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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.

Synopsis

data DescribePackages = DescribePackages' {
- filters :: Maybe [DescribePackagesFilter]
- maxResults :: Maybe Int
- nextToken :: Maybe Text
}
newDescribePackages :: DescribePackages
describePackages_filters :: Lens' DescribePackages (Maybe [DescribePackagesFilter])
describePackages_maxResults :: Lens' DescribePackages (Maybe Int)
describePackages_nextToken :: Lens' DescribePackages (Maybe Text)
data DescribePackagesResponse = DescribePackagesResponse' {
- nextToken :: Maybe Text
- packageDetailsList :: Maybe [PackageDetails]
- httpStatus :: Int
}
newDescribePackagesResponse :: Int -> DescribePackagesResponse
describePackagesResponse_nextToken :: Lens' DescribePackagesResponse (Maybe Text)
describePackagesResponse_packageDetailsList :: Lens' DescribePackagesResponse (Maybe [PackageDetails])
describePackagesResponse_httpStatus :: Lens' DescribePackagesResponse Int

Creating a Request

data DescribePackages Source #

Container for the request parameters to the DescribePackage operation.

See: newDescribePackages smart constructor.

Constructors

DescribePackages'

Fields

filters :: Maybe [DescribePackagesFilter]
Only returns packages that match the DescribePackagesFilterList values.
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 DescribePackageFilters operation returns a nextToken, you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.

Instances

Instances details

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

newDescribePackages :: DescribePackages Source #

Create a value of DescribePackages 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:DescribePackages', describePackages_filters - Only returns packages that match the DescribePackagesFilterList values.

$sel:maxResults:DescribePackages', describePackages_maxResults - An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

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

Request Lenses

describePackages_filters :: Lens' DescribePackages (Maybe [DescribePackagesFilter]) Source #

Only returns packages that match the DescribePackagesFilterList values.

describePackages_maxResults :: Lens' DescribePackages (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.

describePackages_nextToken :: Lens' DescribePackages (Maybe Text) Source #

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

Destructuring the Response

data DescribePackagesResponse Source #

Container for the response returned by the DescribePackages operation.

See: newDescribePackagesResponse smart constructor.

Constructors

DescribePackagesResponse'
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. packageDetailsList :: Maybe [PackageDetails] Basic information about a package. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribePackagesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribePackages Associated Types type Rep DescribePackagesResponse :: Type -> Type # Methods from :: DescribePackagesResponse -> Rep DescribePackagesResponse x # to :: Rep DescribePackagesResponse x -> DescribePackagesResponse #
Read DescribePackagesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribePackages Methods readsPrec :: Int -> ReadS DescribePackagesResponse # readList :: ReadS [DescribePackagesResponse] # readPrec :: ReadPrec DescribePackagesResponse # readListPrec :: ReadPrec [DescribePackagesResponse] #
Show DescribePackagesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribePackages Methods showsPrec :: Int -> DescribePackagesResponse -> ShowS # show :: DescribePackagesResponse -> String # showList :: [DescribePackagesResponse] -> ShowS #
NFData DescribePackagesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribePackages Methods rnf :: DescribePackagesResponse -> () #
Eq DescribePackagesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribePackages Methods (==) :: DescribePackagesResponse -> DescribePackagesResponse -> Bool # (/=) :: DescribePackagesResponse -> DescribePackagesResponse -> Bool #
type Rep DescribePackagesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribePackages type Rep DescribePackagesResponse = D1 ('MetaData "DescribePackagesResponse" "Amazonka.OpenSearch.DescribePackages" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "DescribePackagesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "packageDetailsList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PackageDetails])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribePackagesResponse Source #

Arguments

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

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

DescribePackages, describePackagesResponse_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:packageDetailsList:DescribePackagesResponse', describePackagesResponse_packageDetailsList - Basic information about a package.

$sel:httpStatus:DescribePackagesResponse', describePackagesResponse_httpStatus - The response's http status code.

Response Lenses

describePackagesResponse_nextToken :: Lens' DescribePackagesResponse (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.

describePackagesResponse_packageDetailsList :: Lens' DescribePackagesResponse (Maybe [PackageDetails]) Source #

Basic information about a package.

describePackagesResponse_httpStatus :: Lens' DescribePackagesResponse Int Source #

The response's http status code.