[ aws . securityhub ]

get-software-v2

Description

Returns a list of software packages installed on your resources. Each result identifies a package by name, version, and type, and includes the number of resources that contain that package.

You can use the Scopes parameter to define the data boundary for the query. Currently, Scopes supports AwsOrganizations , which lets you retrieve software from your entire organization or from specific organizational units. Only the delegated administrator account can use Scopes .

You can use the Filters parameter to refine results based on package and resource attributes. You can use Scopes and Filters independently or together. When both are provided, Scopes narrows the data set first, and then Filters refines results within that scoped data set.

To list the resources that contain a specific package, use GetSoftwareResourcesV2 . To get counts of software grouped by a field, use GetSoftwareStatisticsV2 .

See also: AWS API Documentation

get-software-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: Software

Synopsis

  get-software-v2
[--filters <value>]
[--scopes <value>]
[--sort-criteria <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>]
[--help]

Options

--filters (structure)

Filters software packages based on a set of criteria. You can nest composite filters up to three levels deep.

CompositeFilters -> (list)

A collection of complex filtering conditions that can be applied to software packages.

(structure)

Enables the creation of criteria for software packages in Security Hub.

StringFilters -> (list)

Enables filtering based on string field values.

(structure)

Enables filtering of software packages based on string field values.

FieldName -> (string)

The name of the field.

Possible values:

• AccountId
• PackageName
• PackageVersion
• PackageType
• Region
• ResourceRegion
• ResourceType
• ResourceId
• ResourceProvider
• ResourceOwnerAccountId
• ResourceOwnerOrgId
• ResourceCloudPartition

Filter -> (structure)

The string value and comparison operator to filter on. Supported comparisons are EQUALS , NOT_EQUALS , PREFIX , and PREFIX_NOT_EQUALS .

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 in the Security Hub CSPM User Guide .

Possible values:

• EQUALS
• PREFIX
• NOT_EQUALS
• PREFIX_NOT_EQUALS
• CONTAINS
• NOT_CONTAINS
• CONTAINS_WORD

NestedCompositeFilters -> (list)

Provides an additional level of filtering, creating a three-layer nested structure. The first layer is a CompositeFilters array with a CompositeOperator (AND /OR ). The second layer is a CompositeFilter object that contains direct filters and NestedCompositeFilters . The third layer is NestedCompositeFilters , which contains additional filter conditions.

(structure)

Enables the creation of criteria for software packages in Security Hub.

StringFilters -> (list)

Enables filtering based on string field values.

(structure)

Enables filtering of software packages based on string field values.

FieldName -> (string)

The name of the field.

Possible values:

• AccountId
• PackageName
• PackageVersion
• PackageType
• Region
• ResourceRegion
• ResourceType
• ResourceId
• ResourceProvider
• ResourceOwnerAccountId
• ResourceOwnerOrgId
• ResourceCloudPartition

Filter -> (structure)

The string value and comparison operator to filter on. Supported comparisons are EQUALS , NOT_EQUALS , PREFIX , and PREFIX_NOT_EQUALS .

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 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 used to combine multiple filter conditions.

Possible values:

• AND
• OR

Operator -> (string)

The logical operator used to combine multiple filter conditions.

Possible values:

• AND
• OR

CompositeOperator -> (string)

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

Possible values:

• AND
• OR

JSON Syntax:

{
  "CompositeFilters": [
    {
      "StringFilters": [
        {
          "FieldName": "AccountId"|"PackageName"|"PackageVersion"|"PackageType"|"Region"|"ResourceRegion"|"ResourceType"|"ResourceId"|"ResourceProvider"|"ResourceOwnerAccountId"|"ResourceOwnerOrgId"|"ResourceCloudPartition",
          "Filter": {
            "Value": "string",
            "Comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"|"CONTAINS_WORD"
          }
        }
        ...
      ],
      "NestedCompositeFilters": [
        {
          "StringFilters": [
            {
              "FieldName": "AccountId"|"PackageName"|"PackageVersion"|"PackageType"|"Region"|"ResourceRegion"|"ResourceType"|"ResourceId"|"ResourceProvider"|"ResourceOwnerAccountId"|"ResourceOwnerOrgId"|"ResourceCloudPartition",
              "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"
}

--scopes (structure)

Limits the results to software on resources from specific organizational units or from the delegated administrator’s organization. Only the delegated administrator account can use this parameter. Other accounts receive an AccessDeniedException .

This parameter is optional. If you omit it, the delegated administrator sees software from all accounts across the entire organization. Other accounts see only software on their own resources.

You can specify up to 10 entries in Scopes.AwsOrganizations . If multiple entries are specified, the entries are combined using OR logic.

AwsOrganizations -> (list)

A list of Organizations scopes to include in the query results. Each entry in the list specifies an organization or organizational unit to include for the delegated administrator’s account. If the list specifies multiple entries, the entries are combined using OR logic.

(structure)

Specifies an Organizations scope. Data from the specified organization or organizational unit is included in the response.

To scope to a specific organizational unit, provide OrganizationalUnitId . You can optionally include OrganizationId . If you omit OrganizationId , Security Hub uses the caller’s organization ID. To scope to the delegated administrator’s entire organization, provide only OrganizationId .

The organization ID and organizational unit must belong to the delegated administrator’s own organization. Each request must use one scoping approach: either scope to the entire organization by providing an AwsOrganizationScope entry with only OrganizationId , or scope to specific organizational units by providing AwsOrganizationScope entries with OrganizationalUnitId . You can’t combine both approaches in the same request.

OrganizationId -> (string)

The unique identifier (ID) of the organization (for example, o-abcd1234567890 ). The organization must be the delegated administrator’s own organization. If you omit this value and provide OrganizationalUnitId , Security Hub uses the caller’s organization ID.

Constraints:

• pattern: .*\S.*

OrganizationalUnitId -> (string)

The unique identifier (ID) of the organizational unit (OU) (for example, ou-ab12-cd345678 ). The OU must exist within the delegated administrator’s own organization. When specified, the results include only data from accounts in this OU.

Constraints:

• pattern: .*\S.*

Shorthand Syntax:

AwsOrganizations=[{OrganizationId=string,OrganizationalUnitId=string},{OrganizationId=string,OrganizationalUnitId=string}]

JSON Syntax:

{
  "AwsOrganizations": [
    {
      "OrganizationId": "string",
      "OrganizationalUnitId": "string"
    }
    ...
  ]
}

--sort-criteria (list)

The software attributes used to sort the list of returned software packages. You can’t sort by ResourceCount .

(structure)

A collection of finding attributes used to sort findings.

Field -> (string)

The finding attribute used to sort findings.

Constraints:

• pattern: .*\S.*

SortOrder -> (string)

The order used to sort findings.

Possible values:

• asc
• desc

Shorthand Syntax:

Field=string,SortOrder=string ...

JSON Syntax:

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

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

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

--help (boolean)

Display help for the command/subcommand.

Output

Software -> (list)

An array of software packages returned by the operation.

(structure)

Provides information about a software package installed on one or more of your resources.

PackageName -> (string) [required]

The name of the software package.

Constraints:

• pattern: .*\S.*

PackageVersion -> (string)

The version of the software package.

Constraints:

• pattern: .*\S.*

PackageType -> (string) [required]

The type of the software package, for example operating-system , application , or library .

Constraints:

• pattern: .*\S.*

ResourceCount -> (integer) [required]

The number of resources that contain this software package. To list these resources, call GetSoftwareResourcesV2 .

NextToken -> (string)

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