libZSservicesZSamazonka-fmsZSamazonka-fms
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.FMS.ListComplianceStatus

Description

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.

Synopsis

Creating a Request

data ListComplianceStatus Source #

See: newListComplianceStatus smart constructor.

Constructors

ListComplianceStatus' 

Fields

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

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

  • policyId :: Text

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

Instances

Instances details
Eq ListComplianceStatus Source # 
Instance details

Defined in Amazonka.FMS.ListComplianceStatus

Read ListComplianceStatus Source # 
Instance details

Defined in Amazonka.FMS.ListComplianceStatus

Show ListComplianceStatus Source # 
Instance details

Defined in Amazonka.FMS.ListComplianceStatus

Generic ListComplianceStatus Source # 
Instance details

Defined in Amazonka.FMS.ListComplianceStatus

Associated Types

type Rep ListComplianceStatus :: Type -> Type #

NFData ListComplianceStatus Source # 
Instance details

Defined in Amazonka.FMS.ListComplianceStatus

Methods

rnf :: ListComplianceStatus -> () #

Hashable ListComplianceStatus Source # 
Instance details

Defined in Amazonka.FMS.ListComplianceStatus

ToJSON ListComplianceStatus Source # 
Instance details

Defined in Amazonka.FMS.ListComplianceStatus

AWSPager ListComplianceStatus Source # 
Instance details

Defined in Amazonka.FMS.ListComplianceStatus

AWSRequest ListComplianceStatus Source # 
Instance details

Defined in Amazonka.FMS.ListComplianceStatus

Associated Types

type AWSResponse ListComplianceStatus #

ToHeaders ListComplianceStatus Source # 
Instance details

Defined in Amazonka.FMS.ListComplianceStatus

ToPath ListComplianceStatus Source # 
Instance details

Defined in Amazonka.FMS.ListComplianceStatus

ToQuery ListComplianceStatus Source # 
Instance details

Defined in Amazonka.FMS.ListComplianceStatus

type Rep ListComplianceStatus Source # 
Instance details

Defined in Amazonka.FMS.ListComplianceStatus

type Rep ListComplianceStatus = D1 ('MetaData "ListComplianceStatus" "Amazonka.FMS.ListComplianceStatus" "libZSservicesZSamazonka-fmsZSamazonka-fms" 'False) (C1 ('MetaCons "ListComplianceStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "policyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListComplianceStatus Source # 
Instance details

Defined in Amazonka.FMS.ListComplianceStatus

newListComplianceStatus Source #

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:nextToken: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.

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

$sel:policyId:ListComplianceStatus', listComplianceStatus_policyId - The ID of the Firewall Manager policy that you want the details for.

Request Lenses

listComplianceStatus_nextToken :: Lens' ListComplianceStatus (Maybe Text) Source #

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_maxResults :: Lens' ListComplianceStatus (Maybe Natural) Source #

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_policyId :: Lens' ListComplianceStatus Text Source #

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

Destructuring the Response

data ListComplianceStatusResponse Source #

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

Instances details
Eq ListComplianceStatusResponse Source # 
Instance details

Defined in Amazonka.FMS.ListComplianceStatus

Read ListComplianceStatusResponse Source # 
Instance details

Defined in Amazonka.FMS.ListComplianceStatus

Show ListComplianceStatusResponse Source # 
Instance details

Defined in Amazonka.FMS.ListComplianceStatus

Generic ListComplianceStatusResponse Source # 
Instance details

Defined in Amazonka.FMS.ListComplianceStatus

Associated Types

type Rep ListComplianceStatusResponse :: Type -> Type #

NFData ListComplianceStatusResponse Source # 
Instance details

Defined in Amazonka.FMS.ListComplianceStatus

type Rep ListComplianceStatusResponse Source # 
Instance details

Defined in Amazonka.FMS.ListComplianceStatus

type Rep ListComplianceStatusResponse = D1 ('MetaData "ListComplianceStatusResponse" "Amazonka.FMS.ListComplianceStatus" "libZSservicesZSamazonka-fmsZSamazonka-fms" '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 Source #

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:

$sel:nextToken: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) Source #

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.