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

Description

Retrieves the history of all changes to a parameter.

If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, GetParameterHistory retrieves whatever the original key alias was referencing.

This operation returns paginated results.

Synopsis

Creating a Request

data GetParameterHistory Source #

See: newGetParameterHistory smart constructor.

Constructors

GetParameterHistory' 

Fields

  • withDecryption :: Maybe Bool

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

  • nextToken :: Maybe Text

    The token for the next set of items to return. (You received this token from a previous call.)

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

  • name :: Text

    The name of the parameter for which you want to review history.

Instances

Instances details
Eq GetParameterHistory Source # 
Instance details

Defined in Amazonka.SSM.GetParameterHistory

Methods

(==) :: GetParameterHistory -> GetParameterHistory -> Bool #

(/=) :: GetParameterHistory -> GetParameterHistory -> Bool #

Read GetParameterHistory Source # 
Instance details

Defined in Amazonka.SSM.GetParameterHistory

Methods

readsPrec :: Int -> ReadS GetParameterHistory #

readList :: ReadS [GetParameterHistory] #

readPrec :: ReadPrec GetParameterHistory #

readListPrec :: ReadPrec [GetParameterHistory] #

Show GetParameterHistory Source # 
Instance details

Defined in Amazonka.SSM.GetParameterHistory

Methods

showsPrec :: Int -> GetParameterHistory -> ShowS #

show :: GetParameterHistory -> String #

showList :: [GetParameterHistory] -> ShowS #

Generic GetParameterHistory Source # 
Instance details

Defined in Amazonka.SSM.GetParameterHistory

Associated Types

type Rep GetParameterHistory :: Type -> Type #

Methods

from :: GetParameterHistory -> Rep GetParameterHistory x #

to :: Rep GetParameterHistory x -> GetParameterHistory #

NFData GetParameterHistory Source # 
Instance details

Defined in Amazonka.SSM.GetParameterHistory

Methods

rnf :: GetParameterHistory -> () #

Hashable GetParameterHistory Source # 
Instance details

Defined in Amazonka.SSM.GetParameterHistory

Methods

hashWithSalt :: Int -> GetParameterHistory -> Int #

hash :: GetParameterHistory -> Int #

ToJSON GetParameterHistory Source # 
Instance details

Defined in Amazonka.SSM.GetParameterHistory

Methods

toJSON :: GetParameterHistory -> Value #

toEncoding :: GetParameterHistory -> Encoding #

toJSONList :: [GetParameterHistory] -> Value #

toEncodingList :: [GetParameterHistory] -> Encoding #

AWSPager GetParameterHistory Source # 
Instance details

Defined in Amazonka.SSM.GetParameterHistory

Methods

page :: GetParameterHistory -> AWSResponse GetParameterHistory -> Maybe GetParameterHistory #

AWSRequest GetParameterHistory Source # 
Instance details

Defined in Amazonka.SSM.GetParameterHistory

Associated Types

type AWSResponse GetParameterHistory #

Methods

request :: GetParameterHistory -> Request GetParameterHistory #

response :: MonadResource m => Logger -> Service -> Proxy GetParameterHistory -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetParameterHistory))) #

ToHeaders GetParameterHistory Source # 
Instance details

Defined in Amazonka.SSM.GetParameterHistory

Methods

toHeaders :: GetParameterHistory -> [Header] #

ToPath GetParameterHistory Source # 
Instance details

Defined in Amazonka.SSM.GetParameterHistory

Methods

toPath :: GetParameterHistory -> ByteString #

ToQuery GetParameterHistory Source # 
Instance details

Defined in Amazonka.SSM.GetParameterHistory

Methods

toQuery :: GetParameterHistory -> QueryString #

type Rep GetParameterHistory Source # 
Instance details

Defined in Amazonka.SSM.GetParameterHistory

