Skip to content

RemediationStep

Source code in docs_src/capo_securityhub/types/remediation_step.py
class RemediationStep(TypedDict, closed=True):
    phase: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The phase of the remediation plan that this step belongs to (for example, <code>FIX</code>).</p>"""
    description: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>A description of what the step does.</p>"""
    service: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>Which service this step is performed in.</p>"""
    action: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The action to be taken for this step.</p>"""
    logic: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The logic behind the existence of this step.</p>"""
    inverse: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The inverse of the step, to be used if the step needs to be rolled back.</p>"""
    verify_after: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The action to take after the step to verify its success.</p>"""

action instance-attribute

action: NotRequired[NonEmptyString]

The action to be taken for this step.

description instance-attribute

description: NotRequired[NonEmptyString]

A description of what the step does.

inverse instance-attribute

inverse: NotRequired[NonEmptyString]

The inverse of the step, to be used if the step needs to be rolled back.

logic instance-attribute

logic: NotRequired[NonEmptyString]

The logic behind the existence of this step.

phase instance-attribute

phase: NotRequired[NonEmptyString]

The phase of the remediation plan that this step belongs to (for example, FIX).

service instance-attribute

service: NotRequired[NonEmptyString]

Which service this step is performed in.

verify_after instance-attribute

verify_after: NotRequired[NonEmptyString]

The action to take after the step to verify its success.