amazonka-config-2.0: Amazon Config SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Config.GetResourceConfigHistory

Description

Returns a list of ConfigurationItems for the specified resource. The list contains details about each state of the resource during the specified time interval. If you specified a retention period to retain your ConfigurationItems between a minimum of 30 days and a maximum of 7 years (2557 days), Config returns the ConfigurationItems for the specified retention period.

The response is paginated. By default, Config returns a limit of 10 configuration items per page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified limit. In such cases, you can make another call, using the nextToken.

This operation returns paginated results.

Synopsis

Creating a Request

data GetResourceConfigHistory Source #

The input for the GetResourceConfigHistory action.

See: newGetResourceConfigHistory smart constructor.

Constructors

GetResourceConfigHistory' 

Fields

  • chronologicalOrder :: Maybe ChronologicalOrder

    The chronological order for configuration items listed. By default, the results are listed in reverse chronological order.

  • earlierTime :: Maybe POSIX

    The time stamp that indicates an earlier time. If not specified, the action returns paginated results that contain configuration items that start when the first configuration item was recorded.

  • laterTime :: Maybe POSIX

    The time stamp that indicates a later time. If not specified, current time is taken.

  • limit :: Maybe Natural

    The maximum number of configuration items returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

  • nextToken :: Maybe Text

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

  • resourceType :: ResourceType

    The resource type.

  • resourceId :: Text

    The ID of the resource (for example., sg-xxxxxx).

Instances

Instances details
ToJSON GetResourceConfigHistory Source # 
Instance details

Defined in Amazonka.Config.GetResourceConfigHistory

ToHeaders GetResourceConfigHistory Source # 
Instance details

Defined in Amazonka.Config.GetResourceConfigHistory

ToPath GetResourceConfigHistory Source # 
Instance details

Defined in Amazonka.Config.GetResourceConfigHistory

ToQuery GetResourceConfigHistory Source # 
Instance details

Defined in Amazonka.Config.GetResourceConfigHistory

AWSPager GetResourceConfigHistory Source # 
Instance details

Defined in Amazonka.Config.GetResourceConfigHistory

AWSRequest GetResourceConfigHistory Source # 
Instance details

Defined in Amazonka.Config.GetResourceConfigHistory

Generic GetResourceConfigHistory Source # 
Instance details

Defined in Amazonka.Config.GetResourceConfigHistory

Associated Types

type Rep GetResourceConfigHistory :: Type -> Type #

Read GetResourceConfigHistory Source # 
Instance details

Defined in Amazonka.Config.GetResourceConfigHistory

Show GetResourceConfigHistory Source # 
Instance details

Defined in Amazonka.Config.GetResourceConfigHistory

NFData GetResourceConfigHistory Source # 
Instance details

Defined in Amazonka.Config.GetResourceConfigHistory

Eq GetResourceConfigHistory Source # 
Instance details

Defined in Amazonka.Config.GetResourceConfigHistory

Hashable GetResourceConfigHistory Source # 
Instance details

Defined in Amazonka.Config.GetResourceConfigHistory

type AWSResponse GetResourceConfigHistory Source # 
Instance details

Defined in Amazonka.Config.GetResourceConfigHistory

type Rep GetResourceConfigHistory Source # 
Instance details

Defined in Amazonka.Config.GetResourceConfigHistory

