Network.AWS.SSM.GetParametersByPath

Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters .

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.

Creating a Request

getParametersByPath

Arguments

:: Text

gpbpPath

-> GetParametersByPath

Creates a value of GetParametersByPath with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gpbpWithDecryption - Retrieve all parameters in a hierarchy with their value decrypted.
• gpbpParameterFilters - Filters to limit the request results.
• gpbpNextToken - A token to start the list. Use this token to get the next set of results.
• gpbpRecursive - Retrieve all parameters within a hierarchy.
• gpbpMaxResults - 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.
• gpbpPath - The hierarchy for the parameter. Hierarchies start with a forward slash () and end with the parameter name. A hierarchy can have a maximum of five levels. Examples: EnvironmentTestDBString003 FinanceProdIADOSWinServ2016license15

data GetParametersByPath

See: getParametersByPath smart constructor.

Instances

Eq GetParametersByPath

Methods

(==) :: GetParametersByPath -> GetParametersByPath -> Bool

(/=) :: GetParametersByPath -> GetParametersByPath -> Bool

Data GetParametersByPath

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetParametersByPath -> c GetParametersByPath

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetParametersByPath

toConstr :: GetParametersByPath -> Constr

dataTypeOf :: GetParametersByPath -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetParametersByPath)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetParametersByPath)

gmapT :: (forall b. Data b => b -> b) -> GetParametersByPath -> GetParametersByPath

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetParametersByPath -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetParametersByPath -> r

gmapQ :: (forall d. Data d => d -> u) -> GetParametersByPath -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetParametersByPath -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetParametersByPath -> m GetParametersByPath

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetParametersByPath -> m GetParametersByPath

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetParametersByPath -> m GetParametersByPath

Read GetParametersByPath

Methods

readsPrec :: Int -> ReadS GetParametersByPath

readList :: ReadS [GetParametersByPath]

readPrec :: ReadPrec GetParametersByPath

readListPrec :: ReadPrec [GetParametersByPath]

Show GetParametersByPath

Methods

showsPrec :: Int -> GetParametersByPath -> ShowS

show :: GetParametersByPath -> String

showList :: [GetParametersByPath] -> ShowS

Generic GetParametersByPath

Associated Types

type Rep GetParametersByPath :: * -> *

Methods

from :: GetParametersByPath -> Rep GetParametersByPath x

to :: Rep GetParametersByPath x -> GetParametersByPath

Hashable GetParametersByPath

Methods

hashWithSalt :: Int -> GetParametersByPath -> Int

hash :: GetParametersByPath -> Int

ToJSON GetParametersByPath

Methods

toJSON :: GetParametersByPath -> Value

toEncoding :: GetParametersByPath -> Encoding

toJSONList :: [GetParametersByPath] -> Value

toEncodingList :: [GetParametersByPath] -> Encoding

NFData GetParametersByPath

Methods

rnf :: GetParametersByPath -> ()

AWSRequest GetParametersByPath

Associated Types

type Rs GetParametersByPath :: *

Methods

request :: GetParametersByPath -> Request GetParametersByPath

response :: MonadResource m => Logger -> Service -> Proxy * GetParametersByPath -> ClientResponse -> m (Response GetParametersByPath)

ToQuery GetParametersByPath

Methods

toQuery :: GetParametersByPath -> QueryString

ToPath GetParametersByPath

Methods

toPath :: GetParametersByPath -> ByteString

ToHeaders GetParametersByPath

Methods

toHeaders :: GetParametersByPath -> [Header]

type Rep GetParametersByPath

