Skip to content

RemediationGuidanceMetadata

Source code in docs_src/capo_securityhub/types/remediation_guidance_metadata.py
class RemediationGuidanceMetadata(TypedDict, closed=True):
    resource_type: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The resource type of the remediation target.</p>"""
    exposure_type: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The exposure type of the related exposure findings.</p>"""
    trait_titles: NotRequired[
        "capo_securityhub.types.remediation_string_list.RemediationStringList"
    ]
    """<p>The titles of traits this guidance applies to.</p>"""
    reversibility: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The extent to which changes made in accordance with the guidance can be reversed, for example <code>Fully reversible</code>.</p>"""
    fix_effect: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>When the fix takes effect, for example <code>Immediate</code> or <code>Deferred</code>.</p>"""
    risk_level: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The risk when implementing the guidance provided.</p>"""
    automation_level: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The extent to which the guidance can be automated, for example <code>Full</code>.</p>"""
    human_review_required: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Specifies whether human review is required.</p>"""
    generated_at: NotRequired["capo_securityhub.types.timestamp.Timestamp"]
    """<p>Timestamp of when the guidance was generated.</p> <p>For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p>"""
    verification_status: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>Verification status of the guidance.</p>"""

automation_level instance-attribute

automation_level: NotRequired[NonEmptyString]

The extent to which the guidance can be automated, for example Full.

exposure_type instance-attribute

exposure_type: NotRequired[NonEmptyString]

The exposure type of the related exposure findings.

fix_effect instance-attribute

fix_effect: NotRequired[NonEmptyString]

When the fix takes effect, for example Immediate or Deferred.

generated_at instance-attribute

generated_at: NotRequired[Timestamp]

Timestamp of when the guidance was generated.

For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.

human_review_required instance-attribute

human_review_required: NotRequired[Boolean]

Specifies whether human review is required.

resource_type instance-attribute

resource_type: NotRequired[NonEmptyString]

The resource type of the remediation target.

reversibility instance-attribute

reversibility: NotRequired[NonEmptyString]

The extent to which changes made in accordance with the guidance can be reversed, for example Fully reversible.

risk_level instance-attribute

risk_level: NotRequired[NonEmptyString]

The risk when implementing the guidance provided.

trait_titles instance-attribute

trait_titles: NotRequired[RemediationStringList]

The titles of traits this guidance applies to.

verification_status instance-attribute

verification_status: NotRequired[NonEmptyString]

Verification status of the guidance.