Amazonka.ResourceExplorer2.ListIndexes

Retrieves a list of all of the indexes in Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer.

This operation returns paginated results.

Creating a Request

data ListIndexes

See: newListIndexes smart constructor.

Constructors

ListIndexes'

Fields

• maxResults :: Maybe Natural

  The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

  An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

• nextToken :: Maybe Text

  The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

• regions :: Maybe [Text]

  If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.

• type' :: Maybe IndexType

  If specified, limits the output to only indexes of the specified Type, either LOCAL or AGGREGATOR.

  Use this option to discover the aggregator index for your account.

Instances

ToJSON ListIndexes

Defined in Amazonka.ResourceExplorer2.ListIndexes

Methods

toJSON :: ListIndexes -> Value

toEncoding :: ListIndexes -> Encoding

toJSONList :: [ListIndexes] -> Value

toEncodingList :: [ListIndexes] -> Encoding

ToHeaders ListIndexes

Defined in Amazonka.ResourceExplorer2.ListIndexes

Methods

toHeaders :: ListIndexes -> [Header]

ToPath ListIndexes

Defined in Amazonka.ResourceExplorer2.ListIndexes

Methods

toPath :: ListIndexes -> ByteString

ToQuery ListIndexes

Defined in Amazonka.ResourceExplorer2.ListIndexes

Methods

toQuery :: ListIndexes -> QueryString

AWSPager ListIndexes

Defined in Amazonka.ResourceExplorer2.ListIndexes

Methods

page :: ListIndexes -> AWSResponse ListIndexes -> Maybe ListIndexes

AWSRequest ListIndexes

Defined in Amazonka.ResourceExplorer2.ListIndexes

Associated Types

type AWSResponse ListIndexes

Methods

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

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

Generic ListIndexes

Defined in Amazonka.ResourceExplorer2.ListIndexes

Associated Types

type Rep ListIndexes :: Type -> Type

Methods

from :: ListIndexes -> Rep ListIndexes x

to :: Rep ListIndexes x -> ListIndexes

Read ListIndexes

Defined in Amazonka.ResourceExplorer2.ListIndexes

Methods

readsPrec :: Int -> ReadS ListIndexes

readList :: ReadS [ListIndexes]

readPrec :: ReadPrec ListIndexes

readListPrec :: ReadPrec [ListIndexes]

Show ListIndexes

Defined in Amazonka.ResourceExplorer2.ListIndexes

Methods

showsPrec :: Int -> ListIndexes -> ShowS

show :: ListIndexes -> String

showList :: [ListIndexes] -> ShowS

NFData ListIndexes

Defined in Amazonka.ResourceExplorer2.ListIndexes

Methods

rnf :: ListIndexes -> ()

Eq ListIndexes

Defined in Amazonka.ResourceExplorer2.ListIndexes

Methods

(==) :: ListIndexes -> ListIndexes -> Bool

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

Hashable ListIndexes

Defined in Amazonka.ResourceExplorer2.ListIndexes

Methods

hashWithSalt :: Int -> ListIndexes -> Int

hash :: ListIndexes -> Int

type AWSResponse ListIndexes

Defined in Amazonka.ResourceExplorer2.ListIndexes

type AWSResponse ListIndexes = ListIndexesResponse

type Rep ListIndexes

Defined in Amazonka.ResourceExplorer2.ListIndexes

type Rep ListIndexes = D1 ('MetaData "ListIndexes" "Amazonka.ResourceExplorer2.ListIndexes" "amazonka-resource-explorer-v2-2.0-DYDynTzMYCcKX3QLWjH6Yt" 'False) (C1 ('MetaCons "ListIndexes'" '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 "regions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IndexType)))))

newListIndexes :: ListIndexes

Create a value of ListIndexes 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:ListIndexes', listIndexes_maxResults - The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

ListIndexes, listIndexes_nextToken - The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

$sel:regions:ListIndexes', listIndexes_regions - If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.

ListIndexes, listIndexes_type - If specified, limits the output to only indexes of the specified Type, either LOCAL or AGGREGATOR.

Use this option to discover the aggregator index for your account.

Request Lenses

listIndexes_maxResults :: Lens' ListIndexes (Maybe Natural)

The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

listIndexes_nextToken :: Lens' ListIndexes (Maybe Text)

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

listIndexes_regions :: Lens' ListIndexes (Maybe [Text])

If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.

listIndexes_type :: Lens' ListIndexes (Maybe IndexType)

If specified, limits the output to only indexes of the specified Type, either LOCAL or AGGREGATOR.

Use this option to discover the aggregator index for your account.

Destructuring the Response

data ListIndexesResponse

See: newListIndexesResponse smart constructor.

Constructors

ListIndexesResponse'

Fields

• indexes :: Maybe [Index]

  A structure that contains the details and status of each index.

• nextToken :: Maybe Text

  If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListIndexesResponse

Defined in Amazonka.ResourceExplorer2.ListIndexes

Associated Types

type Rep ListIndexesResponse :: Type -> Type

Methods

from :: ListIndexesResponse -> Rep ListIndexesResponse x

to :: Rep ListIndexesResponse x -> ListIndexesResponse

Read ListIndexesResponse

Defined in Amazonka.ResourceExplorer2.ListIndexes

Methods

readsPrec :: Int -> ReadS ListIndexesResponse

readList :: ReadS [ListIndexesResponse]

readPrec :: ReadPrec ListIndexesResponse

readListPrec :: ReadPrec [ListIndexesResponse]

Show ListIndexesResponse

Defined in Amazonka.ResourceExplorer2.ListIndexes

Methods

showsPrec :: Int -> ListIndexesResponse -> ShowS

show :: ListIndexesResponse -> String

showList :: [ListIndexesResponse] -> ShowS

NFData ListIndexesResponse

Defined in Amazonka.ResourceExplorer2.ListIndexes

Methods

rnf :: ListIndexesResponse -> ()

Eq ListIndexesResponse

Defined in Amazonka.ResourceExplorer2.ListIndexes

Methods

(==) :: ListIndexesResponse -> ListIndexesResponse -> Bool

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

type Rep ListIndexesResponse

Defined in Amazonka.ResourceExplorer2.ListIndexes

type Rep ListIndexesResponse = D1 ('MetaData "ListIndexesResponse" "Amazonka.ResourceExplorer2.ListIndexes" "amazonka-resource-explorer-v2-2.0-DYDynTzMYCcKX3QLWjH6Yt" 'False) (C1 ('MetaCons "ListIndexesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Index])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListIndexesResponse

Arguments

:: Int

$sel:httpStatus:ListIndexesResponse'

-> ListIndexesResponse

Create a value of ListIndexesResponse 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:indexes:ListIndexesResponse', listIndexesResponse_indexes - A structure that contains the details and status of each index.

ListIndexes, listIndexesResponse_nextToken - If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

$sel:httpStatus:ListIndexesResponse', listIndexesResponse_httpStatus - The response's http status code.

Response Lenses

listIndexesResponse_indexes :: Lens' ListIndexesResponse (Maybe [Index])

A structure that contains the details and status of each index.

listIndexesResponse_nextToken :: Lens' ListIndexesResponse (Maybe Text)

If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

listIndexesResponse_httpStatus :: Lens' ListIndexesResponse Int

The response's http status code.