| 1 | |||
| 2 | package Paws::SSM::GetParametersByPath; | ||
| 3 | use Moose; | ||
| 4 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 5 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 6 | has ParameterFilters => (is => 'ro', isa => 'ArrayRef[Paws::SSM::ParameterStringFilter]'); | ||
| 7 | has Path => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has Recursive => (is => 'ro', isa => 'Bool'); | ||
| 9 | has WithDecryption => (is => 'ro', isa => 'Bool'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetParametersByPath'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSM::GetParametersByPathResult'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::SSM::GetParametersByPath - Arguments for method GetParametersByPath on L<Paws::SSM> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method GetParametersByPath on the | ||
| 27 | L<Amazon Simple Systems Manager (SSM)|Paws::SSM> service. Use the attributes of this class | ||
| 28 | as arguments to method GetParametersByPath. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetParametersByPath. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $ssm = Paws->service('SSM'); | ||
| 35 | my $GetParametersByPathResult = $ssm->GetParametersByPath( | ||
| 36 | Path => 'MyPSParameterName', | ||
| 37 | MaxResults => 1, # OPTIONAL | ||
| 38 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 39 | ParameterFilters => [ | ||
| 40 | { | ||
| 41 | Key => 'MyParameterStringFilterKey', # min: 1, max: 132 | ||
| 42 | Option => 'MyParameterStringQueryOption', # min: 1, max: 10; OPTIONAL | ||
| 43 | Values => [ | ||
| 44 | 'MyParameterStringFilterValue', ... # min: 1, max: 1024 | ||
| 45 | ], # min: 1, max: 50; OPTIONAL | ||
| 46 | }, | ||
| 47 | ... | ||
| 48 | ], # OPTIONAL | ||
| 49 | Recursive => 1, # OPTIONAL | ||
| 50 | WithDecryption => 1, # OPTIONAL | ||
| 51 | ); | ||
| 52 | |||
| 53 | # Results: | ||
| 54 | my $NextToken = $GetParametersByPathResult->NextToken; | ||
| 55 | my $Parameters = $GetParametersByPathResult->Parameters; | ||
| 56 | |||
| 57 | # Returns a L<Paws::SSM::GetParametersByPathResult> object. | ||
| 58 | |||
| 59 | 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. | ||
| 60 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm/GetParametersByPath> | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 MaxResults => Int | ||
| 66 | |||
| 67 | The maximum number of items to return for this call. The call also | ||
| 68 | returns a token that you can specify in a subsequent call to get the | ||
| 69 | next set of results. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 NextToken => Str | ||
| 74 | |||
| 75 | A token to start the list. Use this token to get the next set of | ||
| 76 | results. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 ParameterFilters => ArrayRef[L<Paws::SSM::ParameterStringFilter>] | ||
| 81 | |||
| 82 | Filters to limit the request results. | ||
| 83 | |||
| 84 | For C<GetParametersByPath>, the following filter C<Key> names are | ||
| 85 | supported: C<Type>, C<KeyId>, C<Label>, and C<DataType>. | ||
| 86 | |||
| 87 | The following C<Key> values are not supported for | ||
| 88 | C<GetParametersByPath>: C<tag>, C<Name>, C<Path>, and C<Tier>. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 B<REQUIRED> Path => Str | ||
| 93 | |||
| 94 | The hierarchy for the parameter. Hierarchies start with a forward slash | ||
| 95 | (/). The hierachy is the parameter name except the last part of the | ||
| 96 | parameter. For the API call to succeeed, the last part of the parameter | ||
| 97 | name cannot be in the path. A parameter name hierarchy can have a | ||
| 98 | maximum of 15 levels. Here is an example of a hierarchy: | ||
| 99 | C</Finance/Prod/IAD/WinServ2016/license33> | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 Recursive => Bool | ||
| 104 | |||
| 105 | Retrieve all parameters within a hierarchy. | ||
| 106 | |||
| 107 | If a user has access to a path, then the user can access all levels of | ||
| 108 | that path. For example, if a user has permission to access path C</a>, | ||
| 109 | then the user can also access C</a/b>. Even if a user has explicitly | ||
| 110 | been denied access in IAM for parameter C</a/b>, they can still call | ||
| 111 | the GetParametersByPath API action recursively for C</a> and view | ||
| 112 | C</a/b>. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 WithDecryption => Bool | ||
| 117 | |||
| 118 | Retrieve all parameters in a hierarchy with their value decrypted. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head1 SEE ALSO | ||
| 124 | |||
| 125 | This class forms part of L<Paws>, documenting arguments for method GetParametersByPath in L<Paws::SSM> | ||
| 126 | |||
| 127 | =head1 BUGS and CONTRIBUTIONS | ||
| 128 | |||
| 129 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 130 | |||
| 131 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 132 | |||
| 133 | =cut | ||
| 134 |