Amazonka.FMS.ListComplianceStatus

Returns an array of PolicyComplianceStatus objects. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.

This operation returns paginated results.

Creating a Request

data ListComplianceStatus

See: newListComplianceStatus smart constructor.

Constructors

ListComplianceStatus'

Fields

• maxResults :: Maybe Natural

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

• nextToken :: Maybe Text

  If you specify a value for MaxResults and you have more PolicyComplianceStatus 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 PolicyComplianceStatus objects. For the second and subsequent ListComplianceStatus requests, specify the value of NextToken from the previous response to get information about another batch of PolicyComplianceStatus objects.

• policyId :: Text

  The ID of the Firewall Manager policy that you want the details for.

Instances

ToJSON ListComplianceStatus

Defined in Amazonka.FMS.ListComplianceStatus

Methods

toJSON :: ListComplianceStatus -> Value

toEncoding :: ListComplianceStatus -> Encoding

toJSONList :: [ListComplianceStatus] -> Value

toEncodingList :: [ListComplianceStatus] -> Encoding

ToHeaders ListComplianceStatus

Defined in Amazonka.FMS.ListComplianceStatus

Methods

toHeaders :: ListComplianceStatus -> [Header]

ToPath ListComplianceStatus

Defined in Amazonka.FMS.ListComplianceStatus

Methods

toPath :: ListComplianceStatus -> ByteString

ToQuery ListComplianceStatus

Defined in Amazonka.FMS.ListComplianceStatus

Methods

toQuery :: ListComplianceStatus -> QueryString

AWSPager ListComplianceStatus

Defined in Amazonka.FMS.ListComplianceStatus

Methods

page :: ListComplianceStatus -> AWSResponse ListComplianceStatus -> Maybe ListComplianceStatus

AWSRequest ListComplianceStatus

Defined in Amazonka.FMS.ListComplianceStatus

Associated Types

type AWSResponse ListComplianceStatus

Methods

request :: (Service -> Service) -> ListComplianceStatus -> Request ListComplianceStatus

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

Generic ListComplianceStatus

Defined in Amazonka.FMS.ListComplianceStatus

Associated Types

type Rep ListComplianceStatus :: Type -> Type

Methods

from :: ListComplianceStatus -> Rep ListComplianceStatus x

to :: Rep ListComplianceStatus x -> ListComplianceStatus

Read ListComplianceStatus

Defined in Amazonka.FMS.ListComplianceStatus

Methods

readsPrec :: Int -> ReadS ListComplianceStatus

readList :: ReadS [ListComplianceStatus]

readPrec :: ReadPrec ListComplianceStatus

readListPrec :: ReadPrec [ListComplianceStatus]

Show ListComplianceStatus

Defined in Amazonka.FMS.ListComplianceStatus

Methods

showsPrec :: Int -> ListComplianceStatus -> ShowS

show :: ListComplianceStatus -> String

showList :: [ListComplianceStatus] -> ShowS

NFData ListComplianceStatus

Defined in Amazonka.FMS.ListComplianceStatus

Methods

rnf :: ListComplianceStatus -> ()

Eq ListComplianceStatus

Defined in Amazonka.FMS.ListComplianceStatus

Methods

(==) :: ListComplianceStatus -> ListComplianceStatus -> Bool

(/=) :: ListComplianceStatus -> ListComplianceStatus -> Bool

Hashable ListComplianceStatus

Defined in Amazonka.FMS.ListComplianceStatus

Methods

hashWithSalt :: Int -> ListComplianceStatus -> Int

hash :: ListComplianceStatus -> Int

type AWSResponse ListComplianceStatus

Defined in Amazonka.FMS.ListComplianceStatus

type AWSResponse ListComplianceStatus = ListComplianceStatusResponse

type Rep ListComplianceStatus

Defined in Amazonka.FMS.ListComplianceStatus

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

newListComplianceStatus

Arguments

:: Text

