:doc:`CloudFormation <../../cloudformation>` / Client / describe_change_set_hooks

*************************
describe_change_set_hooks
*************************



.. py:method:: CloudFormation.Client.describe_change_set_hooks(**kwargs)

  

  Returns Hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeChangeSetHooks>`_  


  **Request Syntax**
  ::

    response = client.describe_change_set_hooks(
        ChangeSetName='string',
        StackName='string',
        NextToken='string',
        LogicalResourceId='string'
    )
    
  :type ChangeSetName: string
  :param ChangeSetName: **[REQUIRED]** 

    The name or Amazon Resource Name (ARN) of the change set that you want to describe.

    

  
  :type StackName: string
  :param StackName: 

    If you specified the name of a change set, specify the stack name or stack ID (ARN) of the change set you want to describe.

    

  
  :type NextToken: string
  :param NextToken: 

    The token for the next set of items to return. (You received this token from a previous call.)

    

  
  :type LogicalResourceId: string
  :param LogicalResourceId: 

    If specified, lists only the Hooks related to the specified ``LogicalResourceId``.

    

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

    
    ::

      {
          'ChangeSetId': 'string',
          'ChangeSetName': 'string',
          'Hooks': [
              {
                  'InvocationPoint': 'PRE_PROVISION',
                  'FailureMode': 'FAIL'|'WARN',
                  'TypeName': 'string',
                  'TypeVersionId': 'string',
                  'TypeConfigurationVersionId': 'string',
                  'TargetDetails': {
                      'TargetType': 'RESOURCE',
                      'ResourceTargetDetails': {
                          'LogicalResourceId': 'string',
                          'ResourceType': 'string',
                          'ResourceAction': 'Add'|'Modify'|'Remove'|'Import'|'Dynamic'|'SyncWithActual'
                      }
                  }
              },
          ],
          'Status': 'PLANNING'|'PLANNED'|'UNAVAILABLE',
          'NextToken': 'string',
          'StackId': 'string',
          'StackName': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ChangeSetId** *(string) --* 

        The change set identifier (stack ID).

        
      

      - **ChangeSetName** *(string) --* 

        The change set name.

        
      

      - **Hooks** *(list) --* 

        List of Hook objects.

        
        

        - *(dict) --* 

          Specifies the resource, the Hook, and the Hook version to be invoked.

          
          

          - **InvocationPoint** *(string) --* 

            The specific point in the provisioning process where the Hook is invoked.

            
          

          - **FailureMode** *(string) --* 

            Specify the Hook failure mode for non-compliant resources in the followings ways.

             

            
            * ``FAIL`` Stops provisioning resources.
             
            * ``WARN`` Allows provisioning to continue with a warning message.
            

            
          

          - **TypeName** *(string) --* 

            The unique name for your Hook. Specifies a three-part namespace for your Hook, with a recommended pattern of ``Organization::Service::Hook``.

             

            .. note::

              

              The following organization namespaces are reserved and can't be used in your Hook type names:

               

              
              * ``Alexa``
               
              * ``AMZN``
               
              * ``Amazon``
               
              * ``ASK``
               
              * ``AWS``
               
              * ``Custom``
               
              * ``Dev``
              

              

            
          

          - **TypeVersionId** *(string) --* 

            The version ID of the type specified.

            
          

          - **TypeConfigurationVersionId** *(string) --* 

            The version ID of the type configuration.

            
          

          - **TargetDetails** *(dict) --* 

            Specifies details about the target that the Hook will run against.

            
            

            - **TargetType** *(string) --* 

              The Hook target type.

              
            

            - **ResourceTargetDetails** *(dict) --* 

              Required if ``TargetType`` is ``RESOURCE``.

              
              

              - **LogicalResourceId** *(string) --* 

                The resource's logical ID, which is defined in the stack's template.

                
              

              - **ResourceType** *(string) --* 

                The type of CloudFormation resource, such as ``AWS::S3::Bucket``.

                
              

              - **ResourceAction** *(string) --* 

                Specifies the action of the resource.

                
          
        
      
    
      

      - **Status** *(string) --* 

        Provides the status of the change set Hook.

        
      

      - **NextToken** *(string) --* 

        Pagination token, ``null`` or empty if no more results.

        
      

      - **StackId** *(string) --* 

        The stack identifier (stack ID).

        
      

      - **StackName** *(string) --* 

        The stack name.

        
  
  **Exceptions**
  
  *   :py:class:`CloudFormation.Client.exceptions.ChangeSetNotFoundException`

  