Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1447387247.5 KB

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

post/#X-Amz-Target=CodeDeploy_20141006.ListDeployments

Query parameters

nextTokenstring

Pagination token

Headers

X-Amz-Target'CodeDeploy_20141006.ListDeployments' required

Request body

applicationNamestring
<p>The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.</p> <note> <p>If <code>applicationName</code> is specified, then <code>deploymentGroupName</code> must be specified. If it is not specified, then <code>deploymentGroupName</code> must not be specified. </p> </note>
deploymentGroupNamestring
<p>The name of a deployment group for the specified application.</p> <note> <p>If <code>deploymentGroupName</code> is specified, then <code>applicationName</code> must be specified. If it is not specified, then <code>applicationName</code> must not be specified. </p> </note>
externalIdstring

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

includeOnlyStatusesDeploymentStatus[]
<p>A subset of deployments to list by status:</p> <ul> <li> <p> <code>Created</code>: Include created deployments in the resulting list.</p> </li> <li> <p> <code>Queued</code>: Include queued deployments in the resulting list.</p> </li> <li> <p> <code>In Progress</code>: Include in-progress deployments in the resulting list.</p> </li> <li> <p> <code>Succeeded</code>: Include successful deployments in the resulting list.</p> </li> <li> <p> <code>Failed</code>: Include failed deployments in the resulting list.</p> </li> <li> <p> <code>Stopped</code>: Include stopped deployments in the resulting list.</p> </li> </ul>
nextTokenstring

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

Response

Success

deploymentsDeploymentId[]

A list of deployment IDs.

nextTokenstring

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.