« blib/lib/Paws/Amplify/ListArtifactsResult.pm
↑ Summary
blib/lib/Paws/Amplify/ListBackendEnvironmentsResult.pm »
| 1 | |||
| 2 | package Paws::Amplify::ListBackendEnvironments; | ||
| 3 | use Moose; | ||
| 4 | has AppId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'appId', required => 1); | ||
| 5 | has EnvironmentName => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'environmentName'); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListBackendEnvironments'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/apps/{appId}/backendenvironments'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Amplify::ListBackendEnvironmentsResult'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Amplify::ListBackendEnvironments - Arguments for method ListBackendEnvironments on L<Paws::Amplify> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method ListBackendEnvironments on the | ||
| 26 | L<AWS Amplify|Paws::Amplify> service. Use the attributes of this class | ||
| 27 | as arguments to method ListBackendEnvironments. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListBackendEnvironments. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $amplify = Paws->service('Amplify'); | ||
| 34 | my $ListBackendEnvironmentsResult = $amplify->ListBackendEnvironments( | ||
| 35 | AppId => 'MyAppId', | ||
| 36 | EnvironmentName => 'MyEnvironmentName', # OPTIONAL | ||
| 37 | MaxResults => 1, # OPTIONAL | ||
| 38 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $BackendEnvironments = | ||
| 43 | $ListBackendEnvironmentsResult->BackendEnvironments; | ||
| 44 | my $NextToken = $ListBackendEnvironmentsResult->NextToken; | ||
| 45 | |||
| 46 | # Returns a L<Paws::Amplify::ListBackendEnvironmentsResult> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/amplify/ListBackendEnvironments> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> AppId => Str | ||
| 55 | |||
| 56 | The unique ID for an Amplify app. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 EnvironmentName => Str | ||
| 61 | |||
| 62 | The name of the backend environment | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 MaxResults => Int | ||
| 67 | |||
| 68 | The maximum number of records to list in a single response. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 NextToken => Str | ||
| 73 | |||
| 74 | A pagination token. Set to null to start listing backend environments | ||
| 75 | from the start. If a non-null pagination token is returned in a result, | ||
| 76 | pass its value in here to list more backend environments. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head1 SEE ALSO | ||
| 82 | |||
| 83 | This class forms part of L<Paws>, documenting arguments for method ListBackendEnvironments in L<Paws::Amplify> | ||
| 84 | |||
| 85 | =head1 BUGS and CONTRIBUTIONS | ||
| 86 | |||
| 87 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 88 | |||
| 89 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 90 | |||
| 91 | =cut | ||
| 92 |