Skip to content

DeploymentLifecycleHookDetail

Source code in docs_src/capo_ecs/types/deployment_lifecycle_hook_detail.py
class DeploymentLifecycleHookDetail(TypedDict, closed=True):
    hook_id: NotRequired["capo_ecs.types.string.String"]
    """<p>The ID of the lifecycle hook. Use this value when calling <code>ContinueServiceDeployment</code> to continue or roll back a paused deployment.</p>"""
    target_type: NotRequired[
        "capo_ecs.types.deployment_lifecycle_hook_target_type.DeploymentLifecycleHookTargetType"
    ]
    """<p>The type of action the lifecycle hook performs, such as <code>AWS_LAMBDA</code> or <code>PAUSE</code>.</p>"""
    target_arn: NotRequired["capo_ecs.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the hook target. For <code>AWS_LAMBDA</code> hooks, this is the Lambda function ARN. For <code>PAUSE</code> hooks, this field is not set.</p>"""
    status: NotRequired[
        "capo_ecs.types.deployment_lifecycle_hook_status.DeploymentLifecycleHookStatus"
    ]
    """<p>The status of the lifecycle hook. Valid values include <code>AWAITING_ACTION</code>, <code>IN_PROGRESS</code>, <code>SUCCEEDED</code>, <code>FAILED</code>, and <code>TIMED_OUT</code>.</p>"""
    expires_at: NotRequired["capo_ecs.types.timestamp.Timestamp"]
    """<p>The time when the lifecycle hook times out. If the hook has not been completed by this time, Amazon ECS takes the timeout action.</p>"""
    timeout_action: NotRequired[
        "capo_ecs.types.deployment_lifecycle_hook_action.DeploymentLifecycleHookAction"
    ]
    """<p>The action Amazon ECS takes when the lifecycle hook times out. Valid values are <code>CONTINUE</code> and <code>ROLLBACK</code>.</p>"""

expires_at instance-attribute

expires_at: NotRequired[Timestamp]

The time when the lifecycle hook times out. If the hook has not been completed by this time, Amazon ECS takes the timeout action.

hook_id instance-attribute

hook_id: NotRequired[String]

The ID of the lifecycle hook. Use this value when calling ContinueServiceDeployment to continue or roll back a paused deployment.

status instance-attribute

status: NotRequired[DeploymentLifecycleHookStatus]

The status of the lifecycle hook. Valid values include AWAITING_ACTION, IN_PROGRESS, SUCCEEDED, FAILED, and TIMED_OUT.

target_arn instance-attribute

target_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the hook target. For AWS_LAMBDA hooks, this is the Lambda function ARN. For PAUSE hooks, this field is not set.

target_type instance-attribute

target_type: NotRequired[DeploymentLifecycleHookTargetType]

The type of action the lifecycle hook performs, such as AWS_LAMBDA or PAUSE.

timeout_action instance-attribute

timeout_action: NotRequired[DeploymentLifecycleHookAction]

The action Amazon ECS takes when the lifecycle hook times out. Valid values are CONTINUE and ROLLBACK.