:doc:`SecurityHub <../../securityhub>` / Paginator / DescribeProducts

****************
DescribeProducts
****************



.. py:class:: SecurityHub.Paginator.DescribeProducts

  ::

    
    paginator = client.get_paginator('describe_products')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`SecurityHub.Client.describe_products`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DescribeProducts>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ProductArn='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ProductArn: string
    :param ProductArn: 

      The ARN of the integration to return.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

        {
            'Products': [
                {
                    'ProductArn': 'string',
                    'ProductName': 'string',
                    'CompanyName': 'string',
                    'Description': 'string',
                    'Categories': [
                        'string',
                    ],
                    'IntegrationTypes': [
                        'SEND_FINDINGS_TO_SECURITY_HUB'|'RECEIVE_FINDINGS_FROM_SECURITY_HUB'|'UPDATE_FINDINGS_IN_SECURITY_HUB',
                    ],
                    'MarketplaceUrl': 'string',
                    'ActivationUrl': 'string',
                    'ProductSubscriptionResourcePolicy': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Products** *(list) --* 

          A list of products, including details for each product.

          
          

          - *(dict) --* 

            Contains details about a product.

            
            

            - **ProductArn** *(string) --* 

              The ARN assigned to the product.

              
            

            - **ProductName** *(string) --* 

              The name of the product.

              
            

            - **CompanyName** *(string) --* 

              The name of the company that provides the product.

              
            

            - **Description** *(string) --* 

              A description of the product.

              
            

            - **Categories** *(list) --* 

              The categories assigned to the product.

              
              

              - *(string) --* 
          
            

            - **IntegrationTypes** *(list) --* 

              The types of integration that the product supports. Available values are the following.

               

              
              * ``SEND_FINDINGS_TO_SECURITY_HUB`` - The integration sends findings to Security Hub.
               
              * ``RECEIVE_FINDINGS_FROM_SECURITY_HUB`` - The integration receives findings from Security Hub.
               
              * ``UPDATE_FINDINGS_IN_SECURITY_HUB`` - The integration does not send new findings to Security Hub, but does make updates to the findings that it receives from Security Hub.
              

              
              

              - *(string) --* 
          
            

            - **MarketplaceUrl** *(string) --* 

              For integrations with Amazon Web Services services, the Amazon Web Services Console URL from which to activate the service.

               

              For integrations with third-party products, the Amazon Web Services Marketplace URL from which to subscribe to or purchase the product.

              
            

            - **ActivationUrl** *(string) --* 

              The URL to the service or product documentation about the integration with Security Hub, including how to activate the integration.

              
            

            - **ProductSubscriptionResourcePolicy** *(string) --* 

              The resource policy associated with the product.

              
        
      
    