/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::CodeDeploy::ListDeployments

NAME

Paws::CodeDeploy::ListDeployments - Arguments for method ListDeployments on Paws::CodeDeploy

DESCRIPTION

This class represents the parameters used for calling the method ListDeployments on the AWS CodeDeploy service. Use the attributes of this class as arguments to method ListDeployments.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListDeployments.

SYNOPSIS

my $codedeploy = Paws->service('CodeDeploy');
my $ListDeploymentsOutput = $codedeploy->ListDeployments(
  ApplicationName => 'MyApplicationName',    # OPTIONAL
  CreateTimeRange => {
    End   => '1970-01-01T01:00:00',          # OPTIONAL
    Start => '1970-01-01T01:00:00',          # OPTIONAL
  },    # OPTIONAL
  DeploymentGroupName => 'MyDeploymentGroupName',    # OPTIONAL
  ExternalId          => 'MyExternalId',             # OPTIONAL
  IncludeOnlyStatuses => [
    'Created',
    ... # values: Created, Queued, InProgress, Baking, Succeeded, Failed, Stopped, Ready
  ],    # OPTIONAL
  NextToken => 'MyNextToken',    # OPTIONAL
);

# Results:
my $Deployments = $ListDeploymentsOutput->Deployments;
my $NextToken   = $ListDeploymentsOutput->NextToken;

# Returns a L<Paws::CodeDeploy::ListDeploymentsOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/codedeploy/ListDeployments

ATTRIBUTES

ApplicationName => Str

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.

CreateTimeRange => Paws::CodeDeploy::TimeRange

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

DeploymentGroupName => Str

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.

ExternalId => Str

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

IncludeOnlyStatuses => ArrayRef[Str|Undef]

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.

NextToken => Str

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

SEE ALSO

This class forms part of Paws, documenting arguments for method ListDeployments in Paws::CodeDeploy

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues