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 |
Lists the deployments in a deployment group for an application registered with the IAM user or Amazon Web Services account.
This operation returns paginated results.
Synopsis
- data ListDeployments = ListDeployments' {}
- newListDeployments :: ListDeployments
- listDeployments_applicationName :: Lens' ListDeployments (Maybe Text)
- listDeployments_createTimeRange :: Lens' ListDeployments (Maybe TimeRange)
- listDeployments_deploymentGroupName :: Lens' ListDeployments (Maybe Text)
- listDeployments_externalId :: Lens' ListDeployments (Maybe Text)
- listDeployments_includeOnlyStatuses :: Lens' ListDeployments (Maybe [DeploymentStatus])
- listDeployments_nextToken :: Lens' ListDeployments (Maybe Text)
- data ListDeploymentsResponse = ListDeploymentsResponse' {
- deployments :: Maybe [Text]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListDeploymentsResponse :: Int -> ListDeploymentsResponse
- listDeploymentsResponse_deployments :: Lens' ListDeploymentsResponse (Maybe [Text])
- listDeploymentsResponse_nextToken :: 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.
ListDeployments' | |
|
Instances
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:
ListDeployments
, listDeployments_applicationName
- The name of an CodeDeploy application associated with the IAM user or
Amazon Web Services account.
If applicationName
is specified, then deploymentGroupName
must be
specified. If it is not specified, then deploymentGroupName
must not
be specified.
$sel:createTimeRange:ListDeployments'
, listDeployments_createTimeRange
- A time range (start and end) for returning a subset of the list of
deployments.
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.
ListDeployments
, listDeployments_externalId
- The unique ID of an external resource for returning deployments linked
to the external resource.
$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.
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.
Request Lenses
listDeployments_applicationName :: Lens' ListDeployments (Maybe Text) Source #
The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
If applicationName
is specified, then deploymentGroupName
must be
specified. If it is not specified, then deploymentGroupName
must not
be specified.
listDeployments_createTimeRange :: Lens' ListDeployments (Maybe TimeRange) Source #
A time range (start and end) for returning a subset of the list of deployments.
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.
listDeployments_externalId :: Lens' ListDeployments (Maybe Text) Source #
The unique ID of an external resource for returning deployments linked to the external resource.
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_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.
Destructuring the Response
data ListDeploymentsResponse Source #
Represents the output of a ListDeployments
operation.
See: newListDeploymentsResponse
smart constructor.
ListDeploymentsResponse' | |
|
Instances
newListDeploymentsResponse Source #
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:deployments:ListDeploymentsResponse'
, listDeploymentsResponse_deployments
- A list of deployment IDs.
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:httpStatus:ListDeploymentsResponse'
, listDeploymentsResponse_httpStatus
- The response's http status code.
Response Lenses
listDeploymentsResponse_deployments :: Lens' ListDeploymentsResponse (Maybe [Text]) Source #
A list of deployment IDs.
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_httpStatus :: Lens' ListDeploymentsResponse Int Source #
The response's http status code.