NAME

Paws::SSM::GetParametersByPath - Arguments for method GetParametersByPath on Paws::SSM

DESCRIPTION

This class represents the parameters used for calling the method GetParametersByPath on the Amazon Simple Systems Manager (SSM) service. Use the attributes of this class as arguments to method GetParametersByPath.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetParametersByPath.

SYNOPSIS

my $ssm = Paws->service('SSM');
my $GetParametersByPathResult = $ssm->GetParametersByPath(
  Path             => 'MyPSParameterName',
  MaxResults       => 1,                     # OPTIONAL
  NextToken        => 'MyNextToken',         # OPTIONAL
  ParameterFilters => [
    {
      Key    => 'MyParameterStringFilterKey',    # min: 1, max: 132
      Option => 'MyParameterStringQueryOption',  # min: 1, max: 10; OPTIONAL
      Values => [
        'MyParameterStringFilterValue', ...      # min: 1, max: 1024
      ],    # min: 1, max: 50; OPTIONAL
    },
    ...
  ],    # OPTIONAL
  Recursive      => 1,    # OPTIONAL
  WithDecryption => 1,    # OPTIONAL
);

# Results:
my $NextToken  = $GetParametersByPathResult->NextToken;
my $Parameters = $GetParametersByPathResult->Parameters;

# Returns a L<Paws::SSM::GetParametersByPathResult> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ssm/GetParametersByPath

ATTRIBUTES

MaxResults => Int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken => Str

A token to start the list. Use this token to get the next set of results.

ParameterFilters => ArrayRef[Paws::SSM::ParameterStringFilter]

Filters to limit the request results.

For GetParametersByPath, the following filter Key names are supported: Type, KeyId, Label, and DataType.

The following Key values are not supported for GetParametersByPath: tag, Name, Path, and Tier.

REQUIRED Path => Str

The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierachy is the parameter name except the last part of the parameter. For the API call to succeeed, the last part of the parameter name cannot be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

Recursive => Bool

Retrieve all parameters within a hierarchy.

If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API action recursively for /a and view /a/b.

WithDecryption => Bool

Retrieve all parameters in a hierarchy with their value decrypted.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetParametersByPath in Paws::SSM

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues