« blib/lib/Paws/AppConfig/GetApplication.pm
↑ Summary
blib/lib/Paws/AppConfig/GetConfigurationProfile.pm »
| 1 | |||
| 2 | package Paws::AppConfig::GetConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has Application => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'Application', required => 1); | ||
| 5 | has ClientConfigurationVersion => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'client_configuration_version'); | ||
| 6 | has ClientId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'client_id', required => 1); | ||
| 7 | has Configuration => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'Configuration', required => 1); | ||
| 8 | has Environment => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'Environment', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetConfiguration'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/applications/{Application}/environments/{Environment}/configurations/{Configuration}'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AppConfig::Configuration'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::AppConfig::GetConfiguration - Arguments for method GetConfiguration on L<Paws::AppConfig> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method GetConfiguration on the | ||
| 27 | L<Amazon AppConfig|Paws::AppConfig> service. Use the attributes of this class | ||
| 28 | as arguments to method GetConfiguration. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetConfiguration. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $appconfig = Paws->service('AppConfig'); | ||
| 35 | my $Configuration = $appconfig->GetConfiguration( | ||
| 36 | Application => 'MyStringWithLengthBetween1And64', | ||
| 37 | ClientId => 'MyStringWithLengthBetween1And64', | ||
| 38 | Configuration => 'MyStringWithLengthBetween1And64', | ||
| 39 | Environment => 'MyStringWithLengthBetween1And64', | ||
| 40 | ClientConfigurationVersion => 'MyVersion', # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $ConfigurationVersion = $Configuration->ConfigurationVersion; | ||
| 45 | my $Content = $Configuration->Content; | ||
| 46 | my $ContentType = $Configuration->ContentType; | ||
| 47 | |||
| 48 | # Returns a L<Paws::AppConfig::Configuration> object. | ||
| 49 | |||
| 50 | 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. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/appconfig/GetConfiguration> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> Application => Str | ||
| 57 | |||
| 58 | The application to get. Specify either the application name or the | ||
| 59 | application ID. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 ClientConfigurationVersion => Str | ||
| 64 | |||
| 65 | The configuration version returned in the most recent | ||
| 66 | C<GetConfiguration> response. | ||
| 67 | |||
| 68 | AWS AppConfig uses the value of the C<ClientConfigurationVersion> | ||
| 69 | parameter to identify the configuration version on your clients. If you | ||
| 70 | donE<rsquo>t send C<ClientConfigurationVersion> with each call to | ||
| 71 | C<GetConfiguration>, your clients receive the current configuration. | ||
| 72 | You are charged each time your clients receive a configuration. | ||
| 73 | |||
| 74 | To avoid excess charges, we recommend that you include the | ||
| 75 | C<ClientConfigurationVersion> value with every call to | ||
| 76 | C<GetConfiguration>. This value must be saved on your client. | ||
| 77 | Subsequent calls to C<GetConfiguration> must pass this value by using | ||
| 78 | the C<ClientConfigurationVersion> parameter. | ||
| 79 | |||
| 80 | For more information about working with configurations, see Retrieving | ||
| 81 | the Configuration | ||
| 82 | (https://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig-retrieving-the-configuration.html) | ||
| 83 | in the I<AWS AppConfig User Guide>. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 B<REQUIRED> ClientId => Str | ||
| 88 | |||
| 89 | A unique ID to identify the client for the configuration. This ID | ||
| 90 | enables AppConfig to deploy the configuration in intervals, as defined | ||
| 91 | in the deployment strategy. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 B<REQUIRED> Configuration => Str | ||
| 96 | |||
| 97 | The configuration to get. Specify either the configuration name or the | ||
| 98 | configuration ID. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 B<REQUIRED> Environment => Str | ||
| 103 | |||
| 104 | The environment to get. Specify either the environment name or the | ||
| 105 | environment ID. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head1 SEE ALSO | ||
| 111 | |||
| 112 | This class forms part of L<Paws>, documenting arguments for method GetConfiguration in L<Paws::AppConfig> | ||
| 113 | |||
| 114 | =head1 BUGS and CONTRIBUTIONS | ||
| 115 | |||
| 116 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 117 | |||
| 118 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 119 | |||
| 120 | =cut | ||
| 121 |