| 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.SSM.DescribeParameters
Description
Get information about a parameter.
Request results are returned on a best-effort basis. If you specify
MaxResults in the request, the response includes information up to the
limit specified. The number of items returned, however, can be between
zero and the value of MaxResults. If the service reaches an internal
limit while processing the results, it stops the operation and returns
the matching values up to that point and a NextToken. You can specify
the NextToken in a subsequent call to get the next set of results.
If you change the KMS key alias for the KMS key used to encrypt a
parameter, then you must also update the key alias the parameter uses to
reference KMS. Otherwise, DescribeParameters retrieves whatever the
original key alias was referencing.
This operation returns paginated results.
Synopsis
- data DescribeParameters = DescribeParameters' {}
- newDescribeParameters :: DescribeParameters
- describeParameters_parameterFilters :: Lens' DescribeParameters (Maybe [ParameterStringFilter])
- describeParameters_filters :: Lens' DescribeParameters (Maybe [ParametersFilter])
- describeParameters_nextToken :: Lens' DescribeParameters (Maybe Text)
- describeParameters_maxResults :: Lens' DescribeParameters (Maybe Natural)
- data DescribeParametersResponse = DescribeParametersResponse' {
- nextToken :: Maybe Text
- parameters :: Maybe [ParameterMetadata]
- httpStatus :: Int
- newDescribeParametersResponse :: Int -> DescribeParametersResponse
- describeParametersResponse_nextToken :: Lens' DescribeParametersResponse (Maybe Text)
- describeParametersResponse_parameters :: Lens' DescribeParametersResponse (Maybe [ParameterMetadata])
- describeParametersResponse_httpStatus :: Lens' DescribeParametersResponse Int
Creating a Request
data DescribeParameters Source #
See: newDescribeParameters smart constructor.
Constructors
| DescribeParameters' | |
Fields
| |
Instances
newDescribeParameters :: DescribeParameters Source #
Create a value of DescribeParameters 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:parameterFilters:DescribeParameters', describeParameters_parameterFilters - Filters to limit the request results.
$sel:filters:DescribeParameters', describeParameters_filters - This data type is deprecated. Instead, use ParameterFilters.
$sel:nextToken:DescribeParameters', describeParameters_nextToken - The token for the next set of items to return. (You received this token
from a previous call.)
$sel:maxResults:DescribeParameters', describeParameters_maxResults - The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the
next set of results.
Request Lenses
describeParameters_parameterFilters :: Lens' DescribeParameters (Maybe [ParameterStringFilter]) Source #
Filters to limit the request results.
describeParameters_filters :: Lens' DescribeParameters (Maybe [ParametersFilter]) Source #
This data type is deprecated. Instead, use ParameterFilters.
describeParameters_nextToken :: Lens' DescribeParameters (Maybe Text) Source #
The token for the next set of items to return. (You received this token from a previous call.)
describeParameters_maxResults :: Lens' DescribeParameters (Maybe Natural) Source #
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
Destructuring the Response
data DescribeParametersResponse Source #
See: newDescribeParametersResponse smart constructor.
Constructors
| DescribeParametersResponse' | |
Fields
| |
Instances
newDescribeParametersResponse Source #
Create a value of DescribeParametersResponse 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:nextToken:DescribeParameters', describeParametersResponse_nextToken - The token to use when requesting the next set of items.
$sel:parameters:DescribeParametersResponse', describeParametersResponse_parameters - Parameters returned by the request.
$sel:httpStatus:DescribeParametersResponse', describeParametersResponse_httpStatus - The response's http status code.
Response Lenses
describeParametersResponse_nextToken :: Lens' DescribeParametersResponse (Maybe Text) Source #
The token to use when requesting the next set of items.
describeParametersResponse_parameters :: Lens' DescribeParametersResponse (Maybe [ParameterMetadata]) Source #
Parameters returned by the request.
describeParametersResponse_httpStatus :: Lens' DescribeParametersResponse Int Source #
The response's http status code.