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",
  external_id: "ExternalId",
  include_only_statuses: ["Created"], # accepts Created, Queued, InProgress, Baking, Succeeded, Failed, Stopped, Ready
  create_time_range: {
    start: Time.now,
    end: Time.now,
  },
  next_token: "NextToken",
}

Represents the input of a ListDeployments operation.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#application_name ⇒ String

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

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

#create_time_range ⇒ Types::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_name ⇒ String

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

    The name of a deployment group for the specified application.

#external_id ⇒ String

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

Returns:

  • (String) —

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

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

    A subset of deployments to list by status:.

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

    An identifier returned from the previous list deployments call.