SecurityHub / Client / get_software_statistics_v2

get_software_statistics_v2¶

SecurityHub.Client.get_software_statistics_v2(**kwargs)¶

Retrieves aggregated counts of software packages installed on your resources, grouped by a field that you specify. For example, you can return the most common package types or the accounts with the most installed packages.

Each count is the number of package-to-resource pairs that match the grouping value. A package installed on three resources contributes three to the count.

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

This operation doesn’t paginate. Use MaxStatisticResults to control how many grouping values are returned.

Request Syntax

response = client.get_software_statistics_v2(
    GroupByRules=[
        {
            'GroupByField': 'AccountId'|'PackageName'|'PackageVersion'|'PackageType'|'Region'|'ResourceRegion'|'ResourceType'|'ResourceId'|'ResourceProvider'|'ResourceOwnerAccountId'|'ResourceOwnerOrgId'|'ResourceCloudPartition',
            'Filters': {
                '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': {'... recursive ...'},
                        'Operator': 'AND'|'OR'
                    },
                ],
                'CompositeOperator': 'AND'|'OR'
            }
        },
    ],
    Scopes={
        'AwsOrganizations': [
            {
                'OrganizationId': 'string',
                'OrganizationalUnitId': 'string'
            },
        ]
    },
    SortOrder='asc'|'desc',
    MaxStatisticResults=123
)

Parameters:

GroupByRules (list) –
[REQUIRED]

How software statistics should be aggregated and organized in the response.
- (dict) –
  
  Defines the configuration for organizing and categorizing software packages installed on your resources.
  - GroupByField (string) – [REQUIRED]
    
    Specifies the attribute that software statistics should be grouped by.
  - Filters (dict) –
    
    The criteria used to select the software packages included in the statistics. 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.
      - (dict) –
        
        Enables the creation of criteria for software packages in Security Hub.
        
        StringFilters (list) –
        
        Enables filtering based on string field values.
        
        (dict) –
        
        Enables filtering of software packages based on string field values.
        
        FieldName (string) –
        
        The name of the field.
        
        Filter (dict) –
        
        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.
        
        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.
        
        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.
        
        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.
Scopes (dict) –
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 statistics from all accounts across the entire organization. Other accounts see only statistics for 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.
  - (dict) –
    
    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.
    - 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.
SortOrder (string) – Sorts aggregated statistics by count. The default is descending, which returns the values with the highest counts first.
MaxStatisticResults (integer) – The maximum number of grouping values to return. Valid values are 1–400. The default is 400.

Return type:

dict

Returns:

Response Syntax

{
    'GroupByResults': [
        {
            'GroupByField': 'string',
            'GroupByValues': [
                {
                    'FieldValue': 'string',
                    'Count': 123
                },
            ]
        },
    ]
}

Response Structure

(dict) –
- GroupByResults (list) –
  
  The aggregated statistics about software based on the specified grouping rule.
  - (dict) –
    
    Represents finding statistics grouped by GroupedByField.
    - GroupByField (string) –
      
      The attribute by which filtered security findings should be grouped.
    - GroupByValues (list) –
      
      An array of grouped values and their respective counts for each GroupByField.
      - (dict) –
        
        Represents individual aggregated results when grouping security findings for each GroupByField.
        
        FieldValue (string) –
        
        The value of the field by which findings are grouped.
        
        Count (integer) –
        
        The number of findings for a specific FieldValue and GroupByField.

get_software_statistics_v2¶

Request Syntax

Response Syntax

Response Structure

Exceptions