Amazonka.SSM.GetParameterHistory

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.

Creating a Request

data GetParameterHistory

See: newGetParameterHistory smart constructor.

Constructors

GetParameterHistory'

Fields

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

• nextToken :: Maybe Text

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

• 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 for which you want to review history.

Instances

ToJSON GetParameterHistory

Defined in Amazonka.SSM.GetParameterHistory

Methods

toJSON :: GetParameterHistory -> Value

toEncoding :: GetParameterHistory -> Encoding

toJSONList :: [GetParameterHistory] -> Value

toEncodingList :: [GetParameterHistory] -> Encoding

ToHeaders GetParameterHistory

Defined in Amazonka.SSM.GetParameterHistory

Methods

toHeaders :: GetParameterHistory -> [Header]

ToPath GetParameterHistory

Defined in Amazonka.SSM.GetParameterHistory

Methods

toPath :: GetParameterHistory -> ByteString

ToQuery GetParameterHistory

Defined in Amazonka.SSM.GetParameterHistory

Methods

toQuery :: GetParameterHistory -> QueryString

AWSPager GetParameterHistory

Defined in Amazonka.SSM.GetParameterHistory

Methods

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

AWSRequest GetParameterHistory

Defined in Amazonka.SSM.GetParameterHistory

Associated Types

type AWSResponse GetParameterHistory

Methods

request :: (Service -> Service) -> GetParameterHistory -> Request GetParameterHistory

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

Generic GetParameterHistory

Defined in Amazonka.SSM.GetParameterHistory

Associated Types

type Rep GetParameterHistory :: Type -> Type

Methods

from :: GetParameterHistory -> Rep GetParameterHistory x

to :: Rep GetParameterHistory x -> GetParameterHistory

Read GetParameterHistory

Defined in Amazonka.SSM.GetParameterHistory

Methods

readsPrec :: Int -> ReadS GetParameterHistory

readList :: ReadS [GetParameterHistory]

readPrec :: ReadPrec GetParameterHistory

readListPrec :: ReadPrec [GetParameterHistory]

Show GetParameterHistory

Defined in Amazonka.SSM.GetParameterHistory

Methods

showsPrec :: Int -> GetParameterHistory -> ShowS

show :: GetParameterHistory -> String

showList :: [GetParameterHistory] -> ShowS

NFData GetParameterHistory

Defined in Amazonka.SSM.GetParameterHistory

Methods

rnf :: GetParameterHistory -> ()

Eq GetParameterHistory

Defined in Amazonka.SSM.GetParameterHistory

Methods

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

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

Hashable GetParameterHistory

Defined in Amazonka.SSM.GetParameterHistory

Methods

hashWithSalt :: Int -> GetParameterHistory -> Int

hash :: GetParameterHistory -> Int

type AWSResponse GetParameterHistory

Defined in Amazonka.SSM.GetParameterHistory

type AWSResponse GetParameterHistory = GetParameterHistoryResponse

type Rep GetParameterHistory

Defined in Amazonka.SSM.GetParameterHistory

type Rep GetParameterHistory = D1 ('MetaData "GetParameterHistory" "Amazonka.SSM.GetParameterHistory" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "GetParameterHistory'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "withDecryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetParameterHistory

Arguments

:: Text

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

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

$sel:withDecryption:GetParameterHistory', getParameterHistory_withDecryption - Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

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

Request Lenses

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

getParameterHistory_nextToken :: Lens' GetParameterHistory (Maybe Text)

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

getParameterHistory_withDecryption :: Lens' GetParameterHistory (Maybe Bool)

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

getParameterHistory_name :: Lens' GetParameterHistory Text

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

Destructuring the Response

data GetParameterHistoryResponse

See: newGetParameterHistoryResponse smart constructor.

Constructors

GetParameterHistoryResponse'

Fields

• nextToken :: Maybe Text

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

• parameters :: Maybe [ParameterHistory]

  A list of parameters returned by the request.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetParameterHistoryResponse

Defined in Amazonka.SSM.GetParameterHistory

Associated Types

type Rep GetParameterHistoryResponse :: Type -> Type

Methods

from :: GetParameterHistoryResponse -> Rep GetParameterHistoryResponse x

to :: Rep GetParameterHistoryResponse x -> GetParameterHistoryResponse

Show GetParameterHistoryResponse

Defined in Amazonka.SSM.GetParameterHistory

Methods

showsPrec :: Int -> GetParameterHistoryResponse -> ShowS

show :: GetParameterHistoryResponse -> String

showList :: [GetParameterHistoryResponse] -> ShowS

NFData GetParameterHistoryResponse

Defined in Amazonka.SSM.GetParameterHistory

Methods

rnf :: GetParameterHistoryResponse -> ()

Eq GetParameterHistoryResponse

Defined in Amazonka.SSM.GetParameterHistory

Methods

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

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

type Rep GetParameterHistoryResponse

Defined in Amazonka.SSM.GetParameterHistory

type Rep GetParameterHistoryResponse = D1 ('MetaData "GetParameterHistoryResponse" "Amazonka.SSM.GetParameterHistory" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" '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

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:

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.

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)

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])

A list of parameters returned by the request.

getParameterHistoryResponse_httpStatus :: Lens' GetParameterHistoryResponse Int

The response's http status code.