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.GetParameters

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Get information about one or more parameters by specifying multiple parameter names.

To get information about a single parameter, you can use the GetParameter operation instead.

Creating a Request

data GetParameters Source #

See: newGetParameters smart constructor.

Constructors

GetParameters'

Fields

withDecryption :: Maybe Bool
Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.
names :: NonEmpty Text
Names of the parameters for which you want to query information.
To query by parameter label, use "Name": "name:label". To query by parameter version, use "Name": "name:version".

Instances

Instances details

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

newGetParameters Source #

Arguments

:: NonEmpty Text	`$sel:names:GetParameters'`
-> GetParameters

Create a value of GetParameters 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:withDecryption:GetParameters', getParameters_withDecryption - Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

$sel:names:GetParameters', getParameters_names - Names of the parameters for which you want to query information.

To query by parameter label, use "Name": "name:label". To query by parameter version, use "Name": "name:version".

Request Lenses

getParameters_withDecryption :: Lens' GetParameters (Maybe Bool) Source #

Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

getParameters_names :: Lens' GetParameters (NonEmpty Text) Source #

Names of the parameters for which you want to query information.

To query by parameter label, use "Name": "name:label". To query by parameter version, use "Name": "name:version".

Destructuring the Response

data GetParametersResponse Source #

See: newGetParametersResponse smart constructor.

Constructors

GetParametersResponse'
Fields httpStatus :: Int The response's http status code. invalidParameters :: [Text] A list of parameters that aren't formatted correctly or don't run during an execution. parameters :: [Parameter] A list of details for a parameter.

Instances

Instances details

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

newGetParametersResponse Source #

Arguments

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

Create a value of GetParametersResponse 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:httpStatus:GetParametersResponse', getParametersResponse_httpStatus - The response's http status code.

$sel:invalidParameters:GetParametersResponse', getParametersResponse_invalidParameters - A list of parameters that aren't formatted correctly or don't run during an execution.

GetParametersResponse, getParametersResponse_parameters - A list of details for a parameter.

Response Lenses

getParametersResponse_httpStatus :: Lens' GetParametersResponse Int Source #

The response's http status code.

getParametersResponse_invalidParameters :: Lens' GetParametersResponse [Text] Source #

A list of parameters that aren't formatted correctly or don't run during an execution.

getParametersResponse_parameters :: Lens' GetParametersResponse [Parameter] Source #

A list of details for a parameter.