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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 Methods toHeaders :: ListDomainsForPackage -> [Header] #
ToPath ListDomainsForPackage Source #
Instance details Defined in Amazonka.OpenSearch.ListDomainsForPackage Methods toPath :: ListDomainsForPackage -> ByteString #
ToQuery ListDomainsForPackage Source #
Instance details Defined in Amazonka.OpenSearch.ListDomainsForPackage Methods toQuery :: ListDomainsForPackage -> QueryString #
AWSRequest ListDomainsForPackage Source #
Instance details Defined in Amazonka.OpenSearch.ListDomainsForPackage Associated Types type AWSResponse ListDomainsForPackage # Methods request :: (Service -> Service) -> ListDomainsForPackage -> Request ListDomainsForPackage # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListDomainsForPackage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListDomainsForPackage))) #
Generic ListDomainsForPackage Source #
Instance details Defined in Amazonka.OpenSearch.ListDomainsForPackage Associated Types type Rep ListDomainsForPackage :: Type -> Type # Methods from :: ListDomainsForPackage -> Rep ListDomainsForPackage x # to :: Rep ListDomainsForPackage x -> ListDomainsForPackage #
Read ListDomainsForPackage Source #
Instance details Defined in Amazonka.OpenSearch.ListDomainsForPackage Methods readsPrec :: Int -> ReadS ListDomainsForPackage # readList :: ReadS [ListDomainsForPackage] # readPrec :: ReadPrec ListDomainsForPackage # readListPrec :: ReadPrec [ListDomainsForPackage] #
Show ListDomainsForPackage Source #
Instance details Defined in Amazonka.OpenSearch.ListDomainsForPackage Methods showsPrec :: Int -> ListDomainsForPackage -> ShowS # show :: ListDomainsForPackage -> String # showList :: [ListDomainsForPackage] -> ShowS #
NFData ListDomainsForPackage Source #
Instance details Defined in Amazonka.OpenSearch.ListDomainsForPackage Methods rnf :: ListDomainsForPackage -> () #
Eq ListDomainsForPackage Source #
Instance details Defined in Amazonka.OpenSearch.ListDomainsForPackage Methods (==) :: ListDomainsForPackage -> ListDomainsForPackage -> Bool # (/=) :: ListDomainsForPackage -> ListDomainsForPackage -> Bool #
Hashable ListDomainsForPackage Source #
Instance details Defined in Amazonka.OpenSearch.ListDomainsForPackage Methods hashWithSalt :: Int -> ListDomainsForPackage -> Int # hash :: ListDomainsForPackage -> Int #
type AWSResponse ListDomainsForPackage Source #
Instance details Defined in Amazonka.OpenSearch.ListDomainsForPackage type AWSResponse ListDomainsForPackage = ListDomainsForPackageResponse
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 #

Arguments

:: Text	`ListDomainsForPackage`
-> ListDomainsForPackage

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

domainPackageDetailsList :: Maybe [DomainPackageDetails]
Information about all domains associated with a package.
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListDomainsForPackageResponse Source #
Instance details Defined in Amazonka.OpenSearch.ListDomainsForPackage Associated Types type Rep ListDomainsForPackageResponse :: Type -> Type # Methods from :: ListDomainsForPackageResponse -> Rep ListDomainsForPackageResponse x # to :: Rep ListDomainsForPackageResponse x -> ListDomainsForPackageResponse #
Read ListDomainsForPackageResponse Source #
Instance details Defined in Amazonka.OpenSearch.ListDomainsForPackage Methods readsPrec :: Int -> ReadS ListDomainsForPackageResponse # readList :: ReadS [ListDomainsForPackageResponse] # readPrec :: ReadPrec ListDomainsForPackageResponse # readListPrec :: ReadPrec [ListDomainsForPackageResponse] #
Show ListDomainsForPackageResponse Source #
Instance details Defined in Amazonka.OpenSearch.ListDomainsForPackage Methods showsPrec :: Int -> ListDomainsForPackageResponse -> ShowS # show :: ListDomainsForPackageResponse -> String # showList :: [ListDomainsForPackageResponse] -> ShowS #
NFData ListDomainsForPackageResponse Source #
Instance details Defined in Amazonka.OpenSearch.ListDomainsForPackage Methods rnf :: ListDomainsForPackageResponse -> () #
Eq ListDomainsForPackageResponse Source #
Instance details Defined in Amazonka.OpenSearch.ListDomainsForPackage Methods (==) :: ListDomainsForPackageResponse -> ListDomainsForPackageResponse -> Bool # (/=) :: ListDomainsForPackageResponse -> ListDomainsForPackageResponse -> Bool #
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 #

Arguments

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

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_domainPackageDetailsList :: Lens' ListDomainsForPackageResponse (Maybe [DomainPackageDetails]) Source #

Information about all domains associated with a package.

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.

listDomainsForPackageResponse_httpStatus :: Lens' ListDomainsForPackageResponse Int Source #

The response's http status code.