<a id="cli-aws-securityhub-get-resources-trends-v2"></a>

# get-resources-trends-v2

## Description

Returns resource trend data based on the specified criteria. This operation helps you analyze patterns and changes in resource compliance over time.

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetResourcesTrendsV2)

`get-resources-trends-v2` is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the `--no-paginate` argument.
When using `--output text` and the `--query` argument on a paginated response, the `--query` argument must extract data from the results of the following query expressions: `TrendsMetrics`

## Synopsis

```
  get-resources-trends-v2
[--filters <value>]
--start-time <value>
--end-time <value>
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
```

## Options

`--filters` (structure)

> The filters to apply to the resources trend data.

> CompositeFilters -> (list)

> > A list of composite filters to apply to the resources trend data.

> > (structure)

> > > A filter structure that contains a logical combination of string filters and nested composite filters for resources trend data.

> > > StringFilters -> (list)

> > > > A list of string filters that apply to resources trend data fields.

> > > > (structure)

> > > > > A filter for string-based fields in resources trend data, such as resource type or account ID.

> > > > > FieldName -> (string)

> > > > > > The name of the resources field to filter on. You can specify one of the following fields.

> > > > > > * `account_id` – The Amazon Web Services account ID that owns the resource.
> > > > > > * `region` – The Amazon Web Services Region of the resource.
> > > > > > * `resource_type` – The type of the resource.
> > > > > > * `resource_category` – The category of the resource.
> > > > > > * `resource_cloud_provider` – The cloud provider of the resource. Valid values are `AWS` and `Azure` .
> > > > > > * `resource_region` – The Region of the resource. For an Amazon Web Services resource, this is the Amazon Web Services Region. For an Azure resource, this is the Azure Region, such as `eastus` .
> > > > > > * `resource_owner_id` – The identifier of the account that owns the resource. For an Amazon Web Services resource, this is the Amazon Web Services account ID. For an Azure resource, this is the Azure subscription ID.
> > > > > > * `resource_owner_organization_id` – The identifier of the organization that owns the resource. For an Amazon Web Services resource, this is the Amazon Web Services organization ID. For an Azure resource, this is the Azure tenant ID.

> > > > > > Possible values:

> > > > > > * `account_id`
> > > > > > * `region`
> > > > > > * `resource_type`
> > > > > > * `resource_category`
> > > > > > * `resource_cloud_provider`
> > > > > > * `resource_region`
> > > > > > * `resource_owner_id`
> > > > > > * `resource_owner_organization_id`

> > > > > Filter -> (structure)

> > > > > > A string filter for filtering Security Hub CSPM findings.

> > > > > > Value -> (string)

> > > > > > > The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is `Security Hub CSPM` . If you provide `security hub` as the filter value, there’s no match.

> > > > > > > Constraints:

> > > > > > > * pattern: `.*\S.*`

> > > > > > Comparison -> (string)

> > > > > > > The condition to apply to a string value when filtering Security Hub CSPM findings.

> > > > > > > To search for values that have the filter value, use one of the following comparison operators:

> > > > > > > * To search for values that include the filter value, use `CONTAINS` . For example, the filter `Title CONTAINS CloudFront` matches findings that have a `Title` that includes the string `CloudFront` .
> > > > > > > * To search for values that contain a word matching the filter value, regardless of case, use `CONTAINS_WORD` . For example, the filter `Title CONTAINS_WORD lambda` matches a finding whose `Title` is `GuardDuty Lambda Protection` , because the `Title` contains the word Lambda. Including special characters in the filter value might produce unexpected search results.
> > > > > > > * To search for values that exactly match the filter value, use `EQUALS` . For example, the filter `AwsAccountId EQUALS 123456789012` only matches findings that have an account ID of `123456789012` .
> > > > > > > * To search for values that start with the filter value, use `PREFIX` . For example, the filter `ResourceRegion PREFIX us` matches findings that have a `ResourceRegion` that starts with `us` . A `ResourceRegion` that starts with a different value, such as `af` , `ap` , or `ca` , doesn’t match.

> > > > > > > > `CONTAINS` , `EQUALS` , and `PREFIX` filters on the same field are joined by `OR` . A finding matches if it matches any one of those filters. For example, the filters `Title CONTAINS CloudFront OR Title CONTAINS CloudWatch` match a finding that includes either `CloudFront` , `CloudWatch` , or both strings in the title.

> > > > > > > To search for values that don’t have the filter value, use one of the following comparison operators:

> > > > > > > * To search for values that exclude the filter value, use `NOT_CONTAINS` . For example, the filter `Title NOT_CONTAINS CloudFront` matches findings that have a `Title` that excludes the string CloudFront.
> > > > > > > * To search for values other than the filter value, use `NOT_EQUALS` . For example, the filter `AwsAccountId NOT_EQUALS 123456789012` only matches findings that have an account ID other than `123456789012` .
> > > > > > > * To search for values that don’t start with the filter value, use `PREFIX_NOT_EQUALS` . For example, the filter `ResourceRegion PREFIX_NOT_EQUALS us` matches findings with a `ResourceRegion` that starts with a value other than `us` .

