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.ListDeployments

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the deployments in a deployment group for an application registered with the IAM user or AWS account.

This operation returns paginated results.

Synopsis

data ListDeployments = ListDeployments' {
- createTimeRange :: Maybe TimeRange
- nextToken :: Maybe Text
- includeOnlyStatuses :: Maybe [DeploymentStatus]
- applicationName :: Maybe Text
- externalId :: Maybe Text
- deploymentGroupName :: Maybe Text
}
newListDeployments :: ListDeployments
listDeployments_createTimeRange :: Lens' ListDeployments (Maybe TimeRange)
listDeployments_nextToken :: Lens' ListDeployments (Maybe Text)
listDeployments_includeOnlyStatuses :: Lens' ListDeployments (Maybe [DeploymentStatus])
listDeployments_applicationName :: Lens' ListDeployments (Maybe Text)
listDeployments_externalId :: Lens' ListDeployments (Maybe Text)
listDeployments_deploymentGroupName :: Lens' ListDeployments (Maybe Text)
data ListDeploymentsResponse = ListDeploymentsResponse' {
- nextToken :: Maybe Text
- deployments :: Maybe [Text]
- httpStatus :: Int
}
newListDeploymentsResponse :: Int -> ListDeploymentsResponse
listDeploymentsResponse_nextToken :: Lens' ListDeploymentsResponse (Maybe Text)
listDeploymentsResponse_deployments :: Lens' ListDeploymentsResponse (Maybe [Text])
listDeploymentsResponse_httpStatus :: Lens' ListDeploymentsResponse Int

Creating a Request

data ListDeployments Source #

Represents the input of a ListDeployments operation.

See: newListDeployments smart constructor.

Constructors

ListDeployments'

Fields

createTimeRange :: Maybe TimeRange
A time range (start and end) for returning a subset of the list of deployments.
nextToken :: Maybe Text
An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.
includeOnlyStatuses :: Maybe [DeploymentStatus]
A subset of deployments to list by status:
- Created: Include created deployments in the resulting list.
- Queued: Include queued deployments in the resulting list.
- In Progress: Include in-progress deployments in the resulting list.
- Succeeded: Include successful deployments in the resulting list.
- Failed: Include failed deployments in the resulting list.
- Stopped: Include stopped deployments in the resulting list.
applicationName :: Maybe Text
The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
If applicationName is specified, then deploymentGroupName must be specified. If it is not specified, then deploymentGroupName must not be specified.
externalId :: Maybe Text
The unique ID of an external resource for returning deployments linked to the external resource.
deploymentGroupName :: Maybe Text
The name of a deployment group for the specified application.
If deploymentGroupName is specified, then applicationName must be specified. If it is not specified, then applicationName must not be specified.

Instances

Instances details

