The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::ElasticBeanstalk::DescribeEnvironments - Arguments for method DescribeEnvironments on Paws::ElasticBeanstalk

DESCRIPTION

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

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

SYNOPSIS

    my $elasticbeanstalk = Paws->service('ElasticBeanstalk');
    # To view information about an environment
    # The following operation retrieves information about an environment named
    # my-env:
    my $EnvironmentDescriptionsMessage =
      $elasticbeanstalk->DescribeEnvironments(
      'EnvironmentNames' => ['my-env'] );

    # Results:
    my $Environments = $EnvironmentDescriptionsMessage->Environments;

   # Returns a L<Paws::ElasticBeanstalk::EnvironmentDescriptionsMessage> 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/elasticbeanstalk/DescribeEnvironments

ATTRIBUTES

ApplicationName => Str

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

EnvironmentIds => ArrayRef[Str|Undef]

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

EnvironmentNames => ArrayRef[Str|Undef]

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

IncludedDeletedBackTo => Str

If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

IncludeDeleted => Bool

Indicates whether to include deleted environments:

true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

false: Do not include deleted environments.

MaxRecords => Int

For a paginated request. Specify a maximum number of environments to include in each response.

If no MaxRecords is specified, all available environments are retrieved in a single response.

NextToken => Str

For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

If no NextToken is specified, the first page is retrieved.

VersionLabel => Str

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeEnvironments in Paws::ElasticBeanstalk

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