/ - Amazon Simple Systems Manager (SSM)

Get information about one or more parameters by specifying multiple parameter names.

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "Names": [], "WithDecryption": true }'

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

Names

array[string]

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".

>= 1 items<= 10 items

WithDecryption

boolean

optional

Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

Examples

Responses

🟢200Success

application/json

Body

Parameters

array[object (Parameter) {9}]

optional

A list of details for a parameter.

Name

string

optional

The name of the parameter.

>= 1 characters<= 2048 characters

Type

enum<string>

optional

The type of parameter. Valid values include the following: String, StringList, and SecureString.

Allowed values:

StringStringListSecureString

Value

string <password>

optional

The parameter value.

Version

integer

optional

The parameter version.

Selector

string

optional

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

>= 0 characters<= 128 characters

SourceResult

string

optional

Applies to parameters that reference information in other Amazon Web Services services. SourceResult is the raw result or response from the source.

LastModifiedDate

string <date-time>

optional

Date the parameter was last changed or updated and the parameter version was created.

ARN

string

optional

The Amazon Resource Name (ARN) of the parameter.

DataType

string

optional

The data type of the parameter, such as text or aws:ec2:image. The default is text.

>= 0 characters<= 128 characters

InvalidParameters

array[string]

optional

A list of parameters that aren't formatted correctly or don't run during an execution.

>= 1 items<= 10 items

🟠480InvalidKeyId

🟠481InternalServerError