« blib/lib/Paws/ElasticBeanstalk/DescribeEnvironmentManagedActionsResult.pm
↑ Summary
blib/lib/Paws/ElasticBeanstalk/DescribeInstancesHealth.pm »
| 1 | |||
| 2 | package Paws::ElasticBeanstalk::DescribeEnvironmentResources; | ||
| 3 | use Moose; | ||
| 4 | has EnvironmentId => (is => 'ro', isa => 'Str'); | ||
| 5 | has EnvironmentName => (is => 'ro', isa => 'Str'); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeEnvironmentResources'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ElasticBeanstalk::EnvironmentResourceDescriptionsMessage'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeEnvironmentResourcesResult'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::ElasticBeanstalk::DescribeEnvironmentResources - Arguments for method DescribeEnvironmentResources on L<Paws::ElasticBeanstalk> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method DescribeEnvironmentResources on the | ||
| 23 | L<AWS Elastic Beanstalk|Paws::ElasticBeanstalk> service. Use the attributes of this class | ||
| 24 | as arguments to method DescribeEnvironmentResources. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeEnvironmentResources. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $elasticbeanstalk = Paws->service('ElasticBeanstalk'); | ||
| 31 | # To view information about the AWS resources in your environment | ||
| 32 | # The following operation retrieves information about resources in an | ||
| 33 | # environment named my-env: | ||
| 34 | my $EnvironmentResourceDescriptionsMessage = | ||
| 35 | $elasticbeanstalk->DescribeEnvironmentResources( | ||
| 36 | 'EnvironmentName' => 'my-env' ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $EnvironmentResources = | ||
| 40 | $EnvironmentResourceDescriptionsMessage->EnvironmentResources; | ||
| 41 | |||
| 42 | # Returns a L<Paws::ElasticBeanstalk::EnvironmentResourceDescriptionsMessage> object. | ||
| 43 | |||
| 44 | 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. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk/DescribeEnvironmentResources> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 EnvironmentId => Str | ||
| 51 | |||
| 52 | The ID of the environment to retrieve AWS resource usage data. | ||
| 53 | |||
| 54 | Condition: You must specify either this or an EnvironmentName, or both. | ||
| 55 | If you do not specify either, AWS Elastic Beanstalk returns | ||
| 56 | C<MissingRequiredParameter> error. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 EnvironmentName => Str | ||
| 61 | |||
| 62 | The name of the environment to retrieve AWS resource usage data. | ||
| 63 | |||
| 64 | Condition: You must specify either this or an EnvironmentId, or both. | ||
| 65 | If you do not specify either, AWS Elastic Beanstalk returns | ||
| 66 | C<MissingRequiredParameter> error. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head1 SEE ALSO | ||
| 72 | |||
| 73 | This class forms part of L<Paws>, documenting arguments for method DescribeEnvironmentResources in L<Paws::ElasticBeanstalk> | ||
| 74 | |||
| 75 | =head1 BUGS and CONTRIBUTIONS | ||
| 76 | |||
| 77 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 78 | |||
| 79 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 80 | |||
| 81 | =cut | ||
| 82 |