amazonka-fms-2.0: Amazon Firewall Management Service 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.FMS.ListProtocolsLists

Description

Returns an array of ProtocolsListDataSummary objects.

This operation returns paginated results.

Synopsis

Creating a Request

data ListProtocolsLists Source #

See: newListProtocolsLists smart constructor.

Constructors

ListProtocolsLists' 

Fields

  • defaultLists :: Maybe Bool

    Specifies whether the lists to retrieve are default lists owned by Firewall Manager.

  • nextToken :: Maybe Text

    If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request in the request parameters, to retrieve the next batch of objects.

  • maxResults :: Natural

    The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

    If you don't specify this, Firewall Manager returns all available objects.

Instances

Instances details
ToJSON ListProtocolsLists Source # 
Instance details

Defined in Amazonka.FMS.ListProtocolsLists

ToHeaders ListProtocolsLists Source # 
Instance details

Defined in Amazonka.FMS.ListProtocolsLists

ToPath ListProtocolsLists Source # 
Instance details

Defined in Amazonka.FMS.ListProtocolsLists

ToQuery ListProtocolsLists Source # 
Instance details

Defined in Amazonka.FMS.ListProtocolsLists

AWSPager ListProtocolsLists Source # 
Instance details

Defined in Amazonka.FMS.ListProtocolsLists

AWSRequest ListProtocolsLists Source # 
Instance details

Defined in Amazonka.FMS.ListProtocolsLists

Associated Types

type AWSResponse ListProtocolsLists #

Generic ListProtocolsLists Source # 
Instance details

Defined in Amazonka.FMS.ListProtocolsLists

Associated Types

type Rep ListProtocolsLists :: Type -> Type #

Read ListProtocolsLists Source # 
Instance details

Defined in Amazonka.FMS.ListProtocolsLists

Show ListProtocolsLists Source # 
Instance details

Defined in Amazonka.FMS.ListProtocolsLists

NFData ListProtocolsLists Source # 
Instance details

Defined in Amazonka.FMS.ListProtocolsLists

Methods

rnf :: ListProtocolsLists -> () #

Eq ListProtocolsLists Source # 
Instance details

Defined in Amazonka.FMS.ListProtocolsLists

Hashable ListProtocolsLists Source # 
Instance details

Defined in Amazonka.FMS.ListProtocolsLists

type AWSResponse ListProtocolsLists Source # 
Instance details

Defined in Amazonka.FMS.ListProtocolsLists

type Rep ListProtocolsLists Source # 
Instance details

Defined in Amazonka.FMS.ListProtocolsLists

type Rep ListProtocolsLists = D1 ('MetaData "ListProtocolsLists" "Amazonka.FMS.ListProtocolsLists" "amazonka-fms-2.0-351knTjuYAjE9GRQTo0ohx" 'False) (C1 ('MetaCons "ListProtocolsLists'" 'PrefixI 'True) (S1 ('MetaSel ('Just "defaultLists") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))))

newListProtocolsLists Source #

Create a value of ListProtocolsLists 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:defaultLists:ListProtocolsLists', listProtocolsLists_defaultLists - Specifies whether the lists to retrieve are default lists owned by Firewall Manager.

ListProtocolsLists, listProtocolsLists_nextToken - If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request in the request parameters, to retrieve the next batch of objects.

$sel:maxResults:ListProtocolsLists', listProtocolsLists_maxResults - The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don't specify this, Firewall Manager returns all available objects.

Request Lenses

listProtocolsLists_defaultLists :: Lens' ListProtocolsLists (Maybe Bool) Source #

Specifies whether the lists to retrieve are default lists owned by Firewall Manager.

listProtocolsLists_nextToken :: Lens' ListProtocolsLists (Maybe Text) Source #

If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request in the request parameters, to retrieve the next batch of objects.

listProtocolsLists_maxResults :: Lens' ListProtocolsLists Natural Source #

The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don't specify this, Firewall Manager returns all available objects.

Destructuring the Response

data ListProtocolsListsResponse Source #

See: newListProtocolsListsResponse smart constructor.

Constructors

ListProtocolsListsResponse' 

Fields

  • nextToken :: Maybe Text

    If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. You can use this token in subsequent requests to retrieve the next batch of objects.

  • protocolsLists :: Maybe [ProtocolsListDataSummary]

    An array of ProtocolsListDataSummary objects.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListProtocolsListsResponse Source # 
Instance details

Defined in Amazonka.FMS.ListProtocolsLists

Associated Types

type Rep ListProtocolsListsResponse :: Type -> Type #

Read ListProtocolsListsResponse Source # 
Instance details

Defined in Amazonka.FMS.ListProtocolsLists

Show ListProtocolsListsResponse Source # 
Instance details

Defined in Amazonka.FMS.ListProtocolsLists

NFData ListProtocolsListsResponse Source # 
Instance details

Defined in Amazonka.FMS.ListProtocolsLists

Eq ListProtocolsListsResponse Source # 
Instance details

Defined in Amazonka.FMS.ListProtocolsLists

type Rep ListProtocolsListsResponse Source # 
Instance details

Defined in Amazonka.FMS.ListProtocolsLists

type Rep ListProtocolsListsResponse = D1 ('MetaData "ListProtocolsListsResponse" "Amazonka.FMS.ListProtocolsLists" "amazonka-fms-2.0-351knTjuYAjE9GRQTo0ohx" 'False) (C1 ('MetaCons "ListProtocolsListsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "protocolsLists") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProtocolsListDataSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListProtocolsListsResponse Source #

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

ListProtocolsLists, listProtocolsListsResponse_nextToken - If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. You can use this token in subsequent requests to retrieve the next batch of objects.

$sel:protocolsLists:ListProtocolsListsResponse', listProtocolsListsResponse_protocolsLists - An array of ProtocolsListDataSummary objects.

$sel:httpStatus:ListProtocolsListsResponse', listProtocolsListsResponse_httpStatus - The response's http status code.

Response Lenses

listProtocolsListsResponse_nextToken :: Lens' ListProtocolsListsResponse (Maybe Text) Source #

If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. You can use this token in subsequent requests to retrieve the next batch of objects.