View a markdown version of this page

Utilisation de GetParameters avec une CLI - AWS Systems Manager

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Utilisation de GetParameters avec une CLI

Les exemples de code suivants illustrent comment utiliser GetParameters.

Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :

CLI
AWS CLI

Exemple 1 : pour répertorier les valeurs d’un paramètre

L’exemple get-parameters suivant répertorie les valeurs des trois paramètres spécifiés.

aws ssm get-parameters \
    --names "MyStringParameter" "MyStringListParameter" "MyInvalidParameterName"

Sortie :

{
    "Parameters": [
        {
            "Name": "MyStringListParameter",
            "Type": "StringList",
            "Value": "alpha,beta,gamma",
            "Version": 1,
            "LastModifiedDate": 1582154764.222,
            "ARN": "arn:aws:ssm:us-west-2:123456789012:parameter/MyStringListParameter",
            "DataType": "text"
        },
        {
            "Name": "MyStringParameter",
            "Type": "String",
            "Value": "Vici",
            "Version": 3,
            "LastModifiedDate": 1582156117.545,
            "ARN": "arn:aws:ssm:us-west-2:123456789012:parameter/MyStringParameter",
            "DataType": "text"
        }
    ],
    "InvalidParameters": [
        "MyInvalidParameterName"
    ]
}

Pour plus d’informations, consultez Utilisation de magasins de paramètres dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 2 : pour répertorier les noms et les valeurs de plusieurs paramètres en utilisant l’option ``--query``

L’exemple get-parameters suivant répertorie les noms et les valeurs des paramètres spécifiés.

aws ssm get-parameters \
    --names MyStringParameter MyStringListParameter \
    --query "Parameters[*].{Name:Name,Value:Value}"

Sortie :

[
    {
        "Name": "MyStringListParameter",
        "Value": "alpha,beta,gamma"
    },
    {
        "Name": "MyStringParameter",
        "Value": "Vidi"
    }
]

Pour plus d’informations, consultez Utilisation de magasins de paramètres dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 3 : pour afficher la valeur d’un paramètre à l’aide d’étiquettes

Ce qui suit get-parameters example répertorie les valeurs pour les paramètres spécifiés, l'un spécifié par label et l'autre spécifié par version.

aws ssm get-parameters \
    --names "MyLabelParameter:label" "MyVersionParameter:2"

Sortie :

{
    "Parameters": [
        {
            "Name": "MyLabelParameter",
            "Type": "String",
            "Value": "parameter by label",
            "Version": 1,
            "Selector": ":label",
            "LastModifiedDate": "2021-07-12T09:49:15.865000-07:00",
            "ARN": "arn:aws:ssm:us-west-2:123456789111:parameter/MyLabelParameter",
            "DataType": "text"
        },
        {
            "Name": "MyVersionParameter",
            "Type": "String",
            "Value": "parameter by version",
            "Version": 2,
            "Selector": ":2",
            "LastModifiedDate": "2021-03-24T16:20:28.236000-07:00",
            "ARN": "arn:aws:ssm:us-west-2:123456789111:parameter/MyVersionParameter",
            "DataType": "text"
        }
    ],
    "InvalidParameters": []
}

Pour plus d’informations, consultez Utilisation des étiquettes de paramètres dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, voir GetParameters dans AWS CLI Référence de commande.

PowerShell
Outils pour PowerShell V4

Exemple 1 : cet exemple répertorie les valeurs d’un paramètre.

Get-SSMParameterValue -Name "Welcome"

Sortie :

InvalidParameters Parameters
----------------- ----------
{}                {Welcome}

Exemple 2 : cet exemple répertorie les détails de la valeur.

(Get-SSMParameterValue -Name "Welcome").Parameters

Sortie :

Name    Type   Value
----    ----   -----
Welcome String Good day, Sunshine!

  • Pour plus de détails sur l'API, voir GetParameters dans Outils AWS pour PowerShell Référence de l'applet de commande (V4).

Outils pour PowerShell V5

Exemple 1 : cet exemple répertorie les valeurs d’un paramètre.

Get-SSMParameterValue -Name "Welcome"

Sortie :

InvalidParameters Parameters
----------------- ----------
{}                {Welcome}

Exemple 2 : cet exemple répertorie les détails de la valeur.

(Get-SSMParameterValue -Name "Welcome").Parameters

Sortie :

Name    Type   Value
----    ----   -----
Welcome String Good day, Sunshine!

  • Pour plus de détails sur l'API, voir GetParameters dans Outils AWS pour PowerShell Référence de l'applet de commande (V5).

Pour une liste complète des AWS Guides du développeur du SDK et exemples de code, voir L'utilisation de ce service avec AWS Kit SDK. Cette rubrique comprend également des informations sur le démarrage et sur les versions précédentes du kit SDK.