Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.OpenSearch.DescribePackages

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes all packages available to Amazon OpenSearch Service domains. Includes options for filtering, limiting the number of results, and pagination.

Synopsis

data DescribePackages = DescribePackages' {
- filters :: Maybe [DescribePackagesFilter]
- nextToken :: Maybe Text
- maxResults :: Maybe Int
}
newDescribePackages :: DescribePackages
describePackages_filters :: Lens' DescribePackages (Maybe [DescribePackagesFilter])
describePackages_nextToken :: Lens' DescribePackages (Maybe Text)
describePackages_maxResults :: Lens' DescribePackages (Maybe Int)
data DescribePackagesResponse = DescribePackagesResponse' {
- packageDetailsList :: Maybe [PackageDetails]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newDescribePackagesResponse :: Int -> DescribePackagesResponse
describePackagesResponse_packageDetailsList :: Lens' DescribePackagesResponse (Maybe [PackageDetails])
describePackagesResponse_nextToken :: Lens' DescribePackagesResponse (Maybe Text)
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. nextToken :: Maybe Text Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page. maxResults :: Maybe Int Limits results to a maximum number of packages.

Instances

Instances details

Eq DescribePackages Source #
Instance details Defined in Amazonka.OpenSearch.DescribePackages Methods (==) :: DescribePackages -> DescribePackages -> Bool # (/=) :: DescribePackages -> DescribePackages -> Bool #
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 #
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 #
NFData DescribePackages Source #
Instance details Defined in Amazonka.OpenSearch.DescribePackages Methods rnf :: DescribePackages -> () #
Hashable DescribePackages Source #
Instance details Defined in Amazonka.OpenSearch.DescribePackages Methods hashWithSalt :: Int -> DescribePackages -> Int # hash :: DescribePackages -> Int #
ToJSON DescribePackages Source #
Instance details Defined in Amazonka.OpenSearch.DescribePackages Methods toJSON :: DescribePackages -> Value # toEncoding :: DescribePackages -> Encoding # toJSONList :: [DescribePackages] -> Value # toEncodingList :: [DescribePackages] -> Encoding #
AWSRequest DescribePackages Source #
Instance details Defined in Amazonka.OpenSearch.DescribePackages Associated Types type AWSResponse DescribePackages # Methods request :: DescribePackages -> Request DescribePackages # response :: MonadResource m => Logger -> Service -> Proxy DescribePackages -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribePackages))) #
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 #
type Rep DescribePackages Source #
Instance details Defined in Amazonka.OpenSearch.DescribePackages type Rep DescribePackages = D1 ('MetaData "DescribePackages" "Amazonka.OpenSearch.DescribePackages" "libZSservicesZSamazonka-opensearchZSamazonka-opensearch" 'False) (C1 ('MetaCons "DescribePackages'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DescribePackagesFilter])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))
type AWSResponse DescribePackages Source #
Instance details Defined in Amazonka.OpenSearch.DescribePackages type AWSResponse DescribePackages = DescribePackagesResponse

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:nextToken:DescribePackages', describePackages_nextToken - Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

$sel:maxResults:DescribePackages', describePackages_maxResults - Limits results to a maximum number of packages.

Request Lenses

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

Only returns packages that match the DescribePackagesFilterList values.

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

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

describePackages_maxResults :: Lens' DescribePackages (Maybe Int) Source #

Limits results to a maximum number of packages.

Destructuring the Response

data DescribePackagesResponse Source #

Container for the response returned by the DescribePackages operation.

See: newDescribePackagesResponse smart constructor.

Constructors

DescribePackagesResponse'
Fields packageDetailsList :: Maybe [PackageDetails] List of `PackageDetails` objects. nextToken :: Maybe Text httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribePackagesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribePackages Methods (==) :: DescribePackagesResponse -> DescribePackagesResponse -> Bool # (/=) :: DescribePackagesResponse -> DescribePackagesResponse -> Bool #
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 #
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 #
NFData DescribePackagesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribePackages Methods rnf :: DescribePackagesResponse -> () #
type Rep DescribePackagesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribePackages type Rep DescribePackagesResponse = D1 ('MetaData "DescribePackagesResponse" "Amazonka.OpenSearch.DescribePackages" "libZSservicesZSamazonka-opensearchZSamazonka-opensearch" 'False) (C1 ('MetaCons "DescribePackagesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "packageDetailsList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PackageDetails])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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:

$sel:packageDetailsList:DescribePackagesResponse', describePackagesResponse_packageDetailsList - List of PackageDetails objects.

$sel:nextToken:DescribePackages', describePackagesResponse_nextToken - Undocumented member.

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

Response Lenses

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

List of PackageDetails objects.

describePackagesResponse_nextToken :: Lens' DescribePackagesResponse (Maybe Text) Source #

Undocumented member.

describePackagesResponse_httpStatus :: Lens' DescribePackagesResponse Int Source #

The response's http status code.