SearchMetrics
Searches for metrics in the specified Connect Customer instance using search criteria and optional tag-based filters. Use pagination to ensure that the operation returns quickly and successfully.
Request Syntax
POST /search-metrics HTTP/1.1
Content-type: application/json
{
"InstanceId": "string",
"MaxResults": number,
"NextToken": "string",
"SearchCriteria": {
"AndConditions": [
"MetricSearchCriteria"
],
"BooleanCondition": {
"ComparisonType": "string",
"FieldName": "string"
},
"OrConditions": [
"MetricSearchCriteria"
],
"StringCondition": {
"ComparisonType": "string",
"FieldName": "string",
"Value": "string"
}
},
"SearchFilter": {
"TagFilter": {
"AndConditions": [
{
"TagKey": "string",
"TagValue": "string"
}
],
"OrConditions": [
[
{
"TagKey": "string",
"TagValue": "string"
}
]
],
"TagCondition": {
"TagKey": "string",
"TagValue": "string"
}
}
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- InstanceId
-
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
- MaxResults
-
The maximum number of results to return per page.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Type: String
Required: No
- SearchCriteria
-
The search criteria to filter the metrics.
Type: MetricSearchCriteria object
Required: No
- SearchFilter
-
Filters to be applied to search results.
Type: MetricSearchFilter object
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ApproximateTotalCount": number,
"Metrics": [
{
"Arn": "string",
"Category": "string",
"CreatedTime": number,
"CreatedUser": { ... },
"CreationMethod": "string",
"DefaultStat": "string",
"Description": "string",
"EffectiveTime": number,
"Filters": [
{
"Id": "string",
"Type": "string"
}
],
"Groupings": [ "string" ],
"Id": "string",
"LastModifiedRegion": "string",
"LastModifiedTime": number,
"LastModifiedUser": { ... },
"MetricCalculation": {
"Calculation": "string",
"CalculationComponents": [
{
"Alias": "string",
"MetricFilters": [
{
"BooleanCondition": {
"Comparison": "string"
},
"MetricFilterKey": "string",
"Negate": boolean,
"NumberCondition": {
"Comparison": "string",
"Values": [ number ]
},
"StringCondition": {
"Comparison": "string",
"Values": [ "string" ]
}
}
],
"MetricId": "string",
"MetricName": "string"
}
]
},
"Name": "string",
"PositiveTrendIndicator": "string",
"PrimaryEventSource": "string",
"PrimaryEventSourceEffectiveTimestampType": "string",
"RefreshRate": number,
"Status": "string",
"SupportedStats": [ "string" ],
"SupportsCustomCalculation": boolean,
"SupportsPreaggregateCalculation": boolean,
"Tags": {
"string" : "string"
},
"Type": "string",
"Unit": "string"
}
],
"NextToken": "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.
- ApproximateTotalCount
-
The approximate total number of metrics that matched your search criteria.
Type: Long
- Metrics
-
The metrics that matched the search criteria.
Type: Array of MetricDefinition objects
- NextToken
-
If there are additional results, this is the token for the next set of results.
Type: String
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403
- InternalServiceException
-
Request processing failed because of an error or failure with the service.
- Message
-
The message.
HTTP Status Code: 500
- InvalidParameterException
-
One or more of the specified parameters are not valid.
- Message
-
The message about the parameters.
HTTP Status Code: 400
- InvalidRequestException
-
The request is not valid.
- Message
-
The message about the request.
- Reason
-
Reason why the request was invalid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
- Message
-
The message about the resource.
HTTP Status Code: 404
- ThrottlingException
-
The throttling limit has been exceeded.
HTTP Status Code: 429
Examples
Example
The following example searches for customer-managed metrics whose name contains "test".
Sample Request
{
"InstanceId": "12345678-1234-1234-1234-123456789012",
"SearchCriteria": {
"AndConditions": [
{
"StringCondition": {
"ComparisonType": "EXACT",
"FieldName": "type",
"Value": "CUSTOMER_MANAGED"
}
},
{
"StringCondition": {
"ComparisonType": "CONTAINS",
"FieldName": "name",
"Value": "test"
}
}
]
},
"MaxResults": 10
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
