Searches for metrics in the specified Connect Customer instance using search criteria and optional tag-based filters¶

Description¶

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.

Usage¶

connect_search_metrics(InstanceId, NextToken, MaxResults, SearchFilter,
  SearchCriteria)

Arguments¶

InstanceId

[required] The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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.

MaxResults

The maximum number of results to return per page.

SearchFilter

Filters to be applied to search results.

SearchCriteria

The search criteria to filter the metrics.

Value¶

A list with the following syntax:

list(
  Metrics = list(
    list(
      Arn = "string",
      Id = "string",
      Name = "string",
      Description = "string",
      MetricCalculation = list(
        CalculationComponents = list(
          list(
            Alias = "string",
            MetricName = "string",
            MetricId = "string",
            MetricFilters = list(
              list(
                MetricFilterKey = "string",
                Negate = TRUE|FALSE,
                NumberCondition = list(
                  Comparison = "LESSER"|"LESSER_OR_EQUAL"|"GREATER"|"GREATER_OR_EQUAL",
                  Values = list(
                    123.0
                  )
                ),
                StringCondition = list(
                  Comparison = "MATCHES_ANY"|"MATCHES_NONE",
                  Values = list(
                    "string"
                  )
                ),
                BooleanCondition = list(
                  Comparison = "IS_TRUE"|"IS_FALSE"
                )
              )
            )
          )
        ),
        Calculation = "string"
      ),
      CreationMethod = "SERVICE_LEVEL_BUILDER"|"METRIC_BUILDER",
      Status = "PUBLISHED"|"SAVED",
      Type = "AWS_MANAGED"|"CUSTOMER_MANAGED",
      Unit = "INTEGER"|"DOUBLE"|"PERCENT"|"SECONDS",
      PositiveTrendIndicator = "POSITIVE"|"NEGATIVE"|"NEUTRAL",
      Groupings = list(
        "string"
      ),
      Filters = list(
        list(
          Id = "string",
          Type = "METRIC_LEVEL"|"RESOURCE_LEVEL"
        )
      ),
      EffectiveTime = as.POSIXct(
        "2015-01-01"
      ),
      RefreshRate = 123,
      Category = "string",
      SupportedStats = list(
        "string"
      ),
      DefaultStat = "string",
      SupportsPreaggregateCalculation = TRUE|FALSE,
      SupportsCustomCalculation = TRUE|FALSE,
      PrimaryEventSource = "string",
      PrimaryEventSourceEffectiveTimestampType = "string",
      CreatedTime = as.POSIXct(
        "2015-01-01"
      ),
      CreatedUser = list(
        ConnectUserArn = "string",
        AWSIdentityArn = "string"
      ),
      LastModifiedRegion = "string",
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedUser = list(
        ConnectUserArn = "string",
        AWSIdentityArn = "string"
      ),
      Tags = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  ApproximateTotalCount = 123
)

Request syntax¶

svc$search_metrics(
  InstanceId = "string",
  NextToken = "string",
  MaxResults = 123,
  SearchFilter = list(
    TagFilter = list(
      OrConditions = list(
        list(
          list(
            TagKey = "string",
            TagValue = "string"
          )
        )
      ),
      AndConditions = list(
        list(
          TagKey = "string",
          TagValue = "string"
        )
      ),
      TagCondition = list(
        TagKey = "string",
        TagValue = "string"
      )
    )
  ),
  SearchCriteria = list(
    OrConditions = list(
      list()
    ),
    AndConditions = list(
      list()
    ),
    StringCondition = list(
      FieldName = "string",
      Value = "string",
      ComparisonType = "STARTS_WITH"|"CONTAINS"|"EXACT"
    ),
    BooleanCondition = list(
      FieldName = "string",
      ComparisonType = "IS_TRUE"|"IS_FALSE"
    )
  )
)