amazonka-codedeploy-2.0: Amazon CodeDeploy SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CodeDeploy.PutLifecycleEventHookExecutionStatus

Description

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.

Synopsis

Creating a Request

data PutLifecycleEventHookExecutionStatus Source #

Constructors

PutLifecycleEventHookExecutionStatus' 

Fields

  • deploymentId :: Maybe Text

    The unique ID of a deployment. Pass this ID to a Lambda function that validates a deployment lifecycle event.

  • lifecycleEventHookExecutionId :: Maybe Text

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

  • status :: Maybe LifecycleEventStatus

    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.

Instances

Instances details
ToJSON PutLifecycleEventHookExecutionStatus Source # 
Instance details

Defined in Amazonka.CodeDeploy.PutLifecycleEventHookExecutionStatus

ToHeaders PutLifecycleEventHookExecutionStatus Source # 
Instance details

Defined in Amazonka.CodeDeploy.PutLifecycleEventHookExecutionStatus

ToPath PutLifecycleEventHookExecutionStatus Source # 
Instance details

Defined in Amazonka.CodeDeploy.PutLifecycleEventHookExecutionStatus

ToQuery PutLifecycleEventHookExecutionStatus Source # 
Instance details

Defined in Amazonka.CodeDeploy.PutLifecycleEventHookExecutionStatus

AWSRequest PutLifecycleEventHookExecutionStatus Source # 
Instance details

Defined in Amazonka.CodeDeploy.PutLifecycleEventHookExecutionStatus

Generic PutLifecycleEventHookExecutionStatus Source # 
Instance details

Defined in Amazonka.CodeDeploy.PutLifecycleEventHookExecutionStatus

Read PutLifecycleEventHookExecutionStatus Source # 
Instance details

Defined in Amazonka.CodeDeploy.PutLifecycleEventHookExecutionStatus

Show PutLifecycleEventHookExecutionStatus Source # 
Instance details

Defined in Amazonka.CodeDeploy.PutLifecycleEventHookExecutionStatus

NFData PutLifecycleEventHookExecutionStatus Source # 
Instance details

Defined in Amazonka.CodeDeploy.PutLifecycleEventHookExecutionStatus

Eq PutLifecycleEventHookExecutionStatus Source # 
Instance details

Defined in Amazonka.CodeDeploy.PutLifecycleEventHookExecutionStatus

Hashable PutLifecycleEventHookExecutionStatus Source # 
Instance details

Defined in Amazonka.CodeDeploy.PutLifecycleEventHookExecutionStatus

type AWSResponse PutLifecycleEventHookExecutionStatus Source # 
Instance details

Defined in Amazonka.CodeDeploy.PutLifecycleEventHookExecutionStatus

type Rep PutLifecycleEventHookExecutionStatus Source # 
Instance details

Defined in Amazonka.CodeDeploy.PutLifecycleEventHookExecutionStatus

type Rep PutLifecycleEventHookExecutionStatus = D1 ('MetaData "PutLifecycleEventHookExecutionStatus" "Amazonka.CodeDeploy.PutLifecycleEventHookExecutionStatus" "amazonka-codedeploy-2.0-4OehMEUeOr9G9ZXD2VmvAo" 'False) (C1 ('MetaCons "PutLifecycleEventHookExecutionStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "lifecycleEventHookExecutionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LifecycleEventStatus)))))

newPutLifecycleEventHookExecutionStatus :: PutLifecycleEventHookExecutionStatus Source #

Create a value of PutLifecycleEventHookExecutionStatus with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

PutLifecycleEventHookExecutionStatus, putLifecycleEventHookExecutionStatus_deploymentId - The unique ID of a deployment. Pass this ID to a Lambda function that validates a deployment lifecycle event.

PutLifecycleEventHookExecutionStatus, putLifecycleEventHookExecutionStatus_lifecycleEventHookExecutionId - The execution ID of a deployment's lifecycle hook. A deployment lifecycle hook is specified in the hooks section of the AppSpec file.

PutLifecycleEventHookExecutionStatus, putLifecycleEventHookExecutionStatus_status - 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.

Request Lenses

putLifecycleEventHookExecutionStatus_deploymentId :: Lens' PutLifecycleEventHookExecutionStatus (Maybe Text) Source #

The unique ID of a deployment. Pass this ID to a Lambda function that validates a deployment lifecycle event.

putLifecycleEventHookExecutionStatus_lifecycleEventHookExecutionId :: Lens' PutLifecycleEventHookExecutionStatus (Maybe Text) Source #

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

putLifecycleEventHookExecutionStatus_status :: Lens' PutLifecycleEventHookExecutionStatus (Maybe LifecycleEventStatus) Source #

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.

Destructuring the Response

data PutLifecycleEventHookExecutionStatusResponse Source #

Constructors

PutLifecycleEventHookExecutionStatusResponse' 

Fields

Instances

Instances details
Generic PutLifecycleEventHookExecutionStatusResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.PutLifecycleEventHookExecutionStatus

Read PutLifecycleEventHookExecutionStatusResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.PutLifecycleEventHookExecutionStatus

Show PutLifecycleEventHookExecutionStatusResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.PutLifecycleEventHookExecutionStatus

NFData PutLifecycleEventHookExecutionStatusResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.PutLifecycleEventHookExecutionStatus

Eq PutLifecycleEventHookExecutionStatusResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.PutLifecycleEventHookExecutionStatus

type Rep PutLifecycleEventHookExecutionStatusResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.PutLifecycleEventHookExecutionStatus

type Rep PutLifecycleEventHookExecutionStatusResponse = D1 ('MetaData "PutLifecycleEventHookExecutionStatusResponse" "Amazonka.CodeDeploy.PutLifecycleEventHookExecutionStatus" "amazonka-codedeploy-2.0-4OehMEUeOr9G9ZXD2VmvAo" 'False) (C1 ('MetaCons "PutLifecycleEventHookExecutionStatusResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "lifecycleEventHookExecutionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutLifecycleEventHookExecutionStatusResponse Source #

Create a value of PutLifecycleEventHookExecutionStatusResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:httpStatus:PutLifecycleEventHookExecutionStatusResponse', putLifecycleEventHookExecutionStatusResponse_httpStatus - The response's http status code.

Response Lenses

putLifecycleEventHookExecutionStatusResponse_lifecycleEventHookExecutionId :: Lens' PutLifecycleEventHookExecutionStatusResponse (Maybe Text) Source #

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