> > > > > > > > `NOT_CONTAINS` , `NOT_EQUALS` , and `PREFIX_NOT_EQUALS` filters on the same field are joined by `AND` . A finding matches only if it matches all of those filters. For example, the filters `Title NOT_CONTAINS CloudFront AND Title NOT_CONTAINS CloudWatch` match a finding that excludes both `CloudFront` and `CloudWatch` in the title.

> > > > > > > You can’t have both a `CONTAINS` filter and a `NOT_CONTAINS` filter on the same field. Similarly, you can’t provide both an `EQUALS` filter and a `NOT_EQUALS` or `PREFIX_NOT_EQUALS` filter on the same field. Combining filters in this way returns an error. `CONTAINS` filters can only be used with other `CONTAINS` filters. `NOT_CONTAINS` filters can only be used with other `NOT_CONTAINS` filters.

> > > > > > > You can combine `PREFIX` filters with `NOT_EQUALS` or `PREFIX_NOT_EQUALS` filters for the same field. Security Hub CSPM first processes the `PREFIX` filters, and then the `NOT_EQUALS` or `PREFIX_NOT_EQUALS` filters.

> > > > > > > For example, for the following filters, Security Hub CSPM first identifies findings that have resource types that start with either `AwsIam` or `AwsEc2` . It then excludes findings that have a resource type of `AwsIamPolicy` and findings that have a resource type of `AwsEc2NetworkInterface` .

> > > > > > > * `ResourceType PREFIX AwsIam`
> > > > > > > * `ResourceType PREFIX AwsEc2`
> > > > > > > * `ResourceType NOT_EQUALS AwsIamPolicy`
> > > > > > > * `ResourceType NOT_EQUALS AwsEc2NetworkInterface`

> > > > > > > The `CONTAINS` operator works with automation rules V1 and V2. The `NOT_CONTAINS` operator works only with automation rules V1. The `CONTAINS_WORD` operator works only in the `GetFindingsV2` , `GetFindingStatisticsV2` , `GetResourcesV2` , and `GetResourcesStatisticsV2` APIs. For more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *Security Hub CSPM User Guide* .

> > > > > > > Possible values:

> > > > > > > * `EQUALS`
> > > > > > > * `PREFIX`
> > > > > > > * `NOT_EQUALS`
> > > > > > > * `PREFIX_NOT_EQUALS`
> > > > > > > * `CONTAINS`
> > > > > > > * `NOT_CONTAINS`
> > > > > > > * `CONTAINS_WORD`

> > > NestedCompositeFilters -> (list)

> > > > A list of nested composite filters that you can use to create complex filter conditions for resources trend data.

> > > > (structure)

> > > > > A filter structure that contains a logical combination of string filters and nested composite filters for resources trend data.

> > > > > StringFilters -> (list)

> > > > > > A list of string filters that apply to resources trend data fields.

> > > > > > (structure)

> > > > > > > A filter for string-based fields in resources trend data, such as resource type or account ID.

> > > > > > > FieldName -> (string)

> > > > > > > > The name of the resources field to filter on. You can specify one of the following fields.

> > > > > > > > * `account_id` – The Amazon Web Services account ID that owns the resource.
> > > > > > > > * `region` – The Amazon Web Services Region of the resource.
> > > > > > > > * `resource_type` – The type of the resource.
> > > > > > > > * `resource_category` – The category of the resource.
> > > > > > > > * `resource_cloud_provider` – The cloud provider of the resource. Valid values are `AWS` and `Azure` .
> > > > > > > > * `resource_region` – The Region of the resource. For an Amazon Web Services resource, this is the Amazon Web Services Region. For an Azure resource, this is the Azure Region, such as `eastus` .
> > > > > > > > * `resource_owner_id` – The identifier of the account that owns the resource. For an Amazon Web Services resource, this is the Amazon Web Services account ID. For an Azure resource, this is the Azure subscription ID.
> > > > > > > > * `resource_owner_organization_id` – The identifier of the organization that owns the resource. For an Amazon Web Services resource, this is the Amazon Web Services organization ID. For an Azure resource, this is the Azure tenant ID.

> > > > > > > > Possible values:

> > > > > > > > * `account_id`
> > > > > > > > * `region`
> > > > > > > > * `resource_type`
> > > > > > > > * `resource_category`
> > > > > > > > * `resource_cloud_provider`
> > > > > > > > * `resource_region`
> > > > > > > > * `resource_owner_id`
> > > > > > > > * `resource_owner_organization_id`

> > > > > > > Filter -> (structure)

