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

Description

Returns an array of PolicySummary objects.

This operation returns paginated results.

Synopsis

Creating a Request

data ListPolicies Source #

See: newListPolicies smart constructor.

Constructors

ListPolicies' 

Fields

  • maxResults :: Maybe Natural

    Specifies the number of PolicySummary objects that you want Firewall Manager to return for this request. If you have more PolicySummary objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of PolicySummary objects.

  • nextToken :: Maybe Text

    If you specify a value for MaxResults and you have more PolicySummary objects than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response that allows you to list another group of PolicySummary objects. For the second and subsequent ListPolicies requests, specify the value of NextToken from the previous response to get information about another batch of PolicySummary objects.

Instances

Instances details
ToJSON ListPolicies Source # 
Instance details

Defined in Amazonka.FMS.ListPolicies

Methods

toJSON :: ListPolicies -> Value #

toEncoding :: ListPolicies -> Encoding #

toJSONList :: [ListPolicies] -> Value #

toEncodingList :: [ListPolicies] -> Encoding #

ToHeaders ListPolicies Source # 
Instance details

Defined in Amazonka.FMS.ListPolicies

Methods

toHeaders :: ListPolicies -> [Header] #

ToPath ListPolicies Source # 
Instance details

Defined in Amazonka.FMS.ListPolicies

Methods

toPath :: ListPolicies -> ByteString #

ToQuery ListPolicies Source # 
Instance details

Defined in Amazonka.FMS.ListPolicies

Methods

toQuery :: ListPolicies -> QueryString #

AWSPager ListPolicies Source # 
Instance details

Defined in Amazonka.FMS.ListPolicies

Methods

page :: ListPolicies -> AWSResponse ListPolicies -> Maybe ListPolicies #

AWSRequest ListPolicies Source # 
Instance details

Defined in Amazonka.FMS.ListPolicies

Associated Types

type AWSResponse ListPolicies #

Methods

request :: (Service -> Service) -> ListPolicies -> Request ListPolicies #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListPolicies -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListPolicies))) #

Generic ListPolicies Source # 
Instance details

Defined in Amazonka.FMS.ListPolicies

Associated Types

type Rep ListPolicies :: Type -> Type #

Methods

from :: ListPolicies -> Rep ListPolicies x #

to :: Rep ListPolicies x -> ListPolicies #

Read ListPolicies Source # 
Instance details

Defined in Amazonka.FMS.ListPolicies

Methods

readsPrec :: Int -> ReadS ListPolicies #

readList :: ReadS [ListPolicies] #

readPrec :: ReadPrec ListPolicies #

readListPrec :: ReadPrec [ListPolicies] #

Show ListPolicies Source # 
Instance details

Defined in Amazonka.FMS.ListPolicies

Methods

showsPrec :: Int -> ListPolicies -> ShowS #

show :: ListPolicies -> String #

showList :: [ListPolicies] -> ShowS #

NFData ListPolicies Source # 
Instance details

Defined in Amazonka.FMS.ListPolicies

Methods

rnf :: ListPolicies -> () #

Eq ListPolicies Source # 
Instance details

Defined in Amazonka.FMS.ListPolicies

Methods

(==) :: ListPolicies -> ListPolicies -> Bool #

(/=) :: ListPolicies -> ListPolicies -> Bool #

Hashable ListPolicies Source # 
Instance details

Defined in Amazonka.FMS.ListPolicies

Methods

hashWithSalt :: Int -> ListPolicies -> Int #

hash :: ListPolicies -> Int #

type AWSResponse ListPolicies Source # 
Instance details

Defined in Amazonka.FMS.ListPolicies

type AWSResponse ListPolicies = ListPoliciesResponse
type Rep ListPolicies Source # 
Instance details

Defined in Amazonka.FMS.ListPolicies

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

newListPolicies :: ListPolicies Source #

Create a value of ListPolicies 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:maxResults:ListPolicies', listPolicies_maxResults - Specifies the number of PolicySummary objects that you want Firewall Manager to return for this request. If you have more PolicySummary objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of PolicySummary objects.

