put_lifecycle_event_hook_execution_status

put_lifecycle_event_hook_execution_status(**kwargs)

Sets the result of a Lambda validation function. The function validates lifecycle hooks during a deployment that uses the Lambda or Amazon ECS compute platform. For Lambda deployments, the available lifecycle hooks are BeforeAllowTraffic and AfterAllowTraffic . For Amazon ECS deployments, the available lifecycle hooks are BeforeInstall , AfterInstall , AfterAllowTestTraffic , BeforeAllowTraffic , and AfterAllowTraffic . Lambda validation functions return Succeeded or Failed . For more information, see AppSpec 'hooks' Section for an Lambda Deployment and AppSpec 'hooks' Section for an Amazon ECS Deployment.

See also: AWS API Documentation

Request Syntax

response = client.put_lifecycle_event_hook_execution_status(
    deploymentId='string',
    lifecycleEventHookExecutionId='string',
    status='Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'
)

Parameters

• deploymentId (string) -- The unique ID of a deployment. Pass this ID to a Lambda function that validates a deployment lifecycle event.
• lifecycleEventHookExecutionId (string) -- The execution ID of a deployment's lifecycle hook. A deployment lifecycle hook is specified in the hooks section of the AppSpec file.
• status (string) -- The result of a Lambda function that validates a deployment lifecycle event. The values listed in Valid Values are valid for lifecycle statuses in general; however, only Succeeded and Failed can be passed successfully in your API call.

Return type

dict

Returns

Response Syntax

{
    'lifecycleEventHookExecutionId': 'string'
}

Response Structure

• (dict) --

  • lifecycleEventHookExecutionId (string) --

    The execution ID of the lifecycle event hook. A hook is specified in the hooks section of the deployment's AppSpec file.

Exceptions

• CodeDeploy.Client.exceptions.InvalidLifecycleEventHookExecutionStatusException
• CodeDeploy.Client.exceptions.InvalidLifecycleEventHookExecutionIdException
• CodeDeploy.Client.exceptions.LifecycleEventAlreadyCompletedException
• CodeDeploy.Client.exceptions.DeploymentIdRequiredException
• CodeDeploy.Client.exceptions.DeploymentDoesNotExistException
• CodeDeploy.Client.exceptions.InvalidDeploymentIdException
• CodeDeploy.Client.exceptions.UnsupportedActionForDeploymentTypeException