Searching for Systems Manager parameters - AWS Systems Manager

Searching for Systems Manager parameters

When you have a large number of parameters in your account, it can be difficult to find information about just one or a few parameters at a time. In this case, you can use filter tools to search for the ones you need information about, according to search criteria you specify. You can use the Systems Manager console, the AWS CLI, the AWS Tools for PowerShell, or the DescribeParameters API to search for parameters.

For information about using the Systems Manager console and AWS CLI to view information about parameters in your account by using search, or filter options, see the following topics.

Search for a parameter (console)

  1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems-manager/.

  2. In the navigation pane, choose Parameter Store.

    -or-

    If the AWS Systems Manager home page opens first, choose the menu icon ( ) to open the navigation pane, and then choose Parameter Store.

  3. Click in the search box and choose how you want to search. For example, Type or Name.

  4. Provide information for the search type you selected. For example:

    • If you are searching by Type, choose from String, StringList, or SecureString.

    • If you are searching by Name, choose contains, equals, or begins-with, and then enter all or part of a parameter name.

      Note

      In the console, the default search type for Name is contains.

  5. Press Enter.

The list of parameters is updated with the results of your search.

Search for a parameter (AWS CLI)

Use the describe-parameters command to view information about one or more parameters in the AWS CLI.

The following examples demonstrate various options you can use to view information about the parameters in your AWS account. For more information about these options, see describe-parameters in the AWS Command Line Interface User Guide.

  1. Install and configure the AWS CLI, if you have not already.

    For information, see Install or upgrade AWS command line tools.

  2. Replace the sample values in the following commands with values reflecting parameters that have been created in your account.

    Linux
    aws ssm describe-parameters \ --parameter-filters "Key=Name,Values=MyParameterName"
    Windows
    aws ssm describe-parameters \ --parameter-filters "Key=Name,Values=MyParameterName"
    Note

    For describe-parameters, the default search type for Name is Equals. In your parameter filters, specifying "Key=Name,Values=MyParameterName" is the same as specifying "Key=Name,Option=Equals,Values=MyParameterName".

    aws ssm describe-parameters --parameter-filters "Key=Name,Option=Contains,Values=Product"
    aws ssm describe-parameters --parameter-filters "Key=Type,Values=String"
    aws ssm describe-parameters --parameter-filters "Key=Path,Values=/Production/West"
    aws ssm describe-parameters --parameter-filters "Key=Tier,Values=Standard"
    aws ssm describe-parameters --parameter-filters "Key=tag:tag-key,Values=tag-value"
    aws ssm describe-parameters --parameter-filters "Key=KeyId,Values=key-id"
    Note

    In the last example, key-id represents the ID of a AWS Key Management Service (AWS KMS) key used to encrypt a SecureString parameter created in your account. Alternatively, you can enter alias/aws/ssm to use the default AWS KMS key for your account. For more information, see Create a SecureString parameter (AWS CLI).

    If successful, the command returns output similar to the following.

    { "Parameters": [ { "Name": "/Production/West/Manager", "Type": "String", "LastModifiedDate": 1573438580.703, "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson", "Version": 1, "Tier": "Standard", "Policies": [] }, { "Name": "/Production/West/TeamLead", "Type": "String", "LastModifiedDate": 1572363610.175, "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson", "Version": 1, "Tier": "Standard", "Policies": [] }, { "Name": "/Production/West/HR", "Type": "String", "LastModifiedDate": 1572363680.503, "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson", "Version": 1, "Tier": "Standard", "Policies": [] } ] }