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