Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SSM.GetParametersByPath

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieve information about one or more parameters in a specific hierarchy.

Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

This operation returns paginated results.

Synopsis

data GetParametersByPath = GetParametersByPath' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- parameterFilters :: Maybe [ParameterStringFilter]
- recursive :: Maybe Bool
- withDecryption :: Maybe Bool
- path :: Text
}
newGetParametersByPath :: Text -> GetParametersByPath
getParametersByPath_maxResults :: Lens' GetParametersByPath (Maybe Natural)
getParametersByPath_nextToken :: Lens' GetParametersByPath (Maybe Text)
getParametersByPath_parameterFilters :: Lens' GetParametersByPath (Maybe [ParameterStringFilter])
getParametersByPath_recursive :: Lens' GetParametersByPath (Maybe Bool)
getParametersByPath_withDecryption :: Lens' GetParametersByPath (Maybe Bool)
getParametersByPath_path :: Lens' GetParametersByPath Text
data GetParametersByPathResponse = GetParametersByPathResponse' {
- nextToken :: Maybe Text
- parameters :: Maybe [Parameter]
- httpStatus :: Int
}
newGetParametersByPathResponse :: Int -> GetParametersByPathResponse
getParametersByPathResponse_nextToken :: Lens' GetParametersByPathResponse (Maybe Text)
getParametersByPathResponse_parameters :: Lens' GetParametersByPathResponse (Maybe [Parameter])
getParametersByPathResponse_httpStatus :: Lens' GetParametersByPathResponse Int

Creating a Request

data GetParametersByPath Source #

See: newGetParametersByPath smart constructor.

Constructors

GetParametersByPath'

Fields

maxResults :: Maybe Natural
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 :: Maybe Text
A token to start the list. Use this token to get the next set of results.
parameterFilters :: Maybe [ParameterStringFilter]
Filters to limit the request results.
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.
recursive :: Maybe 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 operation recursively for /a and view /a/b.
withDecryption :: Maybe Bool
Retrieve all parameters in a hierarchy with their value decrypted.
path :: Text
The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, 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

Instances

Instances details

