libZSservicesZSamazonka-opensearchZSamazonka-opensearch
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.OpenSearch.DescribePackages

Description

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

Synopsis

Creating a Request

data DescribePackages Source #

Container for the request parameters to the DescribePackage operation.

See: newDescribePackages smart constructor.

Constructors

DescribePackages' 

Fields

Instances

Instances details
Eq DescribePackages Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribePackages

Read DescribePackages Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribePackages

Show DescribePackages Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribePackages

Generic DescribePackages Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribePackages

Associated Types

type Rep DescribePackages :: Type -> Type #

NFData DescribePackages Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribePackages

Methods

rnf :: DescribePackages -> () #

Hashable DescribePackages Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribePackages

ToJSON DescribePackages Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribePackages

AWSRequest DescribePackages Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribePackages

Associated Types

type AWSResponse DescribePackages #

ToHeaders DescribePackages Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribePackages

ToPath DescribePackages Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribePackages

ToQuery DescribePackages Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribePackages

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

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

Instances

Instances details
Eq DescribePackagesResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribePackages

Read DescribePackagesResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribePackages

Show DescribePackagesResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribePackages

Generic DescribePackagesResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribePackages

Associated Types

type Rep DescribePackagesResponse :: Type -> Type #

NFData DescribePackagesResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribePackages

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 #

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