Skip to content

StandardsSubscription

Source code in docs_src/capo_securityhub/types/standards_subscription.py
class StandardsSubscription(TypedDict, closed=True):
    standards_subscription_arn: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The ARN of the resource that represents your subscription to the standard.</p>"""
    standards_arn: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The ARN of the standard.</p>"""
    standards_input: NotRequired[
        "capo_securityhub.types.standards_input_parameter_map.StandardsInputParameterMap"
    ]
    """<p>A key-value pair of input for the standard.</p>"""
    standards_status: NotRequired[
        "capo_securityhub.types.standards_status.StandardsStatus"
    ]
    """<p>The status of your subscription to the standard. Possible values are:</p> <ul> <li> <p> <code>PENDING</code> - The standard is in the process of being enabled. Or the standard is already enabled and Security Hub CSPM is adding new controls to the standard.</p> </li> <li> <p> <code>READY</code> - The standard is enabled.</p> </li> <li> <p> <code>INCOMPLETE</code> - The standard could not be enabled completely. One or more errors (<code>StandardsStatusReason</code>) occurred when Security Hub CSPM attempted to enable the standard.</p> </li> <li> <p> <code>DELETING</code> - The standard is in the process of being disabled.</p> </li> <li> <p> <code>FAILED</code> - The standard could not be disabled. One or more errors (<code>StandardsStatusReason</code>) occurred when Security Hub CSPM attempted to disable the standard.</p> </li> </ul>"""
    standards_controls_updatable: NotRequired[
        "capo_securityhub.types.standards_controls_updatable.StandardsControlsUpdatable"
    ]
    """<p>Specifies whether you can retrieve information about and configure individual controls that apply to the standard. Possible values are:</p> <ul> <li> <p> <code>READY_FOR_UPDATES</code> - Controls in the standard can be retrieved and configured.</p> </li> <li> <p> <code>NOT_READY_FOR_UPDATES</code> - Controls in the standard cannot be retrieved or configured.</p> </li> </ul>"""
    standards_status_reason: NotRequired[
        "capo_securityhub.types.standards_status_reason.StandardsStatusReason"
    ]
    """<p>The reason for the current status.</p>"""
    provider: NotRequired["capo_securityhub.types.standards_provider.StandardsProvider"]
    """<p>The cloud provider whose resources the standard evaluates. For example, <code>AWS</code> or <code>Azure</code>.</p>"""

provider instance-attribute

provider: NotRequired[StandardsProvider]

The cloud provider whose resources the standard evaluates. For example, AWS or Azure.

standards_arn instance-attribute

standards_arn: NotRequired[NonEmptyString]

The ARN of the standard.

standards_controls_updatable instance-attribute

standards_controls_updatable: NotRequired[StandardsControlsUpdatable]

Specifies whether you can retrieve information about and configure individual controls that apply to the standard. Possible values are:

  • READY_FOR_UPDATES - Controls in the standard can be retrieved and configured.

  • NOT_READY_FOR_UPDATES - Controls in the standard cannot be retrieved or configured.

standards_input instance-attribute

standards_input: NotRequired[StandardsInputParameterMap]

A key-value pair of input for the standard.

standards_status instance-attribute

standards_status: NotRequired[StandardsStatus]

The status of your subscription to the standard. Possible values are:

  • PENDING - The standard is in the process of being enabled. Or the standard is already enabled and Security Hub CSPM is adding new controls to the standard.

  • READY - The standard is enabled.

  • INCOMPLETE - The standard could not be enabled completely. One or more errors (StandardsStatusReason) occurred when Security Hub CSPM attempted to enable the standard.

  • DELETING - The standard is in the process of being disabled.

  • FAILED - The standard could not be disabled. One or more errors (StandardsStatusReason) occurred when Security Hub CSPM attempted to disable the standard.

standards_status_reason instance-attribute

standards_status_reason: NotRequired[StandardsStatusReason]

The reason for the current status.

standards_subscription_arn instance-attribute

standards_subscription_arn: NotRequired[NonEmptyString]

The ARN of the resource that represents your subscription to the standard.