GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::IoTEvents::UpdateAlarmModel(3) User Contributed Perl Documentation Paws::IoTEvents::UpdateAlarmModel(3)

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

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

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

    my $iotevents = Paws->service('IoTEvents');
    my $UpdateAlarmModelResponse = $iotevents->UpdateAlarmModel(
      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
      Severity => 1,    # OPTIONAL
    );
    # Results:
    my $AlarmModelArn     = $UpdateAlarmModelResponse->AlarmModelArn;
    my $AlarmModelVersion = $UpdateAlarmModelResponse->AlarmModelVersion;
    my $CreationTime      = $UpdateAlarmModelResponse->CreationTime;
    my $LastUpdateTime    = $UpdateAlarmModelResponse->LastUpdateTime;
    my $Status            = $UpdateAlarmModelResponse->Status;
    # Returns a L<Paws::IoTEvents::UpdateAlarmModelResponse> 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/UpdateAlarmModel>

Contains the configuration information of alarm state changes.

Contains information about one or more alarm actions.

The description of the alarm model.

REQUIRED AlarmModelName => Str

The name of the alarm model.

Contains information about one or more notification actions.

REQUIRED AlarmRule => Paws::IoTEvents::AlarmRule

Defines when your alarm is invoked.

REQUIRED RoleArn => Str

The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the AWS General Reference.

A non-negative integer that reflects the severity level of the alarm.

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

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>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.