View a markdown version of this page

DeploymentLifecycleHookDetail - Amazon Elastic Container Service

DeploymentLifecycleHookDetail

The details of a deployment lifecycle hook that is active during a service deployment.

You can view lifecycle hook details by calling DescribeServiceDeployments.

Contents

expiresAt

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

Type: Timestamp

Required: No

hookId

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

Type: String

Required: No

status

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

Type: String

Valid Values: AWAITING_ACTION | IN_PROGRESS | SUCCEEDED | FAILED | TIMED_OUT

Required: No

targetArn

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.

Type: String

Required: No

targetType

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

Type: String

Valid Values: AWS_LAMBDA | PAUSE

Required: No

timeoutAction

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

Type: String

Valid Values: ROLLBACK | CONTINUE

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: