SecurityHub / Client / describe_products_v2

describe_products_v2

SecurityHub.Client.describe_products_v2(**kwargs)

Gets information about the product integration. This API is in public preview and subject to change.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• NextToken (string) – The token required for pagination. On your first call, set the value of this parameter to NULL. For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.

• MaxResults (integer) – The maximum number of results to return.

Return type:

dict

Returns:

Response Syntax

{
    'ProductsV2': [
        {
            'ProductV2Name': 'string',
            'CompanyName': 'string',
            'Description': 'string',
            'Categories': [
                'string',
            ],
            'IntegrationV2Types': [
                'SEND_FINDINGS_TO_SECURITY_HUB'|'RECEIVE_FINDINGS_FROM_SECURITY_HUB'|'UPDATE_FINDINGS_IN_SECURITY_HUB',
            ],
            'MarketplaceUrl': 'string',
            'ActivationUrl': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • ProductsV2 (list) –

    Gets information about the product integration.

    • (dict) –

      Defines the structure for the productV2.

      • ProductV2Name (string) –

        The name of the productV2.

      • CompanyName (string) –

        The name of the organization or vendor that provides the productV2.

      • Description (string) –

        Detailed information about the productV2.

      • Categories (list) –

        The domains or functional areas the productV2 addresses.

        • (string) –

      • IntegrationV2Types (list) –

        The type of integration.

        • (string) –

      • MarketplaceUrl (string) –

        The console URL where you can purchase or subscribe to products.

      • ActivationUrl (string) –

        The URL to the serviceV@ or productV2 documentation about the integration, which includes how to activate the integration.

  • NextToken (string) –

    The pagination token to use to request the next page of results. Otherwise, this parameter is null.

Exceptions

• SecurityHub.Client.exceptions.InternalServerException

• SecurityHub.Client.exceptions.ThrottlingException

• SecurityHub.Client.exceptions.AccessDeniedException

• SecurityHub.Client.exceptions.ValidationException

• SecurityHub.Client.exceptions.ConflictException