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

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

Overview

Represents the input of a ‘ListDeployments` operation.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_name ⇒ String

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

<note markdown=“1”> If ‘applicationName` is specified, then `deploymentGroupName` must be specified. If it is not specified, then `deploymentGroupName` must not be specified.

</note>

Returns:

  • (String) 


3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
 
# File 'lib/aws-sdk-codedeploy/types.rb', line 3872

class ListDeploymentsInput < Struct.new(
  :application_name,
  :deployment_group_name,
  :external_id,
  :include_only_statuses,
  :create_time_range,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#create_time_range ⇒ Types::TimeRange

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

Returns:



3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
 
# File 'lib/aws-sdk-codedeploy/types.rb', line 3872

class ListDeploymentsInput < Struct.new(
  :application_name,
  :deployment_group_name,
  :external_id,
  :include_only_statuses,
  :create_time_range,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_group_name ⇒ String

The name of a deployment group for the specified application.

<note markdown=“1”> If ‘deploymentGroupName` is specified, then `applicationName` must be specified. If it is not specified, then `applicationName` must not be specified.

</note>

Returns:

  • (String) 


3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
 
# File 'lib/aws-sdk-codedeploy/types.rb', line 3872

class ListDeploymentsInput < Struct.new(
  :application_name,
  :deployment_group_name,
  :external_id,
  :include_only_statuses,
  :create_time_range,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#external_id ⇒ String

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

Returns:

  • (String) 


3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
 
# File 'lib/aws-sdk-codedeploy/types.rb', line 3872

class ListDeploymentsInput < Struct.new(
  :application_name,
  :deployment_group_name,
  :external_id,
  :include_only_statuses,
  :create_time_range,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#include_only_statuses ⇒ Array<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>) 


3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
 
# File 'lib/aws-sdk-codedeploy/types.rb', line 3872

class ListDeploymentsInput < Struct.new(
  :application_name,
  :deployment_group_name,
  :external_id,
  :include_only_statuses,
  :create_time_range,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

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) 


3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
 
# File 'lib/aws-sdk-codedeploy/types.rb', line 3872

class ListDeploymentsInput < Struct.new(
  :application_name,
  :deployment_group_name,
  :external_id,
  :include_only_statuses,
  :create_time_range,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end