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

Description

Returns an array of resources in the organization's accounts that are available to be associated with a resource set.

Synopsis

Creating a Request

data ListDiscoveredResources Source #

See: newListDiscoveredResources smart constructor.

Constructors

ListDiscoveredResources' 

Fields

  • maxResults :: Maybe 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.

  • nextToken :: Maybe Text

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

  • memberAccountIds :: [Text]

    The Amazon Web Services account IDs to discover resources in. Only one account is supported per request. The account must be a member of your organization.

  • resourceType :: Text

    The type of resources to discover.

Instances

Instances details
ToJSON ListDiscoveredResources Source # 
Instance details

Defined in Amazonka.FMS.ListDiscoveredResources

ToHeaders ListDiscoveredResources Source # 
Instance details

Defined in Amazonka.FMS.ListDiscoveredResources

ToPath ListDiscoveredResources Source # 
Instance details

Defined in Amazonka.FMS.ListDiscoveredResources

ToQuery ListDiscoveredResources Source # 
Instance details

Defined in Amazonka.FMS.ListDiscoveredResources

AWSRequest ListDiscoveredResources Source # 
Instance details

Defined in Amazonka.FMS.ListDiscoveredResources

Generic ListDiscoveredResources Source # 
Instance details

Defined in Amazonka.FMS.ListDiscoveredResources

Associated Types

type Rep ListDiscoveredResources :: Type -> Type #

Read ListDiscoveredResources Source # 
Instance details

Defined in Amazonka.FMS.ListDiscoveredResources

Show ListDiscoveredResources Source # 
Instance details

Defined in Amazonka.FMS.ListDiscoveredResources

NFData ListDiscoveredResources Source # 
Instance details

Defined in Amazonka.FMS.ListDiscoveredResources

Methods

rnf :: ListDiscoveredResources -> () #

Eq ListDiscoveredResources Source # 
Instance details

Defined in Amazonka.FMS.ListDiscoveredResources

Hashable ListDiscoveredResources Source # 
Instance details

Defined in Amazonka.FMS.ListDiscoveredResources

type AWSResponse ListDiscoveredResources Source # 
Instance details

Defined in Amazonka.FMS.ListDiscoveredResources

type Rep ListDiscoveredResources Source # 
Instance details

Defined in Amazonka.FMS.ListDiscoveredResources

type Rep ListDiscoveredResources = D1 ('MetaData "ListDiscoveredResources" "Amazonka.FMS.ListDiscoveredResources" "amazonka-fms-2.0-351knTjuYAjE9GRQTo0ohx" 'False) (C1 ('MetaCons "ListDiscoveredResources'" '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 "memberAccountIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListDiscoveredResources Source #

Create a value of ListDiscoveredResources 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:ListDiscoveredResources', listDiscoveredResources_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.

ListDiscoveredResources, listDiscoveredResources_nextToken - When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

$sel:memberAccountIds:ListDiscoveredResources', listDiscoveredResources_memberAccountIds - The Amazon Web Services account IDs to discover resources in. Only one account is supported per request. The account must be a member of your organization.

ListDiscoveredResources, listDiscoveredResources_resourceType - The type of resources to discover.

Request Lenses

listDiscoveredResources_maxResults :: Lens' ListDiscoveredResources (Maybe 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.

listDiscoveredResources_nextToken :: Lens' ListDiscoveredResources (Maybe Text) Source #

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

listDiscoveredResources_memberAccountIds :: Lens' ListDiscoveredResources [Text] Source #

The Amazon Web Services account IDs to discover resources in. Only one account is supported per request. The account must be a member of your organization.

Destructuring the Response

data ListDiscoveredResourcesResponse Source #

See: newListDiscoveredResourcesResponse smart constructor.

Constructors

ListDiscoveredResourcesResponse' 

Fields

  • items :: Maybe [DiscoveredResource]

    Details of the resources that were discovered.

  • nextToken :: Maybe Text

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListDiscoveredResourcesResponse Source # 
Instance details

Defined in Amazonka.FMS.ListDiscoveredResources

Associated Types

type Rep ListDiscoveredResourcesResponse :: Type -> Type #

Read ListDiscoveredResourcesResponse Source # 
Instance details

Defined in Amazonka.FMS.ListDiscoveredResources

Show ListDiscoveredResourcesResponse Source # 
Instance details

Defined in Amazonka.FMS.ListDiscoveredResources

NFData ListDiscoveredResourcesResponse Source # 
Instance details

Defined in Amazonka.FMS.ListDiscoveredResources

Eq ListDiscoveredResourcesResponse Source # 
Instance details

Defined in Amazonka.FMS.ListDiscoveredResources

type Rep ListDiscoveredResourcesResponse Source # 
Instance details

Defined in Amazonka.FMS.ListDiscoveredResources

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

newListDiscoveredResourcesResponse Source #

Create a value of ListDiscoveredResourcesResponse 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:items:ListDiscoveredResourcesResponse', listDiscoveredResourcesResponse_items - Details of the resources that were discovered.

ListDiscoveredResources, listDiscoveredResourcesResponse_nextToken - When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

$sel:httpStatus:ListDiscoveredResourcesResponse', listDiscoveredResourcesResponse_httpStatus - The response's http status code.

Response Lenses

listDiscoveredResourcesResponse_nextToken :: Lens' ListDiscoveredResourcesResponse (Maybe Text) Source #

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.