ListComplianceStatus

-> ListComplianceStatus

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

ListComplianceStatus, listComplianceStatus_nextToken - If you specify a value for MaxResults and you have more PolicyComplianceStatus 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 PolicyComplianceStatus objects. For the second and subsequent ListComplianceStatus requests, specify the value of NextToken from the previous response to get information about another batch of PolicyComplianceStatus objects.

ListComplianceStatus, listComplianceStatus_policyId - The ID of the Firewall Manager policy that you want the details for.

Request Lenses

listComplianceStatus_maxResults :: Lens' ListComplianceStatus (Maybe Natural)

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

listComplianceStatus_nextToken :: Lens' ListComplianceStatus (Maybe Text)

If you specify a value for MaxResults and you have more PolicyComplianceStatus 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 PolicyComplianceStatus objects. For the second and subsequent ListComplianceStatus requests, specify the value of NextToken from the previous response to get information about another batch of PolicyComplianceStatus objects.

listComplianceStatus_policyId :: Lens' ListComplianceStatus Text

The ID of the Firewall Manager policy that you want the details for.

Destructuring the Response

data ListComplianceStatusResponse

See: newListComplianceStatusResponse smart constructor.

Constructors

ListComplianceStatusResponse'

Fields

• nextToken :: Maybe Text

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

• policyComplianceStatusList :: Maybe [PolicyComplianceStatus]

  An array of PolicyComplianceStatus objects.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListComplianceStatusResponse

Defined in Amazonka.FMS.ListComplianceStatus

Associated Types

type Rep ListComplianceStatusResponse :: Type -> Type

Methods

from :: ListComplianceStatusResponse -> Rep ListComplianceStatusResponse x

to :: Rep ListComplianceStatusResponse x -> ListComplianceStatusResponse

Read ListComplianceStatusResponse

Defined in Amazonka.FMS.ListComplianceStatus

Methods

readsPrec :: Int -> ReadS ListComplianceStatusResponse

readList :: ReadS [ListComplianceStatusResponse]

readPrec :: ReadPrec ListComplianceStatusResponse

readListPrec :: ReadPrec [ListComplianceStatusResponse]

Show ListComplianceStatusResponse

Defined in Amazonka.FMS.ListComplianceStatus

Methods

showsPrec :: Int -> ListComplianceStatusResponse -> ShowS

show :: ListComplianceStatusResponse -> String

showList :: [ListComplianceStatusResponse] -> ShowS

NFData ListComplianceStatusResponse

Defined in Amazonka.FMS.ListComplianceStatus

Methods

rnf :: ListComplianceStatusResponse -> ()

Eq ListComplianceStatusResponse

Defined in Amazonka.FMS.ListComplianceStatus

Methods

(==) :: ListComplianceStatusResponse -> ListComplianceStatusResponse -> Bool

(/=) :: ListComplianceStatusResponse -> ListComplianceStatusResponse -> Bool

type Rep ListComplianceStatusResponse

Defined in Amazonka.FMS.ListComplianceStatus

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

newListComplianceStatusResponse

Arguments

:: Int

$sel:httpStatus:ListComplianceStatusResponse'

-> ListComplianceStatusResponse

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

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

$sel:policyComplianceStatusList:ListComplianceStatusResponse', listComplianceStatusResponse_policyComplianceStatusList - An array of PolicyComplianceStatus objects.

$sel:httpStatus:ListComplianceStatusResponse', listComplianceStatusResponse_httpStatus - The response's http status code.

Response Lenses

listComplianceStatusResponse_nextToken :: Lens' ListComplianceStatusResponse (Maybe Text)

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

listComplianceStatusResponse_policyComplianceStatusList :: Lens' ListComplianceStatusResponse (Maybe [PolicyComplianceStatus])

An array of PolicyComplianceStatus objects.

listComplianceStatusResponse_httpStatus :: Lens' ListComplianceStatusResponse Int

The response's http status code.