Sélectionner vos préférences de cookies

Nous utilisons des cookies essentiels et des outils similaires qui sont nécessaires au fonctionnement de notre site et à la fourniture de nos services. Nous utilisons des cookies de performance pour collecter des statistiques anonymes afin de comprendre comment les clients utilisent notre site et d’apporter des améliorations. Les cookies essentiels ne peuvent pas être désactivés, mais vous pouvez cliquer sur « Personnaliser » ou « Refuser » pour refuser les cookies de performance.

Si vous êtes d’accord, AWS et les tiers approuvés utiliseront également des cookies pour fournir des fonctionnalités utiles au site, mémoriser vos préférences et afficher du contenu pertinent, y compris des publicités pertinentes. Pour accepter ou refuser tous les cookies non essentiels, cliquez sur « Accepter » ou « Refuser ». Pour effectuer des choix plus détaillés, cliquez sur « Personnaliser ».

Exemples de Systems Manager utilisant AWS CLI

Mode de mise au point
Exemples de Systems Manager utilisant AWS CLI - AWS Command Line Interface

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.

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.

Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l'aide de AWS Command Line Interface with Systems Manager.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la façon de configurer et d'exécuter le code en contexte.

Rubriques

Actions

L'exemple de code suivant montre comment utiliseradd-tags-to-resource.

AWS CLI

Exemple 1 : ajout de balises à une fenêtre de maintenance

L’exemple de add-tags-to-resource suivant ajoute une balise à la fenêtre de maintenance spécifiée.

aws ssm add-tags-to-resource \ --resource-type "MaintenanceWindow" \ --resource-id "mw-03eb9db428EXAMPLE" \ --tags "Key=Stack,Value=Production"

Cette commande ne produit aucun résultat.

Exemple 2 : ajout de balises à un paramètre

L’exemple de add-tags-to-resource suivant ajoute deux balises au paramètre spécifié.

aws ssm add-tags-to-resource \ --resource-type "Parameter" \ --resource-id "My-Parameter" \ --tags '[{"Key":"Region","Value":"East"},{"Key":"Environment", "Value":"Production"}]'

Cette commande ne produit aucun résultat.

Exemple 3 : ajout de balises à un document SSM

L’exemple de add-tags-to-resource suivant ajoute une balise au document spécifié.

aws ssm add-tags-to-resource \ --resource-type "Document" \ --resource-id "My-Document" \ --tags "Key=Quarter,Value=Q322"

Cette commande ne produit aucun résultat.

Pour plus d’informations, consultez Balisage des ressources Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous AddTagsToResourceà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliseradd-tags-to-resource.

AWS CLI

Exemple 1 : ajout de balises à une fenêtre de maintenance

L’exemple de add-tags-to-resource suivant ajoute une balise à la fenêtre de maintenance spécifiée.

aws ssm add-tags-to-resource \ --resource-type "MaintenanceWindow" \ --resource-id "mw-03eb9db428EXAMPLE" \ --tags "Key=Stack,Value=Production"

Cette commande ne produit aucun résultat.

Exemple 2 : ajout de balises à un paramètre

L’exemple de add-tags-to-resource suivant ajoute deux balises au paramètre spécifié.

aws ssm add-tags-to-resource \ --resource-type "Parameter" \ --resource-id "My-Parameter" \ --tags '[{"Key":"Region","Value":"East"},{"Key":"Environment", "Value":"Production"}]'

Cette commande ne produit aucun résultat.

Exemple 3 : ajout de balises à un document SSM

L’exemple de add-tags-to-resource suivant ajoute une balise au document spécifié.

aws ssm add-tags-to-resource \ --resource-type "Document" \ --resource-id "My-Document" \ --tags "Key=Quarter,Value=Q322"

Cette commande ne produit aucun résultat.

Pour plus d’informations, consultez Balisage des ressources Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous AddTagsToResourceà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserassociate-ops-item-related-item.

AWS CLI

Pour associer un article connexe

L'associate-ops-item-related-itemexemple suivant associe un élément associé au OpsItem.

aws ssm associate-ops-item-related-item \ --ops-item-id "oi-649fExample" \ --association-type "RelatesTo" \ --resource-type "AWS::SSMIncidents::IncidentRecord" \ --resource-uri "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/c2bde883-f7d5-343a-b13a-bf5fe9ea689f"

Sortie :

{ "AssociationId": "61d7178d-a30d-4bc5-9b4e-a9e74EXAMPLE" }

Pour plus d'informations, consultez la section Working with Incident Manager incidents OpsCenter dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserassociate-ops-item-related-item.

AWS CLI

Pour associer un article connexe

L'associate-ops-item-related-itemexemple suivant associe un élément associé au OpsItem.

aws ssm associate-ops-item-related-item \ --ops-item-id "oi-649fExample" \ --association-type "RelatesTo" \ --resource-type "AWS::SSMIncidents::IncidentRecord" \ --resource-uri "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/c2bde883-f7d5-343a-b13a-bf5fe9ea689f"

Sortie :

{ "AssociationId": "61d7178d-a30d-4bc5-9b4e-a9e74EXAMPLE" }

Pour plus d'informations, consultez la section Working with Incident Manager incidents OpsCenter dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utilisercancel-command.

AWS CLI

Exemple 1 : annulation d’une commande pour toutes les instances

L’exemple de cancel-command suivant tente d’annuler la commande spécifiée qui est déjà en cours d’exécution pour toutes les instances.

aws ssm cancel-command \ --command-id "662add3d-5831-4a10-b64a-f2ff3EXAMPLE"

Cette commande ne produit aucun résultat.

Exemple 2 : annulation d’une commande pour des instances spécifiques

L’exemple de cancel-command suivant tente d’annuler une commande pour l’instance spécifiée uniquement.

aws ssm cancel-command \ --command-id "662add3d-5831-4a10-b64a-f2ff3EXAMPLE" --instance-ids "i-02573cafcfEXAMPLE"

Cette commande ne produit aucun résultat.

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

  • Pour plus de détails sur l'API, reportez-vous CancelCommandà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercancel-command.

AWS CLI

Exemple 1 : annulation d’une commande pour toutes les instances

L’exemple de cancel-command suivant tente d’annuler la commande spécifiée qui est déjà en cours d’exécution pour toutes les instances.

aws ssm cancel-command \ --command-id "662add3d-5831-4a10-b64a-f2ff3EXAMPLE"

Cette commande ne produit aucun résultat.

Exemple 2 : annulation d’une commande pour des instances spécifiques

L’exemple de cancel-command suivant tente d’annuler une commande pour l’instance spécifiée uniquement.

aws ssm cancel-command \ --command-id "662add3d-5831-4a10-b64a-f2ff3EXAMPLE" --instance-ids "i-02573cafcfEXAMPLE"

Cette commande ne produit aucun résultat.

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

  • Pour plus de détails sur l'API, reportez-vous CancelCommandà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercancel-maintenance-window-execution.

AWS CLI

Pour annuler l'exécution d'une fenêtre de maintenance

Cet cancel-maintenance-window-execution exemple arrête l'exécution de la fenêtre de maintenance spécifiée qui est déjà en cours.

aws ssm cancel-maintenance-window-execution \ --window-execution-id j2l8d5b5c-mw66-tk4d-r3g9-1d4d1EXAMPLE

Sortie :

{ "WindowExecutionId": "j2l8d5b5c-mw66-tk4d-r3g9-1d4d1EXAMPLE" }

Pour plus d'informations, consultez les didacticiels Windows (AWS CLI) de maintenance de Systems Manager dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utilisercancel-maintenance-window-execution.

AWS CLI

Pour annuler l'exécution d'une fenêtre de maintenance

Cet cancel-maintenance-window-execution exemple arrête l'exécution de la fenêtre de maintenance spécifiée qui est déjà en cours.

aws ssm cancel-maintenance-window-execution \ --window-execution-id j2l8d5b5c-mw66-tk4d-r3g9-1d4d1EXAMPLE

Sortie :

{ "WindowExecutionId": "j2l8d5b5c-mw66-tk4d-r3g9-1d4d1EXAMPLE" }

Pour plus d'informations, consultez les didacticiels Windows (AWS CLI) de maintenance de Systems Manager dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utilisercreate-activation.

AWS CLI

Pour créer une activation d’instance gérée

L’exemple de create-activation suivant crée une activation d’instance gérée.

aws ssm create-activation \ --default-instance-name "HybridWebServers" \ --iam-role "HybridWebServersRole" \ --registration-limit 5

Sortie :

{ "ActivationId": "5743558d-563b-4457-8682-d16c3EXAMPLE", "ActivationCode": "dRmgnYaFv567vEXAMPLE" }

Pour plus d’informations, consultez Étape 4 : créer une activation d’instance gérée pour un environnement hybride dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous CreateActivationà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-activation.

AWS CLI

Pour créer une activation d’instance gérée

L’exemple de create-activation suivant crée une activation d’instance gérée.

aws ssm create-activation \ --default-instance-name "HybridWebServers" \ --iam-role "HybridWebServersRole" \ --registration-limit 5

Sortie :

{ "ActivationId": "5743558d-563b-4457-8682-d16c3EXAMPLE", "ActivationCode": "dRmgnYaFv567vEXAMPLE" }

Pour plus d’informations, consultez Étape 4 : créer une activation d’instance gérée pour un environnement hybride dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous CreateActivationà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-association-batch.

AWS CLI

Pour créer plusieurs associations

Cet exemple associe un document de configuration à plusieurs instances. La sortie renvoie une liste des opérations réussies et échouées, le cas échéant.

Commande :

aws ssm create-association-batch --entries "Name=AWS-UpdateSSMAgent,InstanceId=i-1234567890abcdef0" "Name=AWS-UpdateSSMAgent,InstanceId=i-9876543210abcdef0"

Sortie :

{ "Successful": [ { "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-1234567890abcdef0", "AssociationVersion": "1", "Date": 1550504725.007, "LastUpdateAssociationDate": 1550504725.007, "Status": { "Date": 1550504725.007, "Name": "Associated", "Message": "Associated with AWS-UpdateSSMAgent" }, "Overview": { "Status": "Pending", "DetailedStatus": "Creating" }, "DocumentVersion": "$DEFAULT", "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "Targets": [ { "Key": "InstanceIds", "Values": [ "i-1234567890abcdef0" ] } ] }, { "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-9876543210abcdef0", "AssociationVersion": "1", "Date": 1550504725.057, "LastUpdateAssociationDate": 1550504725.057, "Status": { "Date": 1550504725.057, "Name": "Associated", "Message": "Associated with AWS-UpdateSSMAgent" }, "Overview": { "Status": "Pending", "DetailedStatus": "Creating" }, "DocumentVersion": "$DEFAULT", "AssociationId": "9c9f7f20-5154-4fed-a83e-0123456789ab", "Targets": [ { "Key": "InstanceIds", "Values": [ "i-9876543210abcdef0" ] } ] } ], "Failed": [] }
  • Pour plus de détails sur l'API, reportez-vous CreateAssociationBatchà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-association-batch.

AWS CLI

Pour créer plusieurs associations

Cet exemple associe un document de configuration à plusieurs instances. La sortie renvoie une liste des opérations réussies et échouées, le cas échéant.

Commande :

aws ssm create-association-batch --entries "Name=AWS-UpdateSSMAgent,InstanceId=i-1234567890abcdef0" "Name=AWS-UpdateSSMAgent,InstanceId=i-9876543210abcdef0"

Sortie :

{ "Successful": [ { "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-1234567890abcdef0", "AssociationVersion": "1", "Date": 1550504725.007, "LastUpdateAssociationDate": 1550504725.007, "Status": { "Date": 1550504725.007, "Name": "Associated", "Message": "Associated with AWS-UpdateSSMAgent" }, "Overview": { "Status": "Pending", "DetailedStatus": "Creating" }, "DocumentVersion": "$DEFAULT", "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "Targets": [ { "Key": "InstanceIds", "Values": [ "i-1234567890abcdef0" ] } ] }, { "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-9876543210abcdef0", "AssociationVersion": "1", "Date": 1550504725.057, "LastUpdateAssociationDate": 1550504725.057, "Status": { "Date": 1550504725.057, "Name": "Associated", "Message": "Associated with AWS-UpdateSSMAgent" }, "Overview": { "Status": "Pending", "DetailedStatus": "Creating" }, "DocumentVersion": "$DEFAULT", "AssociationId": "9c9f7f20-5154-4fed-a83e-0123456789ab", "Targets": [ { "Key": "InstanceIds", "Values": [ "i-9876543210abcdef0" ] } ] } ], "Failed": [] }
  • Pour plus de détails sur l'API, reportez-vous CreateAssociationBatchà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-association.

AWS CLI

Exemple 1 : pour associer un document à l'aide d'une instance IDs

Cet exemple associe un document de configuration à une instance, en utilisant l'instance IDs.

aws ssm create-association \ --instance-id "i-0cb2b964d3e14fd9f" \ --name "AWS-UpdateSSMAgent"

Sortie :

{ "AssociationDescription": { "Status": { "Date": 1487875500.33, "Message": "Associated with AWS-UpdateSSMAgent", "Name": "Associated" }, "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-0cb2b964d3e14fd9f", "Overview": { "Status": "Pending", "DetailedStatus": "Creating" }, "AssociationId": "b7c3266e-a544-44db-877e-b20d3a108189", "DocumentVersion": "$DEFAULT", "LastUpdateAssociationDate": 1487875500.33, "Date": 1487875500.33, "Targets": [ { "Values": [ "i-0cb2b964d3e14fd9f" ], "Key": "InstanceIds" } ] } }

Pour plus d'informations, consultez CreateAssociationla référence de l'API AWS Systems Manager.

Exemple 2 : association d’un document à l’aide des cibles

Cet exemple associe un document de configuration à une instance à l’aide des cibles.

aws ssm create-association \ --name "AWS-UpdateSSMAgent" \ --targets "Key=instanceids,Values=i-0cb2b964d3e14fd9f"

Sortie :

{ "AssociationDescription": { "Status": { "Date": 1487875500.33, "Message": "Associated with AWS-UpdateSSMAgent", "Name": "Associated" }, "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-0cb2b964d3e14fd9f", "Overview": { "Status": "Pending", "DetailedStatus": "Creating" }, "AssociationId": "b7c3266e-a544-44db-877e-b20d3a108189", "DocumentVersion": "$DEFAULT", "LastUpdateAssociationDate": 1487875500.33, "Date": 1487875500.33, "Targets": [ { "Values": [ "i-0cb2b964d3e14fd9f" ], "Key": "InstanceIds" } ] } }

Pour plus d'informations, consultez CreateAssociationla référence de l'API AWS Systems Manager.

Exemple 3 : création d’une association qui ne s’exécute qu’une seule fois

Cet exemple crée une nouvelle association qui ne s’exécute qu’une seule fois à la date et à l’heure spécifiées. Les associations créées avec une date passée ou présente (au moment du traitement, la date est passée) sont exécutées immédiatement.

aws ssm create-association \ --name "AWS-UpdateSSMAgent" \ --targets "Key=instanceids,Values=i-0cb2b964d3e14fd9f" \ --schedule-expression "at(2020-05-14T15:55:00)" \ --apply-only-at-cron-interval

Sortie :

{ "AssociationDescription": { "Status": { "Date": 1487875500.33, "Message": "Associated with AWS-UpdateSSMAgent", "Name": "Associated" }, "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-0cb2b964d3e14fd9f", "Overview": { "Status": "Pending", "DetailedStatus": "Creating" }, "AssociationId": "b7c3266e-a544-44db-877e-b20d3a108189", "DocumentVersion": "$DEFAULT", "LastUpdateAssociationDate": 1487875500.33, "Date": 1487875500.33, "Targets": [ { "Values": [ "i-0cb2b964d3e14fd9f" ], "Key": "InstanceIds" } ] } }

Pour plus d'informations, reportez-vous CreateAssociationà la section Référence de l'API AWS Systems Manager ou Reference : Cron and rate expressions for Systems Manager dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous CreateAssociationà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-association.

AWS CLI

Exemple 1 : pour associer un document à l'aide d'une instance IDs

Cet exemple associe un document de configuration à une instance, en utilisant l'instance IDs.

aws ssm create-association \ --instance-id "i-0cb2b964d3e14fd9f" \ --name "AWS-UpdateSSMAgent"

Sortie :

{ "AssociationDescription": { "Status": { "Date": 1487875500.33, "Message": "Associated with AWS-UpdateSSMAgent", "Name": "Associated" }, "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-0cb2b964d3e14fd9f", "Overview": { "Status": "Pending", "DetailedStatus": "Creating" }, "AssociationId": "b7c3266e-a544-44db-877e-b20d3a108189", "DocumentVersion": "$DEFAULT", "LastUpdateAssociationDate": 1487875500.33, "Date": 1487875500.33, "Targets": [ { "Values": [ "i-0cb2b964d3e14fd9f" ], "Key": "InstanceIds" } ] } }

Pour plus d'informations, consultez CreateAssociationla référence de l'API AWS Systems Manager.

Exemple 2 : association d’un document à l’aide des cibles

Cet exemple associe un document de configuration à une instance à l’aide des cibles.

aws ssm create-association \ --name "AWS-UpdateSSMAgent" \ --targets "Key=instanceids,Values=i-0cb2b964d3e14fd9f"

Sortie :

{ "AssociationDescription": { "Status": { "Date": 1487875500.33, "Message": "Associated with AWS-UpdateSSMAgent", "Name": "Associated" }, "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-0cb2b964d3e14fd9f", "Overview": { "Status": "Pending", "DetailedStatus": "Creating" }, "AssociationId": "b7c3266e-a544-44db-877e-b20d3a108189", "DocumentVersion": "$DEFAULT", "LastUpdateAssociationDate": 1487875500.33, "Date": 1487875500.33, "Targets": [ { "Values": [ "i-0cb2b964d3e14fd9f" ], "Key": "InstanceIds" } ] } }

Pour plus d'informations, consultez CreateAssociationla référence de l'API AWS Systems Manager.

Exemple 3 : création d’une association qui ne s’exécute qu’une seule fois

Cet exemple crée une nouvelle association qui ne s’exécute qu’une seule fois à la date et à l’heure spécifiées. Les associations créées avec une date passée ou présente (au moment du traitement, la date est passée) sont exécutées immédiatement.

aws ssm create-association \ --name "AWS-UpdateSSMAgent" \ --targets "Key=instanceids,Values=i-0cb2b964d3e14fd9f" \ --schedule-expression "at(2020-05-14T15:55:00)" \ --apply-only-at-cron-interval

Sortie :

{ "AssociationDescription": { "Status": { "Date": 1487875500.33, "Message": "Associated with AWS-UpdateSSMAgent", "Name": "Associated" }, "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-0cb2b964d3e14fd9f", "Overview": { "Status": "Pending", "DetailedStatus": "Creating" }, "AssociationId": "b7c3266e-a544-44db-877e-b20d3a108189", "DocumentVersion": "$DEFAULT", "LastUpdateAssociationDate": 1487875500.33, "Date": 1487875500.33, "Targets": [ { "Values": [ "i-0cb2b964d3e14fd9f" ], "Key": "InstanceIds" } ] } }

Pour plus d'informations, reportez-vous CreateAssociationà la section Référence de l'API AWS Systems Manager ou Reference : Cron and rate expressions for Systems Manager dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous CreateAssociationà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-document.

AWS CLI

Pour créer un document

L’exemple de create-document suivant crée un document Systems Manager.

aws ssm create-document \ --content file://exampleDocument.yml \ --name "Example" \ --document-type "Automation" \ --document-format YAML

Sortie :

{ "DocumentDescription": { "Hash": "fc2410281f40779e694a8b95975d0f9f316da8a153daa94e3d9921102EXAMPLE", "HashType": "Sha256", "Name": "Example", "Owner": "29884EXAMPLE", "CreatedDate": 1583256349.452, "Status": "Creating", "DocumentVersion": "1", "Description": "Document Example", "Parameters": [ { "Name": "AutomationAssumeRole", "Type": "String", "Description": "(Required) The ARN of the role that allows Automation to perform the actions on your behalf. If no role is specified, Systems Manager Automation uses your IAM permissions to execute this document.", "DefaultValue": "" }, { "Name": "InstanceId", "Type": "String", "Description": "(Required) The ID of the Amazon EC2 instance.", "DefaultValue": "" } ], "PlatformTypes": [ "Windows", "Linux" ], "DocumentType": "Automation", "SchemaVersion": "0.3", "LatestVersion": "1", "DefaultVersion": "1", "DocumentFormat": "YAML", "Tags": [] } }

Pour plus d’informations, consultez Création de documents Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous CreateDocumentà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-document.

AWS CLI

Pour créer un document

L’exemple de create-document suivant crée un document Systems Manager.

aws ssm create-document \ --content file://exampleDocument.yml \ --name "Example" \ --document-type "Automation" \ --document-format YAML

Sortie :

{ "DocumentDescription": { "Hash": "fc2410281f40779e694a8b95975d0f9f316da8a153daa94e3d9921102EXAMPLE", "HashType": "Sha256", "Name": "Example", "Owner": "29884EXAMPLE", "CreatedDate": 1583256349.452, "Status": "Creating", "DocumentVersion": "1", "Description": "Document Example", "Parameters": [ { "Name": "AutomationAssumeRole", "Type": "String", "Description": "(Required) The ARN of the role that allows Automation to perform the actions on your behalf. If no role is specified, Systems Manager Automation uses your IAM permissions to execute this document.", "DefaultValue": "" }, { "Name": "InstanceId", "Type": "String", "Description": "(Required) The ID of the Amazon EC2 instance.", "DefaultValue": "" } ], "PlatformTypes": [ "Windows", "Linux" ], "DocumentType": "Automation", "SchemaVersion": "0.3", "LatestVersion": "1", "DefaultVersion": "1", "DocumentFormat": "YAML", "Tags": [] } }

Pour plus d’informations, consultez Création de documents Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous CreateDocumentà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-maintenance-window.

AWS CLI

Exemple 1 : création d’une fenêtre de maintenance

L’exemple de create-maintenance-window suivant crée une nouvelle fenêtre de maintenance qui s’exécute toutes les cinq minutes pendant une durée maximale de deux heures (selon les besoins), empêche le démarrage de nouvelles tâches dans l’heure qui suit la fin de l’exécution de la fenêtre de maintenance, autorise les cibles non associées (instances que vous n’avez pas enregistrées avec la fenêtre de maintenance) et indique, par le biais de balises personnalisées, que son créateur a l’intention de l’utiliser dans le cadre d’un tutoriel.

aws ssm create-maintenance-window \ --name "My-Tutorial-Maintenance-Window" \ --schedule "rate(5 minutes)" \ --duration 2 --cutoff 1 \ --allow-unassociated-targets \ --tags "Key=Purpose,Value=Tutorial"

Sortie :

{ "WindowId": "mw-0c50858d01EXAMPLE" }

Exemple 2 : pour créer une fenêtre de maintenance qui ne s’exécute qu’une seule fois

L’exemple de create-maintenance-window suivant crée une nouvelle fenêtre de maintenance qui ne s’exécute qu’une seule fois à la date et à l’heure spécifiées.

aws ssm create-maintenance-window \ --name My-One-Time-Maintenance-Window \ --schedule "at(2020-05-14T15:55:00)" \ --duration 5 \ --cutoff 2 \ --allow-unassociated-targets \ --tags "Key=Environment,Value=Production"

Sortie :

{ "WindowId": "mw-01234567890abcdef" }

Pour plus d’informations, consultez Fenêtres de maintenance dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous CreateMaintenanceWindowà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-maintenance-window.

AWS CLI

Exemple 1 : création d’une fenêtre de maintenance

L’exemple de create-maintenance-window suivant crée une nouvelle fenêtre de maintenance qui s’exécute toutes les cinq minutes pendant une durée maximale de deux heures (selon les besoins), empêche le démarrage de nouvelles tâches dans l’heure qui suit la fin de l’exécution de la fenêtre de maintenance, autorise les cibles non associées (instances que vous n’avez pas enregistrées avec la fenêtre de maintenance) et indique, par le biais de balises personnalisées, que son créateur a l’intention de l’utiliser dans le cadre d’un tutoriel.

aws ssm create-maintenance-window \ --name "My-Tutorial-Maintenance-Window" \ --schedule "rate(5 minutes)" \ --duration 2 --cutoff 1 \ --allow-unassociated-targets \ --tags "Key=Purpose,Value=Tutorial"

Sortie :

{ "WindowId": "mw-0c50858d01EXAMPLE" }

Exemple 2 : pour créer une fenêtre de maintenance qui ne s’exécute qu’une seule fois

L’exemple de create-maintenance-window suivant crée une nouvelle fenêtre de maintenance qui ne s’exécute qu’une seule fois à la date et à l’heure spécifiées.

aws ssm create-maintenance-window \ --name My-One-Time-Maintenance-Window \ --schedule "at(2020-05-14T15:55:00)" \ --duration 5 \ --cutoff 2 \ --allow-unassociated-targets \ --tags "Key=Environment,Value=Production"

Sortie :

{ "WindowId": "mw-01234567890abcdef" }

Pour plus d’informations, consultez Fenêtres de maintenance dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous CreateMaintenanceWindowà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-ops-item.

AWS CLI

Pour créer un OpsItems

L'create-ops-itemexemple suivant utilise the /aws/resources key in OperationalData pour créer un OpsItem avec une ressource associée à Amazon DynamoDB.

aws ssm create-ops-item \ --title "EC2 instance disk full" \ --description "Log clean up may have failed which caused the disk to be full" \ --priority 2 \ --source ec2 \ --operational-data '{"/aws/resources":{"Value":"[{\"arn\": \"arn:aws:dynamodb:us-west-2:12345678:table/OpsItems\"}]","Type":"SearchableString"}}' \ --notifications Arn="arn:aws:sns:us-west-2:12345678:TestUser"

Sortie :

{ "OpsItemId": "oi-1a2b3c4d5e6f" }

Pour plus d'informations, voir Creating OpsItems in the AWS Systems Manager User Guide.

  • Pour plus de détails sur l'API, reportez-vous CreateOpsItemà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-ops-item.

AWS CLI

Pour créer un OpsItems

L'create-ops-itemexemple suivant utilise the /aws/resources key in OperationalData pour créer un OpsItem avec une ressource associée à Amazon DynamoDB.

aws ssm create-ops-item \ --title "EC2 instance disk full" \ --description "Log clean up may have failed which caused the disk to be full" \ --priority 2 \ --source ec2 \ --operational-data '{"/aws/resources":{"Value":"[{\"arn\": \"arn:aws:dynamodb:us-west-2:12345678:table/OpsItems\"}]","Type":"SearchableString"}}' \ --notifications Arn="arn:aws:sns:us-west-2:12345678:TestUser"

Sortie :

{ "OpsItemId": "oi-1a2b3c4d5e6f" }

Pour plus d'informations, voir Creating OpsItems in the AWS Systems Manager User Guide.

  • Pour plus de détails sur l'API, reportez-vous CreateOpsItemà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-patch-baseline.

AWS CLI

Exemple 1 : création d’un référentiel de correctifs avec approbation automatique

L’exemple de create-patch-baseline suivant crée un référentiel de correctifs pour Windows Server qui approuve les correctifs pour un environnement de production sept jours après leur publication par Microsoft.

aws ssm create-patch-baseline \ --name "Windows-Production-Baseline-AutoApproval" \ --operating-system "WINDOWS" \ --approval-rules "PatchRules=[{PatchFilterGroup={PatchFilters=[{Key=MSRC_SEVERITY,Values=[Critical,Important,Moderate]},{Key=CLASSIFICATION,Values=[SecurityUpdates,Updates,UpdateRollups,CriticalUpdates]}]},ApproveAfterDays=7}]" \ --description "Baseline containing all updates approved for Windows Server production systems"

Sortie :

{ "BaselineId": "pb-045f10b4f3EXAMPLE" }

Exemple 2 : création d’un référentiel de correctifs avec une date limite d’approbation

L’exemple de create-patch-baseline suivant crée un référentiel de correctifs pour Windows Server qui approuve tous les correctifs pour un environnement de production qui sont publiés au plus tard le 7 juillet 2020.

aws ssm create-patch-baseline \ --name "Windows-Production-Baseline-AutoApproval" \ --operating-system "WINDOWS" \ --approval-rules "PatchRules=[{PatchFilterGroup={PatchFilters=[{Key=MSRC_SEVERITY,Values=[Critical,Important,Moderate]},{Key=CLASSIFICATION,Values=[SecurityUpdates,Updates,UpdateRollups,CriticalUpdates]}]},ApproveUntilDate=2020-07-07}]" \ --description "Baseline containing all updates approved for Windows Server production systems"

Sortie :

{ "BaselineId": "pb-045f10b4f3EXAMPLE" }

Exemple 3 : création d’un référentiel de correctifs avec des règles d’approbation stockées dans un fichier JSON

L’exemple de create-patch-baseline suivant crée un référentiel de correctifs pour Amazon Linux 2017.09 qui approuve les correctifs pour un environnement de production sept jours après leur publication, spécifie des règles d’approbation pour le référentiel de correctifs et spécifie un référentiel personnalisé pour les correctifs.

aws ssm create-patch-baseline \ --cli-input-json file://my-amazon-linux-approval-rules-and-repo.json

Contenu de my-amazon-linux-approval-rules-and-repo.json :

{ "Name": "Amazon-Linux-2017.09-Production-Baseline", "Description": "My approval rules patch baseline for Amazon Linux 2017.09 instances", "OperatingSystem": "AMAZON_LINUX", "Tags": [ { "Key": "Environment", "Value": "Production" } ], "ApprovalRules": { "PatchRules": [ { "ApproveAfterDays": 7, "EnableNonSecurity": true, "PatchFilterGroup": { "PatchFilters": [ { "Key": "SEVERITY", "Values": [ "Important", "Critical" ] }, { "Key": "CLASSIFICATION", "Values": [ "Security", "Bugfix" ] }, { "Key": "PRODUCT", "Values": [ "AmazonLinux2017.09" ] } ] } } ] }, "Sources": [ { "Name": "My-AL2017.09", "Products": [ "AmazonLinux2017.09" ], "Configuration": "[amzn-main] \nname=amzn-main-Base\nmirrorlist=http://repo./$awsregion./$awsdomain//$releasever/main/mirror.list //nmirrorlist_expire=300//nmetadata_expire=300 \npriority=10 \nfailovermethod=priority \nfastestmirror_enabled=0 \ngpgcheck=1 \ngpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-amazon-ga \nenabled=1 \nretries=3 \ntimeout=5\nreport_instanceid=yes" } ] }

Exemple 4 : création d’un référentiel de correctifs qui spécifie les correctifs approuvés et rejetés

L’exemple de create-patch-baseline suivant spécifie explicitement les correctifs à approuver et à rejeter en tant qu’exception aux règles d’approbation par défaut.

aws ssm create-patch-baseline \ --name "Amazon-Linux-2017.09-Alpha-Baseline" \ --description "My custom approve/reject patch baseline for Amazon Linux 2017.09 instances" \ --operating-system "AMAZON_LINUX" \ --approved-patches "CVE-2018-1234567,example-pkg-EE-2018*.amzn1.noarch" \ --approved-patches-compliance-level "HIGH" \ --approved-patches-enable-non-security \ --tags "Key=Environment,Value=Alpha"

Pour plus d’informations, consultez Créer un référentiel de correctifs personnalisé dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous CreatePatchBaselineà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-patch-baseline.

AWS CLI

Exemple 1 : création d’un référentiel de correctifs avec approbation automatique

L’exemple de create-patch-baseline suivant crée un référentiel de correctifs pour Windows Server qui approuve les correctifs pour un environnement de production sept jours après leur publication par Microsoft.

aws ssm create-patch-baseline \ --name "Windows-Production-Baseline-AutoApproval" \ --operating-system "WINDOWS" \ --approval-rules "PatchRules=[{PatchFilterGroup={PatchFilters=[{Key=MSRC_SEVERITY,Values=[Critical,Important,Moderate]},{Key=CLASSIFICATION,Values=[SecurityUpdates,Updates,UpdateRollups,CriticalUpdates]}]},ApproveAfterDays=7}]" \ --description "Baseline containing all updates approved for Windows Server production systems"

Sortie :

{ "BaselineId": "pb-045f10b4f3EXAMPLE" }

Exemple 2 : création d’un référentiel de correctifs avec une date limite d’approbation

L’exemple de create-patch-baseline suivant crée un référentiel de correctifs pour Windows Server qui approuve tous les correctifs pour un environnement de production qui sont publiés au plus tard le 7 juillet 2020.

aws ssm create-patch-baseline \ --name "Windows-Production-Baseline-AutoApproval" \ --operating-system "WINDOWS" \ --approval-rules "PatchRules=[{PatchFilterGroup={PatchFilters=[{Key=MSRC_SEVERITY,Values=[Critical,Important,Moderate]},{Key=CLASSIFICATION,Values=[SecurityUpdates,Updates,UpdateRollups,CriticalUpdates]}]},ApproveUntilDate=2020-07-07}]" \ --description "Baseline containing all updates approved for Windows Server production systems"

Sortie :

{ "BaselineId": "pb-045f10b4f3EXAMPLE" }

Exemple 3 : création d’un référentiel de correctifs avec des règles d’approbation stockées dans un fichier JSON

L’exemple de create-patch-baseline suivant crée un référentiel de correctifs pour Amazon Linux 2017.09 qui approuve les correctifs pour un environnement de production sept jours après leur publication, spécifie des règles d’approbation pour le référentiel de correctifs et spécifie un référentiel personnalisé pour les correctifs.

aws ssm create-patch-baseline \ --cli-input-json file://my-amazon-linux-approval-rules-and-repo.json

Contenu de my-amazon-linux-approval-rules-and-repo.json :

{ "Name": "Amazon-Linux-2017.09-Production-Baseline", "Description": "My approval rules patch baseline for Amazon Linux 2017.09 instances", "OperatingSystem": "AMAZON_LINUX", "Tags": [ { "Key": "Environment", "Value": "Production" } ], "ApprovalRules": { "PatchRules": [ { "ApproveAfterDays": 7, "EnableNonSecurity": true, "PatchFilterGroup": { "PatchFilters": [ { "Key": "SEVERITY", "Values": [ "Important", "Critical" ] }, { "Key": "CLASSIFICATION", "Values": [ "Security", "Bugfix" ] }, { "Key": "PRODUCT", "Values": [ "AmazonLinux2017.09" ] } ] } } ] }, "Sources": [ { "Name": "My-AL2017.09", "Products": [ "AmazonLinux2017.09" ], "Configuration": "[amzn-main] \nname=amzn-main-Base\nmirrorlist=http://repo./$awsregion./$awsdomain//$releasever/main/mirror.list //nmirrorlist_expire=300//nmetadata_expire=300 \npriority=10 \nfailovermethod=priority \nfastestmirror_enabled=0 \ngpgcheck=1 \ngpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-amazon-ga \nenabled=1 \nretries=3 \ntimeout=5\nreport_instanceid=yes" } ] }

Exemple 4 : création d’un référentiel de correctifs qui spécifie les correctifs approuvés et rejetés

L’exemple de create-patch-baseline suivant spécifie explicitement les correctifs à approuver et à rejeter en tant qu’exception aux règles d’approbation par défaut.

aws ssm create-patch-baseline \ --name "Amazon-Linux-2017.09-Alpha-Baseline" \ --description "My custom approve/reject patch baseline for Amazon Linux 2017.09 instances" \ --operating-system "AMAZON_LINUX" \ --approved-patches "CVE-2018-1234567,example-pkg-EE-2018*.amzn1.noarch" \ --approved-patches-compliance-level "HIGH" \ --approved-patches-enable-non-security \ --tags "Key=Environment,Value=Alpha"

Pour plus d’informations, consultez Créer un référentiel de correctifs personnalisé dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous CreatePatchBaselineà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-resource-data-sync.

AWS CLI

Pour créer une synchronisation des données de ressources

Cet exemple crée une synchronisation des données de ressources. Il n’y a pas de sortie si la commande réussit.

Commande :

aws ssm create-resource-data-sync --sync-name "ssm-resource-data-sync" --s3-destination "BucketName=ssm-bucket,Prefix=inventory,SyncFormat=JsonSerDe,Region=us-east-1"
  • Pour plus de détails sur l'API, reportez-vous CreateResourceDataSyncà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-resource-data-sync.

AWS CLI

Pour créer une synchronisation des données de ressources

Cet exemple crée une synchronisation des données de ressources. Il n’y a pas de sortie si la commande réussit.

Commande :

aws ssm create-resource-data-sync --sync-name "ssm-resource-data-sync" --s3-destination "BucketName=ssm-bucket,Prefix=inventory,SyncFormat=JsonSerDe,Region=us-east-1"
  • Pour plus de détails sur l'API, reportez-vous CreateResourceDataSyncà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-activation.

AWS CLI

Pour supprimer une activation d’instance gérée

L’exemple de delete-activation suivant supprime l’activation d’une instance gérée.

aws ssm delete-activation \ --activation-id "aa673477-d926-42c1-8757-1358cEXAMPLE"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Configuration de AWS Systems Manager pour les environnements hybrides dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous DeleteActivationà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-activation.

AWS CLI

Pour supprimer une activation d’instance gérée

L’exemple de delete-activation suivant supprime l’activation d’une instance gérée.

aws ssm delete-activation \ --activation-id "aa673477-d926-42c1-8757-1358cEXAMPLE"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Configuration de AWS Systems Manager pour les environnements hybrides dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous DeleteActivationà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-association.

AWS CLI

Exemple 1 : suppression d’une association en utilisant l’ID d’association

L’exemple de delete-association suivant supprime l’association pour l’ID d’association spécifié. Il n’y a pas de sortie si la commande réussit.

aws ssm delete-association \ --association-id "8dfe3659-4309-493a-8755-0123456789ab"

Cette commande ne produit aucun résultat.

Pour plus d’informations, consultez Modifier et créer une nouvelle version d’une association (français non garanti) dans le AWS Guide de l’utilisateur Systems Manager (français non garanti).

Exemple 2 : suppression d’une association

L’exemple de delete-association suivant supprime l’association entre une instance et un document. Il n’y a pas de sortie si la commande réussit.

aws ssm delete-association \ --instance-id "i-1234567890abcdef0" \ --name "AWS-UpdateSSMAgent"

Cette commande ne produit aucun résultat.

Pour plus d’informations, consultez Utilisation des associations dans Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous DeleteAssociationà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-association.

AWS CLI

Exemple 1 : suppression d’une association en utilisant l’ID d’association

L’exemple de delete-association suivant supprime l’association pour l’ID d’association spécifié. Il n’y a pas de sortie si la commande réussit.

aws ssm delete-association \ --association-id "8dfe3659-4309-493a-8755-0123456789ab"

Cette commande ne produit aucun résultat.

Pour plus d’informations, consultez Modifier et créer une nouvelle version d’une association (français non garanti) dans le AWS Guide de l’utilisateur Systems Manager (français non garanti).

Exemple 2 : suppression d’une association

L’exemple de delete-association suivant supprime l’association entre une instance et un document. Il n’y a pas de sortie si la commande réussit.

aws ssm delete-association \ --instance-id "i-1234567890abcdef0" \ --name "AWS-UpdateSSMAgent"

Cette commande ne produit aucun résultat.

Pour plus d’informations, consultez Utilisation des associations dans Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous DeleteAssociationà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-document.

AWS CLI

Pour supprimer un document

L’exemple de delete-document suivant supprime un document Systems Manager.

aws ssm delete-document \ --name "Example"

Cette commande ne produit aucun résultat.

Pour plus d’informations, consultez Création de documents Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous DeleteDocumentà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-document.

AWS CLI

Pour supprimer un document

L’exemple de delete-document suivant supprime un document Systems Manager.

aws ssm delete-document \ --name "Example"

Cette commande ne produit aucun résultat.

Pour plus d’informations, consultez Création de documents Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous DeleteDocumentà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-inventory.

AWS CLI

Pour supprimer un type d'inventaire personnalisé

Cet exemple supprime un schéma d'inventaire personnalisé.

Commande :

aws ssm delete-inventory --type-name "Custom:RackInfo" --schema-delete-option "DeleteSchema"

Sortie :

{ "DeletionId": "d72ac9e8-1f60-4d40-b1c6-bf8c78c68c4d", "TypeName": "Custom:RackInfo", "DeletionSummary": { "TotalCount": 1, "RemainingCount": 1, "SummaryItems": [ { "Version": "1.0", "Count": 1, "RemainingCount": 1 } ] } }

Pour désactiver un type d'inventaire personnalisé

Cet exemple désactive un schéma d'inventaire personnalisé.

Commande :

aws ssm delete-inventory --type-name "Custom:RackInfo" --schema-delete-option "DisableSchema"

Sortie :

{ "DeletionId": "6961492a-8163-44ec-aa1e-923364dd0850", "TypeName": "Custom:RackInformation", "DeletionSummary": { "TotalCount": 0, "RemainingCount": 0, "SummaryItems": [] } }
  • Pour plus de détails sur l'API, reportez-vous DeleteInventoryà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-inventory.

AWS CLI

Pour supprimer un type d'inventaire personnalisé

Cet exemple supprime un schéma d'inventaire personnalisé.

Commande :

aws ssm delete-inventory --type-name "Custom:RackInfo" --schema-delete-option "DeleteSchema"

Sortie :

{ "DeletionId": "d72ac9e8-1f60-4d40-b1c6-bf8c78c68c4d", "TypeName": "Custom:RackInfo", "DeletionSummary": { "TotalCount": 1, "RemainingCount": 1, "SummaryItems": [ { "Version": "1.0", "Count": 1, "RemainingCount": 1 } ] } }

Pour désactiver un type d'inventaire personnalisé

Cet exemple désactive un schéma d'inventaire personnalisé.

Commande :

aws ssm delete-inventory --type-name "Custom:RackInfo" --schema-delete-option "DisableSchema"

Sortie :

{ "DeletionId": "6961492a-8163-44ec-aa1e-923364dd0850", "TypeName": "Custom:RackInformation", "DeletionSummary": { "TotalCount": 0, "RemainingCount": 0, "SummaryItems": [] } }
  • Pour plus de détails sur l'API, reportez-vous DeleteInventoryà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-maintenance-window.

AWS CLI

Pour supprimer une fenêtre de maintenance

Cet exemple de delete-maintenance-window supprime la fenêtre de maintenance spécifiée.

aws ssm delete-maintenance-window \ --window-id "mw-1a2b3c4d5e6f7g8h9"

Sortie :

{ "WindowId":"mw-1a2b3c4d5e6f7g8h9" }

Pour plus d'informations, voir Supprimer une fenêtre de maintenance (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous DeleteMaintenanceWindowà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-maintenance-window.

AWS CLI

Pour supprimer une fenêtre de maintenance

Cet exemple de delete-maintenance-window supprime la fenêtre de maintenance spécifiée.

aws ssm delete-maintenance-window \ --window-id "mw-1a2b3c4d5e6f7g8h9"

Sortie :

{ "WindowId":"mw-1a2b3c4d5e6f7g8h9" }

Pour plus d'informations, voir Supprimer une fenêtre de maintenance (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous DeleteMaintenanceWindowà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-parameter.

AWS CLI

Pour supprimer un paramètre

L’exemple de delete-parameter suivant supprime le paramètre unique spécifié.

aws ssm delete-parameter \ --name "MyParameter"

Cette commande ne produit aucun résultat.

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

  • Pour plus de détails sur l'API, reportez-vous DeleteParameterà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-parameter.

AWS CLI

Pour supprimer un paramètre

L’exemple de delete-parameter suivant supprime le paramètre unique spécifié.

aws ssm delete-parameter \ --name "MyParameter"

Cette commande ne produit aucun résultat.

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

  • Pour plus de détails sur l'API, reportez-vous DeleteParameterà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-parameters.

AWS CLI

Pour supprimer une liste de paramètres

L'delete-parametersexemple suivant supprime les paramètres spécifiés.

aws ssm delete-parameters \ --names "MyFirstParameter" "MySecondParameter" "MyInvalidParameterName"

Sortie :

{ "DeletedParameters": [ "MyFirstParameter", "MySecondParameter" ], "InvalidParameters": [ "MyInvalidParameterName" ] }

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

  • Pour plus de détails sur l'API, reportez-vous DeleteParametersà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-parameters.

AWS CLI

Pour supprimer une liste de paramètres

L'delete-parametersexemple suivant supprime les paramètres spécifiés.

aws ssm delete-parameters \ --names "MyFirstParameter" "MySecondParameter" "MyInvalidParameterName"

Sortie :

{ "DeletedParameters": [ "MyFirstParameter", "MySecondParameter" ], "InvalidParameters": [ "MyInvalidParameterName" ] }

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

  • Pour plus de détails sur l'API, reportez-vous DeleteParametersà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-patch-baseline.

AWS CLI

Pour supprimer un référentiel de correctifs

L’exemple de delete-patch-baseline suivant supprime le référentiel de correctifs spécifié.

aws ssm delete-patch-baseline \ --baseline-id "pb-045f10b4f382baeda"

Sortie :

{ "BaselineId": "pb-045f10b4f382baeda" }

Pour plus d’informations, consultez Mettre à jour ou supprimer un référentiel de correctifs (console) dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous DeletePatchBaselineà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-patch-baseline.

AWS CLI

Pour supprimer un référentiel de correctifs

L’exemple de delete-patch-baseline suivant supprime le référentiel de correctifs spécifié.

aws ssm delete-patch-baseline \ --baseline-id "pb-045f10b4f382baeda"

Sortie :

{ "BaselineId": "pb-045f10b4f382baeda" }

Pour plus d’informations, consultez Mettre à jour ou supprimer un référentiel de correctifs (console) dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous DeletePatchBaselineà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-resource-data-sync.

AWS CLI

Pour supprimer la synchronisation des données d'une ressource

Cet exemple supprime la synchronisation des données d'une ressource. Il n’y a pas de sortie si la commande réussit.

Commande :

aws ssm delete-resource-data-sync --sync-name "ssm-resource-data-sync"
  • Pour plus de détails sur l'API, reportez-vous DeleteResourceDataSyncà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-resource-data-sync.

AWS CLI

Pour supprimer la synchronisation des données d'une ressource

Cet exemple supprime la synchronisation des données d'une ressource. Il n’y a pas de sortie si la commande réussit.

Commande :

aws ssm delete-resource-data-sync --sync-name "ssm-resource-data-sync"
  • Pour plus de détails sur l'API, reportez-vous DeleteResourceDataSyncà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserderegister-managed-instance.

AWS CLI

Pour désenregistrer une instance gérée

L’exemple de deregister-managed-instance suivant désenregistre l’instance gérée spécifiée.

aws ssm deregister-managed-instance \ --instance-id 'mi-08ab247cdfEXAMPLE'

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Désenregistrement des nœuds gérés dans un environnement hybride et multicloud dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserderegister-managed-instance.

AWS CLI

Pour désenregistrer une instance gérée

L’exemple de deregister-managed-instance suivant désenregistre l’instance gérée spécifiée.

aws ssm deregister-managed-instance \ --instance-id 'mi-08ab247cdfEXAMPLE'

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Désenregistrement des nœuds gérés dans un environnement hybride et multicloud dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserderegister-patch-baseline-for-patch-group.

AWS CLI

Pour annuler l’enregistrement d’un groupe de correctifs à partir d’un référentiel de correctifs

L’exemple de deregister-patch-baseline-for-patch-group suivant désenregistre le groupe de correctifs spécifié du référentiel de correctifs spécifié.

aws ssm deregister-patch-baseline-for-patch-group \ --patch-group "Production" \ --baseline-id "pb-0ca44a362fEXAMPLE"

Sortie :

{ "PatchGroup":"Production", "BaselineId":"pb-0ca44a362fEXAMPLE" }

Pour plus d’informations, consultez Ajouter un groupe de correctifs à un référentiel de correctifs dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserderegister-patch-baseline-for-patch-group.

AWS CLI

Pour annuler l’enregistrement d’un groupe de correctifs à partir d’un référentiel de correctifs

L’exemple de deregister-patch-baseline-for-patch-group suivant désenregistre le groupe de correctifs spécifié du référentiel de correctifs spécifié.

aws ssm deregister-patch-baseline-for-patch-group \ --patch-group "Production" \ --baseline-id "pb-0ca44a362fEXAMPLE"

Sortie :

{ "PatchGroup":"Production", "BaselineId":"pb-0ca44a362fEXAMPLE" }

Pour plus d’informations, consultez Ajouter un groupe de correctifs à un référentiel de correctifs dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserderegister-target-from-maintenance-window.

AWS CLI

Pour supprimer une cible d’une fenêtre de maintenance

L’exemple de deregister-target-from-maintenance-window suivant supprime la cible spécifiée de la fenêtre de maintenance spécifiée.

aws ssm deregister-target-from-maintenance-window \ --window-id "mw-ab12cd34ef56gh78" \ --window-target-id "1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2"

Sortie :

{ "WindowId":"mw-ab12cd34ef56gh78", "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" }

Pour plus d'informations, voir Mettre à jour une fenêtre de maintenance (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserderegister-target-from-maintenance-window.

AWS CLI

Pour supprimer une cible d’une fenêtre de maintenance

L’exemple de deregister-target-from-maintenance-window suivant supprime la cible spécifiée de la fenêtre de maintenance spécifiée.

aws ssm deregister-target-from-maintenance-window \ --window-id "mw-ab12cd34ef56gh78" \ --window-target-id "1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2"

Sortie :

{ "WindowId":"mw-ab12cd34ef56gh78", "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" }

Pour plus d'informations, voir Mettre à jour une fenêtre de maintenance (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserderegister-task-from-maintenance-window.

AWS CLI

Pour supprimer une tâche d’une fenêtre de maintenance

L’exemple de deregister-task-from-maintenance-window suivant supprime la tâche spécifiée de la fenêtre de maintenance spécifiée.

aws ssm deregister-task-from-maintenance-window \ --window-id "mw-ab12cd34ef56gh78" \ --window-task-id "1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d5e6c"

Sortie :

{ "WindowTaskId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d5e6c", "WindowId":"mw-ab12cd34ef56gh78" }

Pour plus d'informations, consultez les didacticiels Windows (AWS CLI) de maintenance de Systems Manager dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserderegister-task-from-maintenance-window.

AWS CLI

Pour supprimer une tâche d’une fenêtre de maintenance

L’exemple de deregister-task-from-maintenance-window suivant supprime la tâche spécifiée de la fenêtre de maintenance spécifiée.

aws ssm deregister-task-from-maintenance-window \ --window-id "mw-ab12cd34ef56gh78" \ --window-task-id "1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d5e6c"

Sortie :

{ "WindowTaskId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d5e6c", "WindowId":"mw-ab12cd34ef56gh78" }

Pour plus d'informations, consultez les didacticiels Windows (AWS CLI) de maintenance de Systems Manager dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-activations.

AWS CLI

Pour décrire les activations

L'describe-activationsexemple suivant répertorie les informations relatives aux activations de votre AWS compte.

aws ssm describe-activations

Sortie :

{ "ActivationList": [ { "ActivationId": "5743558d-563b-4457-8682-d16c3EXAMPLE", "Description": "Example1", "IamRole": "HybridWebServersRole, "RegistrationLimit": 5, "RegistrationsCount": 5, "ExpirationDate": 1584316800.0, "Expired": false, "CreatedDate": 1581954699.792 }, { "ActivationId": "3ee0322b-f62d-40eb-b672-13ebfEXAMPLE", "Description": "Example2", "IamRole": "HybridDatabaseServersRole", "RegistrationLimit": 5, "RegistrationsCount": 5, "ExpirationDate": 1580515200.0, "Expired": true, "CreatedDate": 1578064132.002 }, ] }

Pour plus d’informations, consultez Étape 4 : créer une activation d’instance gérée pour un environnement hybride dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous DescribeActivationsà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-activations.

AWS CLI

Pour décrire les activations

L'describe-activationsexemple suivant répertorie les informations relatives aux activations de votre AWS compte.

aws ssm describe-activations

Sortie :

{ "ActivationList": [ { "ActivationId": "5743558d-563b-4457-8682-d16c3EXAMPLE", "Description": "Example1", "IamRole": "HybridWebServersRole, "RegistrationLimit": 5, "RegistrationsCount": 5, "ExpirationDate": 1584316800.0, "Expired": false, "CreatedDate": 1581954699.792 }, { "ActivationId": "3ee0322b-f62d-40eb-b672-13ebfEXAMPLE", "Description": "Example2", "IamRole": "HybridDatabaseServersRole", "RegistrationLimit": 5, "RegistrationsCount": 5, "ExpirationDate": 1580515200.0, "Expired": true, "CreatedDate": 1578064132.002 }, ] }

Pour plus d’informations, consultez Étape 4 : créer une activation d’instance gérée pour un environnement hybride dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous DescribeActivationsà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-association-execution-targets.

AWS CLI

Pour obtenir des détails sur l’exécution d’une association

L’exemple de describe-association-execution-targets suivant décrit l’exécution de l’association spécifiée.

aws ssm describe-association-execution-targets \ --association-id "8dfe3659-4309-493a-8755-0123456789ab" \ --execution-id "7abb6378-a4a5-4f10-8312-0123456789ab"

Sortie :

{ "AssociationExecutionTargets": [ { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "ExecutionId": "7abb6378-a4a5-4f10-8312-0123456789ab", "ResourceId": "i-1234567890abcdef0", "ResourceType": "ManagedInstance", "Status": "Success", "DetailedStatus": "Success", "LastExecutionDate": 1550505538.497, "OutputSource": { "OutputSourceId": "97fff367-fc5a-4299-aed8-0123456789ab", "OutputSourceType": "RunCommand" } } ] }

Pour plus d’informations, consultez Afficher l’historique des associations dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-association-execution-targets.

AWS CLI

Pour obtenir des détails sur l’exécution d’une association

L’exemple de describe-association-execution-targets suivant décrit l’exécution de l’association spécifiée.

aws ssm describe-association-execution-targets \ --association-id "8dfe3659-4309-493a-8755-0123456789ab" \ --execution-id "7abb6378-a4a5-4f10-8312-0123456789ab"

Sortie :

{ "AssociationExecutionTargets": [ { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "ExecutionId": "7abb6378-a4a5-4f10-8312-0123456789ab", "ResourceId": "i-1234567890abcdef0", "ResourceType": "ManagedInstance", "Status": "Success", "DetailedStatus": "Success", "LastExecutionDate": 1550505538.497, "OutputSource": { "OutputSourceId": "97fff367-fc5a-4299-aed8-0123456789ab", "OutputSourceType": "RunCommand" } } ] }

Pour plus d’informations, consultez Afficher l’historique des associations dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-association-executions.

AWS CLI

Exemple 1 : obtention des détails de toutes les exécutions d’une association

L’exemple de describe-association-executions suivant décrit toutes les exécutions de l’association spécifiée.

aws ssm describe-association-executions \ --association-id "8dfe3659-4309-493a-8755-0123456789ab"

Sortie :

{ "AssociationExecutions": [ { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "ExecutionId": "474925ef-1249-45a2-b93d-0123456789ab", "Status": "Success", "DetailedStatus": "Success", "CreatedTime": 1550505827.119, "ResourceCountByStatus": "{Success=1}" }, { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "ExecutionId": "7abb6378-a4a5-4f10-8312-0123456789ab", "Status": "Success", "DetailedStatus": "Success", "CreatedTime": 1550505536.843, "ResourceCountByStatus": "{Success=1}" }, ... ] }

Pour plus d’informations, consultez Afficher l’historique des associations dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 2 : obtention du détail de toutes les exécutions d’une association après une date et heure spécifiques

L’exemple de describe-association-executions suivant décrit toutes les exécutions d’une association après la date et l’heure spécifiées.

aws ssm describe-association-executions \ --association-id "8dfe3659-4309-493a-8755-0123456789ab" \ --filters "Key=CreatedTime,Value=2019-02-18T16:00:00Z,Type=GREATER_THAN"

Sortie :

{ "AssociationExecutions": [ { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "ExecutionId": "474925ef-1249-45a2-b93d-0123456789ab", "Status": "Success", "DetailedStatus": "Success", "CreatedTime": 1550505827.119, "ResourceCountByStatus": "{Success=1}" }, { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "ExecutionId": "7abb6378-a4a5-4f10-8312-0123456789ab", "Status": "Success", "DetailedStatus": "Success", "CreatedTime": 1550505536.843, "ResourceCountByStatus": "{Success=1}" }, ... ] }

Pour plus d’informations, consultez Afficher l’historique des associations dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-association-executions.

AWS CLI

Exemple 1 : obtention des détails de toutes les exécutions d’une association

L’exemple de describe-association-executions suivant décrit toutes les exécutions de l’association spécifiée.

aws ssm describe-association-executions \ --association-id "8dfe3659-4309-493a-8755-0123456789ab"

Sortie :

{ "AssociationExecutions": [ { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "ExecutionId": "474925ef-1249-45a2-b93d-0123456789ab", "Status": "Success", "DetailedStatus": "Success", "CreatedTime": 1550505827.119, "ResourceCountByStatus": "{Success=1}" }, { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "ExecutionId": "7abb6378-a4a5-4f10-8312-0123456789ab", "Status": "Success", "DetailedStatus": "Success", "CreatedTime": 1550505536.843, "ResourceCountByStatus": "{Success=1}" }, ... ] }

Pour plus d’informations, consultez Afficher l’historique des associations dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 2 : obtention du détail de toutes les exécutions d’une association après une date et heure spécifiques

L’exemple de describe-association-executions suivant décrit toutes les exécutions d’une association après la date et l’heure spécifiées.

aws ssm describe-association-executions \ --association-id "8dfe3659-4309-493a-8755-0123456789ab" \ --filters "Key=CreatedTime,Value=2019-02-18T16:00:00Z,Type=GREATER_THAN"

Sortie :

{ "AssociationExecutions": [ { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "ExecutionId": "474925ef-1249-45a2-b93d-0123456789ab", "Status": "Success", "DetailedStatus": "Success", "CreatedTime": 1550505827.119, "ResourceCountByStatus": "{Success=1}" }, { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "ExecutionId": "7abb6378-a4a5-4f10-8312-0123456789ab", "Status": "Success", "DetailedStatus": "Success", "CreatedTime": 1550505536.843, "ResourceCountByStatus": "{Success=1}" }, ... ] }

Pour plus d’informations, consultez Afficher l’historique des associations dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-association.

AWS CLI

Exemple 1 : obtention des détails d’une association

L’exemple de describe-association suivant décrit l’association pour l’ID d’association spécifié.

aws ssm describe-association \ --association-id "8dfe3659-4309-493a-8755-0123456789ab"

Sortie :

{ "AssociationDescription": { "Name": "AWS-GatherSoftwareInventory", "AssociationVersion": "1", "Date": 1534864780.995, "LastUpdateAssociationDate": 1543235759.81, "Overview": { "Status": "Success", "AssociationStatusAggregatedCount": { "Success": 2 } }, "DocumentVersion": "$DEFAULT", "Parameters": { "applications": [ "Enabled" ], "awsComponents": [ "Enabled" ], "customInventory": [ "Enabled" ], "files": [ "" ], "instanceDetailedInformation": [ "Enabled" ], "networkConfig": [ "Enabled" ], "services": [ "Enabled" ], "windowsRegistry": [ "" ], "windowsRoles": [ "Enabled" ], "windowsUpdates": [ "Enabled" ] }, "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "Targets": [ { "Key": "InstanceIds", "Values": [ "*" ] } ], "ScheduleExpression": "rate(24 hours)", "LastExecutionDate": 1550501886.0, "LastSuccessfulExecutionDate": 1550501886.0, "AssociationName": "Inventory-Association" } }

Pour plus d’informations, consultez Modifier et créer une nouvelle version d’une association (français non garanti) dans le AWS Guide de l’utilisateur Systems Manager (français non garanti).

Exemple 2 : obtention des détails d’une association pour une instance et un document spécifiques

L’exemple de describe-association suivant décrit l’association entre une instance et un document.

aws ssm describe-association \ --instance-id "i-1234567890abcdef0" \ --name "AWS-UpdateSSMAgent"

Sortie :

{ "AssociationDescription": { "Status": { "Date": 1487876122.564, "Message": "Associated with AWS-UpdateSSMAgent", "Name": "Associated" }, "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-1234567890abcdef0", "Overview": { "Status": "Pending", "DetailedStatus": "Associated", "AssociationStatusAggregatedCount": { "Pending": 1 } }, "AssociationId": "d8617c07-2079-4c18-9847-1234567890ab", "DocumentVersion": "$DEFAULT", "LastUpdateAssociationDate": 1487876122.564, "Date": 1487876122.564, "Targets": [ { "Values": [ "i-1234567890abcdef0" ], "Key": "InstanceIds" } ] } }

Pour plus d’informations, consultez Modifier et créer une nouvelle version d’une association (français non garanti) dans le AWS Guide de l’utilisateur Systems Manager (français non garanti).

  • Pour plus de détails sur l'API, reportez-vous DescribeAssociationà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-association.

AWS CLI

Exemple 1 : obtention des détails d’une association

L’exemple de describe-association suivant décrit l’association pour l’ID d’association spécifié.

aws ssm describe-association \ --association-id "8dfe3659-4309-493a-8755-0123456789ab"

Sortie :

{ "AssociationDescription": { "Name": "AWS-GatherSoftwareInventory", "AssociationVersion": "1", "Date": 1534864780.995, "LastUpdateAssociationDate": 1543235759.81, "Overview": { "Status": "Success", "AssociationStatusAggregatedCount": { "Success": 2 } }, "DocumentVersion": "$DEFAULT", "Parameters": { "applications": [ "Enabled" ], "awsComponents": [ "Enabled" ], "customInventory": [ "Enabled" ], "files": [ "" ], "instanceDetailedInformation": [ "Enabled" ], "networkConfig": [ "Enabled" ], "services": [ "Enabled" ], "windowsRegistry": [ "" ], "windowsRoles": [ "Enabled" ], "windowsUpdates": [ "Enabled" ] }, "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "Targets": [ { "Key": "InstanceIds", "Values": [ "*" ] } ], "ScheduleExpression": "rate(24 hours)", "LastExecutionDate": 1550501886.0, "LastSuccessfulExecutionDate": 1550501886.0, "AssociationName": "Inventory-Association" } }

Pour plus d’informations, consultez Modifier et créer une nouvelle version d’une association (français non garanti) dans le AWS Guide de l’utilisateur Systems Manager (français non garanti).

Exemple 2 : obtention des détails d’une association pour une instance et un document spécifiques

L’exemple de describe-association suivant décrit l’association entre une instance et un document.

aws ssm describe-association \ --instance-id "i-1234567890abcdef0" \ --name "AWS-UpdateSSMAgent"

Sortie :

{ "AssociationDescription": { "Status": { "Date": 1487876122.564, "Message": "Associated with AWS-UpdateSSMAgent", "Name": "Associated" }, "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-1234567890abcdef0", "Overview": { "Status": "Pending", "DetailedStatus": "Associated", "AssociationStatusAggregatedCount": { "Pending": 1 } }, "AssociationId": "d8617c07-2079-4c18-9847-1234567890ab", "DocumentVersion": "$DEFAULT", "LastUpdateAssociationDate": 1487876122.564, "Date": 1487876122.564, "Targets": [ { "Values": [ "i-1234567890abcdef0" ], "Key": "InstanceIds" } ] } }

Pour plus d’informations, consultez Modifier et créer une nouvelle version d’une association (français non garanti) dans le AWS Guide de l’utilisateur Systems Manager (français non garanti).

  • Pour plus de détails sur l'API, reportez-vous DescribeAssociationà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-automation-executions.

AWS CLI

Pour décrire une exécution d’automatisation

L’exemple de describe-automation-executions suivant affiche les détails d’une exécution d’automatisation.

aws ssm describe-automation-executions \ --filters Key=ExecutionId,Values=73c8eef8-f4ee-4a05-820c-e354fEXAMPLE

Sortie :

{ "AutomationExecutionMetadataList": [ { "AutomationExecutionId": "73c8eef8-f4ee-4a05-820c-e354fEXAMPLE", "DocumentName": "AWS-StartEC2Instance", "DocumentVersion": "1", "AutomationExecutionStatus": "Success", "ExecutionStartTime": 1583737233.748, "ExecutionEndTime": 1583737234.719, "ExecutedBy": "arn:aws:sts::29884EXAMPLE:assumed-role/mw_service_role/OrchestrationService", "LogFile": "", "Outputs": {}, "Mode": "Auto", "Targets": [], "ResolvedTargets": { "ParameterValues": [], "Truncated": false }, "AutomationType": "Local" } ] }

Pour plus d’informations, consultez Exécution d’un flux de travail d’automatisation simple dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-automation-executions.

AWS CLI

Pour décrire une exécution d’automatisation

L’exemple de describe-automation-executions suivant affiche les détails d’une exécution d’automatisation.

aws ssm describe-automation-executions \ --filters Key=ExecutionId,Values=73c8eef8-f4ee-4a05-820c-e354fEXAMPLE

Sortie :

{ "AutomationExecutionMetadataList": [ { "AutomationExecutionId": "73c8eef8-f4ee-4a05-820c-e354fEXAMPLE", "DocumentName": "AWS-StartEC2Instance", "DocumentVersion": "1", "AutomationExecutionStatus": "Success", "ExecutionStartTime": 1583737233.748, "ExecutionEndTime": 1583737234.719, "ExecutedBy": "arn:aws:sts::29884EXAMPLE:assumed-role/mw_service_role/OrchestrationService", "LogFile": "", "Outputs": {}, "Mode": "Auto", "Targets": [], "ResolvedTargets": { "ParameterValues": [], "Truncated": false }, "AutomationType": "Local" } ] }

Pour plus d’informations, consultez Exécution d’un flux de travail d’automatisation simple dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-automation-step-executions.

AWS CLI

Exemple 1 : description de toutes les étapes d’une exécution d’automatisation

L’exemple de describe-automation-step-executions suivant affiche les détails des étapes d’une exécution d’automatisation.

aws ssm describe-automation-step-executions \ --automation-execution-id 73c8eef8-f4ee-4a05-820c-e354fEXAMPLE

Sortie :

{ "StepExecutions": [ { "StepName": "startInstances", "Action": "aws:changeInstanceState", "ExecutionStartTime": 1583737234.134, "ExecutionEndTime": 1583737234.672, "StepStatus": "Success", "Inputs": { "DesiredState": "\"running\"", "InstanceIds": "[\"i-0cb99161f6EXAMPLE\"]" }, "Outputs": { "InstanceStates": [ "running" ] }, "StepExecutionId": "95e70479-cf20-4d80-8018-7e4e2EXAMPLE", "OverriddenParameters": {} } ] }

Exemple 2 : description d’une étape spécifique d’une exécution d’automatisation

L’exemple de describe-automation-step-executions suivant affiche les détails d’une étape spécifique d’une exécution d’automatisation.

aws ssm describe-automation-step-executions \ --automation-execution-id 73c8eef8-f4ee-4a05-820c-e354fEXAMPLE \ --filters Key=StepExecutionId,Values=95e70479-cf20-4d80-8018-7e4e2EXAMPLE

Pour plus d’informations, consultez Exécution d’un flux de travail d’automatisation étape par étape (ligne de commande) dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-automation-step-executions.

AWS CLI

Exemple 1 : description de toutes les étapes d’une exécution d’automatisation

L’exemple de describe-automation-step-executions suivant affiche les détails des étapes d’une exécution d’automatisation.

aws ssm describe-automation-step-executions \ --automation-execution-id 73c8eef8-f4ee-4a05-820c-e354fEXAMPLE

Sortie :

{ "StepExecutions": [ { "StepName": "startInstances", "Action": "aws:changeInstanceState", "ExecutionStartTime": 1583737234.134, "ExecutionEndTime": 1583737234.672, "StepStatus": "Success", "Inputs": { "DesiredState": "\"running\"", "InstanceIds": "[\"i-0cb99161f6EXAMPLE\"]" }, "Outputs": { "InstanceStates": [ "running" ] }, "StepExecutionId": "95e70479-cf20-4d80-8018-7e4e2EXAMPLE", "OverriddenParameters": {} } ] }

Exemple 2 : description d’une étape spécifique d’une exécution d’automatisation

L’exemple de describe-automation-step-executions suivant affiche les détails d’une étape spécifique d’une exécution d’automatisation.

aws ssm describe-automation-step-executions \ --automation-execution-id 73c8eef8-f4ee-4a05-820c-e354fEXAMPLE \ --filters Key=StepExecutionId,Values=95e70479-cf20-4d80-8018-7e4e2EXAMPLE

Pour plus d’informations, consultez Exécution d’un flux de travail d’automatisation étape par étape (ligne de commande) dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-available-patches.

AWS CLI

Pour obtenir les correctifs disponibles

L’exemple de describe-available-patches suivant permet de récupérer les détails de tous les correctifs disponibles pour Windows Server 2019 dont la sévérité du CSEM est Critique.

aws ssm describe-available-patches \ --filters "Key=PRODUCT,Values=WindowsServer2019" "Key=MSRC_SEVERITY,Values=Critical"

Sortie :

{ "Patches": [ { "Id": "fe6bd8c2-3752-4c8b-ab3e-1a7ed08767ba", "ReleaseDate": 1544047205.0, "Title": "2018-11 Update for Windows Server 2019 for x64-based Systems (KB4470788)", "Description": "Install this update to resolve issues in Windows. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article for more information. After you install this item, you may have to restart your computer.", "ContentUrl": "https://support.microsoft.com/en-us/kb/4470788", "Vendor": "Microsoft", "ProductFamily": "Windows", "Product": "WindowsServer2019", "Classification": "SecurityUpdates", "MsrcSeverity": "Critical", "KbNumber": "KB4470788", "MsrcNumber": "", "Language": "All" }, { "Id": "c96115e1-5587-4115-b851-22baa46a3f11", "ReleaseDate": 1549994410.0, "Title": "2019-02 Security Update for Adobe Flash Player for Windows Server 2019 for x64-based Systems (KB4487038)", "Description": "A security issue has been identified in a Microsoft software product that could affect your system. You can help protect your system by installing this update from Microsoft. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article. After you install this update, you may have to restart your system.", "ContentUrl": "https://support.microsoft.com/en-us/kb/4487038", "Vendor": "Microsoft", "ProductFamily": "Windows", "Product": "WindowsServer2019", "Classification": "SecurityUpdates", "MsrcSeverity": "Critical", "KbNumber": "KB4487038", "MsrcNumber": "", "Language": "All" }, ... ] }

Pour obtenir les détails d’un correctif spécifique

L’exemple de describe-available-patches suivant récupère des détails sur le correctif spécifié.

aws ssm describe-available-patches \ --filters "Key=PATCH_ID,Values=KB4480979"

Sortie :

{ "Patches": [ { "Id": "680861e3-fb75-432e-818e-d72e5f2be719", "ReleaseDate": 1546970408.0, "Title": "2019-01 Security Update for Adobe Flash Player for Windows Server 2016 for x64-based Systems (KB4480979)", "Description": "A security issue has been identified in a Microsoft software product that could affect your system. You can help protect your system by installing this update from Microsoft. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article. After you install this update, you may have to restart your system.", "ContentUrl": "https://support.microsoft.com/en-us/kb/4480979", "Vendor": "Microsoft", "ProductFamily": "Windows", "Product": "WindowsServer2016", "Classification": "SecurityUpdates", "MsrcSeverity": "Critical", "KbNumber": "KB4480979", "MsrcNumber": "", "Language": "All" } ] }

Pour plus d’informations, consultez Fonctionnement des opérations du gestionnaire de correctifs dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous DescribeAvailablePatchesà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-available-patches.

AWS CLI

Pour obtenir les correctifs disponibles

L’exemple de describe-available-patches suivant permet de récupérer les détails de tous les correctifs disponibles pour Windows Server 2019 dont la sévérité du CSEM est Critique.

aws ssm describe-available-patches \ --filters "Key=PRODUCT,Values=WindowsServer2019" "Key=MSRC_SEVERITY,Values=Critical"

Sortie :

{ "Patches": [ { "Id": "fe6bd8c2-3752-4c8b-ab3e-1a7ed08767ba", "ReleaseDate": 1544047205.0, "Title": "2018-11 Update for Windows Server 2019 for x64-based Systems (KB4470788)", "Description": "Install this update to resolve issues in Windows. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article for more information. After you install this item, you may have to restart your computer.", "ContentUrl": "https://support.microsoft.com/en-us/kb/4470788", "Vendor": "Microsoft", "ProductFamily": "Windows", "Product": "WindowsServer2019", "Classification": "SecurityUpdates", "MsrcSeverity": "Critical", "KbNumber": "KB4470788", "MsrcNumber": "", "Language": "All" }, { "Id": "c96115e1-5587-4115-b851-22baa46a3f11", "ReleaseDate": 1549994410.0, "Title": "2019-02 Security Update for Adobe Flash Player for Windows Server 2019 for x64-based Systems (KB4487038)", "Description": "A security issue has been identified in a Microsoft software product that could affect your system. You can help protect your system by installing this update from Microsoft. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article. After you install this update, you may have to restart your system.", "ContentUrl": "https://support.microsoft.com/en-us/kb/4487038", "Vendor": "Microsoft", "ProductFamily": "Windows", "Product": "WindowsServer2019", "Classification": "SecurityUpdates", "MsrcSeverity": "Critical", "KbNumber": "KB4487038", "MsrcNumber": "", "Language": "All" }, ... ] }

Pour obtenir les détails d’un correctif spécifique

L’exemple de describe-available-patches suivant récupère des détails sur le correctif spécifié.

aws ssm describe-available-patches \ --filters "Key=PATCH_ID,Values=KB4480979"

Sortie :

{ "Patches": [ { "Id": "680861e3-fb75-432e-818e-d72e5f2be719", "ReleaseDate": 1546970408.0, "Title": "2019-01 Security Update for Adobe Flash Player for Windows Server 2016 for x64-based Systems (KB4480979)", "Description": "A security issue has been identified in a Microsoft software product that could affect your system. You can help protect your system by installing this update from Microsoft. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article. After you install this update, you may have to restart your system.", "ContentUrl": "https://support.microsoft.com/en-us/kb/4480979", "Vendor": "Microsoft", "ProductFamily": "Windows", "Product": "WindowsServer2016", "Classification": "SecurityUpdates", "MsrcSeverity": "Critical", "KbNumber": "KB4480979", "MsrcNumber": "", "Language": "All" } ] }

Pour plus d’informations, consultez Fonctionnement des opérations du gestionnaire de correctifs dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous DescribeAvailablePatchesà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-document-permission.

AWS CLI

Pour décrire les autorisations d’un document

L’exemple de describe-document-permission suivant affiche des détails sur les autorisations relatives à un document Systems Manager partagé publiquement.

aws ssm describe-document-permission \ --name "Example" \ --permission-type "Share"

Sortie :

{ "AccountIds": [ "all" ], "AccountSharingInfoList": [ { "AccountId": "all", "SharedDocumentVersion": "$DEFAULT" } ] }

Pour plus d’informations, consultez Partager un document Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-document-permission.

AWS CLI

Pour décrire les autorisations d’un document

L’exemple de describe-document-permission suivant affiche des détails sur les autorisations relatives à un document Systems Manager partagé publiquement.

aws ssm describe-document-permission \ --name "Example" \ --permission-type "Share"

Sortie :

{ "AccountIds": [ "all" ], "AccountSharingInfoList": [ { "AccountId": "all", "SharedDocumentVersion": "$DEFAULT" } ] }

Pour plus d’informations, consultez Partager un document Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-document.

AWS CLI

Pour afficher les détails d’un document

L'describe-documentexemple suivant affiche les détails d'un document Systems Manager de votre AWS compte.

aws ssm describe-document \ --name "Example"

Sortie :

{ "Document": { "Hash": "fc2410281f40779e694a8b95975d0f9f316da8a153daa94e3d9921102EXAMPLE", "HashType": "Sha256", "Name": "Example", "Owner": "29884EXAMPLE", "CreatedDate": 1583257938.266, "Status": "Active", "DocumentVersion": "1", "Description": "Document Example", "Parameters": [ { "Name": "AutomationAssumeRole", "Type": "String", "Description": "(Required) The ARN of the role that allows Automation to perform the actions on your behalf. If no role is specified, Systems Manager Automation uses your IAM permissions to execute this document.", "DefaultValue": "" }, { "Name": "InstanceId", "Type": "String", "Description": "(Required) The ID of the Amazon EC2 instance.", "DefaultValue": "" } ], "PlatformTypes": [ "Windows", "Linux" ], "DocumentType": "Automation", "SchemaVersion": "0.3", "LatestVersion": "1", "DefaultVersion": "1", "DocumentFormat": "YAML", "Tags": [] } }

Pour plus d’informations, consultez Création de documents Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous DescribeDocumentà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-document.

AWS CLI

Pour afficher les détails d’un document

L'describe-documentexemple suivant affiche les détails d'un document Systems Manager de votre AWS compte.

aws ssm describe-document \ --name "Example"

Sortie :

{ "Document": { "Hash": "fc2410281f40779e694a8b95975d0f9f316da8a153daa94e3d9921102EXAMPLE", "HashType": "Sha256", "Name": "Example", "Owner": "29884EXAMPLE", "CreatedDate": 1583257938.266, "Status": "Active", "DocumentVersion": "1", "Description": "Document Example", "Parameters": [ { "Name": "AutomationAssumeRole", "Type": "String", "Description": "(Required) The ARN of the role that allows Automation to perform the actions on your behalf. If no role is specified, Systems Manager Automation uses your IAM permissions to execute this document.", "DefaultValue": "" }, { "Name": "InstanceId", "Type": "String", "Description": "(Required) The ID of the Amazon EC2 instance.", "DefaultValue": "" } ], "PlatformTypes": [ "Windows", "Linux" ], "DocumentType": "Automation", "SchemaVersion": "0.3", "LatestVersion": "1", "DefaultVersion": "1", "DocumentFormat": "YAML", "Tags": [] } }

Pour plus d’informations, consultez Création de documents Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous DescribeDocumentà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-effective-instance-associations.

AWS CLI

Pour obtenir des détails sur les associations effectives d’une instance

L’exemple de describe-effective-instance-associations suivant récupère les détails des associations effectives d’une instance.

Commande :

aws ssm describe-effective-instance-associations --instance-id "i-1234567890abcdef0"

Sortie :

{ "Associations": [ { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "InstanceId": "i-1234567890abcdef0", "Content": "{\n \"schemaVersion\": \"1.2\",\n \"description\": \"Update the Amazon SSM Agent to the latest version or specified version.\",\n \"parameters\": {\n \"version\": {\n \"default\": \"\",\n \"description\": \"(Optional) A specific version of the Amazon SSM Agent to install. If not specified, the agent will be updated to the latest version.\",\n \"type\": \"String\"\n },\n \"allowDowngrade\": {\n \"default\": \"false\",\n \"description\": \"(Optional) Allow the Amazon SSM Agent service to be downgraded to an earlier version. If set to false, the service can be upgraded to newer versions only (default). If set to true, specify the earlier version.\",\n \"type\": \"String\",\n \"allowedValues\": [\n \"true\",\n \"false\"\n ]\n }\n },\n \"runtimeConfig\": {\n \"aws:updateSsmAgent\": {\n \"properties\": [\n {\n \"agentName\": \"amazon-ssm-agent\",\n \"source\": \"https://s3.{Region}.amazonaws.com/amazon-ssm-{Region}/ssm-agent-manifest.json\",\n \"allowDowngrade\": \"{{ allowDowngrade }}\",\n \"targetVersion\": \"{{ version }}\"\n }\n ]\n }\n }\n}\n", "AssociationVersion": "1" } ] }

L'exemple de code suivant montre comment utiliserdescribe-effective-instance-associations.

AWS CLI

Pour obtenir des détails sur les associations effectives d’une instance

L’exemple de describe-effective-instance-associations suivant récupère les détails des associations effectives d’une instance.

Commande :

aws ssm describe-effective-instance-associations --instance-id "i-1234567890abcdef0"

Sortie :

{ "Associations": [ { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "InstanceId": "i-1234567890abcdef0", "Content": "{\n \"schemaVersion\": \"1.2\",\n \"description\": \"Update the Amazon SSM Agent to the latest version or specified version.\",\n \"parameters\": {\n \"version\": {\n \"default\": \"\",\n \"description\": \"(Optional) A specific version of the Amazon SSM Agent to install. If not specified, the agent will be updated to the latest version.\",\n \"type\": \"String\"\n },\n \"allowDowngrade\": {\n \"default\": \"false\",\n \"description\": \"(Optional) Allow the Amazon SSM Agent service to be downgraded to an earlier version. If set to false, the service can be upgraded to newer versions only (default). If set to true, specify the earlier version.\",\n \"type\": \"String\",\n \"allowedValues\": [\n \"true\",\n \"false\"\n ]\n }\n },\n \"runtimeConfig\": {\n \"aws:updateSsmAgent\": {\n \"properties\": [\n {\n \"agentName\": \"amazon-ssm-agent\",\n \"source\": \"https://s3.{Region}.amazonaws.com/amazon-ssm-{Region}/ssm-agent-manifest.json\",\n \"allowDowngrade\": \"{{ allowDowngrade }}\",\n \"targetVersion\": \"{{ version }}\"\n }\n ]\n }\n }\n}\n", "AssociationVersion": "1" } ] }

L'exemple de code suivant montre comment utiliserdescribe-effective-patches-for-patch-baseline.

AWS CLI

Exemple 1 : obtention de tous les correctifs définis par un référentiel de correctifs personnalisé

L'describe-effective-patches-for-patch-baselineexemple suivant renvoie les correctifs définis par une ligne de base de correctifs personnalisée dans le AWS compte courant. Notez que pour un référentiel personnalisé, seul l’ID est requis pour --baseline-id.

aws ssm describe-effective-patches-for-patch-baseline \ --baseline-id "pb-08b654cf9b9681f04"

Sortie :

{ "EffectivePatches": [ { "Patch": { "Id": "fe6bd8c2-3752-4c8b-ab3e-1a7ed08767ba", "ReleaseDate": 1544047205.0, "Title": "2018-11 Update for Windows Server 2019 for x64-based Systems (KB4470788)", "Description": "Install this update to resolve issues in Windows. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article for more information. After you install this item, you may have to restart your computer.", "ContentUrl": "https://support.microsoft.com/en-us/kb/4470788", "Vendor": "Microsoft", "ProductFamily": "Windows", "Product": "WindowsServer2019", "Classification": "SecurityUpdates", "MsrcSeverity": "Critical", "KbNumber": "KB4470788", "MsrcNumber": "", "Language": "All" }, "PatchStatus": { "DeploymentStatus": "APPROVED", "ComplianceLevel": "CRITICAL", "ApprovalDate": 1544047205.0 } }, { "Patch": { "Id": "915a6b1a-f556-4d83-8f50-b2e75a9a7e58", "ReleaseDate": 1549994400.0, "Title": "2019-02 Cumulative Update for .NET Framework 3.5 and 4.7.2 for Windows Server 2019 for x64 (KB4483452)", "Description": "A security issue has been identified in a Microsoft software product that could affect your system. You can help protect your system by installing this update from Microsoft. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article. After you install this update, you may have to restart your system.", "ContentUrl": "https://support.microsoft.com/en-us/kb/4483452", "Vendor": "Microsoft", "ProductFamily": "Windows", "Product": "WindowsServer2019", "Classification": "SecurityUpdates", "MsrcSeverity": "Important", "KbNumber": "KB4483452", "MsrcNumber": "", "Language": "All" }, "PatchStatus": { "DeploymentStatus": "APPROVED", "ComplianceLevel": "CRITICAL", "ApprovalDate": 1549994400.0 } }, ... ], "NextToken": "--token string truncated--" }

Exemple 2 : pour obtenir tous les correctifs définis par une ligne de base de correctifs AWS gérée

L'describe-effective-patches-for-patch-baselineexemple suivant renvoie les correctifs définis par une ligne de base de correctifs AWS gérée. Notez que pour une ligne de base AWS gérée, l'ARN de référence complet est requis pour --baseline-id

aws ssm describe-effective-patches-for-patch-baseline \ --baseline-id "arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-020d361a05defe4ed"

Voir l’exemple 1 pour un exemple de sortie.

Pour plus d’informations, consultez Comment les correctifs de sécurité sont sélectionnés dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-effective-patches-for-patch-baseline.

AWS CLI

Exemple 1 : obtention de tous les correctifs définis par un référentiel de correctifs personnalisé

L'describe-effective-patches-for-patch-baselineexemple suivant renvoie les correctifs définis par une ligne de base de correctifs personnalisée dans le AWS compte courant. Notez que pour un référentiel personnalisé, seul l’ID est requis pour --baseline-id.

aws ssm describe-effective-patches-for-patch-baseline \ --baseline-id "pb-08b654cf9b9681f04"

Sortie :

{ "EffectivePatches": [ { "Patch": { "Id": "fe6bd8c2-3752-4c8b-ab3e-1a7ed08767ba", "ReleaseDate": 1544047205.0, "Title": "2018-11 Update for Windows Server 2019 for x64-based Systems (KB4470788)", "Description": "Install this update to resolve issues in Windows. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article for more information. After you install this item, you may have to restart your computer.", "ContentUrl": "https://support.microsoft.com/en-us/kb/4470788", "Vendor": "Microsoft", "ProductFamily": "Windows", "Product": "WindowsServer2019", "Classification": "SecurityUpdates", "MsrcSeverity": "Critical", "KbNumber": "KB4470788", "MsrcNumber": "", "Language": "All" }, "PatchStatus": { "DeploymentStatus": "APPROVED", "ComplianceLevel": "CRITICAL", "ApprovalDate": 1544047205.0 } }, { "Patch": { "Id": "915a6b1a-f556-4d83-8f50-b2e75a9a7e58", "ReleaseDate": 1549994400.0, "Title": "2019-02 Cumulative Update for .NET Framework 3.5 and 4.7.2 for Windows Server 2019 for x64 (KB4483452)", "Description": "A security issue has been identified in a Microsoft software product that could affect your system. You can help protect your system by installing this update from Microsoft. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article. After you install this update, you may have to restart your system.", "ContentUrl": "https://support.microsoft.com/en-us/kb/4483452", "Vendor": "Microsoft", "ProductFamily": "Windows", "Product": "WindowsServer2019", "Classification": "SecurityUpdates", "MsrcSeverity": "Important", "KbNumber": "KB4483452", "MsrcNumber": "", "Language": "All" }, "PatchStatus": { "DeploymentStatus": "APPROVED", "ComplianceLevel": "CRITICAL", "ApprovalDate": 1549994400.0 } }, ... ], "NextToken": "--token string truncated--" }

Exemple 2 : pour obtenir tous les correctifs définis par une ligne de base de correctifs AWS gérée

L'describe-effective-patches-for-patch-baselineexemple suivant renvoie les correctifs définis par une ligne de base de correctifs AWS gérée. Notez que pour une ligne de base AWS gérée, l'ARN de référence complet est requis pour --baseline-id

aws ssm describe-effective-patches-for-patch-baseline \ --baseline-id "arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-020d361a05defe4ed"

Voir l’exemple 1 pour un exemple de sortie.

Pour plus d’informations, consultez Comment les correctifs de sécurité sont sélectionnés dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-instance-associations-status.

AWS CLI

Pour décrire le statut des associations d’une instance

Cet exemple montre les détails des associations d’une instance.

Commande :

aws ssm describe-instance-associations-status --instance-id "i-1234567890abcdef0"

Sortie :

{ "InstanceAssociationStatusInfos": [ { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "Name": "AWS-GatherSoftwareInventory", "DocumentVersion": "1", "AssociationVersion": "1", "InstanceId": "i-1234567890abcdef0", "ExecutionDate": 1550501886.0, "Status": "Success", "ExecutionSummary": "1 out of 1 plugin processed, 1 success, 0 failed, 0 timedout, 0 skipped. ", "AssociationName": "Inventory-Association" }, { "AssociationId": "5c5a31f6-6dae-46f9-944c-0123456789ab", "Name": "AWS-UpdateSSMAgent", "DocumentVersion": "1", "AssociationVersion": "1", "InstanceId": "i-1234567890abcdef0", "ExecutionDate": 1550505828.548, "Status": "Success", "DetailedStatus": "Success", "AssociationName": "UpdateSSMAgent" } ] }

L'exemple de code suivant montre comment utiliserdescribe-instance-associations-status.

AWS CLI

Pour décrire le statut des associations d’une instance

Cet exemple montre les détails des associations d’une instance.

Commande :

aws ssm describe-instance-associations-status --instance-id "i-1234567890abcdef0"

Sortie :

{ "InstanceAssociationStatusInfos": [ { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "Name": "AWS-GatherSoftwareInventory", "DocumentVersion": "1", "AssociationVersion": "1", "InstanceId": "i-1234567890abcdef0", "ExecutionDate": 1550501886.0, "Status": "Success", "ExecutionSummary": "1 out of 1 plugin processed, 1 success, 0 failed, 0 timedout, 0 skipped. ", "AssociationName": "Inventory-Association" }, { "AssociationId": "5c5a31f6-6dae-46f9-944c-0123456789ab", "Name": "AWS-UpdateSSMAgent", "DocumentVersion": "1", "AssociationVersion": "1", "InstanceId": "i-1234567890abcdef0", "ExecutionDate": 1550505828.548, "Status": "Success", "DetailedStatus": "Success", "AssociationName": "UpdateSSMAgent" } ] }

L'exemple de code suivant montre comment utiliserdescribe-instance-information.

AWS CLI

Exemple 1 : description des informations relatives aux instances gérées

L’exemple de describe-instance-information suivant récupère les détails de chacune de vos instances gérées.

aws ssm describe-instance-information

Exemple 2 : description des informations relatives à une instance gérée spécifique

L’exemple de describe-instance-information suivant montre les détails de l’instance gérée i-028ea792daEXAMPLE.

aws ssm describe-instance-information \ --filters "Key=InstanceIds,Values=i-028ea792daEXAMPLE"

Exemple 3 : description des informations sur les instances gérées avec une clé de balise spécifique

L’exemple de describe-instance-information suivant montre les détails des instances gérées qui ont la clé de balise DEV.

aws ssm describe-instance-information \ --filters "Key=tag-key,Values=DEV"

Sortie :

{ "InstanceInformationList": [ { "InstanceId": "i-028ea792daEXAMPLE", "PingStatus": "Online", "LastPingDateTime": 1582221233.421, "AgentVersion": "2.3.842.0", "IsLatestVersion": true, "PlatformType": "Linux", "PlatformName": "SLES", "PlatformVersion": "15.1", "ResourceType": "EC2Instance", "IPAddress": "192.0.2.0", "ComputerName": "ip-198.51.100.0.us-east-2.compute.internal", "AssociationStatus": "Success", "LastAssociationExecutionDate": 1582220806.0, "LastSuccessfulAssociationExecutionDate": 1582220806.0, "AssociationOverview": { "DetailedStatus": "Success", "InstanceAssociationStatusAggregatedCount": { "Success": 2 } } } ] }

Pour plus d’informations, consultez Instances gérées dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-instance-information.

AWS CLI

Exemple 1 : description des informations relatives aux instances gérées

L’exemple de describe-instance-information suivant récupère les détails de chacune de vos instances gérées.

aws ssm describe-instance-information

Exemple 2 : description des informations relatives à une instance gérée spécifique

L’exemple de describe-instance-information suivant montre les détails de l’instance gérée i-028ea792daEXAMPLE.

aws ssm describe-instance-information \ --filters "Key=InstanceIds,Values=i-028ea792daEXAMPLE"

Exemple 3 : description des informations sur les instances gérées avec une clé de balise spécifique

L’exemple de describe-instance-information suivant montre les détails des instances gérées qui ont la clé de balise DEV.

aws ssm describe-instance-information \ --filters "Key=tag-key,Values=DEV"

Sortie :

{ "InstanceInformationList": [ { "InstanceId": "i-028ea792daEXAMPLE", "PingStatus": "Online", "LastPingDateTime": 1582221233.421, "AgentVersion": "2.3.842.0", "IsLatestVersion": true, "PlatformType": "Linux", "PlatformName": "SLES", "PlatformVersion": "15.1", "ResourceType": "EC2Instance", "IPAddress": "192.0.2.0", "ComputerName": "ip-198.51.100.0.us-east-2.compute.internal", "AssociationStatus": "Success", "LastAssociationExecutionDate": 1582220806.0, "LastSuccessfulAssociationExecutionDate": 1582220806.0, "AssociationOverview": { "DetailedStatus": "Success", "InstanceAssociationStatusAggregatedCount": { "Success": 2 } } } ] }

Pour plus d’informations, consultez Instances gérées dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-instance-patch-states-for-patch-group.

AWS CLI

Exemple 1 : obtention des états d’instance d’un groupe de correctifs

L’exemple de describe-instance-patch-states-for-patch-group suivant permet d’obtenir des détails sur les états récapitulatifs des correctifs par instance pour le groupe de correctifs spécifié.

aws ssm describe-instance-patch-states-for-patch-group \ --patch-group "Production"

Sortie :

{ "InstancePatchStates": [ { "InstanceId": "i-02573cafcfEXAMPLE", "PatchGroup": "Production", "BaselineId": "pb-0c10e65780EXAMPLE", "SnapshotId": "a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE", "OwnerInformation": "", "InstalledCount": 32, "InstalledOtherCount": 1, "InstalledPendingRebootCount": 0, "InstalledRejectedCount": 0, "MissingCount": 2, "FailedCount": 0, "UnreportedNotApplicableCount": 2671, "NotApplicableCount": 400, "OperationStartTime": "2021-08-04T11:03:50.590000-07:00", "OperationEndTime": "2021-08-04T11:04:21.555000-07:00", "Operation": "Scan", "RebootOption": "NoReboot", "CriticalNonCompliantCount": 0, "SecurityNonCompliantCount": 1, "OtherNonCompliantCount": 0 }, { "InstanceId": "i-0471e04240EXAMPLE", "PatchGroup": "Production", "BaselineId": "pb-09ca3fb51fEXAMPLE", "SnapshotId": "05d8ffb0-1bbe-4812-ba2d-d9b7bEXAMPLE", "OwnerInformation": "", "InstalledCount": 32, "InstalledOtherCount": 1, "InstalledPendingRebootCount": 0, "InstalledRejectedCount": 0, "MissingCount": 2, "FailedCount": 0, "UnreportedNotApplicableCount": 2671, "NotApplicableCount": 400, "OperationStartTime": "2021-08-04T22:06:20.340000-07:00", "OperationEndTime": "2021-08-04T22:07:11.220000-07:00", "Operation": "Scan", "RebootOption": "NoReboot", "CriticalNonCompliantCount": 0, "SecurityNonCompliantCount": 1, "OtherNonCompliantCount": 0 } ] }

Exemple 2 : obtention des états d’instance d’un groupe de correctifs avec plus de cinq correctifs manquants

L’exemple de describe-instance-patch-states-for-patch-group suivant permet d’obtenir des détails sur les états récapitulatifs des correctifs pour le groupe de correctifs spécifié pour les instances ayant plus de cinq correctifs manquants.

aws ssm describe-instance-patch-states-for-patch-group \ --filters Key=MissingCount,Type=GreaterThan,Values=5 \ --patch-group "Production"

Sortie :

{ "InstancePatchStates": [ { "InstanceId": "i-02573cafcfEXAMPLE", "PatchGroup": "Production", "BaselineId": "pb-0c10e65780EXAMPLE", "SnapshotId": "a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE", "OwnerInformation": "", "InstalledCount": 46, "InstalledOtherCount": 4, "InstalledPendingRebootCount": 1, "InstalledRejectedCount": 1, "MissingCount": 7, "FailedCount": 0, "UnreportedNotApplicableCount": 232, "NotApplicableCount": 654, "OperationStartTime": "2021-08-04T11:03:50.590000-07:00", "OperationEndTime": "2021-08-04T11:04:21.555000-07:00", "Operation": "Scan", "RebootOption": "NoReboot", "CriticalNonCompliantCount": 0, "SecurityNonCompliantCount": 1, "OtherNonCompliantCount": 1 } ] }

Exemple 3 : obtention des états d’instance pour un groupe de correctifs avec moins de dix instances qui nécessitent un redémarrage

L’exemple de describe-instance-patch-states-for-patch-group suivant récupère les détails des états récapitulatifs des correctifs pour le groupe de correctifs spécifié pour les instances avec moins de dix instances qui nécessitent un redémarrage.

aws ssm describe-instance-patch-states-for-patch-group \ --filters Key=InstalledPendingRebootCount,Type=LessThan,Values=10 \ --patch-group "Production"

Sortie :

{ "InstancePatchStates": [ { "InstanceId": "i-02573cafcfEXAMPLE", "BaselineId": "pb-0c10e65780EXAMPLE", "SnapshotId": "a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE", "PatchGroup": "Production", "OwnerInformation": "", "InstalledCount": 32, "InstalledOtherCount": 1, "InstalledPendingRebootCount": 4, "InstalledRejectedCount": 0, "MissingCount": 2, "FailedCount": 0, "UnreportedNotApplicableCount": 846, "NotApplicableCount": 212, "OperationStartTime": "2021-08-046T11:03:50.590000-07:00", "OperationEndTime": "2021-08-06T11:04:21.555000-07:00", "Operation": "Scan", "RebootOption": "NoReboot", "CriticalNonCompliantCount": 0, "SecurityNonCompliantCount": 1, "OtherNonCompliantCount": 0 } ] }

Pour plus d’informations, consultez Comprendre les valeurs des états de conformité des correctifs dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-instance-patch-states-for-patch-group.

AWS CLI

Exemple 1 : obtention des états d’instance d’un groupe de correctifs

L’exemple de describe-instance-patch-states-for-patch-group suivant permet d’obtenir des détails sur les états récapitulatifs des correctifs par instance pour le groupe de correctifs spécifié.

aws ssm describe-instance-patch-states-for-patch-group \ --patch-group "Production"

Sortie :

{ "InstancePatchStates": [ { "InstanceId": "i-02573cafcfEXAMPLE", "PatchGroup": "Production", "BaselineId": "pb-0c10e65780EXAMPLE", "SnapshotId": "a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE", "OwnerInformation": "", "InstalledCount": 32, "InstalledOtherCount": 1, "InstalledPendingRebootCount": 0, "InstalledRejectedCount": 0, "MissingCount": 2, "FailedCount": 0, "UnreportedNotApplicableCount": 2671, "NotApplicableCount": 400, "OperationStartTime": "2021-08-04T11:03:50.590000-07:00", "OperationEndTime": "2021-08-04T11:04:21.555000-07:00", "Operation": "Scan", "RebootOption": "NoReboot", "CriticalNonCompliantCount": 0, "SecurityNonCompliantCount": 1, "OtherNonCompliantCount": 0 }, { "InstanceId": "i-0471e04240EXAMPLE", "PatchGroup": "Production", "BaselineId": "pb-09ca3fb51fEXAMPLE", "SnapshotId": "05d8ffb0-1bbe-4812-ba2d-d9b7bEXAMPLE", "OwnerInformation": "", "InstalledCount": 32, "InstalledOtherCount": 1, "InstalledPendingRebootCount": 0, "InstalledRejectedCount": 0, "MissingCount": 2, "FailedCount": 0, "UnreportedNotApplicableCount": 2671, "NotApplicableCount": 400, "OperationStartTime": "2021-08-04T22:06:20.340000-07:00", "OperationEndTime": "2021-08-04T22:07:11.220000-07:00", "Operation": "Scan", "RebootOption": "NoReboot", "CriticalNonCompliantCount": 0, "SecurityNonCompliantCount": 1, "OtherNonCompliantCount": 0 } ] }

Exemple 2 : obtention des états d’instance d’un groupe de correctifs avec plus de cinq correctifs manquants

L’exemple de describe-instance-patch-states-for-patch-group suivant permet d’obtenir des détails sur les états récapitulatifs des correctifs pour le groupe de correctifs spécifié pour les instances ayant plus de cinq correctifs manquants.

aws ssm describe-instance-patch-states-for-patch-group \ --filters Key=MissingCount,Type=GreaterThan,Values=5 \ --patch-group "Production"

Sortie :

{ "InstancePatchStates": [ { "InstanceId": "i-02573cafcfEXAMPLE", "PatchGroup": "Production", "BaselineId": "pb-0c10e65780EXAMPLE", "SnapshotId": "a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE", "OwnerInformation": "", "InstalledCount": 46, "InstalledOtherCount": 4, "InstalledPendingRebootCount": 1, "InstalledRejectedCount": 1, "MissingCount": 7, "FailedCount": 0, "UnreportedNotApplicableCount": 232, "NotApplicableCount": 654, "OperationStartTime": "2021-08-04T11:03:50.590000-07:00", "OperationEndTime": "2021-08-04T11:04:21.555000-07:00", "Operation": "Scan", "RebootOption": "NoReboot", "CriticalNonCompliantCount": 0, "SecurityNonCompliantCount": 1, "OtherNonCompliantCount": 1 } ] }

Exemple 3 : obtention des états d’instance pour un groupe de correctifs avec moins de dix instances qui nécessitent un redémarrage

L’exemple de describe-instance-patch-states-for-patch-group suivant récupère les détails des états récapitulatifs des correctifs pour le groupe de correctifs spécifié pour les instances avec moins de dix instances qui nécessitent un redémarrage.

aws ssm describe-instance-patch-states-for-patch-group \ --filters Key=InstalledPendingRebootCount,Type=LessThan,Values=10 \ --patch-group "Production"

Sortie :

{ "InstancePatchStates": [ { "InstanceId": "i-02573cafcfEXAMPLE", "BaselineId": "pb-0c10e65780EXAMPLE", "SnapshotId": "a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE", "PatchGroup": "Production", "OwnerInformation": "", "InstalledCount": 32, "InstalledOtherCount": 1, "InstalledPendingRebootCount": 4, "InstalledRejectedCount": 0, "MissingCount": 2, "FailedCount": 0, "UnreportedNotApplicableCount": 846, "NotApplicableCount": 212, "OperationStartTime": "2021-08-046T11:03:50.590000-07:00", "OperationEndTime": "2021-08-06T11:04:21.555000-07:00", "Operation": "Scan", "RebootOption": "NoReboot", "CriticalNonCompliantCount": 0, "SecurityNonCompliantCount": 1, "OtherNonCompliantCount": 0 } ] }

Pour plus d’informations, consultez Comprendre les valeurs des états de conformité des correctifs dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-instance-patch-states.

AWS CLI

Pour obtenir les états récapitulatifs des correctifs pour les instances

Cet exemple de describe-instance-patch-states permet d’obtenir les états récapitulatifs des correctifs pour une instance.

aws ssm describe-instance-patch-states \ --instance-ids "i-1234567890abcdef0"

Sortie :

{ "InstancePatchStates": [ { "InstanceId": "i-1234567890abcdef0", "PatchGroup": "my-patch-group", "BaselineId": "pb-0713accee01234567", "SnapshotId": "521c3536-930c-4aa9-950e-01234567abcd", "CriticalNonCompliantCount": 2, "SecurityNonCompliantCount": 2, "OtherNonCompliantCount": 1, "InstalledCount": 123, "InstalledOtherCount": 334, "InstalledPendingRebootCount": 0, "InstalledRejectedCount": 0, "MissingCount": 1, "FailedCount": 2, "UnreportedNotApplicableCount": 11, "NotApplicableCount": 2063, "OperationStartTime": "2021-05-03T11:00:56-07:00", "OperationEndTime": "2021-05-03T11:01:09-07:00", "Operation": "Scan", "LastNoRebootInstallOperationTime": "2020-06-14T12:17:41-07:00", "RebootOption": "RebootIfNeeded" } ] }

Pour plus d’informations, consultez À propos de la conformité des correctifs dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-instance-patch-states.

AWS CLI

Pour obtenir les états récapitulatifs des correctifs pour les instances

Cet exemple de describe-instance-patch-states permet d’obtenir les états récapitulatifs des correctifs pour une instance.

aws ssm describe-instance-patch-states \ --instance-ids "i-1234567890abcdef0"

Sortie :

{ "InstancePatchStates": [ { "InstanceId": "i-1234567890abcdef0", "PatchGroup": "my-patch-group", "BaselineId": "pb-0713accee01234567", "SnapshotId": "521c3536-930c-4aa9-950e-01234567abcd", "CriticalNonCompliantCount": 2, "SecurityNonCompliantCount": 2, "OtherNonCompliantCount": 1, "InstalledCount": 123, "InstalledOtherCount": 334, "InstalledPendingRebootCount": 0, "InstalledRejectedCount": 0, "MissingCount": 1, "FailedCount": 2, "UnreportedNotApplicableCount": 11, "NotApplicableCount": 2063, "OperationStartTime": "2021-05-03T11:00:56-07:00", "OperationEndTime": "2021-05-03T11:01:09-07:00", "Operation": "Scan", "LastNoRebootInstallOperationTime": "2020-06-14T12:17:41-07:00", "RebootOption": "RebootIfNeeded" } ] }

Pour plus d’informations, consultez À propos de la conformité des correctifs dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-instance-patches.

AWS CLI

Exemple 1 : obtention des détails de l’état des correctifs d’une instance

L’exemple de describe-instance-patches suivant récupère les détails des correctifs pour l’instance spécifiée.

aws ssm describe-instance-patches \ --instance-id "i-1234567890abcdef0"

Sortie :

{ "Patches": [ { "Title": "2019-01 Security Update for Adobe Flash Player for Windows Server 2016 for x64-based Systems (KB4480979)", "KBId": "KB4480979", "Classification": "SecurityUpdates", "Severity": "Critical", "State": "Installed", "InstalledTime": "2019-01-09T00:00:00+00:00" }, { "Title": "", "KBId": "KB4481031", "Classification": "", "Severity": "", "State": "InstalledOther", "InstalledTime": "2019-02-08T00:00:00+00:00" }, ... ], "NextToken": "--token string truncated--" }

Exemple 2 : obtention d’une liste de correctifs dans l’état « Manquant » pour une instance

L’exemple de describe-instance-patches suivant permet d’obtenir des informations sur les correctifs qui sont dans l’état Manquant pour l’instance spécifiée.

aws ssm describe-instance-patches \ --instance-id "i-1234567890abcdef0" \ --filters Key=State,Values=Missing

Sortie :

{ "Patches": [ { "Title": "Windows Malicious Software Removal Tool x64 - February 2019 (KB890830)", "KBId": "KB890830", "Classification": "UpdateRollups", "Severity": "Unspecified", "State": "Missing", "InstalledTime": "1970-01-01T00:00:00+00:00" }, ... ], "NextToken": "--token string truncated--" }

Pour plus d’informations, consultez À propos des états de conformité des correctifs dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 3 : pour obtenir la liste des correctifs installés depuis une spécification InstalledTime pour une instance

L’exemple de describe-instance-patches suivant permet d’obtenir des informations sur les correctifs installés depuis une date donnée pour l’instance spécifiée en combinant l’utilisation de --filters et de --query.

aws ssm describe-instance-patches \ --instance-id "i-1234567890abcdef0" \ --filters Key=State,Values=Installed \ --query "Patches[?InstalledTime >= `2023-01-01T16:00:00`]"

Sortie :

{ "Patches": [ { "Title": "2023-03 Cumulative Update for Windows Server 2019 (1809) for x64-based Systems (KB5023702)", "KBId": "KB5023702", "Classification": "SecurityUpdates", "Severity": "Critical", "State": "Installed", "InstalledTime": "2023-03-16T11:00:00+00:00" }, ... ], "NextToken": "--token string truncated--" }
  • Pour plus de détails sur l'API, reportez-vous DescribeInstancePatchesà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-instance-patches.

AWS CLI

Exemple 1 : obtention des détails de l’état des correctifs d’une instance

L’exemple de describe-instance-patches suivant récupère les détails des correctifs pour l’instance spécifiée.

aws ssm describe-instance-patches \ --instance-id "i-1234567890abcdef0"

Sortie :

{ "Patches": [ { "Title": "2019-01 Security Update for Adobe Flash Player for Windows Server 2016 for x64-based Systems (KB4480979)", "KBId": "KB4480979", "Classification": "SecurityUpdates", "Severity": "Critical", "State": "Installed", "InstalledTime": "2019-01-09T00:00:00+00:00" }, { "Title": "", "KBId": "KB4481031", "Classification": "", "Severity": "", "State": "InstalledOther", "InstalledTime": "2019-02-08T00:00:00+00:00" }, ... ], "NextToken": "--token string truncated--" }

Exemple 2 : obtention d’une liste de correctifs dans l’état « Manquant » pour une instance

L’exemple de describe-instance-patches suivant permet d’obtenir des informations sur les correctifs qui sont dans l’état Manquant pour l’instance spécifiée.

aws ssm describe-instance-patches \ --instance-id "i-1234567890abcdef0" \ --filters Key=State,Values=Missing

Sortie :

{ "Patches": [ { "Title": "Windows Malicious Software Removal Tool x64 - February 2019 (KB890830)", "KBId": "KB890830", "Classification": "UpdateRollups", "Severity": "Unspecified", "State": "Missing", "InstalledTime": "1970-01-01T00:00:00+00:00" }, ... ], "NextToken": "--token string truncated--" }

Pour plus d’informations, consultez À propos des états de conformité des correctifs dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 3 : pour obtenir la liste des correctifs installés depuis une spécification InstalledTime pour une instance

L’exemple de describe-instance-patches suivant permet d’obtenir des informations sur les correctifs installés depuis une date donnée pour l’instance spécifiée en combinant l’utilisation de --filters et de --query.

aws ssm describe-instance-patches \ --instance-id "i-1234567890abcdef0" \ --filters Key=State,Values=Installed \ --query "Patches[?InstalledTime >= `2023-01-01T16:00:00`]"

Sortie :

{ "Patches": [ { "Title": "2023-03 Cumulative Update for Windows Server 2019 (1809) for x64-based Systems (KB5023702)", "KBId": "KB5023702", "Classification": "SecurityUpdates", "Severity": "Critical", "State": "Installed", "InstalledTime": "2023-03-16T11:00:00+00:00" }, ... ], "NextToken": "--token string truncated--" }
  • Pour plus de détails sur l'API, reportez-vous DescribeInstancePatchesà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-inventory-deletions.

AWS CLI

Pour obtenir des suppressions d'inventaire

Cet exemple permet de récupérer les détails des opérations de suppression d'inventaire.

Commande :

aws ssm describe-inventory-deletions

Sortie :

{ "InventoryDeletions": [ { "DeletionId": "6961492a-8163-44ec-aa1e-01234567850", "TypeName": "Custom:RackInformation", "DeletionStartTime": 1550254911.0, "LastStatus": "InProgress", "LastStatusMessage": "The Delete is in progress", "DeletionSummary": { "TotalCount": 0, "RemainingCount": 0, "SummaryItems": [] }, "LastStatusUpdateTime": 1550254911.0 }, { "DeletionId": "d72ac9e8-1f60-4d40-b1c6-987654321c4d", "TypeName": "Custom:RackInfo", "DeletionStartTime": 1550254859.0, "LastStatus": "InProgress", "LastStatusMessage": "The Delete is in progress", "DeletionSummary": { "TotalCount": 1, "RemainingCount": 1, "SummaryItems": [ { "Version": "1.0", "Count": 1, "RemainingCount": 1 } ] }, "LastStatusUpdateTime": 1550254859.0 } ] }

Pour obtenir les détails d'une suppression d'inventaire spécifique

Cet exemple permet de récupérer les détails d'une opération de suppression d'inventaire spécifique.

Commande :

aws ssm describe-inventory-deletions --deletion-id "d72ac9e8-1f60-4d40-b1c6-987654321c4d"

Sortie :

{ "InventoryDeletions": [ { "DeletionId": "d72ac9e8-1f60-4d40-b1c6-987654321c4d", "TypeName": "Custom:RackInfo", "DeletionStartTime": 1550254859.0, "LastStatus": "InProgress", "LastStatusMessage": "The Delete is in progress", "DeletionSummary": { "TotalCount": 1, "RemainingCount": 1, "SummaryItems": [ { "Version": "1.0", "Count": 1, "RemainingCount": 1 } ] }, "LastStatusUpdateTime": 1550254859.0 } ] }

L'exemple de code suivant montre comment utiliserdescribe-inventory-deletions.

AWS CLI

Pour obtenir des suppressions d'inventaire

Cet exemple permet de récupérer les détails des opérations de suppression d'inventaire.

Commande :

aws ssm describe-inventory-deletions

Sortie :

{ "InventoryDeletions": [ { "DeletionId": "6961492a-8163-44ec-aa1e-01234567850", "TypeName": "Custom:RackInformation", "DeletionStartTime": 1550254911.0, "LastStatus": "InProgress", "LastStatusMessage": "The Delete is in progress", "DeletionSummary": { "TotalCount": 0, "RemainingCount": 0, "SummaryItems": [] }, "LastStatusUpdateTime": 1550254911.0 }, { "DeletionId": "d72ac9e8-1f60-4d40-b1c6-987654321c4d", "TypeName": "Custom:RackInfo", "DeletionStartTime": 1550254859.0, "LastStatus": "InProgress", "LastStatusMessage": "The Delete is in progress", "DeletionSummary": { "TotalCount": 1, "RemainingCount": 1, "SummaryItems": [ { "Version": "1.0", "Count": 1, "RemainingCount": 1 } ] }, "LastStatusUpdateTime": 1550254859.0 } ] }

Pour obtenir les détails d'une suppression d'inventaire spécifique

Cet exemple permet de récupérer les détails d'une opération de suppression d'inventaire spécifique.

Commande :

aws ssm describe-inventory-deletions --deletion-id "d72ac9e8-1f60-4d40-b1c6-987654321c4d"

Sortie :

{ "InventoryDeletions": [ { "DeletionId": "d72ac9e8-1f60-4d40-b1c6-987654321c4d", "TypeName": "Custom:RackInfo", "DeletionStartTime": 1550254859.0, "LastStatus": "InProgress", "LastStatusMessage": "The Delete is in progress", "DeletionSummary": { "TotalCount": 1, "RemainingCount": 1, "SummaryItems": [ { "Version": "1.0", "Count": 1, "RemainingCount": 1 } ] }, "LastStatusUpdateTime": 1550254859.0 } ] }

L'exemple de code suivant montre comment utiliserdescribe-maintenance-window-execution-task-invocations.

AWS CLI

Pour obtenir les invocations de tâches spécifiques effectuées pour l’exécution d’une tâche de fenêtre de maintenance

L’exemple de describe-maintenance-window-execution-task-invocations suivant répertorie les invocations de la tâche spécifiée exécutée dans le cadre de l’exécution de la fenêtre de maintenance spécifiée.

aws ssm describe-maintenance-window-execution-task-invocations \ --window-execution-id "518d5565-5969-4cca-8f0e-da3b2a638355" \ --task-id "ac0c6ae1-daa3-4a89-832e-d384503b6586"

Sortie :

{ "WindowExecutionTaskInvocationIdentities": [ { "Status": "SUCCESS", "Parameters": "{\"documentName\":\"AWS-RunShellScript\",\"instanceIds\":[\"i-0000293ffd8c57862\"],\"parameters\":{\"commands\":[\"df\"]},\"maxConcurrency\":\"1\",\"maxErrors\":\"1\"}", "InvocationId": "e274b6e1-fe56-4e32-bd2a-8073c6381d8b", "StartTime": 1487692834.723, "EndTime": 1487692834.871, "WindowExecutionId": "518d5565-5969-4cca-8f0e-da3b2a638355", "TaskExecutionId": "ac0c6ae1-daa3-4a89-832e-d384503b6586" } ] }

Pour plus d'informations, consultez la section Afficher les informations sur les tâches et les exécutions de tâches (AWS CLI) dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-maintenance-window-execution-task-invocations.

AWS CLI

Pour obtenir les invocations de tâches spécifiques effectuées pour l’exécution d’une tâche de fenêtre de maintenance

L’exemple de describe-maintenance-window-execution-task-invocations suivant répertorie les invocations de la tâche spécifiée exécutée dans le cadre de l’exécution de la fenêtre de maintenance spécifiée.

aws ssm describe-maintenance-window-execution-task-invocations \ --window-execution-id "518d5565-5969-4cca-8f0e-da3b2a638355" \ --task-id "ac0c6ae1-daa3-4a89-832e-d384503b6586"

Sortie :

{ "WindowExecutionTaskInvocationIdentities": [ { "Status": "SUCCESS", "Parameters": "{\"documentName\":\"AWS-RunShellScript\",\"instanceIds\":[\"i-0000293ffd8c57862\"],\"parameters\":{\"commands\":[\"df\"]},\"maxConcurrency\":\"1\",\"maxErrors\":\"1\"}", "InvocationId": "e274b6e1-fe56-4e32-bd2a-8073c6381d8b", "StartTime": 1487692834.723, "EndTime": 1487692834.871, "WindowExecutionId": "518d5565-5969-4cca-8f0e-da3b2a638355", "TaskExecutionId": "ac0c6ae1-daa3-4a89-832e-d384503b6586" } ] }

Pour plus d'informations, consultez la section Afficher les informations sur les tâches et les exécutions de tâches (AWS CLI) dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-maintenance-window-execution-tasks.

AWS CLI

Pour répertorier toutes les tâches associées à l’exécution d’une fenêtre de maintenance

L’exemple de ssm describe-maintenance-window-execution-tasks suivant répertorie les tâches associées à l’exécution de la fenêtre de maintenance spécifiée.

aws ssm describe-maintenance-window-execution-tasks \ --window-execution-id "518d5565-5969-4cca-8f0e-da3b2EXAMPLE"

Sortie :

{ "WindowExecutionTaskIdentities": [ { "Status": "SUCCESS", "TaskArn": "AWS-RunShellScript", "StartTime": 1487692834.684, "TaskType": "RUN_COMMAND", "EndTime": 1487692835.005, "WindowExecutionId": "518d5565-5969-4cca-8f0e-da3b2EXAMPLE", "TaskExecutionId": "ac0c6ae1-daa3-4a89-832e-d3845EXAMPLE" } ] }

Pour plus d'informations, consultez la section Afficher les informations sur les tâches et les exécutions de tâches (AWS CLI) dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-maintenance-window-execution-tasks.

AWS CLI

Pour répertorier toutes les tâches associées à l’exécution d’une fenêtre de maintenance

L’exemple de ssm describe-maintenance-window-execution-tasks suivant répertorie les tâches associées à l’exécution de la fenêtre de maintenance spécifiée.

aws ssm describe-maintenance-window-execution-tasks \ --window-execution-id "518d5565-5969-4cca-8f0e-da3b2EXAMPLE"

Sortie :

{ "WindowExecutionTaskIdentities": [ { "Status": "SUCCESS", "TaskArn": "AWS-RunShellScript", "StartTime": 1487692834.684, "TaskType": "RUN_COMMAND", "EndTime": 1487692835.005, "WindowExecutionId": "518d5565-5969-4cca-8f0e-da3b2EXAMPLE", "TaskExecutionId": "ac0c6ae1-daa3-4a89-832e-d3845EXAMPLE" } ] }

Pour plus d'informations, consultez la section Afficher les informations sur les tâches et les exécutions de tâches (AWS CLI) dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-maintenance-window-executions.

AWS CLI

Exemple 1 : répertorier toutes les exécutions pour une fenêtre de maintenance

L’exemple de describe-maintenance-window-executions suivant répertorie toutes les exécutions pour la fenêtre de maintenance spécifiée.

aws ssm describe-maintenance-window-executions \ --window-id "mw-ab12cd34eEXAMPLE"

Sortie :

{ "WindowExecutions": [ { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowExecutionId": "6027b513-64fe-4cf0-be7d-1191aEXAMPLE", "Status": "IN_PROGRESS", "StartTime": "2021-08-04T11:00:00.000000-07:00" }, { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowExecutionId": "ff75b750-4834-4377-8f61-b3cadEXAMPLE", "Status": "SUCCESS", "StartTime": "2021-08-03T11:00:00.000000-07:00", "EndTime": "2021-08-03T11:37:21.450000-07:00" }, { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowExecutionId": "9fac7dd9-ff21-42a5-96ad-bbc4bEXAMPLE", "Status": "FAILED", "StatusDetails": "One or more tasks in the orchestration failed.", "StartTime": "2021-08-02T11:00:00.000000-07:00", "EndTime": "2021-08-02T11:22:36.190000-07:00" } ] }

Exemple 2 : répertorier toutes les exécutions pour une fenêtre de maintenance avant une date spécifiée

L’exemple de describe-maintenance-window-executions suivant répertorie toutes les exécutions pour la fenêtre de maintenance spécifiée avant la date spécifiée.

aws ssm describe-maintenance-window-executions \ --window-id "mw-ab12cd34eEXAMPLE" \ --filters "Key=ExecutedBefore,Values=2021-08-03T00:00:00Z"

Sortie :

{ "WindowExecutions": [ { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowExecutionId": "9fac7dd9-ff21-42a5-96ad-bbc4bEXAMPLE", "Status": "FAILED", "StatusDetails": "One or more tasks in the orchestration failed.", "StartTime": "2021-08-02T11:00:00.000000-07:00", "EndTime": "2021-08-02T11:22:36.190000-07:00" } ] }

Exemple 3 : répertorier toutes les exécutions pour une fenêtre de maintenance après une date spécifiée

L’exemple de describe-maintenance-window-executions suivant répertorie toutes les exécutions pour la fenêtre de maintenance spécifiée après la date spécifiée.

aws ssm describe-maintenance-window-executions \ --window-id "mw-ab12cd34eEXAMPLE" \ --filters "Key=ExecutedAfter,Values=2021-08-04T00:00:00Z"

Sortie :

{ "WindowExecutions": [ { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowExecutionId": "6027b513-64fe-4cf0-be7d-1191aEXAMPLE", "Status": "IN_PROGRESS", "StartTime": "2021-08-04T11:00:00.000000-07:00" } ] }

Pour plus d'informations, consultez la section Afficher les informations relatives aux tâches et aux exécutions de tâches (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-maintenance-window-executions.

AWS CLI

Exemple 1 : répertorier toutes les exécutions pour une fenêtre de maintenance

L’exemple de describe-maintenance-window-executions suivant répertorie toutes les exécutions pour la fenêtre de maintenance spécifiée.

aws ssm describe-maintenance-window-executions \ --window-id "mw-ab12cd34eEXAMPLE"

Sortie :

{ "WindowExecutions": [ { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowExecutionId": "6027b513-64fe-4cf0-be7d-1191aEXAMPLE", "Status": "IN_PROGRESS", "StartTime": "2021-08-04T11:00:00.000000-07:00" }, { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowExecutionId": "ff75b750-4834-4377-8f61-b3cadEXAMPLE", "Status": "SUCCESS", "StartTime": "2021-08-03T11:00:00.000000-07:00", "EndTime": "2021-08-03T11:37:21.450000-07:00" }, { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowExecutionId": "9fac7dd9-ff21-42a5-96ad-bbc4bEXAMPLE", "Status": "FAILED", "StatusDetails": "One or more tasks in the orchestration failed.", "StartTime": "2021-08-02T11:00:00.000000-07:00", "EndTime": "2021-08-02T11:22:36.190000-07:00" } ] }

Exemple 2 : répertorier toutes les exécutions pour une fenêtre de maintenance avant une date spécifiée

L’exemple de describe-maintenance-window-executions suivant répertorie toutes les exécutions pour la fenêtre de maintenance spécifiée avant la date spécifiée.

aws ssm describe-maintenance-window-executions \ --window-id "mw-ab12cd34eEXAMPLE" \ --filters "Key=ExecutedBefore,Values=2021-08-03T00:00:00Z"

Sortie :

{ "WindowExecutions": [ { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowExecutionId": "9fac7dd9-ff21-42a5-96ad-bbc4bEXAMPLE", "Status": "FAILED", "StatusDetails": "One or more tasks in the orchestration failed.", "StartTime": "2021-08-02T11:00:00.000000-07:00", "EndTime": "2021-08-02T11:22:36.190000-07:00" } ] }

Exemple 3 : répertorier toutes les exécutions pour une fenêtre de maintenance après une date spécifiée

L’exemple de describe-maintenance-window-executions suivant répertorie toutes les exécutions pour la fenêtre de maintenance spécifiée après la date spécifiée.

aws ssm describe-maintenance-window-executions \ --window-id "mw-ab12cd34eEXAMPLE" \ --filters "Key=ExecutedAfter,Values=2021-08-04T00:00:00Z"

Sortie :

{ "WindowExecutions": [ { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowExecutionId": "6027b513-64fe-4cf0-be7d-1191aEXAMPLE", "Status": "IN_PROGRESS", "StartTime": "2021-08-04T11:00:00.000000-07:00" } ] }

Pour plus d'informations, consultez la section Afficher les informations relatives aux tâches et aux exécutions de tâches (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-maintenance-window-schedule.

AWS CLI

Exemple 1 : pour répertorier les prochaines exécutions pour une fenêtre de maintenance

L'describe-maintenance-window-scheduleexemple suivant répertorie toutes les exécutions à venir pour la fenêtre de maintenance spécifiée.

aws ssm describe-maintenance-window-schedule \ --window-id mw-ab12cd34eEXAMPLE

Sortie :

{ "ScheduledWindowExecutions": [ { "WindowId": "mw-ab12cd34eEXAMPLE", "Name": "My-First-Maintenance-Window", "ExecutionTime": "2020-02-19T16:00Z" }, { "WindowId": "mw-ab12cd34eEXAMPLE", "Name": "My-First-Maintenance-Window", "ExecutionTime": "2020-02-26T16:00Z" }, ... ] }

Exemple 2 : pour répertorier toutes les exécutions à venir pour une fenêtre de maintenance avant une date spécifiée

L'describe-maintenance-window-scheduleexemple suivant répertorie toutes les exécutions à venir pour la fenêtre de maintenance spécifiée qui ont lieu avant la date spécifiée.

aws ssm describe-maintenance-window-schedule \ --window-id mw-0ecb1226dd7b2e9a6 \ --filters "Key=ScheduledBefore,Values=2020-02-15T06:00:00Z"

Exemple 3 : pour répertorier toutes les exécutions à venir pour une fenêtre de maintenance après une date spécifiée

L'describe-maintenance-window-scheduleexemple suivant répertorie toutes les exécutions à venir pour la fenêtre de maintenance spécifiée qui se produisent après la date spécifiée.

aws ssm describe-maintenance-window-schedule \ --window-id mw-0ecb1226dd7b2e9a6 \ --filters "Key=ScheduledAfter,Values=2020-02-15T06:00:00Z"

Pour plus d'informations, consultez la section Afficher les informations relatives à la maintenance de Windows (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-maintenance-window-schedule.

AWS CLI

Exemple 1 : pour répertorier les prochaines exécutions pour une fenêtre de maintenance

L'describe-maintenance-window-scheduleexemple suivant répertorie toutes les exécutions à venir pour la fenêtre de maintenance spécifiée.

aws ssm describe-maintenance-window-schedule \ --window-id mw-ab12cd34eEXAMPLE

Sortie :

{ "ScheduledWindowExecutions": [ { "WindowId": "mw-ab12cd34eEXAMPLE", "Name": "My-First-Maintenance-Window", "ExecutionTime": "2020-02-19T16:00Z" }, { "WindowId": "mw-ab12cd34eEXAMPLE", "Name": "My-First-Maintenance-Window", "ExecutionTime": "2020-02-26T16:00Z" }, ... ] }

Exemple 2 : pour répertorier toutes les exécutions à venir pour une fenêtre de maintenance avant une date spécifiée

L'describe-maintenance-window-scheduleexemple suivant répertorie toutes les exécutions à venir pour la fenêtre de maintenance spécifiée qui ont lieu avant la date spécifiée.

aws ssm describe-maintenance-window-schedule \ --window-id mw-0ecb1226dd7b2e9a6 \ --filters "Key=ScheduledBefore,Values=2020-02-15T06:00:00Z"

Exemple 3 : pour répertorier toutes les exécutions à venir pour une fenêtre de maintenance après une date spécifiée

L'describe-maintenance-window-scheduleexemple suivant répertorie toutes les exécutions à venir pour la fenêtre de maintenance spécifiée qui se produisent après la date spécifiée.

aws ssm describe-maintenance-window-schedule \ --window-id mw-0ecb1226dd7b2e9a6 \ --filters "Key=ScheduledAfter,Values=2020-02-15T06:00:00Z"

Pour plus d'informations, consultez la section Afficher les informations relatives à la maintenance de Windows (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-maintenance-window-targets.

AWS CLI

Exemple 1 : répertorier toutes les cibles d’une fenêtre de maintenance

L’exemple de describe-maintenance-window-targets suivant répertorie toutes les cibles d’une fenêtre de maintenance.

aws ssm describe-maintenance-window-targets \ --window-id "mw-06cf17cbefEXAMPLE"

Sortie :

{ "Targets": [ { "ResourceType": "INSTANCE", "OwnerInformation": "Single instance", "WindowId": "mw-06cf17cbefEXAMPLE", "Targets": [ { "Values": [ "i-0000293ffdEXAMPLE" ], "Key": "InstanceIds" } ], "WindowTargetId": "350d44e6-28cc-44e2-951f-4b2c9EXAMPLE" }, { "ResourceType": "INSTANCE", "OwnerInformation": "Two instances in a list", "WindowId": "mw-06cf17cbefEXAMPLE", "Targets": [ { "Values": [ "i-0000293ffdEXAMPLE", "i-0cb2b964d3EXAMPLE" ], "Key": "InstanceIds" } ], "WindowTargetId": "e078a987-2866-47be-bedd-d9cf4EXAMPLE" } ] }

Exemple 2 : répertorier toutes les cibles d’une fenêtre de maintenance qui correspondent à une valeur d’information spécifique sur le propriétaire

L’exemple de describe-maintenance-window-targets suivant répertorie toutes les cibles d’une fenêtre de maintenance correspondant à une valeur spécifique.

aws ssm describe-maintenance-window-targets \ --window-id "mw-0ecb1226ddEXAMPLE" \ --filters "Key=OwnerInformation,Values=CostCenter1"

Sortie :

{ "Targets": [ { "WindowId": "mw-0ecb1226ddEXAMPLE", "WindowTargetId": "da89dcc3-7f9c-481d-ba2b-edcb7d0057f9", "ResourceType": "INSTANCE", "Targets": [ { "Key": "tag:Environment", "Values": [ "Prod" ] } ], "OwnerInformation": "CostCenter1", "Name": "ProdTarget1" } ] }

Pour plus d'informations, consultez la section Afficher les informations relatives à la maintenance de Windows (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-maintenance-window-targets.

AWS CLI

Exemple 1 : répertorier toutes les cibles d’une fenêtre de maintenance

L’exemple de describe-maintenance-window-targets suivant répertorie toutes les cibles d’une fenêtre de maintenance.

aws ssm describe-maintenance-window-targets \ --window-id "mw-06cf17cbefEXAMPLE"

Sortie :

{ "Targets": [ { "ResourceType": "INSTANCE", "OwnerInformation": "Single instance", "WindowId": "mw-06cf17cbefEXAMPLE", "Targets": [ { "Values": [ "i-0000293ffdEXAMPLE" ], "Key": "InstanceIds" } ], "WindowTargetId": "350d44e6-28cc-44e2-951f-4b2c9EXAMPLE" }, { "ResourceType": "INSTANCE", "OwnerInformation": "Two instances in a list", "WindowId": "mw-06cf17cbefEXAMPLE", "Targets": [ { "Values": [ "i-0000293ffdEXAMPLE", "i-0cb2b964d3EXAMPLE" ], "Key": "InstanceIds" } ], "WindowTargetId": "e078a987-2866-47be-bedd-d9cf4EXAMPLE" } ] }

Exemple 2 : répertorier toutes les cibles d’une fenêtre de maintenance qui correspondent à une valeur d’information spécifique sur le propriétaire

L’exemple de describe-maintenance-window-targets suivant répertorie toutes les cibles d’une fenêtre de maintenance correspondant à une valeur spécifique.

aws ssm describe-maintenance-window-targets \ --window-id "mw-0ecb1226ddEXAMPLE" \ --filters "Key=OwnerInformation,Values=CostCenter1"

Sortie :

{ "Targets": [ { "WindowId": "mw-0ecb1226ddEXAMPLE", "WindowTargetId": "da89dcc3-7f9c-481d-ba2b-edcb7d0057f9", "ResourceType": "INSTANCE", "Targets": [ { "Key": "tag:Environment", "Values": [ "Prod" ] } ], "OwnerInformation": "CostCenter1", "Name": "ProdTarget1" } ] }

Pour plus d'informations, consultez la section Afficher les informations relatives à la maintenance de Windows (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-maintenance-window-tasks.

AWS CLI

Exemple 1 : répertorier toutes les tâches d’une fenêtre de maintenance

L’exemple de describe-maintenance-window-tasks suivant répertorie toutes les tâches pour la fenêtre de maintenance spécifiée.

aws ssm describe-maintenance-window-tasks \ --window-id "mw-06cf17cbefEXAMPLE"

Sortie :

{ "Tasks": [ { "WindowId": "mw-06cf17cbefEXAMPLE", "WindowTaskId": "018b31c3-2d77-4b9e-bd48-c91edEXAMPLE", "TaskArn": "AWS-RestartEC2Instance", "TaskParameters": {}, "Type": "AUTOMATION", "Description": "Restarting EC2 Instance for maintenance", "MaxConcurrency": "1", "MaxErrors": "1", "Name": "My-Automation-Example-Task", "Priority": 0, "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "Targets": [ { "Key": "WindowTargetIds", "Values": [ "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE" ] } ] }, { "WindowId": "mw-06cf17cbefEXAMPLE", "WindowTaskId": "1943dee0-0a17-4978-9bf4-3cc2fEXAMPLE", "TaskArn": "AWS-DisableS3BucketPublicReadWrite", "TaskParameters": {}, "Type": "AUTOMATION", "Description": "Automation task to disable read/write access on public S3 buckets", "MaxConcurrency": "10", "MaxErrors": "5", "Name": "My-Disable-S3-Public-Read-Write-Access-Automation-Task", "Priority": 0, "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "Targets": [ { "Key": "WindowTargetIds", "Values": [ "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE" ] } ] } ] }

Exemple 2 : Pour répertorier toutes les tâches d'une fenêtre de maintenance qui invoque le document de RunPowerShellScript commande AWS-

L’exemple de describe-maintenance-window-tasks suivant répertorie toutes les tâches de la fenêtre de maintenance spécifiée qui invoque le document de commande AWS-RunPowerShellScript.

aws ssm describe-maintenance-window-tasks \ --window-id "mw-ab12cd34eEXAMPLE" \ --filters "Key=TaskArn,Values=AWS-RunPowerShellScript"

Sortie :

{ "Tasks": [ { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowTaskId": "0d36e6b4-3a4f-411e-adcb-3558eEXAMPLE", "TaskArn": "AWS-RunPowerShellScript", "Type": "RUN_COMMAND", "Targets": [ { "Key": "WindowTargetIds", "Values": [ "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE" ] } ], "TaskParameters": {}, "Priority": 1, "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "MaxConcurrency": "1", "MaxErrors": "1", "Name": "MyTask" } ] }

Exemple 3 : répertorier toutes les tâches d’une fenêtre de maintenance dont la priorité est de 3

L’exemple de describe-maintenance-window-tasks suivant liste toutes les tâches de la fenêtre de maintenance spécifiée qui ont une Priority de 3.

aws ssm describe-maintenance-window-tasks \ --window-id "mw-ab12cd34eEXAMPLE" \ --filters "Key=Priority,Values=3"

Sortie :

{ "Tasks": [ { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowTaskId": "0d36e6b4-3a4f-411e-adcb-3558eEXAMPLE", "TaskArn": "AWS-RunPowerShellScript", "Type": "RUN_COMMAND", "Targets": [ { "Key": "WindowTargetIds", "Values": [ "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE" ] } ], "TaskParameters": {}, "Priority": 3, "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "MaxConcurrency": "1", "MaxErrors": "1", "Name": "MyRunCommandTask" }, { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowTaskId": "ee45feff-ad65-4a6c-b478-5cab8EXAMPLE", "TaskArn": "AWS-RestartEC2Instance", "Type": "AUTOMATION", "Targets": [ { "Key": "WindowTargetIds", "Values": [ "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE" ] } ], "TaskParameters": {}, "Priority": 3, "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "MaxConcurrency": "10", "MaxErrors": "5", "Name": "My-Automation-Task", "Description": "A description for my Automation task" } ] }

Exemple 4 : répertorier toutes les tâches d’une fenêtre de maintenance qui ont une priorité de 1 et qui utilisent Run Command

Cet exemple de describe-maintenance-window-tasks répertorie toutes les tâches de la fenêtre de maintenance spécifiée qui ont une Priority de 1 et qui utilisent Run Command.

aws ssm describe-maintenance-window-tasks \ --window-id "mw-ab12cd34eEXAMPLE" \ --filters "Key=Priority,Values=1" "Key=TaskType,Values=RUN_COMMAND"

Sortie :

{ "Tasks": [ { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowTaskId": "0d36e6b4-3a4f-411e-adcb-3558eEXAMPLE", "TaskArn": "AWS-RunPowerShellScript", "Type": "RUN_COMMAND", "Targets": [ { "Key": "WindowTargetIds", "Values": [ "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE" ] } ], "TaskParameters": {}, "Priority": 1, "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "MaxConcurrency": "1", "MaxErrors": "1", "Name": "MyRunCommandTask" } ] }

Pour plus d'informations, consultez la section Afficher les informations sur les fenêtres de maintenance (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-maintenance-window-tasks.

AWS CLI

Exemple 1 : répertorier toutes les tâches d’une fenêtre de maintenance

L’exemple de describe-maintenance-window-tasks suivant répertorie toutes les tâches pour la fenêtre de maintenance spécifiée.

aws ssm describe-maintenance-window-tasks \ --window-id "mw-06cf17cbefEXAMPLE"

Sortie :

{ "Tasks": [ { "WindowId": "mw-06cf17cbefEXAMPLE", "WindowTaskId": "018b31c3-2d77-4b9e-bd48-c91edEXAMPLE", "TaskArn": "AWS-RestartEC2Instance", "TaskParameters": {}, "Type": "AUTOMATION", "Description": "Restarting EC2 Instance for maintenance", "MaxConcurrency": "1", "MaxErrors": "1", "Name": "My-Automation-Example-Task", "Priority": 0, "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "Targets": [ { "Key": "WindowTargetIds", "Values": [ "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE" ] } ] }, { "WindowId": "mw-06cf17cbefEXAMPLE", "WindowTaskId": "1943dee0-0a17-4978-9bf4-3cc2fEXAMPLE", "TaskArn": "AWS-DisableS3BucketPublicReadWrite", "TaskParameters": {}, "Type": "AUTOMATION", "Description": "Automation task to disable read/write access on public S3 buckets", "MaxConcurrency": "10", "MaxErrors": "5", "Name": "My-Disable-S3-Public-Read-Write-Access-Automation-Task", "Priority": 0, "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "Targets": [ { "Key": "WindowTargetIds", "Values": [ "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE" ] } ] } ] }

Exemple 2 : Pour répertorier toutes les tâches d'une fenêtre de maintenance qui invoque le document de RunPowerShellScript commande AWS-

L’exemple de describe-maintenance-window-tasks suivant répertorie toutes les tâches de la fenêtre de maintenance spécifiée qui invoque le document de commande AWS-RunPowerShellScript.

aws ssm describe-maintenance-window-tasks \ --window-id "mw-ab12cd34eEXAMPLE" \ --filters "Key=TaskArn,Values=AWS-RunPowerShellScript"

Sortie :

{ "Tasks": [ { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowTaskId": "0d36e6b4-3a4f-411e-adcb-3558eEXAMPLE", "TaskArn": "AWS-RunPowerShellScript", "Type": "RUN_COMMAND", "Targets": [ { "Key": "WindowTargetIds", "Values": [ "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE" ] } ], "TaskParameters": {}, "Priority": 1, "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "MaxConcurrency": "1", "MaxErrors": "1", "Name": "MyTask" } ] }

Exemple 3 : répertorier toutes les tâches d’une fenêtre de maintenance dont la priorité est de 3

L’exemple de describe-maintenance-window-tasks suivant liste toutes les tâches de la fenêtre de maintenance spécifiée qui ont une Priority de 3.

aws ssm describe-maintenance-window-tasks \ --window-id "mw-ab12cd34eEXAMPLE" \ --filters "Key=Priority,Values=3"

Sortie :

{ "Tasks": [ { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowTaskId": "0d36e6b4-3a4f-411e-adcb-3558eEXAMPLE", "TaskArn": "AWS-RunPowerShellScript", "Type": "RUN_COMMAND", "Targets": [ { "Key": "WindowTargetIds", "Values": [ "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE" ] } ], "TaskParameters": {}, "Priority": 3, "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "MaxConcurrency": "1", "MaxErrors": "1", "Name": "MyRunCommandTask" }, { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowTaskId": "ee45feff-ad65-4a6c-b478-5cab8EXAMPLE", "TaskArn": "AWS-RestartEC2Instance", "Type": "AUTOMATION", "Targets": [ { "Key": "WindowTargetIds", "Values": [ "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE" ] } ], "TaskParameters": {}, "Priority": 3, "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "MaxConcurrency": "10", "MaxErrors": "5", "Name": "My-Automation-Task", "Description": "A description for my Automation task" } ] }

Exemple 4 : répertorier toutes les tâches d’une fenêtre de maintenance qui ont une priorité de 1 et qui utilisent Run Command

Cet exemple de describe-maintenance-window-tasks répertorie toutes les tâches de la fenêtre de maintenance spécifiée qui ont une Priority de 1 et qui utilisent Run Command.

aws ssm describe-maintenance-window-tasks \ --window-id "mw-ab12cd34eEXAMPLE" \ --filters "Key=Priority,Values=1" "Key=TaskType,Values=RUN_COMMAND"

Sortie :

{ "Tasks": [ { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowTaskId": "0d36e6b4-3a4f-411e-adcb-3558eEXAMPLE", "TaskArn": "AWS-RunPowerShellScript", "Type": "RUN_COMMAND", "Targets": [ { "Key": "WindowTargetIds", "Values": [ "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE" ] } ], "TaskParameters": {}, "Priority": 1, "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "MaxConcurrency": "1", "MaxErrors": "1", "Name": "MyRunCommandTask" } ] }

Pour plus d'informations, consultez la section Afficher les informations sur les fenêtres de maintenance (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-maintenance-windows-for-target.

AWS CLI

Pour répertorier toutes les fenêtres de maintenance associées à une instance spécifique

L'describe-maintenance-windows-for-targetexemple suivant répertorie les fenêtres de maintenance associées à des cibles ou à des tâches à l'instance spécifiée.

aws ssm describe-maintenance-windows-for-target \ --targets Key=InstanceIds,Values=i-1234567890EXAMPLE \ --resource-type INSTANCE

Sortie :

{ "WindowIdentities": [ { "WindowId": "mw-0c5ed765acEXAMPLE", "Name": "My-First-Maintenance-Window" } ] }

Pour plus d'informations, consultez la section Afficher les informations relatives à la maintenance de Windows (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-maintenance-windows-for-target.

AWS CLI

Pour répertorier toutes les fenêtres de maintenance associées à une instance spécifique

L'describe-maintenance-windows-for-targetexemple suivant répertorie les fenêtres de maintenance associées à des cibles ou à des tâches à l'instance spécifiée.

aws ssm describe-maintenance-windows-for-target \ --targets Key=InstanceIds,Values=i-1234567890EXAMPLE \ --resource-type INSTANCE

Sortie :

{ "WindowIdentities": [ { "WindowId": "mw-0c5ed765acEXAMPLE", "Name": "My-First-Maintenance-Window" } ] }

Pour plus d'informations, consultez la section Afficher les informations relatives à la maintenance de Windows (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-maintenance-windows.

AWS CLI

Exemple 1 : répertorier toutes les fenêtres de maintenance

L'describe-maintenance-windowsexemple suivant répertorie toutes les fenêtres de maintenance de votre AWS compte dans la région actuelle.

aws ssm describe-maintenance-windows

Sortie :

{ "WindowIdentities": [ { "WindowId": "mw-0ecb1226ddEXAMPLE", "Name": "MyMaintenanceWindow-1", "Enabled": true, "Duration": 2, "Cutoff": 1, "Schedule": "rate(180 minutes)", "NextExecutionTime": "2020-02-12T23:19:20.596Z" }, { "WindowId": "mw-03eb9db428EXAMPLE", "Name": "MyMaintenanceWindow-2", "Enabled": true, "Duration": 3, "Cutoff": 1, "Schedule": "rate(7 days)", "NextExecutionTime": "2020-02-17T23:22:00.956Z" }, ] }

Exemple 2 : répertorier toutes les fenêtres de maintenance activées

L’exemple de describe-maintenance-windows suivant répertorie toutes les fenêtres de maintenance activées.

aws ssm describe-maintenance-windows \ --filters "Key=Enabled,Values=true"

Exemple 3 : répertorier les fenêtres de maintenance qui correspondent à un nom spécifique

Cet exemple de describe-maintenance-windows répertorie toutes les fenêtres de maintenance portant le nom spécifié.

aws ssm describe-maintenance-windows \ --filters "Key=Name,Values=MyMaintenanceWindow"

Pour plus d'informations, consultez la section Afficher les informations relatives à la maintenance de Windows (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-maintenance-windows.

AWS CLI

Exemple 1 : répertorier toutes les fenêtres de maintenance

L'describe-maintenance-windowsexemple suivant répertorie toutes les fenêtres de maintenance de votre AWS compte dans la région actuelle.

aws ssm describe-maintenance-windows

Sortie :

{ "WindowIdentities": [ { "WindowId": "mw-0ecb1226ddEXAMPLE", "Name": "MyMaintenanceWindow-1", "Enabled": true, "Duration": 2, "Cutoff": 1, "Schedule": "rate(180 minutes)", "NextExecutionTime": "2020-02-12T23:19:20.596Z" }, { "WindowId": "mw-03eb9db428EXAMPLE", "Name": "MyMaintenanceWindow-2", "Enabled": true, "Duration": 3, "Cutoff": 1, "Schedule": "rate(7 days)", "NextExecutionTime": "2020-02-17T23:22:00.956Z" }, ] }

Exemple 2 : répertorier toutes les fenêtres de maintenance activées

L’exemple de describe-maintenance-windows suivant répertorie toutes les fenêtres de maintenance activées.

aws ssm describe-maintenance-windows \ --filters "Key=Enabled,Values=true"

Exemple 3 : répertorier les fenêtres de maintenance qui correspondent à un nom spécifique

Cet exemple de describe-maintenance-windows répertorie toutes les fenêtres de maintenance portant le nom spécifié.

aws ssm describe-maintenance-windows \ --filters "Key=Name,Values=MyMaintenanceWindow"

Pour plus d'informations, consultez la section Afficher les informations relatives à la maintenance de Windows (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-ops-items.

AWS CLI

Pour répertorier un ensemble de OpsItems

L'describe-ops-itemsexemple suivant affiche une liste de toutes les offres ouvertes OpsItems dans votre AWS compte.

aws ssm describe-ops-items \ --ops-item-filters "Key=Status,Values=Open,Operator=Equal"

Sortie :

{ "OpsItemSummaries": [ { "CreatedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "CreatedTime": "2020-03-14T17:02:46.375000-07:00", "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "LastModifiedTime": "2020-03-14T17:02:46.375000-07:00", "Source": "SSM", "Status": "Open", "OpsItemId": "oi-7cfc5EXAMPLE", "Title": "SSM Maintenance Window execution failed", "OperationalData": { "/aws/dedup": { "Value": "{\"dedupString\":\"SSMOpsItems-SSM-maintenance-window-execution-failed\"}", "Type": "SearchableString" }, "/aws/resources": { "Value": "[{\"arn\":\"arn:aws:ssm:us-east-2:111222333444:maintenancewindow/mw-034093d322EXAMPLE\"}]", "Type": "SearchableString" } }, "Category": "Availability", "Severity": "3" }, { "CreatedBy": "arn:aws:sts::1112223233444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "CreatedTime": "2020-02-26T11:43:15.426000-08:00", "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "LastModifiedTime": "2020-02-26T11:43:15.426000-08:00", "Source": "EC2", "Status": "Open", "OpsItemId": "oi-6f966EXAMPLE", "Title": "EC2 instance stopped", "OperationalData": { "/aws/automations": { "Value": "[ { \"automationType\": \"AWS:SSM:Automation\", \"automationId\": \"AWS-RestartEC2Instance\" } ]", "Type": "SearchableString" }, "/aws/dedup": { "Value": "{\"dedupString\":\"SSMOpsItems-EC2-instance-stopped\"}", "Type": "SearchableString" }, "/aws/resources": { "Value": "[{\"arn\":\"arn:aws:ec2:us-east-2:111222333444:instance/i-0beccfbc02EXAMPLE\"}]", "Type": "SearchableString" } }, "Category": "Availability", "Severity": "3" } ] }

Pour plus d'informations, reportez-vous à la section Travailler avec OpsItems dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir DescribeOpsItemsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-ops-items.

AWS CLI

Pour répertorier un ensemble de OpsItems

L'describe-ops-itemsexemple suivant affiche une liste de toutes les offres ouvertes OpsItems dans votre AWS compte.

aws ssm describe-ops-items \ --ops-item-filters "Key=Status,Values=Open,Operator=Equal"

Sortie :

{ "OpsItemSummaries": [ { "CreatedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "CreatedTime": "2020-03-14T17:02:46.375000-07:00", "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "LastModifiedTime": "2020-03-14T17:02:46.375000-07:00", "Source": "SSM", "Status": "Open", "OpsItemId": "oi-7cfc5EXAMPLE", "Title": "SSM Maintenance Window execution failed", "OperationalData": { "/aws/dedup": { "Value": "{\"dedupString\":\"SSMOpsItems-SSM-maintenance-window-execution-failed\"}", "Type": "SearchableString" }, "/aws/resources": { "Value": "[{\"arn\":\"arn:aws:ssm:us-east-2:111222333444:maintenancewindow/mw-034093d322EXAMPLE\"}]", "Type": "SearchableString" } }, "Category": "Availability", "Severity": "3" }, { "CreatedBy": "arn:aws:sts::1112223233444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "CreatedTime": "2020-02-26T11:43:15.426000-08:00", "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "LastModifiedTime": "2020-02-26T11:43:15.426000-08:00", "Source": "EC2", "Status": "Open", "OpsItemId": "oi-6f966EXAMPLE", "Title": "EC2 instance stopped", "OperationalData": { "/aws/automations": { "Value": "[ { \"automationType\": \"AWS:SSM:Automation\", \"automationId\": \"AWS-RestartEC2Instance\" } ]", "Type": "SearchableString" }, "/aws/dedup": { "Value": "{\"dedupString\":\"SSMOpsItems-EC2-instance-stopped\"}", "Type": "SearchableString" }, "/aws/resources": { "Value": "[{\"arn\":\"arn:aws:ec2:us-east-2:111222333444:instance/i-0beccfbc02EXAMPLE\"}]", "Type": "SearchableString" } }, "Category": "Availability", "Severity": "3" } ] }

Pour plus d'informations, reportez-vous à la section Travailler avec OpsItems dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir DescribeOpsItemsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-parameters.

AWS CLI

Exemple 1 : répertorier tous les paramètres

L'describe-parametersexemple suivant répertorie tous les paramètres du AWS compte courant et de la région.

aws ssm describe-parameters

Sortie :

{ "Parameters": [ { "Name": "MySecureStringParameter", "Type": "SecureString", "KeyId": "alias/aws/ssm", "LastModifiedDate": 1582155479.205, "LastModifiedUser": "arn:aws:sts::111222333444:assumed-role/Admin/Richard-Roe-Managed", "Description": "This is a SecureString parameter", "Version": 2, "Tier": "Advanced", "Policies": [ { "PolicyText": "{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2020-07-07T22:30:00Z\"}}", "PolicyType": "Expiration", "PolicyStatus": "Pending" }, { "PolicyText": "{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"12\",\"Unit\":\"Hours\"}}", "PolicyType": "ExpirationNotification", "PolicyStatus": "Pending" } ] }, { "Name": "MyStringListParameter", "Type": "StringList", "LastModifiedDate": 1582154764.222, "LastModifiedUser": "arn:aws:iam::111222333444:user/Mary-Major", "Description": "This is a StringList parameter", "Version": 1, "Tier": "Standard", "Policies": [] }, { "Name": "MyStringParameter", "Type": "String", "LastModifiedDate": 1582154711.976, "LastModifiedUser": "arn:aws:iam::111222333444:user/Alejandro-Rosalez", "Description": "This is a String parameter", "Version": 1, "Tier": "Standard", "Policies": [] }, { "Name": "latestAmi", "Type": "String", "LastModifiedDate": 1580862415.521, "LastModifiedUser": "arn:aws:sts::111222333444:assumed-role/lambda-ssm-role/Automation-UpdateSSM-Param", "Version": 3, "Tier": "Standard", "Policies": [] } ] }

Exemple 2 : répertorier tous les paramètres correspondant à des métadonnées spécifiques

Cet exemple de describe-parameters répertorie tous les paramètres correspondant à un filtre.

aws ssm describe-parameters --filters « Clé = type, valeurs = » StringList

Sortie :

{ "Parameters": [ { "Name": "MyStringListParameter", "Type": "StringList", "LastModifiedDate": 1582154764.222, "LastModifiedUser": "arn:aws:iam::111222333444:user/Mary-Major", "Description": "This is a StringList parameter", "Version": 1, "Tier": "Standard", "Policies": [] } ] }

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

  • Pour plus de détails sur l'API, voir DescribeParametersla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-parameters.

AWS CLI

Exemple 1 : répertorier tous les paramètres

L'describe-parametersexemple suivant répertorie tous les paramètres du AWS compte courant et de la région.

aws ssm describe-parameters

Sortie :

{ "Parameters": [ { "Name": "MySecureStringParameter", "Type": "SecureString", "KeyId": "alias/aws/ssm", "LastModifiedDate": 1582155479.205, "LastModifiedUser": "arn:aws:sts::111222333444:assumed-role/Admin/Richard-Roe-Managed", "Description": "This is a SecureString parameter", "Version": 2, "Tier": "Advanced", "Policies": [ { "PolicyText": "{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2020-07-07T22:30:00Z\"}}", "PolicyType": "Expiration", "PolicyStatus": "Pending" }, { "PolicyText": "{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"12\",\"Unit\":\"Hours\"}}", "PolicyType": "ExpirationNotification", "PolicyStatus": "Pending" } ] }, { "Name": "MyStringListParameter", "Type": "StringList", "LastModifiedDate": 1582154764.222, "LastModifiedUser": "arn:aws:iam::111222333444:user/Mary-Major", "Description": "This is a StringList parameter", "Version": 1, "Tier": "Standard", "Policies": [] }, { "Name": "MyStringParameter", "Type": "String", "LastModifiedDate": 1582154711.976, "LastModifiedUser": "arn:aws:iam::111222333444:user/Alejandro-Rosalez", "Description": "This is a String parameter", "Version": 1, "Tier": "Standard", "Policies": [] }, { "Name": "latestAmi", "Type": "String", "LastModifiedDate": 1580862415.521, "LastModifiedUser": "arn:aws:sts::111222333444:assumed-role/lambda-ssm-role/Automation-UpdateSSM-Param", "Version": 3, "Tier": "Standard", "Policies": [] } ] }

Exemple 2 : répertorier tous les paramètres correspondant à des métadonnées spécifiques

Cet exemple de describe-parameters répertorie tous les paramètres correspondant à un filtre.

aws ssm describe-parameters --filters « Clé = type, valeurs = » StringList

Sortie :

{ "Parameters": [ { "Name": "MyStringListParameter", "Type": "StringList", "LastModifiedDate": 1582154764.222, "LastModifiedUser": "arn:aws:iam::111222333444:user/Mary-Major", "Description": "This is a StringList parameter", "Version": 1, "Tier": "Standard", "Policies": [] } ] }

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

  • Pour plus de détails sur l'API, voir DescribeParametersla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-patch-baselines.

AWS CLI

Exemple 1 : répertorier tous les référentiels de correctifs

L’exemple de describe-patch-baselines suivant permet d’obtenir les détails de tous les référentiels de correctifs de votre compte dans la région actuelle.

aws ssm describe-patch-baselines

Sortie :

{ "BaselineIdentities": [ { "BaselineName": "AWS-SuseDefaultPatchBaseline", "DefaultBaseline": true, "BaselineDescription": "Default Patch Baseline for Suse Provided by AWS.", "BaselineId": "arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0123fdb36e334a3b2", "OperatingSystem": "SUSE" }, { "BaselineName": "AWS-DefaultPatchBaseline", "DefaultBaseline": false, "BaselineDescription": "Default Patch Baseline Provided by AWS.", "BaselineId": "arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-020d361a05defe4ed", "OperatingSystem": "WINDOWS" }, ... { "BaselineName": "MyWindowsPatchBaseline", "DefaultBaseline": true, "BaselineDescription": "My patch baseline for EC2 instances for Windows Server", "BaselineId": "pb-0ad00e0dd7EXAMPLE", "OperatingSystem": "WINDOWS" } ] }

Exemple 2 : Pour répertorier toutes les lignes de base de correctifs fournies par AWS

L'describe-patch-baselinesexemple suivant répertorie toutes les lignes de base de correctifs fournies par AWS.

aws ssm describe-patch-baselines \ --filters "Key=OWNER,Values=[AWS]"

Exemple 3 : répertorier tous les référentiels de correctifs que vous possédez

L’exemple de describe-patch-baselines suivant répertorie tous les référentiels de correctifs personnalisés créés dans votre compte dans la région actuelle.

aws ssm describe-patch-baselines \ --filters "Key=OWNER,Values=[Self]"

Pour plus d’informations, consultez À propos des référentiels de correctifs prédéfinis et personnalisés dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-patch-baselines.

AWS CLI

Exemple 1 : répertorier tous les référentiels de correctifs

L’exemple de describe-patch-baselines suivant permet d’obtenir les détails de tous les référentiels de correctifs de votre compte dans la région actuelle.

aws ssm describe-patch-baselines

Sortie :

{ "BaselineIdentities": [ { "BaselineName": "AWS-SuseDefaultPatchBaseline", "DefaultBaseline": true, "BaselineDescription": "Default Patch Baseline for Suse Provided by AWS.", "BaselineId": "arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0123fdb36e334a3b2", "OperatingSystem": "SUSE" }, { "BaselineName": "AWS-DefaultPatchBaseline", "DefaultBaseline": false, "BaselineDescription": "Default Patch Baseline Provided by AWS.", "BaselineId": "arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-020d361a05defe4ed", "OperatingSystem": "WINDOWS" }, ... { "BaselineName": "MyWindowsPatchBaseline", "DefaultBaseline": true, "BaselineDescription": "My patch baseline for EC2 instances for Windows Server", "BaselineId": "pb-0ad00e0dd7EXAMPLE", "OperatingSystem": "WINDOWS" } ] }

Exemple 2 : Pour répertorier toutes les lignes de base de correctifs fournies par AWS

L'describe-patch-baselinesexemple suivant répertorie toutes les lignes de base de correctifs fournies par AWS.

aws ssm describe-patch-baselines \ --filters "Key=OWNER,Values=[AWS]"

Exemple 3 : répertorier tous les référentiels de correctifs que vous possédez

L’exemple de describe-patch-baselines suivant répertorie tous les référentiels de correctifs personnalisés créés dans votre compte dans la région actuelle.

aws ssm describe-patch-baselines \ --filters "Key=OWNER,Values=[Self]"

Pour plus d’informations, consultez À propos des référentiels de correctifs prédéfinis et personnalisés dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-patch-group-state.

AWS CLI

Pour obtenir l’état d’un groupe de correctifs

L’exemple de describe-patch-group-state suivant récupère le récapitulatif de haut niveau de la conformité des correctifs pour un groupe de correctifs.

aws ssm describe-patch-group-state \ --patch-group "Production"

Sortie :

{ "Instances": 21, "InstancesWithCriticalNonCompliantPatches": 1, "InstancesWithFailedPatches": 2, "InstancesWithInstalledOtherPatches": 3, "InstancesWithInstalledPatches": 21, "InstancesWithInstalledPendingRebootPatches": 2, "InstancesWithInstalledRejectedPatches": 1, "InstancesWithMissingPatches": 3, "InstancesWithNotApplicablePatches": 4, "InstancesWithOtherNonCompliantPatches": 1, "InstancesWithSecurityNonCompliantPatches": 1, "InstancesWithUnreportedNotApplicablePatches": 2 }

Pour plus d'informations, reportez-vous aux sections À propos des groupes de correctifs < https://docs.aws.amazon.com/systems-manager/ latest/userguide/sysman -patch-patchgroups.html>__ et Comprendre les valeurs d'état de conformité des correctifs dans le Guide de l'utilisateur de Systems Manager.AWS

L'exemple de code suivant montre comment utiliserdescribe-patch-group-state.

AWS CLI

Pour obtenir l’état d’un groupe de correctifs

L’exemple de describe-patch-group-state suivant récupère le récapitulatif de haut niveau de la conformité des correctifs pour un groupe de correctifs.

aws ssm describe-patch-group-state \ --patch-group "Production"

Sortie :

{ "Instances": 21, "InstancesWithCriticalNonCompliantPatches": 1, "InstancesWithFailedPatches": 2, "InstancesWithInstalledOtherPatches": 3, "InstancesWithInstalledPatches": 21, "InstancesWithInstalledPendingRebootPatches": 2, "InstancesWithInstalledRejectedPatches": 1, "InstancesWithMissingPatches": 3, "InstancesWithNotApplicablePatches": 4, "InstancesWithOtherNonCompliantPatches": 1, "InstancesWithSecurityNonCompliantPatches": 1, "InstancesWithUnreportedNotApplicablePatches": 2 }

Pour plus d'informations, reportez-vous aux sections À propos des groupes de correctifs < https://docs.aws.amazon.com/systems-manager/ latest/userguide/sysman -patch-patchgroups.html>__ et Comprendre les valeurs d'état de conformité des correctifs dans le Guide de l'utilisateur de Systems Manager.AWS

L'exemple de code suivant montre comment utiliserdescribe-patch-groups.

AWS CLI

Pour afficher les enregistrements de groupes de correctifs

L’exemple de describe-patch-groups suivant répertorie les enregistrements de groupes de correctifs.

aws ssm describe-patch-groups

Sortie :

{ "Mappings": [ { "PatchGroup": "Production", "BaselineIdentity": { "BaselineId": "pb-0123456789abcdef0", "BaselineName": "ProdPatching", "OperatingSystem": "WINDOWS", "BaselineDescription": "Patches for Production", "DefaultBaseline": false } }, { "PatchGroup": "Development", "BaselineIdentity": { "BaselineId": "pb-0713accee01234567", "BaselineName": "DevPatching", "OperatingSystem": "WINDOWS", "BaselineDescription": "Patches for Development", "DefaultBaseline": true } }, ... ] }

Pour plus d'informations, consultez les sections Créer un groupe de correctifs < https://docs.aws.amazon.com/systems-manager/ latest/userguide/sysman - patch-group-tagging .html>__ et Ajouter un groupe de correctifs à une ligne de base de correctifs dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir DescribePatchGroupsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-patch-groups.

AWS CLI

Pour afficher les enregistrements de groupes de correctifs

L’exemple de describe-patch-groups suivant répertorie les enregistrements de groupes de correctifs.

aws ssm describe-patch-groups

Sortie :

{ "Mappings": [ { "PatchGroup": "Production", "BaselineIdentity": { "BaselineId": "pb-0123456789abcdef0", "BaselineName": "ProdPatching", "OperatingSystem": "WINDOWS", "BaselineDescription": "Patches for Production", "DefaultBaseline": false } }, { "PatchGroup": "Development", "BaselineIdentity": { "BaselineId": "pb-0713accee01234567", "BaselineName": "DevPatching", "OperatingSystem": "WINDOWS", "BaselineDescription": "Patches for Development", "DefaultBaseline": true } }, ... ] }

Pour plus d'informations, consultez les sections Créer un groupe de correctifs < https://docs.aws.amazon.com/systems-manager/ latest/userguide/sysman - patch-group-tagging .html>__ et Ajouter un groupe de correctifs à une ligne de base de correctifs dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir DescribePatchGroupsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-patch-properties.

AWS CLI

Pour répertorier la disponibilité des correctifs Amazon Linux

L'describe-patch-propertiesexemple suivant affiche une liste des produits Amazon Linux pour lesquels des correctifs sont disponibles dans votre AWS compte.

aws ssm describe-patch-properties \ --operating-system AMAZON_LINUX \ --property PRODUCT

Sortie :

{ "Properties": [ { "Name": "AmazonLinux2012.03" }, { "Name": "AmazonLinux2012.09" }, { "Name": "AmazonLinux2013.03" }, { "Name": "AmazonLinux2013.09" }, { "Name": "AmazonLinux2014.03" }, { "Name": "AmazonLinux2014.09" }, { "Name": "AmazonLinux2015.03" }, { "Name": "AmazonLinux2015.09" }, { "Name": "AmazonLinux2016.03" }, { "Name": "AmazonLinux2016.09" }, { "Name": "AmazonLinux2017.03" }, { "Name": "AmazonLinux2017.09" }, { "Name": "AmazonLinux2018.03" } ] }

Pour plus d’informations, consultez À propos des référentiels de correctifs dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-patch-properties.

AWS CLI

Pour répertorier la disponibilité des correctifs Amazon Linux

L'describe-patch-propertiesexemple suivant affiche une liste des produits Amazon Linux pour lesquels des correctifs sont disponibles dans votre AWS compte.

aws ssm describe-patch-properties \ --operating-system AMAZON_LINUX \ --property PRODUCT

Sortie :

{ "Properties": [ { "Name": "AmazonLinux2012.03" }, { "Name": "AmazonLinux2012.09" }, { "Name": "AmazonLinux2013.03" }, { "Name": "AmazonLinux2013.09" }, { "Name": "AmazonLinux2014.03" }, { "Name": "AmazonLinux2014.09" }, { "Name": "AmazonLinux2015.03" }, { "Name": "AmazonLinux2015.09" }, { "Name": "AmazonLinux2016.03" }, { "Name": "AmazonLinux2016.09" }, { "Name": "AmazonLinux2017.03" }, { "Name": "AmazonLinux2017.09" }, { "Name": "AmazonLinux2018.03" } ] }

Pour plus d’informations, consultez À propos des référentiels de correctifs dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdescribe-sessions.

AWS CLI

Exemple 1 : pour répertorier toutes les sessions actives du gestionnaire de session

Cet describe-sessions exemple extrait la liste des dernières sessions actives créées (sessions connectées et déconnectées) au cours des 30 derniers jours et démarrées par l'utilisateur spécifié. Cette commande renvoie uniquement les résultats des connexions aux cibles initiées à l'aide du gestionnaire de session. Il ne répertorie pas les connexions établies par d'autres moyens, tels que les connexions de bureau à distance ou SSH.

aws ssm describe-sessions \ --state "Active" \ --filters "key=Owner,value=arn:aws:sts::123456789012:assumed-role/Administrator/Shirley-Rodriguez"

Sortie :

{ "Sessions": [ { "SessionId": "John-07a16060613c408b5", "Target": "i-1234567890abcdef0", "Status": "Connected", "StartDate": 1550676938.352, "Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Shirley-Rodriguez", "OutputUrl": {} }, { "SessionId": "John-01edf534b8b56e8eb", "Target": "i-9876543210abcdef0", "Status": "Connected", "StartDate": 1550676842.194, "Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Shirley-Rodriguez", "OutputUrl": {} } ] }

Exemple 2 : pour répertorier toutes les sessions du gestionnaire de session terminées

Cet describe-sessions exemple extrait une liste des dernières sessions interrompues au cours des 30 derniers jours pour tous les utilisateurs.

aws ssm describe-sessions \ --state "History"

Sortie :

{ "Sessions": [ { "SessionId": "Mary-Major-0022b1eb2b0d9e3bd", "Target": "i-1234567890abcdef0", "Status": "Terminated", "StartDate": 1550520701.256, "EndDate": 1550521931.563, "Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Mary-Major" }, { "SessionId": "Jane-Roe-0db53f487931ed9d4", "Target": "i-9876543210abcdef0", "Status": "Terminated", "StartDate": 1550161369.149, "EndDate": 1550162580.329, "Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Jane-Roe" }, ... ], "NextToken": "--token string truncated--" }

Pour plus d'informations, consultez la section Afficher l'historique des sessions dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir DescribeSessionsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-sessions.

AWS CLI

Exemple 1 : pour répertorier toutes les sessions actives du gestionnaire de session

Cet describe-sessions exemple extrait la liste des dernières sessions actives créées (sessions connectées et déconnectées) au cours des 30 derniers jours et démarrées par l'utilisateur spécifié. Cette commande renvoie uniquement les résultats des connexions aux cibles initiées à l'aide du gestionnaire de session. Il ne répertorie pas les connexions établies par d'autres moyens, tels que les connexions de bureau à distance ou SSH.

aws ssm describe-sessions \ --state "Active" \ --filters "key=Owner,value=arn:aws:sts::123456789012:assumed-role/Administrator/Shirley-Rodriguez"

Sortie :

{ "Sessions": [ { "SessionId": "John-07a16060613c408b5", "Target": "i-1234567890abcdef0", "Status": "Connected", "StartDate": 1550676938.352, "Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Shirley-Rodriguez", "OutputUrl": {} }, { "SessionId": "John-01edf534b8b56e8eb", "Target": "i-9876543210abcdef0", "Status": "Connected", "StartDate": 1550676842.194, "Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Shirley-Rodriguez", "OutputUrl": {} } ] }

Exemple 2 : pour répertorier toutes les sessions du gestionnaire de session terminées

Cet describe-sessions exemple extrait une liste des dernières sessions interrompues au cours des 30 derniers jours pour tous les utilisateurs.

aws ssm describe-sessions \ --state "History"

Sortie :

{ "Sessions": [ { "SessionId": "Mary-Major-0022b1eb2b0d9e3bd", "Target": "i-1234567890abcdef0", "Status": "Terminated", "StartDate": 1550520701.256, "EndDate": 1550521931.563, "Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Mary-Major" }, { "SessionId": "Jane-Roe-0db53f487931ed9d4", "Target": "i-9876543210abcdef0", "Status": "Terminated", "StartDate": 1550161369.149, "EndDate": 1550162580.329, "Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Jane-Roe" }, ... ], "NextToken": "--token string truncated--" }

Pour plus d'informations, consultez la section Afficher l'historique des sessions dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir DescribeSessionsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdisassociate-ops-item-related-item.

AWS CLI

Pour supprimer une association d'articles connexes

L'disassociate-ops-item-related-itemexemple suivant supprime l'association entre le OpsItem et un élément connexe.

aws ssm disassociate-ops-item-related-item \ --ops-item-id "oi-f99f2EXAMPLE" \ --association-id "e2036148-cccb-490e-ac2a-390e5EXAMPLE"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Working with Incident Manager incidents OpsCenter dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserdisassociate-ops-item-related-item.

AWS CLI

Pour supprimer une association d'articles connexes

L'disassociate-ops-item-related-itemexemple suivant supprime l'association entre le OpsItem et un élément connexe.

aws ssm disassociate-ops-item-related-item \ --ops-item-id "oi-f99f2EXAMPLE" \ --association-id "e2036148-cccb-490e-ac2a-390e5EXAMPLE"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Working with Incident Manager incidents OpsCenter dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserget-automation-execution.

AWS CLI

Pour afficher les détails d’une exécution d’automatisation

L’exemple de get-automation-execution suivant affiche des informations détaillées sur une exécution d’automatisation.

aws ssm get-automation-execution \ --automation-execution-id 73c8eef8-f4ee-4a05-820c-e354fEXAMPLE

Sortie :

{ "AutomationExecution": { "AutomationExecutionId": "73c8eef8-f4ee-4a05-820c-e354fEXAMPLE", "DocumentName": "AWS-StartEC2Instance", "DocumentVersion": "1", "ExecutionStartTime": 1583737233.748, "ExecutionEndTime": 1583737234.719, "AutomationExecutionStatus": "Success", "StepExecutions": [ { "StepName": "startInstances", "Action": "aws:changeInstanceState", "ExecutionStartTime": 1583737234.134, "ExecutionEndTime": 1583737234.672, "StepStatus": "Success", "Inputs": { "DesiredState": "\"running\"", "InstanceIds": "[\"i-0cb99161f6EXAMPLE\"]" }, "Outputs": { "InstanceStates": [ "running" ] }, "StepExecutionId": "95e70479-cf20-4d80-8018-7e4e2EXAMPLE", "OverriddenParameters": {} } ], "StepExecutionsTruncated": false, "Parameters": { "AutomationAssumeRole": [ "" ], "InstanceId": [ "i-0cb99161f6EXAMPLE" ] }, "Outputs": {}, "Mode": "Auto", "ExecutedBy": "arn:aws:sts::29884EXAMPLE:assumed-role/mw_service_role/OrchestrationService", "Targets": [], "ResolvedTargets": { "ParameterValues": [], "Truncated": false } } }

Pour plus d'informations, reportez-vous à la section Procédure pas à pas : patcher une AMI Linux (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserget-automation-execution.

AWS CLI

Pour afficher les détails d’une exécution d’automatisation

L’exemple de get-automation-execution suivant affiche des informations détaillées sur une exécution d’automatisation.

aws ssm get-automation-execution \ --automation-execution-id 73c8eef8-f4ee-4a05-820c-e354fEXAMPLE

Sortie :

{ "AutomationExecution": { "AutomationExecutionId": "73c8eef8-f4ee-4a05-820c-e354fEXAMPLE", "DocumentName": "AWS-StartEC2Instance", "DocumentVersion": "1", "ExecutionStartTime": 1583737233.748, "ExecutionEndTime": 1583737234.719, "AutomationExecutionStatus": "Success", "StepExecutions": [ { "StepName": "startInstances", "Action": "aws:changeInstanceState", "ExecutionStartTime": 1583737234.134, "ExecutionEndTime": 1583737234.672, "StepStatus": "Success", "Inputs": { "DesiredState": "\"running\"", "InstanceIds": "[\"i-0cb99161f6EXAMPLE\"]" }, "Outputs": { "InstanceStates": [ "running" ] }, "StepExecutionId": "95e70479-cf20-4d80-8018-7e4e2EXAMPLE", "OverriddenParameters": {} } ], "StepExecutionsTruncated": false, "Parameters": { "AutomationAssumeRole": [ "" ], "InstanceId": [ "i-0cb99161f6EXAMPLE" ] }, "Outputs": {}, "Mode": "Auto", "ExecutedBy": "arn:aws:sts::29884EXAMPLE:assumed-role/mw_service_role/OrchestrationService", "Targets": [], "ResolvedTargets": { "ParameterValues": [], "Truncated": false } } }

Pour plus d'informations, reportez-vous à la section Procédure pas à pas : patcher une AMI Linux (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserget-calendar-state.

AWS CLI

Exemple 1 : pour obtenir l'état actuel d'un calendrier des modifications

Cet get-calendar-state exemple renvoie l'état d'un calendrier à l'heure actuelle. Comme l'exemple ne précise pas d'heure, l'état actuel du calendrier est indiqué.

aws ssm get-calendar-state \ --calendar-names "MyCalendar"

Sortie :

{ "State": "OPEN", "AtTime": "2020-02-19T22:28:51Z", "NextTransitionTime": "2020-02-24T21:15:19Z" }

Exemple 2 : pour obtenir l'état d'un calendrier des modifications à une heure spécifiée

Cet get-calendar-state exemple renvoie l'état d'un calendrier à l'heure spécifiée.

aws ssm get-calendar-state \ --calendar-names "MyCalendar" \ --at-time "2020-07-19T21:15:19Z"

Sortie :

{ "State": "CLOSED", "AtTime": "2020-07-19T21:15:19Z" }

Pour plus d'informations, consultez la section Get the State of the Change Calendar dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir GetCalendarStatela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-calendar-state.

AWS CLI

Exemple 1 : pour obtenir l'état actuel d'un calendrier des modifications

Cet get-calendar-state exemple renvoie l'état d'un calendrier à l'heure actuelle. Comme l'exemple ne précise pas d'heure, l'état actuel du calendrier est indiqué.

aws ssm get-calendar-state \ --calendar-names "MyCalendar"

Sortie :

{ "State": "OPEN", "AtTime": "2020-02-19T22:28:51Z", "NextTransitionTime": "2020-02-24T21:15:19Z" }

Exemple 2 : pour obtenir l'état d'un calendrier des modifications à une heure spécifiée

Cet get-calendar-state exemple renvoie l'état d'un calendrier à l'heure spécifiée.

aws ssm get-calendar-state \ --calendar-names "MyCalendar" \ --at-time "2020-07-19T21:15:19Z"

Sortie :

{ "State": "CLOSED", "AtTime": "2020-07-19T21:15:19Z" }

Pour plus d'informations, consultez la section Get the State of the Change Calendar dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir GetCalendarStatela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-command-invocation.

AWS CLI

Pour afficher les détails d’une invocation de commande

L’exemple de get-command-invocation suivant répertorie toutes les invocations de la commande spécifiée sur l’instance spécifiée.

aws ssm get-command-invocation \ --command-id "ef7fdfd8-9b57-4151-a15c-db9a12345678" \ --instance-id "i-1234567890abcdef0"

Sortie :

{ "CommandId": "ef7fdfd8-9b57-4151-a15c-db9a12345678", "InstanceId": "i-1234567890abcdef0", "Comment": "b48291dd-ba76-43e0-b9df-13e11ddaac26:6960febb-2907-4b59-8e1a-d6ce8EXAMPLE", "DocumentName": "AWS-UpdateSSMAgent", "DocumentVersion": "", "PluginName": "aws:updateSsmAgent", "ResponseCode": 0, "ExecutionStartDateTime": "2020-02-19T18:18:03.419Z", "ExecutionElapsedTime": "PT0.091S", "ExecutionEndDateTime": "2020-02-19T18:18:03.419Z", "Status": "Success", "StatusDetails": "Success", "StandardOutputContent": "Updating amazon-ssm-agent from 2.3.842.0 to latest\nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/ssm-agent-manifest.json\namazon-ssm-agent 2.3.842.0 has already been installed, update skipped\n", "StandardOutputUrl": "", "StandardErrorContent": "", "StandardErrorUrl": "", "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false } }

Pour plus d’informations, consultez Comprendre les statuts de commande dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, voir GetCommandInvocationla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-command-invocation.

AWS CLI

Pour afficher les détails d’une invocation de commande

L’exemple de get-command-invocation suivant répertorie toutes les invocations de la commande spécifiée sur l’instance spécifiée.

aws ssm get-command-invocation \ --command-id "ef7fdfd8-9b57-4151-a15c-db9a12345678" \ --instance-id "i-1234567890abcdef0"

Sortie :

{ "CommandId": "ef7fdfd8-9b57-4151-a15c-db9a12345678", "InstanceId": "i-1234567890abcdef0", "Comment": "b48291dd-ba76-43e0-b9df-13e11ddaac26:6960febb-2907-4b59-8e1a-d6ce8EXAMPLE", "DocumentName": "AWS-UpdateSSMAgent", "DocumentVersion": "", "PluginName": "aws:updateSsmAgent", "ResponseCode": 0, "ExecutionStartDateTime": "2020-02-19T18:18:03.419Z", "ExecutionElapsedTime": "PT0.091S", "ExecutionEndDateTime": "2020-02-19T18:18:03.419Z", "Status": "Success", "StatusDetails": "Success", "StandardOutputContent": "Updating amazon-ssm-agent from 2.3.842.0 to latest\nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/ssm-agent-manifest.json\namazon-ssm-agent 2.3.842.0 has already been installed, update skipped\n", "StandardOutputUrl": "", "StandardErrorContent": "", "StandardErrorUrl": "", "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false } }

Pour plus d’informations, consultez Comprendre les statuts de commande dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, voir GetCommandInvocationla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-connection-status.

AWS CLI

Pour afficher le statut de connexion d’une instance gérée

Cet exemple de get-connection-status renvoie le statut de connexion de l’instance gérée spécifiée.

aws ssm get-connection-status \ --target i-1234567890abcdef0

Sortie :

{ "Target": "i-1234567890abcdef0", "Status": "connected" }
  • Pour plus de détails sur l'API, voir GetConnectionStatusla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-connection-status.

AWS CLI

Pour afficher le statut de connexion d’une instance gérée

Cet exemple de get-connection-status renvoie le statut de connexion de l’instance gérée spécifiée.

aws ssm get-connection-status \ --target i-1234567890abcdef0

Sortie :

{ "Target": "i-1234567890abcdef0", "Status": "connected" }
  • Pour plus de détails sur l'API, voir GetConnectionStatusla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-default-patch-baseline.

AWS CLI

Exemple 1 : affichage du référentiel de correctifs par défaut de Windows

L’exemple de get-default-patch-baseline suivant permet de récupérer les détails du référentiel de correctifs par défaut pour Windows Server.

aws ssm get-default-patch-baseline

Sortie :

{ "BaselineId": "pb-0713accee01612345", "OperatingSystem": "WINDOWS" }

Exemple 2 : affichage du référentiel de correctifs par défaut pour Amazon Linux

L’exemple de get-default-patch-baseline suivant permet de récupérer les détails du référentiel de correctifs par défaut pour Amazon Linux.

aws ssm get-default-patch-baseline \ --operating-system AMAZON_LINUX

Sortie :

{ "BaselineId": "pb-047c6eb9c8fc12345", "OperatingSystem": "AMAZON_LINUX" }

Pour plus d'informations, voir À propos des lignes de base de correctifs prédéfinies et personnalisées < https://docs.aws.amazon.com/systems-manager/ latest/userguide/sysman -patch-baselines.html>__ et Définir une ligne de base de correctifs existante par défaut dans le guide de l'utilisateur de Systems Manager.AWS

L'exemple de code suivant montre comment utiliserget-default-patch-baseline.

AWS CLI

Exemple 1 : affichage du référentiel de correctifs par défaut de Windows

L’exemple de get-default-patch-baseline suivant permet de récupérer les détails du référentiel de correctifs par défaut pour Windows Server.

aws ssm get-default-patch-baseline

Sortie :

{ "BaselineId": "pb-0713accee01612345", "OperatingSystem": "WINDOWS" }

Exemple 2 : affichage du référentiel de correctifs par défaut pour Amazon Linux

L’exemple de get-default-patch-baseline suivant permet de récupérer les détails du référentiel de correctifs par défaut pour Amazon Linux.

aws ssm get-default-patch-baseline \ --operating-system AMAZON_LINUX

Sortie :

{ "BaselineId": "pb-047c6eb9c8fc12345", "OperatingSystem": "AMAZON_LINUX" }

Pour plus d'informations, voir À propos des lignes de base de correctifs prédéfinies et personnalisées < https://docs.aws.amazon.com/systems-manager/ latest/userguide/sysman -patch-baselines.html>__ et Définir une ligne de base de correctifs existante par défaut dans le guide de l'utilisateur de Systems Manager.AWS

L'exemple de code suivant montre comment utiliserget-deployable-patch-snapshot-for-instance.

AWS CLI

Pour récupérer l’instantané actuel pour le référentiel de correctifs qu’une instance utilise

L’exemple de get-deployable-patch-snapshot-for-instance suivant récupère les détails de l’instantané en cours pour le référentiel de correctifs spécifié utilisé par une instance. Cette commande doit être exécutée à partir de l’instance en utilisant les informations d’identification de l’instance. Pour vous assurer qu’il utilise les informations d’identification de l’instance, exécutez aws configure et spécifiez uniquement la région de votre instance. Laissez les champs Access Key et Secret Key vides.

Conseil : utilisez uuidgen pour générer un snapshot-id.

aws ssm get-deployable-patch-snapshot-for-instance \ --instance-id "i-1234567890abcdef0" \ --snapshot-id "521c3536-930c-4aa9-950e-01234567abcd"

Sortie :

{ "InstanceId": "i-1234567890abcdef0", "SnapshotId": "521c3536-930c-4aa9-950e-01234567abcd", "Product": "AmazonLinux2018.03", "SnapshotDownloadUrl": "https://patch-baseline-snapshot-us-east-1.s3.amazonaws.com/ed85194ef27214f5984f28b4d664d14f7313568fea7d4b6ac6c10ad1f729d7e7-773304212436/AMAZON_LINUX-521c3536-930c-4aa9-950e-01234567abcd?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20190215T164031Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAJ5C56P35AEBRX2QQ%2F20190215%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=efaaaf6e3878e77f48a6697e015efdbda9c426b09c5822055075c062f6ad2149" }

Pour plus d’informations, consultez Nom du paramètre : ID de l’instantané dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserget-deployable-patch-snapshot-for-instance.

AWS CLI

Pour récupérer l’instantané actuel pour le référentiel de correctifs qu’une instance utilise

L’exemple de get-deployable-patch-snapshot-for-instance suivant récupère les détails de l’instantané en cours pour le référentiel de correctifs spécifié utilisé par une instance. Cette commande doit être exécutée à partir de l’instance en utilisant les informations d’identification de l’instance. Pour vous assurer qu’il utilise les informations d’identification de l’instance, exécutez aws configure et spécifiez uniquement la région de votre instance. Laissez les champs Access Key et Secret Key vides.

Conseil : utilisez uuidgen pour générer un snapshot-id.

aws ssm get-deployable-patch-snapshot-for-instance \ --instance-id "i-1234567890abcdef0" \ --snapshot-id "521c3536-930c-4aa9-950e-01234567abcd"

Sortie :

{ "InstanceId": "i-1234567890abcdef0", "SnapshotId": "521c3536-930c-4aa9-950e-01234567abcd", "Product": "AmazonLinux2018.03", "SnapshotDownloadUrl": "https://patch-baseline-snapshot-us-east-1.s3.amazonaws.com/ed85194ef27214f5984f28b4d664d14f7313568fea7d4b6ac6c10ad1f729d7e7-773304212436/AMAZON_LINUX-521c3536-930c-4aa9-950e-01234567abcd?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20190215T164031Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAJ5C56P35AEBRX2QQ%2F20190215%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=efaaaf6e3878e77f48a6697e015efdbda9c426b09c5822055075c062f6ad2149" }

Pour plus d’informations, consultez Nom du paramètre : ID de l’instantané dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserget-document.

AWS CLI

Pour obtenir le contenu d’un document

L’exemple de get-document suivant affiche le contenu d’un document Systems Manager.

aws ssm get-document \ --name "AWS-RunShellScript"

Sortie :

{ "Name": "AWS-RunShellScript", "DocumentVersion": "1", "Status": "Active", "Content": "{\n \"schemaVersion\":\"1.2\",\n \"description\":\"Run a shell script or specify the commands to run.\",\n \"parameters\":{\n \"commands\":{\n \"type\":\"StringList\",\n \"description\":\"(Required) Specify a shell script or a command to run.\",\n \"minItems\":1,\n \"displayType\":\"textarea\"\n },\n \"workingDirectory\":{\n \"type\":\"String\",\n \"default\":\"\",\n \"description\":\"(Optional) The path to the working directory on your instance.\",\n \"maxChars\":4096\n },\n \"executionTimeout\":{\n \"type\":\"String\",\n \"default\":\"3600\",\n \"description\":\"(Optional) The time in seconds for a command to complete before it is considered to have failed. Default is 3600 (1 hour). Maximum is 172800 (48 hours).\",\n \"allowedPattern\":\"([1-9][0-9]{0,4})|(1[0-6][0-9]{4})|(17[0-1][0-9]{3})|(172[0-7][0-9]{2})|(172800)\"\n }\n },\n \"runtimeConfig\":{\n \"aws:runShellScript\":{\n \"properties\":[\n {\n \"id\":\"0.aws:runShellScript\",\n \"runCommand\":\"{{ commands }}\",\n \"workingDirectory\":\"{{ workingDirectory }}\",\n \"timeoutSeconds\":\"{{ executionTimeout }}\"\n }\n ]\n }\n }\n}\n", "DocumentType": "Command", "DocumentFormat": "JSON" }

Pour plus d’informations, consultez Documents AWS Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, voir GetDocumentla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-document.

AWS CLI

Pour obtenir le contenu d’un document

L’exemple de get-document suivant affiche le contenu d’un document Systems Manager.

aws ssm get-document \ --name "AWS-RunShellScript"

Sortie :

{ "Name": "AWS-RunShellScript", "DocumentVersion": "1", "Status": "Active", "Content": "{\n \"schemaVersion\":\"1.2\",\n \"description\":\"Run a shell script or specify the commands to run.\",\n \"parameters\":{\n \"commands\":{\n \"type\":\"StringList\",\n \"description\":\"(Required) Specify a shell script or a command to run.\",\n \"minItems\":1,\n \"displayType\":\"textarea\"\n },\n \"workingDirectory\":{\n \"type\":\"String\",\n \"default\":\"\",\n \"description\":\"(Optional) The path to the working directory on your instance.\",\n \"maxChars\":4096\n },\n \"executionTimeout\":{\n \"type\":\"String\",\n \"default\":\"3600\",\n \"description\":\"(Optional) The time in seconds for a command to complete before it is considered to have failed. Default is 3600 (1 hour). Maximum is 172800 (48 hours).\",\n \"allowedPattern\":\"([1-9][0-9]{0,4})|(1[0-6][0-9]{4})|(17[0-1][0-9]{3})|(172[0-7][0-9]{2})|(172800)\"\n }\n },\n \"runtimeConfig\":{\n \"aws:runShellScript\":{\n \"properties\":[\n {\n \"id\":\"0.aws:runShellScript\",\n \"runCommand\":\"{{ commands }}\",\n \"workingDirectory\":\"{{ workingDirectory }}\",\n \"timeoutSeconds\":\"{{ executionTimeout }}\"\n }\n ]\n }\n }\n}\n", "DocumentType": "Command", "DocumentFormat": "JSON" }

Pour plus d’informations, consultez Documents AWS Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, voir GetDocumentla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-inventory-schema.

AWS CLI

Pour afficher votre schéma d’inventaire

Cet exemple renvoie une liste de noms de types d’inventaire pour le compte.

Commande :

aws ssm get-inventory-schema

Sortie :

{ "Schemas": [ { "TypeName": "AWS:AWSComponent", "Version": "1.0", "Attributes": [ { "Name": "Name", "DataType": "STRING" }, { "Name": "ApplicationType", "DataType": "STRING" }, { "Name": "Publisher", "DataType": "STRING" }, { "Name": "Version", "DataType": "STRING" }, { "Name": "InstalledTime", "DataType": "STRING" }, { "Name": "Architecture", "DataType": "STRING" }, { "Name": "URL", "DataType": "STRING" } ] }, ... ], "NextToken": "--token string truncated--" }

Pour afficher le schéma d’inventaire d’un type d’inventaire spécifique

Cet exemple renvoie le schéma d'inventaire pour un type d'inventaire des AWS composants AWS :

Commande :

aws ssm get-inventory-schema --type-name "AWS:AWSComponent"
  • Pour plus de détails sur l'API, voir GetInventorySchemala section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-inventory-schema.

AWS CLI

Pour afficher votre schéma d’inventaire

Cet exemple renvoie une liste de noms de types d’inventaire pour le compte.

Commande :

aws ssm get-inventory-schema

Sortie :

{ "Schemas": [ { "TypeName": "AWS:AWSComponent", "Version": "1.0", "Attributes": [ { "Name": "Name", "DataType": "STRING" }, { "Name": "ApplicationType", "DataType": "STRING" }, { "Name": "Publisher", "DataType": "STRING" }, { "Name": "Version", "DataType": "STRING" }, { "Name": "InstalledTime", "DataType": "STRING" }, { "Name": "Architecture", "DataType": "STRING" }, { "Name": "URL", "DataType": "STRING" } ] }, ... ], "NextToken": "--token string truncated--" }

Pour afficher le schéma d’inventaire d’un type d’inventaire spécifique

Cet exemple renvoie le schéma d'inventaire pour un type d'inventaire des AWS composants AWS :

Commande :

aws ssm get-inventory-schema --type-name "AWS:AWSComponent"
  • Pour plus de détails sur l'API, voir GetInventorySchemala section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-inventory.

AWS CLI

Pour afficher votre inventaire

Cet exemple permet d’obtenir les métadonnées personnalisées de votre inventaire.

Commande :

aws ssm get-inventory

Sortie :

{ "Entities": [ { "Data": { "AWS:InstanceInformation": { "Content": [ { "ComputerName": "ip-172-31-44-222.us-west-2.compute.internal", "InstanceId": "i-0cb2b964d3e14fd9f", "IpAddress": "172.31.44.222", "AgentType": "amazon-ssm-agent", "ResourceType": "EC2Instance", "AgentVersion": "2.0.672.0", "PlatformVersion": "2016.09", "PlatformName": "Amazon Linux AMI", "PlatformType": "Linux" } ], "TypeName": "AWS:InstanceInformation", "SchemaVersion": "1.0", "CaptureTime": "2017-02-20T18:03:58Z" } }, "Id": "i-0cb2b964d3e14fd9f" } ] }
  • Pour plus de détails sur l'API, voir GetInventoryla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-inventory.

AWS CLI

Pour afficher votre inventaire

Cet exemple permet d’obtenir les métadonnées personnalisées de votre inventaire.

Commande :

aws ssm get-inventory

Sortie :

{ "Entities": [ { "Data": { "AWS:InstanceInformation": { "Content": [ { "ComputerName": "ip-172-31-44-222.us-west-2.compute.internal", "InstanceId": "i-0cb2b964d3e14fd9f", "IpAddress": "172.31.44.222", "AgentType": "amazon-ssm-agent", "ResourceType": "EC2Instance", "AgentVersion": "2.0.672.0", "PlatformVersion": "2016.09", "PlatformName": "Amazon Linux AMI", "PlatformType": "Linux" } ], "TypeName": "AWS:InstanceInformation", "SchemaVersion": "1.0", "CaptureTime": "2017-02-20T18:03:58Z" } }, "Id": "i-0cb2b964d3e14fd9f" } ] }
  • Pour plus de détails sur l'API, voir GetInventoryla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-maintenance-window-execution-task-invocation.

AWS CLI

Pour obtenir des informations sur l'invocation d'une tâche pendant la fenêtre de maintenance

L'get-maintenance-window-execution-task-invocationexemple suivant répertorie les informations relatives à l'appel de tâches spécifié qui fait partie de l'exécution de la fenêtre de maintenance spécifiée.

aws ssm get-maintenance-window-execution-task-invocation \ --window-execution-id "bc494bfa-e63b-49f6-8ad1-aa9f2EXAMPLE" \ --task-id "96f2ad59-97e3-461d-a63d-40c8aEXAMPLE" \ --invocation-id "a5273e2c-d2c6-4880-b3e1-5e550EXAMPLE"

Sortie :

{ "Status": "SUCCESS", "Parameters": "{\"comment\":\"\",\"documentName\":\"AWS-RunPowerShellScript\",\"instanceIds\":[\"i-1234567890EXAMPLE\"],\"maxConcurrency\":\"1\",\"maxErrors\":\"1\",\"parameters\":{\"executionTimeout\":[\"3600\"],\"workingDirectory\":[\"\"],\"commands\":[\"echo Hello\"]},\"timeoutSeconds\":600}", "ExecutionId": "03b6baa0-5460-4e15-83f2-ea685EXAMPLE", "InvocationId": "a5273e2c-d2c6-4880-b3e1-5e550EXAMPLE", "StartTime": 1549998326.421, "TaskType": "RUN_COMMAND", "EndTime": 1550001931.784, "WindowExecutionId": "bc494bfa-e63b-49f6-8ad1-aa9f2EXAMPLE", "StatusDetails": "Failed", "TaskExecutionId": "96f2ad59-97e3-461d-a63d-40c8aEXAMPLE" }

Pour plus d'informations, consultez la section Afficher les informations sur les tâches et les exécutions de tâches (AWS CLI) dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserget-maintenance-window-execution-task-invocation.

AWS CLI

Pour obtenir des informations sur l'invocation d'une tâche pendant la fenêtre de maintenance

L'get-maintenance-window-execution-task-invocationexemple suivant répertorie les informations relatives à l'appel de tâches spécifié qui fait partie de l'exécution de la fenêtre de maintenance spécifiée.

aws ssm get-maintenance-window-execution-task-invocation \ --window-execution-id "bc494bfa-e63b-49f6-8ad1-aa9f2EXAMPLE" \ --task-id "96f2ad59-97e3-461d-a63d-40c8aEXAMPLE" \ --invocation-id "a5273e2c-d2c6-4880-b3e1-5e550EXAMPLE"

Sortie :

{ "Status": "SUCCESS", "Parameters": "{\"comment\":\"\",\"documentName\":\"AWS-RunPowerShellScript\",\"instanceIds\":[\"i-1234567890EXAMPLE\"],\"maxConcurrency\":\"1\",\"maxErrors\":\"1\",\"parameters\":{\"executionTimeout\":[\"3600\"],\"workingDirectory\":[\"\"],\"commands\":[\"echo Hello\"]},\"timeoutSeconds\":600}", "ExecutionId": "03b6baa0-5460-4e15-83f2-ea685EXAMPLE", "InvocationId": "a5273e2c-d2c6-4880-b3e1-5e550EXAMPLE", "StartTime": 1549998326.421, "TaskType": "RUN_COMMAND", "EndTime": 1550001931.784, "WindowExecutionId": "bc494bfa-e63b-49f6-8ad1-aa9f2EXAMPLE", "StatusDetails": "Failed", "TaskExecutionId": "96f2ad59-97e3-461d-a63d-40c8aEXAMPLE" }

Pour plus d'informations, consultez la section Afficher les informations sur les tâches et les exécutions de tâches (AWS CLI) dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserget-maintenance-window-execution-task.

AWS CLI

Pour obtenir des informations sur l’exécution d’une tâche de la fenêtre de maintenance

L’exemple de get-maintenance-window-execution-task suivant répertorie les informations relatives à une tâche qui fait partie de l’exécution de la fenêtre de maintenance spécifiée.

aws ssm get-maintenance-window-execution-task \ --window-execution-id "518d5565-5969-4cca-8f0e-da3b2EXAMPLE" \ --task-id "ac0c6ae1-daa3-4a89-832e-d3845EXAMPLE"

Sortie :

{ "WindowExecutionId": "518d5565-5969-4cca-8f0e-da3b2EXAMPLE", "TaskExecutionId": "ac0c6ae1-daa3-4a89-832e-d3845EXAMPLE", "TaskArn": "AWS-RunPatchBaseline", "ServiceRole": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "Type": "RUN_COMMAND", "TaskParameters": [ { "BaselineOverride": { "Values": [ "" ] }, "InstallOverrideList": { "Values": [ "" ] }, "Operation": { "Values": [ "Scan" ] }, "RebootOption": { "Values": [ "RebootIfNeeded" ] }, "SnapshotId": { "Values": [ "{{ aws:ORCHESTRATION_ID }}" ] }, "aws:InstanceId": { "Values": [ "i-02573cafcfEXAMPLE", "i-0471e04240EXAMPLE", "i-07782c72faEXAMPLE" ] } } ], "Priority": 1, "MaxConcurrency": "1", "MaxErrors": "3", "Status": "SUCCESS", "StartTime": "2021-08-04T11:45:35.088000-07:00", "EndTime": "2021-08-04T11:53:09.079000-07:00" }

Pour plus d'informations, consultez la section Afficher les informations relatives aux tâches et aux exécutions de tâches (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserget-maintenance-window-execution-task.

AWS CLI

Pour obtenir des informations sur l’exécution d’une tâche de la fenêtre de maintenance

L’exemple de get-maintenance-window-execution-task suivant répertorie les informations relatives à une tâche qui fait partie de l’exécution de la fenêtre de maintenance spécifiée.

aws ssm get-maintenance-window-execution-task \ --window-execution-id "518d5565-5969-4cca-8f0e-da3b2EXAMPLE" \ --task-id "ac0c6ae1-daa3-4a89-832e-d3845EXAMPLE"

Sortie :

{ "WindowExecutionId": "518d5565-5969-4cca-8f0e-da3b2EXAMPLE", "TaskExecutionId": "ac0c6ae1-daa3-4a89-832e-d3845EXAMPLE", "TaskArn": "AWS-RunPatchBaseline", "ServiceRole": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "Type": "RUN_COMMAND", "TaskParameters": [ { "BaselineOverride": { "Values": [ "" ] }, "InstallOverrideList": { "Values": [ "" ] }, "Operation": { "Values": [ "Scan" ] }, "RebootOption": { "Values": [ "RebootIfNeeded" ] }, "SnapshotId": { "Values": [ "{{ aws:ORCHESTRATION_ID }}" ] }, "aws:InstanceId": { "Values": [ "i-02573cafcfEXAMPLE", "i-0471e04240EXAMPLE", "i-07782c72faEXAMPLE" ] } } ], "Priority": 1, "MaxConcurrency": "1", "MaxErrors": "3", "Status": "SUCCESS", "StartTime": "2021-08-04T11:45:35.088000-07:00", "EndTime": "2021-08-04T11:53:09.079000-07:00" }

Pour plus d'informations, consultez la section Afficher les informations relatives aux tâches et aux exécutions de tâches (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserget-maintenance-window-execution.

AWS CLI

Pour obtenir des informations sur l’exécution d’une tâche de la fenêtre de maintenance

L’exemple de get-maintenance-window-execution suivant répertorie les informations relatives à une tâche exécutée dans le cadre de l’exécution de la fenêtre de maintenance spécifiée.

aws ssm get-maintenance-window-execution \ --window-execution-id "518d5565-5969-4cca-8f0e-da3b2EXAMPLE"

Sortie :

{ "Status": "SUCCESS", "TaskIds": [ "ac0c6ae1-daa3-4a89-832e-d3845EXAMPLE" ], "StartTime": 1487692834.595, "EndTime": 1487692835.051, "WindowExecutionId": "518d5565-5969-4cca-8f0e-da3b2EXAMPLE", }

Pour plus d'informations, consultez la section Afficher les informations sur les tâches et les exécutions de tâches (AWS CLI) dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserget-maintenance-window-execution.

AWS CLI

Pour obtenir des informations sur l’exécution d’une tâche de la fenêtre de maintenance

L’exemple de get-maintenance-window-execution suivant répertorie les informations relatives à une tâche exécutée dans le cadre de l’exécution de la fenêtre de maintenance spécifiée.

aws ssm get-maintenance-window-execution \ --window-execution-id "518d5565-5969-4cca-8f0e-da3b2EXAMPLE"

Sortie :

{ "Status": "SUCCESS", "TaskIds": [ "ac0c6ae1-daa3-4a89-832e-d3845EXAMPLE" ], "StartTime": 1487692834.595, "EndTime": 1487692835.051, "WindowExecutionId": "518d5565-5969-4cca-8f0e-da3b2EXAMPLE", }

Pour plus d'informations, consultez la section Afficher les informations sur les tâches et les exécutions de tâches (AWS CLI) dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserget-maintenance-window-task.

AWS CLI

Pour obtenir des informations sur une tâche de fenêtre de maintenance

L'get-maintenance-window-taskexemple suivant permet de récupérer des informations sur la tâche de la fenêtre de maintenance spécifiée.

aws ssm get-maintenance-window-task \ --window-id mw-0c5ed765acEXAMPLE \ --window-task-id 0e842a8d-2d44-4886-bb62-af8dcEXAMPLE

Sortie :

{ "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "MaxErrors": "1", "TaskArn": "AWS-RunPowerShellScript", "MaxConcurrency": "1", "WindowTaskId": "0e842a8d-2d44-4886-bb62-af8dcEXAMPLE", "TaskParameters": {}, "Priority": 1, "TaskInvocationParameters": { "RunCommand": { "Comment": "", "TimeoutSeconds": 600, "Parameters": { "commands": [ "echo Hello" ], "executionTimeout": [ "3600" ], "workingDirectory": [ "" ] } } }, "WindowId": "mw-0c5ed765acEXAMPLE", "TaskType": "RUN_COMMAND", "Targets": [ { "Values": [ "84c818da-b619-4d3d-9651-946f3EXAMPLE" ], "Key": "WindowTargetIds" } ], "Name": "ExampleTask" }

Pour plus d'informations, consultez la section Afficher les informations relatives à la maintenance de Windows (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserget-maintenance-window-task.

AWS CLI

Pour obtenir des informations sur une tâche de fenêtre de maintenance

L'get-maintenance-window-taskexemple suivant permet de récupérer des informations sur la tâche de la fenêtre de maintenance spécifiée.

aws ssm get-maintenance-window-task \ --window-id mw-0c5ed765acEXAMPLE \ --window-task-id 0e842a8d-2d44-4886-bb62-af8dcEXAMPLE

Sortie :

{ "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "MaxErrors": "1", "TaskArn": "AWS-RunPowerShellScript", "MaxConcurrency": "1", "WindowTaskId": "0e842a8d-2d44-4886-bb62-af8dcEXAMPLE", "TaskParameters": {}, "Priority": 1, "TaskInvocationParameters": { "RunCommand": { "Comment": "", "TimeoutSeconds": 600, "Parameters": { "commands": [ "echo Hello" ], "executionTimeout": [ "3600" ], "workingDirectory": [ "" ] } } }, "WindowId": "mw-0c5ed765acEXAMPLE", "TaskType": "RUN_COMMAND", "Targets": [ { "Values": [ "84c818da-b619-4d3d-9651-946f3EXAMPLE" ], "Key": "WindowTargetIds" } ], "Name": "ExampleTask" }

Pour plus d'informations, consultez la section Afficher les informations relatives à la maintenance de Windows (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserget-maintenance-window.

AWS CLI

Pour obtenir des informations sur une fenêtre de maintenance

L’exemple de get-maintenance-window suivant permet d’obtenir des informations sur la fenêtre de maintenance spécifiée.

aws ssm get-maintenance-window \ --window-id "mw-03eb9db428EXAMPLE"

Sortie :

{ "AllowUnassociatedTargets": true, "CreatedDate": 1515006912.957, "Cutoff": 1, "Duration": 6, "Enabled": true, "ModifiedDate": 2020-01-01T10:04:04.099Z, "Name": "My-Maintenance-Window", "Schedule": "rate(3 days)", "WindowId": "mw-03eb9db428EXAMPLE", "NextExecutionTime": "2020-02-25T00:08:15.099Z" }

Pour plus d'informations, consultez la section Afficher les informations sur les fenêtres de maintenance (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir GetMaintenanceWindowla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-maintenance-window.

AWS CLI

Pour obtenir des informations sur une fenêtre de maintenance

L’exemple de get-maintenance-window suivant permet d’obtenir des informations sur la fenêtre de maintenance spécifiée.

aws ssm get-maintenance-window \ --window-id "mw-03eb9db428EXAMPLE"

Sortie :

{ "AllowUnassociatedTargets": true, "CreatedDate": 1515006912.957, "Cutoff": 1, "Duration": 6, "Enabled": true, "ModifiedDate": 2020-01-01T10:04:04.099Z, "Name": "My-Maintenance-Window", "Schedule": "rate(3 days)", "WindowId": "mw-03eb9db428EXAMPLE", "NextExecutionTime": "2020-02-25T00:08:15.099Z" }

Pour plus d'informations, consultez la section Afficher les informations sur les fenêtres de maintenance (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir GetMaintenanceWindowla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-ops-item.

AWS CLI

Pour consulter les informations relatives à un OpsItem

L'get-ops-itemexemple suivant affiche les détails relatifs à ce qui est spécifié OpsItem.

aws ssm get-ops-item \ --ops-item-id oi-0b725EXAMPLE

Sortie :

{ "OpsItem": { "CreatedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "CreatedTime": "2019-12-04T15:52:16.793000-08:00", "Description": "CloudWatch Event Rule SSMOpsItems-EC2-instance-terminated was triggered. Your EC2 instance has terminated. See below for more details.", "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "LastModifiedTime": "2019-12-04T15:52:16.793000-08:00", "Notifications": [], "RelatedOpsItems": [], "Status": "Open", "OpsItemId": "oi-0b725EXAMPLE", "Title": "EC2 instance terminated", "Source": "EC2", "OperationalData": { "/aws/automations": { "Value": "[ { \"automationType\": \"AWS:SSM:Automation\", \"automationId\": \"AWS-CreateManagedWindowsInstance\" }, { \"automationType\": \"AWS:SSM:Automation\", \"automationId\": \"AWS-CreateManagedLinuxInstance\" } ]", "Type": "SearchableString" }, "/aws/dedup": { "Value": "{\"dedupString\":\"SSMOpsItems-EC2-instance-terminated\"}", "Type": "SearchableString" }, "/aws/resources": { "Value": "[{\"arn\":\"arn:aws:ec2:us-east-2:111222333444:instance/i-05adec7e97EXAMPLE\"}]", "Type": "SearchableString" }, "event-time": { "Value": "2019-12-04T23:52:16Z", "Type": "String" }, "instance-state": { "Value": "terminated", "Type": "String" } }, "Category": "Availability", "Severity": "4" } }

Pour plus d'informations, reportez-vous à la section Travailler avec OpsItems dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir GetOpsItemla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-ops-item.

AWS CLI

Pour consulter les informations relatives à un OpsItem

L'get-ops-itemexemple suivant affiche les détails relatifs à ce qui est spécifié OpsItem.

aws ssm get-ops-item \ --ops-item-id oi-0b725EXAMPLE

Sortie :

{ "OpsItem": { "CreatedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "CreatedTime": "2019-12-04T15:52:16.793000-08:00", "Description": "CloudWatch Event Rule SSMOpsItems-EC2-instance-terminated was triggered. Your EC2 instance has terminated. See below for more details.", "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "LastModifiedTime": "2019-12-04T15:52:16.793000-08:00", "Notifications": [], "RelatedOpsItems": [], "Status": "Open", "OpsItemId": "oi-0b725EXAMPLE", "Title": "EC2 instance terminated", "Source": "EC2", "OperationalData": { "/aws/automations": { "Value": "[ { \"automationType\": \"AWS:SSM:Automation\", \"automationId\": \"AWS-CreateManagedWindowsInstance\" }, { \"automationType\": \"AWS:SSM:Automation\", \"automationId\": \"AWS-CreateManagedLinuxInstance\" } ]", "Type": "SearchableString" }, "/aws/dedup": { "Value": "{\"dedupString\":\"SSMOpsItems-EC2-instance-terminated\"}", "Type": "SearchableString" }, "/aws/resources": { "Value": "[{\"arn\":\"arn:aws:ec2:us-east-2:111222333444:instance/i-05adec7e97EXAMPLE\"}]", "Type": "SearchableString" }, "event-time": { "Value": "2019-12-04T23:52:16Z", "Type": "String" }, "instance-state": { "Value": "terminated", "Type": "String" } }, "Category": "Availability", "Severity": "4" } }

Pour plus d'informations, reportez-vous à la section Travailler avec OpsItems dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir GetOpsItemla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-ops-summary.

AWS CLI

Pour afficher un résumé de tous OpsItems

L'get-ops-summaryexemple suivant affiche un résumé de tous les éléments OpsItems de votre AWS compte.

aws ssm get-ops-summary

Sortie :

{ "Entities": [ { "Id": "oi-4309fEXAMPLE", "Data": { "AWS:OpsItem": { "CaptureTime": "2020-02-26T18:58:32.918Z", "Content": [ { "AccountId": "111222333444", "Category": "Availability", "CreatedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "CreatedTime": "2020-02-26T19:10:44.149Z", "Description": "CloudWatch Event Rule SSMOpsItems-EC2-instance-terminated was triggered. Your EC2 instance has terminated. See below for more details.", "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "LastModifiedTime": "2020-02-26T19:10:44.149Z", "Notifications": "", "OperationalData": "{\"/aws/automations\":{\"type\":\"SearchableString\",\"value\":\"[ { \\\"automationType\\\": \\\"AWS:SSM:Automation\\\", \\\"automationId\\\": \\\"AWS-CreateManagedWindowsInstance\\\" }, { \\\"automationType\\\": \\\"AWS:SSM:Automation\\\", \\\"automationId\\\": \\\"AWS-CreateManagedLinuxInstance\\\" } ]\"},\"/aws/resources\":{\"type\":\"SearchableString\",\"value\":\"[{\\\"arn\\\":\\\"arn:aws:ec2:us-east-2:111222333444:instance/i-0acbd0800fEXAMPLE\\\"}]\"},\"/aws/dedup\":{\"type\":\"SearchableString\",\"value\":\"{\\\"dedupString\\\":\\\"SSMOpsItems-EC2-instance-terminated\\\"}\"}}", "OpsItemId": "oi-4309fEXAMPLE", "RelatedItems": "", "Severity": "3", "Source": "EC2", "Status": "Open", "Title": "EC2 instance terminated" } ] } } }, { "Id": "oi-bb2a0e6a4541", "Data": { "AWS:OpsItem": { "CaptureTime": "2019-11-26T19:20:06.161Z", "Content": [ { "AccountId": "111222333444", "Category": "Availability", "CreatedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "CreatedTime": "2019-11-26T20:00:07.237Z", "Description": "CloudWatch Event Rule SSMOpsItems-SSM-maintenance-window-execution-failed was triggered. Your SSM Maintenance Window execution has failed. See below for more details.", "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "LastModifiedTime": "2019-11-26T20:00:07.237Z", "Notifications": "", "OperationalData": "{\"/aws/resources\":{\"type\":\"SearchableString\",\"value\":\"[{\\\"arn\\\":\\\"arn:aws:ssm:us-east-2:111222333444:maintenancewindow/mw-0e83ba440dEXAMPLE\\\"}]\"},\"/aws/dedup\":{\"type\":\"SearchableString\",\"value\":\"{\\\"dedupString\\\":\\\"SSMOpsItems-SSM-maintenance-window-execution-failed\\\"}\"}}", "OpsItemId": "oi-bb2a0EXAMPLE", "RelatedItems": "", "Severity": "3", "Source": "SSM", "Status": "Open", "Title": "SSM Maintenance Window execution failed" } ] } } } ] }

Pour plus d'informations, reportez-vous à la section Travailler avec OpsItems dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir GetOpsSummaryla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-ops-summary.

AWS CLI

Pour afficher un résumé de tous OpsItems

L'get-ops-summaryexemple suivant affiche un résumé de tous les éléments OpsItems de votre AWS compte.

aws ssm get-ops-summary

Sortie :

{ "Entities": [ { "Id": "oi-4309fEXAMPLE", "Data": { "AWS:OpsItem": { "CaptureTime": "2020-02-26T18:58:32.918Z", "Content": [ { "AccountId": "111222333444", "Category": "Availability", "CreatedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "CreatedTime": "2020-02-26T19:10:44.149Z", "Description": "CloudWatch Event Rule SSMOpsItems-EC2-instance-terminated was triggered. Your EC2 instance has terminated. See below for more details.", "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "LastModifiedTime": "2020-02-26T19:10:44.149Z", "Notifications": "", "OperationalData": "{\"/aws/automations\":{\"type\":\"SearchableString\",\"value\":\"[ { \\\"automationType\\\": \\\"AWS:SSM:Automation\\\", \\\"automationId\\\": \\\"AWS-CreateManagedWindowsInstance\\\" }, { \\\"automationType\\\": \\\"AWS:SSM:Automation\\\", \\\"automationId\\\": \\\"AWS-CreateManagedLinuxInstance\\\" } ]\"},\"/aws/resources\":{\"type\":\"SearchableString\",\"value\":\"[{\\\"arn\\\":\\\"arn:aws:ec2:us-east-2:111222333444:instance/i-0acbd0800fEXAMPLE\\\"}]\"},\"/aws/dedup\":{\"type\":\"SearchableString\",\"value\":\"{\\\"dedupString\\\":\\\"SSMOpsItems-EC2-instance-terminated\\\"}\"}}", "OpsItemId": "oi-4309fEXAMPLE", "RelatedItems": "", "Severity": "3", "Source": "EC2", "Status": "Open", "Title": "EC2 instance terminated" } ] } } }, { "Id": "oi-bb2a0e6a4541", "Data": { "AWS:OpsItem": { "CaptureTime": "2019-11-26T19:20:06.161Z", "Content": [ { "AccountId": "111222333444", "Category": "Availability", "CreatedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "CreatedTime": "2019-11-26T20:00:07.237Z", "Description": "CloudWatch Event Rule SSMOpsItems-SSM-maintenance-window-execution-failed was triggered. Your SSM Maintenance Window execution has failed. See below for more details.", "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "LastModifiedTime": "2019-11-26T20:00:07.237Z", "Notifications": "", "OperationalData": "{\"/aws/resources\":{\"type\":\"SearchableString\",\"value\":\"[{\\\"arn\\\":\\\"arn:aws:ssm:us-east-2:111222333444:maintenancewindow/mw-0e83ba440dEXAMPLE\\\"}]\"},\"/aws/dedup\":{\"type\":\"SearchableString\",\"value\":\"{\\\"dedupString\\\":\\\"SSMOpsItems-SSM-maintenance-window-execution-failed\\\"}\"}}", "OpsItemId": "oi-bb2a0EXAMPLE", "RelatedItems": "", "Severity": "3", "Source": "SSM", "Status": "Open", "Title": "SSM Maintenance Window execution failed" } ] } } } ] }

Pour plus d'informations, reportez-vous à la section Travailler avec OpsItems dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir GetOpsSummaryla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-parameter-history.

AWS CLI

Pour obtenir un historique des valeurs d’un paramètre

L’exemple de get-parameter-history suivant répertorie l’historique des modifications pour le paramètre spécifié, y compris sa valeur.

aws ssm get-parameter-history \ --name "MyStringParameter"

Sortie :

{ "Parameters": [ { "Name": "MyStringParameter", "Type": "String", "LastModifiedDate": 1582154711.976, "LastModifiedUser": "arn:aws:iam::111222333444:user/Mary-Major", "Description": "This is the first version of my String parameter", "Value": "Veni", "Version": 1, "Labels": [], "Tier": "Standard", "Policies": [] }, { "Name": "MyStringParameter", "Type": "String", "LastModifiedDate": 1582156093.471, "LastModifiedUser": "arn:aws:iam::111222333444:user/Mary-Major", "Description": "This is the second version of my String parameter", "Value": "Vidi", "Version": 2, "Labels": [], "Tier": "Standard", "Policies": [] }, { "Name": "MyStringParameter", "Type": "String", "LastModifiedDate": 1582156117.545, "LastModifiedUser": "arn:aws:iam::111222333444:user/Mary-Major", "Description": "This is the third version of my String parameter", "Value": "Vici", "Version": 3, "Labels": [], "Tier": "Standard", "Policies": [] } ] }

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

  • Pour plus de détails sur l'API, voir GetParameterHistoryla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-parameter-history.

AWS CLI

Pour obtenir un historique des valeurs d’un paramètre

L’exemple de get-parameter-history suivant répertorie l’historique des modifications pour le paramètre spécifié, y compris sa valeur.

aws ssm get-parameter-history \ --name "MyStringParameter"

Sortie :

{ "Parameters": [ { "Name": "MyStringParameter", "Type": "String", "LastModifiedDate": 1582154711.976, "LastModifiedUser": "arn:aws:iam::111222333444:user/Mary-Major", "Description": "This is the first version of my String parameter", "Value": "Veni", "Version": 1, "Labels": [], "Tier": "Standard", "Policies": [] }, { "Name": "MyStringParameter", "Type": "String", "LastModifiedDate": 1582156093.471, "LastModifiedUser": "arn:aws:iam::111222333444:user/Mary-Major", "Description": "This is the second version of my String parameter", "Value": "Vidi", "Version": 2, "Labels": [], "Tier": "Standard", "Policies": [] }, { "Name": "MyStringParameter", "Type": "String", "LastModifiedDate": 1582156117.545, "LastModifiedUser": "arn:aws:iam::111222333444:user/Mary-Major", "Description": "This is the third version of my String parameter", "Value": "Vici", "Version": 3, "Labels": [], "Tier": "Standard", "Policies": [] } ] }

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

  • Pour plus de détails sur l'API, voir GetParameterHistoryla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-parameter.

AWS CLI

Exemple 1 : affichage de la valeur d’un paramètre

L’exemple de get-parameter suivant répertorie la valeur de l’unique paramètre spécifié.

aws ssm get-parameter \ --name "MyStringParameter"

Sortie :

{ "Parameter": { "Name": "MyStringParameter", "Type": "String", "Value": "Veni", "Version": 1, "LastModifiedDate": 1530018761.888, "ARN": "arn:aws:ssm:us-east-2:111222333444:parameter/MyStringParameter" "DataType": "text" } }

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

Exemple 2 : pour déchiffrer la valeur d'un paramètre SecureString

L’exemple de get-parameter suivant déchiffre la valeur du paramètre SecureString spécifié.

aws ssm get-parameter \ --name "MySecureStringParameter" \ --with-decryption

Sortie :

{ "Parameter": { "Name": "MySecureStringParameter", "Type": "SecureString", "Value": "16679b88-310b-4895-a943-e0764EXAMPLE", "Version": 2, "LastModifiedDate": 1582155479.205, "ARN": "arn:aws:ssm:us-east-2:111222333444:parameter/MySecureStringParameter" "DataType": "text" } }

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

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

L’exemple get-parameter suivant répertorie la valeur du paramètre unique spécifié à l’aide d’une étiquette.

aws ssm get-parameter \ --name "MyParameter:label"

Sortie :

{ "Parameter": { "Name": "MyParameter", "Type": "String", "Value": "parameter version 2", "Version": 2, "Selector": ":label", "LastModifiedDate": "2021-07-12T09:49:15.865000-07:00", "ARN": "arn:aws:ssm:us-west-2:786973925828:parameter/MyParameter", "DataType": "text" } }

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

Exemple 4 : affichage de la valeur d’un paramètre en utilisant les versions

L’exemple de get-parameter suivant répertorie la valeur de la version du paramètre unique spécifié.

aws ssm get-parameter \ --name "MyParameter:2"

Sortie :

{ "Parameter": { "Name": "MyParameter", "Type": "String", "Value": "parameter version 2", "Version": 2, "Selector": ":2", "LastModifiedDate": "2021-07-12T09:49:15.865000-07:00", "ARN": "arn:aws:ssm:us-west-2:786973925828:parameter/MyParameter", "DataType": "text" } }

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 GetParameterla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-parameter.

AWS CLI

Exemple 1 : affichage de la valeur d’un paramètre

L’exemple de get-parameter suivant répertorie la valeur de l’unique paramètre spécifié.

aws ssm get-parameter \ --name "MyStringParameter"

Sortie :

{ "Parameter": { "Name": "MyStringParameter", "Type": "String", "Value": "Veni", "Version": 1, "LastModifiedDate": 1530018761.888, "ARN": "arn:aws:ssm:us-east-2:111222333444:parameter/MyStringParameter" "DataType": "text" } }

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

Exemple 2 : pour déchiffrer la valeur d'un paramètre SecureString

L’exemple de get-parameter suivant déchiffre la valeur du paramètre SecureString spécifié.

aws ssm get-parameter \ --name "MySecureStringParameter" \ --with-decryption

Sortie :

{ "Parameter": { "Name": "MySecureStringParameter", "Type": "SecureString", "Value": "16679b88-310b-4895-a943-e0764EXAMPLE", "Version": 2, "LastModifiedDate": 1582155479.205, "ARN": "arn:aws:ssm:us-east-2:111222333444:parameter/MySecureStringParameter" "DataType": "text" } }

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

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

L’exemple get-parameter suivant répertorie la valeur du paramètre unique spécifié à l’aide d’une étiquette.

aws ssm get-parameter \ --name "MyParameter:label"

Sortie :

{ "Parameter": { "Name": "MyParameter", "Type": "String", "Value": "parameter version 2", "Version": 2, "Selector": ":label", "LastModifiedDate": "2021-07-12T09:49:15.865000-07:00", "ARN": "arn:aws:ssm:us-west-2:786973925828:parameter/MyParameter", "DataType": "text" } }

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

Exemple 4 : affichage de la valeur d’un paramètre en utilisant les versions

L’exemple de get-parameter suivant répertorie la valeur de la version du paramètre unique spécifié.

aws ssm get-parameter \ --name "MyParameter:2"

Sortie :

{ "Parameter": { "Name": "MyParameter", "Type": "String", "Value": "parameter version 2", "Version": 2, "Selector": ":2", "LastModifiedDate": "2021-07-12T09:49:15.865000-07:00", "ARN": "arn:aws:ssm:us-west-2:786973925828:parameter/MyParameter", "DataType": "text" } }

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 GetParameterla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-parameters-by-path.

AWS CLI

Pour répertorier les paramètres dans un chemin spécifique

L'get-parameters-by-pathexemple suivant répertorie les paramètres au sein de la hiérarchie spécifiée.

aws ssm get-parameters-by-path \ --path "/site/newyork/department/"

Sortie :

{ "Parameters": [ { "Name": "/site/newyork/department/marketing", "Type": "String", "Value": "Floor 2", "Version": 1, "LastModifiedDate": 1530018761.888, "ARN": "arn:aws:ssm:us-east-1:111222333444:parameter/site/newyork/department/marketing" }, { "Name": "/site/newyork/department/infotech", "Type": "String", "Value": "Floor 3", "Version": 1, "LastModifiedDate": 1530018823.429, "ARN": "arn:aws:ssm:us-east-1:111222333444:parameter/site/newyork/department/infotech" }, ... ] }

Pour plus d'informations, consultez la section Utilisation des hiérarchies de paramètres dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir GetParametersByPathla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-parameters-by-path.

AWS CLI

Pour répertorier les paramètres dans un chemin spécifique

L'get-parameters-by-pathexemple suivant répertorie les paramètres au sein de la hiérarchie spécifiée.

aws ssm get-parameters-by-path \ --path "/site/newyork/department/"

Sortie :

{ "Parameters": [ { "Name": "/site/newyork/department/marketing", "Type": "String", "Value": "Floor 2", "Version": 1, "LastModifiedDate": 1530018761.888, "ARN": "arn:aws:ssm:us-east-1:111222333444:parameter/site/newyork/department/marketing" }, { "Name": "/site/newyork/department/infotech", "Type": "String", "Value": "Floor 3", "Version": 1, "LastModifiedDate": 1530018823.429, "ARN": "arn:aws:ssm:us-east-1:111222333444:parameter/site/newyork/department/infotech" }, ... ] }

Pour plus d'informations, consultez la section Utilisation des hiérarchies de paramètres dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir GetParametersByPathla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-parameters.

AWS CLI

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

L’exemple de 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-east-2:111222333444:parameter/MyStringListParameter" "DataType": "text" }, { "Name": "MyStringParameter", "Type": "String", "Value": "Vici", "Version": 3, "LastModifiedDate": 1582156117.545, "ARN": "arn:aws:ssm:us-east-2:111222333444: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 : répertorier les noms et les valeurs de plusieurs paramètres en utilisant l’option ``--query``

L’exemple de 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 : affichage de la valeur d’un paramètre à l’aide d’étiquettes

L’exemple get-parameter suivant répertorie la valeur du paramètre unique spécifié à l’aide d’une étiquette.

aws ssm get-parameter \ --name "MyParameter:label"

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:786973925828:parameter/MyParameter", "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:786973925828:parameter/unlabel-param", "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 GetParametersla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-parameters.

AWS CLI

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

L’exemple de 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-east-2:111222333444:parameter/MyStringListParameter" "DataType": "text" }, { "Name": "MyStringParameter", "Type": "String", "Value": "Vici", "Version": 3, "LastModifiedDate": 1582156117.545, "ARN": "arn:aws:ssm:us-east-2:111222333444: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 : répertorier les noms et les valeurs de plusieurs paramètres en utilisant l’option ``--query``

L’exemple de 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 : affichage de la valeur d’un paramètre à l’aide d’étiquettes

L’exemple get-parameter suivant répertorie la valeur du paramètre unique spécifié à l’aide d’une étiquette.

aws ssm get-parameter \ --name "MyParameter:label"

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:786973925828:parameter/MyParameter", "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:786973925828:parameter/unlabel-param", "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 GetParametersla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-patch-baseline-for-patch-group.

AWS CLI

Pour afficher le référentiel de correctifs d’un groupe de correctifs

L’exemple de get-patch-baseline-for-patch-group suivant permet de récupérer les détails du référentiel de correctifs pour le groupe de correctifs spécifié.

aws ssm get-patch-baseline-for-patch-group \ --patch-group "DEV"

Sortie :

{ "PatchGroup": "DEV", "BaselineId": "pb-0123456789abcdef0", "OperatingSystem": "WINDOWS" }

Pour plus d'informations, consultez les sections Créer un groupe de correctifs < https://docs.aws.amazon.com/systems-manager/ latest/userguide/sysman - patch-group-tagging .html>__ et Ajouter un groupe de correctifs à une ligne de base de correctifs dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserget-patch-baseline-for-patch-group.

AWS CLI

Pour afficher le référentiel de correctifs d’un groupe de correctifs

L’exemple de get-patch-baseline-for-patch-group suivant permet de récupérer les détails du référentiel de correctifs pour le groupe de correctifs spécifié.

aws ssm get-patch-baseline-for-patch-group \ --patch-group "DEV"

Sortie :

{ "PatchGroup": "DEV", "BaselineId": "pb-0123456789abcdef0", "OperatingSystem": "WINDOWS" }

Pour plus d'informations, consultez les sections Créer un groupe de correctifs < https://docs.aws.amazon.com/systems-manager/ latest/userguide/sysman - patch-group-tagging .html>__ et Ajouter un groupe de correctifs à une ligne de base de correctifs dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserget-patch-baseline.

AWS CLI

Pour afficher un référentiel de correctifs

L’exemple de get-patch-baseline suivant récupère les détails du référentiel de correctifs spécifié.

aws ssm get-patch-baseline \ --baseline-id "pb-0123456789abcdef0"

Sortie :

{ "BaselineId": "pb-0123456789abcdef0", "Name": "WindowsPatching", "OperatingSystem": "WINDOWS", "GlobalFilters": { "PatchFilters": [] }, "ApprovalRules": { "PatchRules": [ { "PatchFilterGroup": { "PatchFilters": [ { "Key": "PRODUCT", "Values": [ "WindowsServer2016" ] } ] }, "ComplianceLevel": "CRITICAL", "ApproveAfterDays": 0, "EnableNonSecurity": false } ] }, "ApprovedPatches": [], "ApprovedPatchesComplianceLevel": "UNSPECIFIED", "ApprovedPatchesEnableNonSecurity": false, "RejectedPatches": [], "RejectedPatchesAction": "ALLOW_AS_DEPENDENCY", "PatchGroups": [ "QA", "DEV" ], "CreatedDate": 1550244180.465, "ModifiedDate": 1550244180.465, "Description": "Patches for Windows Servers", "Sources": [] }

Pour plus d’informations, consultez À propos des référentiels de correctifs dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, voir GetPatchBaselinela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-patch-baseline.

AWS CLI

Pour afficher un référentiel de correctifs

L’exemple de get-patch-baseline suivant récupère les détails du référentiel de correctifs spécifié.

aws ssm get-patch-baseline \ --baseline-id "pb-0123456789abcdef0"

Sortie :

{ "BaselineId": "pb-0123456789abcdef0", "Name": "WindowsPatching", "OperatingSystem": "WINDOWS", "GlobalFilters": { "PatchFilters": [] }, "ApprovalRules": { "PatchRules": [ { "PatchFilterGroup": { "PatchFilters": [ { "Key": "PRODUCT", "Values": [ "WindowsServer2016" ] } ] }, "ComplianceLevel": "CRITICAL", "ApproveAfterDays": 0, "EnableNonSecurity": false } ] }, "ApprovedPatches": [], "ApprovedPatchesComplianceLevel": "UNSPECIFIED", "ApprovedPatchesEnableNonSecurity": false, "RejectedPatches": [], "RejectedPatchesAction": "ALLOW_AS_DEPENDENCY", "PatchGroups": [ "QA", "DEV" ], "CreatedDate": 1550244180.465, "ModifiedDate": 1550244180.465, "Description": "Patches for Windows Servers", "Sources": [] }

Pour plus d’informations, consultez À propos des référentiels de correctifs dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, voir GetPatchBaselinela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-service-setting.

AWS CLI

Pour récupérer le paramètre de service pour le débit du Parameter Store

get-service-settingCet exemple extrait le paramètre de service actuel pour le débit du Parameter Store dans la région spécifiée.

aws ssm get-service-setting \ --setting-id arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled

Sortie :

{ "ServiceSetting": { "SettingId": "/ssm/parameter-store/high-throughput-enabled", "SettingValue": "false", "LastModifiedDate": 1555532818.578, "LastModifiedUser": "System", "ARN": "arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled", "Status": "Default" } }

Pour plus d'informations, consultez la section Increasing Parameter Store Throughput dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir GetServiceSettingla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-service-setting.

AWS CLI

Pour récupérer le paramètre de service pour le débit du Parameter Store

get-service-settingCet exemple extrait le paramètre de service actuel pour le débit du Parameter Store dans la région spécifiée.

aws ssm get-service-setting \ --setting-id arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled

Sortie :

{ "ServiceSetting": { "SettingId": "/ssm/parameter-store/high-throughput-enabled", "SettingValue": "false", "LastModifiedDate": 1555532818.578, "LastModifiedUser": "System", "ARN": "arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled", "Status": "Default" } }

Pour plus d'informations, consultez la section Increasing Parameter Store Throughput dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir GetServiceSettingla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlabel-parameter-version.

AWS CLI

Exemple 1 : pour ajouter une étiquette à la dernière version d'un paramètre

L'label-parameter-versionexemple suivant ajoute une étiquette à la dernière version du paramètre spécifié.

aws ssm label-parameter-version \ --name "MyStringParameter" \ --labels "ProductionReady"

Sortie :

{ "InvalidLabels": [], "ParameterVersion": 3 }

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

Exemple 2 : pour ajouter une étiquette à une version spécifique d'un paramètre

L'label-parameter-versionexemple suivant ajoute une étiquette à la version spécifiée d'un paramètre.

aws ssm label-parameter-version \ --name "MyStringParameter" \ --labels "ProductionReady" \ --parameter-version "2" --labels "DevelopmentReady"

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 LabelParameterVersionla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlabel-parameter-version.

AWS CLI

Exemple 1 : pour ajouter une étiquette à la dernière version d'un paramètre

L'label-parameter-versionexemple suivant ajoute une étiquette à la dernière version du paramètre spécifié.

aws ssm label-parameter-version \ --name "MyStringParameter" \ --labels "ProductionReady"

Sortie :

{ "InvalidLabels": [], "ParameterVersion": 3 }

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

Exemple 2 : pour ajouter une étiquette à une version spécifique d'un paramètre

L'label-parameter-versionexemple suivant ajoute une étiquette à la version spécifiée d'un paramètre.

aws ssm label-parameter-version \ --name "MyStringParameter" \ --labels "ProductionReady" \ --parameter-version "2" --labels "DevelopmentReady"

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 LabelParameterVersionla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-association-versions.

AWS CLI

Pour répertorier toutes les versions d’une association pour un ID d’association spécifique

L’exemple de list-association-versions suivant répertorie toutes les versions des associations spécifiées.

aws ssm list-association-versions \ --association-id "8dfe3659-4309-493a-8755-0123456789ab"

Sortie :

{ "AssociationVersions": [ { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "CreatedDate": 1550505536.726, "Name": "AWS-UpdateSSMAgent", "Parameters": { "allowDowngrade": [ "false" ], "version": [ "" ] }, "Targets": [ { "Key": "InstanceIds", "Values": [ "i-1234567890abcdef0" ] } ], "ScheduleExpression": "cron(0 00 12 ? * SUN *)", "AssociationName": "UpdateSSMAgent" } ] }

Pour plus d’informations, consultez Utilisation des associations dans Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserlist-association-versions.

AWS CLI

Pour répertorier toutes les versions d’une association pour un ID d’association spécifique

L’exemple de list-association-versions suivant répertorie toutes les versions des associations spécifiées.

aws ssm list-association-versions \ --association-id "8dfe3659-4309-493a-8755-0123456789ab"

Sortie :

{ "AssociationVersions": [ { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "CreatedDate": 1550505536.726, "Name": "AWS-UpdateSSMAgent", "Parameters": { "allowDowngrade": [ "false" ], "version": [ "" ] }, "Targets": [ { "Key": "InstanceIds", "Values": [ "i-1234567890abcdef0" ] } ], "ScheduleExpression": "cron(0 00 12 ? * SUN *)", "AssociationName": "UpdateSSMAgent" } ] }

Pour plus d’informations, consultez Utilisation des associations dans Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserlist-associations.

AWS CLI

Exemple 1 : répertorier vos associations pour une instance spécifique

L'exemple de liste-associations suivant répertorie toutes les associations avec le paramètre Update AssociationName. SSMAgent

aws ssm list-associations / --association-filter-list "key=AssociationName,value=UpdateSSMAgent"

Sortie :

{ "Associations": [ { "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-1234567890abcdef0", "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "Targets": [ { "Key": "InstanceIds", "Values": [ "i-016648b75dd622dab" ] } ], "Overview": { "Status": "Pending", "DetailedStatus": "Associated", "AssociationStatusAggregatedCount": { "Pending": 1 } }, "ScheduleExpression": "cron(0 00 12 ? * SUN *)", "AssociationName": "UpdateSSMAgent" } ] }

Pour plus d’informations, consultez Utilisation des associations dans Systems Manager dans le Guide de l’utilisateur Systems Manager.

Exemple 2 : répertorier vos associations pour un document spécifique

L’exemple de list-associations suivant répertorie toutes les associations pour le document spécifié.

aws ssm list-associations / --association-filter-list "key=Name,value=AWS-UpdateSSMAgent"

Sortie :

{ "Associations": [ { "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-1234567890abcdef0", "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "Targets": [ { "Key": "InstanceIds", "Values": [ "i-1234567890abcdef0" ] } ], "LastExecutionDate": 1550505828.548, "Overview": { "Status": "Success", "DetailedStatus": "Success", "AssociationStatusAggregatedCount": { "Success": 1 } }, "ScheduleExpression": "cron(0 00 12 ? * SUN *)", "AssociationName": "UpdateSSMAgent" }, { "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-9876543210abcdef0", "AssociationId": "fbc07ef7-b985-4684-b82b-0123456789ab", "AssociationVersion": "1", "Targets": [ { "Key": "InstanceIds", "Values": [ "i-9876543210abcdef0" ] } ], "LastExecutionDate": 1550507531.0, "Overview": { "Status": "Success", "AssociationStatusAggregatedCount": { "Success": 1 } } } ] }

Pour plus d’informations, consultez Utilisation des associations dans Systems Manager dans le Guide de l’utilisateur Systems Manager.

  • Pour plus de détails sur l'API, voir ListAssociationsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-associations.

AWS CLI

Exemple 1 : répertorier vos associations pour une instance spécifique

L'exemple de liste-associations suivant répertorie toutes les associations avec le paramètre Update AssociationName. SSMAgent

aws ssm list-associations / --association-filter-list "key=AssociationName,value=UpdateSSMAgent"

Sortie :

{ "Associations": [ { "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-1234567890abcdef0", "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "Targets": [ { "Key": "InstanceIds", "Values": [ "i-016648b75dd622dab" ] } ], "Overview": { "Status": "Pending", "DetailedStatus": "Associated", "AssociationStatusAggregatedCount": { "Pending": 1 } }, "ScheduleExpression": "cron(0 00 12 ? * SUN *)", "AssociationName": "UpdateSSMAgent" } ] }

Pour plus d’informations, consultez Utilisation des associations dans Systems Manager dans le Guide de l’utilisateur Systems Manager.

Exemple 2 : répertorier vos associations pour un document spécifique

L’exemple de list-associations suivant répertorie toutes les associations pour le document spécifié.

aws ssm list-associations / --association-filter-list "key=Name,value=AWS-UpdateSSMAgent"

Sortie :

{ "Associations": [ { "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-1234567890abcdef0", "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "Targets": [ { "Key": "InstanceIds", "Values": [ "i-1234567890abcdef0" ] } ], "LastExecutionDate": 1550505828.548, "Overview": { "Status": "Success", "DetailedStatus": "Success", "AssociationStatusAggregatedCount": { "Success": 1 } }, "ScheduleExpression": "cron(0 00 12 ? * SUN *)", "AssociationName": "UpdateSSMAgent" }, { "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-9876543210abcdef0", "AssociationId": "fbc07ef7-b985-4684-b82b-0123456789ab", "AssociationVersion": "1", "Targets": [ { "Key": "InstanceIds", "Values": [ "i-9876543210abcdef0" ] } ], "LastExecutionDate": 1550507531.0, "Overview": { "Status": "Success", "AssociationStatusAggregatedCount": { "Success": 1 } } } ] }

Pour plus d’informations, consultez Utilisation des associations dans Systems Manager dans le Guide de l’utilisateur Systems Manager.

  • Pour plus de détails sur l'API, voir ListAssociationsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-command-invocations.

AWS CLI

Pour répertorier les invocations d’une commande spécifique

L’exemple de list-command-invocations suivant répertorie toutes les invocations d’une commande.

aws ssm list-command-invocations \ --command-id "ef7fdfd8-9b57-4151-a15c-db9a12345678" \ --details

Sortie :

{ "CommandInvocations": [ { "CommandId": "ef7fdfd8-9b57-4151-a15c-db9a12345678", "InstanceId": "i-02573cafcfEXAMPLE", "InstanceName": "", "Comment": "b48291dd-ba76-43e0-b9df-13e11ddaac26:6960febb-2907-4b59-8e1a-d6ce8EXAMPLE", "DocumentName": "AWS-UpdateSSMAgent", "DocumentVersion": "", "RequestedDateTime": 1582136283.089, "Status": "Success", "StatusDetails": "Success", "StandardOutputUrl": "", "StandardErrorUrl": "", "CommandPlugins": [ { "Name": "aws:updateSsmAgent", "Status": "Success", "StatusDetails": "Success", "ResponseCode": 0, "ResponseStartDateTime": 1582136283.419, "ResponseFinishDateTime": 1582136283.51, "Output": "Updating amazon-ssm-agent from 2.3.842.0 to latest\nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/ssm-agent-manifest.json\namazon-ssm-agent 2.3.842.0 has already been installed, update skipped\n", "StandardOutputUrl": "", "StandardErrorUrl": "", "OutputS3Region": "us-east-2", "OutputS3BucketName": "", "OutputS3KeyPrefix": "" } ], "ServiceRole": "", "NotificationConfig": { "NotificationArn": "", "NotificationEvents": [], "NotificationType": "" }, "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false } }, { "CommandId": "ef7fdfd8-9b57-4151-a15c-db9a12345678", "InstanceId": "i-0471e04240EXAMPLE", "InstanceName": "", "Comment": "b48291dd-ba76-43e0-b9df-13e11ddaac26:6960febb-2907-4b59-8e1a-d6ce8EXAMPLE", "DocumentName": "AWS-UpdateSSMAgent", "DocumentVersion": "", "RequestedDateTime": 1582136283.02, "Status": "Success", "StatusDetails": "Success", "StandardOutputUrl": "", "StandardErrorUrl": "", "CommandPlugins": [ { "Name": "aws:updateSsmAgent", "Status": "Success", "StatusDetails": "Success", "ResponseCode": 0, "ResponseStartDateTime": 1582136283.812, "ResponseFinishDateTime": 1582136295.031, "Output": "Updating amazon-ssm-agent from 2.3.672.0 to latest\nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/ssm-agent-manifest.json\nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/amazon-ssm-agent-updater/2.3.842.0/amazon-ssm-agent-updater-snap-amd64.tar.gz\nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/amazon-ssm-agent/2.3.672.0/amazon-ssm-agent-snap-amd64.tar.gz\nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/amazon-ssm-agent/2.3.842.0/amazon-ssm-agent-snap-amd64.tar.gz\nInitiating amazon-ssm-agent update to 2.3.842.0\namazon-ssm-agent updated successfully to 2.3.842.0", "StandardOutputUrl": "", "StandardErrorUrl": "", "OutputS3Region": "us-east-2", "OutputS3BucketName": "", "OutputS3KeyPrefix": "8bee3135-398c-4d31-99b6-e42d2EXAMPLE/i-0471e04240EXAMPLE/awsupdateSsmAgent" } ], "ServiceRole": "", "NotificationConfig": { "NotificationArn": "", "NotificationEvents": [], "NotificationType": "" }, "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false } } ] }

Pour plus d’informations, consultez Comprendre les statuts de commande dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserlist-command-invocations.

AWS CLI

Pour répertorier les invocations d’une commande spécifique

L’exemple de list-command-invocations suivant répertorie toutes les invocations d’une commande.

aws ssm list-command-invocations \ --command-id "ef7fdfd8-9b57-4151-a15c-db9a12345678" \ --details

Sortie :

{ "CommandInvocations": [ { "CommandId": "ef7fdfd8-9b57-4151-a15c-db9a12345678", "InstanceId": "i-02573cafcfEXAMPLE", "InstanceName": "", "Comment": "b48291dd-ba76-43e0-b9df-13e11ddaac26:6960febb-2907-4b59-8e1a-d6ce8EXAMPLE", "DocumentName": "AWS-UpdateSSMAgent", "DocumentVersion": "", "RequestedDateTime": 1582136283.089, "Status": "Success", "StatusDetails": "Success", "StandardOutputUrl": "", "StandardErrorUrl": "", "CommandPlugins": [ { "Name": "aws:updateSsmAgent", "Status": "Success", "StatusDetails": "Success", "ResponseCode": 0, "ResponseStartDateTime": 1582136283.419, "ResponseFinishDateTime": 1582136283.51, "Output": "Updating amazon-ssm-agent from 2.3.842.0 to latest\nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/ssm-agent-manifest.json\namazon-ssm-agent 2.3.842.0 has already been installed, update skipped\n", "StandardOutputUrl": "", "StandardErrorUrl": "", "OutputS3Region": "us-east-2", "OutputS3BucketName": "", "OutputS3KeyPrefix": "" } ], "ServiceRole": "", "NotificationConfig": { "NotificationArn": "", "NotificationEvents": [], "NotificationType": "" }, "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false } }, { "CommandId": "ef7fdfd8-9b57-4151-a15c-db9a12345678", "InstanceId": "i-0471e04240EXAMPLE", "InstanceName": "", "Comment": "b48291dd-ba76-43e0-b9df-13e11ddaac26:6960febb-2907-4b59-8e1a-d6ce8EXAMPLE", "DocumentName": "AWS-UpdateSSMAgent", "DocumentVersion": "", "RequestedDateTime": 1582136283.02, "Status": "Success", "StatusDetails": "Success", "StandardOutputUrl": "", "StandardErrorUrl": "", "CommandPlugins": [ { "Name": "aws:updateSsmAgent", "Status": "Success", "StatusDetails": "Success", "ResponseCode": 0, "ResponseStartDateTime": 1582136283.812, "ResponseFinishDateTime": 1582136295.031, "Output": "Updating amazon-ssm-agent from 2.3.672.0 to latest\nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/ssm-agent-manifest.json\nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/amazon-ssm-agent-updater/2.3.842.0/amazon-ssm-agent-updater-snap-amd64.tar.gz\nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/amazon-ssm-agent/2.3.672.0/amazon-ssm-agent-snap-amd64.tar.gz\nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/amazon-ssm-agent/2.3.842.0/amazon-ssm-agent-snap-amd64.tar.gz\nInitiating amazon-ssm-agent update to 2.3.842.0\namazon-ssm-agent updated successfully to 2.3.842.0", "StandardOutputUrl": "", "StandardErrorUrl": "", "OutputS3Region": "us-east-2", "OutputS3BucketName": "", "OutputS3KeyPrefix": "8bee3135-398c-4d31-99b6-e42d2EXAMPLE/i-0471e04240EXAMPLE/awsupdateSsmAgent" } ], "ServiceRole": "", "NotificationConfig": { "NotificationArn": "", "NotificationEvents": [], "NotificationType": "" }, "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false } } ] }

Pour plus d’informations, consultez Comprendre les statuts de commande dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserlist-commands.

AWS CLI

Exemple 1 : obtention du statut d’une commande spécifique

L’exemple de list-commands suivant récupère et affiche le statut de la commande spécifiée.

aws ssm list-commands \ --command-id "0831e1a8-a1ac-4257-a1fd-c831bEXAMPLE"

Exemple 2 : obtention du statut des commandes demandées après une date donnée

L’exemple de list-commands suivant permet de récupérer les détails des commandes demandées après la date spécifiée.

aws ssm list-commands \ --filter "key=InvokedAfter,value=2020-02-01T00:00:00Z"

Exemple 3 : Pour répertorier toutes les commandes demandées dans un AWS compte

L'list-commandsexemple suivant répertorie toutes les commandes demandées par les utilisateurs du AWS compte courant et de la région.

aws ssm list-commands

Sortie :

{ "Commands": [ { "CommandId": "8bee3135-398c-4d31-99b6-e42d2EXAMPLE", "DocumentName": "AWS-UpdateSSMAgent", "DocumentVersion": "", "Comment": "b48291dd-ba76-43e0-b9df-13e11ddaac26:6960febb-2907-4b59-8e1a-d6ce8EXAMPLE", "ExpiresAfter": "2020-02-19T11:28:02.500000-08:00", "Parameters": {}, "InstanceIds": [ "i-028ea792daEXAMPLE", "i-02feef8c46EXAMPLE", "i-038613f3f0EXAMPLE", "i-03a530a2d4EXAMPLE", "i-083b678d37EXAMPLE", "i-0dee81debaEXAMPLE" ], "Targets": [], "RequestedDateTime": "2020-02-19T10:18:02.500000-08:00", "Status": "Success", "StatusDetails": "Success", "OutputS3BucketName": "", "OutputS3KeyPrefix": "", "MaxConcurrency": "50", "MaxErrors": "100%", "TargetCount": 6, "CompletedCount": 6, "ErrorCount": 0, "DeliveryTimedOutCount": 0, "ServiceRole": "", "NotificationConfig": { "NotificationArn": "", "NotificationEvents": [], "NotificationType": "" }, "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false } } { "CommandId": "e9ade581-c03d-476b-9b07-26667EXAMPLE", "DocumentName": "AWS-FindWindowsUpdates", "DocumentVersion": "1", "Comment": "", "ExpiresAfter": "2020-01-24T12:37:31.874000-08:00", "Parameters": { "KbArticleIds": [ "" ], "UpdateLevel": [ "All" ] }, "InstanceIds": [], "Targets": [ { "Key": "InstanceIds", "Values": [ "i-00ec29b21eEXAMPLE", "i-09911ddd90EXAMPLE" ] } ], "RequestedDateTime": "2020-01-24T11:27:31.874000-08:00", "Status": "Success", "StatusDetails": "Success", "OutputS3BucketName": "my-us-east-2-bucket", "OutputS3KeyPrefix": "my-rc-output", "MaxConcurrency": "50", "MaxErrors": "0", "TargetCount": 2, "CompletedCount": 2, "ErrorCount": 0, "DeliveryTimedOutCount": 0, "ServiceRole": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "NotificationConfig": { "NotificationArn": "arn:aws:sns:us-east-2:111222333444:my-us-east-2-notification-arn", "NotificationEvents": [ "All" ], "NotificationType": "Invocation" }, "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false } } { "CommandId": "d539b6c3-70e8-4853-80e5-0ce4fEXAMPLE", "DocumentName": "AWS-RunPatchBaseline", "DocumentVersion": "1", "Comment": "", "ExpiresAfter": "2020-01-24T12:21:04.350000-08:00", "Parameters": { "InstallOverrideList": [ "" ], "Operation": [ "Install" ], "RebootOption": [ "RebootIfNeeded" ], "SnapshotId": [ "" ] }, "InstanceIds": [], "Targets": [ { "Key": "InstanceIds", "Values": [ "i-00ec29b21eEXAMPLE", "i-09911ddd90EXAMPLE" ] } ], "RequestedDateTime": "2020-01-24T11:11:04.350000-08:00", "Status": "Success", "StatusDetails": "Success", "OutputS3BucketName": "my-us-east-2-bucket", "OutputS3KeyPrefix": "my-rc-output", "MaxConcurrency": "50", "MaxErrors": "0", "TargetCount": 2, "CompletedCount": 2, "ErrorCount": 0, "DeliveryTimedOutCount": 0, "ServiceRole": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "NotificationConfig": { "NotificationArn": "arn:aws:sns:us-east-2:111222333444:my-us-east-2-notification-arn", "NotificationEvents": [ "All" ], "NotificationType": "Invocation" }, "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false } } ] }

Pour plus d’informations, consultez Exécution de commandes à l’aide de Run Command de Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, voir ListCommandsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-commands.

AWS CLI

Exemple 1 : obtention du statut d’une commande spécifique

L’exemple de list-commands suivant récupère et affiche le statut de la commande spécifiée.

aws ssm list-commands \ --command-id "0831e1a8-a1ac-4257-a1fd-c831bEXAMPLE"

Exemple 2 : obtention du statut des commandes demandées après une date donnée

L’exemple de list-commands suivant permet de récupérer les détails des commandes demandées après la date spécifiée.

aws ssm list-commands \ --filter "key=InvokedAfter,value=2020-02-01T00:00:00Z"

Exemple 3 : Pour répertorier toutes les commandes demandées dans un AWS compte

L'list-commandsexemple suivant répertorie toutes les commandes demandées par les utilisateurs du AWS compte courant et de la région.

aws ssm list-commands

Sortie :

{ "Commands": [ { "CommandId": "8bee3135-398c-4d31-99b6-e42d2EXAMPLE", "DocumentName": "AWS-UpdateSSMAgent", "DocumentVersion": "", "Comment": "b48291dd-ba76-43e0-b9df-13e11ddaac26:6960febb-2907-4b59-8e1a-d6ce8EXAMPLE", "ExpiresAfter": "2020-02-19T11:28:02.500000-08:00", "Parameters": {}, "InstanceIds": [ "i-028ea792daEXAMPLE", "i-02feef8c46EXAMPLE", "i-038613f3f0EXAMPLE", "i-03a530a2d4EXAMPLE", "i-083b678d37EXAMPLE", "i-0dee81debaEXAMPLE" ], "Targets": [], "RequestedDateTime": "2020-02-19T10:18:02.500000-08:00", "Status": "Success", "StatusDetails": "Success", "OutputS3BucketName": "", "OutputS3KeyPrefix": "", "MaxConcurrency": "50", "MaxErrors": "100%", "TargetCount": 6, "CompletedCount": 6, "ErrorCount": 0, "DeliveryTimedOutCount": 0, "ServiceRole": "", "NotificationConfig": { "NotificationArn": "", "NotificationEvents": [], "NotificationType": "" }, "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false } } { "CommandId": "e9ade581-c03d-476b-9b07-26667EXAMPLE", "DocumentName": "AWS-FindWindowsUpdates", "DocumentVersion": "1", "Comment": "", "ExpiresAfter": "2020-01-24T12:37:31.874000-08:00", "Parameters": { "KbArticleIds": [ "" ], "UpdateLevel": [ "All" ] }, "InstanceIds": [], "Targets": [ { "Key": "InstanceIds", "Values": [ "i-00ec29b21eEXAMPLE", "i-09911ddd90EXAMPLE" ] } ], "RequestedDateTime": "2020-01-24T11:27:31.874000-08:00", "Status": "Success", "StatusDetails": "Success", "OutputS3BucketName": "my-us-east-2-bucket", "OutputS3KeyPrefix": "my-rc-output", "MaxConcurrency": "50", "MaxErrors": "0", "TargetCount": 2, "CompletedCount": 2, "ErrorCount": 0, "DeliveryTimedOutCount": 0, "ServiceRole": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "NotificationConfig": { "NotificationArn": "arn:aws:sns:us-east-2:111222333444:my-us-east-2-notification-arn", "NotificationEvents": [ "All" ], "NotificationType": "Invocation" }, "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false } } { "CommandId": "d539b6c3-70e8-4853-80e5-0ce4fEXAMPLE", "DocumentName": "AWS-RunPatchBaseline", "DocumentVersion": "1", "Comment": "", "ExpiresAfter": "2020-01-24T12:21:04.350000-08:00", "Parameters": { "InstallOverrideList": [ "" ], "Operation": [ "Install" ], "RebootOption": [ "RebootIfNeeded" ], "SnapshotId": [ "" ] }, "InstanceIds": [], "Targets": [ { "Key": "InstanceIds", "Values": [ "i-00ec29b21eEXAMPLE", "i-09911ddd90EXAMPLE" ] } ], "RequestedDateTime": "2020-01-24T11:11:04.350000-08:00", "Status": "Success", "StatusDetails": "Success", "OutputS3BucketName": "my-us-east-2-bucket", "OutputS3KeyPrefix": "my-rc-output", "MaxConcurrency": "50", "MaxErrors": "0", "TargetCount": 2, "CompletedCount": 2, "ErrorCount": 0, "DeliveryTimedOutCount": 0, "ServiceRole": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "NotificationConfig": { "NotificationArn": "arn:aws:sns:us-east-2:111222333444:my-us-east-2-notification-arn", "NotificationEvents": [ "All" ], "NotificationType": "Invocation" }, "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false } } ] }

Pour plus d’informations, consultez Exécution de commandes à l’aide de Run Command de Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, voir ListCommandsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-compliance-items.

AWS CLI

Pour répertorier les éléments de conformité d’une instance spécifique

Cet exemple répertorie tous les éléments de conformité pour l’instance spécifiée.

Commande :

aws ssm list-compliance-items --resource-ids "i-1234567890abcdef0" --resource-types "ManagedInstance"

Sortie :

{ "ComplianceItems": [ { "ComplianceType": "Association", "ResourceType": "ManagedInstance", "ResourceId": "i-1234567890abcdef0", "Id": "8dfe3659-4309-493a-8755-0123456789ab", "Title": "", "Status": "COMPLIANT", "Severity": "UNSPECIFIED", "ExecutionSummary": { "ExecutionTime": 1550408470.0 }, "Details": { "DocumentName": "AWS-GatherSoftwareInventory", "DocumentVersion": "1" } }, { "ComplianceType": "Association", "ResourceType": "ManagedInstance", "ResourceId": "i-1234567890abcdef0", "Id": "e4c2ed6d-516f-41aa-aa2a-0123456789ab", "Title": "", "Status": "COMPLIANT", "Severity": "UNSPECIFIED", "ExecutionSummary": { "ExecutionTime": 1550508475.0 }, "Details": { "DocumentName": "AWS-UpdateSSMAgent", "DocumentVersion": "1" } }, ... ], "NextToken": "--token string truncated--" }

Pour répertorier les éléments de conformité pour une instance et un ID d’association spécifiques

Cet exemple répertorie tous les éléments de conformité pour l’instance et l’ID d’association spécifiés.

Commande :

aws ssm list-compliance-items --resource-ids "i-1234567890abcdef0" --resource-types "ManagedInstance" --filters "Key=ComplianceType,Values=Association,Type=EQUAL" "Key=Id,Values=e4c2ed6d-516f-41aa-aa2a-0123456789ab,Type=EQUAL"

Pour répertorier les éléments de conformité d’une instance après une date et heure spécifiques

Cet exemple répertorie tous les éléments de conformité d’une instance après la date et l’heure spécifiées.

Commande :

aws ssm list-compliance-items --resource-ids "i-1234567890abcdef0" --resource-types "ManagedInstance" --filters "Key=ExecutionTime,Values=2019-02-18T16:00:00Z,Type=GREATER_THAN"
  • Pour plus de détails sur l'API, voir ListComplianceItemsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-compliance-items.

AWS CLI

Pour répertorier les éléments de conformité d’une instance spécifique

Cet exemple répertorie tous les éléments de conformité pour l’instance spécifiée.

Commande :

aws ssm list-compliance-items --resource-ids "i-1234567890abcdef0" --resource-types "ManagedInstance"

Sortie :

{ "ComplianceItems": [ { "ComplianceType": "Association", "ResourceType": "ManagedInstance", "ResourceId": "i-1234567890abcdef0", "Id": "8dfe3659-4309-493a-8755-0123456789ab", "Title": "", "Status": "COMPLIANT", "Severity": "UNSPECIFIED", "ExecutionSummary": { "ExecutionTime": 1550408470.0 }, "Details": { "DocumentName": "AWS-GatherSoftwareInventory", "DocumentVersion": "1" } }, { "ComplianceType": "Association", "ResourceType": "ManagedInstance", "ResourceId": "i-1234567890abcdef0", "Id": "e4c2ed6d-516f-41aa-aa2a-0123456789ab", "Title": "", "Status": "COMPLIANT", "Severity": "UNSPECIFIED", "ExecutionSummary": { "ExecutionTime": 1550508475.0 }, "Details": { "DocumentName": "AWS-UpdateSSMAgent", "DocumentVersion": "1" } }, ... ], "NextToken": "--token string truncated--" }

Pour répertorier les éléments de conformité pour une instance et un ID d’association spécifiques

Cet exemple répertorie tous les éléments de conformité pour l’instance et l’ID d’association spécifiés.

Commande :

aws ssm list-compliance-items --resource-ids "i-1234567890abcdef0" --resource-types "ManagedInstance" --filters "Key=ComplianceType,Values=Association,Type=EQUAL" "Key=Id,Values=e4c2ed6d-516f-41aa-aa2a-0123456789ab,Type=EQUAL"

Pour répertorier les éléments de conformité d’une instance après une date et heure spécifiques

Cet exemple répertorie tous les éléments de conformité d’une instance après la date et l’heure spécifiées.

Commande :

aws ssm list-compliance-items --resource-ids "i-1234567890abcdef0" --resource-types "ManagedInstance" --filters "Key=ExecutionTime,Values=2019-02-18T16:00:00Z,Type=GREATER_THAN"
  • Pour plus de détails sur l'API, voir ListComplianceItemsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-compliance-summaries.

AWS CLI

Pour répertorier les récapitulatifs de conformité pour tous les types de conformité

Cet exemple répertorie les récapitulatifs de conformité pour tous les types de conformité de votre compte.

Commande :

aws ssm list-compliance-summaries

Sortie :

{ "ComplianceSummaryItems": [ { "ComplianceType": "Association", "CompliantSummary": { "CompliantCount": 2, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 2 } }, "NonCompliantSummary": { "NonCompliantCount": 0, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 0 } } }, { "ComplianceType": "Patch", "CompliantSummary": { "CompliantCount": 1, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 1 } }, "NonCompliantSummary": { "NonCompliantCount": 1, "SeveritySummary": { "CriticalCount": 1, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 0 } } }, ... ], "NextToken": "eyJOZXh0VG9rZW4iOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==" }

Pour répertorier les récapitulatifs de conformité pour un type de conformité spécifique

Cet exemple répertorie les récapitulatifs de conformité pour le type de conformité du correctif.

Commande :

aws ssm list-compliance-summaries --filters "Key=ComplianceType,Values=Patch,Type=EQUAL"

L'exemple de code suivant montre comment utiliserlist-compliance-summaries.

AWS CLI

Pour répertorier les récapitulatifs de conformité pour tous les types de conformité

Cet exemple répertorie les récapitulatifs de conformité pour tous les types de conformité de votre compte.

Commande :

aws ssm list-compliance-summaries

Sortie :

{ "ComplianceSummaryItems": [ { "ComplianceType": "Association", "CompliantSummary": { "CompliantCount": 2, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 2 } }, "NonCompliantSummary": { "NonCompliantCount": 0, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 0 } } }, { "ComplianceType": "Patch", "CompliantSummary": { "CompliantCount": 1, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 1 } }, "NonCompliantSummary": { "NonCompliantCount": 1, "SeveritySummary": { "CriticalCount": 1, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 0 } } }, ... ], "NextToken": "eyJOZXh0VG9rZW4iOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==" }

Pour répertorier les récapitulatifs de conformité pour un type de conformité spécifique

Cet exemple répertorie les récapitulatifs de conformité pour le type de conformité du correctif.

Commande :

aws ssm list-compliance-summaries --filters "Key=ComplianceType,Values=Patch,Type=EQUAL"

L'exemple de code suivant montre comment utiliserlist-document-metadata-history.

AWS CLI

Exemple : pour consulter l'historique des approbations et le statut d'un modèle de modification

L'list-document-metadata-historyexemple suivant renvoie l'historique des approbations pour le modèle de modification de Change Manager spécifié.

aws ssm list-document-metadata-history \ --name MyChangeManageTemplate \ --metadata DocumentReviews

Sortie :

{ "Name": "MyChangeManagerTemplate", "DocumentVersion": "1", "Author": "arn:aws:iam::111222333444;:user/JohnDoe", "Metadata": { "ReviewerResponse": [ { "CreateTime": "2021-07-30T11:58:28.025000-07:00", "UpdatedTime": "2021-07-30T12:01:19.274000-07:00", "ReviewStatus": "APPROVED", "Comment": [ { "Type": "COMMENT", "Content": "I approve this template version" } ], "Reviewer": "arn:aws:iam::111222333444;:user/ShirleyRodriguez" }, { "CreateTime": "2021-07-30T11:58:28.025000-07:00", "UpdatedTime": "2021-07-30T11:58:28.025000-07:00", "ReviewStatus": "PENDING" } ] } }

Pour plus d'informations, consultez la section Révision et approbation ou rejet des modèles de modification dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserlist-document-metadata-history.

AWS CLI

Exemple : pour consulter l'historique des approbations et le statut d'un modèle de modification

L'list-document-metadata-historyexemple suivant renvoie l'historique des approbations pour le modèle de modification de Change Manager spécifié.

aws ssm list-document-metadata-history \ --name MyChangeManageTemplate \ --metadata DocumentReviews

Sortie :

{ "Name": "MyChangeManagerTemplate", "DocumentVersion": "1", "Author": "arn:aws:iam::111222333444;:user/JohnDoe", "Metadata": { "ReviewerResponse": [ { "CreateTime": "2021-07-30T11:58:28.025000-07:00", "UpdatedTime": "2021-07-30T12:01:19.274000-07:00", "ReviewStatus": "APPROVED", "Comment": [ { "Type": "COMMENT", "Content": "I approve this template version" } ], "Reviewer": "arn:aws:iam::111222333444;:user/ShirleyRodriguez" }, { "CreateTime": "2021-07-30T11:58:28.025000-07:00", "UpdatedTime": "2021-07-30T11:58:28.025000-07:00", "ReviewStatus": "PENDING" } ] } }

Pour plus d'informations, consultez la section Révision et approbation ou rejet des modèles de modification dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserlist-document-versions.

AWS CLI

Pour répertorier les versions d’un document

L’exemple de list-document-versions suivant répertorie toutes les versions d’un document Systems Manager.

aws ssm list-document-versions \ --name "Example"

Sortie :

{ "DocumentVersions": [ { "Name": "Example", "DocumentVersion": "1", "CreatedDate": 1583257938.266, "IsDefaultVersion": true, "DocumentFormat": "YAML", "Status": "Active" } ] }

Pour plus d’informations, consultez Envoi de commandes qui utilisent le paramètre de version de document dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, voir ListDocumentVersionsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-document-versions.

AWS CLI

Pour répertorier les versions d’un document

L’exemple de list-document-versions suivant répertorie toutes les versions d’un document Systems Manager.

aws ssm list-document-versions \ --name "Example"

Sortie :

{ "DocumentVersions": [ { "Name": "Example", "DocumentVersion": "1", "CreatedDate": 1583257938.266, "IsDefaultVersion": true, "DocumentFormat": "YAML", "Status": "Active" } ] }

Pour plus d’informations, consultez Envoi de commandes qui utilisent le paramètre de version de document dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, voir ListDocumentVersionsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-documents.

AWS CLI

Exemple 1 : répertorier les documents

L’exemple de list-documents suivant répertorie les documents appartenant au compte de la demande étiquetés avec la balise personnalisée.

aws ssm list-documents \ --filters Key=Owner,Values=Self Key=tag:DocUse,Values=Testing

Sortie :

{ "DocumentIdentifiers": [ { "Name": "Example", "Owner": "29884EXAMPLE", "PlatformTypes": [ "Windows", "Linux" ], "DocumentVersion": "1", "DocumentType": "Automation", "SchemaVersion": "0.3", "DocumentFormat": "YAML", "Tags": [ { "Key": "DocUse", "Value": "Testing" } ] } ] }

Pour plus d’informations, consultez Documents AWS Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 2 : répertorier les documents partagés

L'list-documentsexemple suivant répertorie les documents partagés, y compris les documents partagés privés qui ne sont pas détenus par AWS.

aws ssm list-documents \ --filters Key=Name,Values=sharedDocNamePrefix Key=Owner,Values=Private

Sortie :

{ "DocumentIdentifiers": [ { "Name": "Example", "Owner": "12345EXAMPLE", "PlatformTypes": [ "Windows", "Linux" ], "DocumentVersion": "1", "DocumentType": "Command", "SchemaVersion": "0.3", "DocumentFormat": "YAML", "Tags": [] } ] }

Pour plus d’informations, consultez Documents AWS Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, voir ListDocumentsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-documents.

AWS CLI

Exemple 1 : répertorier les documents

L’exemple de list-documents suivant répertorie les documents appartenant au compte de la demande étiquetés avec la balise personnalisée.

aws ssm list-documents \ --filters Key=Owner,Values=Self Key=tag:DocUse,Values=Testing

Sortie :

{ "DocumentIdentifiers": [ { "Name": "Example", "Owner": "29884EXAMPLE", "PlatformTypes": [ "Windows", "Linux" ], "DocumentVersion": "1", "DocumentType": "Automation", "SchemaVersion": "0.3", "DocumentFormat": "YAML", "Tags": [ { "Key": "DocUse", "Value": "Testing" } ] } ] }

Pour plus d’informations, consultez Documents AWS Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 2 : répertorier les documents partagés

L'list-documentsexemple suivant répertorie les documents partagés, y compris les documents partagés privés qui ne sont pas détenus par AWS.

aws ssm list-documents \ --filters Key=Name,Values=sharedDocNamePrefix Key=Owner,Values=Private

Sortie :

{ "DocumentIdentifiers": [ { "Name": "Example", "Owner": "12345EXAMPLE", "PlatformTypes": [ "Windows", "Linux" ], "DocumentVersion": "1", "DocumentType": "Command", "SchemaVersion": "0.3", "DocumentFormat": "YAML", "Tags": [] } ] }

Pour plus d’informations, consultez Documents AWS Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, voir ListDocumentsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-inventory-entries.

AWS CLI

Exemple 1 : affichage des entrées d’un type d’inventaire spécifique pour une instance

L'list-inventory-entriesexemple suivant répertorie les entrées d'inventaire pour le type:Application AWS inventory sur une instance spécifique.

aws ssm list-inventory-entries \ --instance-id "i-1234567890abcdef0" \ --type-name "AWS:Application"

Sortie :

{ "TypeName": "AWS:Application", "InstanceId": "i-1234567890abcdef0", "SchemaVersion": "1.1", "CaptureTime": "2019-02-15T12:17:55Z", "Entries": [ { "Architecture": "i386", "Name": "Amazon SSM Agent", "PackageId": "{88a60be2-89a1-4df8-812a-80863c2a2b68}", "Publisher": "Amazon Web Services", "Version": "2.3.274.0" }, { "Architecture": "x86_64", "InstalledTime": "2018-05-03T13:42:34Z", "Name": "AmazonCloudWatchAgent", "Publisher": "", "Version": "1.200442.0" } ] }

Exemple 2 : affichage des entrées d’inventaire personnalisées affectées à une instance

L’exemple de list-inventory-entries suivant répertorie une entrée d’inventaire personnalisée affectée à une instance.

aws ssm list-inventory-entries \ --instance-id "i-1234567890abcdef0" \ --type-name "Custom:RackInfo"

Sortie :

{ "TypeName": "Custom:RackInfo", "InstanceId": "i-1234567890abcdef0", "SchemaVersion": "1.0", "CaptureTime": "2021-05-22T10:01:01Z", "Entries": [ { "RackLocation": "Bay B/Row C/Rack D/Shelf E" } ] }
  • Pour plus de détails sur l'API, voir ListInventoryEntriesla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-inventory-entries.

AWS CLI

Exemple 1 : affichage des entrées d’un type d’inventaire spécifique pour une instance

L'list-inventory-entriesexemple suivant répertorie les entrées d'inventaire pour le type:Application AWS inventory sur une instance spécifique.

aws ssm list-inventory-entries \ --instance-id "i-1234567890abcdef0" \ --type-name "AWS:Application"

Sortie :

{ "TypeName": "AWS:Application", "InstanceId": "i-1234567890abcdef0", "SchemaVersion": "1.1", "CaptureTime": "2019-02-15T12:17:55Z", "Entries": [ { "Architecture": "i386", "Name": "Amazon SSM Agent", "PackageId": "{88a60be2-89a1-4df8-812a-80863c2a2b68}", "Publisher": "Amazon Web Services", "Version": "2.3.274.0" }, { "Architecture": "x86_64", "InstalledTime": "2018-05-03T13:42:34Z", "Name": "AmazonCloudWatchAgent", "Publisher": "", "Version": "1.200442.0" } ] }

Exemple 2 : affichage des entrées d’inventaire personnalisées affectées à une instance

L’exemple de list-inventory-entries suivant répertorie une entrée d’inventaire personnalisée affectée à une instance.

aws ssm list-inventory-entries \ --instance-id "i-1234567890abcdef0" \ --type-name "Custom:RackInfo"

Sortie :

{ "TypeName": "Custom:RackInfo", "InstanceId": "i-1234567890abcdef0", "SchemaVersion": "1.0", "CaptureTime": "2021-05-22T10:01:01Z", "Entries": [ { "RackLocation": "Bay B/Row C/Rack D/Shelf E" } ] }
  • Pour plus de détails sur l'API, voir ListInventoryEntriesla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-ops-item-related-items.

AWS CLI

Pour répertorier les ressources connexes d'un OpsItem

L'list-ops-item-related-itemsexemple suivant répertorie les ressources liées aux éléments connexes d'un. OpsItem

aws ssm list-ops-item-related-items \ --ops-item-id "oi-f99f2EXAMPLE"

Sortie :

{ "Summaries": [ { "OpsItemId": "oi-f99f2EXAMPLE", "AssociationId": "e2036148-cccb-490e-ac2a-390e5EXAMPLE", "ResourceType": "AWS::SSMIncidents::IncidentRecord", "AssociationType": "IsParentOf", "ResourceUri": "arn:aws:ssm-incidents::111122223333:incident-record/example-response/64bd9b45-1d0e-2622-840d-03a87a1451fa", "CreatedBy": { "Arn": "arn:aws:sts::111122223333:assumed-role/AWSServiceRoleForIncidentManager/IncidentResponse" }, "CreatedTime": "2021-08-11T18:47:14.994000+00:00", "LastModifiedBy": { "Arn": "arn:aws:sts::111122223333:assumed-role/AWSServiceRoleForIncidentManager/IncidentResponse" }, "LastModifiedTime": "2021-08-11T18:47:14.994000+00:00" } ] }

Pour plus d'informations, consultez la section Working with Incident Manager incidents OpsCenter dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserlist-ops-item-related-items.

AWS CLI

Pour répertorier les ressources connexes d'un OpsItem

L'list-ops-item-related-itemsexemple suivant répertorie les ressources liées aux éléments connexes d'un. OpsItem

aws ssm list-ops-item-related-items \ --ops-item-id "oi-f99f2EXAMPLE"

Sortie :

{ "Summaries": [ { "OpsItemId": "oi-f99f2EXAMPLE", "AssociationId": "e2036148-cccb-490e-ac2a-390e5EXAMPLE", "ResourceType": "AWS::SSMIncidents::IncidentRecord", "AssociationType": "IsParentOf", "ResourceUri": "arn:aws:ssm-incidents::111122223333:incident-record/example-response/64bd9b45-1d0e-2622-840d-03a87a1451fa", "CreatedBy": { "Arn": "arn:aws:sts::111122223333:assumed-role/AWSServiceRoleForIncidentManager/IncidentResponse" }, "CreatedTime": "2021-08-11T18:47:14.994000+00:00", "LastModifiedBy": { "Arn": "arn:aws:sts::111122223333:assumed-role/AWSServiceRoleForIncidentManager/IncidentResponse" }, "LastModifiedTime": "2021-08-11T18:47:14.994000+00:00" } ] }

Pour plus d'informations, consultez la section Working with Incident Manager incidents OpsCenter dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserlist-resource-compliance-summaries.

AWS CLI

Pour répertorier les récapitulatifs de conformité du niveau des ressources

Cet exemple répertorie les récapitulatifs de conformité du niveau des ressources.

Commande :

aws ssm list-resource-compliance-summaries

Sortie :

{ "ResourceComplianceSummaryItems": [ { "ComplianceType": "Association", "ResourceType": "ManagedInstance", "ResourceId": "i-1234567890abcdef0", "Status": "COMPLIANT", "OverallSeverity": "UNSPECIFIED", "ExecutionSummary": { "ExecutionTime": 1550509273.0 }, "CompliantSummary": { "CompliantCount": 2, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 2 } }, "NonCompliantSummary": { "NonCompliantCount": 0, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 0 } } }, { "ComplianceType": "Patch", "ResourceType": "ManagedInstance", "ResourceId": "i-9876543210abcdef0", "Status": "COMPLIANT", "OverallSeverity": "UNSPECIFIED", "ExecutionSummary": { "ExecutionTime": 1550248550.0, "ExecutionId": "7abb6378-a4a5-4f10-8312-0123456789ab", "ExecutionType": "Command" }, "CompliantSummary": { "CompliantCount": 397, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 397 } }, "NonCompliantSummary": { "NonCompliantCount": 0, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 0 } } } ], "NextToken": "--token string truncated--" }

Pour répertorier les récapitulatifs de conformité du niveau des ressources pour un type de conformité spécifique

Cet exemple répertorie les récapitulatifs de conformité du niveau des ressources pour le type de conformité du correctif.

Commande :

aws ssm list-resource-compliance-summaries --filters "Key=ComplianceType,Values=Patch,Type=EQUAL"

L'exemple de code suivant montre comment utiliserlist-resource-compliance-summaries.

AWS CLI

Pour répertorier les récapitulatifs de conformité du niveau des ressources

Cet exemple répertorie les récapitulatifs de conformité du niveau des ressources.

Commande :

aws ssm list-resource-compliance-summaries

Sortie :

{ "ResourceComplianceSummaryItems": [ { "ComplianceType": "Association", "ResourceType": "ManagedInstance", "ResourceId": "i-1234567890abcdef0", "Status": "COMPLIANT", "OverallSeverity": "UNSPECIFIED", "ExecutionSummary": { "ExecutionTime": 1550509273.0 }, "CompliantSummary": { "CompliantCount": 2, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 2 } }, "NonCompliantSummary": { "NonCompliantCount": 0, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 0 } } }, { "ComplianceType": "Patch", "ResourceType": "ManagedInstance", "ResourceId": "i-9876543210abcdef0", "Status": "COMPLIANT", "OverallSeverity": "UNSPECIFIED", "ExecutionSummary": { "ExecutionTime": 1550248550.0, "ExecutionId": "7abb6378-a4a5-4f10-8312-0123456789ab", "ExecutionType": "Command" }, "CompliantSummary": { "CompliantCount": 397, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 397 } }, "NonCompliantSummary": { "NonCompliantCount": 0, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 0 } } } ], "NextToken": "--token string truncated--" }

Pour répertorier les récapitulatifs de conformité du niveau des ressources pour un type de conformité spécifique

Cet exemple répertorie les récapitulatifs de conformité du niveau des ressources pour le type de conformité du correctif.

Commande :

aws ssm list-resource-compliance-summaries --filters "Key=ComplianceType,Values=Patch,Type=EQUAL"

L'exemple de code suivant montre comment utiliserlist-resource-data-sync.

AWS CLI

Pour répertorier les configurations de synchronisation des données de vos ressources

Cet exemple permet de récupérer des informations sur les configurations de synchronisation des données de vos ressources.

aws ssm list-resource-data-sync

Sortie :

{ "ResourceDataSyncItems": [ { "SyncName": "MyResourceDataSync", "S3Destination": { "BucketName": "ssm-resource-data-sync", "SyncFormat": "JsonSerDe", "Region": "us-east-1" }, "LastSyncTime": 1550261472.003, "LastSuccessfulSyncTime": 1550261472.003, "LastStatus": "Successful", "SyncCreatedTime": 1543235736.72, "LastSyncStatusMessage": "The sync was successfully completed" } ] }
  • Pour plus de détails sur l'API, voir ListResourceDataSyncla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-resource-data-sync.

AWS CLI

Pour répertorier les configurations de synchronisation des données de vos ressources

Cet exemple permet de récupérer des informations sur les configurations de synchronisation des données de vos ressources.

aws ssm list-resource-data-sync

Sortie :

{ "ResourceDataSyncItems": [ { "SyncName": "MyResourceDataSync", "S3Destination": { "BucketName": "ssm-resource-data-sync", "SyncFormat": "JsonSerDe", "Region": "us-east-1" }, "LastSyncTime": 1550261472.003, "LastSuccessfulSyncTime": 1550261472.003, "LastStatus": "Successful", "SyncCreatedTime": 1543235736.72, "LastSyncStatusMessage": "The sync was successfully completed" } ] }
  • Pour plus de détails sur l'API, voir ListResourceDataSyncla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-tags-for-resource.

AWS CLI

Pour répertorier les balises appliquées à un référentiel de correctifs

L’exemple de list-tags-for-resource suivant répertorie les balises appliquées à un référentiel de correctifs.

aws ssm list-tags-for-resource \ --resource-type "PatchBaseline" \ --resource-id "pb-0123456789abcdef0"

Sortie :

{ "TagList": [ { "Key": "Environment", "Value": "Production" }, { "Key": "Region", "Value": "EMEA" } ] }

Pour plus d'informations, consultez la section AWS Ressources de balisage dans le manuel de référence AWS général.

  • Pour plus de détails sur l'API, voir ListTagsForResourcela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-tags-for-resource.

AWS CLI

Pour répertorier les balises appliquées à un référentiel de correctifs

L’exemple de list-tags-for-resource suivant répertorie les balises appliquées à un référentiel de correctifs.

aws ssm list-tags-for-resource \ --resource-type "PatchBaseline" \ --resource-id "pb-0123456789abcdef0"

Sortie :

{ "TagList": [ { "Key": "Environment", "Value": "Production" }, { "Key": "Region", "Value": "EMEA" } ] }

Pour plus d'informations, consultez la section AWS Ressources de balisage dans le manuel de référence AWS général.

  • Pour plus de détails sur l'API, voir ListTagsForResourcela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisermodify-document-permission.

AWS CLI

Pour modifier les autorisations sur les documents

L’exemple de modify-document-permission suivant partage publiquement un document Systems Manager.

aws ssm modify-document-permission \ --name "Example" \ --permission-type "Share" \ --account-ids-to-add "All"

Cette commande ne produit aucun résultat.

Pour plus d’informations, consultez Partager un document Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utilisermodify-document-permission.

AWS CLI

Pour modifier les autorisations sur les documents

L’exemple de modify-document-permission suivant partage publiquement un document Systems Manager.

aws ssm modify-document-permission \ --name "Example" \ --permission-type "Share" \ --account-ids-to-add "All"

Cette commande ne produit aucun résultat.

Pour plus d’informations, consultez Partager un document Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserput-compliance-items.

AWS CLI

Pour enregistrer un type de conformité et des détails de conformité dans une instance désignée

Cet exemple enregistre le type de conformité Custom:AVCheck dans l’instance gérée spécifiée. Il n’y a pas de sortie si la commande réussit.

Commande :

aws ssm put-compliance-items --resource-id "i-1234567890abcdef0" --resource-type "ManagedInstance" --compliance-type "Custom:AVCheck" --execution-summary "ExecutionTime=2019-02-18T16:00:00Z" --items "Id=Version2.0,Title=ScanHost,Severity=CRITICAL,Status=COMPLIANT"
  • Pour plus de détails sur l'API, voir PutComplianceItemsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserput-compliance-items.

AWS CLI

Pour enregistrer un type de conformité et des détails de conformité dans une instance désignée

Cet exemple enregistre le type de conformité Custom:AVCheck dans l’instance gérée spécifiée. Il n’y a pas de sortie si la commande réussit.

Commande :

aws ssm put-compliance-items --resource-id "i-1234567890abcdef0" --resource-type "ManagedInstance" --compliance-type "Custom:AVCheck" --execution-summary "ExecutionTime=2019-02-18T16:00:00Z" --items "Id=Version2.0,Title=ScanHost,Severity=CRITICAL,Status=COMPLIANT"
  • Pour plus de détails sur l'API, voir PutComplianceItemsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserput-inventory.

AWS CLI

Pour attribuer des métadonnées client à une instance

Cet exemple attribue les informations sur les emplacements des racks à une instance. Il n’y a pas de sortie si la commande réussit.

Commande (Linux) :

aws ssm put-inventory --instance-id "i-016648b75dd622dab" --items '[{"TypeName": "Custom:RackInfo","SchemaVersion": "1.0","CaptureTime": "2019-01-22T10:01:01Z","Content":[{"RackLocation": "Bay B/Row C/Rack D/Shelf E"}]}]'

Commande (Windows) :

aws ssm put-inventory --instance-id "i-016648b75dd622dab" --items "TypeName=Custom:RackInfo,SchemaVersion=1.0,CaptureTime=2019-01-22T10:01:01Z,Content=[{RackLocation='Bay B/Row C/Rack D/Shelf F'}]"
  • Pour plus de détails sur l'API, voir PutInventoryla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserput-inventory.

AWS CLI

Pour attribuer des métadonnées client à une instance

Cet exemple attribue les informations sur les emplacements des racks à une instance. Il n’y a pas de sortie si la commande réussit.

Commande (Linux) :

aws ssm put-inventory --instance-id "i-016648b75dd622dab" --items '[{"TypeName": "Custom:RackInfo","SchemaVersion": "1.0","CaptureTime": "2019-01-22T10:01:01Z","Content":[{"RackLocation": "Bay B/Row C/Rack D/Shelf E"}]}]'

Commande (Windows) :

aws ssm put-inventory --instance-id "i-016648b75dd622dab" --items "TypeName=Custom:RackInfo,SchemaVersion=1.0,CaptureTime=2019-01-22T10:01:01Z,Content=[{RackLocation='Bay B/Row C/Rack D/Shelf F'}]"
  • Pour plus de détails sur l'API, voir PutInventoryla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserput-parameter.

AWS CLI

Exemple 1 : modification de la valeur d’un paramètre

L’exemple de put-parameter suivant modifie la valeur du paramètre spécifié.

aws ssm put-parameter \ --name "MyStringParameter" \ --type "String" \ --value "Vici" \ --overwrite

Sortie :

{ "Version": 2, "Tier": "Standard" }

Pour plus d'informations, consultez Create a Systems Manager parameter (AWS CLI), « Managing parameter tiers < https://docs.aws.amazon.com/systems-manager/ latest/userguide/parameter - store-advanced-parameters .html>`__ » et Working with parameter policies dans le guide de l'utilisateur de Systems Manager AWS .

Exemple 2 : création d’un paramètre avancé

L’exemple de put-parameter suivant crée un paramètre avancé.

aws ssm put-parameter \ --name "MyAdvancedParameter" \ --description "This is an advanced parameter" \ --value "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat [truncated]" \ --type "String" \ --tier Advanced

Sortie :

{ "Version": 1, "Tier": "Advanced" }

Pour plus d'informations, consultez Create a Systems Manager parameter (AWS CLI), « Managing parameter tiers < https://docs.aws.amazon.com/systems-manager/ latest/userguide/parameter - store-advanced-parameters .html>`__ » et Working with parameter policies dans le guide de l'utilisateur de Systems Manager AWS .

Exemple 3 : conversion d’un paramètre standard en paramètre avancé

L’exemple de put-parameter suivant convertit un paramètre standard existant en un paramètre avancé.

aws ssm put-parameter \ --name "MyConvertedParameter" \ --value "abc123" \ --type "String" \ --tier Advanced \ --overwrite

Sortie :

{ "Version": 2, "Tier": "Advanced" }

Pour plus d'informations, consultez Create a Systems Manager parameter (AWS CLI), « Managing parameter tiers < https://docs.aws.amazon.com/systems-manager/ latest/userguide/parameter - store-advanced-parameters .html>`__ » et Working with parameter policies dans le guide de l'utilisateur de Systems Manager AWS .

Exemple 4 : création d’un paramètre avec une politique attachée

L’exemple de put-parameter suivant crée un paramètre avancé auquel est attachée une politique de paramètre.

aws ssm put-parameter \ --name "/Finance/Payroll/q2accesskey" \ --value "P@sSwW)rd" \ --type "SecureString" \ --tier Advanced \ --policies "[{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2020-06-30T00:00:00.000Z\"}},{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"5\",\"Unit\":\"Days\"}},{\"Type\":\"NoChangeNotification\",\"Version\":\"1.0\",\"Attributes\":{\"After\":\"60\",\"Unit\":\"Days\"}}]"

Sortie :

{ "Version": 1, "Tier": "Advanced" }

Pour plus d'informations, consultez Create a Systems Manager parameter (AWS CLI), « Managing parameter tiers < https://docs.aws.amazon.com/systems-manager/ latest/userguide/parameter - store-advanced-parameters .html>`__ » et Working with parameter policies dans le guide de l'utilisateur de Systems Manager AWS .

Exemple 5 : ajout d’une politique à un paramètre existant

L’exemple de put-parameter suivant attache une politique à un paramètre avancé existant.

aws ssm put-parameter \ --name "/Finance/Payroll/q2accesskey" \ --value "N3wP@sSwW)rd" \ --type "SecureString" \ --tier Advanced \ --policies "[{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2020-06-30T00:00:00.000Z\"}},{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"5\",\"Unit\":\"Days\"}},{\"Type\":\"NoChangeNotification\",\"Version\":\"1.0\",\"Attributes\":{\"After\":\"60\",\"Unit\":\"Days\"}}]" --overwrite

Sortie :

{ "Version": 2, "Tier": "Advanced" }

Pour plus d'informations, consultez Create a Systems Manager parameter (AWS CLI), « Managing parameter tiers < https://docs.aws.amazon.com/systems-manager/ latest/userguide/parameter - store-advanced-parameters .html>`__ » et Working with parameter policies dans le guide de l'utilisateur de Systems Manager AWS .

  • Pour plus de détails sur l'API, voir PutParameterla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserput-parameter.

AWS CLI

Exemple 1 : modification de la valeur d’un paramètre

L’exemple de put-parameter suivant modifie la valeur du paramètre spécifié.

aws ssm put-parameter \ --name "MyStringParameter" \ --type "String" \ --value "Vici" \ --overwrite

Sortie :

{ "Version": 2, "Tier": "Standard" }

Pour plus d'informations, consultez Create a Systems Manager parameter (AWS CLI), « Managing parameter tiers < https://docs.aws.amazon.com/systems-manager/ latest/userguide/parameter - store-advanced-parameters .html>`__ » et Working with parameter policies dans le guide de l'utilisateur de Systems Manager AWS .

Exemple 2 : création d’un paramètre avancé

L’exemple de put-parameter suivant crée un paramètre avancé.

aws ssm put-parameter \ --name "MyAdvancedParameter" \ --description "This is an advanced parameter" \ --value "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat [truncated]" \ --type "String" \ --tier Advanced

Sortie :

{ "Version": 1, "Tier": "Advanced" }

Pour plus d'informations, consultez Create a Systems Manager parameter (AWS CLI), « Managing parameter tiers < https://docs.aws.amazon.com/systems-manager/ latest/userguide/parameter - store-advanced-parameters .html>`__ » et Working with parameter policies dans le guide de l'utilisateur de Systems Manager AWS .

Exemple 3 : conversion d’un paramètre standard en paramètre avancé

L’exemple de put-parameter suivant convertit un paramètre standard existant en un paramètre avancé.

aws ssm put-parameter \ --name "MyConvertedParameter" \ --value "abc123" \ --type "String" \ --tier Advanced \ --overwrite

Sortie :

{ "Version": 2, "Tier": "Advanced" }

Pour plus d'informations, consultez Create a Systems Manager parameter (AWS CLI), « Managing parameter tiers < https://docs.aws.amazon.com/systems-manager/ latest/userguide/parameter - store-advanced-parameters .html>`__ » et Working with parameter policies dans le guide de l'utilisateur de Systems Manager AWS .

Exemple 4 : création d’un paramètre avec une politique attachée

L’exemple de put-parameter suivant crée un paramètre avancé auquel est attachée une politique de paramètre.

aws ssm put-parameter \ --name "/Finance/Payroll/q2accesskey" \ --value "P@sSwW)rd" \ --type "SecureString" \ --tier Advanced \ --policies "[{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2020-06-30T00:00:00.000Z\"}},{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"5\",\"Unit\":\"Days\"}},{\"Type\":\"NoChangeNotification\",\"Version\":\"1.0\",\"Attributes\":{\"After\":\"60\",\"Unit\":\"Days\"}}]"

Sortie :

{ "Version": 1, "Tier": "Advanced" }

Pour plus d'informations, consultez Create a Systems Manager parameter (AWS CLI), « Managing parameter tiers < https://docs.aws.amazon.com/systems-manager/ latest/userguide/parameter - store-advanced-parameters .html>`__ » et Working with parameter policies dans le guide de l'utilisateur de Systems Manager AWS .

Exemple 5 : ajout d’une politique à un paramètre existant

L’exemple de put-parameter suivant attache une politique à un paramètre avancé existant.

aws ssm put-parameter \ --name "/Finance/Payroll/q2accesskey" \ --value "N3wP@sSwW)rd" \ --type "SecureString" \ --tier Advanced \ --policies "[{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2020-06-30T00:00:00.000Z\"}},{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"5\",\"Unit\":\"Days\"}},{\"Type\":\"NoChangeNotification\",\"Version\":\"1.0\",\"Attributes\":{\"After\":\"60\",\"Unit\":\"Days\"}}]" --overwrite

Sortie :

{ "Version": 2, "Tier": "Advanced" }

Pour plus d'informations, consultez Create a Systems Manager parameter (AWS CLI), « Managing parameter tiers < https://docs.aws.amazon.com/systems-manager/ latest/userguide/parameter - store-advanced-parameters .html>`__ » et Working with parameter policies dans le guide de l'utilisateur de Systems Manager AWS .

  • Pour plus de détails sur l'API, voir PutParameterla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserregister-default-patch-baseline.

AWS CLI

Pour définir le référentiel de correctifs par défaut

L’exemple de register-default-patch-baseline suivant enregistre le référentiel de correctifs personnalisé spécifié en tant que référentiel de correctifs par défaut pour le type de système d’exploitation qu’il prend en charge.

aws ssm register-default-patch-baseline \ --baseline-id "pb-abc123cf9bEXAMPLE"

Sortie :

{ "BaselineId":"pb-abc123cf9bEXAMPLE" }

L'register-default-patch-baselineexemple suivant enregistre la ligne de base de correctifs par défaut fournie par AWS CentOS comme ligne de base de correctifs par défaut.

aws ssm register-default-patch-baseline \ --baseline-id "arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed"

Sortie :

{ "BaselineId":"pb-abc123cf9bEXAMPLE" }

Pour plus d’informations, consultez À propos des référentiels de correctifs prédéfinis et personnalisés dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserregister-default-patch-baseline.

AWS CLI

Pour définir le référentiel de correctifs par défaut

L’exemple de register-default-patch-baseline suivant enregistre le référentiel de correctifs personnalisé spécifié en tant que référentiel de correctifs par défaut pour le type de système d’exploitation qu’il prend en charge.

aws ssm register-default-patch-baseline \ --baseline-id "pb-abc123cf9bEXAMPLE"

Sortie :

{ "BaselineId":"pb-abc123cf9bEXAMPLE" }

L'register-default-patch-baselineexemple suivant enregistre la ligne de base de correctifs par défaut fournie par AWS CentOS comme ligne de base de correctifs par défaut.

aws ssm register-default-patch-baseline \ --baseline-id "arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed"

Sortie :

{ "BaselineId":"pb-abc123cf9bEXAMPLE" }

Pour plus d’informations, consultez À propos des référentiels de correctifs prédéfinis et personnalisés dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserregister-patch-baseline-for-patch-group.

AWS CLI

Pour enregistrer un référentiel de correctifs pour un groupe de correctifs

L’exemple de register-patch-baseline-for-patch-group suivant permet d’enregistrer un référentiel de correctifs pour un groupe de correctifs.

aws ssm register-patch-baseline-for-patch-group \ --baseline-id "pb-045f10b4f382baeda" \ --patch-group "Production"

Sortie :

{ "BaselineId": "pb-045f10b4f382baeda", "PatchGroup": "Production" }

Pour plus d'informations, consultez les sections Créer un groupe de correctifs < https://docs.aws.amazon.com/systems-manager/ latest/userguide/sysman - patch-group-tagging .html>__ et Ajouter un groupe de correctifs à une ligne de base de correctifs dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserregister-patch-baseline-for-patch-group.

AWS CLI

Pour enregistrer un référentiel de correctifs pour un groupe de correctifs

L’exemple de register-patch-baseline-for-patch-group suivant permet d’enregistrer un référentiel de correctifs pour un groupe de correctifs.

aws ssm register-patch-baseline-for-patch-group \ --baseline-id "pb-045f10b4f382baeda" \ --patch-group "Production"

Sortie :

{ "BaselineId": "pb-045f10b4f382baeda", "PatchGroup": "Production" }

Pour plus d'informations, consultez les sections Créer un groupe de correctifs < https://docs.aws.amazon.com/systems-manager/ latest/userguide/sysman - patch-group-tagging .html>__ et Ajouter un groupe de correctifs à une ligne de base de correctifs dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserregister-target-with-maintenance-window.

AWS CLI

Exemple 1 : enregistrement d’une cible unique avec une fenêtre de maintenance

L’exemple de register-target-with-maintenance-window suivant enregistre une instance avec une fenêtre de maintenance.

aws ssm register-target-with-maintenance-window \ --window-id "mw-ab12cd34ef56gh78" \ --target "Key=InstanceIds,Values=i-0000293ffd8c57862" \ --owner-information "Single instance" \ --resource-type "INSTANCE"

Sortie :

{ "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" }

Exemple 2 : pour enregistrer plusieurs cibles avec une fenêtre de maintenance à l'aide d'une instance IDs

L'register-target-with-maintenance-windowexemple suivant enregistre deux instances avec une fenêtre de maintenance en spécifiant leur instance IDs.

aws ssm register-target-with-maintenance-window \ --window-id "mw-ab12cd34ef56gh78" \ --target "Key=InstanceIds,Values=i-0000293ffd8c57862,i-0cb2b964d3e14fd9f" \ --owner-information "Two instances in a list" \ --resource-type "INSTANCE"

Sortie :

{ "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" }

Exemple 3 : enregistrement de cibles avec une fenêtre de maintenance à l’aide des balises de ressources

L’exemple de register-target-with-maintenance-window suivant enregistre des instances avec une fenêtre de maintenance en spécifiant les balises de ressources qui ont été appliquées aux instances.

aws ssm register-target-with-maintenance-window \ --window-id "mw-06cf17cbefcb4bf4f" \ --targets "Key=tag:Environment,Values=Prod" "Key=Role,Values=Web" \ --owner-information "Production Web Servers" \ --resource-type "INSTANCE"

Sortie :

{ "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" }

Exemple 4 : enregistrement de cibles à l’aide d’un groupe de clés de balises

L’exemple de register-target-with-maintenance-window suivant enregistre des instances auxquelles une ou plusieurs clés de balises ont été attribuées, quelle que soit la valeur de leur clé.

aws ssm register-target-with-maintenance-window \ --window-id "mw-0c50858d01EXAMPLE" \ --resource-type "INSTANCE" \ --target "Key=tag-key,Values=Name,Instance-Type,CostCenter"

Sortie :

{ "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" }

Exemple 5 : pour enregistrer des cibles à l’aide d’un nom de groupe de ressources

L’exemple de register-target-with-maintenance-window suivant permet d’enregistrer un groupe de ressources spécifié, quel que soit le type de ressources qu’il contient.

aws ssm register-target-with-maintenance-window \ --window-id "mw-0c50858d01EXAMPLE" \ --resource-type "RESOURCE_GROUP" \ --target "Key=resource-groups:Name,Values=MyResourceGroup"

Sortie :

{ "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" }

Pour plus d'informations, consultez la section Enregistrer une instance cible avec la fenêtre de maintenance (AWS CLI) dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserregister-target-with-maintenance-window.

AWS CLI

Exemple 1 : enregistrement d’une cible unique avec une fenêtre de maintenance

L’exemple de register-target-with-maintenance-window suivant enregistre une instance avec une fenêtre de maintenance.

aws ssm register-target-with-maintenance-window \ --window-id "mw-ab12cd34ef56gh78" \ --target "Key=InstanceIds,Values=i-0000293ffd8c57862" \ --owner-information "Single instance" \ --resource-type "INSTANCE"

Sortie :

{ "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" }

Exemple 2 : pour enregistrer plusieurs cibles avec une fenêtre de maintenance à l'aide d'une instance IDs

L'register-target-with-maintenance-windowexemple suivant enregistre deux instances avec une fenêtre de maintenance en spécifiant leur instance IDs.

aws ssm register-target-with-maintenance-window \ --window-id "mw-ab12cd34ef56gh78" \ --target "Key=InstanceIds,Values=i-0000293ffd8c57862,i-0cb2b964d3e14fd9f" \ --owner-information "Two instances in a list" \ --resource-type "INSTANCE"

Sortie :

{ "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" }

Exemple 3 : enregistrement de cibles avec une fenêtre de maintenance à l’aide des balises de ressources

L’exemple de register-target-with-maintenance-window suivant enregistre des instances avec une fenêtre de maintenance en spécifiant les balises de ressources qui ont été appliquées aux instances.

aws ssm register-target-with-maintenance-window \ --window-id "mw-06cf17cbefcb4bf4f" \ --targets "Key=tag:Environment,Values=Prod" "Key=Role,Values=Web" \ --owner-information "Production Web Servers" \ --resource-type "INSTANCE"

Sortie :

{ "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" }

Exemple 4 : enregistrement de cibles à l’aide d’un groupe de clés de balises

L’exemple de register-target-with-maintenance-window suivant enregistre des instances auxquelles une ou plusieurs clés de balises ont été attribuées, quelle que soit la valeur de leur clé.

aws ssm register-target-with-maintenance-window \ --window-id "mw-0c50858d01EXAMPLE" \ --resource-type "INSTANCE" \ --target "Key=tag-key,Values=Name,Instance-Type,CostCenter"

Sortie :

{ "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" }

Exemple 5 : pour enregistrer des cibles à l’aide d’un nom de groupe de ressources

L’exemple de register-target-with-maintenance-window suivant permet d’enregistrer un groupe de ressources spécifié, quel que soit le type de ressources qu’il contient.

aws ssm register-target-with-maintenance-window \ --window-id "mw-0c50858d01EXAMPLE" \ --resource-type "RESOURCE_GROUP" \ --target "Key=resource-groups:Name,Values=MyResourceGroup"

Sortie :

{ "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" }

Pour plus d'informations, consultez la section Enregistrer une instance cible avec la fenêtre de maintenance (AWS CLI) dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserregister-task-with-maintenance-window.

AWS CLI

Exemple 1 : enregistrement d’une tâche d’automatisation avec une fenêtre de maintenance

L’exemple de register-task-with-maintenance-window suivant enregistre une tâche d’automatisation avec une fenêtre de maintenance qui est ciblée sur une instance.

aws ssm register-task-with-maintenance-window \ --window-id "mw-082dcd7649EXAMPLE" \ --targets Key=InstanceIds,Values=i-1234520122EXAMPLE \ --task-arn AWS-RestartEC2Instance \ --service-role-arn arn:aws:iam::111222333444:role/SSM --task-type AUTOMATION \ --task-invocation-parameters "{\"Automation\":{\"DocumentVersion\":\"\$LATEST\",\"Parameters\":{\"InstanceId\":[\"{{RESOURCE_ID}}\"]}}}" \ --priority 0 \ --max-concurrency 1 \ --max-errors 1 \ --name "AutomationExample" \ --description "Restarting EC2 Instance for maintenance"

Sortie :

{ "WindowTaskId":"11144444-5555-6666-7777-88888888" }

Pour plus d'informations, consultez la section Enregistrer une tâche avec la fenêtre de maintenance (AWS CLI) dans le guide de l'utilisateur de AWS Systems Manager.

Exemple 2 : enregistrement d’une tâche Lambda avec une fenêtre de maintenance

L’exemple de register-task-with-maintenance-window suivant enregistre une tâche Lambda avec une fenêtre de maintenance ciblée sur une instance.

aws ssm register-task-with-maintenance-window \ --window-id "mw-082dcd7649dee04e4" \ --targets Key=InstanceIds,Values=i-12344d305eEXAMPLE \ --task-arn arn:aws:lambda:us-east-1:111222333444:function:SSMTestLAMBDA \ --service-role-arn arn:aws:iam::111222333444:role/SSM \ --task-type LAMBDA \ --task-invocation-parameters '{"Lambda":{"Payload":"{\"InstanceId\":\"{{RESOURCE_ID}}\",\"targetType\":\"{{TARGET_TYPE}}\"}","Qualifier":"$LATEST"}}' \ --priority 0 \ --max-concurrency 10 \ --max-errors 5 \ --name "Lambda_Example" \ --description "My Lambda Example"

Sortie :

{ "WindowTaskId":"22244444-5555-6666-7777-88888888" }

Pour plus d'informations, consultez la section Enregistrer une tâche avec la fenêtre de maintenance (AWS CLI) dans le guide de l'utilisateur de AWS Systems Manager.

Exemple 3 : enregistrement d’une tâche Run Command avec une fenêtre de maintenance

L’exemple de register-task-with-maintenance-window suivant enregistre une tâche Run Command avec une fenêtre de maintenance ciblée sur une instance.

aws ssm register-task-with-maintenance-window \ --window-id "mw-082dcd7649dee04e4" \ --targets "Key=InstanceIds,Values=i-12344d305eEXAMPLE" \ --service-role-arn "arn:aws:iam::111222333444:role/SSM" \ --task-type "RUN_COMMAND" \ --name "SSMInstallPowerShellModule" \ --task-arn "AWS-InstallPowerShellModule" \ --task-invocation-parameters "{\"RunCommand\":{\"Comment\":\"\",\"OutputS3BucketName\":\"runcommandlogs\",\"Parameters\":{\"commands\":[\"Get-Module -ListAvailable\"],\"executionTimeout\":[\"3600\"],\"source\":[\"https:\/\/gallery.technet.microsoft.com\/EZOut-33ae0fb7\/file\/110351\/1\/EZOut.zip\"],\"workingDirectory\":[\"\\\\\"]},\"TimeoutSeconds\":600}}" \ --max-concurrency 1 \ --max-errors 1 \ --priority 10

Sortie :

{ "WindowTaskId":"33344444-5555-6666-7777-88888888" }

Pour plus d'informations, consultez la section Enregistrer une tâche avec la fenêtre de maintenance (AWS CLI) dans le guide de l'utilisateur de AWS Systems Manager.

Exemple 4 : enregistrement d’une tâche Step Functions avec une fenêtre de maintenance

L’exemple de register-task-with-maintenance-window suivant enregistre une tâche Step Functions avec une fenêtre de maintenance ciblée sur une instance.

aws ssm register-task-with-maintenance-window \ --window-id "mw-1234d787d6EXAMPLE" \ --targets Key=WindowTargetIds,Values=12347414-69c3-49f8-95b8-ed2dcEXAMPLE \ --task-arn arn:aws:states:us-east-1:111222333444:stateMachine:SSMTestStateMachine \ --service-role-arn arn:aws:iam::111222333444:role/MaintenanceWindows \ --task-type STEP_FUNCTIONS \ --task-invocation-parameters '{"StepFunctions":{"Input":"{\"InstanceId\":\"{{RESOURCE_ID}}\"}"}}' \ --priority 0 \ --max-concurrency 10 \ --max-errors 5 \ --name "Step_Functions_Example" \ --description "My Step Functions Example"

Sortie :

{ "WindowTaskId":"44444444-5555-6666-7777-88888888" }

Pour plus d'informations, consultez la section Enregistrer une tâche avec la fenêtre de maintenance (AWS CLI) dans le guide de l'utilisateur de AWS Systems Manager.

Exemple 5 : enregistrement d’une tâche à l’aide de l’ID cible d’une fenêtre de maintenance

L’exemple de register-task-with-maintenance-window suivant enregistre une tâche à l’aide de l’ID cible d’une fenêtre de maintenance. L’ID cible de la fenêtre de maintenance se trouvait dans la sortie de la commande aws ssm register-target-with-maintenance-window. Vous pouvez également le récupérer à partir de la sortie de la commande aws ssm describe-maintenance-window-targets.

aws ssm register-task-with-maintenance-window \ --targets "Key=WindowTargetIds,Values=350d44e6-28cc-44e2-951f-4b2c9EXAMPLE" \ --task-arn "AWS-RunShellScript" \ --service-role-arn "arn:aws:iam::111222333444:role/MaintenanceWindowsRole" \ --window-id "mw-ab12cd34eEXAMPLE" \ --task-type "RUN_COMMAND" \ --task-parameters "{\"commands\":{\"Values\":[\"df\"]}}" \ --max-concurrency 1 \ --max-errors 1 \ --priority 10

Sortie :

{ "WindowTaskId":"33344444-5555-6666-7777-88888888" }

Pour plus d'informations, consultez la section Enregistrer une tâche avec la fenêtre de maintenance (AWS CLI) dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserregister-task-with-maintenance-window.

AWS CLI

Exemple 1 : enregistrement d’une tâche d’automatisation avec une fenêtre de maintenance

L’exemple de register-task-with-maintenance-window suivant enregistre une tâche d’automatisation avec une fenêtre de maintenance qui est ciblée sur une instance.

aws ssm register-task-with-maintenance-window \ --window-id "mw-082dcd7649EXAMPLE" \ --targets Key=InstanceIds,Values=i-1234520122EXAMPLE \ --task-arn AWS-RestartEC2Instance \ --service-role-arn arn:aws:iam::111222333444:role/SSM --task-type AUTOMATION \ --task-invocation-parameters "{\"Automation\":{\"DocumentVersion\":\"\$LATEST\",\"Parameters\":{\"InstanceId\":[\"{{RESOURCE_ID}}\"]}}}" \ --priority 0 \ --max-concurrency 1 \ --max-errors 1 \ --name "AutomationExample" \ --description "Restarting EC2 Instance for maintenance"

Sortie :

{ "WindowTaskId":"11144444-5555-6666-7777-88888888" }

Pour plus d'informations, consultez la section Enregistrer une tâche avec la fenêtre de maintenance (AWS CLI) dans le guide de l'utilisateur de AWS Systems Manager.

Exemple 2 : enregistrement d’une tâche Lambda avec une fenêtre de maintenance

L’exemple de register-task-with-maintenance-window suivant enregistre une tâche Lambda avec une fenêtre de maintenance ciblée sur une instance.

aws ssm register-task-with-maintenance-window \ --window-id "mw-082dcd7649dee04e4" \ --targets Key=InstanceIds,Values=i-12344d305eEXAMPLE \ --task-arn arn:aws:lambda:us-east-1:111222333444:function:SSMTestLAMBDA \ --service-role-arn arn:aws:iam::111222333444:role/SSM \ --task-type LAMBDA \ --task-invocation-parameters '{"Lambda":{"Payload":"{\"InstanceId\":\"{{RESOURCE_ID}}\",\"targetType\":\"{{TARGET_TYPE}}\"}","Qualifier":"$LATEST"}}' \ --priority 0 \ --max-concurrency 10 \ --max-errors 5 \ --name "Lambda_Example" \ --description "My Lambda Example"

Sortie :

{ "WindowTaskId":"22244444-5555-6666-7777-88888888" }

Pour plus d'informations, consultez la section Enregistrer une tâche avec la fenêtre de maintenance (AWS CLI) dans le guide de l'utilisateur de AWS Systems Manager.

Exemple 3 : enregistrement d’une tâche Run Command avec une fenêtre de maintenance

L’exemple de register-task-with-maintenance-window suivant enregistre une tâche Run Command avec une fenêtre de maintenance ciblée sur une instance.

aws ssm register-task-with-maintenance-window \ --window-id "mw-082dcd7649dee04e4" \ --targets "Key=InstanceIds,Values=i-12344d305eEXAMPLE" \ --service-role-arn "arn:aws:iam::111222333444:role/SSM" \ --task-type "RUN_COMMAND" \ --name "SSMInstallPowerShellModule" \ --task-arn "AWS-InstallPowerShellModule" \ --task-invocation-parameters "{\"RunCommand\":{\"Comment\":\"\",\"OutputS3BucketName\":\"runcommandlogs\",\"Parameters\":{\"commands\":[\"Get-Module -ListAvailable\"],\"executionTimeout\":[\"3600\"],\"source\":[\"https:\/\/gallery.technet.microsoft.com\/EZOut-33ae0fb7\/file\/110351\/1\/EZOut.zip\"],\"workingDirectory\":[\"\\\\\"]},\"TimeoutSeconds\":600}}" \ --max-concurrency 1 \ --max-errors 1 \ --priority 10

Sortie :

{ "WindowTaskId":"33344444-5555-6666-7777-88888888" }

Pour plus d'informations, consultez la section Enregistrer une tâche avec la fenêtre de maintenance (AWS CLI) dans le guide de l'utilisateur de AWS Systems Manager.

Exemple 4 : enregistrement d’une tâche Step Functions avec une fenêtre de maintenance

L’exemple de register-task-with-maintenance-window suivant enregistre une tâche Step Functions avec une fenêtre de maintenance ciblée sur une instance.

aws ssm register-task-with-maintenance-window \ --window-id "mw-1234d787d6EXAMPLE" \ --targets Key=WindowTargetIds,Values=12347414-69c3-49f8-95b8-ed2dcEXAMPLE \ --task-arn arn:aws:states:us-east-1:111222333444:stateMachine:SSMTestStateMachine \ --service-role-arn arn:aws:iam::111222333444:role/MaintenanceWindows \ --task-type STEP_FUNCTIONS \ --task-invocation-parameters '{"StepFunctions":{"Input":"{\"InstanceId\":\"{{RESOURCE_ID}}\"}"}}' \ --priority 0 \ --max-concurrency 10 \ --max-errors 5 \ --name "Step_Functions_Example" \ --description "My Step Functions Example"

Sortie :

{ "WindowTaskId":"44444444-5555-6666-7777-88888888" }

Pour plus d'informations, consultez la section Enregistrer une tâche avec la fenêtre de maintenance (AWS CLI) dans le guide de l'utilisateur de AWS Systems Manager.

Exemple 5 : enregistrement d’une tâche à l’aide de l’ID cible d’une fenêtre de maintenance

L’exemple de register-task-with-maintenance-window suivant enregistre une tâche à l’aide de l’ID cible d’une fenêtre de maintenance. L’ID cible de la fenêtre de maintenance se trouvait dans la sortie de la commande aws ssm register-target-with-maintenance-window. Vous pouvez également le récupérer à partir de la sortie de la commande aws ssm describe-maintenance-window-targets.

aws ssm register-task-with-maintenance-window \ --targets "Key=WindowTargetIds,Values=350d44e6-28cc-44e2-951f-4b2c9EXAMPLE" \ --task-arn "AWS-RunShellScript" \ --service-role-arn "arn:aws:iam::111222333444:role/MaintenanceWindowsRole" \ --window-id "mw-ab12cd34eEXAMPLE" \ --task-type "RUN_COMMAND" \ --task-parameters "{\"commands\":{\"Values\":[\"df\"]}}" \ --max-concurrency 1 \ --max-errors 1 \ --priority 10

Sortie :

{ "WindowTaskId":"33344444-5555-6666-7777-88888888" }

Pour plus d'informations, consultez la section Enregistrer une tâche avec la fenêtre de maintenance (AWS CLI) dans le guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserremove-tags-from-resource.

AWS CLI

Pour supprimer une balise d’un référentiel de correctifs

L’exemple de remove-tags-from-resource suivant supprime des correctifs d’un référentiel de correctifs.

aws ssm remove-tags-from-resource \ --resource-type "PatchBaseline" \ --resource-id "pb-0123456789abcdef0" \ --tag-keys "Region"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section AWS Ressources de balisage dans le manuel de référence AWS général.

L'exemple de code suivant montre comment utiliserremove-tags-from-resource.

AWS CLI

Pour supprimer une balise d’un référentiel de correctifs

L’exemple de remove-tags-from-resource suivant supprime des correctifs d’un référentiel de correctifs.

aws ssm remove-tags-from-resource \ --resource-type "PatchBaseline" \ --resource-id "pb-0123456789abcdef0" \ --tag-keys "Region"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section AWS Ressources de balisage dans le manuel de référence AWS général.

L'exemple de code suivant montre comment utiliserreset-service-setting.

AWS CLI

Pour réinitialiser le paramètre de service pour le débit du Parameter Store

L'reset-service-settingexemple suivant réinitialise le paramètre de service pour le débit du Parameter Store dans la région spécifiée afin de ne plus utiliser de débit accru.

aws ssm reset-service-setting \ --setting-id arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled

Sortie :

{ "ServiceSetting": { "SettingId": "/ssm/parameter-store/high-throughput-enabled", "SettingValue": "false", "LastModifiedDate": 1555532818.578, "LastModifiedUser": "System", "ARN": "arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled", "Status": "Default" } }

Pour plus d'informations, consultez la section Increasing Parameter Store Throughput dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir ResetServiceSettingla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserreset-service-setting.

AWS CLI

Pour réinitialiser le paramètre de service pour le débit du Parameter Store

L'reset-service-settingexemple suivant réinitialise le paramètre de service pour le débit du Parameter Store dans la région spécifiée afin de ne plus utiliser de débit accru.

aws ssm reset-service-setting \ --setting-id arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled

Sortie :

{ "ServiceSetting": { "SettingId": "/ssm/parameter-store/high-throughput-enabled", "SettingValue": "false", "LastModifiedDate": 1555532818.578, "LastModifiedUser": "System", "ARN": "arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled", "Status": "Default" } }

Pour plus d'informations, consultez la section Increasing Parameter Store Throughput dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir ResetServiceSettingla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserresume-session.

AWS CLI

Pour reprendre une session du gestionnaire de session

Cet resume-session exemple reprend une session du gestionnaire de session avec une instance après sa déconnexion. Notez que cette commande interactive nécessite l’installation du plugin Session Manager sur l’ordinateur client qui effectue l’appel.

aws ssm resume-session \ --session-id Mary-Major-07a16060613c408b5

Sortie :

{ "SessionId": "Mary-Major-07a16060613c408b5", "TokenValue": "AAEAAVbTGsaOnyvcUoNGqifbv5r/8lgxuQljCuY8qVcvOnoBAAAAAFxtd3jIXAFUUXGTJ7zF/AWJPwDviOlF5p3dlAgrqVIVO6IEXhkHLz0/1gXKRKEME71E6TLOplLDJAMZ+kREejkZu4c5AxMkrQjMF+gtHP1bYJKTwtHQd1wjulPLexO8SHl7g5R/wekrj6WsDUpnEegFBfGftpAIz2GXQVfTJXKfkc5qepQ11C11DOIT2dozOqXgHwfQHfAKLErM5dWDZqKwyT1Z3iw7unQdm3p5qsbrugiOZ7CRANTE+ihfGa6MEJJ97Jmat/a2TspEnOjNn9Mvu5iwXIW2yCvWZrGUj+/QI5Xr7s1XJBEnSKR54o4fN0GV9RWl0RZsZm1m1ki0JJtiwwgZ", "StreamUrl": "wss://ssmmessages.us-east-2.amazonaws.com/v1/data-channel/Mary-Major-07a16060613c408b5?role=publish_subscribe" }

Pour plus d'informations, consultez la section Installer le plug-in Session Manager pour la AWS CLI dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir ResumeSessionla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserresume-session.

AWS CLI

Pour reprendre une session du gestionnaire de session

Cet resume-session exemple reprend une session du gestionnaire de session avec une instance après sa déconnexion. Notez que cette commande interactive nécessite l’installation du plugin Session Manager sur l’ordinateur client qui effectue l’appel.

aws ssm resume-session \ --session-id Mary-Major-07a16060613c408b5

Sortie :

{ "SessionId": "Mary-Major-07a16060613c408b5", "TokenValue": "AAEAAVbTGsaOnyvcUoNGqifbv5r/8lgxuQljCuY8qVcvOnoBAAAAAFxtd3jIXAFUUXGTJ7zF/AWJPwDviOlF5p3dlAgrqVIVO6IEXhkHLz0/1gXKRKEME71E6TLOplLDJAMZ+kREejkZu4c5AxMkrQjMF+gtHP1bYJKTwtHQd1wjulPLexO8SHl7g5R/wekrj6WsDUpnEegFBfGftpAIz2GXQVfTJXKfkc5qepQ11C11DOIT2dozOqXgHwfQHfAKLErM5dWDZqKwyT1Z3iw7unQdm3p5qsbrugiOZ7CRANTE+ihfGa6MEJJ97Jmat/a2TspEnOjNn9Mvu5iwXIW2yCvWZrGUj+/QI5Xr7s1XJBEnSKR54o4fN0GV9RWl0RZsZm1m1ki0JJtiwwgZ", "StreamUrl": "wss://ssmmessages.us-east-2.amazonaws.com/v1/data-channel/Mary-Major-07a16060613c408b5?role=publish_subscribe" }

Pour plus d'informations, consultez la section Installer le plug-in Session Manager pour la AWS CLI dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir ResumeSessionla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisersend-automation-signal.

AWS CLI

Pour envoyer un signal à une exécution automatique

L'send-automation-signalexemple suivant envoie un signal d'approbation à une exécution automatique.

aws ssm send-automation-signal \ --automation-execution-id 73c8eef8-f4ee-4a05-820c-e354fEXAMPLE \ --signal-type "Approve"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Exécution d'un flux de travail d'automatisation avec des approbateurs dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir SendAutomationSignalla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisersend-automation-signal.

AWS CLI

Pour envoyer un signal à une exécution automatique

L'send-automation-signalexemple suivant envoie un signal d'approbation à une exécution automatique.

aws ssm send-automation-signal \ --automation-execution-id 73c8eef8-f4ee-4a05-820c-e354fEXAMPLE \ --signal-type "Approve"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Exécution d'un flux de travail d'automatisation avec des approbateurs dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, voir SendAutomationSignalla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisersend-command.

AWS CLI

Exemple 1 : exécution d’une commande sur une ou plusieurs instances distantes

L’exemple de send-command suivant exécute une commande echo sur une instance cible.

aws ssm send-command \ --document-name "AWS-RunShellScript" \ --parameters 'commands=["echo HelloWorld"]' \ --targets "Key=instanceids,Values=i-1234567890abcdef0" \ --comment "echo HelloWorld"

Sortie :

{ "Command": { "CommandId": "92853adf-ba41-4cd6-9a88-142d1EXAMPLE", "DocumentName": "AWS-RunShellScript", "DocumentVersion": "", "Comment": "echo HelloWorld", "ExpiresAfter": 1550181014.717, "Parameters": { "commands": [ "echo HelloWorld" ] }, "InstanceIds": [ "i-0f00f008a2dcbefe2" ], "Targets": [], "RequestedDateTime": 1550173814.717, "Status": "Pending", "StatusDetails": "Pending", "OutputS3BucketName": "", "OutputS3KeyPrefix": "", "MaxConcurrency": "50", "MaxErrors": "0", "TargetCount": 1, "CompletedCount": 0, "ErrorCount": 0, "DeliveryTimedOutCount": 0, "ServiceRole": "", "NotificationConfig": { "NotificationArn": "", "NotificationEvents": [], "NotificationType": "" }, "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false } } }

Pour plus d’informations, consultez Exécution de commandes à l’aide de Run Command de Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 2 : pour obtenir des informations sur l’IP d’une instance

L’exemple de send-command suivant récupère les informations sur l’IP d’une instance.

aws ssm send-command \ --instance-ids "i-1234567890abcdef0" \ --document-name "AWS-RunShellScript" \ --comment "IP config" \ --parameters "commands=ifconfig"

Voir l’exemple 1 pour un exemple de sortie.

Pour plus d’informations, consultez Exécution de commandes à l’aide de Run Command de Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 3 : pour exécuter une commande sur des instances avec des balises spécifiques

L’exemple de send-command suivant exécute une commande sur les instances qui ont la clé de balise « ENV » et la valeur « Dev ».

aws ssm send-command \ --targets "Key=tag:ENV,Values=Dev" \ --document-name "AWS-RunShellScript" \ --parameters "commands=ifconfig"

Voir l’exemple 1 pour un exemple de sortie.

Pour plus d’informations, consultez Exécution de commandes à l’aide de Run Command de Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 4 : exécuter une commande qui envoie des notifications SNS

L’exemple de send-command suivant exécute une commande qui envoie des notifications SNS pour tous les événements de notification et le type de notification Command.

aws ssm send-command \ --instance-ids "i-1234567890abcdef0" \ --document-name "AWS-RunShellScript" \ --comment "IP config" \ --parameters "commands=ifconfig" \ --service-role-arn "arn:aws:iam::123456789012:role/SNS_Role" \ --notification-config "NotificationArn=arn:aws:sns:us-east-1:123456789012:SNSTopicName,NotificationEvents=All,NotificationType=Command"

Voir l’exemple 1 pour un exemple de sortie.

Pour plus d’informations, consultez Exécution de commandes à l’aide de Run Command de Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 5 : Pour exécuter une commande qui renvoie vers S3 et CloudWatch

L'send-commandexemple suivant exécute une commande qui affiche les détails de la commande dans un compartiment S3 et dans un groupe de CloudWatch journaux Logs.

aws ssm send-command \ --instance-ids "i-1234567890abcdef0" \ --document-name "AWS-RunShellScript" \ --comment "IP config" \ --parameters "commands=ifconfig" \ --output-s3-bucket-name "s3-bucket-name" \ --output-s3-key-prefix "runcommand" \ --cloud-watch-output-config "CloudWatchOutputEnabled=true,CloudWatchLogGroupName=CWLGroupName"

Voir l’exemple 1 pour un exemple de sortie.

Pour plus d’informations, consultez Exécution de commandes à l’aide de Run Command de Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 6 : pour exécuter des commandes sur plusieurs instances avec des balises différentes

L’exemple de send-command suivant exécute une commande sur des instances avec deux clés et valeurs de balises différentes.

aws ssm send-command \ --document-name "AWS-RunPowerShellScript" \ --parameters commands=["echo helloWorld"] \ --targets Key=tag:Env,Values=Dev Key=tag:Role,Values=WebServers

Voir l’exemple 1 pour un exemple de sortie.

Pour plus d’informations, consultez Exécution de commandes à l’aide de Run Command de Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 7 : pour cibler plusieurs instances avec la même clé de balise

L’exemple de send-command suivant exécute une commande sur des instances ayant la même clé de balise mais des valeurs différentes.

aws ssm send-command \ --document-name "AWS-RunPowerShellScript" \ --parameters commands=["echo helloWorld"] \ --targets Key=tag:Env,Values=Dev,Test

Voir l’exemple 1 pour un exemple de sortie.

Pour plus d’informations, consultez Exécution de commandes à l’aide de Run Command de Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 8 : pour exécuter une commande qui utilise un document partagé

L’exemple de send-command suivant exécute un document partagé sur une instance cible.

aws ssm send-command \ --document-name "arn:aws:ssm:us-east-1:123456789012:document/ExampleDocument" \ --targets "Key=instanceids,Values=i-1234567890abcdef0"

Voir l’exemple 1 pour un exemple de sortie.

Pour plus d’informations, consultez Utilisation de documents SSM partagés dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, voir SendCommandla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisersend-command.

AWS CLI

Exemple 1 : exécution d’une commande sur une ou plusieurs instances distantes

L’exemple de send-command suivant exécute une commande echo sur une instance cible.

aws ssm send-command \ --document-name "AWS-RunShellScript" \ --parameters 'commands=["echo HelloWorld"]' \ --targets "Key=instanceids,Values=i-1234567890abcdef0" \ --comment "echo HelloWorld"

Sortie :

{ "Command": { "CommandId": "92853adf-ba41-4cd6-9a88-142d1EXAMPLE", "DocumentName": "AWS-RunShellScript", "DocumentVersion": "", "Comment": "echo HelloWorld", "ExpiresAfter": 1550181014.717, "Parameters": { "commands": [ "echo HelloWorld" ] }, "InstanceIds": [ "i-0f00f008a2dcbefe2" ], "Targets": [], "RequestedDateTime": 1550173814.717, "Status": "Pending", "StatusDetails": "Pending", "OutputS3BucketName": "", "OutputS3KeyPrefix": "", "MaxConcurrency": "50", "MaxErrors": "0", "TargetCount": 1, "CompletedCount": 0, "ErrorCount": 0, "DeliveryTimedOutCount": 0, "ServiceRole": "", "NotificationConfig": { "NotificationArn": "", "NotificationEvents": [], "NotificationType": "" }, "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false } } }

Pour plus d’informations, consultez Exécution de commandes à l’aide de Run Command de Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 2 : pour obtenir des informations sur l’IP d’une instance

L’exemple de send-command suivant récupère les informations sur l’IP d’une instance.

aws ssm send-command \ --instance-ids "i-1234567890abcdef0" \ --document-name "AWS-RunShellScript" \ --comment "IP config" \ --parameters "commands=ifconfig"

Voir l’exemple 1 pour un exemple de sortie.

Pour plus d’informations, consultez Exécution de commandes à l’aide de Run Command de Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 3 : pour exécuter une commande sur des instances avec des balises spécifiques

L’exemple de send-command suivant exécute une commande sur les instances qui ont la clé de balise « ENV » et la valeur « Dev ».

aws ssm send-command \ --targets "Key=tag:ENV,Values=Dev" \ --document-name "AWS-RunShellScript" \ --parameters "commands=ifconfig"

Voir l’exemple 1 pour un exemple de sortie.

Pour plus d’informations, consultez Exécution de commandes à l’aide de Run Command de Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 4 : exécuter une commande qui envoie des notifications SNS

L’exemple de send-command suivant exécute une commande qui envoie des notifications SNS pour tous les événements de notification et le type de notification Command.

aws ssm send-command \ --instance-ids "i-1234567890abcdef0" \ --document-name "AWS-RunShellScript" \ --comment "IP config" \ --parameters "commands=ifconfig" \ --service-role-arn "arn:aws:iam::123456789012:role/SNS_Role" \ --notification-config "NotificationArn=arn:aws:sns:us-east-1:123456789012:SNSTopicName,NotificationEvents=All,NotificationType=Command"

Voir l’exemple 1 pour un exemple de sortie.

Pour plus d’informations, consultez Exécution de commandes à l’aide de Run Command de Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 5 : Pour exécuter une commande qui renvoie vers S3 et CloudWatch

L'send-commandexemple suivant exécute une commande qui affiche les détails de la commande dans un compartiment S3 et dans un groupe de CloudWatch journaux Logs.

aws ssm send-command \ --instance-ids "i-1234567890abcdef0" \ --document-name "AWS-RunShellScript" \ --comment "IP config" \ --parameters "commands=ifconfig" \ --output-s3-bucket-name "s3-bucket-name" \ --output-s3-key-prefix "runcommand" \ --cloud-watch-output-config "CloudWatchOutputEnabled=true,CloudWatchLogGroupName=CWLGroupName"

Voir l’exemple 1 pour un exemple de sortie.

Pour plus d’informations, consultez Exécution de commandes à l’aide de Run Command de Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 6 : pour exécuter des commandes sur plusieurs instances avec des balises différentes

L’exemple de send-command suivant exécute une commande sur des instances avec deux clés et valeurs de balises différentes.

aws ssm send-command \ --document-name "AWS-RunPowerShellScript" \ --parameters commands=["echo helloWorld"] \ --targets Key=tag:Env,Values=Dev Key=tag:Role,Values=WebServers

Voir l’exemple 1 pour un exemple de sortie.

Pour plus d’informations, consultez Exécution de commandes à l’aide de Run Command de Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 7 : pour cibler plusieurs instances avec la même clé de balise

L’exemple de send-command suivant exécute une commande sur des instances ayant la même clé de balise mais des valeurs différentes.

aws ssm send-command \ --document-name "AWS-RunPowerShellScript" \ --parameters commands=["echo helloWorld"] \ --targets Key=tag:Env,Values=Dev,Test

Voir l’exemple 1 pour un exemple de sortie.

Pour plus d’informations, consultez Exécution de commandes à l’aide de Run Command de Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 8 : pour exécuter une commande qui utilise un document partagé

L’exemple de send-command suivant exécute un document partagé sur une instance cible.

aws ssm send-command \ --document-name "arn:aws:ssm:us-east-1:123456789012:document/ExampleDocument" \ --targets "Key=instanceids,Values=i-1234567890abcdef0"

Voir l’exemple 1 pour un exemple de sortie.

Pour plus d’informations, consultez Utilisation de documents SSM partagés dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, voir SendCommandla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserstart-associations-once.

AWS CLI

Pour gérer une association immédiatement et une seule fois

L'start-associations-onceexemple suivant exécute l'association spécifiée immédiatement et une seule fois. Il n’y a pas de sortie si la commande réussit.

aws ssm start-associations-once \ --association-id "8dfe3659-4309-493a-8755-0123456789ab"

Cette commande ne produit aucun résultat.

Pour plus d’informations, consultez Afficher l’historique des associations dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, voir StartAssociationsOncela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserstart-associations-once.

AWS CLI

Pour gérer une association immédiatement et une seule fois

L'start-associations-onceexemple suivant exécute l'association spécifiée immédiatement et une seule fois. Il n’y a pas de sortie si la commande réussit.

aws ssm start-associations-once \ --association-id "8dfe3659-4309-493a-8755-0123456789ab"

Cette commande ne produit aucun résultat.

Pour plus d’informations, consultez Afficher l’historique des associations dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, voir StartAssociationsOncela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserstart-automation-execution.

AWS CLI

Exemple 1 : exécution d’un document d’automatisation

L’exemple de start-automation-execution suivant exécute un document d’automatisation.

aws ssm start-automation-execution \ --document-name "AWS-UpdateLinuxAmi" \ --parameters "AutomationAssumeRole=arn:aws:iam::123456789012:role/SSMAutomationRole,SourceAmiId=ami-EXAMPLE,IamInstanceProfileName=EC2InstanceRole"

Sortie :

{ "AutomationExecutionId": "4105a4fc-f944-11e6-9d32-0a1b2EXAMPLE" }

Pour plus d’informations, consultez Exécution manuelle d’un flux de travail d’automatisation dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 2 : exécution d’un document d’automatisation partagé

L’exemple de start-automation-execution suivant exécute un document d’automatisation partagé.

aws ssm start-automation-execution \ --document-name "arn:aws:ssm:us-east-1:123456789012:document/ExampleDocument"

Sortie :

{ "AutomationExecutionId": "4105a4fc-f944-11e6-9d32-0a1b2EXAMPLE" }

Pour plus d’informations, consultez Utilisation de documents SSM partagés dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserstart-automation-execution.

AWS CLI

Exemple 1 : exécution d’un document d’automatisation

L’exemple de start-automation-execution suivant exécute un document d’automatisation.

aws ssm start-automation-execution \ --document-name "AWS-UpdateLinuxAmi" \ --parameters "AutomationAssumeRole=arn:aws:iam::123456789012:role/SSMAutomationRole,SourceAmiId=ami-EXAMPLE,IamInstanceProfileName=EC2InstanceRole"

Sortie :

{ "AutomationExecutionId": "4105a4fc-f944-11e6-9d32-0a1b2EXAMPLE" }

Pour plus d’informations, consultez Exécution manuelle d’un flux de travail d’automatisation dans le Guide de l’utilisateur AWS Systems Manager.

Exemple 2 : exécution d’un document d’automatisation partagé

L’exemple de start-automation-execution suivant exécute un document d’automatisation partagé.

aws ssm start-automation-execution \ --document-name "arn:aws:ssm:us-east-1:123456789012:document/ExampleDocument"

Sortie :

{ "AutomationExecutionId": "4105a4fc-f944-11e6-9d32-0a1b2EXAMPLE" }

Pour plus d’informations, consultez Utilisation de documents SSM partagés dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserstart-change-request-execution.

AWS CLI

Exemple 1 : pour lancer une demande de modification

L'start-change-request-executionexemple suivant lance une demande de modification avec un minimum d'options spécifiées.

aws ssm start-change-request-execution \ --change-request-name MyChangeRequest \ --document-name AWS-HelloWorldChangeTemplate \ --runbooks '[{"DocumentName": "AWS-HelloWorld","Parameters": {"AutomationAssumeRole": ["arn:aws:iam:us-east-2:1112223233444:role/MyChangeManagerAssumeRole"]}}]' \ --parameters Approver="JohnDoe",ApproverType="IamUser",ApproverSnsTopicArn="arn:aws:sns:us-east-2:1112223233444:MyNotificationTopic"

Sortie :

{ "AutomationExecutionId": "9d32a4fc-f944-11e6-4105-0a1b2EXAMPLE" }

Exemple 2 : Pour démarrer une demande de modification à l'aide d'un fichier JSON externe

L'start-automation-executionexemple suivant lance une demande de modification avec plusieurs options spécifiées dans un fichier JSON.

aws ssm start-change-request-execution \ --cli-input-json file://MyChangeRequest.json

Contenu de MyChangeRequest.json :

{ "ChangeRequestName": "MyChangeRequest", "DocumentName": "AWS-HelloWorldChangeTemplate", "DocumentVersion": "$DEFAULT", "ScheduledTime": "2021-12-30T03:00:00", "ScheduledEndTime": "2021-12-30T03:05:00", "Tags": [ { "Key": "Purpose", "Value": "Testing" } ], "Parameters": { "Approver": [ "JohnDoe" ], "ApproverType": [ "IamUser" ], "ApproverSnsTopicArn": [ "arn:aws:sns:us-east-2:111222333444;:MyNotificationTopic ] }, "Runbooks": [ { "DocumentName": "AWS-HelloWorld", "DocumentVersion": "1", "MaxConcurrency": "1", "MaxErrors": "1", "Parameters": { "AutomationAssumeRole": [ "arn:aws:iam::111222333444:role/MyChangeManagerAssumeRole" ] } } ], "ChangeDetails": "### Document Name: HelloWorldChangeTemplate\n\n## What does this document do?\nThis change template demonstrates the feature set available for creating change templates for Change Manager. This template starts a Runbook workflow for the Automation document called AWS-HelloWorld.\n\n## Input Parameters\n* ApproverSnsTopicArn: (Required) Amazon Simple Notification Service ARN for approvers.\n* Approver: (Required) The name of the approver to send this request to.\n* ApproverType: (Required) The type of reviewer.\n * Allowed Values: IamUser, IamGroup, IamRole, SSOGroup, SSOUser\n\n## Output Parameters\nThis document has no outputs \n" }

Sortie :

{ "AutomationExecutionId": "9d32a4fc-f944-11e6-4105-0a1b2EXAMPLE" }

Pour plus d'informations, consultez la section Création de demandes de modification dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserstart-change-request-execution.

AWS CLI

Exemple 1 : pour lancer une demande de modification

L'start-change-request-executionexemple suivant lance une demande de modification avec un minimum d'options spécifiées.

aws ssm start-change-request-execution \ --change-request-name MyChangeRequest \ --document-name AWS-HelloWorldChangeTemplate \ --runbooks '[{"DocumentName": "AWS-HelloWorld","Parameters": {"AutomationAssumeRole": ["arn:aws:iam:us-east-2:1112223233444:role/MyChangeManagerAssumeRole"]}}]' \ --parameters Approver="JohnDoe",ApproverType="IamUser",ApproverSnsTopicArn="arn:aws:sns:us-east-2:1112223233444:MyNotificationTopic"

Sortie :

{ "AutomationExecutionId": "9d32a4fc-f944-11e6-4105-0a1b2EXAMPLE" }

Exemple 2 : Pour démarrer une demande de modification à l'aide d'un fichier JSON externe

L'start-automation-executionexemple suivant lance une demande de modification avec plusieurs options spécifiées dans un fichier JSON.

aws ssm start-change-request-execution \ --cli-input-json file://MyChangeRequest.json

Contenu de MyChangeRequest.json :

{ "ChangeRequestName": "MyChangeRequest", "DocumentName": "AWS-HelloWorldChangeTemplate", "DocumentVersion": "$DEFAULT", "ScheduledTime": "2021-12-30T03:00:00", "ScheduledEndTime": "2021-12-30T03:05:00", "Tags": [ { "Key": "Purpose", "Value": "Testing" } ], "Parameters": { "Approver": [ "JohnDoe" ], "ApproverType": [ "IamUser" ], "ApproverSnsTopicArn": [ "arn:aws:sns:us-east-2:111222333444;:MyNotificationTopic ] }, "Runbooks": [ { "DocumentName": "AWS-HelloWorld", "DocumentVersion": "1", "MaxConcurrency": "1", "MaxErrors": "1", "Parameters": { "AutomationAssumeRole": [ "arn:aws:iam::111222333444:role/MyChangeManagerAssumeRole" ] } } ], "ChangeDetails": "### Document Name: HelloWorldChangeTemplate\n\n## What does this document do?\nThis change template demonstrates the feature set available for creating change templates for Change Manager. This template starts a Runbook workflow for the Automation document called AWS-HelloWorld.\n\n## Input Parameters\n* ApproverSnsTopicArn: (Required) Amazon Simple Notification Service ARN for approvers.\n* Approver: (Required) The name of the approver to send this request to.\n* ApproverType: (Required) The type of reviewer.\n * Allowed Values: IamUser, IamGroup, IamRole, SSOGroup, SSOUser\n\n## Output Parameters\nThis document has no outputs \n" }

Sortie :

{ "AutomationExecutionId": "9d32a4fc-f944-11e6-4105-0a1b2EXAMPLE" }

Pour plus d'informations, consultez la section Création de demandes de modification dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserstart-session.

AWS CLI

Exemple 1 : démarrage d’une session Session Manager

Cet exemple de start-session établit une connexion avec une instance pour une session Session Manager. Notez que cette commande interactive nécessite l’installation du plugin Session Manager sur l’ordinateur client qui effectue l’appel.

aws ssm start-session \ --target "i-1234567890abcdef0"

Sortie :

Starting session with SessionId: Jane-Roe-07a16060613c408b5

Exemple 2 : démarrage d’une session Session Manager en utilisant SSH

Cet exemple de start-session établit une connexion avec une instance pour une session Session Manager en utilisant SSH. Notez que cette commande interactive nécessite que le plug-in Session Manager soit installé sur la machine cliente effectuant l'appel, et que la commande utilise l'utilisateur par défaut sur l'instance, comme ec2-user pour les EC2 instances pour Linux.

ssh -i /path/my-key-pair.pem ec2-user@i-02573cafcfEXAMPLE

Sortie :

Starting session with SessionId: ec2-user-07a16060613c408b5

Pour plus d'informations, consultez Démarrer une session et installer le plug-in Session Manager pour la AWS CLI dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous StartSessionà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserstart-session.

AWS CLI

Exemple 1 : démarrage d’une session Session Manager

Cet exemple de start-session établit une connexion avec une instance pour une session Session Manager. Notez que cette commande interactive nécessite l’installation du plugin Session Manager sur l’ordinateur client qui effectue l’appel.

aws ssm start-session \ --target "i-1234567890abcdef0"

Sortie :

Starting session with SessionId: Jane-Roe-07a16060613c408b5

Exemple 2 : démarrage d’une session Session Manager en utilisant SSH

Cet exemple de start-session établit une connexion avec une instance pour une session Session Manager en utilisant SSH. Notez que cette commande interactive nécessite que le plug-in Session Manager soit installé sur la machine cliente effectuant l'appel, et que la commande utilise l'utilisateur par défaut sur l'instance, comme ec2-user pour les EC2 instances pour Linux.

ssh -i /path/my-key-pair.pem ec2-user@i-02573cafcfEXAMPLE

Sortie :

Starting session with SessionId: ec2-user-07a16060613c408b5

Pour plus d'informations, consultez Démarrer une session et installer le plug-in Session Manager pour la AWS CLI dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous StartSessionà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserstop-automation-execution.

AWS CLI

Pour arrêter l’exécution d’une automatisation

L’exemple de stop-automation-execution suivant arrête un document d’automatisation.

aws ssm stop-automation-execution --automation-execution-id "4105a4fc-f944-11e6-9d32-0a1b2EXAMPLE"

Cette commande ne produit aucun résultat.

Pour plus d’informations, consultez Exécution manuelle d’un flux de travail d’automatisation dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous StopAutomationExecutionà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserstop-automation-execution.

AWS CLI

Pour arrêter l’exécution d’une automatisation

L’exemple de stop-automation-execution suivant arrête un document d’automatisation.

aws ssm stop-automation-execution --automation-execution-id "4105a4fc-f944-11e6-9d32-0a1b2EXAMPLE"

Cette commande ne produit aucun résultat.

Pour plus d’informations, consultez Exécution manuelle d’un flux de travail d’automatisation dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous StopAutomationExecutionà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserterminate-session.

AWS CLI

Pour mettre fin à une session du gestionnaire de session

Cet terminate-session exemple met définitivement fin à une session créée par l'utilisateur « Shirley-Rodriguez » et ferme la connexion de données entre le client Session Manager et l'agent SSM sur l'instance.

aws ssm terminate-session \ --session-id "Shirley-Rodriguez-07a16060613c408b5"

Sortie :

{ "SessionId": "Shirley-Rodriguez-07a16060613c408b5" }

Pour plus d'informations, consultez la section Mettre fin à une session dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous TerminateSessionà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserterminate-session.

AWS CLI

Pour mettre fin à une session du gestionnaire de session

Cet terminate-session exemple met définitivement fin à une session créée par l'utilisateur « Shirley-Rodriguez » et ferme la connexion de données entre le client Session Manager et l'agent SSM sur l'instance.

aws ssm terminate-session \ --session-id "Shirley-Rodriguez-07a16060613c408b5"

Sortie :

{ "SessionId": "Shirley-Rodriguez-07a16060613c408b5" }

Pour plus d'informations, consultez la section Mettre fin à une session dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous TerminateSessionà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserunlabel-parameter-version.

AWS CLI

Pour supprimer des libellés de paramètres

L'unlabel-parameter-versionexemple suivant supprime les étiquettes spécifiées de la version de paramètre donnée.

aws ssm unlabel-parameter-version \ --name "parameterName" \ --parameter-version "version" \ --labels "label_1" "label_2" "label_3"

Sortie :

{ "RemovedLabels": [ "label_1" "label_2" "label_3" ], "InvalidLabels": [] }

Pour plus d'informations, consultez la section Supprimer les étiquettes de paramètres (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous UnlabelParameterVersionà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserunlabel-parameter-version.

AWS CLI

Pour supprimer des libellés de paramètres

L'unlabel-parameter-versionexemple suivant supprime les étiquettes spécifiées de la version de paramètre donnée.

aws ssm unlabel-parameter-version \ --name "parameterName" \ --parameter-version "version" \ --labels "label_1" "label_2" "label_3"

Sortie :

{ "RemovedLabels": [ "label_1" "label_2" "label_3" ], "InvalidLabels": [] }

Pour plus d'informations, consultez la section Supprimer les étiquettes de paramètres (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous UnlabelParameterVersionà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-association-status.

AWS CLI

Pour mettre à jour le statut de l’association

L’exemple de update-association-status suivant met à jour le statut de l’association entre une instance et un document.

aws ssm update-association-status \ --name "AWS-UpdateSSMAgent" \ --instance-id "i-1234567890abcdef0" \ --association-status "Date=1424421071.939,Name=Pending,Message=temp_status_change,AdditionalInfo=Additional-Config-Needed"

Sortie :

{ "AssociationDescription": { "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-1234567890abcdef0", "AssociationVersion": "1", "Date": 1550507529.604, "LastUpdateAssociationDate": 1550507806.974, "Status": { "Date": 1424421071.0, "Name": "Pending", "Message": "temp_status_change", "AdditionalInfo": "Additional-Config-Needed" }, "Overview": { "Status": "Success", "AssociationStatusAggregatedCount": { "Success": 1 } }, "DocumentVersion": "$DEFAULT", "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "Targets": [ { "Key": "InstanceIds", "Values": [ "i-1234567890abcdef0" ] } ], "LastExecutionDate": 1550507808.0, "LastSuccessfulExecutionDate": 1550507808.0 } }

Pour plus d’informations, consultez Utilisation des associations dans Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous UpdateAssociationStatusà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-association-status.

AWS CLI

Pour mettre à jour le statut de l’association

L’exemple de update-association-status suivant met à jour le statut de l’association entre une instance et un document.

aws ssm update-association-status \ --name "AWS-UpdateSSMAgent" \ --instance-id "i-1234567890abcdef0" \ --association-status "Date=1424421071.939,Name=Pending,Message=temp_status_change,AdditionalInfo=Additional-Config-Needed"

Sortie :

{ "AssociationDescription": { "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-1234567890abcdef0", "AssociationVersion": "1", "Date": 1550507529.604, "LastUpdateAssociationDate": 1550507806.974, "Status": { "Date": 1424421071.0, "Name": "Pending", "Message": "temp_status_change", "AdditionalInfo": "Additional-Config-Needed" }, "Overview": { "Status": "Success", "AssociationStatusAggregatedCount": { "Success": 1 } }, "DocumentVersion": "$DEFAULT", "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "Targets": [ { "Key": "InstanceIds", "Values": [ "i-1234567890abcdef0" ] } ], "LastExecutionDate": 1550507808.0, "LastSuccessfulExecutionDate": 1550507808.0 } }

Pour plus d’informations, consultez Utilisation des associations dans Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous UpdateAssociationStatusà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-association.

AWS CLI

Exemple 1 : mise à jour d’une association de documents

L’exemple de update-association suivant met à jour une association avec une nouvelle version de document.

aws ssm update-association \ --association-id "8dfe3659-4309-493a-8755-0123456789ab" \ --document-version "\$LATEST"

Sortie :

{ "AssociationDescription": { "Name": "AWS-UpdateSSMAgent", "AssociationVersion": "2", "Date": 1550508093.293, "LastUpdateAssociationDate": 1550508106.596, "Overview": { "Status": "Pending", "DetailedStatus": "Creating" }, "DocumentVersion": "$LATEST", "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "Targets": [ { "Key": "tag:Name", "Values": [ "Linux" ] } ], "LastExecutionDate": 1550508094.879, "LastSuccessfulExecutionDate": 1550508094.879 } }

Pour plus d’informations, consultez Modifier et créer une nouvelle version d’une association (français non garanti) dans le AWS Guide de l’utilisateur Systems Manager (français non garanti).

Exemple 2 : mise à jour de l’expression de l’horaire d’une association

L’exemple de update-association suivant met à jour l’expression de l’horaire pour l’association spécifiée.

aws ssm update-association \ --association-id "8dfe3659-4309-493a-8755-0123456789ab" \ --schedule-expression "cron(0 0 0/4 1/1 * ? *)"

Sortie :

{ "AssociationDescription": { "Name": "AWS-HelloWorld", "AssociationVersion": "2", "Date": "2021-02-08T13:54:19.203000-08:00", "LastUpdateAssociationDate": "2021-06-29T11:51:07.933000-07:00", "Overview": { "Status": "Pending", "DetailedStatus": "Creating" }, "DocumentVersion": "$DEFAULT", "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "Targets": [ { "Key": "aws:NoOpAutomationTag", "Values": [ "AWS-NoOpAutomationTarget-Value" ] } ], "ScheduleExpression": "cron(0 0 0/4 1/1 * ? *)", "LastExecutionDate": "2021-06-26T19:00:48.110000-07:00", "ApplyOnlyAtCronInterval": false } }

Pour plus d’informations, consultez Modifier et créer une nouvelle version d’une association (français non garanti) dans le AWS Guide de l’utilisateur Systems Manager (français non garanti).

  • Pour plus de détails sur l'API, reportez-vous UpdateAssociationà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-association.

AWS CLI

Exemple 1 : mise à jour d’une association de documents

L’exemple de update-association suivant met à jour une association avec une nouvelle version de document.

aws ssm update-association \ --association-id "8dfe3659-4309-493a-8755-0123456789ab" \ --document-version "\$LATEST"

Sortie :

{ "AssociationDescription": { "Name": "AWS-UpdateSSMAgent", "AssociationVersion": "2", "Date": 1550508093.293, "LastUpdateAssociationDate": 1550508106.596, "Overview": { "Status": "Pending", "DetailedStatus": "Creating" }, "DocumentVersion": "$LATEST", "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "Targets": [ { "Key": "tag:Name", "Values": [ "Linux" ] } ], "LastExecutionDate": 1550508094.879, "LastSuccessfulExecutionDate": 1550508094.879 } }

Pour plus d’informations, consultez Modifier et créer une nouvelle version d’une association (français non garanti) dans le AWS Guide de l’utilisateur Systems Manager (français non garanti).

Exemple 2 : mise à jour de l’expression de l’horaire d’une association

L’exemple de update-association suivant met à jour l’expression de l’horaire pour l’association spécifiée.

aws ssm update-association \ --association-id "8dfe3659-4309-493a-8755-0123456789ab" \ --schedule-expression "cron(0 0 0/4 1/1 * ? *)"

Sortie :

{ "AssociationDescription": { "Name": "AWS-HelloWorld", "AssociationVersion": "2", "Date": "2021-02-08T13:54:19.203000-08:00", "LastUpdateAssociationDate": "2021-06-29T11:51:07.933000-07:00", "Overview": { "Status": "Pending", "DetailedStatus": "Creating" }, "DocumentVersion": "$DEFAULT", "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "Targets": [ { "Key": "aws:NoOpAutomationTag", "Values": [ "AWS-NoOpAutomationTarget-Value" ] } ], "ScheduleExpression": "cron(0 0 0/4 1/1 * ? *)", "LastExecutionDate": "2021-06-26T19:00:48.110000-07:00", "ApplyOnlyAtCronInterval": false } }

Pour plus d’informations, consultez Modifier et créer une nouvelle version d’une association (français non garanti) dans le AWS Guide de l’utilisateur Systems Manager (français non garanti).

  • Pour plus de détails sur l'API, reportez-vous UpdateAssociationà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-document-default-version.

AWS CLI

Pour mettre à jour la version par défaut d’un document

L’exemple de update-document-default-version suivant met à jour la version par défaut d’un document Systems Manager.

aws ssm update-document-default-version \ --name "Example" \ --document-version "2"

Sortie :

{ "Description": { "Name": "Example", "DefaultVersion": "2" } }

Pour plus d’informations, consultez Écrire le contenu d’un document SSM dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserupdate-document-default-version.

AWS CLI

Pour mettre à jour la version par défaut d’un document

L’exemple de update-document-default-version suivant met à jour la version par défaut d’un document Systems Manager.

aws ssm update-document-default-version \ --name "Example" \ --document-version "2"

Sortie :

{ "Description": { "Name": "Example", "DefaultVersion": "2" } }

Pour plus d’informations, consultez Écrire le contenu d’un document SSM dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserupdate-document-metadata.

AWS CLI

Exemple : pour approuver la dernière version d'un modèle de modification

update-document-metadataCe qui suit fournit une approbation pour la dernière version d'un modèle de modification qui a été soumis pour révision.

aws ssm update-document-metadata \ --name MyChangeManagerTemplate \ --document-reviews 'Action=Approve,Comment=[{Type=Comment,Content=Approved!}]'

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Révision et approbation ou rejet des modèles de modification dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous UpdateDocumentMetadataà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-document-metadata.

AWS CLI

Exemple : pour approuver la dernière version d'un modèle de modification

update-document-metadataCe qui suit fournit une approbation pour la dernière version d'un modèle de modification qui a été soumis pour révision.

aws ssm update-document-metadata \ --name MyChangeManagerTemplate \ --document-reviews 'Action=Approve,Comment=[{Type=Comment,Content=Approved!}]'

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Révision et approbation ou rejet des modèles de modification dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous UpdateDocumentMetadataà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-document.

AWS CLI

Pour créer une nouvelle version d’un document

L’exemple de update-document suivant crée une nouvelle version d’un document lorsqu’il est exécuté dans un ordinateur Windows. Le document spécifié par --document doit être au format JSON. Notez que file:// doit être référencé et suivi du chemin d’accès au fichier de contenu. En raison du $ au début du paramètre --document-version, vous devez entourer la valeur de guillemets doubles sous Windows. Sous Linux, macOS ou lorsque vous y êtes PowerShell invité, vous devez placer la valeur entre guillemets simples.

Version Windows :

aws ssm update-document \ --name "RunShellScript" \ --content "file://RunShellScript.json" \ --document-version "$LATEST"

Version Linux/Mac :

aws ssm update-document \ --name "RunShellScript" \ --content "file://RunShellScript.json" \ --document-version '$LATEST'

Sortie :

{ "DocumentDescription": { "Status": "Updating", "Hash": "f775e5df4904c6fa46686c4722fae9de1950dace25cd9608ff8d622046b68d9b", "Name": "RunShellScript", "Parameters": [ { "Type": "StringList", "Name": "commands", "Description": "(Required) Specify a shell script or a command to run." } ], "DocumentType": "Command", "PlatformTypes": [ "Linux" ], "DocumentVersion": "2", "HashType": "Sha256", "CreatedDate": 1487899655.152, "Owner": "809632081692", "SchemaVersion": "2.0", "DefaultVersion": "1", "LatestVersion": "2", "Description": "Run an updated script" } }
  • Pour plus de détails sur l'API, reportez-vous UpdateDocumentà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-document.

AWS CLI

Pour créer une nouvelle version d’un document

L’exemple de update-document suivant crée une nouvelle version d’un document lorsqu’il est exécuté dans un ordinateur Windows. Le document spécifié par --document doit être au format JSON. Notez que file:// doit être référencé et suivi du chemin d’accès au fichier de contenu. En raison du $ au début du paramètre --document-version, vous devez entourer la valeur de guillemets doubles sous Windows. Sous Linux, macOS ou lorsque vous y êtes PowerShell invité, vous devez placer la valeur entre guillemets simples.

Version Windows :

aws ssm update-document \ --name "RunShellScript" \ --content "file://RunShellScript.json" \ --document-version "$LATEST"

Version Linux/Mac :

aws ssm update-document \ --name "RunShellScript" \ --content "file://RunShellScript.json" \ --document-version '$LATEST'

Sortie :

{ "DocumentDescription": { "Status": "Updating", "Hash": "f775e5df4904c6fa46686c4722fae9de1950dace25cd9608ff8d622046b68d9b", "Name": "RunShellScript", "Parameters": [ { "Type": "StringList", "Name": "commands", "Description": "(Required) Specify a shell script or a command to run." } ], "DocumentType": "Command", "PlatformTypes": [ "Linux" ], "DocumentVersion": "2", "HashType": "Sha256", "CreatedDate": 1487899655.152, "Owner": "809632081692", "SchemaVersion": "2.0", "DefaultVersion": "1", "LatestVersion": "2", "Description": "Run an updated script" } }
  • Pour plus de détails sur l'API, reportez-vous UpdateDocumentà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-maintenance-window-target.

AWS CLI

Pour mettre à jour la cible d'une fenêtre de maintenance

L'update-maintenance-window-targetexemple suivant met à jour uniquement le nom d'une cible de fenêtre de maintenance.

aws ssm update-maintenance-window-target \ --window-id "mw-0c5ed765acEXAMPLE" \ --window-target-id "57e8344e-fe64-4023-8191-6bf05EXAMPLE" \ --name "NewName" \ --no-replace

Sortie :

{ "Description": "", "OwnerInformation": "", "WindowTargetId": "57e8344e-fe64-4023-8191-6bf05EXAMPLE", "WindowId": "mw-0c5ed765acEXAMPLE", "Targets": [ { "Values": [ "i-1234567890EXAMPLE" ], "Key": "InstanceIds" } ], "Name": "NewName" }

Pour plus d'informations, voir Mettre à jour une fenêtre de maintenance (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserupdate-maintenance-window-target.

AWS CLI

Pour mettre à jour la cible d'une fenêtre de maintenance

L'update-maintenance-window-targetexemple suivant met à jour uniquement le nom d'une cible de fenêtre de maintenance.

aws ssm update-maintenance-window-target \ --window-id "mw-0c5ed765acEXAMPLE" \ --window-target-id "57e8344e-fe64-4023-8191-6bf05EXAMPLE" \ --name "NewName" \ --no-replace

Sortie :

{ "Description": "", "OwnerInformation": "", "WindowTargetId": "57e8344e-fe64-4023-8191-6bf05EXAMPLE", "WindowId": "mw-0c5ed765acEXAMPLE", "Targets": [ { "Values": [ "i-1234567890EXAMPLE" ], "Key": "InstanceIds" } ], "Name": "NewName" }

Pour plus d'informations, voir Mettre à jour une fenêtre de maintenance (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserupdate-maintenance-window-task.

AWS CLI

Pour mettre à jour une tâche de fenêtre de maintenance

L'update-maintenance-window-taskexemple suivant met à jour le rôle de service pour une tâche de fenêtre de maintenance.

aws ssm update-maintenance-window-task \ --window-id "mw-0c5ed765acEXAMPLE" \ --window-task-id "23d3809e-9fbe-4ddf-b41a-b49d7EXAMPLE" \ --service-role-arn "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM"

Sortie :

{ "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "MaxErrors": "1", "TaskArn": "AWS-UpdateEC2Config", "MaxConcurrency": "1", "WindowTaskId": "23d3809e-9fbe-4ddf-b41a-b49d7EXAMPLE", "TaskParameters": {}, "Priority": 1, "TaskInvocationParameters": { "RunCommand": { "TimeoutSeconds": 600, "Parameters": { "allowDowngrade": [ "false" ] } } }, "WindowId": "mw-0c5ed765acEXAMPLE", "Description": "UpdateEC2Config", "Targets": [ { "Values": [ "57e8344e-fe64-4023-8191-6bf05EXAMPLE" ], "Key": "WindowTargetIds" } ], "Name": "UpdateEC2Config" }

Pour plus d'informations, voir Mettre à jour une fenêtre de maintenance (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserupdate-maintenance-window-task.

AWS CLI

Pour mettre à jour une tâche de fenêtre de maintenance

L'update-maintenance-window-taskexemple suivant met à jour le rôle de service pour une tâche de fenêtre de maintenance.

aws ssm update-maintenance-window-task \ --window-id "mw-0c5ed765acEXAMPLE" \ --window-task-id "23d3809e-9fbe-4ddf-b41a-b49d7EXAMPLE" \ --service-role-arn "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM"

Sortie :

{ "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "MaxErrors": "1", "TaskArn": "AWS-UpdateEC2Config", "MaxConcurrency": "1", "WindowTaskId": "23d3809e-9fbe-4ddf-b41a-b49d7EXAMPLE", "TaskParameters": {}, "Priority": 1, "TaskInvocationParameters": { "RunCommand": { "TimeoutSeconds": 600, "Parameters": { "allowDowngrade": [ "false" ] } } }, "WindowId": "mw-0c5ed765acEXAMPLE", "Description": "UpdateEC2Config", "Targets": [ { "Values": [ "57e8344e-fe64-4023-8191-6bf05EXAMPLE" ], "Key": "WindowTargetIds" } ], "Name": "UpdateEC2Config" }

Pour plus d'informations, voir Mettre à jour une fenêtre de maintenance (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

L'exemple de code suivant montre comment utiliserupdate-maintenance-window.

AWS CLI

Exemple 1 : mise à jour d’une fenêtre de maintenance

L’exemple de update-maintenance-window suivant met à jour le nom d’une fenêtre de maintenance.

aws ssm update-maintenance-window \ --window-id "mw-1a2b3c4d5e6f7g8h9" \ --name "My-Renamed-MW"

Sortie :

{ "Cutoff": 1, "Name": "My-Renamed-MW", "Schedule": "cron(0 16 ? * TUE *)", "Enabled": true, "AllowUnassociatedTargets": true, "WindowId": "mw-1a2b3c4d5e6f7g8h9", "Duration": 4 }

Exemple 2 : désactivation d’une fenêtre de maintenance

L’exemple de update-maintenance-window suivant désactive une fenêtre de maintenance.

aws ssm update-maintenance-window \ --window-id "mw-1a2b3c4d5e6f7g8h9" \ --no-enabled

Exemple 3 : activation d’une fenêtre de maintenance

L’exemple de update-maintenance-window suivant permet d’activer une fenêtre de maintenance.

aws ssm update-maintenance-window \ --window-id "mw-1a2b3c4d5e6f7g8h9" \ --enabled

Pour plus d'informations, voir Mettre à jour une fenêtre de maintenance (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous UpdateMaintenanceWindowà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-maintenance-window.

AWS CLI

Exemple 1 : mise à jour d’une fenêtre de maintenance

L’exemple de update-maintenance-window suivant met à jour le nom d’une fenêtre de maintenance.

aws ssm update-maintenance-window \ --window-id "mw-1a2b3c4d5e6f7g8h9" \ --name "My-Renamed-MW"

Sortie :

{ "Cutoff": 1, "Name": "My-Renamed-MW", "Schedule": "cron(0 16 ? * TUE *)", "Enabled": true, "AllowUnassociatedTargets": true, "WindowId": "mw-1a2b3c4d5e6f7g8h9", "Duration": 4 }

Exemple 2 : désactivation d’une fenêtre de maintenance

L’exemple de update-maintenance-window suivant désactive une fenêtre de maintenance.

aws ssm update-maintenance-window \ --window-id "mw-1a2b3c4d5e6f7g8h9" \ --no-enabled

Exemple 3 : activation d’une fenêtre de maintenance

L’exemple de update-maintenance-window suivant permet d’activer une fenêtre de maintenance.

aws ssm update-maintenance-window \ --window-id "mw-1a2b3c4d5e6f7g8h9" \ --enabled

Pour plus d'informations, voir Mettre à jour une fenêtre de maintenance (AWS CLI) dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous UpdateMaintenanceWindowà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-managed-instance-role.

AWS CLI

Pour mettre à jour le rôle IAM d’une instance gérée

L’exemple de update-managed-instance-role suivant met à jour le profil d’instance IAM d’une instance gérée.

aws ssm update-managed-instance-role \ --instance-id "mi-08ab247cdfEXAMPLE" \ --iam-role "ExampleRole"

Cette commande ne produit aucun résultat.

Pour plus d’informations, consultez Étape 4 : créer un profil d’instance IAM pour Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserupdate-managed-instance-role.

AWS CLI

Pour mettre à jour le rôle IAM d’une instance gérée

L’exemple de update-managed-instance-role suivant met à jour le profil d’instance IAM d’une instance gérée.

aws ssm update-managed-instance-role \ --instance-id "mi-08ab247cdfEXAMPLE" \ --iam-role "ExampleRole"

Cette commande ne produit aucun résultat.

Pour plus d’informations, consultez Étape 4 : créer un profil d’instance IAM pour Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

L'exemple de code suivant montre comment utiliserupdate-ops-item.

AWS CLI

Pour mettre à jour un OpsItem

L'update-ops-itemexemple suivant met à jour la description, la priorité et la catégorie d'un OpsItem. En outre, la commande spécifie une rubrique SNS dans laquelle les notifications sont envoyées lorsqu'elle OpsItem est modifiée ou modifiée.

aws ssm update-ops-item \ --ops-item-id "oi-287b5EXAMPLE" \ --description "Primary OpsItem for failover event 2020-01-01-fh398yf" \ --priority 2 \ --category "Security" \ --notifications "Arn=arn:aws:sns:us-east-2:111222333444:my-us-east-2-topic"

Sortie :

This command produces no output.

Pour plus d'informations, reportez-vous à la section Travailler avec OpsItems dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous UpdateOpsItemà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-ops-item.

AWS CLI

Pour mettre à jour un OpsItem

L'update-ops-itemexemple suivant met à jour la description, la priorité et la catégorie d'un OpsItem. En outre, la commande spécifie une rubrique SNS dans laquelle les notifications sont envoyées lorsqu'elle OpsItem est modifiée ou modifiée.

aws ssm update-ops-item \ --ops-item-id "oi-287b5EXAMPLE" \ --description "Primary OpsItem for failover event 2020-01-01-fh398yf" \ --priority 2 \ --category "Security" \ --notifications "Arn=arn:aws:sns:us-east-2:111222333444:my-us-east-2-topic"

Sortie :

This command produces no output.

Pour plus d'informations, reportez-vous à la section Travailler avec OpsItems dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous UpdateOpsItemà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-patch-baseline.

AWS CLI

Exemple 1 : mise à jour d’un référentiel de correctifs

L’exemple de update-patch-baseline suivant ajoute les deux correctifs spécifiés comme rejetés et un correctif comme approuvé au référentiel de correctifs spécifié.

aws ssm update-patch-baseline \ --baseline-id "pb-0123456789abcdef0" \ --rejected-patches "KB2032276" "MS10-048" \ --approved-patches "KB2124261"

Sortie :

{ "BaselineId": "pb-0123456789abcdef0", "Name": "WindowsPatching", "OperatingSystem": "WINDOWS", "GlobalFilters": { "PatchFilters": [] }, "ApprovalRules": { "PatchRules": [ { "PatchFilterGroup": { "PatchFilters": [ { "Key": "PRODUCT", "Values": [ "WindowsServer2016" ] } ] }, "ComplianceLevel": "CRITICAL", "ApproveAfterDays": 0, "EnableNonSecurity": false } ] }, "ApprovedPatches": [ "KB2124261" ], "ApprovedPatchesComplianceLevel": "UNSPECIFIED", "ApprovedPatchesEnableNonSecurity": false, "RejectedPatches": [ "KB2032276", "MS10-048" ], "RejectedPatchesAction": "ALLOW_AS_DEPENDENCY", "CreatedDate": 1550244180.465, "ModifiedDate": 1550244180.465, "Description": "Patches for Windows Servers", "Sources": [] }

Exemple 2 : renommer un référentiel de correctifs

L’exemple de update-patch-baseline suivant renomme le référentiel de correctifs spécifié.

aws ssm update-patch-baseline \ --baseline-id "pb-0713accee01234567" \ --name "Windows-Server-2012-R2-Important-and-Critical-Security-Updates"

Pour plus d'informations, voir Mettre à jour ou supprimer une ligne de base de correctifs < https://docs.aws.amazon.com/systems-manager/ latest/userguide/patch - baseline-update-or-delete .html>`__ dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous UpdatePatchBaselineà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-patch-baseline.

AWS CLI

Exemple 1 : mise à jour d’un référentiel de correctifs

L’exemple de update-patch-baseline suivant ajoute les deux correctifs spécifiés comme rejetés et un correctif comme approuvé au référentiel de correctifs spécifié.

aws ssm update-patch-baseline \ --baseline-id "pb-0123456789abcdef0" \ --rejected-patches "KB2032276" "MS10-048" \ --approved-patches "KB2124261"

Sortie :

{ "BaselineId": "pb-0123456789abcdef0", "Name": "WindowsPatching", "OperatingSystem": "WINDOWS", "GlobalFilters": { "PatchFilters": [] }, "ApprovalRules": { "PatchRules": [ { "PatchFilterGroup": { "PatchFilters": [ { "Key": "PRODUCT", "Values": [ "WindowsServer2016" ] } ] }, "ComplianceLevel": "CRITICAL", "ApproveAfterDays": 0, "EnableNonSecurity": false } ] }, "ApprovedPatches": [ "KB2124261" ], "ApprovedPatchesComplianceLevel": "UNSPECIFIED", "ApprovedPatchesEnableNonSecurity": false, "RejectedPatches": [ "KB2032276", "MS10-048" ], "RejectedPatchesAction": "ALLOW_AS_DEPENDENCY", "CreatedDate": 1550244180.465, "ModifiedDate": 1550244180.465, "Description": "Patches for Windows Servers", "Sources": [] }

Exemple 2 : renommer un référentiel de correctifs

L’exemple de update-patch-baseline suivant renomme le référentiel de correctifs spécifié.

aws ssm update-patch-baseline \ --baseline-id "pb-0713accee01234567" \ --name "Windows-Server-2012-R2-Important-and-Critical-Security-Updates"

Pour plus d'informations, voir Mettre à jour ou supprimer une ligne de base de correctifs < https://docs.aws.amazon.com/systems-manager/ latest/userguide/patch - baseline-update-or-delete .html>`__ dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous UpdatePatchBaselineà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-resource-data-sync.

AWS CLI

Pour mettre à jour la synchronisation des données d'une ressource

L'update-resource-data-syncexemple suivant met à jour la synchronisation SyncFromSource des données d'une ressource.

aws ssm update-resource-data-sync \ --sync-name exampleSync \ --sync-type SyncFromSource \ --sync-source '{"SourceType":"SingleAccountMultiRegions", "SourceRegions":["us-east-1", "us-west-2"]}'

Cette commande ne produit aucun résultat.

Pour plus d'informations, reportez-vous à la section Configuration de Systems Manager Explorer pour afficher les données de plusieurs comptes et régions dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous UpdateResourceDataSyncà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-resource-data-sync.

AWS CLI

Pour mettre à jour la synchronisation des données d'une ressource

L'update-resource-data-syncexemple suivant met à jour la synchronisation SyncFromSource des données d'une ressource.

aws ssm update-resource-data-sync \ --sync-name exampleSync \ --sync-type SyncFromSource \ --sync-source '{"SourceType":"SingleAccountMultiRegions", "SourceRegions":["us-east-1", "us-west-2"]}'

Cette commande ne produit aucun résultat.

Pour plus d'informations, reportez-vous à la section Configuration de Systems Manager Explorer pour afficher les données de plusieurs comptes et régions dans le Guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous UpdateResourceDataSyncà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-service-setting.

AWS CLI

Pour mettre à jour le paramètre de service pour le débit du Parameter Store

L'update-service-settingexemple suivant met à jour le paramètre de service actuel pour le débit du Parameter Store dans la région spécifiée afin d'utiliser un débit accru.

aws ssm update-service-setting \ --setting-id arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled \ --setting-value true

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Increasing Parameter Store Throughput dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous UpdateServiceSettingà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-service-setting.

AWS CLI

Pour mettre à jour le paramètre de service pour le débit du Parameter Store

L'update-service-settingexemple suivant met à jour le paramètre de service actuel pour le débit du Parameter Store dans la région spécifiée afin d'utiliser un débit accru.

aws ssm update-service-setting \ --setting-id arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled \ --setting-value true

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Increasing Parameter Store Throughput dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour plus de détails sur l'API, reportez-vous UpdateServiceSettingà la section Référence des AWS CLI commandes.

Sur cette page

Rubrique suivante :

Amazon Textract

Rubrique précédente :

Amazon SWF
ConfidentialitéConditions d'utilisation du sitePréférences de cookies
© 2025, Amazon Web Services, Inc. ou ses affiliés. Tous droits réservés.