« blib/lib/Paws/ElasticBeanstalk/DescribeAccountAttributesResult.pm
↑ Summary
blib/lib/Paws/ElasticBeanstalk/DescribeEnvironmentHealth.pm »
| 1 | |||
| 2 | package Paws::ElasticBeanstalk::DescribeConfigurationSettings; | ||
| 3 | use Moose; | ||
| 4 | has ApplicationName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has EnvironmentName => (is => 'ro', isa => 'Str'); | ||
| 6 | has TemplateName => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeConfigurationSettings'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ElasticBeanstalk::ConfigurationSettingsDescriptions'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeConfigurationSettingsResult'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::ElasticBeanstalk::DescribeConfigurationSettings - Arguments for method DescribeConfigurationSettings on L<Paws::ElasticBeanstalk> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method DescribeConfigurationSettings on the | ||
| 24 | L<AWS Elastic Beanstalk|Paws::ElasticBeanstalk> service. Use the attributes of this class | ||
| 25 | as arguments to method DescribeConfigurationSettings. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeConfigurationSettings. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $elasticbeanstalk = Paws->service('ElasticBeanstalk'); | ||
| 32 | # To view configurations settings for an environment | ||
| 33 | # The following operation retrieves configuration settings for an environment | ||
| 34 | # named my-env: | ||
| 35 | my $ConfigurationSettingsDescriptions = | ||
| 36 | $elasticbeanstalk->DescribeConfigurationSettings( | ||
| 37 | 'ApplicationName' => 'my-app', | ||
| 38 | 'EnvironmentName' => 'my-env' | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $ConfigurationSettings = | ||
| 43 | $ConfigurationSettingsDescriptions->ConfigurationSettings; | ||
| 44 | |||
| 45 | # Returns a L<Paws::ElasticBeanstalk::ConfigurationSettingsDescriptions> 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/DescribeConfigurationSettings> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> ApplicationName => Str | ||
| 54 | |||
| 55 | The application for the environment or configuration template. | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | =head2 EnvironmentName => Str | ||
| 60 | |||
| 61 | The name of the environment to describe. | ||
| 62 | |||
| 63 | Condition: You must specify either this or a TemplateName, but not | ||
| 64 | both. If you specify both, AWS Elastic Beanstalk returns an | ||
| 65 | C<InvalidParameterCombination> error. If you do not specify either, AWS | ||
| 66 | Elastic Beanstalk returns C<MissingRequiredParameter> error. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 TemplateName => Str | ||
| 71 | |||
| 72 | The name of the configuration template to describe. | ||
| 73 | |||
| 74 | Conditional: You must specify either this parameter or an | ||
| 75 | EnvironmentName, but not both. If you specify both, AWS Elastic | ||
| 76 | Beanstalk returns an C<InvalidParameterCombination> error. If you do | ||
| 77 | not specify either, AWS Elastic Beanstalk returns a | ||
| 78 | C<MissingRequiredParameter> error. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head1 SEE ALSO | ||
| 84 | |||
| 85 | This class forms part of L<Paws>, documenting arguments for method DescribeConfigurationSettings in L<Paws::ElasticBeanstalk> | ||
| 86 | |||
| 87 | =head1 BUGS and CONTRIBUTIONS | ||
| 88 | |||
| 89 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 90 | |||
| 91 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 92 | |||
| 93 | =cut | ||
| 94 |