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.EC2.GetIpamAddressHistory

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieve historical information about a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.

This operation returns paginated results.

Synopsis

data GetIpamAddressHistory = GetIpamAddressHistory' {
- dryRun :: Maybe Bool
- endTime :: Maybe ISO8601
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- startTime :: Maybe ISO8601
- vpcId :: Maybe Text
- cidr :: Text
- ipamScopeId :: Text
}
newGetIpamAddressHistory :: Text -> Text -> GetIpamAddressHistory
getIpamAddressHistory_dryRun :: Lens' GetIpamAddressHistory (Maybe Bool)
getIpamAddressHistory_endTime :: Lens' GetIpamAddressHistory (Maybe UTCTime)
getIpamAddressHistory_maxResults :: Lens' GetIpamAddressHistory (Maybe Natural)
getIpamAddressHistory_nextToken :: Lens' GetIpamAddressHistory (Maybe Text)
getIpamAddressHistory_startTime :: Lens' GetIpamAddressHistory (Maybe UTCTime)
getIpamAddressHistory_vpcId :: Lens' GetIpamAddressHistory (Maybe Text)
getIpamAddressHistory_cidr :: Lens' GetIpamAddressHistory Text
getIpamAddressHistory_ipamScopeId :: Lens' GetIpamAddressHistory Text
data GetIpamAddressHistoryResponse = GetIpamAddressHistoryResponse' {
- historyRecords :: Maybe [IpamAddressHistoryRecord]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetIpamAddressHistoryResponse :: Int -> GetIpamAddressHistoryResponse
getIpamAddressHistoryResponse_historyRecords :: Lens' GetIpamAddressHistoryResponse (Maybe [IpamAddressHistoryRecord])
getIpamAddressHistoryResponse_nextToken :: Lens' GetIpamAddressHistoryResponse (Maybe Text)
getIpamAddressHistoryResponse_httpStatus :: Lens' GetIpamAddressHistoryResponse Int

Creating a Request

data GetIpamAddressHistory Source #

See: newGetIpamAddressHistory smart constructor.

Constructors

GetIpamAddressHistory'

Fields

dryRun :: Maybe Bool
A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
endTime :: Maybe ISO8601
The end of the time period for which you are looking for history. If you omit this option, it will default to the current time.
maxResults :: Maybe Natural
The maximum number of historical results you would like returned per page. Defaults to 100.
nextToken :: Maybe Text
The token for the next page of results.
startTime :: Maybe ISO8601
The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime.
vpcId :: Maybe Text
The ID of the VPC you want your history records filtered by.
cidr :: Text
The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR.
ipamScopeId :: Text
The ID of the IPAM scope that the CIDR is in.

Instances

Instances details

