/mitigationactions/actions/{actionName}

Gets information about a mitigation action.

Requires permission to access the DescribeMitigationAction action.

{ "actionName": "string", "actionType": "UPDATE_DEVICE_CERTIFICATE", "actionArn": "string", "actionId": "string", "roleArn": "string", "actionParams": { "updateDeviceCertificateParams": { "action": "DEACTIVATE" }, "updateCACertificateParams": { "action": "DEACTIVATE" }, "addThingsToThingGroupParams": { "thingGroupNames": [], "overrideDynamicGroups": true }, "replaceDefaultPolicyVersionParams": { "templateName": "BLANK_POLICY" }, "enableIoTLoggingParams": { "roleArnForLogging": "string", "logLevel": "INFO" }, "publishFindingToSnsParams": { "topicArn": "string" } }, "creationDate": "string", "lastModifiedDate": "string" }

Responses

🟢200Success

application/json

Body

actionName

string

optional

The friendly name that uniquely identifies the mitigation action.

<= 128 characters

Match pattern:

[a-zA-Z0-9_-]+

actionType

enum<string>

optional

The type of mitigation action.

Allowed values:

UPDATE_DEVICE_CERTIFICATEUPDATE_CA_CERTIFICATEADD_THINGS_TO_THING_GROUPREPLACE_DEFAULT_POLICY_VERSIONENABLE_IOT_LOGGINGPUBLISH_FINDING_TO_SNS

actionArn

string

optional

The ARN that identifies this migration action.

actionId

string

optional

A unique identifier for this action.

roleArn

string

optional

The ARN of the IAM role used to apply this action.

>= 20 characters<= 2048 characters

actionParams

object

optional

Parameters that control how the mitigation action is applied, specific to the type of mitigation action.

updateDeviceCertificateParams

object

optional

Parameters to define a mitigation action that changes the state of the device certificate to inactive.

updateCACertificateParams

object

optional

Parameters to define a mitigation action that changes the state of the CA certificate to inactive.

addThingsToThingGroupParams

object

optional

Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.

replaceDefaultPolicyVersionParams

object

optional

Parameters to define a mitigation action that adds a blank policy to restrict permissions.

enableIoTLoggingParams

object

optional

Parameters to define a mitigation action that enables Amazon Web Services IoT Core logging at a specified level of detail.

publishFindingToSnsParams

object

optional

Parameters to define a mitigation action that publishes findings to Amazon Simple Notification Service (Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.

creationDate

string <date-time>

optional

The date and time when the mitigation action was added to your Amazon Web Services accounts.

lastModifiedDate

string <date-time>

optional

The date and time when the mitigation action was last changed.

🟠480InvalidRequestException

🟠481ResourceNotFoundException

🟠482ThrottlingException

🟠483InternalFailureException