NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $iot = Paws->service('IoT');
my $StartDetectMitigationActionsTaskResponse =
  $iot->StartDetectMitigationActionsTask(
  Actions => [
    'MyMitigationActionName', ...    # max: 128
  ],
  ClientRequestToken => 'MyClientRequestToken',
  Target             => {
    BehaviorName        => 'MyBehaviorName',    # min: 1, max: 128; OPTIONAL
    SecurityProfileName =>
      'MySecurityProfileName',                  # min: 1, max: 128; OPTIONAL
    ViolationIds => [
      'MyViolationId', ...                      # min: 1, max: 128
    ],    # min: 1, max: 25; OPTIONAL
  },
  TaskId                        => 'MyMitigationActionsTaskId',
  IncludeOnlyActiveViolations   => 1,                             # OPTIONAL
  IncludeSuppressedAlerts       => 1,                             # OPTIONAL
  ViolationEventOccurrenceRange => {
    EndTime   => '1970-01-01T01:00:00',
    StartTime => '1970-01-01T01:00:00',

  },                                                              # OPTIONAL
  );

# Results:
my $TaskId = $StartDetectMitigationActionsTaskResponse->TaskId;

# Returns a L<Paws::IoT::StartDetectMitigationActionsTaskResponse> 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/StartDetectMitigationActionsTask

ATTRIBUTES

REQUIRED Actions => ArrayRef[Str|Undef]

The actions to be performed when a device has unexpected behavior.

REQUIRED ClientRequestToken => Str

Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

IncludeOnlyActiveViolations => Bool

Specifies to list only active violations.

IncludeSuppressedAlerts => Bool

Specifies to include suppressed alerts.

REQUIRED Target => Paws::IoT::DetectMitigationActionsTaskTarget

Specifies the ML Detect findings to which the mitigation actions are applied.

REQUIRED TaskId => Str

The unique identifier of the task.

ViolationEventOccurrenceRange => Paws::IoT::ViolationEventOccurrenceRange

Specifies the time period of which violation events occurred between.

SEE ALSO

This class forms part of Paws, documenting arguments for method StartDetectMitigationActionsTask in Paws::IoT

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