describe-mitigation-action¶
Description¶
Gets information about a mitigation action.
Requires permission to access the DescribeMitigationAction action.
See also: AWS API Documentation
Synopsis¶
describe-mitigation-action
--action-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--action-name (string)
The friendly name that uniquely identifies the mitigation action.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination.
--output (string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
on
off
auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
base64
raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To view the details for a defined mitigation action
The following describe-mitigation-action example displays details for the specified mitigation action.
aws iot describe-mitigation-action \
--action-name AddThingsToQuarantineGroupAction
Output:
{
"actionName": "AddThingsToQuarantineGroupAction",
"actionType": "ADD_THINGS_TO_THING_GROUP",
"actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroupAction",
"actionId": "2fd2726d-98e1-4abf-b10f-09465ccd6bfa",
"roleArn": "arn:aws:iam::123456789012:role/service-role/MoveThingsToQuarantineGroupRole",
"actionParams": {
"addThingsToThingGroupParams": {
"thingGroupNames": [
"QuarantineGroup1"
],
"overrideDynamicGroups": true
}
},
"creationDate": "2019-12-10T11:09:35.999000-08:00",
"lastModifiedDate": "2019-12-10T11:09:35.999000-08:00"
}
For more information, see DescribeMitigationAction (Mitigation Action Commands) in the AWS IoT Developer Guide.
Output¶
actionName -> (string)
The friendly name that uniquely identifies the mitigation action.
actionType -> (string)
The type of mitigation action.
actionArn -> (string)
The ARN that identifies this migration action.
actionId -> (string)
A unique identifier for this action.
roleArn -> (string)
The ARN of the IAM role used to apply this action.
actionParams -> (structure)
Parameters that control how the mitigation action is applied, specific to the type of mitigation action.
updateDeviceCertificateParams -> (structure)
Parameters to define a mitigation action that changes the state of the device certificate to inactive.
action -> (string)
The action that you want to apply to the device certificate. The only supported value is
DEACTIVATE.updateCACertificateParams -> (structure)
Parameters to define a mitigation action that changes the state of the CA certificate to inactive.
action -> (string)
The action that you want to apply to the CA certificate. The only supported value is
DEACTIVATE.addThingsToThingGroupParams -> (structure)
Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.
thingGroupNames -> (list)
The list of groups to which you want to add the things that triggered the mitigation action. You can add a thing to a maximum of 10 groups, but you can’t add a thing to more than one group in the same hierarchy.
(string)
overrideDynamicGroups -> (boolean)
Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic thing groups.
replaceDefaultPolicyVersionParams -> (structure)
Parameters to define a mitigation action that adds a blank policy to restrict permissions.
templateName -> (string)
The name of the template to be applied. The only supported value is
BLANK_POLICY.enableIoTLoggingParams -> (structure)
Parameters to define a mitigation action that enables Amazon Web Services IoT Core logging at a specified level of detail.
roleArnForLogging -> (string)
The Amazon Resource Name (ARN) of the IAM role used for logging.
logLevel -> (string)
Specifies the type of information to be logged.
publishFindingToSnsParams -> (structure)
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.
topicArn -> (string)
The ARN of the topic to which you want to publish the findings.
creationDate -> (timestamp)
The date and time when the mitigation action was added to your Amazon Web Services accounts.
lastModifiedDate -> (timestamp)
The date and time when the mitigation action was last changed.