Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CodeDeploy.BatchGetDeploymentTargets

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns an array of one or more targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated BatchGetDeploymentInstances. The maximum number of targets that can be returned is 25.

The type of targets returned depends on the deployment's compute platform or deployment method:

EC2/On-premises: Information about Amazon EC2 instance targets.
Lambda: Information about Lambda functions targets.
Amazon ECS: Information about Amazon ECS service targets.
CloudFormation: Information about targets of blue/green deployments initiated by a CloudFormation stack update.

Creating a Request

data BatchGetDeploymentTargets Source #

See: newBatchGetDeploymentTargets smart constructor.

Constructors

BatchGetDeploymentTargets'

Fields

deploymentId :: Maybe Text
The unique ID of a deployment.
targetIds :: Maybe [Text]
The unique IDs of the deployment targets. The compute platform of the deployment determines the type of the targets and their formats. The maximum number of deployment target IDs you can specify is 25.
- For deployments that use the EC2/On-premises compute platform, the target IDs are Amazon EC2 or on-premises instances IDs, and their target type is instanceTarget.
- For deployments that use the Lambda compute platform, the target IDs are the names of Lambda functions, and their target type is instanceTarget.
- For deployments that use the Amazon ECS compute platform, the target IDs are pairs of Amazon ECS clusters and services specified using the format <clustername>:<servicename>. Their target type is ecsTarget.
- For deployments that are deployed with CloudFormation, the target IDs are CloudFormation stack IDs. Their target type is cloudFormationTarget.

Instances

Instances details

