SecurityHub / Client / describe_products

describe_products¶

SecurityHub.Client.describe_products(**kwargs)¶

Returns information about product integrations in Security Hub.

You can optionally provide an integration ARN. If you provide an integration ARN, then the results only include that integration.

If you don’t provide an integration ARN, then the results include all of the available product integrations.

Request Syntax

response = client.describe_products(
    NextToken='string',
    MaxResults=123,
    ProductArn='string'
)

Parameters:

NextToken (string) –
The token that is required for pagination. On your first call to the DescribeProducts operation, set the value of this parameter to NULL.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
MaxResults (integer) – The maximum number of results to return.
ProductArn (string) – The ARN of the integration to return.

Return type:

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'
        },
    ],
    'NextToken': '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.
- NextToken (string) –
  
  The pagination token to use to request the next page of results.

Exceptions

SecurityHub.Client.exceptions.InternalException
SecurityHub.Client.exceptions.LimitExceededException
SecurityHub.Client.exceptions.InvalidAccessException
SecurityHub.Client.exceptions.InvalidInputException