You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CodeDeploy::Types::ListDeploymentInstancesInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb

Overview

Note:

When making an API call, you may pass ListDeploymentInstancesInput data as a hash:

{
  deployment_id: "DeploymentId", # required
  next_token: "NextToken",
  instance_status_filter: ["Pending"], # accepts Pending, InProgress, Succeeded, Failed, Skipped, Unknown, Ready
  instance_type_filter: ["Blue"], # accepts Blue, Green
}

Represents the input of a ListDeploymentInstances operation.

Instance Attribute Summary collapse

Instance Attribute Details

#deployment_idString

The unique ID of a deployment.

Returns:

  • (String)


2630
2631
2632
2633
2634
2635
2636
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 2630

class ListDeploymentInstancesInput < Struct.new(
  :deployment_id,
  :next_token,
  :instance_status_filter,
  :instance_type_filter)
  include Aws::Structure
end

#instance_status_filterArray<String>

A subset of instances to list by status:

  • Pending: Include those instance with pending deployments.

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

  • Succeeded: Include those instances with successful deployments.

  • Failed: Include those instance with failed deployments.

  • Skipped: Include those instance with skipped deployments.

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

Returns:

  • (Array<String>)


2630
2631
2632
2633
2634
2635
2636
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 2630

class ListDeploymentInstancesInput < Struct.new(
  :deployment_id,
  :next_token,
  :instance_status_filter,
  :instance_type_filter)
  include Aws::Structure
end

#instance_type_filterArray<String>

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.

Returns:

  • (Array<String>)


2630
2631
2632
2633
2634
2635
2636
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 2630

class ListDeploymentInstancesInput < Struct.new(
  :deployment_id,
  :next_token,
  :instance_status_filter,
  :instance_type_filter)
  include Aws::Structure
end

#next_tokenString

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.

Returns:

  • (String)


2630
2631
2632
2633
2634
2635
2636
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 2630

class ListDeploymentInstancesInput < Struct.new(
  :deployment_id,
  :next_token,
  :instance_status_filter,
  :instance_type_filter)
  include Aws::Structure
end