Skip to content

List Deployment Instances

codedeploy_list_deployment_instances R Documentation

The newer BatchGetDeploymentTargets should be used instead because it works with all compute types

Description

The newer batch_get_deployment_targets should be used instead because it works with all compute types. list_deployment_instances throws an exception if it is used with a compute platform other than EC2/On-premises or Lambda.

Lists the instance for a deployment associated with the user or Amazon Web Services account.

Usage

codedeploy_list_deployment_instances(deploymentId, nextToken,
  instanceStatusFilter, instanceTypeFilter)

Arguments

deploymentId

[required] The unique ID of a deployment.

nextToken

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

instanceStatusFilter

A subset of instances to list by status:

  • Pending: Include those instances with pending deployments.

  • InProgress: Include those instances where deployments are still in progress.

  • Succeeded: Include those instances with successful deployments.

  • Failed: Include those instances with failed deployments.

  • Skipped: Include those instances with skipped deployments.

  • Unknown: Include those instances with deployments in an unknown state.

instanceTypeFilter

The set of instances in a blue/green deployment, either those in the original environment ("BLUE") or those in the replacement environment ("GREEN"), for which you want to view instance information.

Value

A list with the following syntax: 

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

Request syntax

svc$list_deployment_instances(
  deploymentId = "string",
  nextToken = "string",
  instanceStatusFilter = list(
    "Pending"|"InProgress"|"Succeeded"|"Failed"|"Skipped"|"Unknown"|"Ready"
  ),
  instanceTypeFilter = list(
    "Blue"|"Green"
  )
)