type Rep GetParameterHistory = D1 ('MetaData "GetParameterHistory" "Amazonka.SSM.GetParameterHistory" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "GetParameterHistory'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "withDecryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetParameterHistory Source # 
Instance details

Defined in Amazonka.SSM.GetParameterHistory

type AWSResponse GetParameterHistory = GetParameterHistoryResponse

newGetParameterHistory Source #

Arguments

:: Text

$sel:name:GetParameterHistory'

-> GetParameterHistory 

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

$sel:nextToken:GetParameterHistory', getParameterHistory_nextToken - The token for the next set of items to return. (You received this token from a previous call.)

$sel:maxResults:GetParameterHistory', getParameterHistory_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.

$sel:name:GetParameterHistory', getParameterHistory_name - The name of the parameter for which you want to review history.

Request Lenses

getParameterHistory_withDecryption :: Lens' GetParameterHistory (Maybe Bool) Source #

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

getParameterHistory_nextToken :: Lens' GetParameterHistory (Maybe Text) Source #

The token for the next set of items to return. (You received this token from a previous call.)

getParameterHistory_maxResults :: Lens' GetParameterHistory (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.

getParameterHistory_name :: Lens' GetParameterHistory Text Source #

The name of the parameter for which you want to review history.

Destructuring the Response

data GetParameterHistoryResponse Source #

See: newGetParameterHistoryResponse smart constructor.

Constructors

GetParameterHistoryResponse' 

Fields

Instances

Instances details
Eq GetParameterHistoryResponse Source # 
Instance details

Defined in Amazonka.SSM.GetParameterHistory

Methods

(==) :: GetParameterHistoryResponse -> GetParameterHistoryResponse -> Bool #

(/=) :: GetParameterHistoryResponse -> GetParameterHistoryResponse -> Bool #

Show GetParameterHistoryResponse Source # 
Instance details

Defined in Amazonka.SSM.GetParameterHistory

Methods

showsPrec :: Int -> GetParameterHistoryResponse -> ShowS #

show :: GetParameterHistoryResponse -> String #

showList :: [GetParameterHistoryResponse] -> ShowS #

Generic GetParameterHistoryResponse Source # 
Instance details

Defined in Amazonka.SSM.GetParameterHistory

Associated Types

type Rep GetParameterHistoryResponse :: Type -> Type #

Methods

from :: GetParameterHistoryResponse -> Rep GetParameterHistoryResponse x #

to :: Rep GetParameterHistoryResponse x -> GetParameterHistoryResponse #

NFData GetParameterHistoryResponse Source # 
Instance details

Defined in Amazonka.SSM.GetParameterHistory

Methods

rnf :: GetParameterHistoryResponse -> () #

type Rep GetParameterHistoryResponse Source # 
Instance details

Defined in Amazonka.SSM.GetParameterHistory

type Rep GetParameterHistoryResponse = D1 ('MetaData "GetParameterHistoryResponse" "Amazonka.SSM.GetParameterHistory" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "GetParameterHistoryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ParameterHistory])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetParameterHistoryResponse Source #

Arguments

:: Int

$sel:httpStatus:GetParameterHistoryResponse'

-> GetParameterHistoryResponse 

Create a value of GetParameterHistoryResponse 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:nextToken:GetParameterHistory', getParameterHistoryResponse_nextToken - The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

$sel:parameters:GetParameterHistoryResponse', getParameterHistoryResponse_parameters - A list of parameters returned by the request.

$sel:httpStatus:GetParameterHistoryResponse', getParameterHistoryResponse_httpStatus - The response's http status code.

Response Lenses

getParameterHistoryResponse_nextToken :: Lens' GetParameterHistoryResponse (Maybe Text) Source #

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

getParameterHistoryResponse_parameters :: Lens' GetParameterHistoryResponse (Maybe [ParameterHistory]) Source #

A list of parameters returned by the request.

getParameterHistoryResponse_httpStatus :: Lens' GetParameterHistoryResponse Int Source #

The response's http status code.