ToHeaders GetIpamAddressHistory Source #
Instance details Defined in Amazonka.EC2.GetIpamAddressHistory Methods toHeaders :: GetIpamAddressHistory -> [Header] #
ToPath GetIpamAddressHistory Source #
Instance details Defined in Amazonka.EC2.GetIpamAddressHistory Methods toPath :: GetIpamAddressHistory -> ByteString #
ToQuery GetIpamAddressHistory Source #
Instance details Defined in Amazonka.EC2.GetIpamAddressHistory Methods toQuery :: GetIpamAddressHistory -> QueryString #
AWSPager GetIpamAddressHistory Source #
Instance details Defined in Amazonka.EC2.GetIpamAddressHistory Methods page :: GetIpamAddressHistory -> AWSResponse GetIpamAddressHistory -> Maybe GetIpamAddressHistory #
AWSRequest GetIpamAddressHistory Source #
Instance details Defined in Amazonka.EC2.GetIpamAddressHistory Associated Types type AWSResponse GetIpamAddressHistory # Methods request :: (Service -> Service) -> GetIpamAddressHistory -> Request GetIpamAddressHistory # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetIpamAddressHistory -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetIpamAddressHistory))) #
Generic GetIpamAddressHistory Source #
Instance details Defined in Amazonka.EC2.GetIpamAddressHistory Associated Types type Rep GetIpamAddressHistory :: Type -> Type # Methods from :: GetIpamAddressHistory -> Rep GetIpamAddressHistory x # to :: Rep GetIpamAddressHistory x -> GetIpamAddressHistory #
Read GetIpamAddressHistory Source #
Instance details Defined in Amazonka.EC2.GetIpamAddressHistory Methods readsPrec :: Int -> ReadS GetIpamAddressHistory # readList :: ReadS [GetIpamAddressHistory] # readPrec :: ReadPrec GetIpamAddressHistory # readListPrec :: ReadPrec [GetIpamAddressHistory] #
Show GetIpamAddressHistory Source #
Instance details Defined in Amazonka.EC2.GetIpamAddressHistory Methods showsPrec :: Int -> GetIpamAddressHistory -> ShowS # show :: GetIpamAddressHistory -> String # showList :: [GetIpamAddressHistory] -> ShowS #
NFData GetIpamAddressHistory Source #
Instance details Defined in Amazonka.EC2.GetIpamAddressHistory Methods rnf :: GetIpamAddressHistory -> () #
Eq GetIpamAddressHistory Source #
Instance details Defined in Amazonka.EC2.GetIpamAddressHistory Methods (==) :: GetIpamAddressHistory -> GetIpamAddressHistory -> Bool # (/=) :: GetIpamAddressHistory -> GetIpamAddressHistory -> Bool #
Hashable GetIpamAddressHistory Source #
Instance details Defined in Amazonka.EC2.GetIpamAddressHistory Methods hashWithSalt :: Int -> GetIpamAddressHistory -> Int # hash :: GetIpamAddressHistory -> Int #
type AWSResponse GetIpamAddressHistory Source #
Instance details Defined in Amazonka.EC2.GetIpamAddressHistory type AWSResponse GetIpamAddressHistory = GetIpamAddressHistoryResponse
type Rep GetIpamAddressHistory Source #
Instance details Defined in Amazonka.EC2.GetIpamAddressHistory type Rep GetIpamAddressHistory = D1 ('MetaData "GetIpamAddressHistory" "Amazonka.EC2.GetIpamAddressHistory" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "GetIpamAddressHistory'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "cidr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "ipamScopeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetIpamAddressHistory Source #

Arguments

:: Text	`GetIpamAddressHistory`
-> Text	`GetIpamAddressHistory`
-> GetIpamAddressHistory

Create a value of GetIpamAddressHistory 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:dryRun:GetIpamAddressHistory', getIpamAddressHistory_dryRun - A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

GetIpamAddressHistory, getIpamAddressHistory_endTime - The end of the time period for which you are looking for history. If you omit this option, it will default to the current time.

$sel:maxResults:GetIpamAddressHistory', getIpamAddressHistory_maxResults - The maximum number of historical results you would like returned per page. Defaults to 100.

GetIpamAddressHistory, getIpamAddressHistory_nextToken - The token for the next page of results.

GetIpamAddressHistory, getIpamAddressHistory_startTime - The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime.

GetIpamAddressHistory, getIpamAddressHistory_vpcId - The ID of the VPC you want your history records filtered by.

GetIpamAddressHistory, getIpamAddressHistory_cidr - The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR.

GetIpamAddressHistory, getIpamAddressHistory_ipamScopeId - The ID of the IPAM scope that the CIDR is in.

Request Lenses

getIpamAddressHistory_dryRun :: Lens' GetIpamAddressHistory (Maybe Bool) Source #

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

getIpamAddressHistory_endTime :: Lens' GetIpamAddressHistory (Maybe UTCTime) Source #

The end of the time period for which you are looking for history. If you omit this option, it will default to the current time.

getIpamAddressHistory_maxResults :: Lens' GetIpamAddressHistory (Maybe Natural) Source #

The maximum number of historical results you would like returned per page. Defaults to 100.

getIpamAddressHistory_nextToken :: Lens' GetIpamAddressHistory (Maybe Text) Source #

The token for the next page of results.

getIpamAddressHistory_startTime :: Lens' GetIpamAddressHistory (Maybe UTCTime) Source #

The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime.

getIpamAddressHistory_vpcId :: Lens' GetIpamAddressHistory (Maybe Text) Source #

The ID of the VPC you want your history records filtered by.

getIpamAddressHistory_cidr :: Lens' GetIpamAddressHistory Text Source #

The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR.

getIpamAddressHistory_ipamScopeId :: Lens' GetIpamAddressHistory Text Source #

The ID of the IPAM scope that the CIDR is in.

Destructuring the Response

data GetIpamAddressHistoryResponse Source #

See: newGetIpamAddressHistoryResponse smart constructor.

Constructors

GetIpamAddressHistoryResponse'

Fields

historyRecords :: Maybe [IpamAddressHistoryRecord]
A historical record for a CIDR within an IPAM scope. If the CIDR is associated with an EC2 instance, you will see an object in the response for the instance and one for the network interface.
nextToken :: Maybe Text
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetIpamAddressHistoryResponse Source #
Instance details Defined in Amazonka.EC2.GetIpamAddressHistory Associated Types type Rep GetIpamAddressHistoryResponse :: Type -> Type # Methods from :: GetIpamAddressHistoryResponse -> Rep GetIpamAddressHistoryResponse x # to :: Rep GetIpamAddressHistoryResponse x -> GetIpamAddressHistoryResponse #
Read GetIpamAddressHistoryResponse Source #
Instance details Defined in Amazonka.EC2.GetIpamAddressHistory Methods readsPrec :: Int -> ReadS GetIpamAddressHistoryResponse # readList :: ReadS [GetIpamAddressHistoryResponse] # readPrec :: ReadPrec GetIpamAddressHistoryResponse # readListPrec :: ReadPrec [GetIpamAddressHistoryResponse] #
Show GetIpamAddressHistoryResponse Source #
Instance details Defined in Amazonka.EC2.GetIpamAddressHistory Methods showsPrec :: Int -> GetIpamAddressHistoryResponse -> ShowS # show :: GetIpamAddressHistoryResponse -> String # showList :: [GetIpamAddressHistoryResponse] -> ShowS #
NFData GetIpamAddressHistoryResponse Source #
Instance details Defined in Amazonka.EC2.GetIpamAddressHistory Methods rnf :: GetIpamAddressHistoryResponse -> () #
Eq GetIpamAddressHistoryResponse Source #
Instance details Defined in Amazonka.EC2.GetIpamAddressHistory Methods (==) :: GetIpamAddressHistoryResponse -> GetIpamAddressHistoryResponse -> Bool # (/=) :: GetIpamAddressHistoryResponse -> GetIpamAddressHistoryResponse -> Bool #
type Rep GetIpamAddressHistoryResponse Source #
Instance details Defined in Amazonka.EC2.GetIpamAddressHistory type Rep GetIpamAddressHistoryResponse = D1 ('MetaData "GetIpamAddressHistoryResponse" "Amazonka.EC2.GetIpamAddressHistory" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "GetIpamAddressHistoryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "historyRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IpamAddressHistoryRecord])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetIpamAddressHistoryResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetIpamAddressHistoryResponse'`
-> GetIpamAddressHistoryResponse

Create a value of GetIpamAddressHistoryResponse 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:historyRecords:GetIpamAddressHistoryResponse', getIpamAddressHistoryResponse_historyRecords - A historical record for a CIDR within an IPAM scope. If the CIDR is associated with an EC2 instance, you will see an object in the response for the instance and one for the network interface.

GetIpamAddressHistory, getIpamAddressHistoryResponse_nextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.

$sel:httpStatus:GetIpamAddressHistoryResponse', getIpamAddressHistoryResponse_httpStatus - The response's http status code.

Response Lenses

getIpamAddressHistoryResponse_historyRecords :: Lens' GetIpamAddressHistoryResponse (Maybe [IpamAddressHistoryRecord]) Source #

A historical record for a CIDR within an IPAM scope. If the CIDR is associated with an EC2 instance, you will see an object in the response for the instance and one for the network interface.

getIpamAddressHistoryResponse_nextToken :: Lens' GetIpamAddressHistoryResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

getIpamAddressHistoryResponse_httpStatus :: Lens' GetIpamAddressHistoryResponse Int Source #

The response's http status code.