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

Description

Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

Synopsis

Creating a Request

data ListPackagesForDomain Source #

Container for the request parameters to the ListPackagesForDomain operation.

See: newListPackagesForDomain smart constructor.

Constructors

ListPackagesForDomain' 

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

  • domainName :: Text

    The name of the domain for which you want to list associated packages.

Instances

Instances details
ToHeaders ListPackagesForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListPackagesForDomain

ToPath ListPackagesForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListPackagesForDomain

ToQuery ListPackagesForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListPackagesForDomain

AWSRequest ListPackagesForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListPackagesForDomain

Associated Types

type AWSResponse ListPackagesForDomain #

Generic ListPackagesForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListPackagesForDomain

Associated Types

type Rep ListPackagesForDomain :: Type -> Type #

Read ListPackagesForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListPackagesForDomain

Show ListPackagesForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListPackagesForDomain

NFData ListPackagesForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListPackagesForDomain

Methods

rnf :: ListPackagesForDomain -> () #

Eq ListPackagesForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListPackagesForDomain

Hashable ListPackagesForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListPackagesForDomain

type AWSResponse ListPackagesForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListPackagesForDomain

type Rep ListPackagesForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListPackagesForDomain

type Rep ListPackagesForDomain = D1 ('MetaData "ListPackagesForDomain" "Amazonka.OpenSearch.ListPackagesForDomain" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "ListPackagesForDomain'" '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 "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListPackagesForDomain Source #

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

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

ListPackagesForDomain, listPackagesForDomain_domainName - The name of the domain for which you want to list associated packages.

Request Lenses

listPackagesForDomain_maxResults :: Lens' ListPackagesForDomain (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.

listPackagesForDomain_nextToken :: Lens' ListPackagesForDomain (Maybe Text) Source #

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

listPackagesForDomain_domainName :: Lens' ListPackagesForDomain Text Source #

The name of the domain for which you want to list associated packages.

Destructuring the Response

data ListPackagesForDomainResponse Source #

Container for the response parameters to the ListPackagesForDomain operation.

See: newListPackagesForDomainResponse smart constructor.

Constructors

ListPackagesForDomainResponse' 

Fields

Instances

Instances details
Generic ListPackagesForDomainResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListPackagesForDomain

Associated Types

type Rep ListPackagesForDomainResponse :: Type -> Type #

Read ListPackagesForDomainResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListPackagesForDomain

Show ListPackagesForDomainResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListPackagesForDomain

NFData ListPackagesForDomainResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListPackagesForDomain

Eq ListPackagesForDomainResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListPackagesForDomain

type Rep ListPackagesForDomainResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListPackagesForDomain

type Rep ListPackagesForDomainResponse = D1 ('MetaData "ListPackagesForDomainResponse" "Amazonka.OpenSearch.ListPackagesForDomain" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "ListPackagesForDomainResponse'" '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))))

newListPackagesForDomainResponse Source #

Create a value of ListPackagesForDomainResponse 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:ListPackagesForDomainResponse', listPackagesForDomainResponse_domainPackageDetailsList - List of all packages associated with a domain.

ListPackagesForDomain, listPackagesForDomainResponse_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:ListPackagesForDomainResponse', listPackagesForDomainResponse_httpStatus - The response's http status code.

Response Lenses

listPackagesForDomainResponse_nextToken :: Lens' ListPackagesForDomainResponse (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.