NAME

Paws::IoTEvents - Perl Interface to AWS AWS IoT Events

SYNOPSIS

  use Paws;
  my $obj = Paws->service('IoTEvents');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use AWS IoT Events API operations to create, read, update, and delete inputs and detector models, and to list their versions.

For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27>

METHODS

CreateAlarmModel

AlarmModelName => Str
AlarmRule => Paws::IoTEvents::AlarmRule
RoleArn => Str
[AlarmCapabilities => Paws::IoTEvents::AlarmCapabilities]
[AlarmEventActions => Paws::IoTEvents::AlarmEventActions]
[AlarmModelDescription => Str]
[AlarmNotification => Paws::IoTEvents::AlarmNotification]
[Key => Str]
[Severity => Int]
[Tags => ArrayRef[Paws::IoTEvents::Tag]]

Each argument is described in detail in: Paws::IoTEvents::CreateAlarmModel

Returns: a Paws::IoTEvents::CreateAlarmModelResponse instance

Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see Create an alarm model (https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html) in the AWS IoT Events Developer Guide.

CreateDetectorModel

DetectorModelDefinition => Paws::IoTEvents::DetectorModelDefinition
DetectorModelName => Str
RoleArn => Str
[DetectorModelDescription => Str]
[EvaluationMethod => Str]
[Key => Str]
[Tags => ArrayRef[Paws::IoTEvents::Tag]]

Each argument is described in detail in: Paws::IoTEvents::CreateDetectorModel

Returns: a Paws::IoTEvents::CreateDetectorModelResponse instance

Creates a detector model.

CreateInput

InputDefinition => Paws::IoTEvents::InputDefinition
InputName => Str
[InputDescription => Str]
[Tags => ArrayRef[Paws::IoTEvents::Tag]]

Each argument is described in detail in: Paws::IoTEvents::CreateInput

Returns: a Paws::IoTEvents::CreateInputResponse instance

Creates an input.

DeleteAlarmModel

AlarmModelName => Str

Each argument is described in detail in: Paws::IoTEvents::DeleteAlarmModel

Returns: a Paws::IoTEvents::DeleteAlarmModelResponse instance

Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.

DeleteDetectorModel

DetectorModelName => Str

Each argument is described in detail in: Paws::IoTEvents::DeleteDetectorModel

Returns: a Paws::IoTEvents::DeleteDetectorModelResponse instance

Deletes a detector model. Any active instances of the detector model are also deleted.

DeleteInput

InputName => Str

Each argument is described in detail in: Paws::IoTEvents::DeleteInput

Returns: a Paws::IoTEvents::DeleteInputResponse instance

Deletes an input.

DescribeAlarmModel

AlarmModelName => Str
[AlarmModelVersion => Str]

Each argument is described in detail in: Paws::IoTEvents::DescribeAlarmModel

Returns: a Paws::IoTEvents::DescribeAlarmModelResponse instance

Retrieves information about an alarm model. If you don't specify a value for the "alarmModelVersion" parameter, the latest version is returned.

DescribeDetectorModel

DetectorModelName => Str
[DetectorModelVersion => Str]

Each argument is described in detail in: Paws::IoTEvents::DescribeDetectorModel

Returns: a Paws::IoTEvents::DescribeDetectorModelResponse instance

Describes a detector model. If the "version" parameter is not specified, information about the latest version is returned.

DescribeDetectorModelAnalysis

AnalysisId => Str

Each argument is described in detail in: Paws::IoTEvents::DescribeDetectorModelAnalysis

Returns: a Paws::IoTEvents::DescribeDetectorModelAnalysisResponse instance

Retrieves runtime information about a detector model analysis.

After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.

DescribeInput

InputName => Str

Each argument is described in detail in: Paws::IoTEvents::DescribeInput

Returns: a Paws::IoTEvents::DescribeInputResponse instance

Describes an input.

DescribeLoggingOptions

Each argument is described in detail in: Paws::IoTEvents::DescribeLoggingOptions

Returns: a Paws::IoTEvents::DescribeLoggingOptionsResponse instance

Retrieves the current settings of the AWS IoT Events logging options.

GetDetectorModelAnalysisResults

AnalysisId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::IoTEvents::GetDetectorModelAnalysisResults

Returns: a Paws::IoTEvents::GetDetectorModelAnalysisResultsResponse instance

Retrieves one or more analysis results of the detector model.

After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.

ListAlarmModels

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::IoTEvents::ListAlarmModels

Returns: a Paws::IoTEvents::ListAlarmModelsResponse instance

Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.

ListAlarmModelVersions

AlarmModelName => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::IoTEvents::ListAlarmModelVersions

Returns: a Paws::IoTEvents::ListAlarmModelVersionsResponse instance

Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.

ListDetectorModels

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::IoTEvents::ListDetectorModels

Returns: a Paws::IoTEvents::ListDetectorModelsResponse instance

Lists the detector models you have created. Only the metadata associated with each detector model is returned.

ListDetectorModelVersions

DetectorModelName => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::IoTEvents::ListDetectorModelVersions

Returns: a Paws::IoTEvents::ListDetectorModelVersionsResponse instance

Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.

ListInputRoutings

InputIdentifier => Paws::IoTEvents::InputIdentifier
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::IoTEvents::ListInputRoutings

Returns: a Paws::IoTEvents::ListInputRoutingsResponse instance

Lists one or more input routings.

ListInputs

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::IoTEvents::ListInputs

Returns: a Paws::IoTEvents::ListInputsResponse instance

Lists the inputs you have created.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::IoTEvents::ListTagsForResource

Returns: a Paws::IoTEvents::ListTagsForResourceResponse instance

Lists the tags (metadata) you have assigned to the resource.

PutLoggingOptions

LoggingOptions => Paws::IoTEvents::LoggingOptions

Each argument is described in detail in: Paws::IoTEvents::PutLoggingOptions

Returns: nothing

Sets or updates the AWS IoT Events logging options.

If you update the value of any "loggingOptions" field, it takes up to one minute for the change to take effect. If you change the policy attached to the role you specified in the "roleArn" field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.

StartDetectorModelAnalysis

DetectorModelDefinition => Paws::IoTEvents::DetectorModelDefinition

Each argument is described in detail in: Paws::IoTEvents::StartDetectorModelAnalysis

Returns: a Paws::IoTEvents::StartDetectorModelAnalysisResponse instance

Performs an analysis of your detector model. For more information, see Troubleshooting a detector model (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html) in the AWS IoT Events Developer Guide.