DescribeMitigationAction
Gets information about a mitigation action.
Requires permission to access the DescribeMitigationAction action.
Request Syntax
GET /mitigationactions/actions/actionName HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- actionName
-
The friendly name that uniquely identifies the mitigation action.
Length Constraints: Maximum length of 128.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"actionArn": "string",
"actionId": "string",
"actionName": "string",
"actionParams": {
"addThingsToThingGroupParams": {
"overrideDynamicGroups": boolean,
"thingGroupNames": [ "string" ]
},
"enableIoTLoggingParams": {
"logLevel": "string",
"roleArnForLogging": "string"
},
"publishFindingToSnsParams": {
"topicArn": "string"
},
"replaceDefaultPolicyVersionParams": {
"templateName": "string"
},
"updateCACertificateParams": {
"action": "string"
},
"updateDeviceCertificateParams": {
"action": "string"
}
},
"actionType": "string",
"creationDate": number,
"lastModifiedDate": number,
"roleArn": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- actionArn
-
The ARN that identifies this migration action.
Type: String
- actionId
-
A unique identifier for this action.
Type: String
- actionName
-
The friendly name that uniquely identifies the mitigation action.
Type: String
Length Constraints: Maximum length of 128.
Pattern:
[a-zA-Z0-9_-]+ - actionParams
-
Parameters that control how the mitigation action is applied, specific to the type of mitigation action.
Type: MitigationActionParams object
- actionType
-
The type of mitigation action.
Type: String
Valid Values:
UPDATE_DEVICE_CERTIFICATE | UPDATE_CA_CERTIFICATE | ADD_THINGS_TO_THING_GROUP | REPLACE_DEFAULT_POLICY_VERSION | ENABLE_IOT_LOGGING | PUBLISH_FINDING_TO_SNS - creationDate
-
The date and time when the mitigation action was added to your AWS accounts.
Type: Timestamp
- lastModifiedDate
-
The date and time when the mitigation action was last changed.
Type: Timestamp
- roleArn
-
The ARN of the IAM role used to apply this action.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Errors
- InternalFailureException
-
An unexpected error has occurred.
- message
-
The message for the exception.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
- message
-
The message for the exception.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource does not exist.
- message
-
The message for the exception.
HTTP Status Code: 404
- ThrottlingException
-
The rate exceeds the limit.
- message
-
The message for the exception.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
