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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes available Amazon Web Services services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service.

We recommend that you use DescribeManagedPrefixLists instead.

This operation returns paginated results.

Synopsis

data DescribePrefixLists = DescribePrefixLists' {
- dryRun :: Maybe Bool
- filters :: Maybe [Filter]
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- prefixListIds :: Maybe [Text]
}
newDescribePrefixLists :: DescribePrefixLists
describePrefixLists_dryRun :: Lens' DescribePrefixLists (Maybe Bool)
describePrefixLists_filters :: Lens' DescribePrefixLists (Maybe [Filter])
describePrefixLists_maxResults :: Lens' DescribePrefixLists (Maybe Int)
describePrefixLists_nextToken :: Lens' DescribePrefixLists (Maybe Text)
describePrefixLists_prefixListIds :: Lens' DescribePrefixLists (Maybe [Text])
data DescribePrefixListsResponse = DescribePrefixListsResponse' {
- nextToken :: Maybe Text
- prefixLists :: Maybe [PrefixList]
- httpStatus :: Int
}
newDescribePrefixListsResponse :: Int -> DescribePrefixListsResponse
describePrefixListsResponse_nextToken :: Lens' DescribePrefixListsResponse (Maybe Text)
describePrefixListsResponse_prefixLists :: Lens' DescribePrefixListsResponse (Maybe [PrefixList])
describePrefixListsResponse_httpStatus :: Lens' DescribePrefixListsResponse Int

Creating a Request

data DescribePrefixLists Source #

See: newDescribePrefixLists smart constructor.

Constructors

DescribePrefixLists'

Fields

dryRun :: Maybe Bool
Checks 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.
filters :: Maybe [Filter]
One or more filters.
- prefix-list-id: The ID of a prefix list.
- prefix-list-name: The name of a prefix list.
maxResults :: Maybe Int
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
nextToken :: Maybe Text
The token for the next page of results.
prefixListIds :: Maybe [Text]
One or more prefix list IDs.

Instances

Instances details

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

newDescribePrefixLists :: DescribePrefixLists Source #

Create a value of DescribePrefixLists 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:DescribePrefixLists', describePrefixLists_dryRun - Checks 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.

$sel:filters:DescribePrefixLists', describePrefixLists_filters - One or more filters.

prefix-list-id: The ID of a prefix list.
prefix-list-name: The name of a prefix list.

$sel:maxResults:DescribePrefixLists', describePrefixLists_maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

DescribePrefixLists, describePrefixLists_nextToken - The token for the next page of results.

DescribePrefixLists, describePrefixLists_prefixListIds - One or more prefix list IDs.

Request Lenses

describePrefixLists_dryRun :: Lens' DescribePrefixLists (Maybe Bool) Source #

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

describePrefixLists_filters :: Lens' DescribePrefixLists (Maybe [Filter]) Source #

One or more filters.

prefix-list-id: The ID of a prefix list.
prefix-list-name: The name of a prefix list.

describePrefixLists_maxResults :: Lens' DescribePrefixLists (Maybe Int) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

describePrefixLists_nextToken :: Lens' DescribePrefixLists (Maybe Text) Source #

The token for the next page of results.

describePrefixLists_prefixListIds :: Lens' DescribePrefixLists (Maybe [Text]) Source #

One or more prefix list IDs.

Destructuring the Response

data DescribePrefixListsResponse Source #

See: newDescribePrefixListsResponse smart constructor.

Constructors

DescribePrefixListsResponse'
Fields 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. prefixLists :: Maybe [PrefixList] All available prefix lists. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribePrefixListsResponse Source #

Arguments

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

Create a value of DescribePrefixListsResponse 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:

DescribePrefixLists, describePrefixListsResponse_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:prefixLists:DescribePrefixListsResponse', describePrefixListsResponse_prefixLists - All available prefix lists.

$sel:httpStatus:DescribePrefixListsResponse', describePrefixListsResponse_httpStatus - The response's http status code.

Response Lenses

describePrefixListsResponse_nextToken :: Lens' DescribePrefixListsResponse (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.

describePrefixListsResponse_prefixLists :: Lens' DescribePrefixListsResponse (Maybe [PrefixList]) Source #

All available prefix lists.

describePrefixListsResponse_httpStatus :: Lens' DescribePrefixListsResponse Int Source #

The response's http status code.