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

**********************
describe_resource_scan
**********************



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

  

  Describes details of a resource scan.

  

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


  **Request Syntax**
  ::

    response = client.describe_resource_scan(
        ResourceScanId='string'
    )
    
  :type ResourceScanId: string
  :param ResourceScanId: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the resource scan.

    

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

    
    ::

      {
          'ResourceScanId': 'string',
          'Status': 'IN_PROGRESS'|'FAILED'|'COMPLETE'|'EXPIRED',
          'StatusReason': 'string',
          'StartTime': datetime(2015, 1, 1),
          'EndTime': datetime(2015, 1, 1),
          'PercentageCompleted': 123.0,
          'ResourceTypes': [
              'string',
          ],
          'ResourcesScanned': 123,
          'ResourcesRead': 123,
          'ScanFilters': [
              {
                  'Types': [
                      'string',
                  ]
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ResourceScanId** *(string) --* 

        The Amazon Resource Name (ARN) of the resource scan. The format is ``arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}``. An example is ``arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 ``.

        
      

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

        Status of the resource scan.

           IN_PROGRESS   

        The resource scan is still in progress.

           COMPLETE   

        The resource scan is complete.

           EXPIRED   

        The resource scan has expired.

           FAILED   

        The resource scan has failed.

        
      

      - **StatusReason** *(string) --* 

        The reason for the resource scan status, providing more information if a failure happened.

        
      

      - **StartTime** *(datetime) --* 

        The time that the resource scan was started.

        
      

      - **EndTime** *(datetime) --* 

        The time that the resource scan was finished.

        
      

      - **PercentageCompleted** *(float) --* 

        The percentage of the resource scan that has been completed.

        
      

      - **ResourceTypes** *(list) --* 

        The list of resource types for the specified scan. Resource types are only available for scans with a ``Status`` set to ``COMPLETE`` or ``FAILED ``.

        
        

        - *(string) --* 
    
      

      - **ResourcesScanned** *(integer) --* 

        The number of resources that were listed. This is only available for scans with a ``Status`` set to ``COMPLETE``, ``EXPIRED``, or ``FAILED ``.

        
      

      - **ResourcesRead** *(integer) --* 

        The number of resources that were read. This is only available for scans with a ``Status`` set to ``COMPLETE``, ``EXPIRED``, or ``FAILED``.

         

        .. note::

          

          This field may be 0 if the resource scan failed with a ``ResourceScanLimitExceededException``.

          

        
      

      - **ScanFilters** *(list) --* 

        The scan filters that were used.

        
        

        - *(dict) --* 

          A filter that is used to specify which resource types to scan.

          
          

          - **Types** *(list) --* 

            An array of strings where each string represents an Amazon Web Services resource type you want to scan. Each string defines the resource type using the format ``AWS::ServiceName::ResourceType``, for example, ``AWS::DynamoDB::Table``. For the full list of supported resource types, see the `Resource type support <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html>`__ table in the *CloudFormation User Guide*.

             

            To scan all resource types within a service, you can use a wildcard, represented by an asterisk ( ``*``). You can place an asterisk at only the end of the string, for example, ``AWS::S3::*``.

            
            

            - *(string) --* 
        
      
    
  
  **Exceptions**
  
  *   :py:class:`CloudFormation.Client.exceptions.ResourceScanNotFoundException`

  