| 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.GetParameters
Description
Get information about one or more parameters by specifying multiple parameter names.
To get information about a single parameter, you can use the GetParameter operation instead.
Synopsis
- data GetParameters = GetParameters' {}
- newGetParameters :: NonEmpty Text -> GetParameters
- getParameters_withDecryption :: Lens' GetParameters (Maybe Bool)
- getParameters_names :: Lens' GetParameters (NonEmpty Text)
- data GetParametersResponse = GetParametersResponse' {
- parameters :: Maybe [Parameter]
- invalidParameters :: Maybe [Text]
- httpStatus :: Int
- newGetParametersResponse :: Int -> GetParametersResponse
- getParametersResponse_parameters :: Lens' GetParametersResponse (Maybe [Parameter])
- getParametersResponse_invalidParameters :: Lens' GetParametersResponse (Maybe [Text])
- getParametersResponse_httpStatus :: Lens' GetParametersResponse Int
Creating a Request
data GetParameters Source #
See: newGetParameters smart constructor.
Constructors
| GetParameters' | |
Fields
| |
Instances
Arguments
| :: NonEmpty Text | |
| -> GetParameters |
Create a value of GetParameters 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:withDecryption:GetParameters', getParameters_withDecryption - Return decrypted secure string value. Return decrypted values for secure
string parameters. This flag is ignored for String and StringList
parameter types.
$sel:names:GetParameters', getParameters_names - Names of the parameters for which you want to query information.
To query by parameter label, use "Name": "name:label". To query by
parameter version, use "Name": "name:version".
Request Lenses
getParameters_withDecryption :: Lens' GetParameters (Maybe Bool) Source #
Return decrypted secure string value. Return decrypted values for secure
string parameters. This flag is ignored for String and StringList
parameter types.
getParameters_names :: Lens' GetParameters (NonEmpty Text) Source #
Names of the parameters for which you want to query information.
To query by parameter label, use "Name": "name:label". To query by
parameter version, use "Name": "name:version".
Destructuring the Response
data GetParametersResponse Source #
See: newGetParametersResponse smart constructor.
Constructors
| GetParametersResponse' | |
Fields
| |
Instances
newGetParametersResponse Source #
Create a value of GetParametersResponse 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:parameters:GetParametersResponse', getParametersResponse_parameters - A list of details for a parameter.
$sel:invalidParameters:GetParametersResponse', getParametersResponse_invalidParameters - A list of parameters that aren't formatted correctly or don't run
during an execution.
$sel:httpStatus:GetParametersResponse', getParametersResponse_httpStatus - The response's http status code.
Response Lenses
getParametersResponse_parameters :: Lens' GetParametersResponse (Maybe [Parameter]) Source #
A list of details for a parameter.
getParametersResponse_invalidParameters :: Lens' GetParametersResponse (Maybe [Text]) Source #
A list of parameters that aren't formatted correctly or don't run during an execution.
getParametersResponse_httpStatus :: Lens' GetParametersResponse Int Source #
The response's http status code.