libZSservicesZSamazonka-codedeployZSamazonka-codedeploy
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CodeDeploy.ListDeploymentTargets

Description

Returns an array of target IDs that are associated a deployment.

This operation returns paginated results.

Synopsis

Creating a Request

data ListDeploymentTargets Source #

See: newListDeploymentTargets smart constructor.

Constructors

ListDeploymentTargets' 

Fields

  • deploymentId :: Maybe Text

    The unique ID of a deployment.

  • targetFilters :: Maybe (HashMap TargetFilterName [Text])

    A key used to filter the returned targets. The two valid values are:

    • TargetStatus - A TargetStatus filter string can be Failed, InProgress, Pending, Ready, Skipped, Succeeded, or Unknown.
    • ServerInstanceLabel - A ServerInstanceLabel filter string can be Blue or Green.
  • nextToken :: Maybe Text

    A token identifier returned from the previous ListDeploymentTargets call. It can be used to return the next set of deployment targets in the list.

Instances

Instances details
Eq ListDeploymentTargets Source # 
Instance details

Defined in Amazonka.CodeDeploy.ListDeploymentTargets

Read ListDeploymentTargets Source # 
Instance details

Defined in Amazonka.CodeDeploy.ListDeploymentTargets

Show ListDeploymentTargets Source # 
Instance details

Defined in Amazonka.CodeDeploy.ListDeploymentTargets

Generic ListDeploymentTargets Source # 
Instance details

Defined in Amazonka.CodeDeploy.ListDeploymentTargets

Associated Types

type Rep ListDeploymentTargets :: Type -> Type #

NFData ListDeploymentTargets Source # 
Instance details

Defined in Amazonka.CodeDeploy.ListDeploymentTargets

Methods

rnf :: ListDeploymentTargets -> () #

Hashable ListDeploymentTargets Source # 
Instance details

Defined in Amazonka.CodeDeploy.ListDeploymentTargets

ToJSON ListDeploymentTargets Source # 
Instance details

Defined in Amazonka.CodeDeploy.ListDeploymentTargets

AWSPager ListDeploymentTargets Source # 
Instance details

Defined in Amazonka.CodeDeploy.ListDeploymentTargets

AWSRequest ListDeploymentTargets Source # 
Instance details

Defined in Amazonka.CodeDeploy.ListDeploymentTargets

Associated Types

type AWSResponse ListDeploymentTargets #

ToHeaders ListDeploymentTargets Source # 
Instance details

Defined in Amazonka.CodeDeploy.ListDeploymentTargets

ToPath ListDeploymentTargets Source # 
Instance details

Defined in Amazonka.CodeDeploy.ListDeploymentTargets

ToQuery ListDeploymentTargets Source # 
Instance details

Defined in Amazonka.CodeDeploy.ListDeploymentTargets

type Rep ListDeploymentTargets Source # 
Instance details

Defined in Amazonka.CodeDeploy.ListDeploymentTargets

type Rep ListDeploymentTargets = D1 ('MetaData "ListDeploymentTargets" "Amazonka.CodeDeploy.ListDeploymentTargets" "libZSservicesZSamazonka-codedeployZSamazonka-codedeploy" 'False) (C1 ('MetaCons "ListDeploymentTargets'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "targetFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap TargetFilterName [Text]))) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))
type AWSResponse ListDeploymentTargets Source # 
Instance details

Defined in Amazonka.CodeDeploy.ListDeploymentTargets

newListDeploymentTargets :: ListDeploymentTargets Source #

Create a value of ListDeploymentTargets 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:deploymentId:ListDeploymentTargets', listDeploymentTargets_deploymentId - The unique ID of a deployment.

$sel:targetFilters:ListDeploymentTargets', listDeploymentTargets_targetFilters - A key used to filter the returned targets. The two valid values are:

  • TargetStatus - A TargetStatus filter string can be Failed, InProgress, Pending, Ready, Skipped, Succeeded, or Unknown.
  • ServerInstanceLabel - A ServerInstanceLabel filter string can be Blue or Green.

$sel:nextToken:ListDeploymentTargets', listDeploymentTargets_nextToken - A token identifier returned from the previous ListDeploymentTargets call. It can be used to return the next set of deployment targets in the list.

Request Lenses

listDeploymentTargets_targetFilters :: Lens' ListDeploymentTargets (Maybe (HashMap TargetFilterName [Text])) Source #

A key used to filter the returned targets. The two valid values are:

  • TargetStatus - A TargetStatus filter string can be Failed, InProgress, Pending, Ready, Skipped, Succeeded, or Unknown.
  • ServerInstanceLabel - A ServerInstanceLabel filter string can be Blue or Green.

listDeploymentTargets_nextToken :: Lens' ListDeploymentTargets (Maybe Text) Source #

A token identifier returned from the previous ListDeploymentTargets call. It can be used to return the next set of deployment targets in the list.

Destructuring the Response

data ListDeploymentTargetsResponse Source #

See: newListDeploymentTargetsResponse smart constructor.

Constructors

ListDeploymentTargetsResponse' 

Fields

  • nextToken :: Maybe Text

    If a large amount of information is returned, a token identifier is also returned. It can be used in a subsequent ListDeploymentTargets call to return the next set of deployment targets in the list.

  • targetIds :: Maybe [Text]

    The unique IDs of deployment targets.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListDeploymentTargetsResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.ListDeploymentTargets

Read ListDeploymentTargetsResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.ListDeploymentTargets

Show ListDeploymentTargetsResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.ListDeploymentTargets

Generic ListDeploymentTargetsResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.ListDeploymentTargets

Associated Types

type Rep ListDeploymentTargetsResponse :: Type -> Type #

NFData ListDeploymentTargetsResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.ListDeploymentTargets

type Rep ListDeploymentTargetsResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.ListDeploymentTargets

type Rep ListDeploymentTargetsResponse = D1 ('MetaData "ListDeploymentTargetsResponse" "Amazonka.CodeDeploy.ListDeploymentTargets" "libZSservicesZSamazonka-codedeployZSamazonka-codedeploy" 'False) (C1 ('MetaCons "ListDeploymentTargetsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "targetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDeploymentTargetsResponse Source #

Create a value of ListDeploymentTargetsResponse 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:nextToken:ListDeploymentTargets', listDeploymentTargetsResponse_nextToken - If a large amount of information is returned, a token identifier is also returned. It can be used in a subsequent ListDeploymentTargets call to return the next set of deployment targets in the list.

$sel:targetIds:ListDeploymentTargetsResponse', listDeploymentTargetsResponse_targetIds - The unique IDs of deployment targets.

$sel:httpStatus:ListDeploymentTargetsResponse', listDeploymentTargetsResponse_httpStatus - The response's http status code.

Response Lenses

listDeploymentTargetsResponse_nextToken :: Lens' ListDeploymentTargetsResponse (Maybe Text) Source #

If a large amount of information is returned, a token identifier is also returned. It can be used in a subsequent ListDeploymentTargets call to return the next set of deployment targets in the list.