ToJSON GetParametersByPath Source #
Instance details Defined in Amazonka.SSM.GetParametersByPath Methods toJSON :: GetParametersByPath -> Value # toEncoding :: GetParametersByPath -> Encoding # toJSONList :: [GetParametersByPath] -> Value # toEncodingList :: [GetParametersByPath] -> Encoding #
ToHeaders GetParametersByPath Source #
Instance details Defined in Amazonka.SSM.GetParametersByPath Methods toHeaders :: GetParametersByPath -> [Header] #
ToPath GetParametersByPath Source #
Instance details Defined in Amazonka.SSM.GetParametersByPath Methods toPath :: GetParametersByPath -> ByteString #
ToQuery GetParametersByPath Source #
Instance details Defined in Amazonka.SSM.GetParametersByPath Methods toQuery :: GetParametersByPath -> QueryString #
AWSPager GetParametersByPath Source #
Instance details Defined in Amazonka.SSM.GetParametersByPath Methods page :: GetParametersByPath -> AWSResponse GetParametersByPath -> Maybe GetParametersByPath #
AWSRequest GetParametersByPath Source #
Instance details Defined in Amazonka.SSM.GetParametersByPath Associated Types type AWSResponse GetParametersByPath # Methods request :: (Service -> Service) -> GetParametersByPath -> Request GetParametersByPath # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetParametersByPath -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetParametersByPath))) #
Generic GetParametersByPath Source #
Instance details Defined in Amazonka.SSM.GetParametersByPath Associated Types type Rep GetParametersByPath :: Type -> Type # Methods from :: GetParametersByPath -> Rep GetParametersByPath x # to :: Rep GetParametersByPath x -> GetParametersByPath #
Read GetParametersByPath Source #
Instance details Defined in Amazonka.SSM.GetParametersByPath Methods readsPrec :: Int -> ReadS GetParametersByPath # readList :: ReadS [GetParametersByPath] # readPrec :: ReadPrec GetParametersByPath # readListPrec :: ReadPrec [GetParametersByPath] #
Show GetParametersByPath Source #
Instance details Defined in Amazonka.SSM.GetParametersByPath Methods showsPrec :: Int -> GetParametersByPath -> ShowS # show :: GetParametersByPath -> String # showList :: [GetParametersByPath] -> ShowS #
NFData GetParametersByPath Source #
Instance details Defined in Amazonka.SSM.GetParametersByPath Methods rnf :: GetParametersByPath -> () #
Eq GetParametersByPath Source #
Instance details Defined in Amazonka.SSM.GetParametersByPath Methods (==) :: GetParametersByPath -> GetParametersByPath -> Bool # (/=) :: GetParametersByPath -> GetParametersByPath -> Bool #
Hashable GetParametersByPath Source #
Instance details Defined in Amazonka.SSM.GetParametersByPath Methods hashWithSalt :: Int -> GetParametersByPath -> Int # hash :: GetParametersByPath -> Int #
type AWSResponse GetParametersByPath Source #
Instance details Defined in Amazonka.SSM.GetParametersByPath type AWSResponse GetParametersByPath = GetParametersByPathResponse
type Rep GetParametersByPath Source #
Instance details Defined in Amazonka.SSM.GetParametersByPath type Rep GetParametersByPath = D1 ('MetaData "GetParametersByPath" "Amazonka.SSM.GetParametersByPath" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "GetParametersByPath'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "parameterFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ParameterStringFilter])))) :: (S1 ('MetaSel ('Just "recursive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "withDecryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetParametersByPath Source #

Arguments

:: Text	`$sel:path:GetParametersByPath'`
-> GetParametersByPath

Create a value of GetParametersByPath with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maxResults:GetParametersByPath', getParametersByPath_maxResults - 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.

GetParametersByPath, getParametersByPath_nextToken - A token to start the list. Use this token to get the next set of results.

$sel:parameterFilters:GetParametersByPath', getParametersByPath_parameterFilters - Filters to limit the request results.

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.

$sel:recursive:GetParametersByPath', getParametersByPath_recursive - 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 operation recursively for /a and view /a/b.

$sel:withDecryption:GetParametersByPath', getParametersByPath_withDecryption - Retrieve all parameters in a hierarchy with their value decrypted.

$sel:path:GetParametersByPath', getParametersByPath_path - The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, 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

Request Lenses

getParametersByPath_maxResults :: Lens' GetParametersByPath (Maybe Natural) Source #

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.

getParametersByPath_nextToken :: Lens' GetParametersByPath (Maybe Text) Source #

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

getParametersByPath_parameterFilters :: Lens' GetParametersByPath (Maybe [ParameterStringFilter]) Source #

Filters to limit the request results.

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.

getParametersByPath_recursive :: Lens' GetParametersByPath (Maybe Bool) Source #

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

getParametersByPath_withDecryption :: Lens' GetParametersByPath (Maybe Bool) Source #

Retrieve all parameters in a hierarchy with their value decrypted.

getParametersByPath_path :: Lens' GetParametersByPath Text Source #

The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, 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

Destructuring the Response

data GetParametersByPathResponse Source #

See: newGetParametersByPathResponse smart constructor.

Constructors

GetParametersByPathResponse'
Fields nextToken :: Maybe Text The token for the next set of items to return. Use this token to get the next set of results. parameters :: Maybe [Parameter] A list of parameters found in the specified hierarchy. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetParametersByPathResponse Source #
Instance details Defined in Amazonka.SSM.GetParametersByPath Associated Types type Rep GetParametersByPathResponse :: Type -> Type # Methods from :: GetParametersByPathResponse -> Rep GetParametersByPathResponse x # to :: Rep GetParametersByPathResponse x -> GetParametersByPathResponse #
Show GetParametersByPathResponse Source #
Instance details Defined in Amazonka.SSM.GetParametersByPath Methods showsPrec :: Int -> GetParametersByPathResponse -> ShowS # show :: GetParametersByPathResponse -> String # showList :: [GetParametersByPathResponse] -> ShowS #
NFData GetParametersByPathResponse Source #
Instance details Defined in Amazonka.SSM.GetParametersByPath Methods rnf :: GetParametersByPathResponse -> () #
Eq GetParametersByPathResponse Source #
Instance details Defined in Amazonka.SSM.GetParametersByPath Methods (==) :: GetParametersByPathResponse -> GetParametersByPathResponse -> Bool # (/=) :: GetParametersByPathResponse -> GetParametersByPathResponse -> Bool #
type Rep GetParametersByPathResponse Source #
Instance details Defined in Amazonka.SSM.GetParametersByPath type Rep GetParametersByPathResponse = D1 ('MetaData "GetParametersByPathResponse" "Amazonka.SSM.GetParametersByPath" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "GetParametersByPathResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Parameter])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetParametersByPathResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetParametersByPathResponse'`
-> GetParametersByPathResponse

Create a value of GetParametersByPathResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetParametersByPath, getParametersByPathResponse_nextToken - The token for the next set of items to return. Use this token to get the next set of results.

GetParametersByPathResponse, getParametersByPathResponse_parameters - A list of parameters found in the specified hierarchy.

$sel:httpStatus:GetParametersByPathResponse', getParametersByPathResponse_httpStatus - The response's http status code.

Response Lenses

getParametersByPathResponse_nextToken :: Lens' GetParametersByPathResponse (Maybe Text) Source #

The token for the next set of items to return. Use this token to get the next set of results.

getParametersByPathResponse_parameters :: Lens' GetParametersByPathResponse (Maybe [Parameter]) Source #

A list of parameters found in the specified hierarchy.

getParametersByPathResponse_httpStatus :: Lens' GetParametersByPathResponse Int Source #

The response's http status code.