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

Class: Aws::CodeDeploy::Types::ListDeploymentsInput

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 ListDeploymentsInput data as a hash:

{
  application_name: "ApplicationName",
  deployment_group_name: "DeploymentGroupName",
  include_only_statuses: ["Created"], # accepts Created, Queued, InProgress, Succeeded, Failed, Stopped, Ready
  create_time_range: {
    start: Time.now,
    end: Time.now,
  },
  next_token: "NextToken",
}

Represents the input of a ListDeployments operation.

Instance Attribute Summary collapse

Instance Attribute Details

#application_nameString

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

If applicationName is specified, then deploymentGroupName must be specified. If it is not specified, then deploymentGroupName must not be specified.

Returns:

  • (String)


3495
3496
3497
3498
3499
3500
3501
3502
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 3495

class ListDeploymentsInput < Struct.new(
  :application_name,
  :deployment_group_name,
  :include_only_statuses,
  :create_time_range,
  :next_token)
  include Aws::Structure
end

#create_time_rangeTypes::TimeRange

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

Returns:



3495
3496
3497
3498
3499
3500
3501
3502
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 3495

class ListDeploymentsInput < Struct.new(
  :application_name,
  :deployment_group_name,
  :include_only_statuses,
  :create_time_range,
  :next_token)
  include Aws::Structure
end

#deployment_group_nameString

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.

Returns:

  • (String)


3495
3496
3497
3498
3499
3500
3501
3502
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 3495

class ListDeploymentsInput < Struct.new(
  :application_name,
  :deployment_group_name,
  :include_only_statuses,
  :create_time_range,
  :next_token)
  include Aws::Structure
end

#include_only_statusesArray<String>

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.

Returns:

  • (Array<String>)


3495
3496
3497
3498
3499
3500
3501
3502
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 3495

class ListDeploymentsInput < Struct.new(
  :application_name,
  :deployment_group_name,
  :include_only_statuses,
  :create_time_range,
  :next_token)
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


3495
3496
3497
3498
3499
3500
3501
3502
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 3495

class ListDeploymentsInput < Struct.new(
  :application_name,
  :deployment_group_name,
  :include_only_statuses,
  :create_time_range,
  :next_token)
  include Aws::Structure
end