> > > > > > > > A string filter for filtering Security Hub CSPM findings.

> > > > > > > > Value -> (string)

> > > > > > > > > The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is `Security Hub CSPM` . If you provide `security hub` as the filter value, there’s no match.

> > > > > > > > > Constraints:

> > > > > > > > > * pattern: `.*\S.*`

> > > > > > > > Comparison -> (string)

> > > > > > > > > The condition to apply to a string value when filtering Security Hub CSPM findings.

> > > > > > > > > To search for values that have the filter value, use one of the following comparison operators:

> > > > > > > > > * To search for values that include the filter value, use `CONTAINS` . For example, the filter `Title CONTAINS CloudFront` matches findings that have a `Title` that includes the string `CloudFront` .
> > > > > > > > > * To search for values that contain a word matching the filter value, regardless of case, use `CONTAINS_WORD` . For example, the filter `Title CONTAINS_WORD lambda` matches a finding whose `Title` is `GuardDuty Lambda Protection` , because the `Title` contains the word Lambda. Including special characters in the filter value might produce unexpected search results.
> > > > > > > > > * To search for values that exactly match the filter value, use `EQUALS` . For example, the filter `AwsAccountId EQUALS 123456789012` only matches findings that have an account ID of `123456789012` .
> > > > > > > > > * To search for values that start with the filter value, use `PREFIX` . For example, the filter `ResourceRegion PREFIX us` matches findings that have a `ResourceRegion` that starts with `us` . A `ResourceRegion` that starts with a different value, such as `af` , `ap` , or `ca` , doesn’t match.

> > > > > > > > > > `CONTAINS` , `EQUALS` , and `PREFIX` filters on the same field are joined by `OR` . A finding matches if it matches any one of those filters. For example, the filters `Title CONTAINS CloudFront OR Title CONTAINS CloudWatch` match a finding that includes either `CloudFront` , `CloudWatch` , or both strings in the title.

> > > > > > > > > To search for values that don’t have the filter value, use one of the following comparison operators:

> > > > > > > > > * To search for values that exclude the filter value, use `NOT_CONTAINS` . For example, the filter `Title NOT_CONTAINS CloudFront` matches findings that have a `Title` that excludes the string CloudFront.
> > > > > > > > > * To search for values other than the filter value, use `NOT_EQUALS` . For example, the filter `AwsAccountId NOT_EQUALS 123456789012` only matches findings that have an account ID other than `123456789012` .
> > > > > > > > > * To search for values that don’t start with the filter value, use `PREFIX_NOT_EQUALS` . For example, the filter `ResourceRegion PREFIX_NOT_EQUALS us` matches findings with a `ResourceRegion` that starts with a value other than `us` .

> > > > > > > > > > `NOT_CONTAINS` , `NOT_EQUALS` , and `PREFIX_NOT_EQUALS` filters on the same field are joined by `AND` . A finding matches only if it matches all of those filters. For example, the filters `Title NOT_CONTAINS CloudFront AND Title NOT_CONTAINS CloudWatch` match a finding that excludes both `CloudFront` and `CloudWatch` in the title.

> > > > > > > > > You can’t have both a `CONTAINS` filter and a `NOT_CONTAINS` filter on the same field. Similarly, you can’t provide both an `EQUALS` filter and a `NOT_EQUALS` or `PREFIX_NOT_EQUALS` filter on the same field. Combining filters in this way returns an error. `CONTAINS` filters can only be used with other `CONTAINS` filters. `NOT_CONTAINS` filters can only be used with other `NOT_CONTAINS` filters.

> > > > > > > > > You can combine `PREFIX` filters with `NOT_EQUALS` or `PREFIX_NOT_EQUALS` filters for the same field. Security Hub CSPM first processes the `PREFIX` filters, and then the `NOT_EQUALS` or `PREFIX_NOT_EQUALS` filters.

> > > > > > > > > For example, for the following filters, Security Hub CSPM first identifies findings that have resource types that start with either `AwsIam` or `AwsEc2` . It then excludes findings that have a resource type of `AwsIamPolicy` and findings that have a resource type of `AwsEc2NetworkInterface` .

> > > > > > > > > * `ResourceType PREFIX AwsIam`
> > > > > > > > > * `ResourceType PREFIX AwsEc2`
> > > > > > > > > * `ResourceType NOT_EQUALS AwsIamPolicy`
> > > > > > > > > * `ResourceType NOT_EQUALS AwsEc2NetworkInterface`

> > > > > > > > > The `CONTAINS` operator works with automation rules V1 and V2. The `NOT_CONTAINS` operator works only with automation rules V1. The `CONTAINS_WORD` operator works only in the `GetFindingsV2` , `GetFindingStatisticsV2` , `GetResourcesV2` , and `GetResourcesStatisticsV2` APIs. For more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *Security Hub CSPM User Guide* .