ToJSON BatchGetDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.BatchGetDeploymentTargets Methods toJSON :: BatchGetDeploymentTargets -> Value # toEncoding :: BatchGetDeploymentTargets -> Encoding # toJSONList :: [BatchGetDeploymentTargets] -> Value # toEncodingList :: [BatchGetDeploymentTargets] -> Encoding #
ToHeaders BatchGetDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.BatchGetDeploymentTargets Methods toHeaders :: BatchGetDeploymentTargets -> [Header] #
ToPath BatchGetDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.BatchGetDeploymentTargets Methods toPath :: BatchGetDeploymentTargets -> ByteString #
ToQuery BatchGetDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.BatchGetDeploymentTargets Methods toQuery :: BatchGetDeploymentTargets -> QueryString #
AWSRequest BatchGetDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.BatchGetDeploymentTargets Associated Types type AWSResponse BatchGetDeploymentTargets # Methods request :: (Service -> Service) -> BatchGetDeploymentTargets -> Request BatchGetDeploymentTargets # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy BatchGetDeploymentTargets -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse BatchGetDeploymentTargets))) #
Generic BatchGetDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.BatchGetDeploymentTargets Associated Types type Rep BatchGetDeploymentTargets :: Type -> Type # Methods from :: BatchGetDeploymentTargets -> Rep BatchGetDeploymentTargets x # to :: Rep BatchGetDeploymentTargets x -> BatchGetDeploymentTargets #
Read BatchGetDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.BatchGetDeploymentTargets Methods readsPrec :: Int -> ReadS BatchGetDeploymentTargets # readList :: ReadS [BatchGetDeploymentTargets] # readPrec :: ReadPrec BatchGetDeploymentTargets # readListPrec :: ReadPrec [BatchGetDeploymentTargets] #
Show BatchGetDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.BatchGetDeploymentTargets Methods showsPrec :: Int -> BatchGetDeploymentTargets -> ShowS # show :: BatchGetDeploymentTargets -> String # showList :: [BatchGetDeploymentTargets] -> ShowS #
NFData BatchGetDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.BatchGetDeploymentTargets Methods rnf :: BatchGetDeploymentTargets -> () #
Eq BatchGetDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.BatchGetDeploymentTargets Methods (==) :: BatchGetDeploymentTargets -> BatchGetDeploymentTargets -> Bool # (/=) :: BatchGetDeploymentTargets -> BatchGetDeploymentTargets -> Bool #
Hashable BatchGetDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.BatchGetDeploymentTargets Methods hashWithSalt :: Int -> BatchGetDeploymentTargets -> Int # hash :: BatchGetDeploymentTargets -> Int #
type AWSResponse BatchGetDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.BatchGetDeploymentTargets type AWSResponse BatchGetDeploymentTargets = BatchGetDeploymentTargetsResponse
type Rep BatchGetDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.BatchGetDeploymentTargets type Rep BatchGetDeploymentTargets = D1 ('MetaData "BatchGetDeploymentTargets" "Amazonka.CodeDeploy.BatchGetDeploymentTargets" "amazonka-codedeploy-2.0-4OehMEUeOr9G9ZXD2VmvAo" 'False) (C1 ('MetaCons "BatchGetDeploymentTargets'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "targetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))

newBatchGetDeploymentTargets :: BatchGetDeploymentTargets Source #

Create a value of BatchGetDeploymentTargets 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:

BatchGetDeploymentTargets, batchGetDeploymentTargets_deploymentId - The unique ID of a deployment.

$sel:targetIds:BatchGetDeploymentTargets', batchGetDeploymentTargets_targetIds - The unique IDs of the deployment targets. The compute platform of the deployment determines the type of the targets and their formats. The maximum number of deployment target IDs you can specify is 25.

For deployments that use the EC2/On-premises compute platform, the target IDs are Amazon EC2 or on-premises instances IDs, and their target type is instanceTarget.
For deployments that use the Lambda compute platform, the target IDs are the names of Lambda functions, and their target type is instanceTarget.
For deployments that use the Amazon ECS compute platform, the target IDs are pairs of Amazon ECS clusters and services specified using the format <clustername>:<servicename>. Their target type is ecsTarget.
For deployments that are deployed with CloudFormation, the target IDs are CloudFormation stack IDs. Their target type is cloudFormationTarget.

Request Lenses

batchGetDeploymentTargets_deploymentId :: Lens' BatchGetDeploymentTargets (Maybe Text) Source #

The unique ID of a deployment.

batchGetDeploymentTargets_targetIds :: Lens' BatchGetDeploymentTargets (Maybe [Text]) Source #

The unique IDs of the deployment targets. The compute platform of the deployment determines the type of the targets and their formats. The maximum number of deployment target IDs you can specify is 25.

For deployments that use the EC2/On-premises compute platform, the target IDs are Amazon EC2 or on-premises instances IDs, and their target type is instanceTarget.
For deployments that use the Lambda compute platform, the target IDs are the names of Lambda functions, and their target type is instanceTarget.
For deployments that use the Amazon ECS compute platform, the target IDs are pairs of Amazon ECS clusters and services specified using the format <clustername>:<servicename>. Their target type is ecsTarget.
For deployments that are deployed with CloudFormation, the target IDs are CloudFormation stack IDs. Their target type is cloudFormationTarget.

Destructuring the Response

data BatchGetDeploymentTargetsResponse Source #

See: newBatchGetDeploymentTargetsResponse smart constructor.

Constructors

BatchGetDeploymentTargetsResponse'

Fields

deploymentTargets :: Maybe [DeploymentTarget]
A list of target objects for a deployment. Each target object contains details about the target, such as its status and lifecycle events. The type of the target objects depends on the deployment' compute platform.
- EC2/On-premises: Each target object is an Amazon EC2 or on-premises instance.
- Lambda: The target object is a specific version of an Lambda function.
- Amazon ECS: The target object is an Amazon ECS service.
- CloudFormation: The target object is an CloudFormation blue/green deployment.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic BatchGetDeploymentTargetsResponse Source #
Instance details Defined in Amazonka.CodeDeploy.BatchGetDeploymentTargets Associated Types type Rep BatchGetDeploymentTargetsResponse :: Type -> Type # Methods from :: BatchGetDeploymentTargetsResponse -> Rep BatchGetDeploymentTargetsResponse x # to :: Rep BatchGetDeploymentTargetsResponse x -> BatchGetDeploymentTargetsResponse #
Read BatchGetDeploymentTargetsResponse Source #
Instance details Defined in Amazonka.CodeDeploy.BatchGetDeploymentTargets Methods readsPrec :: Int -> ReadS BatchGetDeploymentTargetsResponse # readList :: ReadS [BatchGetDeploymentTargetsResponse] # readPrec :: ReadPrec BatchGetDeploymentTargetsResponse # readListPrec :: ReadPrec [BatchGetDeploymentTargetsResponse] #
Show BatchGetDeploymentTargetsResponse Source #
Instance details Defined in Amazonka.CodeDeploy.BatchGetDeploymentTargets Methods showsPrec :: Int -> BatchGetDeploymentTargetsResponse -> ShowS # show :: BatchGetDeploymentTargetsResponse -> String # showList :: [BatchGetDeploymentTargetsResponse] -> ShowS #
NFData BatchGetDeploymentTargetsResponse Source #
Instance details Defined in Amazonka.CodeDeploy.BatchGetDeploymentTargets Methods rnf :: BatchGetDeploymentTargetsResponse -> () #
Eq BatchGetDeploymentTargetsResponse Source #
Instance details Defined in Amazonka.CodeDeploy.BatchGetDeploymentTargets Methods (==) :: BatchGetDeploymentTargetsResponse -> BatchGetDeploymentTargetsResponse -> Bool # (/=) :: BatchGetDeploymentTargetsResponse -> BatchGetDeploymentTargetsResponse -> Bool #
type Rep BatchGetDeploymentTargetsResponse Source #
Instance details Defined in Amazonka.CodeDeploy.BatchGetDeploymentTargets type Rep BatchGetDeploymentTargetsResponse = D1 ('MetaData "BatchGetDeploymentTargetsResponse" "Amazonka.CodeDeploy.BatchGetDeploymentTargets" "amazonka-codedeploy-2.0-4OehMEUeOr9G9ZXD2VmvAo" 'False) (C1 ('MetaCons "BatchGetDeploymentTargetsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deploymentTargets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DeploymentTarget])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newBatchGetDeploymentTargetsResponse Source #

Arguments

:: Int	`$sel:httpStatus:BatchGetDeploymentTargetsResponse'`
-> BatchGetDeploymentTargetsResponse

Create a value of BatchGetDeploymentTargetsResponse 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:

$sel:deploymentTargets:BatchGetDeploymentTargetsResponse', batchGetDeploymentTargetsResponse_deploymentTargets - A list of target objects for a deployment. Each target object contains details about the target, such as its status and lifecycle events. The type of the target objects depends on the deployment' compute platform.

EC2/On-premises: Each target object is an Amazon EC2 or on-premises instance.
Lambda: The target object is a specific version of an Lambda function.
Amazon ECS: The target object is an Amazon ECS service.
CloudFormation: The target object is an CloudFormation blue/green deployment.

$sel:httpStatus:BatchGetDeploymentTargetsResponse', batchGetDeploymentTargetsResponse_httpStatus - The response's http status code.

Response Lenses

batchGetDeploymentTargetsResponse_deploymentTargets :: Lens' BatchGetDeploymentTargetsResponse (Maybe [DeploymentTarget]) Source #

A list of target objects for a deployment. Each target object contains details about the target, such as its status and lifecycle events. The type of the target objects depends on the deployment' compute platform.

EC2/On-premises: Each target object is an Amazon EC2 or on-premises instance.
Lambda: The target object is a specific version of an Lambda function.
Amazon ECS: The target object is an Amazon ECS service.
CloudFormation: The target object is an CloudFormation blue/green deployment.

batchGetDeploymentTargetsResponse_httpStatus :: Lens' BatchGetDeploymentTargetsResponse Int Source #

The response's http status code.