Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CodeDeploy.ListDeploymentTargets

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

This operation returns paginated results.

Synopsis

data ListDeploymentTargets = ListDeploymentTargets' {
- deploymentId :: Maybe Text
- targetFilters :: Maybe (HashMap TargetFilterName [Text])
- nextToken :: Maybe Text
}
newListDeploymentTargets :: ListDeploymentTargets
listDeploymentTargets_deploymentId :: Lens' ListDeploymentTargets (Maybe Text)
listDeploymentTargets_targetFilters :: Lens' ListDeploymentTargets (Maybe (HashMap TargetFilterName [Text]))
listDeploymentTargets_nextToken :: Lens' ListDeploymentTargets (Maybe Text)
data ListDeploymentTargetsResponse = ListDeploymentTargetsResponse' {
- nextToken :: Maybe Text
- targetIds :: Maybe [Text]
- httpStatus :: Int
}
newListDeploymentTargetsResponse :: Int -> ListDeploymentTargetsResponse
listDeploymentTargetsResponse_nextToken :: Lens' ListDeploymentTargetsResponse (Maybe Text)
listDeploymentTargetsResponse_targetIds :: Lens' ListDeploymentTargetsResponse (Maybe [Text])
listDeploymentTargetsResponse_httpStatus :: Lens' ListDeploymentTargetsResponse Int

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 Methods (==) :: ListDeploymentTargets -> ListDeploymentTargets -> Bool # (/=) :: ListDeploymentTargets -> ListDeploymentTargets -> Bool #
Read ListDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeploymentTargets Methods readsPrec :: Int -> ReadS ListDeploymentTargets # readList :: ReadS [ListDeploymentTargets] # readPrec :: ReadPrec ListDeploymentTargets # readListPrec :: ReadPrec [ListDeploymentTargets] #
Show ListDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeploymentTargets Methods showsPrec :: Int -> ListDeploymentTargets -> ShowS # show :: ListDeploymentTargets -> String # showList :: [ListDeploymentTargets] -> ShowS #
Generic ListDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeploymentTargets Associated Types type Rep ListDeploymentTargets :: Type -> Type # Methods from :: ListDeploymentTargets -> Rep ListDeploymentTargets x # to :: Rep ListDeploymentTargets x -> ListDeploymentTargets #
NFData ListDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeploymentTargets Methods rnf :: ListDeploymentTargets -> () #
Hashable ListDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeploymentTargets Methods hashWithSalt :: Int -> ListDeploymentTargets -> Int # hash :: ListDeploymentTargets -> Int #
ToJSON ListDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeploymentTargets Methods toJSON :: ListDeploymentTargets -> Value # toEncoding :: ListDeploymentTargets -> Encoding # toJSONList :: [ListDeploymentTargets] -> Value # toEncodingList :: [ListDeploymentTargets] -> Encoding #
AWSPager ListDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeploymentTargets Methods page :: ListDeploymentTargets -> AWSResponse ListDeploymentTargets -> Maybe ListDeploymentTargets #
AWSRequest ListDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeploymentTargets Associated Types type AWSResponse ListDeploymentTargets # Methods request :: ListDeploymentTargets -> Request ListDeploymentTargets # response :: MonadResource m => Logger -> Service -> Proxy ListDeploymentTargets -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListDeploymentTargets))) #
ToHeaders ListDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeploymentTargets Methods toHeaders :: ListDeploymentTargets -> [Header] #
ToPath ListDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeploymentTargets Methods toPath :: ListDeploymentTargets -> ByteString #
ToQuery ListDeploymentTargets Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeploymentTargets Methods toQuery :: ListDeploymentTargets -> QueryString #
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 type AWSResponse ListDeploymentTargets = ListDeploymentTargetsResponse

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_deploymentId :: Lens' ListDeploymentTargets (Maybe Text) Source #

The unique ID of a deployment.

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 Methods (==) :: ListDeploymentTargetsResponse -> ListDeploymentTargetsResponse -> Bool # (/=) :: ListDeploymentTargetsResponse -> ListDeploymentTargetsResponse -> Bool #
Read ListDeploymentTargetsResponse Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeploymentTargets Methods readsPrec :: Int -> ReadS ListDeploymentTargetsResponse # readList :: ReadS [ListDeploymentTargetsResponse] # readPrec :: ReadPrec ListDeploymentTargetsResponse # readListPrec :: ReadPrec [ListDeploymentTargetsResponse] #
Show ListDeploymentTargetsResponse Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeploymentTargets Methods showsPrec :: Int -> ListDeploymentTargetsResponse -> ShowS # show :: ListDeploymentTargetsResponse -> String # showList :: [ListDeploymentTargetsResponse] -> ShowS #
Generic ListDeploymentTargetsResponse Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeploymentTargets Associated Types type Rep ListDeploymentTargetsResponse :: Type -> Type # Methods from :: ListDeploymentTargetsResponse -> Rep ListDeploymentTargetsResponse x # to :: Rep ListDeploymentTargetsResponse x -> ListDeploymentTargetsResponse #
NFData ListDeploymentTargetsResponse Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeploymentTargets Methods rnf :: ListDeploymentTargetsResponse -> () #
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 #

Arguments

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

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.

listDeploymentTargetsResponse_targetIds :: Lens' ListDeploymentTargetsResponse (Maybe [Text]) Source #

The unique IDs of deployment targets.

listDeploymentTargetsResponse_httpStatus :: Lens' ListDeploymentTargetsResponse Int Source #

The response's http status code.