type Rep GetParametersByPath = D1 (MetaData "GetParametersByPath" "Network.AWS.SSM.GetParametersByPath" "amazonka-ssm-1.5.0-7otWUS4XVRaHT5J0sMcEDs" False) (C1 (MetaCons "GetParametersByPath'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gpbpWithDecryption") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_gpbpParameterFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ParameterStringFilter]))) (S1 (MetaSel (Just Symbol "_gpbpNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_gpbpRecursive") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_gpbpMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_gpbpPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs GetParametersByPath

type Rs GetParametersByPath = GetParametersByPathResponse

Request Lenses

gpbpWithDecryption :: Lens' GetParametersByPath (Maybe Bool)

Retrieve all parameters in a hierarchy with their value decrypted.

gpbpParameterFilters :: Lens' GetParametersByPath [ParameterStringFilter]

Filters to limit the request results.

gpbpNextToken :: Lens' GetParametersByPath (Maybe Text)

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

gpbpRecursive :: Lens' GetParametersByPath (Maybe Bool)

Retrieve all parameters within a hierarchy.

gpbpMaxResults :: Lens' GetParametersByPath (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.

gpbpPath :: Lens' GetParametersByPath Text

The hierarchy for the parameter. Hierarchies start with a forward slash () and end with the parameter name. A hierarchy can have a maximum of five levels. Examples: EnvironmentTestDBString003 FinanceProdIADOSWinServ2016license15

Destructuring the Response

getParametersByPathResponse

Arguments

:: Int

gpbprsResponseStatus

-> GetParametersByPathResponse

Creates a value of GetParametersByPathResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gpbprsNextToken - The token for the next set of items to return. Use this token to get the next set of results.
• gpbprsParameters - A list of parameters found in the specified hierarchy.
• gpbprsResponseStatus - -- | The response status code.

data GetParametersByPathResponse

See: getParametersByPathResponse smart constructor.

Instances

Eq GetParametersByPathResponse

Methods

(==) :: GetParametersByPathResponse -> GetParametersByPathResponse -> Bool

(/=) :: GetParametersByPathResponse -> GetParametersByPathResponse -> Bool

Data GetParametersByPathResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetParametersByPathResponse -> c GetParametersByPathResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetParametersByPathResponse

toConstr :: GetParametersByPathResponse -> Constr

dataTypeOf :: GetParametersByPathResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetParametersByPathResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetParametersByPathResponse)

gmapT :: (forall b. Data b => b -> b) -> GetParametersByPathResponse -> GetParametersByPathResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetParametersByPathResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetParametersByPathResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> GetParametersByPathResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetParametersByPathResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetParametersByPathResponse -> m GetParametersByPathResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetParametersByPathResponse -> m GetParametersByPathResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetParametersByPathResponse -> m GetParametersByPathResponse

Read GetParametersByPathResponse

Methods

readsPrec :: Int -> ReadS GetParametersByPathResponse

readList :: ReadS [GetParametersByPathResponse]

readPrec :: ReadPrec GetParametersByPathResponse

readListPrec :: ReadPrec [GetParametersByPathResponse]

Show GetParametersByPathResponse

Methods

showsPrec :: Int -> GetParametersByPathResponse -> ShowS

show :: GetParametersByPathResponse -> String

showList :: [GetParametersByPathResponse] -> ShowS

Generic GetParametersByPathResponse

Associated Types

type Rep GetParametersByPathResponse :: * -> *

Methods

from :: GetParametersByPathResponse -> Rep GetParametersByPathResponse x

to :: Rep GetParametersByPathResponse x -> GetParametersByPathResponse

NFData GetParametersByPathResponse

Methods

rnf :: GetParametersByPathResponse -> ()

type Rep GetParametersByPathResponse

type Rep GetParametersByPathResponse = D1 (MetaData "GetParametersByPathResponse" "Network.AWS.SSM.GetParametersByPath" "amazonka-ssm-1.5.0-7otWUS4XVRaHT5J0sMcEDs" False) (C1 (MetaCons "GetParametersByPathResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gpbprsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_gpbprsParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Parameter]))) (S1 (MetaSel (Just Symbol "_gpbprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

gpbprsNextToken :: Lens' GetParametersByPathResponse (Maybe Text)

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

gpbprsParameters :: Lens' GetParametersByPathResponse [Parameter]

A list of parameters found in the specified hierarchy.

gpbprsResponseStatus :: Lens' GetParametersByPathResponse Int

• - | The response status code.