NAME

Paws::IoTEvents::CreateAlarmModel - Arguments for method CreateAlarmModel on Paws::IoTEvents

DESCRIPTION

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

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

SYNOPSIS

    my $iotevents = Paws->service('IoTEvents');
    my $CreateAlarmModelResponse = $iotevents->CreateAlarmModel(
      AlarmModelName => 'MyAlarmModelName',
      AlarmRule      => {
        SimpleRule => {
          ComparisonOperator => 'GREATER'
          , # values: GREATER, GREATER_OR_EQUAL, LESS, LESS_OR_EQUAL, EQUAL, NOT_EQUAL
          InputProperty => 'MyInputProperty',    # min: 1, max: 512
          Threshold     => 'MyThreshold',        # min: 1, max: 512
        },    # OPTIONAL
      },
      RoleArn           => 'MyAmazonResourceName',
      AlarmCapabilities => {
        AcknowledgeFlow => {
          Enabled => 1,
        },    # OPTIONAL
        InitializationConfiguration => {
          DisabledOnInitialization => 1,
        },    # OPTIONAL
      },    # OPTIONAL
      AlarmEventActions => {
        AlarmActions => [
          {
            DynamoDB => {
              HashKeyField => 'MyDynamoKeyField',
              HashKeyValue => 'MyDynamoKeyValue',
              TableName    => 'MyDynamoTableName',
              HashKeyType  => 'MyDynamoKeyType',      # OPTIONAL
              Operation    => 'MyDynamoOperation',    # OPTIONAL
              Payload      => {
                ContentExpression => 'MyContentExpression',    # min: 1
                Type              => 'STRING',    # values: STRING, JSON
              },    # OPTIONAL
              PayloadField  => 'MyDynamoKeyField',
              RangeKeyField => 'MyDynamoKeyField',
              RangeKeyType  => 'MyDynamoKeyType',    # OPTIONAL
              RangeKeyValue => 'MyDynamoKeyValue',
            },    # OPTIONAL
            DynamoDBv2 => {
              TableName => 'MyDynamoTableName',
              Payload   => {
                ContentExpression => 'MyContentExpression',    # min: 1
                Type              => 'STRING',    # values: STRING, JSON
              },    # OPTIONAL
            },    # OPTIONAL
            Firehose => {
              DeliveryStreamName => 'MyDeliveryStreamName',
              Payload            => {
                ContentExpression => 'MyContentExpression',    # min: 1
                Type              => 'STRING',    # values: STRING, JSON
              },    # OPTIONAL
              Separator => 'MyFirehoseSeparator',    # OPTIONAL
            },    # OPTIONAL
            IotEvents => {
              InputName => 'MyInputName',    # min: 1, max: 128
              Payload   => {
                ContentExpression => 'MyContentExpression',    # min: 1
                Type              => 'STRING',    # values: STRING, JSON
              },    # OPTIONAL
            },    # OPTIONAL
            IotSiteWise => {
              AssetId       => 'MyAssetId',                 # OPTIONAL
              EntryId       => 'MyAssetPropertyEntryId',    # OPTIONAL
              PropertyAlias => 'MyAssetPropertyAlias',      # OPTIONAL
              PropertyId    => 'MyAssetPropertyId',         # OPTIONAL
              PropertyValue => {
                Quality   => 'MyAssetPropertyQuality',      # OPTIONAL
                Timestamp => {
                  TimeInSeconds => 'MyAssetPropertyTimeInSeconds',
                  OffsetInNanos => 'MyAssetPropertyOffsetInNanos',    # OPTIONAL
                },    # OPTIONAL
                Value => {
                  BooleanValue => 'MyAssetPropertyBooleanValue',    # OPTIONAL
                  DoubleValue  => 'MyAssetPropertyDoubleValue',     # OPTIONAL
                  IntegerValue => 'MyAssetPropertyIntegerValue',    # OPTIONAL
                  StringValue  => 'MyAssetPropertyStringValue',     # OPTIONAL
                },    # OPTIONAL
              },    # OPTIONAL
            },    # OPTIONAL
            IotTopicPublish => {
              MqttTopic => 'MyMQTTTopic',    # min: 1, max: 128
              Payload   => {
                ContentExpression => 'MyContentExpression',    # min: 1
                Type              => 'STRING',    # values: STRING, JSON
              },    # OPTIONAL
            },    # OPTIONAL
            Lambda => {
              FunctionArn => 'MyAmazonResourceName',    # min: 1, max: 2048
              Payload     => {
                ContentExpression => 'MyContentExpression',    # min: 1
                Type              => 'STRING',    # values: STRING, JSON
              },    # OPTIONAL
            },    # OPTIONAL
            Sns => {
              TargetArn => 'MyAmazonResourceName',    # min: 1, max: 2048
              Payload   => {
                ContentExpression => 'MyContentExpression',    # min: 1
                Type              => 'STRING',    # values: STRING, JSON
              },    # OPTIONAL
            },    # OPTIONAL
            Sqs => {
              QueueUrl => 'MyQueueUrl',
              Payload  => {
                ContentExpression => 'MyContentExpression',    # min: 1
                Type              => 'STRING',    # values: STRING, JSON
              },    # OPTIONAL
              UseBase64 => 1,    # OPTIONAL
            },    # OPTIONAL
          },
          ...
        ],    # OPTIONAL
      },    # OPTIONAL
      AlarmModelDescription => 'MyAlarmModelDescription',    # OPTIONAL
      AlarmNotification     => {
        NotificationActions => [
          {
            Action => {
              LambdaAction => {
                FunctionArn => 'MyAmazonResourceName',    # min: 1, max: 2048
                Payload     => {
                  ContentExpression => 'MyContentExpression',    # min: 1
                  Type              => 'STRING',    # values: STRING, JSON
                },    # OPTIONAL
              },    # OPTIONAL
            },
            EmailConfigurations => [
              {
                From       => 'MyFromEmail',
                Recipients => {
                  To => [
                    {
                      SsoIdentity => {
                        IdentityStoreId => 'MyIdentityStoreId',
                        UserId          => 'MySSOReferenceId',    # OPTIONAL
                      },    # OPTIONAL
                    },
                    ...
                  ],    # min: 1; OPTIONAL
                },
                Content => {
                  AdditionalMessage =>
                    'MyNotificationAdditionalMessage',    # OPTIONAL
                  Subject => 'MyEmailSubject',            # OPTIONAL
                },    # OPTIONAL
              },
              ...
            ],    # min: 1; OPTIONAL
            SmsConfigurations => [
              {
                Recipients => [
                  {
                    SsoIdentity => {
                      IdentityStoreId => 'MyIdentityStoreId',
                      UserId          => 'MySSOReferenceId',    # OPTIONAL
                    },    # OPTIONAL
                  },
                  ...
                ],    # min: 1; OPTIONAL
                AdditionalMessage =>
                  'MyNotificationAdditionalMessage',    # OPTIONAL
                SenderId => 'MySMSSenderId',            # OPTIONAL
              },
              ...
            ],    # min: 1; OPTIONAL
          },
          ...
        ],    # min: 1; OPTIONAL
      },    # OPTIONAL
      Key      => 'MyAttributeJsonPath',    # OPTIONAL
      Severity => 1,                        # OPTIONAL
      Tags     => [
        {
          Key   => 'MyTagKey',      # min: 1, max: 128
          Value => 'MyTagValue',    # max: 256
        },
        ...
      ],    # OPTIONAL
    );
    # Results:
    my $AlarmModelArn     = $CreateAlarmModelResponse->AlarmModelArn;
    my $AlarmModelVersion = $CreateAlarmModelResponse->AlarmModelVersion;
    my $CreationTime      = $CreateAlarmModelResponse->CreationTime;
    my $LastUpdateTime    = $CreateAlarmModelResponse->LastUpdateTime;
    my $Status            = $CreateAlarmModelResponse->Status;
    # Returns a L<Paws::IoTEvents::CreateAlarmModelResponse> 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/iotevents/CreateAlarmModel>

ATTRIBUTES

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateAlarmModel in Paws::IoTEvents

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>