GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::ElasticBeanstalk::DescribeEnvironments(3) User Contributed Perl Documentation Paws::ElasticBeanstalk::DescribeEnvironments(3)

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

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.

    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>

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

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

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

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

Indicates whether to include deleted environments:

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

"false": Do not include deleted environments.

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.

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.

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

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

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>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.