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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Get information about a single parameter by specifying the parameter name.

To get information about more than one parameter at a time, use the GetParameters operation.

Synopsis

Creating a Request

data GetParameter Source #

See: newGetParameter smart constructor.

Constructors

GetParameter'
Fields withDecryption :: Maybe Bool Return decrypted values for secure string parameters. This flag is ignored for `String` and `StringList` parameter types. name :: Text The name of the parameter you want to query. To query by parameter label, use `"Name": "name:label"`. To query by parameter version, use `"Name": "name:version"`.

Instances

Instances details

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

newGetParameter Source #

Arguments

:: Text	`GetParameter`
-> GetParameter

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

GetParameter, getParameter_name - The name of the parameter you want to query.

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

Request Lenses

getParameter_withDecryption :: Lens' GetParameter (Maybe Bool) Source #

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

getParameter_name :: Lens' GetParameter Text Source #

The name of the parameter you want to query.

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

Destructuring the Response

data GetParameterResponse Source #

See: newGetParameterResponse smart constructor.

Constructors

GetParameterResponse'
Fields httpStatus :: Int The response's http status code. parameter :: Parameter Information about a parameter.

Instances

Instances details

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

newGetParameterResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetParameterResponse'`
-> Parameter	`$sel:parameter:GetParameterResponse'`
-> GetParameterResponse

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

$sel:parameter:GetParameterResponse', getParameterResponse_parameter - Information about a parameter.

Response Lenses

getParameterResponse_httpStatus :: Lens' GetParameterResponse Int Source #

The response's http status code.

getParameterResponse_parameter :: Lens' GetParameterResponse Parameter Source #

Information about a parameter.