Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1425123120.1 KB

Create a query with the Network Flow Monitor query interface that you can run to return workload insights top contributors. Specify the scope that you want to create a query for.

The call returns a query ID that you can use with GetQueryResultsWorkloadInsightsTopContributors to run the query and return the top contributors for the workload insights for a scope.

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable APIs for the top contributors that you want to be returned.

post/workloadInsights/{scopeId}/topContributorsQueries

Path parameters

scopeIdstring required

The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a <code>CreateScope</code> API call.

Request body

startTimestring date-time required

The timestamp that is the date and time that is the beginning of the period that you want to retrieve results for with your query.

endTimestring date-time required

The timestamp that is the date and time end of the period that you want to retrieve results for with your query.

metricName'TIMEOUTS' | 'RETRANSMISSIONS' | 'DATA_TRANSFERRED' required

The metric that you want to query top contributors for. That is, you can specify this metric to return the top contributor network flows, for this type of metric, for a monitor and (optionally) within a specific category, such as network flows between Availability Zones.

destinationCategory'INTRA_AZ' | 'INTER_AZ' | 'INTER_VPC' | 'UNCLASSIFIED' | 'AMAZON_S3' | 'AMAZON_DYNAMODB' | 'INTER_REGION' required
<p>The destination category for a top contributors row. Destination categories can be one of the following: </p> <ul> <li> <p> <code>INTRA_AZ</code>: Top contributor network flows within a single Availability Zone</p> </li> <li> <p> <code>INTER_AZ</code>: Top contributor network flows between Availability Zones</p> </li> <li> <p> <code>INTER_REGION</code>: Top contributor network flows between Regions (to the edge of another Region)</p> </li> <li> <p> <code>INTER_VPC</code>: Top contributor network flows between VPCs</p> </li> <li> <p> <code>AWS_SERVICES</code>: Top contributor network flows to or from Amazon Web Services services</p> </li> <li> <p> <code>UNCLASSIFIED</code>: Top contributor network flows that do not have a bucket classification</p> </li> </ul>
limitinteger

The maximum number of top contributors to return.

Response

Success

queryIdstring required

The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.