Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. iot
  5. getFleetMetric

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.iot.getFleetMetric

Explore with Pulumi AI

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

An aggregated metric of certain devices in your fleet

Using getFleetMetric

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 getFleetMetric(args: GetFleetMetricArgs, opts?: InvokeOptions): Promise<GetFleetMetricResult>
function getFleetMetricOutput(args: GetFleetMetricOutputArgs, opts?: InvokeOptions): Output<GetFleetMetricResult>
Copy
def get_fleet_metric(metric_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetFleetMetricResult
def get_fleet_metric_output(metric_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetFleetMetricResult]
Copy
func LookupFleetMetric(ctx *Context, args *LookupFleetMetricArgs, opts ...InvokeOption) (*LookupFleetMetricResult, error)
func LookupFleetMetricOutput(ctx *Context, args *LookupFleetMetricOutputArgs, opts ...InvokeOption) LookupFleetMetricResultOutput
Copy

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

public static class GetFleetMetric 
{
    public static Task<GetFleetMetricResult> InvokeAsync(GetFleetMetricArgs args, InvokeOptions? opts = null)
    public static Output<GetFleetMetricResult> Invoke(GetFleetMetricInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetFleetMetricResult> getFleetMetric(GetFleetMetricArgs args, InvokeOptions options)
public static Output<GetFleetMetricResult> getFleetMetric(GetFleetMetricArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:iot:getFleetMetric
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

MetricName This property is required. string
The name of the fleet metric
MetricName This property is required. string
The name of the fleet metric
metricName This property is required. String
The name of the fleet metric
metricName This property is required. string
The name of the fleet metric
metric_name This property is required. str
The name of the fleet metric
metricName This property is required. String
The name of the fleet metric

getFleetMetric Result

The following output properties are available:

AggregationField string
The aggregation field to perform aggregation and metric emission
AggregationType Pulumi.AwsNative.IoT.Outputs.FleetMetricAggregationType
The type of the aggregation query.
CreationDate string
The creation date of a fleet metric
Description string
The description of a fleet metric
IndexName string
The index name of a fleet metric
LastModifiedDate string
The last modified date of a fleet metric
MetricArn string
The Amazon Resource Number (ARN) of a fleet metric metric
Period int
The period of metric emission in seconds
QueryString string
The Fleet Indexing query used by a fleet metric
QueryVersion string
The version of a Fleet Indexing query used by a fleet metric
Tags List<Pulumi.AwsNative.Outputs.Tag>
An array of key-value pairs to apply to this resource
Unit string
The unit of data points emitted by a fleet metric
Version double
The version of a fleet metric
AggregationField string
The aggregation field to perform aggregation and metric emission
AggregationType FleetMetricAggregationType
The type of the aggregation query.
CreationDate string
The creation date of a fleet metric
Description string
The description of a fleet metric
IndexName string
The index name of a fleet metric
LastModifiedDate string
The last modified date of a fleet metric
MetricArn string
The Amazon Resource Number (ARN) of a fleet metric metric
Period int
The period of metric emission in seconds
QueryString string
The Fleet Indexing query used by a fleet metric
QueryVersion string
The version of a Fleet Indexing query used by a fleet metric
Tags Tag
An array of key-value pairs to apply to this resource
Unit string
The unit of data points emitted by a fleet metric
Version float64
The version of a fleet metric
aggregationField String
The aggregation field to perform aggregation and metric emission
aggregationType FleetMetricAggregationType
The type of the aggregation query.
creationDate String
The creation date of a fleet metric
description String
The description of a fleet metric
indexName String
The index name of a fleet metric
lastModifiedDate String
The last modified date of a fleet metric
metricArn String
The Amazon Resource Number (ARN) of a fleet metric metric
period Integer
The period of metric emission in seconds
queryString String
The Fleet Indexing query used by a fleet metric
queryVersion String
The version of a Fleet Indexing query used by a fleet metric
tags List<Tag>
An array of key-value pairs to apply to this resource
unit String
The unit of data points emitted by a fleet metric
version Double
The version of a fleet metric
aggregationField string
The aggregation field to perform aggregation and metric emission
aggregationType FleetMetricAggregationType
The type of the aggregation query.
creationDate string
The creation date of a fleet metric
description string
The description of a fleet metric
indexName string
The index name of a fleet metric
lastModifiedDate string
The last modified date of a fleet metric
metricArn string
The Amazon Resource Number (ARN) of a fleet metric metric
period number
The period of metric emission in seconds
queryString string
The Fleet Indexing query used by a fleet metric
queryVersion string
The version of a Fleet Indexing query used by a fleet metric
tags Tag[]
An array of key-value pairs to apply to this resource
unit string
The unit of data points emitted by a fleet metric
version number
The version of a fleet metric
aggregation_field str
The aggregation field to perform aggregation and metric emission
aggregation_type FleetMetricAggregationType
The type of the aggregation query.
creation_date str
The creation date of a fleet metric
description str
The description of a fleet metric
index_name str
The index name of a fleet metric
last_modified_date str
The last modified date of a fleet metric
metric_arn str
The Amazon Resource Number (ARN) of a fleet metric metric
period int
The period of metric emission in seconds
query_string str
The Fleet Indexing query used by a fleet metric
query_version str
The version of a Fleet Indexing query used by a fleet metric
tags Sequence[root_Tag]
An array of key-value pairs to apply to this resource
unit str
The unit of data points emitted by a fleet metric
version float
The version of a fleet metric
aggregationField String
The aggregation field to perform aggregation and metric emission
aggregationType Property Map
The type of the aggregation query.
creationDate String
The creation date of a fleet metric
description String
The description of a fleet metric
indexName String
The index name of a fleet metric
lastModifiedDate String
The last modified date of a fleet metric
metricArn String
The Amazon Resource Number (ARN) of a fleet metric metric
period Number
The period of metric emission in seconds
queryString String
The Fleet Indexing query used by a fleet metric
queryVersion String
The version of a Fleet Indexing query used by a fleet metric
tags List<Property Map>
An array of key-value pairs to apply to this resource
unit String
The unit of data points emitted by a fleet metric
version Number
The version of a fleet metric

Supporting Types

FleetMetricAggregationType

Name This property is required. string
Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality
Values This property is required. List<string>
Fleet Indexing aggregation type values
Name This property is required. string
Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality
Values This property is required. []string
Fleet Indexing aggregation type values
name This property is required. String
Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality
values This property is required. List<String>
Fleet Indexing aggregation type values
name This property is required. string
Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality
values This property is required. string[]
Fleet Indexing aggregation type values
name This property is required. str
Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality
values This property is required. Sequence[str]
Fleet Indexing aggregation type values
name This property is required. String
Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality
values This property is required. List<String>
Fleet Indexing aggregation type values

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native