Skip to content
AWS for Query.Farm

aws.ssm.get_parameter

Example SQL Queries

SELECT * FROM
aws.ssm.get_parameter
WHERE
"name" = 'VALUE';

Description

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

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

Table Definition

Column NameColumn Data Type
name Required Input Column

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.

VARCHAR
with_decryption Input Column

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

BOOLEAN
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
parameter

Information about a parameter.

STRUCT(
    "name" VARCHAR,
    "type" VARCHAR,
    "value" VARCHAR,
    "version" BIGINT,
    "selector" VARCHAR,
    "source_result" VARCHAR,
    "last_modified_date" TIMESTAMP_S,
    "arn" VARCHAR,
    "data_type" VARCHAR
)
Show child fields
parameter.arn

The Amazon Resource Name (ARN) of the parameter.

parameter.data_type

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

parameter.last_modified_date

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

parameter.name

The name of the parameter.

parameter.selector

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

parameter.source_result

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

parameter.type

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

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

parameter.value

The parameter value.

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

parameter.version

The parameter version.