[ aws . securityhub ]

get-resources-v2

Description

Returns a list of resources. This API is in private preview and subject to change.

See also: AWS API Documentation

get-resources-v2 uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

get-resources-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: Resources

Synopsis

  get-resources-v2
[--filters <value>]
[--sort-criteria <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Options

--filters (structure)

Filters resources based on a set of criteria.

CompositeFilters -> (list)

A collection of complex filtering conditions that can be applied to Amazon Web Services resources.

(structure)

Enables the creation of criteria for Amazon Web Services resources in Security Hub.

StringFilters -> (list)

Enables filtering based on string field values.

(structure)

Enables filtering of Amazon Web Services resources based on string field values.

FieldName -> (string)

The name of the field.

Filter -> (structure)

A string filter for filtering Security Hub findings.

Value -> (string)

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

Comparison -> (string)

The condition to apply to a string value when filtering Security Hub 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 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 first processes the PREFIX filters, and then the NOT_EQUALS or PREFIX_NOT_EQUALS filters.

For example, for the following filters, Security Hub 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

CONTAINS and NOT_CONTAINS operators can be used only with automation rules V1. CONTAINS_WORD operator is only supported in GetFindingsV2 , GetFindingStatisticsV2 , GetResourcesV2 , and GetResourceStatisticsV2 APIs. For more information, see Automation rules in the Security Hub User Guide .

DateFilters -> (list)

Enables filtering based on date and timestamp field values.

(structure)

Enables the filtering of Amazon Web Services resources based on date and timestamp attributes.

FieldName -> (string)

The name of the field.

Filter -> (structure)

A date filter for querying findings.

Start -> (string)

A timestamp that provides the start date for the date filter.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps .

End -> (string)

A timestamp that provides the end date for the date filter.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps .

DateRange -> (structure)

A date range for the date filter.

Value -> (integer)

A date range value for the date filter.

Unit -> (string)

A date range unit for the date filter.

NumberFilters -> (list)

Enables filtering based on numerical field values.

(structure)

Enables filtering of Amazon Web Services resources based on numerical values.

FieldName -> (string)

The name of the field.

Filter -> (structure)

A number filter for querying findings.

Gte -> (double)

The greater-than-equal condition to be applied to a single field when querying for findings.

Lte -> (double)

The less-than-equal condition to be applied to a single field when querying for findings.

Eq -> (double)

The equal-to condition to be applied to a single field when querying for findings.

Gt -> (double)

The greater-than condition to be applied to a single field when querying for findings.

Lt -> (double)

The less-than condition to be applied to a single field when querying for findings.

MapFilters -> (list)

Enables filtering based on map-based field values.

(structure)

Enables filtering of Amazon Web Services resources based on key-value map attributes.

FieldName -> (string)

The name of the field.

Filter -> (structure)

A map filter for filtering Security Hub findings. Each map filter provides the field to check for, the value to check for, and the comparison operator.

Key -> (string)

The key of the map filter. For example, for ResourceTags , Key identifies the name of the tag. For UserDefinedFields , Key is the name of the field.

Value -> (string)

The value for the key in the map filter. Filter values are case sensitive. For example, one of the values for a tag called Department might be Security . If you provide security as the filter value, then there’s no match.

Comparison -> (string)

The condition to apply to the key value when filtering Security Hub findings with a map filter.

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, for the ResourceTags field, the filter Department CONTAINS Security matches findings that include the value Security for the Department tag. In the same example, a finding with a value of Security team for the Department tag is a match.
• To search for values that exactly match the filter value, use EQUALS . For example, for the ResourceTags field, the filter Department EQUALS Security matches findings that have the value Security for the Department tag.

CONTAINS and EQUALS filters on the same field are joined by OR . A finding matches if it matches any one of those filters. For example, the filters Department CONTAINS Security OR Department CONTAINS Finance match a finding that includes either Security , Finance , or both values.

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, for the ResourceTags field, the filter Department NOT_CONTAINS Finance matches findings that exclude the value Finance for the Department tag.
• To search for values other than the filter value, use NOT_EQUALS . For example, for the ResourceTags field, the filter Department NOT_EQUALS Finance matches findings that don’t have the value Finance for the Department tag.

NOT_CONTAINS and 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 Department NOT_CONTAINS Security AND Department NOT_CONTAINS Finance match a finding that excludes both the Security and Finance values.

CONTAINS filters can only be used with other CONTAINS filters. NOT_CONTAINS filters can only be used with other NOT_CONTAINS filters.

You can’t have both a CONTAINS filter and a NOT_CONTAINS filter on the same field. Similarly, you can’t have both an EQUALS filter and a NOT_EQUALS filter on the same field. Combining filters in this way returns an error.

CONTAINS and NOT_CONTAINS operators can be used only with automation rules. For more information, see Automation rules in the Security Hub User Guide .

Operator -> (string)

The logical operator used to combine multiple filter conditions.

CompositeOperator -> (string)

The logical operator used to combine multiple filter conditions in the structure.

JSON Syntax:

{
  "CompositeFilters": [
    {
      "StringFilters": [
        {
          "FieldName": "resource_arn"|"resource_id"|"account_id"|"region"|"resource_category"|"resource_type"|"resource_name"|"findings_summary.finding_type"|"findings_summary.product_name",
          "Filter": {
            "Value": "string",
            "Comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"|"CONTAINS_WORD"
          }
        }
        ...
      ],
      "DateFilters": [
        {
          "FieldName": "resource_detail_capture_time_dt"|"resource_creation_time_dt",
          "Filter": {
            "Start": "string",
            "End": "string",
            "DateRange": {
              "Value": integer,
              "Unit": "DAYS"
            }
          }
        }
        ...
      ],
      "NumberFilters": [
        {
          "FieldName": "findings_summary.total_findings"|"findings_summary.severities.other"|"findings_summary.severities.fatal"|"findings_summary.severities.critical"|"findings_summary.severities.high"|"findings_summary.severities.medium"|"findings_summary.severities.low"|"findings_summary.severities.informational"|"findings_summary.severities.unknown",
          "Filter": {
            "Gte": double,
            "Lte": double,
            "Eq": double,
            "Gt": double,
            "Lt": double
          }
        }
        ...
      ],
      "MapFilters": [
        {
          "FieldName": "tags",
          "Filter": {
            "Key": "string",
            "Value": "string",
            "Comparison": "EQUALS"|"NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          }
        }
        ...
      ],
      "Operator": "AND"|"OR"
    }
    ...
  ],
  "CompositeOperator": "AND"|"OR"
}

--sort-criteria (list)

The finding attributes used to sort the list of returned findings.

(structure)

A collection of finding attributes used to sort findings.

Field -> (string)

The finding attribute used to sort findings.

SortOrder -> (string)

The order used to sort findings.

Shorthand Syntax:

Field=string,SortOrder=string ...

JSON Syntax:

[
  {
    "Field": "string",
    "SortOrder": "asc"|"desc"
  }
  ...
]

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

--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 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 in the AWS Command Line Interface User Guide .

--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 in the AWS Command Line Interface User Guide .

--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

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

Output

Resources -> (list)

Filters resources based on a set of criteria.

(structure)

Provides comprehensive details about an Amazon Web Services resource and its associated security findings.

ResourceArn -> (string)

Specifies the ARN that uniquely identifies a resource.

ResourceId -> (string)

The unique identifier for a resource.

AccountId -> (string)

The Amazon Web Services account that owns the resource.

Region -> (string)

The Amazon Web Services Region where the resource is located.

ResourceCategory -> (string)

The grouping where the resource belongs.

ResourceType -> (string)

The type of resource.

ResourceName -> (string)

The name of the resource.

ResourceCreationTimeDt -> (string)

The time when the resource was created.

ResourceDetailCaptureTimeDt -> (string)

The timestamp when information about the resource was captured.

FindingsSummary -> (list)

An aggregated view of security findings associated with a resource.

(structure)

A list of summaries for all finding types on a resource.

FindingType -> (string)

The category or classification of the security finding.

ProductName -> (string)

The name of the product associated with the security finding.

TotalFindings -> (integer)

The total count of security findings.

Severities -> (structure)

A breakdown of security findings by their severity levels.

Other -> (integer)

The number of findings not in any of the severity categories.

Fatal -> (integer)

The number of findings with a severity level of fatal.

Critical -> (integer)

The number of findings with a severity level of critical.

High -> (integer)

The number of findings with a severity level of high.

Medium -> (integer)

The number of findings with a severity level of medium.

Low -> (integer)

The number of findings with a severity level of low.

Informational -> (integer)

The number of findings that provide security-related information.

Unknown -> (integer)

The number of findings with a severity level cannot be determined.

ResourceTags -> (list)

The key-value pairs associated with a resource.

(structure)

Represents tag information associated with Amazon Web Services resources.

Key -> (string)

The identifier or name of the tag.

Value -> (string)

The data associated with the tag key.

ResourceConfig -> (document)

The configuration details of a resource.

NextToken -> (string)

The pagination token to use to request the next page of results. Otherwise, this parameter is null.