Skip to content

Retrieves a paginated list of metric summaries for the specified Connect Customer instance

Description

Retrieves a paginated list of metric summaries for the specified Connect Customer instance. Use pagination to ensure that the operation returns quickly and successfully.

Usage

connect_list_metrics(InstanceId, Type, MaxResults, NextToken)

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.

  • Type

    The type of metrics to list. Valid values: AWS_MANAGED | CUSTOMER_MANAGED.

  • MaxResults

    The maximum number of results to return per page.

  • 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.

Value

A list with the following syntax:

list(
  MetricSummaryList = list(
    list(
      Arn = "string",
      Id = "string",
      Name = "string",
      Status = "PUBLISHED"|"SAVED",
      Type = "AWS_MANAGED"|"CUSTOMER_MANAGED",
      LastModifiedRegion = "string",
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_metrics(
  InstanceId = "string",
  Type = "AWS_MANAGED"|"CUSTOMER_MANAGED",
  MaxResults = 123,
  NextToken = "string"
)