Skip to content

Product

Source code in docs_src/capo_securityhub/types/product.py
class Product(TypedDict, closed=True):
    product_arn: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The ARN assigned to the product.</p>"""
    product_name: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The name of the product.</p>"""
    company_name: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The name of the company that provides the product.</p>"""
    description: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>A description of the product.</p>"""
    categories: NotRequired["capo_securityhub.types.category_list.CategoryList"]
    """<p>The categories assigned to the product.</p>"""
    integration_types: NotRequired[
        "capo_securityhub.types.integration_type_list.IntegrationTypeList"
    ]
    """<p>The types of integration that the product supports. Available values are the following.</p> <ul> <li> <p> <code>SEND_FINDINGS_TO_SECURITY_HUB</code> - The integration sends findings to Security Hub CSPM.</p> </li> <li> <p> <code>RECEIVE_FINDINGS_FROM_SECURITY_HUB</code> - The integration receives findings from Security Hub CSPM.</p> </li> <li> <p> <code>UPDATE_FINDINGS_IN_SECURITY_HUB</code> - The integration does not send new findings to Security Hub CSPM, but does make updates to the findings that it receives from Security Hub CSPM.</p> </li> </ul>"""
    marketplace_url: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>For integrations with Amazon Web Services services, the Amazon Web Services Console URL from which to activate the service.</p> <p>For integrations with third-party products, the Amazon Web Services Marketplace URL from which to subscribe to or purchase the product.</p>"""
    activation_url: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The URL to the service or product documentation about the integration with Security Hub CSPM, including how to activate the integration.</p>"""
    product_subscription_resource_policy: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The resource policy associated with the product.</p>"""

activation_url instance-attribute

activation_url: NotRequired[NonEmptyString]

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

categories instance-attribute

categories: NotRequired[CategoryList]

The categories assigned to the product.

company_name instance-attribute

company_name: NotRequired[NonEmptyString]

The name of the company that provides the product.

description instance-attribute

description: NotRequired[NonEmptyString]

A description of the product.

integration_types instance-attribute

integration_types: NotRequired[IntegrationTypeList]

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 CSPM.

  • RECEIVE_FINDINGS_FROM_SECURITY_HUB - The integration receives findings from Security Hub CSPM.

  • UPDATE_FINDINGS_IN_SECURITY_HUB - The integration does not send new findings to Security Hub CSPM, but does make updates to the findings that it receives from Security Hub CSPM.

marketplace_url instance-attribute

marketplace_url: NotRequired[NonEmptyString]

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.

product_arn instance-attribute

product_arn: NotRequired[NonEmptyString]

The ARN assigned to the product.

product_name instance-attribute

product_name: NotRequired[NonEmptyString]

The name of the product.

product_subscription_resource_policy instance-attribute

product_subscription_resource_policy: NotRequired[NonEmptyString]

The resource policy associated with the product.