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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListDeploymentsInput as input to an Aws::Client method, you can use a vanilla 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 applicable IAM user or AWS account.

Returns:

  • (String)

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

#create_time_rangeTypes::TimeRange

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

Returns:

  • (Types::TimeRange)

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

#deployment_group_nameString

The name of an existing deployment group for the specified application.

Returns:

  • (String)

    The name of an existing deployment group for the specified application.

#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>)

    A subset of deployments to list by status:.

#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)

    An identifier returned from the previous list deployments call.