Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetSoftwareStatisticsV2

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. With AwsOrganizations, you can 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


POST /softwarev2/statistics HTTP/1.1
Content-type: application/json

{
   "GroupByRules": [ 
      { 
         "Filters": { 
            "CompositeFilters": [ 
               { 
                  "NestedCompositeFilters": [ 
                     "SoftwareCompositeFilter"
                  ],
                  "Operator": "string",
                  "StringFilters": [ 
                     { 
                        "FieldName": "string",
                        "Filter": { 
                           "Comparison": "string",
                           "Value": "string"
                        }
                     }
                  ]
               }
            ],
            "CompositeOperator": "string"
         },
         "GroupByField": "string"
      }
   ],
   "MaxStatisticResults": number,
   "Scopes": { 
      "AwsOrganizations": [ 
         { 
            "OrganizationalUnitId": "string",
            "OrganizationId": "string"
         }
      ]
   },
   "SortOrder": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

GroupByRules

How software statistics should be aggregated and organized in the response.

Type: Array of SoftwareGroupByRule objects

Required: Yes

MaxStatisticResults

The maximum number of grouping values to return. Valid values are 1–400. The default is 400.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 400.

Required: No

Scopes

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.

Type: SoftwareScopes object

Required: No

SortOrder

Sorts aggregated statistics by count. The default is descending, which returns the values with the highest counts first.

Type: String

Valid Values: asc | desc

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "GroupByResults": [ 
      { 
         "GroupByField": "string",
         "GroupByValues": [ 
            { 
               "Count": number,
               "FieldValue": "string"
            }
         ]
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

GroupByResults

The aggregated statistics about software based on the specified grouping rule.

Type: Array of GroupByResult objects

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You don't have permission to perform the action specified in the request.

HTTP Status Code: 403

ConflictException

The request causes conflict with the current state of the service resource.

HTTP Status Code: 409

InternalServerException

The request has failed due to an internal failure of the service.

HTTP Status Code: 500

OrganizationalUnitNotFoundException

The request failed because one or more organizational units specified in the request don't exist within the caller's organization.

HTTP Status Code: 400

OrganizationNotFoundException

The request failed because one or more organizations specified in the request don't exist or don't belong to the caller's organization.

HTTP Status Code: 400

ResourceNotFoundException

The request was rejected because we can't find the specified resource.

HTTP Status Code: 404

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The request has failed validation because it's missing required fields or has invalid inputs.

HTTP Status Code: 400