AWS SecurityHub

{'ProductArn': 'string'}

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 do not provide an integration ARN, then the results include all of the available product integrations.

See also: AWS API Documentation

Request Syntax

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

type NextToken:

string

param NextToken:

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.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return.

type ProductArn:

string

param ProductArn:

The ARN of the integration to return.

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',
            ],
            '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 - Indicates that the integration sends findings to Security Hub.

        • RECEIVE_FINDINGS_FROM_SECURITY_HUB - Indicates that the integration receives findings from Security Hub.

        • (string) --

      • MarketplaceUrl (string) --

        The URL for the page that contains more information about the product.

      • ActivationUrl (string) --

        The URL used to activate the product.

      • ProductSubscriptionResourcePolicy (string) --

        The resource policy associated with the product.

  • NextToken (string) --

    The pagination token to use to request the next page of results.