Amazon CodeDeploy · JSON Structure

Amazon Codedeploy List Deployment Instances Input Structure

Represents the input of a ListDeploymentInstances operation.

Type: object Properties: 4 Required: 1
AmazonDeploymentDevOpsCI/CDRelease ManagementBlue/Green Deployment

ListDeploymentInstancesInput is a JSON Structure definition published by Amazon CodeDeploy, describing 4 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

deploymentId nextToken instanceStatusFilter instanceTypeFilter

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codedeploy/refs/heads/main/json-structure/amazon-codedeploy-list-deployment-instances-input-structure.json",
  "name": "ListDeploymentInstancesInput",
  "description": " Represents the input of a <code>ListDeploymentInstances</code> operation. ",
  "type": "object",
  "properties": {
    "deploymentId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeploymentId"
        },
        {
          "description": " The unique ID of a deployment. "
        }
      ]
    },
    "nextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NextToken"
        },
        {
          "description": "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": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InstanceStatusList"
        },
        {
          "description": "<p>A subset of instances to list by status:</p> <ul> <li> <p> <code>Pending</code>: Include those instances with pending deployments.</p> </li> <li> <p> <code>InProgress</code>: Include those instances where deployments are still in progress.</p> </li> <li> <p> <code>Succeeded</code>: Include those instances with successful deployments.</p> </li> <li> <p> <code>Failed</code>: Include those instances with failed deployments.</p> </li> <li> <p> <code>Skipped</code>: Include those instances with skipped deployments.</p> </li> <li> <p> <code>Unknown</code>: Include those instances with deployments in an unknown state.</p> </li> </ul>"
        }
      ]
    },
    "instanceTypeFilter": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InstanceTypeList"
        },
        {
          "description": "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."
        }
      ]
    }
  },
  "required": [
    "deploymentId"
  ]
}