Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Discovery.ListConfigurations

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

data ListConfigurations = ListConfigurations' {
- filters :: Maybe [Filter]
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- orderBy :: Maybe [OrderByElement]
- configurationType :: ConfigurationItemType
}
newListConfigurations :: ConfigurationItemType -> ListConfigurations
listConfigurations_filters :: Lens' ListConfigurations (Maybe [Filter])
listConfigurations_maxResults :: Lens' ListConfigurations (Maybe Int)
listConfigurations_nextToken :: Lens' ListConfigurations (Maybe Text)
listConfigurations_orderBy :: Lens' ListConfigurations (Maybe [OrderByElement])
listConfigurations_configurationType :: Lens' ListConfigurations ConfigurationItemType
data ListConfigurationsResponse = ListConfigurationsResponse' {
- configurations :: Maybe [HashMap Text Text]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListConfigurationsResponse :: Int -> ListConfigurationsResponse
listConfigurationsResponse_configurations :: Lens' ListConfigurationsResponse (Maybe [HashMap Text Text])
listConfigurationsResponse_nextToken :: Lens' ListConfigurationsResponse (Maybe Text)
listConfigurationsResponse_httpStatus :: Lens' ListConfigurationsResponse Int

Creating a Request

data ListConfigurations Source #

See: newListConfigurations smart constructor.

Constructors

ListConfigurations'

Fields

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 Amazon Web Services Application Discovery Service User Guide.
maxResults :: Maybe Int
The total number of items to return. The maximum value is 100.
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.
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 Amazon Web Services Application Discovery Service User Guide.
configurationType :: ConfigurationItemType
A valid configuration identified by Application Discovery Service.

Instances

Instances details

ToJSON ListConfigurations Source #
Instance details Defined in Amazonka.Discovery.ListConfigurations Methods toJSON :: ListConfigurations -> Value # toEncoding :: ListConfigurations -> Encoding # toJSONList :: [ListConfigurations] -> Value # toEncodingList :: [ListConfigurations] -> Encoding #
ToHeaders ListConfigurations Source #
Instance details Defined in Amazonka.Discovery.ListConfigurations Methods toHeaders :: ListConfigurations -> [Header] #
ToPath ListConfigurations Source #
Instance details Defined in Amazonka.Discovery.ListConfigurations Methods toPath :: ListConfigurations -> ByteString #
ToQuery ListConfigurations Source #
Instance details Defined in Amazonka.Discovery.ListConfigurations Methods toQuery :: ListConfigurations -> QueryString #
AWSPager ListConfigurations Source #
Instance details Defined in Amazonka.Discovery.ListConfigurations Methods page :: ListConfigurations -> AWSResponse ListConfigurations -> Maybe ListConfigurations #
AWSRequest ListConfigurations Source #
Instance details Defined in Amazonka.Discovery.ListConfigurations Associated Types type AWSResponse ListConfigurations # Methods request :: (Service -> Service) -> ListConfigurations -> Request ListConfigurations # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListConfigurations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListConfigurations))) #
Generic ListConfigurations Source #
Instance details Defined in Amazonka.Discovery.ListConfigurations Associated Types type Rep ListConfigurations :: Type -> Type # Methods from :: ListConfigurations -> Rep ListConfigurations x # to :: Rep ListConfigurations x -> ListConfigurations #
Read ListConfigurations Source #
Instance details Defined in Amazonka.Discovery.ListConfigurations Methods readsPrec :: Int -> ReadS ListConfigurations # readList :: ReadS [ListConfigurations] # readPrec :: ReadPrec ListConfigurations # readListPrec :: ReadPrec [ListConfigurations] #
Show ListConfigurations Source #
Instance details Defined in Amazonka.Discovery.ListConfigurations Methods showsPrec :: Int -> ListConfigurations -> ShowS # show :: ListConfigurations -> String # showList :: [ListConfigurations] -> ShowS #
NFData ListConfigurations Source #
Instance details Defined in Amazonka.Discovery.ListConfigurations Methods rnf :: ListConfigurations -> () #
Eq ListConfigurations Source #
Instance details Defined in Amazonka.Discovery.ListConfigurations Methods (==) :: ListConfigurations -> ListConfigurations -> Bool # (/=) :: ListConfigurations -> ListConfigurations -> Bool #
Hashable ListConfigurations Source #
Instance details Defined in Amazonka.Discovery.ListConfigurations Methods hashWithSalt :: Int -> ListConfigurations -> Int # hash :: ListConfigurations -> Int #
type AWSResponse ListConfigurations Source #
Instance details Defined in Amazonka.Discovery.ListConfigurations type AWSResponse ListConfigurations = ListConfigurationsResponse
type Rep ListConfigurations Source #
Instance details Defined in Amazonka.Discovery.ListConfigurations type Rep ListConfigurations = D1 ('MetaData "ListConfigurations" "Amazonka.Discovery.ListConfigurations" "amazonka-discovery-2.0-FHPaShbhCtL10K1sBxZHs" 'False) (C1 ('MetaCons "ListConfigurations'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "orderBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OrderByElement])) :: S1 ('MetaSel ('Just "configurationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConfigurationItemType)))))

