SSM / Client / get_parameters
get_parameters#
- SSM.Client.get_parameters(**kwargs)#
Get information about one or more parameters by specifying multiple parameter names.
Note
To get information about a single parameter, you can use the GetParameter operation instead.
See also: AWS API Documentation
Request Syntax
response = client.get_parameters( Names=[ 'string', ], WithDecryption=True|False )
- Parameters:
Names (list) –
[REQUIRED]
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"
.(string) –
WithDecryption (boolean) – Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for
String
andStringList
parameter types.
- Return type:
dict
- Returns:
Response Syntax
{ 'Parameters': [ { 'Name': 'string', 'Type': 'String'|'StringList'|'SecureString', 'Value': 'string', 'Version': 123, 'Selector': 'string', 'SourceResult': 'string', 'LastModifiedDate': datetime(2015, 1, 1), 'ARN': 'string', 'DataType': 'string' }, ], 'InvalidParameters': [ 'string', ] }
Response Structure
(dict) –
Parameters (list) –
A list of details for a parameter.
(dict) –
An Amazon Web Services Systems Manager parameter in Parameter Store.
Name (string) –
The name of the parameter.
Type (string) –
The type of parameter. Valid values include the following:
String
,StringList
, andSecureString
.Note
If type is
StringList
, the system returns a comma-separated string with no spaces between commas in theValue
field.Value (string) –
The parameter value.
Note
If type is
StringList
, the system returns a comma-separated string with no spaces between commas in theValue
field.Version (integer) –
The parameter version.
Selector (string) –
Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:
parameter_name:version
parameter_name:label
SourceResult (string) –
Applies to parameters that reference information in other Amazon Web Services services.
SourceResult
is the raw result or response from the source.LastModifiedDate (datetime) –
Date the parameter was last changed or updated and the parameter version was created.
ARN (string) –
The Amazon Resource Name (ARN) of the parameter.
DataType (string) –
The data type of the parameter, such as
text
oraws:ec2:image
. The default istext
.
InvalidParameters (list) –
A list of parameters that aren’t formatted correctly or don’t run during an execution.
(string) –
Exceptions
SSM.Client.exceptions.InvalidKeyId
SSM.Client.exceptions.InternalServerError