The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $codedeploy = Paws->service('CodeDeploy');
    my $ListDeploymentInstancesOutput = $codedeploy->ListDeploymentInstances(
      DeploymentId         => 'MyDeploymentId',
      InstanceStatusFilter => [
        'Pending',
        ... # values: Pending, InProgress, Succeeded, Failed, Skipped, Unknown, Ready
      ],    # OPTIONAL
      InstanceTypeFilter => [
        'Blue', ...    # values: Blue, Green
      ],               # OPTIONAL
      NextToken => 'MyNextToken',    # OPTIONAL
    );

    # Results:
    my $InstancesList = $ListDeploymentInstancesOutput->InstancesList;
    my $NextToken     = $ListDeploymentInstancesOutput->NextToken;

    # Returns a L<Paws::CodeDeploy::ListDeploymentInstancesOutput> 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/ListDeploymentInstances

ATTRIBUTES

REQUIRED DeploymentId => Str

The unique ID of a deployment.

InstanceStatusFilter => ArrayRef[Str|Undef]

A subset of instances to list by status:

  • Pending: Include those instances with pending deployments.

  • InProgress: Include those instances where deployments are still in progress.

  • Succeeded: Include those instances with successful deployments.

  • Failed: Include those instances with failed deployments.

  • Skipped: Include those instances with skipped deployments.

  • Unknown: Include those instances with deployments in an unknown state.

InstanceTypeFilter => ArrayRef[Str|Undef]

The set of instances in a blue/green deployment, either those in the original environment ("BLUE") or those in the replacement environment ("GREEN"), for which you want to view instance information.

NextToken => Str

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

SEE ALSO

This class forms part of Paws, documenting arguments for method ListDeploymentInstances 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