Eq ListDeployments Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeployments Methods (==) :: ListDeployments -> ListDeployments -> Bool # (/=) :: ListDeployments -> ListDeployments -> Bool #
Read ListDeployments Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeployments Methods readsPrec :: Int -> ReadS ListDeployments # readList :: ReadS [ListDeployments] # readPrec :: ReadPrec ListDeployments # readListPrec :: ReadPrec [ListDeployments] #
Show ListDeployments Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeployments Methods showsPrec :: Int -> ListDeployments -> ShowS # show :: ListDeployments -> String # showList :: [ListDeployments] -> ShowS #
Generic ListDeployments Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeployments Associated Types type Rep ListDeployments :: Type -> Type # Methods from :: ListDeployments -> Rep ListDeployments x # to :: Rep ListDeployments x -> ListDeployments #
NFData ListDeployments Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeployments Methods rnf :: ListDeployments -> () #
Hashable ListDeployments Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeployments Methods hashWithSalt :: Int -> ListDeployments -> Int # hash :: ListDeployments -> Int #
ToJSON ListDeployments Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeployments Methods toJSON :: ListDeployments -> Value # toEncoding :: ListDeployments -> Encoding # toJSONList :: [ListDeployments] -> Value # toEncodingList :: [ListDeployments] -> Encoding #
AWSPager ListDeployments Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeployments Methods page :: ListDeployments -> AWSResponse ListDeployments -> Maybe ListDeployments #
AWSRequest ListDeployments Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeployments Associated Types type AWSResponse ListDeployments # Methods request :: ListDeployments -> Request ListDeployments # response :: MonadResource m => Logger -> Service -> Proxy ListDeployments -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListDeployments))) #
ToHeaders ListDeployments Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeployments Methods toHeaders :: ListDeployments -> [Header] #
ToPath ListDeployments Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeployments Methods toPath :: ListDeployments -> ByteString #
ToQuery ListDeployments Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeployments Methods toQuery :: ListDeployments -> QueryString #
type Rep ListDeployments Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeployments type Rep ListDeployments = D1 ('MetaData "ListDeployments" "Amazonka.CodeDeploy.ListDeployments" "libZSservicesZSamazonka-codedeployZSamazonka-codedeploy" 'False) (C1 ('MetaCons "ListDeployments'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createTimeRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeRange)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "includeOnlyStatuses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DeploymentStatus])))) :: (S1 ('MetaSel ('Just "applicationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "deploymentGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))
type AWSResponse ListDeployments Source #
Instance details Defined in Amazonka.CodeDeploy.ListDeployments type AWSResponse ListDeployments = ListDeploymentsResponse

newListDeployments :: ListDeployments Source #

Create a value of ListDeployments 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:createTimeRange:ListDeployments', listDeployments_createTimeRange - A time range (start and end) for returning a subset of the list of deployments.

$sel:nextToken:ListDeployments', listDeployments_nextToken - An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.

$sel:includeOnlyStatuses:ListDeployments', listDeployments_includeOnlyStatuses - A subset of deployments to list by status:

Created: Include created deployments in the resulting list.
Queued: Include queued deployments in the resulting list.
In Progress: Include in-progress deployments in the resulting list.
Succeeded: Include successful deployments in the resulting list.
Failed: Include failed deployments in the resulting list.
Stopped: Include stopped deployments in the resulting list.

$sel:applicationName:ListDeployments', listDeployments_applicationName - The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

If applicationName is specified, then deploymentGroupName must be specified. If it is not specified, then deploymentGroupName must not be specified.

$sel:externalId:ListDeployments', listDeployments_externalId - The unique ID of an external resource for returning deployments linked to the external resource.

$sel:deploymentGroupName:ListDeployments', listDeployments_deploymentGroupName - The name of a deployment group for the specified application.

If deploymentGroupName is specified, then applicationName must be specified. If it is not specified, then applicationName must not be specified.

Request Lenses

listDeployments_createTimeRange :: Lens' ListDeployments (Maybe TimeRange) Source #

A time range (start and end) for returning a subset of the list of deployments.

listDeployments_nextToken :: Lens' ListDeployments (Maybe Text) Source #

An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.

listDeployments_includeOnlyStatuses :: Lens' ListDeployments (Maybe [DeploymentStatus]) Source #

A subset of deployments to list by status:

Created: Include created deployments in the resulting list.
Queued: Include queued deployments in the resulting list.
In Progress: Include in-progress deployments in the resulting list.
Succeeded: Include successful deployments in the resulting list.
Failed: Include failed deployments in the resulting list.
Stopped: Include stopped deployments in the resulting list.

listDeployments_applicationName :: Lens' ListDeployments (Maybe Text) Source #

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

If applicationName is specified, then deploymentGroupName must be specified. If it is not specified, then deploymentGroupName must not be specified.

listDeployments_externalId :: Lens' ListDeployments (Maybe Text) Source #

The unique ID of an external resource for returning deployments linked to the external resource.

listDeployments_deploymentGroupName :: Lens' ListDeployments (Maybe Text) Source #

The name of a deployment group for the specified application.

If deploymentGroupName is specified, then applicationName must be specified. If it is not specified, then applicationName must not be specified.

Destructuring the Response

data ListDeploymentsResponse Source #

Represents the output of a ListDeployments operation.

See: newListDeploymentsResponse smart constructor.

Constructors

ListDeploymentsResponse'
Fields nextToken :: Maybe Text If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployments call to return the next set of deployments in the list. deployments :: Maybe [Text] A list of deployment IDs. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListDeploymentsResponse Source #

Arguments

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

Create a value of ListDeploymentsResponse 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:ListDeployments', listDeploymentsResponse_nextToken - If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployments call to return the next set of deployments in the list.

$sel:deployments:ListDeploymentsResponse', listDeploymentsResponse_deployments - A list of deployment IDs.

$sel:httpStatus:ListDeploymentsResponse', listDeploymentsResponse_httpStatus - The response's http status code.

Response Lenses

listDeploymentsResponse_nextToken :: Lens' ListDeploymentsResponse (Maybe Text) Source #

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

listDeploymentsResponse_deployments :: Lens' ListDeploymentsResponse (Maybe [Text]) Source #

A list of deployment IDs.

listDeploymentsResponse_httpStatus :: Lens' ListDeploymentsResponse Int Source #

The response's http status code.