> > > > > > > > > Possible values:

> > > > > > > > > * `EQUALS`
> > > > > > > > > * `PREFIX`
> > > > > > > > > * `NOT_EQUALS`
> > > > > > > > > * `PREFIX_NOT_EQUALS`
> > > > > > > > > * `CONTAINS`
> > > > > > > > > * `NOT_CONTAINS`
> > > > > > > > > * `CONTAINS_WORD`

> > > > > Operator -> (string)

> > > > > > The logical operator (AND, OR) to apply between the string filters and nested composite filters.

> > > > > > Possible values:

> > > > > > * `AND`
> > > > > > * `OR`

> > > Operator -> (string)

> > > > The logical operator (AND, OR) to apply between the string filters and nested composite filters.

> > > > Possible values:

> > > > * `AND`
> > > > * `OR`

> CompositeOperator -> (string)

> > The logical operator (AND, OR) to apply between multiple composite filters.

> > Possible values:

> > * `AND`
> > * `OR`

JSON Syntax:

```json
{
  "CompositeFilters": [
    {
      "StringFilters": [
        {
          "FieldName": "account_id"|"region"|"resource_type"|"resource_category"|"resource_cloud_provider"|"resource_region"|"resource_owner_id"|"resource_owner_organization_id",
          "Filter": {
            "Value": "string",
            "Comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"|"CONTAINS_WORD"
          }
        }
        ...
      ],
      "NestedCompositeFilters": [
        {
          "StringFilters": [
            {
              "FieldName": "account_id"|"region"|"resource_type"|"resource_category"|"resource_cloud_provider"|"resource_region"|"resource_owner_id"|"resource_owner_organization_id",
              "Filter": {
                "Value": "string",
                "Comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"|"CONTAINS_WORD"
              }
            }
            ...
          ],
          "NestedCompositeFilters": ,
          "Operator": "AND"|"OR"
        }
        ...
      ],
      "Operator": "AND"|"OR"
    }
    ...
  ],
  "CompositeOperator": "AND"|"OR"
}
```

`--start-time` (timestamp) [required]

> The starting timestamp for the time period to analyze resources trends, in ISO 8601 format.

`--end-time` (timestamp) [required]

> The ending timestamp for the time period to analyze resources trends, in ISO 8601 format.

`--starting-token` (string)

> A token to specify where to start paginating. This is the `NextToken` from a previously truncated response.

> For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* .

`--page-size` (integer)

> The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

> For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* .

> Constraints:

> * min: `1`
> * max: `100`

`--max-items` (integer)

> The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a `NextToken` is provided in the command’s output. To resume pagination, provide the `NextToken` value in the `starting-token` argument of a subsequent command. **Do not** use the `NextToken` response element directly outside of the AWS CLI.

> For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* .

`--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

## Global Options

`--debug` (boolean)

Turn on debug logging.

`--endpoint-url` (string)

Override command’s default URL with the given URL.

`--no-verify-ssl` (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

`--no-paginate` (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

`--output` (string)

The formatting style for command output.

* json
* text
* table
* yaml
* yaml-stream
* off

`--query` (string)

A JMESPath query to use in filtering the response data.

`--profile` (string)

Use a specific profile from your credential file.

`--region` (string)

The region to use. Overrides config/env settings.

`--version` (string)

Display the version of this tool.

`--color` (string)

Turn on/off color output.

* on
* off
* auto

`--no-sign-request` (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

`--ca-bundle` (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

`--cli-read-timeout` (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

`--cli-connect-timeout` (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

`--cli-binary-format` (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`.

* base64
* raw-in-base64-out

`--no-cli-pager` (boolean)

Disable cli pager for output.

`--cli-auto-prompt` (boolean)

Automatically prompt for CLI input parameters.

`--no-cli-auto-prompt` (boolean)

Disable automatically prompt for CLI input parameters.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

## Output

Granularity -> (string)

> The time interval granularity for the returned trend data (such as DAILY or WEEKLY).

> Possible values:

> * `Daily`
> * `Weekly`
> * `Monthly`

TrendsMetrics -> (list)

> The collection of time-series trend metrics, including counts of resources across the specified time period.

> (structure)

> > Contains the resource trend metrics data for a specific time point in the requested time period.

> > Timestamp -> (timestamp) [required]

> > > The timestamp for this data point in the resources trend metrics.

> > TrendsValues -> (structure) [required]

> > > The resource trend metric values associated with this timestamp, including resource counts.

> > > ResourcesCount -> (structure) [required]

> > > > The resource count statistics for this data point in the trend timeline.

> > > > AllResources -> (long) [required]

> > > > > The total count of all resources for the given time interval.

> > > > > Constraints:

> > > > > * min: `0`

NextToken -> (string)

> The token to use for retrieving the next page of results, if more trend data is available.
