libZSservicesZSamazonka-ssmZSamazonka-ssm
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SSM.GetParameter

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
Eq GetParameter Source # 
Instance details

Defined in Amazonka.SSM.GetParameter

Read GetParameter Source # 
Instance details

Defined in Amazonka.SSM.GetParameter

Show GetParameter Source # 
Instance details

Defined in Amazonka.SSM.GetParameter

Generic GetParameter Source # 
Instance details

Defined in Amazonka.SSM.GetParameter

Associated Types

type Rep GetParameter :: Type -> Type #

NFData GetParameter Source # 
Instance details

Defined in Amazonka.SSM.GetParameter

Methods

rnf :: GetParameter -> () #

Hashable GetParameter Source # 
Instance details

Defined in Amazonka.SSM.GetParameter

ToJSON GetParameter Source # 
Instance details

Defined in Amazonka.SSM.GetParameter

AWSRequest GetParameter Source # 
Instance details

Defined in Amazonka.SSM.GetParameter

Associated Types

type AWSResponse GetParameter #

ToHeaders GetParameter Source # 
Instance details

Defined in Amazonka.SSM.GetParameter

ToPath GetParameter Source # 
Instance details

Defined in Amazonka.SSM.GetParameter

ToQuery GetParameter Source # 
Instance details

Defined in Amazonka.SSM.GetParameter

type Rep GetParameter Source # 
Instance details

Defined in Amazonka.SSM.GetParameter

type Rep GetParameter = D1 ('MetaData "GetParameter" "Amazonka.SSM.GetParameter" "libZSservicesZSamazonka-ssmZSamazonka-ssm" '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)))
type AWSResponse GetParameter Source # 
Instance details

Defined in Amazonka.SSM.GetParameter

newGetParameter Source #

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.

$sel:name: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

Instances

Instances details
Eq GetParameterResponse Source # 
Instance details

Defined in Amazonka.SSM.GetParameter

Show GetParameterResponse Source # 
Instance details

Defined in Amazonka.SSM.GetParameter

Generic GetParameterResponse Source # 
Instance details

Defined in Amazonka.SSM.GetParameter

Associated Types

type Rep GetParameterResponse :: Type -> Type #

NFData GetParameterResponse Source # 
Instance details

Defined in Amazonka.SSM.GetParameter

Methods

rnf :: GetParameterResponse -> () #

type Rep GetParameterResponse Source # 
Instance details

Defined in Amazonka.SSM.GetParameter

type Rep GetParameterResponse = D1 ('MetaData "GetParameterResponse" "Amazonka.SSM.GetParameter" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "GetParameterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "parameter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Parameter)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetParameterResponse Source #

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:parameter:GetParameterResponse', getParameterResponse_parameter - Information about a parameter.

$sel:httpStatus:GetParameterResponse', getParameterResponse_httpStatus - The response's http status code.

Response Lenses