amazonka-resource-explorer-v2-2.0: Amazon Resource Explorer 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.ResourceExplorer2.Types.ResourceCount

Description

 
Synopsis

Documentation

data ResourceCount Source #

Information about the number of results that match the query. At this time, Amazon Web Services Resource Explorer doesn't count more than 1,000 matches for any query. This structure provides information about whether the query exceeded this limit.

This field is included in every page when you paginate the results.

See: newResourceCount smart constructor.

Constructors

ResourceCount' 

Fields

  • complete :: Maybe Bool

    Indicates whether the TotalResources value represents an exhaustive count of search results.

    • If True, it indicates that the search was exhaustive. Every resource that matches the query was counted.
    • If False, then the search reached the limit of 1,000 matching results, and stopped counting.
  • totalResources :: Maybe Integer

    The number of resources that match the search query. This value can't exceed 1,000. If there are more than 1,000 resources that match the query, then only 1,000 are counted and the Complete field is set to false. We recommend that you refine your query to return a smaller number of results.

Instances

Instances details
FromJSON ResourceCount Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.Types.ResourceCount

Generic ResourceCount Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.Types.ResourceCount

Associated Types

type Rep ResourceCount :: Type -> Type #

Read ResourceCount Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.Types.ResourceCount

Show ResourceCount Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.Types.ResourceCount

NFData ResourceCount Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.Types.ResourceCount

Methods

rnf :: ResourceCount -> () #

Eq ResourceCount Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.Types.ResourceCount

Hashable ResourceCount Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.Types.ResourceCount

type Rep ResourceCount Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.Types.ResourceCount

type Rep ResourceCount = D1 ('MetaData "ResourceCount" "Amazonka.ResourceExplorer2.Types.ResourceCount" "amazonka-resource-explorer-v2-2.0-DYDynTzMYCcKX3QLWjH6Yt" 'False) (C1 ('MetaCons "ResourceCount'" 'PrefixI 'True) (S1 ('MetaSel ('Just "complete") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "totalResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))

newResourceCount :: ResourceCount Source #

Create a value of ResourceCount 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:complete:ResourceCount', resourceCount_complete - Indicates whether the TotalResources value represents an exhaustive count of search results.

  • If True, it indicates that the search was exhaustive. Every resource that matches the query was counted.
  • If False, then the search reached the limit of 1,000 matching results, and stopped counting.

$sel:totalResources:ResourceCount', resourceCount_totalResources - The number of resources that match the search query. This value can't exceed 1,000. If there are more than 1,000 resources that match the query, then only 1,000 are counted and the Complete field is set to false. We recommend that you refine your query to return a smaller number of results.

resourceCount_complete :: Lens' ResourceCount (Maybe Bool) Source #

Indicates whether the TotalResources value represents an exhaustive count of search results.

  • If True, it indicates that the search was exhaustive. Every resource that matches the query was counted.
  • If False, then the search reached the limit of 1,000 matching results, and stopped counting.

resourceCount_totalResources :: Lens' ResourceCount (Maybe Integer) Source #

The number of resources that match the search query. This value can't exceed 1,000. If there are more than 1,000 resources that match the query, then only 1,000 are counted and the Complete field is set to false. We recommend that you refine your query to return a smaller number of results.