Skip to content

List Deployments

codedeploy_list_deployments R Documentation

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

Description

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

Usage

codedeploy_list_deployments(applicationName, deploymentGroupName,
  externalId, includeOnlyStatuses, createTimeRange, nextToken)

Arguments

applicationName

The name of an CodeDeploy application associated with the 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.

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.

externalId

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

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.

createTimeRange

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

nextToken

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

Value

A list with the following syntax: 

list(
  deployments = list(
    "string"
  ),
  nextToken = "string"
)

Request syntax

svc$list_deployments(
  applicationName = "string",
  deploymentGroupName = "string",
  externalId = "string",
  includeOnlyStatuses = list(
    "Created"|"Queued"|"InProgress"|"Baking"|"Succeeded"|"Failed"|"Stopped"|"Ready"
  ),
  createTimeRange = list(
    start = as.POSIXct(
      "2015-01-01"
    ),
    end = as.POSIXct(
      "2015-01-01"
    )
  ),
  nextToken = "string"
)