newListConfigurations Source #

Arguments

:: ConfigurationItemType	`ListConfigurations`
-> ListConfigurations

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: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 Amazon Web Services Application Discovery Service User Guide.

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

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: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 Amazon Web Services Application Discovery Service User Guide.

ListConfigurations, listConfigurations_configurationType - A valid configuration identified by Application Discovery Service.

Request Lenses

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 Amazon Web Services Application Discovery Service User Guide.

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

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

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_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 Amazon Web Services Application Discovery Service User Guide.

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

Generic ListConfigurationsResponse Source #
Instance details Defined in Amazonka.Discovery.ListConfigurations Associated Types type Rep ListConfigurationsResponse :: Type -> Type # Methods from :: ListConfigurationsResponse -> Rep ListConfigurationsResponse x # to :: Rep ListConfigurationsResponse x -> ListConfigurationsResponse #
Read ListConfigurationsResponse Source #
Instance details Defined in Amazonka.Discovery.ListConfigurations Methods readsPrec :: Int -> ReadS ListConfigurationsResponse # readList :: ReadS [ListConfigurationsResponse] # readPrec :: ReadPrec ListConfigurationsResponse # readListPrec :: ReadPrec [ListConfigurationsResponse] #
Show ListConfigurationsResponse Source #
Instance details Defined in Amazonka.Discovery.ListConfigurations Methods showsPrec :: Int -> ListConfigurationsResponse -> ShowS # show :: ListConfigurationsResponse -> String # showList :: [ListConfigurationsResponse] -> ShowS #
NFData ListConfigurationsResponse Source #
Instance details Defined in Amazonka.Discovery.ListConfigurations Methods rnf :: ListConfigurationsResponse -> () #
Eq ListConfigurationsResponse Source #
Instance details Defined in Amazonka.Discovery.ListConfigurations Methods (==) :: ListConfigurationsResponse -> ListConfigurationsResponse -> Bool # (/=) :: ListConfigurationsResponse -> ListConfigurationsResponse -> Bool #
type Rep ListConfigurationsResponse Source #
Instance details Defined in Amazonka.Discovery.ListConfigurations type Rep ListConfigurationsResponse = D1 ('MetaData "ListConfigurationsResponse" "Amazonka.Discovery.ListConfigurations" "amazonka-discovery-2.0-FHPaShbhCtL10K1sBxZHs" '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 #

Arguments

:: Int	`$sel:httpStatus:ListConfigurationsResponse'`
-> ListConfigurationsResponse

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.

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.

listConfigurationsResponse_httpStatus :: Lens' ListConfigurationsResponse Int Source #

The response's http status code.