type Rep GetResourceConfigHistory = D1 ('MetaData "GetResourceConfigHistory" "Amazonka.Config.GetResourceConfigHistory" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "GetResourceConfigHistory'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "chronologicalOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChronologicalOrder)) :*: (S1 ('MetaSel ('Just "earlierTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "laterTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceType) :*: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetResourceConfigHistory Source #

Create a value of GetResourceConfigHistory 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:chronologicalOrder:GetResourceConfigHistory', getResourceConfigHistory_chronologicalOrder - The chronological order for configuration items listed. By default, the results are listed in reverse chronological order.

$sel:earlierTime:GetResourceConfigHistory', getResourceConfigHistory_earlierTime - The time stamp that indicates an earlier time. If not specified, the action returns paginated results that contain configuration items that start when the first configuration item was recorded.

$sel:laterTime:GetResourceConfigHistory', getResourceConfigHistory_laterTime - The time stamp that indicates a later time. If not specified, current time is taken.

$sel:limit:GetResourceConfigHistory', getResourceConfigHistory_limit - The maximum number of configuration items returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

GetResourceConfigHistory, getResourceConfigHistory_nextToken - The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

GetResourceConfigHistory, getResourceConfigHistory_resourceType - The resource type.

GetResourceConfigHistory, getResourceConfigHistory_resourceId - The ID of the resource (for example., sg-xxxxxx).

Request Lenses

getResourceConfigHistory_chronologicalOrder :: Lens' GetResourceConfigHistory (Maybe ChronologicalOrder) Source #

The chronological order for configuration items listed. By default, the results are listed in reverse chronological order.

getResourceConfigHistory_earlierTime :: Lens' GetResourceConfigHistory (Maybe UTCTime) Source #

The time stamp that indicates an earlier time. If not specified, the action returns paginated results that contain configuration items that start when the first configuration item was recorded.

getResourceConfigHistory_laterTime :: Lens' GetResourceConfigHistory (Maybe UTCTime) Source #

The time stamp that indicates a later time. If not specified, current time is taken.

getResourceConfigHistory_limit :: Lens' GetResourceConfigHistory (Maybe Natural) Source #

The maximum number of configuration items returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

getResourceConfigHistory_nextToken :: Lens' GetResourceConfigHistory (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

getResourceConfigHistory_resourceId :: Lens' GetResourceConfigHistory Text Source #

The ID of the resource (for example., sg-xxxxxx).

Destructuring the Response

data GetResourceConfigHistoryResponse Source #

The output for the GetResourceConfigHistory action.

See: newGetResourceConfigHistoryResponse smart constructor.

Constructors

GetResourceConfigHistoryResponse' 

Fields

Instances

Instances details
Generic GetResourceConfigHistoryResponse Source # 
Instance details

Defined in Amazonka.Config.GetResourceConfigHistory

Associated Types

type Rep GetResourceConfigHistoryResponse :: Type -> Type #

Read GetResourceConfigHistoryResponse Source # 
Instance details

Defined in Amazonka.Config.GetResourceConfigHistory

Show GetResourceConfigHistoryResponse Source # 
Instance details

Defined in Amazonka.Config.GetResourceConfigHistory

NFData GetResourceConfigHistoryResponse Source # 
Instance details

Defined in Amazonka.Config.GetResourceConfigHistory

Eq GetResourceConfigHistoryResponse Source # 
Instance details

Defined in Amazonka.Config.GetResourceConfigHistory

type Rep GetResourceConfigHistoryResponse Source # 
Instance details

Defined in Amazonka.Config.GetResourceConfigHistory

type Rep GetResourceConfigHistoryResponse = D1 ('MetaData "GetResourceConfigHistoryResponse" "Amazonka.Config.GetResourceConfigHistory" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "GetResourceConfigHistoryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "configurationItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ConfigurationItem])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetResourceConfigHistoryResponse Source #

Create a value of GetResourceConfigHistoryResponse 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:configurationItems:GetResourceConfigHistoryResponse', getResourceConfigHistoryResponse_configurationItems - A list that contains the configuration history of one or more resources.

GetResourceConfigHistory, getResourceConfigHistoryResponse_nextToken - The string that you use in a subsequent request to get the next page of results in a paginated response.

$sel:httpStatus:GetResourceConfigHistoryResponse', getResourceConfigHistoryResponse_httpStatus - The response's http status code.

Response Lenses

getResourceConfigHistoryResponse_configurationItems :: Lens' GetResourceConfigHistoryResponse (Maybe [ConfigurationItem]) Source #

A list that contains the configuration history of one or more resources.

getResourceConfigHistoryResponse_nextToken :: Lens' GetResourceConfigHistoryResponse (Maybe Text) Source #

The string that you use in a subsequent request to get the next page of results in a paginated response.