libZSservicesZSamazonka-discoveryZSamazonka-discovery
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.Discovery.ListConfigurations

Description

Retrieves a list of configuration items as specified by the value passed to the required parameter configurationType. Optional filtering may be applied to refine search results.

This operation returns paginated results.

Synopsis

Creating a Request

data ListConfigurations Source #

See: newListConfigurations smart constructor.

Constructors

ListConfigurations' 

Fields

  • orderBy :: Maybe [OrderByElement]

    Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see Using the ListConfigurations Action in the AWS Application Discovery Service User Guide.

  • filters :: Maybe [Filter]

    You can filter the request using various logical operators and a key-value format. For example:

    {"key": "serverType", "value": "webServer"}

    For a complete list of filter options and guidance about using them with this action, see Using the ListConfigurations Action in the AWS Application Discovery Service User Guide.

  • nextToken :: Maybe Text

    Token to retrieve the next set of results. For example, if a previous call to ListConfigurations returned 100 items, but you set ListConfigurationsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

  • maxResults :: Maybe Int

    The total number of items to return. The maximum value is 100.

  • configurationType :: ConfigurationItemType

    A valid configuration identified by Application Discovery Service.

Instances

Instances details
Eq ListConfigurations Source # 
Instance details

Defined in Amazonka.Discovery.ListConfigurations

Read ListConfigurations Source # 
Instance details

Defined in Amazonka.Discovery.ListConfigurations

Show ListConfigurations Source # 
Instance details

Defined in Amazonka.Discovery.ListConfigurations

Generic ListConfigurations Source # 
Instance details

Defined in Amazonka.Discovery.ListConfigurations

Associated Types

type Rep ListConfigurations :: Type -> Type #

NFData ListConfigurations Source # 
Instance details

Defined in Amazonka.Discovery.ListConfigurations

Methods

rnf :: ListConfigurations -> () #

Hashable ListConfigurations Source # 
Instance details

Defined in Amazonka.Discovery.ListConfigurations

ToJSON ListConfigurations Source # 
Instance details

Defined in Amazonka.Discovery.ListConfigurations

AWSPager ListConfigurations Source # 
Instance details

Defined in Amazonka.Discovery.ListConfigurations

AWSRequest ListConfigurations Source # 
Instance details

Defined in Amazonka.Discovery.ListConfigurations

Associated Types

type AWSResponse ListConfigurations #

ToHeaders ListConfigurations Source # 
Instance details

Defined in Amazonka.Discovery.ListConfigurations

ToPath ListConfigurations Source # 
Instance details

Defined in Amazonka.Discovery.ListConfigurations

ToQuery ListConfigurations Source # 
Instance details

Defined in Amazonka.Discovery.ListConfigurations

type Rep ListConfigurations Source # 
Instance details

Defined in Amazonka.Discovery.ListConfigurations

type Rep ListConfigurations = D1 ('MetaData "ListConfigurations" "Amazonka.Discovery.ListConfigurations" "libZSservicesZSamazonka-discoveryZSamazonka-discovery" 'False) (C1 ('MetaCons "ListConfigurations'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "orderBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OrderByElement])) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "configurationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConfigurationItemType)))))
type AWSResponse ListConfigurations Source # 
Instance details

Defined in Amazonka.Discovery.ListConfigurations

newListConfigurations Source #

Create a value of ListConfigurations 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:orderBy:ListConfigurations', listConfigurations_orderBy - Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see Using the ListConfigurations Action in the AWS Application Discovery Service User Guide.

$sel:filters:ListConfigurations', listConfigurations_filters - You can filter the request using various logical operators and a key-value format. For example:

{"key": "serverType", "value": "webServer"}

For a complete list of filter options and guidance about using them with this action, see Using the ListConfigurations Action in the AWS Application Discovery Service User Guide.

$sel:nextToken:ListConfigurations', listConfigurations_nextToken - Token to retrieve the next set of results. For example, if a previous call to ListConfigurations returned 100 items, but you set ListConfigurationsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

$sel:maxResults:ListConfigurations', listConfigurations_maxResults - The total number of items to return. The maximum value is 100.

$sel:configurationType:ListConfigurations', listConfigurations_configurationType - A valid configuration identified by Application Discovery Service.

Request Lenses

listConfigurations_orderBy :: Lens' ListConfigurations (Maybe [OrderByElement]) Source #

Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see Using the ListConfigurations Action in the AWS Application Discovery Service User Guide.

listConfigurations_filters :: Lens' ListConfigurations (Maybe [Filter]) Source #

You can filter the request using various logical operators and a key-value format. For example:

{"key": "serverType", "value": "webServer"}

For a complete list of filter options and guidance about using them with this action, see Using the ListConfigurations Action in the AWS Application Discovery Service User Guide.

listConfigurations_nextToken :: Lens' ListConfigurations (Maybe Text) Source #

Token to retrieve the next set of results. For example, if a previous call to ListConfigurations returned 100 items, but you set ListConfigurationsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

listConfigurations_maxResults :: Lens' ListConfigurations (Maybe Int) Source #

The total number of items to return. The maximum value is 100.

listConfigurations_configurationType :: Lens' ListConfigurations ConfigurationItemType Source #

A valid configuration identified by Application Discovery Service.

Destructuring the Response

data ListConfigurationsResponse Source #

See: newListConfigurationsResponse smart constructor.

Constructors

ListConfigurationsResponse' 

Fields

  • configurations :: Maybe [HashMap Text Text]

    Returns configuration details, including the configuration ID, attribute names, and attribute values.

  • nextToken :: Maybe Text

    Token to retrieve the next set of results. For example, if your call to ListConfigurations returned 100 items, but you set ListConfigurationsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Discovery.ListConfigurations

Read ListConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Discovery.ListConfigurations

Show ListConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Discovery.ListConfigurations

Generic ListConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Discovery.ListConfigurations

Associated Types

type Rep ListConfigurationsResponse :: Type -> Type #

NFData ListConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Discovery.ListConfigurations

type Rep ListConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Discovery.ListConfigurations

type Rep ListConfigurationsResponse = D1 ('MetaData "ListConfigurationsResponse" "Amazonka.Discovery.ListConfigurations" "libZSservicesZSamazonka-discoveryZSamazonka-discovery" 'False) (C1 ('MetaCons "ListConfigurationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "configurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HashMap Text Text])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListConfigurationsResponse Source #

Create a value of ListConfigurationsResponse 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:configurations:ListConfigurationsResponse', listConfigurationsResponse_configurations - Returns configuration details, including the configuration ID, attribute names, and attribute values.

$sel:nextToken:ListConfigurations', listConfigurationsResponse_nextToken - Token to retrieve the next set of results. For example, if your call to ListConfigurations returned 100 items, but you set ListConfigurationsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.

$sel:httpStatus:ListConfigurationsResponse', listConfigurationsResponse_httpStatus - The response's http status code.

Response Lenses

listConfigurationsResponse_configurations :: Lens' ListConfigurationsResponse (Maybe [HashMap Text Text]) Source #

Returns configuration details, including the configuration ID, attribute names, and attribute values.

listConfigurationsResponse_nextToken :: Lens' ListConfigurationsResponse (Maybe Text) Source #

Token to retrieve the next set of results. For example, if your call to ListConfigurations returned 100 items, but you set ListConfigurationsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.