« blib/lib/Paws/AppConfig/ListDeployments.pm
↑ Summary
blib/lib/Paws/AppConfig/ListHostedConfigurationVersions.pm »
| 1 | |||
| 2 | package Paws::AppConfig::ListEnvironments; | ||
| 3 | use Moose; | ||
| 4 | has ApplicationId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'ApplicationId', required => 1); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'max_results'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'next_token'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListEnvironments'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/applications/{ApplicationId}/environments'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AppConfig::Environments'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::AppConfig::ListEnvironments - Arguments for method ListEnvironments on L<Paws::AppConfig> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method ListEnvironments on the | ||
| 25 | L<Amazon AppConfig|Paws::AppConfig> service. Use the attributes of this class | ||
| 26 | as arguments to method ListEnvironments. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListEnvironments. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $appconfig = Paws->service('AppConfig'); | ||
| 33 | my $Environments = $appconfig->ListEnvironments( | ||
| 34 | ApplicationId => 'MyId', | ||
| 35 | MaxResults => 1, # OPTIONAL | ||
| 36 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $Items = $Environments->Items; | ||
| 41 | my $NextToken = $Environments->NextToken; | ||
| 42 | |||
| 43 | # Returns a L<Paws::AppConfig::Environments> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/appconfig/ListEnvironments> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> ApplicationId => Str | ||
| 52 | |||
| 53 | The application ID. | ||
| 54 | |||
| 55 | |||
| 56 | |||
| 57 | =head2 MaxResults => Int | ||
| 58 | |||
| 59 | The maximum number of items to return for this call. The call also | ||
| 60 | returns a token that you can specify in a subsequent call to get the | ||
| 61 | next set of results. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 NextToken => Str | ||
| 66 | |||
| 67 | A token to start the list. Use this token to get the next set of | ||
| 68 | results. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head1 SEE ALSO | ||
| 74 | |||
| 75 | This class forms part of L<Paws>, documenting arguments for method ListEnvironments in L<Paws::AppConfig> | ||
| 76 | |||
| 77 | =head1 BUGS and CONTRIBUTIONS | ||
| 78 | |||
| 79 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 80 | |||
| 81 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 82 | |||
| 83 | =cut | ||
| 84 |