AWS Native

Pulumi Official
Package maintained by Pulumi
v0.19.0 published on Wednesday, Jun 8, 2022 by Pulumi

getFleetMetric

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>
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]
func LookupFleetMetric(ctx *Context, args *LookupFleetMetricArgs, opts ...InvokeOption) (*LookupFleetMetricResult, error)
func LookupFleetMetricOutput(ctx *Context, args *LookupFleetMetricOutputArgs, opts ...InvokeOption) LookupFleetMetricResultOutput

> 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)
}
public static CompletableFuture<GetFleetMetricResult> getFleetMetric(GetFleetMetricArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws-native:iot:getFleetMetric
  Arguments:
    # Arguments dictionary

The following arguments are supported:

MetricName string

The name of the fleet metric

MetricName string

The name of the fleet metric

metricName String

The name of the fleet metric

metricName string

The name of the fleet metric

metric_name str

The name of the fleet metric

metricName 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
CreationDate double

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 double

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.IoT.Outputs.FleetMetricTag>

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
CreationDate float64

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 float64

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 []FleetMetricTag

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
creationDate Double

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 Double

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<FleetMetricTag>

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
creationDate number

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 number

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 FleetMetricTag[]

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
creation_date float

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 float

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[FleetMetricTag]

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
creationDate Number

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 Number

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 string

Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality

Values List<string>

Fleet Indexing aggregation type values

Name string

Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality

Values []string

Fleet Indexing aggregation type values

name String

Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality

values List<String>

Fleet Indexing aggregation type values

name string

Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality

values string[]

Fleet Indexing aggregation type values

name str

Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality

values Sequence[str]

Fleet Indexing aggregation type values

name String

Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality

values List<String>

Fleet Indexing aggregation type values

FleetMetricTag

Key string

The tag's key

Value string

The tag's value

Key string

The tag's key

Value string

The tag's value

key String

The tag's key

value String

The tag's value

key string

The tag's key

value string

The tag's value

key str

The tag's key

value str

The tag's value

key String

The tag's key

value String

The tag's value

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0