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.ListDomainsForPackage

Description

Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.

Synopsis

Creating a Request

data ListDomainsForPackage Source #

Container for the request parameters to the ListDomainsForPackage operation.

See: newListDomainsForPackage smart constructor.

Constructors

ListDomainsForPackage' 

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 ListDomainsForPackage operation returns a nextToken, you can include the returned nextToken in subsequent ListDomainsForPackage operations, which returns results in the next page.

  • packageID :: Text

    The unique identifier of the package for which to list associated domains.

Instances

Instances details
ToHeaders ListDomainsForPackage Source # 
Instance details

Defined in Amazonka.OpenSearch.ListDomainsForPackage

ToPath ListDomainsForPackage Source # 
Instance details

Defined in Amazonka.OpenSearch.ListDomainsForPackage

ToQuery ListDomainsForPackage Source # 
Instance details

Defined in Amazonka.OpenSearch.ListDomainsForPackage

AWSRequest ListDomainsForPackage Source # 
Instance details

Defined in Amazonka.OpenSearch.ListDomainsForPackage

Associated Types

type AWSResponse ListDomainsForPackage #

Generic ListDomainsForPackage Source # 
Instance details

Defined in Amazonka.OpenSearch.ListDomainsForPackage

Associated Types

type Rep ListDomainsForPackage :: Type -> Type #

Read ListDomainsForPackage Source # 
Instance details

Defined in Amazonka.OpenSearch.ListDomainsForPackage

Show ListDomainsForPackage Source # 
Instance details

Defined in Amazonka.OpenSearch.ListDomainsForPackage

NFData ListDomainsForPackage Source # 
Instance details

Defined in Amazonka.OpenSearch.ListDomainsForPackage

Methods

rnf :: ListDomainsForPackage -> () #

Eq ListDomainsForPackage Source # 
Instance details

Defined in Amazonka.OpenSearch.ListDomainsForPackage

Hashable ListDomainsForPackage Source # 
Instance details

Defined in Amazonka.OpenSearch.ListDomainsForPackage

type AWSResponse ListDomainsForPackage Source # 
Instance details

Defined in Amazonka.OpenSearch.ListDomainsForPackage

type Rep ListDomainsForPackage Source # 
Instance details

Defined in Amazonka.OpenSearch.ListDomainsForPackage

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

newListDomainsForPackage Source #

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

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

ListDomainsForPackage, listDomainsForPackage_packageID - The unique identifier of the package for which to list associated domains.

Request Lenses

listDomainsForPackage_maxResults :: Lens' ListDomainsForPackage (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.

listDomainsForPackage_nextToken :: Lens' ListDomainsForPackage (Maybe Text) Source #

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

listDomainsForPackage_packageID :: Lens' ListDomainsForPackage Text Source #

The unique identifier of the package for which to list associated domains.

Destructuring the Response

data ListDomainsForPackageResponse Source #

Container for the response parameters to the ListDomainsForPackage operation.

See: newListDomainsForPackageResponse smart constructor.

Constructors

ListDomainsForPackageResponse' 

Fields

Instances

Instances details
Generic ListDomainsForPackageResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListDomainsForPackage

Associated Types

type Rep ListDomainsForPackageResponse :: Type -> Type #

Read ListDomainsForPackageResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListDomainsForPackage

Show ListDomainsForPackageResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListDomainsForPackage

NFData ListDomainsForPackageResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListDomainsForPackage

Eq ListDomainsForPackageResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListDomainsForPackage

type Rep ListDomainsForPackageResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListDomainsForPackage

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

newListDomainsForPackageResponse Source #

Create a value of ListDomainsForPackageResponse 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:domainPackageDetailsList:ListDomainsForPackageResponse', listDomainsForPackageResponse_domainPackageDetailsList - Information about all domains associated with a package.

ListDomainsForPackage, listDomainsForPackageResponse_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:httpStatus:ListDomainsForPackageResponse', listDomainsForPackageResponse_httpStatus - The response's http status code.

Response Lenses

listDomainsForPackageResponse_nextToken :: Lens' ListDomainsForPackageResponse (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.