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 |
Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.
Synopsis
- data DescribePackages = DescribePackages' {}
- newDescribePackages :: DescribePackages
- describePackages_filters :: Lens' DescribePackages (Maybe [DescribePackagesFilter])
- describePackages_maxResults :: Lens' DescribePackages (Maybe Int)
- describePackages_nextToken :: Lens' DescribePackages (Maybe Text)
- data DescribePackagesResponse = DescribePackagesResponse' {}
- 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.
DescribePackages' | |
|
Instances
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.
DescribePackagesResponse' | |
|
Instances
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:
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.