aws-native.connect.getMetric

AWS Cloud Control v1.78.0, Sep 7 26

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.78.0
published on Monday, Sep 7, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.78.0
published on Monday, Sep 7, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

Using getMetric

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getMetric(args: GetMetricArgs, opts?: InvokeOptions): Promise<GetMetricResult>
function getMetricOutput(args: GetMetricOutputArgs, opts?: InvokeOutputOptions): Output<GetMetricResult>

def get_metric(metric_arn: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetMetricResult
def get_metric_output(metric_arn: pulumi.Input[Optional[str]] = None,
               opts: Optional[InvokeOutputOptions] = None) -> Output[GetMetricResult]

func LookupMetric(ctx *Context, args *LookupMetricArgs, opts ...InvokeOption) (*LookupMetricResult, error)
func LookupMetricOutput(ctx *Context, args *LookupMetricOutputArgs, opts ...InvokeOption) LookupMetricResultOutput

> Note: This function is named LookupMetric in the Go SDK.

public static class GetMetric 
{
    public static Task<GetMetricResult> InvokeAsync(GetMetricArgs args, InvokeOptions? opts = null)
    public static Output<GetMetricResult> Invoke(GetMetricInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetMetricResult> Invoke(GetMetricInvokeArgs args, InvokeOutputOptions opts)
}

public static CompletableFuture<GetMetricResult> getMetric(GetMetricArgs args, InvokeOptions options)
public static Output<GetMetricResult> getMetric(GetMetricArgs args, InvokeOptions options)
public static Output<GetMetricResult> getMetric(GetMetricArgs args, InvokeOutputOptions options)

fn::invoke:
  function: aws-native:connect:getMetric
  arguments:
    # arguments dictionary

data "aws-native_connect_get_metric" "name" {
    # arguments
}

The following arguments are supported:

MetricArn string: The Amazon Resource Name (ARN) for the custom metric.

MetricArn string: The Amazon Resource Name (ARN) for the custom metric.

metric_arn string: The Amazon Resource Name (ARN) for the custom metric.

metricArn String: The Amazon Resource Name (ARN) for the custom metric.

metricArn string: The Amazon Resource Name (ARN) for the custom metric.

metric_arn str: The Amazon Resource Name (ARN) for the custom metric.

metricArn String: The Amazon Resource Name (ARN) for the custom metric.

getMetric Result

The following output properties are available:

Category string: The category of the custom metric
CreatedTime double: The timestamp where the metric was created
CreatedUser Pulumi.AwsNative.Connect.Outputs.MetricCreatedByInfo
CreationMethod Pulumi.AwsNative.Connect.MetricCreationMethod: Whether the metric was built with the guided Service Level (SL) experience, or with the free-form metric builder
Description string: The description of the custom metric
EffectiveTime double: Earliest time that can be queried for this metric
Filters List<Pulumi.AwsNative.Connect.Outputs.MetricAvailableFilter>: List of filter types that may be used with this metric
Groupings List<string>: List of groupings that may be used with this metric
LastModifiedRegion string: The AWS region where the metric was last modified
LastModifiedTime double: The timestamp where the metric was last modified
LastModifiedUser Pulumi.AwsNative.Connect.Outputs.MetricCreatedByInfo
MetricArn string: The Amazon Resource Name (ARN) for the custom metric.
MetricCalculation Pulumi.AwsNative.Connect.Outputs.MetricCalculationProperties: The calculation configuration for the metric
Name string: The name of the custom metric
PositiveTrendIndicator Pulumi.AwsNative.Connect.MetricPositiveTrendIndicator: Indicates how to classify a positive trend in metric data on the UI
PrimaryEventSource string: Main provider of the document/row-level data for the metric; should match Data Lake table names
PrimaryEventSourceEffectiveTimestampType string: Identifies the timestamp used to place the metrics on a time-series; should match public attribute name
RefreshRate int: Recommended time to wait between each refresh of data for the metric
SupportedStats List<string>: List of stat aggregations available for the metric
SupportsCustomCalculation bool: The metric may be used to compose other (custom) metrics
SupportsPreaggregateCalculation bool: The metric may be used to compose other (custom) metrics, meaning it can be used inside of aggregate stat functions
Tags List<Pulumi.AwsNative.Outputs.Tag>: One or more tags.
Type Pulumi.AwsNative.Connect.MetricType: Whether the metric is provided out-of-the-box or created by each customer
Unit Pulumi.AwsNative.Connect.MetricUnit: Display unit for the metric data

Category string: The category of the custom metric
CreatedTime float64: The timestamp where the metric was created
CreatedUser MetricCreatedByInfo
CreationMethod MetricCreationMethod: Whether the metric was built with the guided Service Level (SL) experience, or with the free-form metric builder
Description string: The description of the custom metric
EffectiveTime float64: Earliest time that can be queried for this metric
Filters []MetricAvailableFilter: List of filter types that may be used with this metric
Groupings []string: List of groupings that may be used with this metric
LastModifiedRegion string: The AWS region where the metric was last modified
LastModifiedTime float64: The timestamp where the metric was last modified
LastModifiedUser MetricCreatedByInfo
MetricArn string: The Amazon Resource Name (ARN) for the custom metric.
MetricCalculation MetricCalculationProperties: The calculation configuration for the metric
Name string: The name of the custom metric
PositiveTrendIndicator MetricPositiveTrendIndicator: Indicates how to classify a positive trend in metric data on the UI
PrimaryEventSource string: Main provider of the document/row-level data for the metric; should match Data Lake table names
PrimaryEventSourceEffectiveTimestampType string: Identifies the timestamp used to place the metrics on a time-series; should match public attribute name
RefreshRate int: Recommended time to wait between each refresh of data for the metric
SupportedStats []string: List of stat aggregations available for the metric
SupportsCustomCalculation bool: The metric may be used to compose other (custom) metrics
SupportsPreaggregateCalculation bool: The metric may be used to compose other (custom) metrics, meaning it can be used inside of aggregate stat functions
Tags Tag: One or more tags.
Type MetricType: Whether the metric is provided out-of-the-box or created by each customer
Unit MetricUnit: Display unit for the metric data

category string: The category of the custom metric
created_time number: The timestamp where the metric was created
created_user object
creation_method "SERVICE_LEVEL_BUILDER" | "METRIC_BUILDER": Whether the metric was built with the guided Service Level (SL) experience, or with the free-form metric builder
description string: The description of the custom metric
effective_time number: Earliest time that can be queried for this metric
filters list(object): List of filter types that may be used with this metric
groupings list(string): List of groupings that may be used with this metric
last_modified_region string: The AWS region where the metric was last modified
last_modified_time number: The timestamp where the metric was last modified
last_modified_user object
metric_arn string: The Amazon Resource Name (ARN) for the custom metric.
metric_calculation object: The calculation configuration for the metric
name string: The name of the custom metric
positive_trend_indicator "POSITIVE" | "NEGATIVE" | "NEUTRAL": Indicates how to classify a positive trend in metric data on the UI
primary_event_source string: Main provider of the document/row-level data for the metric; should match Data Lake table names
primary_event_source_effective_timestamp_type string: Identifies the timestamp used to place the metrics on a time-series; should match public attribute name
refresh_rate number: Recommended time to wait between each refresh of data for the metric
supported_stats list(string): List of stat aggregations available for the metric
supports_custom_calculation bool: The metric may be used to compose other (custom) metrics
supports_preaggregate_calculation bool: The metric may be used to compose other (custom) metrics, meaning it can be used inside of aggregate stat functions
tags list(object): One or more tags.
type "AWS_MANAGED" | "CUSTOMER_MANAGED": Whether the metric is provided out-of-the-box or created by each customer
unit "INTEGER" | "DOUBLE" | "PERCENT" | "SECONDS": Display unit for the metric data

category String: The category of the custom metric
createdTime Double: The timestamp where the metric was created
createdUser MetricCreatedByInfo
creationMethod MetricCreationMethod: Whether the metric was built with the guided Service Level (SL) experience, or with the free-form metric builder
description String: The description of the custom metric
effectiveTime Double: Earliest time that can be queried for this metric
filters List<MetricAvailableFilter>: List of filter types that may be used with this metric
groupings List<String>: List of groupings that may be used with this metric
lastModifiedRegion String: The AWS region where the metric was last modified
lastModifiedTime Double: The timestamp where the metric was last modified
lastModifiedUser MetricCreatedByInfo
metricArn String: The Amazon Resource Name (ARN) for the custom metric.
metricCalculation MetricCalculationProperties: The calculation configuration for the metric
name String: The name of the custom metric
positiveTrendIndicator MetricPositiveTrendIndicator: Indicates how to classify a positive trend in metric data on the UI
primaryEventSource String: Main provider of the document/row-level data for the metric; should match Data Lake table names
primaryEventSourceEffectiveTimestampType String: Identifies the timestamp used to place the metrics on a time-series; should match public attribute name
refreshRate Integer: Recommended time to wait between each refresh of data for the metric
supportedStats List<String>: List of stat aggregations available for the metric
supportsCustomCalculation Boolean: The metric may be used to compose other (custom) metrics
supportsPreaggregateCalculation Boolean: The metric may be used to compose other (custom) metrics, meaning it can be used inside of aggregate stat functions
tags List<Tag>: One or more tags.
type MetricType: Whether the metric is provided out-of-the-box or created by each customer
unit MetricUnit: Display unit for the metric data

category string: The category of the custom metric
createdTime number: The timestamp where the metric was created
createdUser MetricCreatedByInfo
creationMethod MetricCreationMethod: Whether the metric was built with the guided Service Level (SL) experience, or with the free-form metric builder
description string: The description of the custom metric
effectiveTime number: Earliest time that can be queried for this metric
filters MetricAvailableFilter[]: List of filter types that may be used with this metric
groupings string[]: List of groupings that may be used with this metric
lastModifiedRegion string: The AWS region where the metric was last modified
lastModifiedTime number: The timestamp where the metric was last modified
lastModifiedUser MetricCreatedByInfo
metricArn string: The Amazon Resource Name (ARN) for the custom metric.
metricCalculation MetricCalculationProperties: The calculation configuration for the metric
name string: The name of the custom metric
positiveTrendIndicator MetricPositiveTrendIndicator: Indicates how to classify a positive trend in metric data on the UI
primaryEventSource string: Main provider of the document/row-level data for the metric; should match Data Lake table names
primaryEventSourceEffectiveTimestampType string: Identifies the timestamp used to place the metrics on a time-series; should match public attribute name
refreshRate number: Recommended time to wait between each refresh of data for the metric
supportedStats string[]: List of stat aggregations available for the metric
supportsCustomCalculation boolean: The metric may be used to compose other (custom) metrics
supportsPreaggregateCalculation boolean: The metric may be used to compose other (custom) metrics, meaning it can be used inside of aggregate stat functions
tags Tag[]: One or more tags.
type MetricType: Whether the metric is provided out-of-the-box or created by each customer
unit MetricUnit: Display unit for the metric data

category str: The category of the custom metric
created_time float: The timestamp where the metric was created
created_user MetricCreatedByInfo
creation_method MetricCreationMethod: Whether the metric was built with the guided Service Level (SL) experience, or with the free-form metric builder
description str: The description of the custom metric
effective_time float: Earliest time that can be queried for this metric
filters Sequence[MetricAvailableFilter]: List of filter types that may be used with this metric
groupings Sequence[str]: List of groupings that may be used with this metric
last_modified_region str: The AWS region where the metric was last modified
last_modified_time float: The timestamp where the metric was last modified
last_modified_user MetricCreatedByInfo
metric_arn str: The Amazon Resource Name (ARN) for the custom metric.
metric_calculation MetricCalculationProperties: The calculation configuration for the metric
name str: The name of the custom metric
positive_trend_indicator MetricPositiveTrendIndicator: Indicates how to classify a positive trend in metric data on the UI
primary_event_source str: Main provider of the document/row-level data for the metric; should match Data Lake table names
primary_event_source_effective_timestamp_type str: Identifies the timestamp used to place the metrics on a time-series; should match public attribute name
refresh_rate int: Recommended time to wait between each refresh of data for the metric
supported_stats Sequence[str]: List of stat aggregations available for the metric
supports_custom_calculation bool: The metric may be used to compose other (custom) metrics
supports_preaggregate_calculation bool: The metric may be used to compose other (custom) metrics, meaning it can be used inside of aggregate stat functions
tags Sequence[root_Tag]: One or more tags.
type MetricType: Whether the metric is provided out-of-the-box or created by each customer
unit MetricUnit: Display unit for the metric data

category String: The category of the custom metric
createdTime Number: The timestamp where the metric was created
createdUser Property Map
creationMethod "SERVICE_LEVEL_BUILDER" | "METRIC_BUILDER": Whether the metric was built with the guided Service Level (SL) experience, or with the free-form metric builder
description String: The description of the custom metric
effectiveTime Number: Earliest time that can be queried for this metric
filters List<Property Map>: List of filter types that may be used with this metric
groupings List<String>: List of groupings that may be used with this metric
lastModifiedRegion String: The AWS region where the metric was last modified
lastModifiedTime Number: The timestamp where the metric was last modified
lastModifiedUser Property Map
metricArn String: The Amazon Resource Name (ARN) for the custom metric.
metricCalculation Property Map: The calculation configuration for the metric
name String: The name of the custom metric
positiveTrendIndicator "POSITIVE" | "NEGATIVE" | "NEUTRAL": Indicates how to classify a positive trend in metric data on the UI
primaryEventSource String: Main provider of the document/row-level data for the metric; should match Data Lake table names
primaryEventSourceEffectiveTimestampType String: Identifies the timestamp used to place the metrics on a time-series; should match public attribute name
refreshRate Number: Recommended time to wait between each refresh of data for the metric
supportedStats List<String>: List of stat aggregations available for the metric
supportsCustomCalculation Boolean: The metric may be used to compose other (custom) metrics
supportsPreaggregateCalculation Boolean: The metric may be used to compose other (custom) metrics, meaning it can be used inside of aggregate stat functions
tags List<Property Map>: One or more tags.
type "AWS_MANAGED" | "CUSTOMER_MANAGED": Whether the metric is provided out-of-the-box or created by each customer
unit "INTEGER" | "DOUBLE" | "PERCENT" | "SECONDS": Display unit for the metric data

Supporting Types

MetricAvailableFilter

Id string
Type Pulumi.AwsNative.Connect.MetricAvailableFilterType

Id string
Type MetricAvailableFilterType

id string
type "METRIC_LEVEL" | "RESOURCE_LEVEL"

id String
type MetricAvailableFilterType

id string
type MetricAvailableFilterType

id str
type MetricAvailableFilterType

id String
type "METRIC_LEVEL" | "RESOURCE_LEVEL"

MetricAvailableFilterType

MetricCalculationComponent

Alias string: Metric calculation component alias for use within a calculation
MetricFilters List<Pulumi.AwsNative.Connect.Inputs.MetricFilter>
MetricId string
MetricName string

Alias string: Metric calculation component alias for use within a calculation
MetricFilters []MetricFilter
MetricId string
MetricName string

alias string: Metric calculation component alias for use within a calculation
metric_filters list(object)
metric_id string
metric_name string

alias String: Metric calculation component alias for use within a calculation
metricFilters List<MetricFilter>
metricId String
metricName String

alias string: Metric calculation component alias for use within a calculation
metricFilters MetricFilter[]
metricId string
metricName string

alias str: Metric calculation component alias for use within a calculation
metric_filters Sequence[MetricFilter]
metric_id str
metric_name str

alias String: Metric calculation component alias for use within a calculation
metricFilters List<Property Map>
metricId String
metricName String

MetricCalculationProperties

Calculation string: The calculation formula
CalculationComponents List<Pulumi.AwsNative.Connect.Inputs.MetricCalculationComponent>: The calculation components for the metric

Calculation string: The calculation formula
CalculationComponents []MetricCalculationComponent: The calculation components for the metric

calculation string: The calculation formula
calculation_components list(object): The calculation components for the metric

calculation String: The calculation formula
calculationComponents List<MetricCalculationComponent>: The calculation components for the metric

calculation string: The calculation formula
calculationComponents MetricCalculationComponent[]: The calculation components for the metric

calculation str: The calculation formula
calculation_components Sequence[MetricCalculationComponent]: The calculation components for the metric

calculation String: The calculation formula
calculationComponents List<Property Map>: The calculation components for the metric

MetricCreatedByInfo

AwsIdentityArn string: STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.
ConnectUserArn string: An agent ARN representing a connect user.

AwsIdentityArn string: STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.
ConnectUserArn string: An agent ARN representing a connect user.

aws_identity_arn string: STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.
connect_user_arn string: An agent ARN representing a connect user.

awsIdentityArn String: STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.
connectUserArn String: An agent ARN representing a connect user.

awsIdentityArn string: STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.
connectUserArn string: An agent ARN representing a connect user.

aws_identity_arn str: STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.
connect_user_arn str: An agent ARN representing a connect user.

awsIdentityArn String: STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.
connectUserArn String: An agent ARN representing a connect user.