NAME

Paws::IoT::CreateCustomMetric - Arguments for method CreateCustomMetric on Paws::IoT

DESCRIPTION

This class represents the parameters used for calling the method CreateCustomMetric on the AWS IoT service. Use the attributes of this class as arguments to method CreateCustomMetric.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateCustomMetric.

SYNOPSIS

    my $iot = Paws->service('IoT');
    my $CreateCustomMetricResponse = $iot->CreateCustomMetric(
      ClientRequestToken => 'MyClientRequestToken',
      MetricName         => 'MyMetricName',
      MetricType         => 'string-list',
      DisplayName        => 'MyCustomMetricDisplayName',    # OPTIONAL
      Tags               => [
        {
          Key   => 'MyTagKey',      # min: 1, max: 128
          Value => 'MyTagValue',    # min: 1, max: 256; OPTIONAL
        },
        ...
      ],    # OPTIONAL
    );
    # Results:
    my $MetricArn  = $CreateCustomMetricResponse->MetricArn;
    my $MetricName = $CreateCustomMetricResponse->MetricName;
    # Returns a L<Paws::IoT::CreateCustomMetricResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/iot/CreateCustomMetric>

ATTRIBUTES

REQUIRED ClientRequestToken => Str

Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

DisplayName => Str

Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.

REQUIRED MetricName => Str

The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with "aws:". Cannot be updated once defined.

REQUIRED MetricType => Str

The type of the custom metric. Types include "string-list", "ip-address-list", "number-list", and "number".

Valid values are: "string-list", "ip-address-list", "number-list", "number"

Tags => ArrayRef[Paws::IoT::Tag]

Metadata that can be used to manage the custom metric.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>