SSM / Client / get_parameter

get_parameter#

SSM.Client.get_parameter(**kwargs)#

Get information about a single parameter by specifying the parameter name.

Note

To get information about more than one parameter at a time, use the GetParameters operation.

See also: AWS API Documentation

Request Syntax

response = client.get_parameter(
    Name='string',
    WithDecryption=True|False
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name or Amazon Resource Name (ARN) of the parameter that you want to query. For parameters shared with you from another account, you must use the full ARN.

    To query by parameter label, use "Name": "name:label". To query by parameter version, use "Name": "name:version".

    For more information about shared parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.

  • WithDecryption (boolean) – Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

Return type:

dict

Returns:

Response Syntax

{
    'Parameter': {
        'Name': 'string',
        'Type': 'String'|'StringList'|'SecureString',
        'Value': 'string',
        'Version': 123,
        'Selector': 'string',
        'SourceResult': 'string',
        'LastModifiedDate': datetime(2015, 1, 1),
        'ARN': 'string',
        'DataType': 'string'
    }
}

Response Structure

  • (dict) –

    • Parameter (dict) –

      Information about a parameter.

      • Name (string) –

        The name of the parameter.

      • Type (string) –

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

        Note

        If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

      • Value (string) –

        The parameter value.

        Note

        If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value 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 or aws:ec2:image. The default is text.

Exceptions