amazonka-opensearch-2.0: Amazon OpenSearch 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.OpenSearch.ListVersions

Description

Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

Synopsis

Creating a Request

data ListVersions Source #

Container for the request parameters to the ListVersions operation.

See: newListVersions smart constructor.

Constructors

ListVersions' 

Fields

  • maxResults :: Maybe Int

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

  • nextToken :: Maybe Text

    If your initial ListVersions operation returns a nextToken, you can include the returned nextToken in subsequent ListVersions operations, which returns results in the next page.

Instances

Instances details
ToHeaders ListVersions Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVersions

ToPath ListVersions Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVersions

ToQuery ListVersions Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVersions

AWSRequest ListVersions Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVersions

Associated Types

type AWSResponse ListVersions #

Generic ListVersions Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVersions

Associated Types

type Rep ListVersions :: Type -> Type #

Read ListVersions Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVersions

Show ListVersions Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVersions

NFData ListVersions Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVersions

Methods

rnf :: ListVersions -> () #

Eq ListVersions Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVersions

Hashable ListVersions Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVersions

type AWSResponse ListVersions Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVersions

type Rep ListVersions Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVersions

type Rep ListVersions = D1 ('MetaData "ListVersions" "Amazonka.OpenSearch.ListVersions" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "ListVersions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListVersions :: ListVersions Source #

Create a value of ListVersions 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:ListVersions', listVersions_maxResults - An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

ListVersions, listVersions_nextToken - If your initial ListVersions operation returns a nextToken, you can include the returned nextToken in subsequent ListVersions operations, which returns results in the next page.

Request Lenses

listVersions_maxResults :: Lens' ListVersions (Maybe Int) Source #

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

listVersions_nextToken :: Lens' ListVersions (Maybe Text) Source #

If your initial ListVersions operation returns a nextToken, you can include the returned nextToken in subsequent ListVersions operations, which returns results in the next page.

Destructuring the Response

data ListVersionsResponse Source #

Container for the parameters for response received from the ListVersions operation.

See: newListVersionsResponse smart constructor.

Constructors

ListVersionsResponse' 

Fields

  • nextToken :: Maybe Text

    When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

  • versions :: Maybe [Text]

    A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListVersionsResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVersions

Associated Types

type Rep ListVersionsResponse :: Type -> Type #

Read ListVersionsResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVersions

Show ListVersionsResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVersions

NFData ListVersionsResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVersions

Methods

rnf :: ListVersionsResponse -> () #

Eq ListVersionsResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVersions

type Rep ListVersionsResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVersions

type Rep ListVersionsResponse = D1 ('MetaData "ListVersionsResponse" "Amazonka.OpenSearch.ListVersions" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "ListVersionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "versions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListVersionsResponse Source #

Create a value of ListVersionsResponse 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:

ListVersions, listVersionsResponse_nextToken - When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

$sel:versions:ListVersionsResponse', listVersionsResponse_versions - A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

$sel:httpStatus:ListVersionsResponse', listVersionsResponse_httpStatus - The response's http status code.

Response Lenses

listVersionsResponse_nextToken :: Lens' ListVersionsResponse (Maybe Text) Source #

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

listVersionsResponse_versions :: Lens' ListVersionsResponse (Maybe [Text]) Source #

A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.