:doc:`IoT <../../iot>` / Client / describe_mitigation_action

**************************
describe_mitigation_action
**************************



.. py:method:: IoT.Client.describe_mitigation_action(**kwargs)

  

  Gets information about a mitigation action.

   

  Requires permission to access the `DescribeMitigationAction <https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions>`__ action.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iot-2015-05-28/DescribeMitigationAction>`_  


  **Request Syntax**
  ::

    response = client.describe_mitigation_action(
        actionName='string'
    )
    
  :type actionName: string
  :param actionName: **[REQUIRED]** 

    The friendly name that uniquely identifies the mitigation action.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'actionName': 'string',
          'actionType': 'UPDATE_DEVICE_CERTIFICATE'|'UPDATE_CA_CERTIFICATE'|'ADD_THINGS_TO_THING_GROUP'|'REPLACE_DEFAULT_POLICY_VERSION'|'ENABLE_IOT_LOGGING'|'PUBLISH_FINDING_TO_SNS',
          'actionArn': 'string',
          'actionId': 'string',
          'roleArn': 'string',
          'actionParams': {
              'updateDeviceCertificateParams': {
                  'action': 'DEACTIVATE'
              },
              'updateCACertificateParams': {
                  'action': 'DEACTIVATE'
              },
              'addThingsToThingGroupParams': {
                  'thingGroupNames': [
                      'string',
                  ],
                  'overrideDynamicGroups': True|False
              },
              'replaceDefaultPolicyVersionParams': {
                  'templateName': 'BLANK_POLICY'
              },
              'enableIoTLoggingParams': {
                  'roleArnForLogging': 'string',
                  'logLevel': 'DEBUG'|'INFO'|'ERROR'|'WARN'|'DISABLED'
              },
              'publishFindingToSnsParams': {
                  'topicArn': 'string'
              }
          },
          'creationDate': datetime(2015, 1, 1),
          'lastModifiedDate': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **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** *(dict) --* 

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

        
        

        - **updateDeviceCertificateParams** *(dict) --* 

          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** *(dict) --* 

          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** *(dict) --* 

          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** *(dict) --* 

          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** *(dict) --* 

          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** *(dict) --* 

          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** *(datetime) --* 

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

        
      

      - **lastModifiedDate** *(datetime) --* 

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

        
  
  **Exceptions**
  
  *   :py:class:`IoT.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`IoT.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`IoT.Client.exceptions.ThrottlingException`

  
  *   :py:class:`IoT.Client.exceptions.InternalFailureException`

  