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.DirectoryService.ListIpRoutes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the address blocks that you have added to a directory.

This operation returns paginated results.

Creating a Request

data ListIpRoutes Source #

See: newListIpRoutes smart constructor.

Constructors

ListIpRoutes'

Fields

limit :: Maybe Natural
Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.
nextToken :: Maybe Text
The ListIpRoutes.NextToken value from a previous call to ListIpRoutes. Pass null if this is the first call.
directoryId :: Text
Identifier (ID) of the directory for which you want to retrieve the IP addresses.

Instances

Instances details

ToJSON ListIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.ListIpRoutes Methods toJSON :: ListIpRoutes -> Value # toEncoding :: ListIpRoutes -> Encoding # toJSONList :: [ListIpRoutes] -> Value # toEncodingList :: [ListIpRoutes] -> Encoding #
ToHeaders ListIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.ListIpRoutes Methods toHeaders :: ListIpRoutes -> [Header] #
ToPath ListIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.ListIpRoutes Methods toPath :: ListIpRoutes -> ByteString #
ToQuery ListIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.ListIpRoutes Methods toQuery :: ListIpRoutes -> QueryString #
AWSPager ListIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.ListIpRoutes Methods page :: ListIpRoutes -> AWSResponse ListIpRoutes -> Maybe ListIpRoutes #
AWSRequest ListIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.ListIpRoutes Associated Types type AWSResponse ListIpRoutes # Methods request :: (Service -> Service) -> ListIpRoutes -> Request ListIpRoutes # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListIpRoutes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListIpRoutes))) #
Generic ListIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.ListIpRoutes Associated Types type Rep ListIpRoutes :: Type -> Type # Methods from :: ListIpRoutes -> Rep ListIpRoutes x # to :: Rep ListIpRoutes x -> ListIpRoutes #
Read ListIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.ListIpRoutes Methods readsPrec :: Int -> ReadS ListIpRoutes # readList :: ReadS [ListIpRoutes] # readPrec :: ReadPrec ListIpRoutes # readListPrec :: ReadPrec [ListIpRoutes] #
Show ListIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.ListIpRoutes Methods showsPrec :: Int -> ListIpRoutes -> ShowS # show :: ListIpRoutes -> String # showList :: [ListIpRoutes] -> ShowS #
NFData ListIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.ListIpRoutes Methods rnf :: ListIpRoutes -> () #
Eq ListIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.ListIpRoutes Methods (==) :: ListIpRoutes -> ListIpRoutes -> Bool # (/=) :: ListIpRoutes -> ListIpRoutes -> Bool #
Hashable ListIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.ListIpRoutes Methods hashWithSalt :: Int -> ListIpRoutes -> Int # hash :: ListIpRoutes -> Int #
type AWSResponse ListIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.ListIpRoutes type AWSResponse ListIpRoutes = ListIpRoutesResponse
type Rep ListIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.ListIpRoutes type Rep ListIpRoutes = D1 ('MetaData "ListIpRoutes" "Amazonka.DirectoryService.ListIpRoutes" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" 'False) (C1 ('MetaCons "ListIpRoutes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListIpRoutes Source #

Arguments

:: Text	`ListIpRoutes`
-> ListIpRoutes

Create a value of ListIpRoutes 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:limit:ListIpRoutes', listIpRoutes_limit - Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

ListIpRoutes, listIpRoutes_nextToken - The ListIpRoutes.NextToken value from a previous call to ListIpRoutes. Pass null if this is the first call.

ListIpRoutes, listIpRoutes_directoryId - Identifier (ID) of the directory for which you want to retrieve the IP addresses.

Request Lenses

listIpRoutes_limit :: Lens' ListIpRoutes (Maybe Natural) Source #

Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

listIpRoutes_nextToken :: Lens' ListIpRoutes (Maybe Text) Source #

The ListIpRoutes.NextToken value from a previous call to ListIpRoutes. Pass null if this is the first call.

listIpRoutes_directoryId :: Lens' ListIpRoutes Text Source #

Identifier (ID) of the directory for which you want to retrieve the IP addresses.

Destructuring the Response

data ListIpRoutesResponse Source #

See: newListIpRoutesResponse smart constructor.

Constructors

ListIpRoutesResponse'
Fields ipRoutesInfo :: Maybe [IpRouteInfo] A list of IpRoutes. nextToken :: Maybe Text If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListIpRoutes to retrieve the next set of items. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListIpRoutesResponse Source #

Arguments

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

Create a value of ListIpRoutesResponse 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:ipRoutesInfo:ListIpRoutesResponse', listIpRoutesResponse_ipRoutesInfo - A list of IpRoutes.

ListIpRoutes, listIpRoutesResponse_nextToken - If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListIpRoutes to retrieve the next set of items.

$sel:httpStatus:ListIpRoutesResponse', listIpRoutesResponse_httpStatus - The response's http status code.

Response Lenses

listIpRoutesResponse_ipRoutesInfo :: Lens' ListIpRoutesResponse (Maybe [IpRouteInfo]) Source #

A list of IpRoutes.

listIpRoutesResponse_nextToken :: Lens' ListIpRoutesResponse (Maybe Text) Source #

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListIpRoutes to retrieve the next set of items.

listIpRoutesResponse_httpStatus :: Lens' ListIpRoutesResponse Int Source #

The response's http status code.