GetParametersByPathRequest

import type { GetParametersByPathRequest } from "https://aws-api.deno.dev/v0.3/services/ssm.ts?docs=full";

interface GetParametersByPathRequest {

MaxResults?: number | null;

NextToken?: string | null;

ParameterFilters?: ParameterStringFilter[] | null;

Path: string;

Recursive?: boolean | null;

WithDecryption?: boolean | null;

}

§Properties

MaxResults?: number | null

[src]

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?: string | null

[src]

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

ParameterFilters?: ParameterStringFilter[] | null

[src]

Filters to limit the request results.

Note: The following Key values are supported for GetParametersByPath: Type, KeyId, and Label. The following Key values aren't supported for GetParametersByPath: tag, DataType, Name, Path, and Tier.

Path: string

[src]

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 can't 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?: boolean | null

[src]

Retrieve all parameters within a hierarchy.

! IMPORTANT: ! 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 operation recursively for /a and view /a/b.

WithDecryption?: boolean | null

[src]

Retrieve all parameters in a hierarchy with their value decrypted.