StartQueryWorkloadInsightsTopContributors
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.
Request Syntax
POST /workloadInsights/scopeId/topContributorsQueries HTTP/1.1
Content-type: application/json
{
"destinationCategory": "string",
"endTime": "string",
"limit": number,
"metricName": "string",
"startTime": "string"
}URI Request Parameters
The request uses the following URI parameters.
- scopeId
-
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
CreateScopeAPI call.Required: Yes
Request Body
The request accepts the following data in JSON format.
- destinationCategory
-
The destination category for a top contributors row. Destination categories can be one of the following:
-
INTRA_AZ: Top contributor network flows within a single Availability Zone -
INTER_AZ: Top contributor network flows between Availability Zones -
INTER_VPC: Top contributor network flows between VPCs -
AWS_SERVICES: Top contributor network flows to or from AWS services -
UNCLASSIFIED: Top contributor network flows that do not have a bucket classification
Type: String
Valid Values:
INTRA_AZ | INTER_AZ | INTER_VPC | UNCLASSIFIED | AMAZON_S3 | AMAZON_DYNAMODBRequired: Yes
-
- endTime
-
The timestamp that is the date and time end of the period that you want to retrieve results for with your query.
Type: Timestamp
Required: Yes
- limit
-
The maximum number of top contributors to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 500.
Required: No
- metricName
-
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.
Type: String
Valid Values:
TIMEOUTS | RETRANSMISSIONS | DATA_TRANSFERREDRequired: Yes
- startTime
-
The timestamp that is the date and time beginning of the period that you want to retrieve results for with your query.
Type: Timestamp
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"queryId": "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.
- queryId
-
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.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have sufficient permission to perform this action.
HTTP Status Code: 403
- InternalServerException
-
An internal error occurred.
HTTP Status Code: 500
- ServiceQuotaExceededException
-
The request exceeded a service quota.
HTTP Status Code: 402
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
Invalid request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