ListPolicies, listPolicies_nextToken - If you specify a value for MaxResults and you have more PolicySummary objects than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response that allows you to list another group of PolicySummary objects. For the second and subsequent ListPolicies requests, specify the value of NextToken from the previous response to get information about another batch of PolicySummary objects.

Request Lenses

listPolicies_maxResults :: Lens' ListPolicies (Maybe Natural) Source #

Specifies the number of PolicySummary objects that you want Firewall Manager to return for this request. If you have more PolicySummary objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of PolicySummary objects.

listPolicies_nextToken :: Lens' ListPolicies (Maybe Text) Source #

If you specify a value for MaxResults and you have more PolicySummary objects than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response that allows you to list another group of PolicySummary objects. For the second and subsequent ListPolicies requests, specify the value of NextToken from the previous response to get information about another batch of PolicySummary objects.

Destructuring the Response

data ListPoliciesResponse Source #

See: newListPoliciesResponse smart constructor.

Constructors

ListPoliciesResponse' 

Fields

  • nextToken :: Maybe Text

    If you have more PolicySummary objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more PolicySummary objects, submit another ListPolicies request, and specify the NextToken value from the response in the NextToken value in the next request.

  • policyList :: Maybe [PolicySummary]

    An array of PolicySummary objects.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListPoliciesResponse Source # 
Instance details

Defined in Amazonka.FMS.ListPolicies

Associated Types

type Rep ListPoliciesResponse :: Type -> Type #

Methods

from :: ListPoliciesResponse -> Rep ListPoliciesResponse x #

to :: Rep ListPoliciesResponse x -> ListPoliciesResponse #

Read ListPoliciesResponse Source # 
Instance details

Defined in Amazonka.FMS.ListPolicies

Methods

readsPrec :: Int -> ReadS ListPoliciesResponse #

readList :: ReadS [ListPoliciesResponse] #

readPrec :: ReadPrec ListPoliciesResponse #

readListPrec :: ReadPrec [ListPoliciesResponse] #

Show ListPoliciesResponse Source # 
Instance details

Defined in Amazonka.FMS.ListPolicies

Methods

showsPrec :: Int -> ListPoliciesResponse -> ShowS #

show :: ListPoliciesResponse -> String #

showList :: [ListPoliciesResponse] -> ShowS #

NFData ListPoliciesResponse Source # 
Instance details

Defined in Amazonka.FMS.ListPolicies

Methods

rnf :: ListPoliciesResponse -> () #

Eq ListPoliciesResponse Source # 
Instance details

Defined in Amazonka.FMS.ListPolicies

Methods

(==) :: ListPoliciesResponse -> ListPoliciesResponse -> Bool #

(/=) :: ListPoliciesResponse -> ListPoliciesResponse -> Bool #

type Rep ListPoliciesResponse Source # 
Instance details

Defined in Amazonka.FMS.ListPolicies

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

newListPoliciesResponse Source #

Arguments

:: Int

$sel:httpStatus:ListPoliciesResponse'

-> ListPoliciesResponse 

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

ListPolicies, listPoliciesResponse_nextToken - If you have more PolicySummary objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more PolicySummary objects, submit another ListPolicies request, and specify the NextToken value from the response in the NextToken value in the next request.

$sel:policyList:ListPoliciesResponse', listPoliciesResponse_policyList - An array of PolicySummary objects.

$sel:httpStatus:ListPoliciesResponse', listPoliciesResponse_httpStatus - The response's http status code.

Response Lenses

listPoliciesResponse_nextToken :: Lens' ListPoliciesResponse (Maybe Text) Source #

If you have more PolicySummary objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more PolicySummary objects, submit another ListPolicies request, and specify the NextToken value from the response in the NextToken value in the next request.

listPoliciesResponse_policyList :: Lens' ListPoliciesResponse (Maybe [PolicySummary]) Source #

An array of PolicySummary objects.

listPoliciesResponse_httpStatus :: Lens' ListPoliciesResponse Int Source #

The response's http status code.