Retrieves the full definition of an existing metric from the specified Connect Customer instance¶

Description¶

Retrieves the full definition of an existing metric from the specified Connect Customer instance.

Usage¶

connect_describe_metric(InstanceId, MetricId)

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.

MetricId

[required] The identifier of the metric to describe. Adding the $SAVED qualifier will describe the saved version of the metric. Adding $LATEST or omitting a qualifier will describe the published version.

Value¶

A list with the following syntax:

list(
  Metric = 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"
    )
  )
)

Request syntax¶

svc$describe_metric(
  InstanceId = "string",
  MetricId = "string"
)