Ejemplos de Systems Manager que utilizan AWS CLI - AWS SDKEjemplos de código

Hay más AWS SDK ejemplos disponibles en el GitHub repositorio de AWS Doc SDK Examples.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Ejemplos de Systems Manager que utilizan AWS CLI

Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes AWS Command Line Interface mediante Systems Manager.

Las acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las funciones de servicio individuales, es posible ver las acciones en contexto en los escenarios relacionados.

Cada ejemplo incluye un enlace al código fuente completo, donde puede encontrar instrucciones sobre cómo configurar y ejecutar el código en su contexto.

Acciones

En el siguiente ejemplo de código se muestra cómo usar add-tags-to-resource.

AWS CLI

Ejemplo 1: adición de etiquetas a un periodo de mantenimiento

En el siguiente ejemplo de add-tags-to-resource se agrega una etiqueta al periodo de mantenimiento especificado.

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

Este comando no genera ninguna salida.

Ejemplo 2: adición de etiquetas a un parámetro

En el siguiente ejemplo de add-tags-to-resource se agregan dos etiquetas al parámetro especificado.

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

Este comando no genera ninguna salida.

Ejemplo 3: Para añadir etiquetas a un SSM documento

En el siguiente ejemplo de add-tags-to-resource se agrega una etiqueta al documento especificado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Etiquetado de recursos de Systems Manager en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte AddTagsToResourcela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar associate-ops-item-related-item.

AWS CLI

Para asociar un elemento relacionado

El siguiente associate-ops-item-related-item ejemplo asocia un elemento relacionado al 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"

Salida:

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

Para obtener más información, consulte Trabajar con incidentes de Incident Manager OpsCenter en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar cancel-command.

AWS CLI

Ejemplo 1: cancelación de un comando para todas las instancias

En el siguiente ejemplo de cancel-command se intenta cancelar el comando especificado que ya se está ejecutando en todas las instancias.

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

Este comando no genera ninguna salida.

Ejemplo 2: cancelación de un comando para instancias específicas

En el siguiente ejemplo de cancel-command se intenta cancelar un comando únicamente en la instancia especificada.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Etiquetado de parámetros de Systems Manager en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte CancelCommandla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar cancel-maintenance-window-execution.

AWS CLI

Para cancelar la ejecución de una ventana de mantenimiento

Este cancel-maintenance-window-execution ejemplo detiene la ejecución de la ventana de mantenimiento especificada que ya está en curso.

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

Salida:

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

Para obtener más información, consulte los tutoriales de Windows sobre mantenimiento de Systems Manager (AWS CLI) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar create-activation.

AWS CLI

Creación de la activación de una instancia administrada

En el siguiente ejemplo de create-activation se crea la activación de una instancia administrada.

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

Salida:

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

Para obtener más información, consulte Paso 4: crear una activación híbrida para un entorno híbrido y multinube en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte CreateActivationla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar create-association-batch.

AWS CLI

Creación de varias asociaciones

En este ejemplo se asocia un documento de configuración a varias instancias. El resultado devuelve una lista de operaciones correctas y con errores, si corresponde.

Comando:

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

Salida:

{ "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": [] }

En el siguiente ejemplo de código se muestra cómo usar create-association.

AWS CLI

Ejemplo 1: Para asociar un documento mediante una instancia IDs

En este ejemplo, se asocia un documento de configuración a una instancia, utilizando instanceIDs.

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

Salida:

{ "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" } ] } }

Para obtener más información, consulte CreateAssociationla APIReferencia AWS de Systems Manager.

Ejemplo 2: asociación de un documento mediante destinos

En este ejemplo, se asocia un documento de configuración a una instancia mediante destinos.

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

Salida:

{ "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" } ] } }

Para obtener más información, consulte CreateAssociationla APIReferencia AWS de Systems Manager.

Ejemplo 3: creación de una asociación que solo se ejecuta una vez

En este ejemplo se crea una nueva asociación que solo se ejecuta una vez en la fecha y hora especificadas. Las asociaciones creadas con una fecha en el pasado o en el presente (cuando se procesan, la fecha queda en el pasado) se ejecutan inmediatamente.

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

Salida:

{ "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" } ] } }

Para obtener más información, consulte CreateAssociationla Referencia de AWS Systems Manager o API Referencia: expresiones de cron y velocidad para Systems Manager en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte CreateAssociationla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar create-document.

AWS CLI

Creación de un documento

En el siguiente ejemplo de create-document se crea un documento de Systems Manager.

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

Salida:

{ "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": [] } }

Para obtener más información, consulte Crear contenido en el documento de SSM en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte CreateDocumentla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar create-maintenance-window.

AWS CLI

Ejemplo 1: creación de un periodo de mantenimiento

En el siguiente ejemplo de create-maintenance-window se crea un nuevo periodo de mantenimiento que, cada cinco minutos durante un máximo de dos horas (según sea necesario), impide que se inicien nuevas tareas una hora después de que finalice el periodo de mantenimiento, permite los destinos no asociados (instancias que no ha registrado con el periodo de mantenimiento) e indica, mediante el uso de etiquetas personalizadas, que su creador tiene la intención de utilizarlo en un tutorial.

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"

Salida:

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

Ejemplo 2: creación de un periodo de mantenimiento que se ejecuta solo una vez

En el siguiente ejemplo de create-maintenance-window se crea un nuevo periodo de mantenimiento que solo se ejecuta una vez en la fecha y hora especificadas.

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"

Salida:

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

Para obtener más información, consulte Maintenance Windows en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar create-ops-item.

AWS CLI

Para crear un OpsItems

En el siguiente create-ops-item ejemplo, se utiliza una the /aws/resources clave OperationalData para crear un OpsItem recurso relacionado con 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"

Salida:

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

Para obtener más información, consulte Creación OpsItems en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte CreateOpsItemla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar create-patch-baseline.

AWS CLI

Ejemplo 1: creación de una línea de base de revisiones con aprobación automática

En el siguiente ejemplo de create-patch-baseline se crea una línea de base de revisiones para Windows Server que aprueba las revisiones de un entorno de producción siete días después de que Microsoft las publique.

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"

Salida:

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

Ejemplo 2: creación de una línea de base de revisiones con una fecha límite de aprobación

En el siguiente ejemplo de create-patch-baseline se crea una línea de base de revisiones para Windows Server que aprueba todas las revisiones de un entorno de producción que se publicaron el 7 de julio del 2020 o antes.

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"

Salida:

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

Ejemplo 3: Para crear una línea base de parches con las reglas de aprobación almacenadas en un JSON archivo

En el siguiente ejemplo de create-patch-baseline se crea una línea de base de revisiones para Amazon Linux 2017.09 que aprueba las revisiones de un entorno de producción siete días después de su publicación, especifica las reglas de aprobación para la línea de base de revisiones y especifica un repositorio personalizado para las revisiones.

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

Contenidos 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" } ] }

Ejemplo 4: creación de una línea de base de revisiones que especifica las revisiones aprobadas y rechazadas

En el siguiente ejemplo de create-patch-baseline se especifican de forma explícita las revisiones que se deben aprobar y rechazar como excepción a las reglas de aprobación predeterminadas.

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"

Para obtener más información, consulte Creación de una línea de base de revisiones personalizada en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte CreatePatchBaselinela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar create-resource-data-sync.

AWS CLI

Para crear una sincronización de datos de recursos

En este ejemplo, se crea una sincronización de datos de recursos. No se obtienen resultados si el comando se ejecuta correctamente.

Comando:

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"

En el siguiente ejemplo de código se muestra cómo usar delete-activation.

AWS CLI

Eliminación de la activación de una instancia administrada

En el siguiente ejemplo de delete-activation se elimina la activación de una instancia administrada.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Configuración de AWS Systems Manager para entornos híbridos en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte DeleteActivationla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar delete-association.

AWS CLI

Ejemplo 1: eliminación de una asociación mediante el ID de asociación

En el siguiente ejemplo de delete-association se elimina la asociación del ID de asociación especificado. No se obtienen resultados si el comando se ejecuta correctamente.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Edición y creación de una nueva versión de una asociación en la Guía del usuario de AWS Systems Manager.

Ejemplo 2: eliminación de una asociación

En el siguiente ejemplo de delete-association se elimina la asociación entre una instancia y un documento. No se obtienen resultados si el comando se ejecuta correctamente.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Trabajo con asociaciones en Systems Manager en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte DeleteAssociationla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar delete-document.

AWS CLI

Eliminación de un documento

En el siguiente ejemplo de delete-document se elimina un documento de Systems Manager.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Crear contenido en el documento de SSM en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte DeleteDocumentla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar delete-inventory.

AWS CLI

Para eliminar un tipo de inventario personalizado

En este ejemplo, se elimina un esquema de inventario personalizado.

Comando:

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

Salida:

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

Para deshabilitar un tipo de inventario personalizado

En este ejemplo, se inhabilita un esquema de inventario personalizado.

Comando:

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

Salida:

{ "DeletionId": "6961492a-8163-44ec-aa1e-923364dd0850", "TypeName": "Custom:RackInformation", "DeletionSummary": { "TotalCount": 0, "RemainingCount": 0, "SummaryItems": [] } }
  • Para API obtener más información, consulte DeleteInventoryla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar delete-maintenance-window.

AWS CLI

Eliminación de un periodo de mantenimiento

En este ejemplo de delete-maintenance-window se elimina el periodo de mantenimiento especificado.

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

Salida:

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

Para obtener más información, consulte Eliminar una ventana de mantenimiento (AWS CLI) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar delete-parameter.

AWS CLI

Eliminación de un parámetro

En el siguiente ejemplo de delete-parameter se elimina el parámetro único especificado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Uso de Parameter Store en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte DeleteParameterla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar delete-parameters.

AWS CLI

Para eliminar una lista de parámetros

En el siguiente delete-parameters ejemplo, se eliminan los parámetros especificados.

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

Salida:

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

Para obtener más información, consulte Uso de Parameter Store en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte DeleteParametersla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar delete-patch-baseline.

AWS CLI

Eliminación de una línea de base de revisiones

En el siguiente ejemplo de delete-patch-baseline se elimina la línea de base de revisiones especificada.

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

Salida:

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

Para obtener más información, consulte Actualización o eliminación de una línea de base de revisiones (consola) en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte DeletePatchBaselinela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar delete-resource-data-sync.

AWS CLI

Para eliminar la sincronización de datos de un recurso

En este ejemplo, se elimina la sincronización de datos de un recurso. No se obtienen resultados si el comando se ejecuta correctamente.

Comando:

aws ssm delete-resource-data-sync --sync-name "ssm-resource-data-sync"

En el siguiente ejemplo de código se muestra cómo usar deregister-managed-instance.

AWS CLI

Anulación del registro de una instancia administrada

En el siguiente ejemplo de deregister-managed-instance se anula el registro de la instancia administrada especificada.

aws ssm deregister-managed-instance --instance-id "mi-08ab247cdfEXAMPLE"

Este comando no genera ninguna salida.

Para obtener más información, consulte Anulación del registro de nodos administrados en un entorno híbrido y multinube en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar deregister-patch-baseline-for-patch-group.

AWS CLI

Anulación del registro de un grupo de revisiones de una línea de base de revisiones

En el siguiente ejemplo de deregister-patch-baseline-for-patch-group se anula el registro del grupo de revisiones especificado de la línea de base de revisiones.

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

Salida:

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

Para obtener más información, consulte Añadir un grupo de revisiones a una línea de base de revisiones en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar deregister-target-from-maintenance-window.

AWS CLI

Eliminación de un destino de un periodo de mantenimiento

En el siguiente ejemplo de deregister-target-from-maintenance-window, se elimina el destino especificado del periodo de mantenimiento especificado.

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

Salida:

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

Para obtener más información, consulte Actualizar una ventana de mantenimiento (AWS CLI) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar deregister-task-from-maintenance-window.

AWS CLI

Eliminación de una tarea de un periodo de mantenimiento

En el siguiente ejemplo de deregister-task-from-maintenance-window se elimina la tarea especificada del periodo de mantenimiento especificado.

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

Salida:

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

Para obtener más información, consulte los tutoriales de Windows sobre mantenimiento de Systems Manager (AWS CLI) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar describe-activations.

AWS CLI

Descripción de las activaciones

En el siguiente describe-activations ejemplo, se muestran detalles sobre las activaciones de su AWS cuenta.

aws ssm describe-activations

Salida:

{ "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 }, ] }

Para obtener más información, consulte Paso 4: crear una activación híbrida para un entorno híbrido y multinube en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte DescribeActivationsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar describe-association-execution-targets.

AWS CLI

Obtención de detalles de la ejecución de una asociación

En el siguiente ejemplo de describe-association-execution-targets se describe la ejecución de la asociación especificada.

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

Salida:

{ "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" } } ] }

Para obtener más información, consulte Visualización de los historiales de asociación en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar describe-association-executions.

AWS CLI

Ejemplo 1: obtención de detalles de todas las ejecuciones de una asociación

En el siguiente ejemplo de describe-association-executions se describen todas las ejecuciones de la asociación especificada.

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

Salida:

{ "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}" }, ... ] }

Para obtener más información, consulte Visualización de los historiales de asociación en la Guía del usuario de AWS Systems Manager.

Ejemplo 2: obtención de detalles de todas las ejecuciones de una asociación después de una fecha y hora específicas

En el siguiente ejemplo de describe-association-executions se describen todas las ejecuciones de una asociación después de la fecha y hora especificadas.

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

Salida:

{ "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}" }, ... ] }

Para obtener más información, consulte Visualización de los historiales de asociación en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar describe-association.

AWS CLI

Ejemplo 1: obtención de los detalles de una asociación

En el siguiente ejemplo de describe-association se describe la asociación del ID de asociación especificado.

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

Salida:

{ "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" } }

Para obtener más información, consulte Edición y creación de una nueva versión de una asociación en la Guía del usuario de AWS Systems Manager.

Ejemplo 2: obtención de los detalles de una asociación para una instancia y un documento específicos

En el siguiente ejemplo de describe-association se describe la asociación entre una instancia y un documento.

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

Salida:

{ "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" } ] } }

Para obtener más información, consulte Edición y creación de una nueva versión de una asociación en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte DescribeAssociationla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar describe-automation-executions.

AWS CLI

Descripción de una ejecución de automatización

En el siguiente ejemplo de describe-automation-executions se muestran detalles sobre una ejecución de Automatización.

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

Salida:

{ "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" } ] }

Para obtener más información, consulte Ejecución de una automatización sencilla en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar describe-automation-step-executions.

AWS CLI

Ejemplo 1: descripción de todos los pasos de una ejecución de automatización

En el siguiente ejemplo de describe-automation-step-executions se muestran detalles sobre los pasos de una ejecución de Automatización.

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

Salida:

{ "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": {} } ] }

Ejemplo 2: descripción de un paso concreto de una ejecución de automatización

En el siguiente ejemplo de describe-automation-step-executions se muestran detalles sobre un paso específico de una ejecución de Automatización.

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

Para obtener más información, consulte Running an Automation Workflow Step by Step (Command Line) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar describe-available-patches.

AWS CLI

Obtención de las revisiones disponibles

En el siguiente describe-available-patches ejemplo, se obtienen detalles sobre todos los parches disponibles para Windows Server 2019 que tienen una MSRC gravedad crítica.

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

Salida:

{ "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" }, ... ] }

Obtención de detalles de una revisión específica

En el siguiente ejemplo de describe-available-patches se recuperan los detalles sobre la revisión especificada.

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

Salida:

{ "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" } ] }

Para obtener más información, consulte Cómo funcionan las operaciones de Patch Manager en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar describe-document-permission.

AWS CLI

Descripción de los permisos de los documentos

En el siguiente ejemplo de describe-document-permission se muestran los detalles de los permisos sobre un documento de Systems Manager que se comparte públicamente.

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

Salida:

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

Para obtener más información, consulte Compartir un documento de Systems Manager en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar describe-document.

AWS CLI

Visualización de los detalles de un documento

En el siguiente describe-document ejemplo, se muestran detalles sobre un documento de Systems Manager de su AWS cuenta.

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

Salida:

{ "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": [] } }

Para obtener más información, consulte Crear contenido en el documento de SSM en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte DescribeDocumentla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar describe-effective-instance-associations.

AWS CLI

Obtención de los detalles de las asociaciones efectivas de una instancia

En el siguiente ejemplo de describe-effective-instance-associations se recuperan los detalles sobre las asociaciones efectivas de una instancia.

Comando:

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

Salida:

{ "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" } ] }

En el siguiente ejemplo de código se muestra cómo usar describe-effective-patches-for-patch-baseline.

AWS CLI

Ejemplo 1: obtención de todas las revisiones definidas por una línea de base de revisiones personalizada

El siguiente describe-effective-patches-for-patch-baseline ejemplo devuelve los parches definidos por una línea base de parches personalizada en la AWS cuenta corriente. Tenga en cuenta que, para una línea de base personalizada, solo se requiere el ID para --baseline-id.

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

Salida:

{ "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--" }

Ejemplo 2: Para definir todos los parches mediante una línea base de parches AWS gestionada

El siguiente describe-effective-patches-for-patch-baseline ejemplo devuelve los parches definidos por una línea base de parches AWS gestionada. Tenga en cuenta que, en el caso de una línea base AWS gestionada, ARN es necesaria la línea base completa para --baseline-id

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

Consulte el ejemplo 1 para ver una salida de muestra.

Para obtener más información, consulte Cómo se seleccionan las revisiones de seguridad en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar describe-instance-associations-status.

AWS CLI

Descripción del estado de las asociaciones de una instancia

En este ejemplo se muestran los detalles de las asociaciones de una instancia.

Comando:

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

Salida:

{ "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" } ] }

En el siguiente ejemplo de código se muestra cómo usar describe-instance-information.

AWS CLI

Ejemplo 1: descripción de la información de las instancias administradas

En el siguiente ejemplo de describe-instance-information se recuperan los detalles de cada una de las instancias administradas.

aws ssm describe-instance-information

Ejemplo 2: descripción de la información sobre una instancia administrada específica

En el siguiente ejemplo de describe-instance-information se muestran los detalles de la instancia administrada i-028ea792daEXAMPLE.

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

Ejemplo 3: descripción de la información sobre las instancias administradas con una clave de etiqueta específica

En el siguiente ejemplo de describe-instance-information se muestran los detalles de las instancias administradas que tienen la clave de etiqueta DEV.

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

Salida:

{ "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 } } } ] }

Para obtener más información, consulte Managed Instances en la Guía del usuario de AWS .

En el siguiente ejemplo de código se muestra cómo usar describe-instance-patch-states-for-patch-group.

AWS CLI

Ejemplo 1: obtención de los estados de las instancias de un grupo de revisiones

En el siguiente ejemplo de describe-instance-patch-states-for-patch-group se obtienen detalles sobre los estados resumidos de las revisiones por instancia en el grupo de revisiones especificado.

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

Salida:

{ "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 } ] }

Ejemplo 2: obtención de los estados de las instancias de un grupo de revisiones al que le faltan más de cinco revisiones

En el siguiente ejemplo de describe-instance-patch-states-for-patch-group se obtienen detalles sobre los estados resumidos de las revisiones del grupo de revisiones especificado en las instancias a las que les faltan más de cinco revisiones.

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

Salida:

{ "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 } ] }

Ejemplo 3: obtención de los estados de las instancias de un grupo de revisiones con menos de diez instancias que requieren un reinicio

En el siguiente ejemplo de describe-instance-patch-states-for-patch-group se obtienen detalles sobre los estados resumidos de las revisiones del grupo de revisiones especificado en las instancias con menos de diez instancias que requieren un reinicio.

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

Salida:

{ "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 } ] }

Para obtener más información, consulte Conocimiento de los valores del estado de conformidad de parches en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar describe-instance-patch-states.

AWS CLI

Obtención de los estados resumidos de las revisiones en instancias

En este ejemplo de describe-instance-patch-states se obtienen los estados resumidos de las revisiones en una instancia.

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

Salida:

{ "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" } ] }

Para obtener más información, consulte Conocimiento de los valores del estado de conformidad de parches en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar describe-instance-patches.

AWS CLI

Ejemplo 1: obtención de los detalles del estado de una revisión en una instancia

En el siguiente ejemplo de describe-instance-patches se recuperan los detalles sobre la instancia especificada.

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

Salida:

{ "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--" }

Ejemplo 2: obtención de una lista de las revisiones que se encuentran en el estado Faltante en una instancia

En el siguiente ejemplo de describe-instance-patches se recupera información sobre las revisiones que se encuentran en el estado Falta en la instancia especificada.

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

Salida:

{ "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--" }

Para obtener más información, consulte Conocimiento de los valores del estado de conformidad de parches en la Guía del usuario de AWS Systems Manager.

Ejemplo 3: Para obtener una lista de los parches instalados desde una instancia especificada InstalledTime

En el siguiente ejemplo de describe-instance-patches se recupera información sobre las revisiones instaladas desde un tiempo específico en la instancia especificada combinando el uso de --filters y --query.

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

Salida:

{ "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--" }

En el siguiente ejemplo de código se muestra cómo usar describe-inventory-deletions.

AWS CLI

Para obtener información sobre las eliminaciones de inventario

En este ejemplo, se recuperan los detalles de las operaciones de eliminación de inventario.

Comando:

aws ssm describe-inventory-deletions

Salida:

{ "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 } ] }

Para obtener detalles de una eliminación de inventario específica

En este ejemplo, se recuperan los detalles de una operación de eliminación de inventario específica.

Comando:

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

Salida:

{ "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 } ] }

En el siguiente ejemplo de código se muestra cómo usar describe-maintenance-window-execution-task-invocations.

AWS CLI

Obtención de las invocaciones de tareas específicas hechas para la ejecución de una tarea en un periodo de mantenimiento

En el siguiente ejemplo de describe-maintenance-window-execution-task-invocations se muestran las invocaciones de la tarea especificada que se ejecutó como parte de la ejecución del periodo de mantenimiento especificado.

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

Salida:

{ "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" } ] }

Para obtener más información, consulte Ver información sobre tareas y ejecuciones de tareas (AWS CLI) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar describe-maintenance-window-execution-tasks.

AWS CLI

Enumeración de todas las tareas asociadas a la ejecución de un periodo de mantenimiento

En el siguiente ejemplo de ssm describe-maintenance-window-execution-tasks se enumeran todas las tareas asociadas a la ejecución del periodo de mantenimiento especificado.

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

Salida:

{ "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" } ] }

Para obtener más información, consulte Ver información sobre tareas y ejecuciones de tareas (AWS CLI) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar describe-maintenance-window-executions.

AWS CLI

Ejemplo 1: enumeración de todas las ejecuciones de un periodo de mantenimiento

En el siguiente ejemplo de describe-maintenance-window-executions se enumeran todas las ejecuciones del periodo de mantenimiento especificado.

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

Salida:

{ "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" } ] }

Ejemplo 2: enumeración de todas las ejecuciones de un periodo de mantenimiento antes de una fecha especificada

En el siguiente ejemplo de describe-maintenance-window-executions se enumeran todas las ejecuciones del periodo de mantenimiento especificado antes de la fecha especificada.

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

Salida:

{ "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" } ] }

Ejemplo 3: enumeración de todas las ejecuciones de un periodo de mantenimiento después de una fecha especificada

En el siguiente ejemplo de describe-maintenance-window-executions se enumeran todas las ejecuciones del periodo de mantenimiento especificado después de la fecha especificada.

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

Salida:

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

Para obtener más información, consulte Ver información sobre tareas y ejecuciones de tareas (AWS CLI) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar describe-maintenance-window-schedule.

AWS CLI

Ejemplo 1: Para enumerar las próximas ejecuciones de un período de mantenimiento

En el siguiente describe-maintenance-window-schedule ejemplo, se enumeran todas las próximas ejecuciones del período de mantenimiento especificado.

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

Salida:

{ "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" }, ... ] }

Ejemplo 2: Para enumerar todas las próximas ejecuciones de un período de mantenimiento antes de una fecha específica

En el siguiente describe-maintenance-window-schedule ejemplo, se enumeran todas las próximas ejecuciones del período de mantenimiento especificado que se produzcan antes de la fecha especificada.

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

Ejemplo 3: Para enumerar todas las próximas ejecuciones de un período de mantenimiento después de una fecha específica

En el siguiente describe-maintenance-window-schedule ejemplo, se enumeran todas las próximas ejecuciones del período de mantenimiento especificado que se produzcan después de la fecha especificada.

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

Para obtener más información, consulte Ver información sobre el mantenimiento de Windows (AWS CLI) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar describe-maintenance-window-targets.

AWS CLI

Ejemplo 1: enumeración de todos los destinos de un periodo de mantenimiento

En el siguiente ejemplo de describe-maintenance-window-targets se enumeran todos los destinos de un periodo de mantenimiento.

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

Salida:

{ "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" } ] }

Ejemplo 2: enumeración de todos los destinos de un periodo de mantenimiento que coincida con un valor específico de información del propietario

En este ejemplo de describe-maintenance-window-targets se enumeran todos los destinos de un periodo de mantenimiento con un valor específico.

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

Salida:

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

Para obtener más información, consulte Ver información sobre el mantenimiento de Windows (AWS CLI) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar describe-maintenance-window-tasks.

AWS CLI

Ejemplo 1: enumeración de todas las tareas de un periodo de mantenimiento

En el siguiente ejemplo de describe-maintenance-window-tasks se enumeran todas las tareas del periodo de mantenimiento especificado.

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

Salida:

{ "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" ] } ] } ] }

Ejemplo 2: Para enumerar todas las tareas de una ventana de mantenimiento que invoca el documento de RunPowerShellScript comando AWS-

En el siguiente ejemplo de describe-maintenance-window-tasks se enumeran todas las tareas del periodo de mantenimiento especificado que invoca el documento de comandos AWS-RunPowerShellScript.

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

Salida:

{ "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" } ] }

Ejemplo 3: enumeración de todas las tareas de un periodo de mantenimiento que tienen una prioridad de 3

En el siguiente ejemplo de describe-maintenance-window-tasks se enumeran todas las tareas del periodo de mantenimiento especificado que tienen una Priority de 3.

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

Salida:

{ "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" } ] }

Ejemplo 4: enumeración de todas las tareas de un periodo de mantenimiento que tienen una prioridad de 1 y uso del comando de ejecución

En este ejemplo de describe-maintenance-window-tasks se enumeran todas las tareas del periodo de mantenimiento especificado que tienen una Priority de 1 y el uso del Run Command.

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

Salida:

{ "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" } ] }

Para obtener más información, consulte Ver información sobre las ventanas de mantenimiento (AWS CLI) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar describe-maintenance-windows-for-target.

AWS CLI

Para enumerar todas las ventanas de mantenimiento asociadas a una instancia específica

En el siguiente describe-maintenance-windows-for-target ejemplo, se enumeran las ventanas de mantenimiento que tienen objetivos o tareas asociados a la instancia especificada.

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

Salida:

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

Para obtener más información, consulte Ver información sobre el mantenimiento de Windows (AWS CLI) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar describe-maintenance-windows.

AWS CLI

Ejemplo 1: enumeración de todos los periodos de mantenimiento

El siguiente describe-maintenance-windows ejemplo muestra todos los períodos de mantenimiento de su AWS cuenta en la región actual.

aws ssm describe-maintenance-windows

Salida:

{ "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" }, ] }

Ejemplo 2: enumeración de todos los periodos de mantenimiento habilitados

En el siguiente ejemplo de describe-maintenance-windows se enumeran todos los periodos de mantenimiento habilitados.

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

Ejemplo 3: enumeración de los periodos de mantenimiento que coincidan con un nombre específico

En este ejemplo de describe-maintenance-windows se enumeran todos los periodos de mantenimiento con el nombre especificado.

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

Para obtener más información, consulte Ver información sobre el mantenimiento de Windows (AWS CLI) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar describe-ops-items.

AWS CLI

Para enumerar un conjunto de OpsItems

En el siguiente describe-ops-items ejemplo, se muestra una lista de todas OpsItems las AWS cuentas abiertas.

aws ssm describe-ops-items \ --ops-item-filters "Key=Status,Values=Open,Operator=Equal"

Salida:

{ "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" } ] }

Para obtener más información, consulte Trabajar con OpsItems en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte DescribeOpsItemsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar describe-parameters.

AWS CLI

Ejemplo 1: Creación de una lista de todos los parámetros

El siguiente describe-parameters ejemplo muestra todos los parámetros de la AWS cuenta corriente y la región.

aws ssm describe-parameters

Salida:

{ "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": [] } ] }

Ejemplo 2: Creación de una lista de todos los parámetros que coinciden con metadatos específicos

En este ejemplo de describe-parameters se enumeran todos los parámetros que coinciden con un filtro.

aws ssm describe-parameters --filters «Clave=Type, Values=» StringList

Salida:

{ "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": [] } ] }

Para obtener más información, consulte Búsqueda de parámetros de Systems Manager en la Guía del usuario de AWS Systems Manager.

  • APIPara obtener más información, DescribeParametersconsulte AWS CLI la Referencia de comandos.

En el siguiente ejemplo de código se muestra cómo usar describe-patch-baselines.

AWS CLI

Ejemplo 1: enumeración de todas las líneas de base de revisiones

En el siguiente ejemplo de describe-patch-baselines se recuperan los detalles de todas las líneas de base de revisiones de su cuenta en la región actual.

aws ssm describe-patch-baselines

Salida:

{ "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" } ] }

Ejemplo 2: Para enumerar todas las líneas base de parches proporcionadas por AWS

En el siguiente describe-patch-baselines ejemplo se enumeran todas las líneas base de los parches proporcionadas por. AWS

aws ssm describe-patch-baselines \ --filters "Key=OWNER,Values=[AWS]"

Ejemplo 3: enumeración de todas las líneas de base de revisiones de su propiedad

En el siguiente ejemplo de describe-patch-baselines se enumeran todas las líneas de base de revisiones personalizadas creadas en su cuenta en la región actual.

aws ssm describe-patch-baselines \ --filters "Key=OWNER,Values=[Self]"

Para obtener más información, consulte Acerca de las líneas de base de revisiones personalizadas y predefinidas en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar describe-patch-group-state.

AWS CLI

Obtención del estado de un grupo de revisiones

En el siguiente ejemplo de describe-patch-group-state se recupera el resumen general de conformidad de las revisiones de un grupo de revisiones.

aws ssm describe-patch-group-state \ --patch-group "Production"

Salida:

{ "Instances": 21, "InstancesWithCriticalNonCompliantPatches": 1, "InstancesWithFailedPatches": 2, "InstancesWithInstalledOtherPatches": 3, "InstancesWithInstalledPatches": 21, "InstancesWithInstalledPendingRebootPatches": 2, "InstancesWithInstalledRejectedPatches": 1, "InstancesWithMissingPatches": 3, "InstancesWithNotApplicablePatches": 4, "InstancesWithOtherNonCompliantPatches": 1, "InstancesWithSecurityNonCompliantPatches": 1, "InstancesWithUnreportedNotApplicablePatches": 2 }

Para obtener más información, consulte Acerca de los grupos de parches < https://docs.aws.amazon.com/systems-manager/ latest/userguide/sysman -patch-patchgroups.html>__ y Descripción de los valores del estado de conformidad de los parches en la Guía del usuario de Systems Manager.AWS

En el siguiente ejemplo de código se muestra cómo usar describe-patch-groups.

AWS CLI

Visualización de los registros de grupos de revisiones

En el siguiente ejemplo de describe-patch-groups se enumeran los registros de los grupos de revisiones.

aws ssm describe-patch-groups

Salida:

{ "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 } }, ... ] }

Para obtener más información, consulte Creación de un grupo de parches < https://docs.aws.amazon.com/systems-manager/ latest/userguide/sysman - patch-group-tagging .html>__ y Añadir un grupo de parches a una línea base de parches en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte la Referencia de DescribePatchGroupscomandos AWS CLI .

En el siguiente ejemplo de código se muestra cómo usar describe-patch-properties.

AWS CLI

Para enumerar la disponibilidad de parches de Amazon Linux

En el siguiente describe-patch-properties ejemplo, se muestra una lista de los productos de Amazon Linux para los que hay parches disponibles en su AWS cuenta.

aws ssm describe-patch-properties \ --operating-system AMAZON_LINUX \ --property PRODUCT

Salida:

{ "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" } ] }

Para obtener más información, consulte Acerca de las líneas de base de revisiones en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar describe-sessions.

AWS CLI

Ejemplo 1: Para enumerar todas las sesiones activas del Administrador de sesiones

En este describe-sessions ejemplo, se recupera una lista de las sesiones activas que se crearon más recientemente (tanto las sesiones conectadas como las desconectadas) en los últimos 30 días y que fueron iniciadas por el usuario especificado. Este comando devuelve solo los resultados de las conexiones a destinos iniciadas mediante el Administrador de sesiones. No muestra las conexiones realizadas a través de otros medios, como las conexiones a escritorio remoto oSSH.

aws ssm describe-sessions \ --state "Active" \ --filters "key=Owner,value=arn:aws:sts::123456789012:assumed-role/Administrator/Shirley-Rodriguez"

Salida:

{ "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": {} } ] }

Ejemplo 2: Para enumerar todas las sesiones del Administrador de sesiones terminadas

En este describe-sessions ejemplo, se recupera una lista de las sesiones finalizadas más recientemente en los últimos 30 días para todos los usuarios.

aws ssm describe-sessions \ --state "History"

Salida:

{ "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--" }

Para obtener más información, consulte Ver el historial de sesiones en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte DescribeSessionsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar disassociate-ops-item-related-item.

AWS CLI

Para eliminar una asociación de artículos relacionados

En el siguiente disassociate-ops-item-related-item ejemplo, se elimina la asociación entre el elemento OpsItem y un elemento relacionado.

aws ssm disassociate-ops-item-related-item \ --ops-item-id "oi-f99f2EXAMPLE" \ --association-id "e2036148-cccb-490e-ac2a-390e5EXAMPLE"

Este comando no genera ninguna salida.

Para obtener más información, consulte Trabajar con incidentes de Incident Manager OpsCenter en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar get-automation-execution.

AWS CLI

Visualización de los detalles sobre una ejecución de automatización

En el siguiente ejemplo de get-automation-execution se muestra información detallada sobre una ejecución de Automatización.

aws ssm get-automation-execution \ --automation-execution-id 73c8eef8-f4ee-4a05-820c-e354fEXAMPLE

Salida:

{ "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 } } }

Para obtener más información, consulte Tutorial: Parchear un Linux AMI (AWS CLI) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar get-calendar-state.

AWS CLI

Ejemplo 1: Para obtener el estado actual de un calendario de cambios

En este get-calendar-state ejemplo se devuelve el estado de un calendario en el momento actual. Como en el ejemplo no se especifica una hora, se informa del estado actual del calendario.

aws ssm get-calendar-state \ --calendar-names "MyCalendar"

Salida:

{ "State": "OPEN", "AtTime": "2020-02-19T22:28:51Z", "NextTransitionTime": "2020-02-24T21:15:19Z" }

Ejemplo 2: Para obtener el estado de un calendario de cambios a una hora específica

En este get-calendar-state ejemplo se devuelve el estado de un calendario a la hora especificada.

aws ssm get-calendar-state \ --calendar-names "MyCalendar" \ --at-time "2020-07-19T21:15:19Z"

Salida:

{ "State": "CLOSED", "AtTime": "2020-07-19T21:15:19Z" }

Para obtener más información, consulte Obtener el estado del calendario de cambios en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte GetCalendarStatela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar get-command-invocation.

AWS CLI

Visualización de los detalles de la invocación de un comando

En el siguiente ejemplo de get-command-invocation se muestran todas las invocaciones del comando especificado en la instancia especificada.

aws ssm get-command-invocation \ --command-id "ef7fdfd8-9b57-4151-a15c-db9a12345678" \ --instance-id "i-1234567890abcdef0"

Salida:

{ "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 } }

Para obtener más información, consulte Descripción de los estados del comando en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte GetCommandInvocationla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar get-connection-status.

AWS CLI

Visualización del estado de conexión de una instancia administrada

En este ejemplo de get-connection-status se devuelve el estado de conexión de la instancia administrada especificada.

aws ssm get-connection-status \ --target i-1234567890abcdef0

Salida:

{ "Target": "i-1234567890abcdef0", "Status": "connected" }
  • Para API obtener más información, consulte GetConnectionStatusla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar get-default-patch-baseline.

AWS CLI

Ejemplo 1: visualización de la línea de base de revisiones de Windows predeterminada

En el siguiente ejemplo de get-default-patch-baseline se recuperan los detalles de la línea de base de revisiones predeterminada para Windows Server.

aws ssm get-default-patch-baseline

Salida:

{ "BaselineId": "pb-0713accee01612345", "OperatingSystem": "WINDOWS" }

Ejemplo 2: visualización de la línea de base de revisiones predeterminada para Amazon Linux

En el siguiente ejemplo de get-default-patch-baseline se recuperan los detalles de la línea de base de revisiones predeterminada para Amazon Linux.

aws ssm get-default-patch-baseline \ --operating-system AMAZON_LINUX

Salida:

{ "BaselineId": "pb-047c6eb9c8fc12345", "OperatingSystem": "AMAZON_LINUX" }

Para obtener más información, consulte Acerca de las líneas base de parches predefinidas y personalizadas < https://docs.aws.amazon.com/systems-manager/ latest/userguide/sysman -patch-baselines.html>__ y Establecer una línea base de parche existente como predeterminada en la Guía del usuario de Systems Manager.AWS

En el siguiente ejemplo de código se muestra cómo usar get-deployable-patch-snapshot-for-instance.

AWS CLI

Recuperación de la instantánea actual de la línea de base de revisiones que usa una instancia

En el siguiente ejemplo de get-deployable-patch-snapshot-for-instance se recuperan los detalles de la instantánea actual correspondiente a la línea de base de revisiones especificada que usa una instancia. Este comando debe ejecutarse desde la instancia con las credenciales de la instancia. Para asegurarse de que usa las credenciales de la instancia, ejecute aws configure y especifique solo la región de la instancia. Deje vacíos los campos Access Key y Secret Key.

Consejo: Use uuidgen para generar un snapshot-id.

aws ssm get-deployable-patch-snapshot-for-instance \ --instance-id "i-1234567890abcdef0" \ --snapshot-id "521c3536-930c-4aa9-950e-01234567abcd"

Salida:

{ "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" }

Para obtener más información, consulte Nombre del parámetro: Snapshot ID en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar get-document.

AWS CLI

Obtención del contenido de un documento

En el siguiente ejemplo de get-document se muestra el contenido de un documento de Systems Manager.

aws ssm get-document \ --name "AWS-RunShellScript"

Salida:

{ "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" }

Para obtener más información, consulte Documentos de AWS Systems Manager en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte GetDocumentla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar get-inventory-schema.

AWS CLI

Visualización del esquema del inventario

En este ejemplo se obtiene una lista con los nombres de los tipos de inventario de la cuenta.

Comando:

aws ssm get-inventory-schema

Salida:

{ "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--" }

Visualización del esquema de inventario de un tipo de inventario específico

En este ejemplo se devuelve el esquema de inventario para un tipo de inventario de AWS componentes. AWS

Comando:

aws ssm get-inventory-schema --type-name "AWS:AWSComponent"
  • Para API obtener más información, consulte GetInventorySchemala Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar get-inventory.

AWS CLI

Visualización del inventario

En este ejemplo se obtienen los metadatos personalizados del inventario.

Comando:

aws ssm get-inventory

Salida:

{ "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" } ] }
  • Para API obtener más información, consulte GetInventoryla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar get-maintenance-window-execution-task-invocation.

AWS CLI

Para obtener información sobre la invocación de una tarea de una ventana de mantenimiento

En el siguiente get-maintenance-window-execution-task-invocation ejemplo, se muestra información sobre la invocación de la tarea especificada que forma parte de la ejecución del período de mantenimiento especificado.

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"

Salida:

{ "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" }

Para obtener más información, consulte Ver información sobre tareas y ejecuciones de tareas (AWS CLI) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar get-maintenance-window-execution-task.

AWS CLI

Obtención de información sobre la ejecución de una tarea del periodo de mantenimiento

En el siguiente ejemplo de get-maintenance-window-execution-task se muestra información sobre una tarea que forma parte de la ejecución del periodo de mantenimiento especificado.

aws ssm get-maintenance-window-execution-task \ --window-execution-id "518d5565-5969-4cca-8f0e-da3b2EXAMPLE" \ --task-id "ac0c6ae1-daa3-4a89-832e-d3845EXAMPLE"

Salida:

{ "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" }

Para obtener más información, consulte Ver información sobre tareas y ejecuciones de tareas (AWS CLI) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar get-maintenance-window-execution.

AWS CLI

Obtención de información sobre la ejecución de una tarea del periodo de mantenimiento

En el siguiente ejemplo de get-maintenance-window-execution se muestra información sobre una tarea que se ejecutó como parte de la ejecución del periodo de mantenimiento especificado.

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

Salida:

{ "Status": "SUCCESS", "TaskIds": [ "ac0c6ae1-daa3-4a89-832e-d3845EXAMPLE" ], "StartTime": 1487692834.595, "EndTime": 1487692835.051, "WindowExecutionId": "518d5565-5969-4cca-8f0e-da3b2EXAMPLE", }

Para obtener más información, consulte Ver información sobre tareas y ejecuciones de tareas (AWS CLI) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar get-maintenance-window-task.

AWS CLI

Para obtener información sobre una tarea de la ventana de mantenimiento

En el siguiente get-maintenance-window-task ejemplo, se recuperan los detalles sobre la tarea de la ventana de mantenimiento especificada.

aws ssm get-maintenance-window-task \ --window-id mw-0c5ed765acEXAMPLE \ --window-task-id 0e842a8d-2d44-4886-bb62-af8dcEXAMPLE

Salida:

{ "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" }

Para obtener más información, consulte Ver información sobre el mantenimiento de Windows (AWS CLI) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar get-maintenance-window.

AWS CLI

Obtención de información sobre un periodo de mantenimiento

En el siguiente ejemplo de get-maintenance-window se recuperan los detalles sobre el periodo de mantenimiento especificado.

aws ssm get-maintenance-window \ --window-id "mw-03eb9db428EXAMPLE"

Salida:

{ "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" }

Para obtener más información, consulte Ver información sobre las ventanas de mantenimiento (AWS CLI) en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte GetMaintenanceWindowla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar get-ops-item.

AWS CLI

Para ver información sobre un OpsItem

En el siguiente get-ops-item ejemplo, se muestran detalles sobre lo especificado OpsItem.

aws ssm get-ops-item \ --ops-item-id oi-0b725EXAMPLE

Salida:

{ "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" } }

Para obtener más información, consulte Trabajar con OpsItems en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte GetOpsItemla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar get-ops-summary.

AWS CLI

Para ver un resumen de todos OpsItems

En el siguiente get-ops-summary ejemplo, se muestra un resumen de todo lo que OpsItems hay en tu AWS cuenta.

aws ssm get-ops-summary

Salida:

{ "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" } ] } } } ] }

Para obtener más información, consulte Trabajar con OpsItems en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte GetOpsSummaryla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar get-parameter-history.

AWS CLI

Obtención del historial de valores de un parámetro

En el siguiente ejemplo de get-parameter-history se enumera el historial de cambios del parámetro especificado, incluido su valor.

aws ssm get-parameter-history \ --name "MyStringParameter"

Salida:

{ "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": [] } ] }

Para obtener más información, consulte Trabajo con versiones de parámetros en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte GetParameterHistoryla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar get-parameter.

AWS CLI

Ejemplo 1: visualización del valor de un parámetro

En el siguiente ejemplo de get-parameter se enumera el valor del parámetro único especificado.

aws ssm get-parameter \ --name "MyStringParameter"

Salida:

{ "Parameter": { "Name": "MyStringParameter", "Type": "String", "Value": "Veni", "Version": 1, "LastModifiedDate": 1530018761.888, "ARN": "arn:aws:ssm:us-east-2:111222333444:parameter/MyStringParameter" "DataType": "text" } }

Para obtener más información, consulte Uso de Parameter Store en la Guía del usuario de AWS Systems Manager.

Ejemplo 2: Para descifrar el valor de un parámetro SecureString

En el siguiente ejemplo de get-parameter se cambia el valor del parámetro SecureString especificado.

aws ssm get-parameter \ --name "MySecureStringParameter" \ --with-decryption

Salida:

{ "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" } }

Para obtener más información, consulte Uso de Parameter Store en la Guía del usuario de AWS Systems Manager.

Ejemplo 3: visualización del valor de un parámetro mediante etiquetas

En el siguiente ejemplo de get-parameter se enumera el valor del parámetro único especificado con una etiqueta especificada.

aws ssm get-parameter \ --name "MyParameter:label"

Salida:

{ "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" } }

Para obtener más información, consulte Trabajo con etiquetas de parámetros en la Guía del usuario de AWS Systems Manager.

Ejemplo 4: visualización del valor de un parámetro mediante etiquetas

En el siguiente ejemplo de get-parameter se enumera el valor de la versión de parámetro único especificado.

aws ssm get-parameter \ --name "MyParameter:2"

Salida:

{ "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" } }

Para obtener más información, consulte Trabajo con etiquetas de parámetros en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte GetParameterla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar get-parameters-by-path.

AWS CLI

Para enumerar los parámetros de una ruta específica

En el siguiente get-parameters-by-path ejemplo, se enumeran los parámetros de la jerarquía especificada.

aws ssm get-parameters-by-path \ --path "/site/newyork/department/"

Salida:

{ "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" }, ... ] }

Para obtener más información, consulte Trabajar con jerarquías de parámetros en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte GetParametersByPathla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar get-parameters.

AWS CLI

Ejemplo 1: enumeración de los valores de un parámetro

En el siguiente ejemplo de get-parameters se enumeran los valores de los tres parámetros especificados.

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

Salida:

{ "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" ] }

Para obtener más información, consulte Uso de Parameter Store en la Guía del usuario de AWS Systems Manager.

Ejemplo 2: enumeración de los nombres y valores de varios parámetros mediante la opción “--query”

En el siguiente ejemplo de get-parameters se enumeran los nombres y valores de los parámetros especificados.

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

Salida:

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

Para obtener más información, consulte Uso de Parameter Store en la Guía del usuario de AWS Systems Manager.

Ejemplo 3: visualización del valor de un parámetro mediante etiquetas

En el siguiente ejemplo de get-parameter se enumera el valor del parámetro único especificado con una etiqueta especificada.

aws ssm get-parameter \ --name "MyParameter:label"

Salida:

{ "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": [] }

Para obtener más información, consulte Trabajo con etiquetas de parámetros en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte GetParametersla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar get-patch-baseline-for-patch-group.

AWS CLI

Visualización de la línea de base de revisiones de un grupo de revisiones

En el siguiente ejemplo de get-patch-baseline-for-patch-group se recuperan los detalles sobre la línea de base de revisiones del grupo de revisiones especificado.

aws ssm get-patch-baseline-for-patch-group \ --patch-group "DEV"

Salida:

{ "PatchGroup": "DEV", "BaselineId": "pb-0123456789abcdef0", "OperatingSystem": "WINDOWS" }

Para obtener más información, consulte Creación de un grupo de parches < https://docs.aws.amazon.com/systems-manager/ latest/userguide/sysman - patch-group-tagging .html>__ y Añadir un grupo de parches a una línea base de parches en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar get-patch-baseline.

AWS CLI

Visualización de una línea de base de revisiones

En el siguiente ejemplo de get-patch-baseline se recuperan los detalles de la línea de base de revisiones especificada.

aws ssm get-patch-baseline \ --baseline-id "pb-0123456789abcdef0"

Salida:

{ "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": [] }

Para obtener más información, consulte Acerca de las líneas de base de revisiones en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte GetPatchBaselinela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar get-service-setting.

AWS CLI

Para recuperar la configuración del servicio para el rendimiento del almacén de parámetros

El siguiente get-service-setting ejemplo recupera la configuración de servicio actual del rendimiento del almacén de parámetros en la región especificada.

aws ssm get-service-setting \ --setting-id arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled

Salida:

{ "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" } }

Para obtener más información, consulte Aumentar el rendimiento del almacén de parámetros en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte GetServiceSettingla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar label-parameter-version.

AWS CLI

Ejemplo 1: Para añadir una etiqueta a la última versión de un parámetro

En el siguiente label-parameter-version ejemplo, se agrega una etiqueta a la última versión del parámetro especificado.

aws ssm label-parameter-version \ --name "MyStringParameter" \ --labels "ProductionReady"

Salida:

{ "InvalidLabels": [], "ParameterVersion": 3 }

Para obtener más información, consulte Trabajo con etiquetas de parámetros en la Guía del usuario de AWS Systems Manager.

Ejemplo 2: Para añadir una etiqueta a una versión específica de un parámetro

En el siguiente label-parameter-version ejemplo, se agrega una etiqueta a la versión especificada de un parámetro.

aws ssm label-parameter-version \ --name "MyStringParameter" \ --labels "ProductionReady" \ --parameter-version "2" --labels "DevelopmentReady"

Para obtener más información, consulte Trabajo con etiquetas de parámetros en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar list-association-versions.

AWS CLI

Enumeración de todas las versiones de una asociación para un ID de asociación específico

En el siguiente ejemplo de list-association-versions se enumeran todas las versiones de las asociaciones especificadas.

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

Salida:

{ "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" } ] }

Para obtener más información, consulte Trabajo con asociaciones en Systems Manager en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar list-associations.

AWS CLI

Ejemplo 1: enumeración de las asociaciones de una instancia específica

En el siguiente ejemplo de lista de asociaciones se enumeran todas las asociaciones con la letra AssociationName U. pdateSSMAgent

aws ssm list-associations / --association-filter-list "key=AssociationName,value=UpdateSSMAgent"

Salida:

{ "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" } ] }

Para obtener más información, consulte Trabajo con asociaciones en Systems Manager en la Guía del usuario de Systems Manager.

Ejemplo 2: enumeración de las asociaciones de un documento específico

En el siguiente ejemplo de list-associations se enumeran todas las asociaciones del documento especificado.

aws ssm list-associations / --association-filter-list "key=Name,value=AWS-UpdateSSMAgent"

Salida:

{ "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 } } } ] }

Para obtener más información, consulte Trabajo con asociaciones en Systems Manager en la Guía del usuario de Systems Manager.

  • Para API obtener más información, consulte la Referencia ListAssociationsde AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar list-command-invocations.

AWS CLI

Enumeración de las invocaciones de un comando específico

En el siguiente ejemplo de list-command-invocations se enumeran todas las invocaciones de un comando.

aws ssm list-command-invocations \ --command-id "ef7fdfd8-9b57-4151-a15c-db9a12345678" \ --details

Salida:

{ "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 } } ] }

Para obtener más información, consulte Descripción de los estados del comando en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar list-commands.

AWS CLI

Ejemplo 1: obtención del estado de un comando específico

En el siguiente ejemplo de list-commands se recupera y muestra el estado del comando especificado.

aws ssm list-commands \ --command-id "0831e1a8-a1ac-4257-a1fd-c831bEXAMPLE"

Ejemplo 2: obtención del estado de los comandos solicitados después de una fecha específica

En el siguiente ejemplo de list-commands se recuperan los detalles de los comandos solicitados después de la fecha especificada.

aws ssm list-commands \ --filter "key=InvokedAfter,value=2020-02-01T00:00:00Z"

Ejemplo 3: Para enumerar todos los comandos solicitados en una AWS cuenta

En el siguiente list-commands ejemplo, se enumeran todos los comandos solicitados por los usuarios de la AWS cuenta y la región actuales.

aws ssm list-commands

Salida:

{ "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 } } ] }

Para obtener más información, consulte Running Commands Using Systems Manager Run Command en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte ListCommandsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar list-compliance-items.

AWS CLI

Enumeración de los elementos de conformidad de una instancia específica

En este ejemplo se enumeran todos los elementos de conformidad de la instancia especificada.

Comando:

aws ssm list-compliance-items --resource-ids "i-1234567890abcdef0" --resource-types "ManagedInstance"

Salida:

{ "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--" }

Enumeración de los elementos de conformidad de una instancia y un ID de asociación específicos

En este ejemplo se enumeran todos los elementos de conformidad de la instancia y el ID de asociación especificados.

Comando:

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"

Enumeración de los elementos de conformidad de una instancia después de una fecha y hora específicas

En este ejemplo se enumeran todos los elementos de conformidad de una instancia después de la fecha y hora especificada.

Comando:

aws ssm list-compliance-items --resource-ids "i-1234567890abcdef0" --resource-types "ManagedInstance" --filters "Key=ExecutionTime,Values=2019-02-18T16:00:00Z,Type=GREATER_THAN"
  • Para API obtener más información, consulte ListComplianceItemsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar list-compliance-summaries.

AWS CLI

Enumeración de los resúmenes de conformidad de todos los tipos de conformidad

En este ejemplo se enumeran los resúmenes de conformidad de todos los tipos de conformidad de su cuenta.

Comando:

aws ssm list-compliance-summaries

Salida:

{ "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==" }

Enumeración de los resúmenes de conformidad de un tipo de conformidad específico

En este ejemplo se muestra el resumen de conformidad del tipo de conformidad de la revisión.

Comando:

aws ssm list-compliance-summaries --filters "Key=ComplianceType,Values=Patch,Type=EQUAL"

En el siguiente ejemplo de código se muestra cómo usar list-document-metadata-history.

AWS CLI

Ejemplo: para ver el historial y el estado de aprobación de una plantilla de cambios

En el siguiente list-document-metadata-history ejemplo, se devuelve el historial de aprobaciones de la plantilla de cambios de Change Manager especificada.

aws ssm list-document-metadata-history \ --name MyChangeManageTemplate \ --metadata DocumentReviews

Salida:

{ "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" } ] } }

Para obtener más información, consulte Revisión y aprobación o rechazo de plantillas de cambios en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar list-document-versions.

AWS CLI

Enumeración de las versiones de los documentos

En el siguiente ejemplo de list-document-versions se enumeran todas las versiones de un documento de Systems Manager.

aws ssm list-document-versions \ --name "Example"

Salida:

{ "DocumentVersions": [ { "Name": "Example", "DocumentVersion": "1", "CreatedDate": 1583257938.266, "IsDefaultVersion": true, "DocumentFormat": "YAML", "Status": "Active" } ] }

Para obtener más información, consulte Ejecución de comandos mediante una versión de documento específica en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte ListDocumentVersionsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar list-documents.

AWS CLI

Ejemplo 1: enumeración de documentos

En el siguiente ejemplo de list-documents se enumeran los documentos propiedad de la cuenta solicitante etiquetados con la etiqueta personalizada.

aws ssm list-documents \ --filters Key=Owner,Values=Self Key=tag:DocUse,Values=Testing

Salida:

{ "DocumentIdentifiers": [ { "Name": "Example", "Owner": "29884EXAMPLE", "PlatformTypes": [ "Windows", "Linux" ], "DocumentVersion": "1", "DocumentType": "Automation", "SchemaVersion": "0.3", "DocumentFormat": "YAML", "Tags": [ { "Key": "DocUse", "Value": "Testing" } ] } ] }

Para obtener más información, consulte Documentos de AWS Systems Manager en la Guía del usuario de AWS Systems Manager.

Ejemplo 2: enumeración de los documentos compartidos

En el siguiente list-documents ejemplo se enumeran los documentos compartidos, incluidos los documentos compartidos privados que no son propiedad de AWS.

aws ssm list-documents \ --filters Key=Name,Values=sharedDocNamePrefix Key=Owner,Values=Private

Salida:

{ "DocumentIdentifiers": [ { "Name": "Example", "Owner": "12345EXAMPLE", "PlatformTypes": [ "Windows", "Linux" ], "DocumentVersion": "1", "DocumentType": "Command", "SchemaVersion": "0.3", "DocumentFormat": "YAML", "Tags": [] } ] }

Para obtener más información, consulte Documentos de AWS Systems Manager en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte ListDocumentsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar list-inventory-entries.

AWS CLI

Ejemplo 1: visualización de las entradas de tipos de inventario específicos de una instancia

En el siguiente list-inventory-entries ejemplo, se enumeran las entradas de inventario del tipo de AWS inventario: Application en una instancia específica.

aws ssm list-inventory-entries \ --instance-id "i-1234567890abcdef0" \ --type-name "AWS:Application"

Salida:

{ "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" } ] }

Ejemplo 2: visualización de las entradas de inventario personalizadas asignadas a una instancia

En el siguiente ejemplo de list-inventory-entries se muestra una entrada de inventario personalizada asignada a una instancia.

aws ssm list-inventory-entries \ --instance-id "i-1234567890abcdef0" \ --type-name "Custom:RackInfo"

Salida:

{ "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" } ] }
  • Para API obtener más información, consulte la Referencia ListInventoryEntriesde AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar list-ops-item-related-items.

AWS CLI

Para enumerar los recursos relacionados de un OpsItem

En el siguiente list-ops-item-related-items ejemplo se enumeran los recursos de elementos relacionados de un. OpsItem

aws ssm list-ops-item-related-items \ --ops-item-id "oi-f99f2EXAMPLE"

Salida:

{ "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" } ] }

Para obtener más información, consulte Trabajar con incidentes de Incident Manager OpsCenter en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar list-resource-compliance-summaries.

AWS CLI

Enumeración de los recuentos resumidos de conformidad para cada recurso

En este ejemplo se enumeran los recuentos resumidos de conformidad para cada recurso.

Comando:

aws ssm list-resource-compliance-summaries

Salida:

{ "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--" }

Enumeración de los resúmenes de conformidad de un tipo de conformidad específico para cada recurso

En este ejemplo se enumeran los resúmenes de conformidad de cada recurso del tipo de conformidad de la revisión.

Comando:

aws ssm list-resource-compliance-summaries --filters "Key=ComplianceType,Values=Patch,Type=EQUAL"

En el siguiente ejemplo de código se muestra cómo usar list-resource-data-sync.

AWS CLI

Para enumerar las configuraciones de sincronización de datos de sus recursos

En este ejemplo, se recupera información sobre las configuraciones de sincronización de datos de los recursos.

aws ssm list-resource-data-sync

Salida:

{ "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" } ] }
  • Para API obtener más información, consulte ListResourceDataSyncla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar list-tags-for-resource.

AWS CLI

Enumeración de las etiquetas aplicadas a una línea de base de revisiones

En el siguiente ejemplo de list-tags-for-resource se muestran las etiquetas de una línea de base de revisiones.

aws ssm list-tags-for-resource \ --resource-type "PatchBaseline" \ --resource-id "pb-0123456789abcdef0"

Salida:

{ "TagList": [ { "Key": "Environment", "Value": "Production" }, { "Key": "Region", "Value": "EMEA" } ] }

Para obtener más información, consulte Etiquetado de AWS recursos en la Referencia AWS general.

  • Para API obtener más información, consulte ListTagsForResourcela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar modify-document-permission.

AWS CLI

Modificación de los permisos de los documentos

En el siguiente ejemplo de modify-document-permission se comparte un documento de Systems Manager públicamente.

aws ssm modify-document-permission \ --name "Example" \ --permission-type "Share" \ --account-ids-to-add "All"

Este comando no genera ninguna salida.

Para obtener más información, consulte Compartir un documento de Systems Manager en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar put-compliance-items.

AWS CLI

Registro de un tipo de conformidad y de los detalles de conformidad en una instancia designada

En este ejemplo se registra el tipo de conformidad Custom:AVCheck en la instancia administrada especificada. No se obtienen resultados si el comando se ejecuta correctamente.

Comando:

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"
  • Para API obtener más información, consulte PutComplianceItemsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar put-inventory.

AWS CLI

Asignación de metadatos de cliente a una instancia

En este ejemplo se asigna información de ubicación de bastidores a una instancia. No se obtienen resultados si el comando se ejecuta correctamente.

Comando (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"}]}]'

Comando (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'}]"
  • Para API obtener más información, consulte PutInventoryla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar put-parameter.

AWS CLI

Ejemplo 1: Cambio del valor de un parámetro

En el siguiente ejemplo de put-parameter se cambia el valor del parámetro especificado.

aws ssm put-parameter \ --name "MyStringParameter" \ --type "String" \ --value "Vici" \ --overwrite

Salida:

{ "Version": 2, "Tier": "Standard" }

Para obtener más información, consulte Crear un parámetro de Systems Manager (AWS CLI), «Administrar niveles de parámetros < https://docs.aws.amazon.com/systems-manager/ latest/userguide/parameter - store-advanced-parameters .html>`__» y «Trabajar con políticas de parámetros» en la Guía del usuario de Systems Manager AWS .

Ejemplo 2: Creación de un parámetro avanzado

En el siguiente ejemplo de put-parameter se crea un parámetro avanzado.

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

Salida:

{ "Version": 1, "Tier": "Advanced" }

Para obtener más información, consulte Crear un parámetro de Systems Manager (AWS CLI), «Administrar niveles de parámetros < https://docs.aws.amazon.com/systems-manager/ latest/userguide/parameter - store-advanced-parameters .html>`__» y «Trabajar con políticas de parámetros» en la Guía del usuario de Systems Manager AWS .

Ejemplo 3: Cambio de un parámetro estándar a un parámetro avanzado

En el siguiente ejemplo de put-parameter se convierte un parámetro estándar existente en un parámetro avanzado.

aws ssm put-parameter \ --name "MyConvertedParameter" \ --value "abc123" \ --type "String" \ --tier Advanced \ --overwrite

Salida:

{ "Version": 2, "Tier": "Advanced" }

Para obtener más información, consulte Crear un parámetro de Systems Manager (AWS CLI), «Administrar niveles de parámetros < https://docs.aws.amazon.com/systems-manager/ latest/userguide/parameter - store-advanced-parameters .html>`__» y «Trabajar con políticas de parámetros» en la Guía del usuario de Systems Manager AWS .

Ejemplo 4: Creación de un parámetro con una política adjunta

En el siguiente ejemplo de put-parameter se crea un parámetro avanzado con una política de parámetros adjunta.

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\"}}]"

Salida:

{ "Version": 1, "Tier": "Advanced" }

Para obtener más información, consulte Crear un parámetro de Systems Manager (AWS CLI), «Administrar niveles de parámetros < https://docs.aws.amazon.com/systems-manager/ latest/userguide/parameter - store-advanced-parameters .html>`__» y «Trabajar con políticas de parámetros» en la Guía del usuario de Systems Manager AWS .

Ejemplo 5: Adición de una política a un parámetro existente

En el siguiente ejemplo de put-parameter se adjunta una política a un parámetro avanzado existente.

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

Salida:

{ "Version": 2, "Tier": "Advanced" }

Para obtener más información, consulte Crear un parámetro de Systems Manager (AWS CLI), «Administrar niveles de parámetros < https://docs.aws.amazon.com/systems-manager/ latest/userguide/parameter - store-advanced-parameters .html>`__» y «Trabajar con políticas de parámetros» en la Guía del usuario de Systems Manager AWS .

  • Para obtener API más información, consulte la Referencia de comandos. PutParameterAWS CLI

En el siguiente ejemplo de código se muestra cómo usar register-default-patch-baseline.

AWS CLI

Configuración de la línea de base de revisiones predeterminada

En el siguiente ejemplo de register-default-patch-baseline se registra la línea de base de revisiones personalizada especificada como la línea de base de revisiones predeterminada para el tipo de sistema operativo que admite.

aws ssm register-default-patch-baseline \ --baseline-id "pb-abc123cf9bEXAMPLE"

Salida:

{ "BaselineId":"pb-abc123cf9bEXAMPLE" }

El siguiente register-default-patch-baseline ejemplo registra la línea base de parches predeterminada proporcionada AWS por CentOS como línea base de parches predeterminada.

aws ssm register-default-patch-baseline \ --baseline-id "arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed"

Salida:

{ "BaselineId":"pb-abc123cf9bEXAMPLE" }

Para obtener más información, consulte Acerca de las líneas de base de revisiones personalizadas y predefinidas en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar register-patch-baseline-for-patch-group.

AWS CLI

Registro de una línea de base de revisiones de un grupo de revisiones

En el siguiente ejemplo de register-patch-baseline-for-patch-group se registra una línea de base de revisiones para un grupo de revisiones.

aws ssm register-patch-baseline-for-patch-group \ --baseline-id "pb-045f10b4f382baeda" \ --patch-group "Production"

Salida:

{ "BaselineId": "pb-045f10b4f382baeda", "PatchGroup": "Production" }

Para obtener más información, consulte Creación de un grupo de parches < https://docs.aws.amazon.com/systems-manager/ latest/userguide/sysman - patch-group-tagging .html>__ y Añadir un grupo de parches a una línea base de parches en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar register-target-with-maintenance-window.

AWS CLI

Ejemplo 1: registro de un único destino con un periodo de mantenimiento

En el siguiente ejemplo de register-target-with-maintenance-window se registra una instancia con un periodo de mantenimiento.

aws ssm register-target-with-maintenance-window \ --window-id "mw-ab12cd34ef56gh78" \ --target "Key=InstanceIds,Values=i-0000293ffd8c57862" \ --owner-information "Single instance" \ --resource-type "INSTANCE"

Salida:

{ "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" }

Ejemplo 2: Para registrar varios objetivos con una ventana de mantenimiento mediante una instancia IDs

En el siguiente register-target-with-maintenance-window ejemplo, se registran dos instancias con una ventana de mantenimiento especificando su instanciaIDs.

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"

Salida:

{ "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" }

Ejemplo 3: registro de destinos con un periodo de mantenimiento mediante etiquetas de recursos

En el siguiente ejemplo de register-target-with-maintenance-window se registran las instancias con un periodo de mantenimiento especificando las etiquetas de recursos que se han aplicado a las instancias.

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"

Salida:

{ "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" }

Ejemplo 4: registro de destinos mediante un grupo de claves de etiquetas

En el siguiente ejemplo de register-target-with-maintenance-window se registran instancias que tienen una o más claves asignadas, independientemente de los valores de la clave.

aws ssm register-target-with-maintenance-window \ --window-id "mw-0c50858d01EXAMPLE" \ --resource-type "INSTANCE" \ --target "Key=tag-key,Values=Name,Instance-Type,CostCenter"

Salida:

{ "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" }

Ejemplo 5: registro de destinos con un nombre de grupo de recursos

En el siguiente ejemplo de register-target-with-maintenance-window se registra un grupo de recursos especificado, independientemente del tipo de recursos que contiene.

aws ssm register-target-with-maintenance-window \ --window-id "mw-0c50858d01EXAMPLE" \ --resource-type "RESOURCE_GROUP" \ --target "Key=resource-groups:Name,Values=MyResourceGroup"

Salida:

{ "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" }

Para obtener más información, consulte Registrar una instancia de destino con la ventana de mantenimiento (AWS CLI) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar register-task-with-maintenance-window.

AWS CLI

Ejemplo 1: registro de una tarea de Automatización con un periodo de mantenimiento

En el siguiente ejemplo de register-task-with-maintenance-window se registra una tarea de Automatización con un periodo de mantenimiento destinado a una instancia.

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"

Salida:

{ "WindowTaskId":"11144444-5555-6666-7777-88888888" }

Para obtener más información, consulte Registrar una tarea con la ventana de mantenimiento (AWS CLI) en la Guía del usuario de AWS Systems Manager.

Ejemplo 2: registro de una tarea de Lambda con un periodo de mantenimiento

En el siguiente ejemplo de register-task-with-maintenance-window se registra una tarea de Lambda con un periodo de mantenimiento destinado a una instancia.

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"

Salida:

{ "WindowTaskId":"22244444-5555-6666-7777-88888888" }

Para obtener más información, consulte Registrar una tarea con la ventana de mantenimiento (AWS CLI) en la Guía del usuario de AWS Systems Manager.

Ejemplo 3: registro de una tarea de ejecución de un comando con un periodo de mantenimiento

En el siguiente ejemplo de register-task-with-maintenance-window se registra una tarea de ejecución de un comando con un periodo de mantenimiento destinado a una instancia.

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

Salida:

{ "WindowTaskId":"33344444-5555-6666-7777-88888888" }

Para obtener más información, consulte Registrar una tarea con la ventana de mantenimiento (AWS CLI) en la Guía del usuario de AWS Systems Manager.

Ejemplo 4: registro de una tarea de Step Functions con un periodo de mantenimiento

En el siguiente ejemplo de register-task-with-maintenance-window se registra una tarea de Step Functions con un periodo de mantenimiento destinado a una instancia.

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"

Salida:

{ "WindowTaskId":"44444444-5555-6666-7777-88888888" }

Para obtener más información, consulte Registrar una tarea con la ventana de mantenimiento (AWS CLI) en la Guía del usuario de AWS Systems Manager.

Ejemplo 5: registro de una tarea mediante un ID de destino de un periodo de mantenimiento

En el siguiente ejemplo de register-task-with-maintenance-window se registra una tarea mediante un ID de destino de un periodo de mantenimiento. El ID de destino del periodo de mantenimiento estaba en el resultado del comando aws ssm register-target-with-maintenance-window. También puede recuperarlo del resultado del comando 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

Salida:

{ "WindowTaskId":"33344444-5555-6666-7777-88888888" }

Para obtener más información, consulte Registrar una tarea con la ventana de mantenimiento (AWS CLI) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar remove-tags-from-resource.

AWS CLI

Eliminación de una etiqueta de una línea de base de revisiones

En el siguiente ejemplo de remove-tags-from-resource se eliminan las etiquetas de una línea de base de revisiones.

aws ssm remove-tags-from-resource \ --resource-type "PatchBaseline" \ --resource-id "pb-0123456789abcdef0" \ --tag-keys "Region"

Este comando no genera ninguna salida.

Para obtener más información, consulte Etiquetado de AWS recursos en la Referencia AWS general.

En el siguiente ejemplo de código se muestra cómo usar reset-service-setting.

AWS CLI

Para restablecer la configuración del servicio para el rendimiento del almacén de parámetros

En el siguiente reset-service-setting ejemplo, se restablece la configuración del servicio para el rendimiento del almacén de parámetros en la región especificada para que deje de utilizar el rendimiento incrementado.

aws ssm reset-service-setting \ --setting-id arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled

Salida:

{ "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" } }

Para obtener más información, consulte Aumentar el rendimiento del almacén de parámetros en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte ResetServiceSettingla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar resume-session.

AWS CLI

Para reanudar una sesión del administrador de sesiones

En este resume-session ejemplo, se reanuda una sesión del administrador de sesiones con una instancia después de haberla desconectado. Tenga en cuenta que este comando interactivo requiere que el complemento Session Manager esté instalado en la máquina cliente que realiza la llamada.

aws ssm resume-session \ --session-id Mary-Major-07a16060613c408b5

Salida:

{ "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" }

Para obtener más información, consulte Instalación del complemento Session Manager AWS CLI en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte ResumeSessionla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar send-automation-signal.

AWS CLI

Para enviar una señal a una ejecución de automatización

El siguiente send-automation-signal ejemplo envía una señal de aprobación a una ejecución de automatización.

aws ssm send-automation-signal \ --automation-execution-id 73c8eef8-f4ee-4a05-820c-e354fEXAMPLE \ --signal-type "Approve"

Este comando no genera ninguna salida.

Para obtener más información, consulte Ejecución de un flujo de trabajo de automatización con aprobadores en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte SendAutomationSignalla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar send-command.

AWS CLI

Ejemplo 1: ejecución de un comando en una o más instancias remotas

En el siguiente ejemplo de send-command se ejecuta un comando echo en una instancia de destino.

aws ssm send-command \ --document-name "AWS-RunShellScript" \ --parameters 'commands=["echo HelloWorld"]' \ --targets "Key=instanceids,Values=i-1234567890abcdef0" \ --comment "echo HelloWorld"

Salida:

{ "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 } } }

Para obtener más información, consulte Running Commands Using Systems Manager Run Command en la Guía del usuario de AWS Systems Manager.

Ejemplo 2: obtención de información sobre la IP de una instancia

En el siguiente ejemplo de send-command se obtiene información sobre la IP de una instancia.

aws ssm send-command \ --instance-ids "i-1234567890abcdef0" \ --document-name "AWS-RunShellScript" \ --comment "IP config" \ --parameters "commands=ifconfig"

Consulte el ejemplo 1 para ver una salida de muestra.

Para obtener más información, consulte Running Commands Using Systems Manager Run Command en la Guía del usuario de AWS Systems Manager.

Ejemplo 3: ejecución de un comando en instancias con etiquetas específicas

El siguiente send-command ejemplo ejecuta un comando en instancias que tienen la clave de etiqueta ENV "» y el valor «Dev».

aws ssm send-command \ --targets "Key=tag:ENV,Values=Dev" \ --document-name "AWS-RunShellScript" \ --parameters "commands=ifconfig"

Consulte el ejemplo 1 para ver una salida de muestra.

Para obtener más información, consulte Running Commands Using Systems Manager Run Command en la Guía del usuario de AWS Systems Manager.

Ejemplo 4: ejecutar un comando que envíe SNS notificaciones

En el siguiente send-command ejemplo, se ejecuta un comando que envía SNS notificaciones para todos los eventos de notificación y el tipo de Command notificación.

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"

Consulte el ejemplo 1 para ver una salida de muestra.

Para obtener más información, consulte Running Commands Using Systems Manager Run Command en la Guía del usuario de AWS Systems Manager.

Ejemplo 5: Para ejecutar un comando que se envíe a S3 y CloudWatch

El siguiente send-command ejemplo ejecuta un comando que envía los detalles del comando a un bucket de S3 y a un grupo de CloudWatch registros.

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"

Consulte el ejemplo 1 para ver una salida de muestra.

Para obtener más información, consulte Running Commands Using Systems Manager Run Command en la Guía del usuario de AWS Systems Manager.

Ejemplo 6: ejecución de comandos en varias instancias con etiquetas diferentes

En el siguiente ejemplo de send-command se ejecuta un comando en instancias con dos claves y valores de etiqueta diferentes.

aws ssm send-command \ --document-name "AWS-RunPowerShellScript" \ --parameters commands=["echo helloWorld"] \ --targets Key=tag:Env,Values=Dev Key=tag:Role,Values=WebServers

Consulte el ejemplo 1 para ver una salida de muestra.

Para obtener más información, consulte Running Commands Using Systems Manager Run Command en la Guía del usuario de AWS Systems Manager.

Ejemplo 7: definición de varias instancias como destino con la misma clave de etiqueta

En el siguiente ejemplo de send-command se ejecuta un comando en instancias que tienen la misma clave de etiqueta, pero con valores diferentes.

aws ssm send-command \ --document-name "AWS-RunPowerShellScript" \ --parameters commands=["echo helloWorld"] \ --targets Key=tag:Env,Values=Dev,Test

Consulte el ejemplo 1 para ver una salida de muestra.

Para obtener más información, consulte Running Commands Using Systems Manager Run Command en la Guía del usuario de AWS Systems Manager.

Ejemplo 8: ejecución de un comando que usa un documento compartido

En el siguiente ejemplo de send-command se ejecuta un documento compartido en una instancia de destino.

aws ssm send-command \ --document-name "arn:aws:ssm:us-east-1:123456789012:document/ExampleDocument" \ --targets "Key=instanceids,Values=i-1234567890abcdef0"

Consulte el ejemplo 1 para ver una salida de muestra.

Para obtener más información, consulte Uso de SSM documentos compartidos en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte SendCommandla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar start-associations-once.

AWS CLI

Para ejecutar una asociación de forma inmediata y solo una vez

En el siguiente start-associations-once ejemplo, se ejecuta la asociación especificada inmediatamente y solo una vez. No se obtienen resultados si el comando se ejecuta correctamente.

aws ssm start-associations-once \ --association-id "8dfe3659-4309-493a-8755-0123456789ab"

Este comando no genera ninguna salida.

Para obtener más información, consulte Visualización de los historiales de asociación en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar start-automation-execution.

AWS CLI

Ejemplo 1: ejecución de un documento de automatización

En el siguiente ejemplo de start-automation-execution se ejecuta un documento de Automatización.

aws ssm start-automation-execution \ --document-name "AWS-UpdateLinuxAmi" \ --parameters "AutomationAssumeRole=arn:aws:iam::123456789012:role/SSMAutomationRole,SourceAmiId=ami-EXAMPLE,IamInstanceProfileName=EC2InstanceRole"

Salida:

{ "AutomationExecutionId": "4105a4fc-f944-11e6-9d32-0a1b2EXAMPLE" }

Para obtener más información, consulte Ejecución manual de un flujo de trabajo de Automatización en la Guía del usuario de AWS Systems Manager.

Ejemplo 2: ejecución de un documento de automatización compartido

En el siguiente ejemplo de start-automation-execution se ejecuta un documento de Automatización compartido.

aws ssm start-automation-execution \ --document-name "arn:aws:ssm:us-east-1:123456789012:document/ExampleDocument"

Salida:

{ "AutomationExecutionId": "4105a4fc-f944-11e6-9d32-0a1b2EXAMPLE" }

Para obtener más información, consulte Uso de SSM documentos compartidos en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar start-change-request-execution.

AWS CLI

Ejemplo 1: Para iniciar una solicitud de cambio

En el siguiente start-change-request-execution ejemplo, se inicia una solicitud de cambio con un mínimo de opciones especificadas.

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"

Salida:

{ "AutomationExecutionId": "9d32a4fc-f944-11e6-4105-0a1b2EXAMPLE" }

Ejemplo 2: Para iniciar una solicitud de cambio mediante un JSON archivo externo

En el siguiente start-automation-execution ejemplo, se inicia una solicitud de cambio con varias opciones especificadas en un JSON archivo.

aws ssm start-change-request-execution \ --cli-input-json file://MyChangeRequest.json

Contenidos 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" }

Salida:

{ "AutomationExecutionId": "9d32a4fc-f944-11e6-4105-0a1b2EXAMPLE" }

Para obtener más información, consulte Creación de solicitudes de cambio en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar start-session.

AWS CLI

Ejemplo 1: para iniciar una sesión de Session Manager

Este ejemplo de start-session establece una conexión a una instancia para una sesión de Session Manager. Tenga en cuenta que este comando interactivo requiere que el complemento Session Manager esté instalado en la máquina cliente que realiza la llamada.

aws ssm start-session \ --target "i-1234567890abcdef0"

Salida:

Starting session with SessionId: Jane-Roe-07a16060613c408b5

Ejemplo 2: Para iniciar una sesión del administrador de sesiones mediante SSH

Este start-session ejemplo establece una conexión con una instancia para una sesión del administrador de sesiones medianteSSH. Tenga en cuenta que este comando interactivo requiere que el complemento Session Manager esté instalado en la máquina cliente que realiza la llamada y que el comando usa el usuario predeterminado de la instancia, como en el caso ec2-user de EC2 las instancias de Linux.

ssh -i /path/my-key-pair.pem ec2-user@i-02573cafcfEXAMPLE

Salida:

Starting session with SessionId: ec2-user-07a16060613c408b5

Para obtener más información, consulte Iniciar una sesión e instalar el complemento Session Manager AWS CLI en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte StartSessionla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar stop-automation-execution.

AWS CLI

Detención de una ejecución de automatización

En el siguiente ejemplo de stop-automation-execution se detiene un documento de Automatización.

aws ssm stop-automation-execution --automation-execution-id "4105a4fc-f944-11e6-9d32-0a1b2EXAMPLE"

Este comando no genera ninguna salida.

Para obtener más información, consulte Ejecución manual de un flujo de trabajo de Automatización en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar terminate-session.

AWS CLI

Para finalizar una sesión del administrador de sesiones

Este terminate-session ejemplo finaliza permanentemente una sesión creada por el usuario «Shirley-Rodriguez» y cierra la conexión de datos entre el cliente del administrador de sesiones y el SSM agente de la instancia.

aws ssm terminate-session \ --session-id "Shirley-Rodriguez-07a16060613c408b5"

Salida:

{ "SessionId": "Shirley-Rodriguez-07a16060613c408b5" }

Para obtener más información, consulte Finalizar una sesión en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte TerminateSessionla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar unlabel-parameter-version.

AWS CLI

Para eliminar etiquetas de parámetros

El siguiente unlabel-parameter-version ejemplo elimina las etiquetas especificadas de la versión de parámetro dada.

aws ssm unlabel-parameter-version \ --name "parameterName" \ --parameter-version "version" \ --labels "label_1" "label_2" "label_3"

Salida:

{ "RemovedLabels": [ "label_1" "label_2" "label_3" ], "InvalidLabels": [] }

Para obtener más información, consulte Eliminar etiquetas de parámetros (AWS CLI) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar update-association-status.

AWS CLI

Actualización del estado de la asociación

En el siguiente ejemplo de update-association-status se actualiza el estado de la asociación entre una instancia y un documento.

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"

Salida:

{ "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 } }

Para obtener más información, consulte Trabajo con asociaciones en Systems Manager en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar update-association.

AWS CLI

Ejemplo 1: actualización de una asociación de documentos

En el siguiente ejemplo de update-association se actualiza una asociación con una nueva versión del documento.

aws ssm update-association \ --association-id "8dfe3659-4309-493a-8755-0123456789ab" \ --document-version "\$LATEST"

Salida:

{ "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 } }

Para obtener más información, consulte Edición y creación de una nueva versión de una asociación en la Guía del usuario de AWS Systems Manager.

Ejemplo 2: actualización de la expresión de programación de una asociación

En el siguiente ejemplo de update-association se actualiza la expresión de programación de la asociación especificada.

aws ssm update-association \ --association-id "8dfe3659-4309-493a-8755-0123456789ab" \ --schedule-expression "cron(0 0 0/4 1/1 * ? *)"

Salida:

{ "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 } }

Para obtener más información, consulte Edición y creación de una nueva versión de una asociación en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte UpdateAssociationla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar update-document-default-version.

AWS CLI

Actualización de la versión predeterminada de un documento

En el siguiente ejemplo de update-document-default-version se actualiza la versión predeterminada de un documento de Systems Manager.

aws ssm update-document-default-version \ --name "Example" \ --document-version "2"

Salida:

{ "Description": { "Name": "Example", "DefaultVersion": "2" } }

Para obtener más información, consulte Redacción SSM del contenido de un documento en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar update-document-metadata.

AWS CLI

Ejemplo: para aprobar la última versión de una plantilla de cambios

A continuación, se update-document-metadata proporciona una aprobación para la última versión de una plantilla de cambios que se ha enviado para su revisión.

aws ssm update-document-metadata \ --name MyChangeManagerTemplate \ --document-reviews 'Action=Approve,Comment=[{Type=Comment,Content=Approved!}]'

Este comando no genera ninguna salida.

Para obtener más información, consulte Revisión y aprobación o rechazo de plantillas de cambios en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar update-document.

AWS CLI

Creación de una nueva versión de un documento

En el siguiente ejemplo de update-document se crea una nueva versión de un documento cuando se ejecuta en una computador con Windows. El documento especificado por --document debe tener el JSON formato indicado. Tenga en cuenta que se debe hacer referencia a file:// seguido de la ruta del archivo de contenido. Debido a que $ está al principio del parámetro --document-version, en Windows debe escribir el valor entre comillas dobles. En Linux, macOS o cuando se le PowerShell solicite, debe escribir el valor entre comillas simples.

Versión de Windows:

aws ssm update-document \ --name "RunShellScript" \ --content "file://RunShellScript.json" \ --document-version "$LATEST"

Versión de Linux o Mac:

aws ssm update-document \ --name "RunShellScript" \ --content "file://RunShellScript.json" \ --document-version '$LATEST'

Salida:

{ "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" } }
  • Para API obtener más información, consulte UpdateDocumentla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar update-maintenance-window-target.

AWS CLI

Para actualizar un objetivo de ventana de mantenimiento

En el siguiente update-maintenance-window-target ejemplo, se actualiza solo el nombre de un objetivo de ventana de mantenimiento.

aws ssm update-maintenance-window-target \ --window-id "mw-0c5ed765acEXAMPLE" \ --window-target-id "57e8344e-fe64-4023-8191-6bf05EXAMPLE" \ --name "NewName" \ --no-replace

Salida:

{ "Description": "", "OwnerInformation": "", "WindowTargetId": "57e8344e-fe64-4023-8191-6bf05EXAMPLE", "WindowId": "mw-0c5ed765acEXAMPLE", "Targets": [ { "Values": [ "i-1234567890EXAMPLE" ], "Key": "InstanceIds" } ], "Name": "NewName" }

Para obtener más información, consulte Actualizar una ventana de mantenimiento (AWS CLI) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar update-maintenance-window-task.

AWS CLI

Para actualizar una tarea de la ventana de mantenimiento

En el siguiente update-maintenance-window-task ejemplo, se actualiza la función de servicio de una tarea de la ventana de mantenimiento.

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"

Salida:

{ "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" }

Para obtener más información, consulte Actualizar una ventana de mantenimiento (AWS CLI) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar update-maintenance-window.

AWS CLI

Ejemplo 1: actualización de un periodo de mantenimiento

En el siguiente ejemplo de update-maintenance-window se actualiza el nombre de un periodo de mantenimiento.

aws ssm update-maintenance-window \ --window-id "mw-1a2b3c4d5e6f7g8h9" \ --name "My-Renamed-MW"

Salida:

{ "Cutoff": 1, "Name": "My-Renamed-MW", "Schedule": "cron(0 16 ? * TUE *)", "Enabled": true, "AllowUnassociatedTargets": true, "WindowId": "mw-1a2b3c4d5e6f7g8h9", "Duration": 4 }

Ejemplo 2: desactivación de un periodo de mantenimiento

En el siguiente ejemplo de update-maintenance-window se desactiva un periodo de mantenimiento.

aws ssm update-maintenance-window \ --window-id "mw-1a2b3c4d5e6f7g8h9" \ --no-enabled

Ejemplo 3: activación de un periodo de mantenimiento

En el siguiente ejemplo de update-maintenance-window se activa un periodo de mantenimiento.

aws ssm update-maintenance-window \ --window-id "mw-1a2b3c4d5e6f7g8h9" \ --enabled

Para obtener más información, consulte Actualizar una ventana de mantenimiento (AWS CLI) en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar update-managed-instance-role.

AWS CLI

Para actualizar la IAM función de una instancia gestionada

En el siguiente update-managed-instance-role ejemplo, se actualiza el perfil de IAM instancia de una instancia gestionada.

aws ssm update-managed-instance-role \ --instance-id "mi-08ab247cdfEXAMPLE" \ --iam-role "ExampleRole"

Este comando no genera ninguna salida.

Para obtener más información, consulte el paso 4: Crear un perfil de IAM instancia para Systems Manager en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar update-ops-item.

AWS CLI

Para actualizar un OpsItem

El siguiente update-ops-item ejemplo actualiza la descripción, la prioridad y la categoría de un OpsItem. Además, el comando especifica un SNS tema al que se envían las notificaciones cuando OpsItem se edita o cambia.

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"

Salida:

This command produces no output.

Para obtener más información, consulte Trabajar con OpsItems en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte UpdateOpsItemla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar update-patch-baseline.

AWS CLI

Ejemplo 1: actualización de una línea de base de revisiones

En el siguiente ejemplo de update-patch-baseline se agregan dos revisiones especificadas como rechazadas y una revisión como aprobada a la línea de base de revisiones especificada.

aws ssm update-patch-baseline \ --baseline-id "pb-0123456789abcdef0" \ --rejected-patches "KB2032276" "MS10-048" \ --approved-patches "KB2124261"

Salida:

{ "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": [] }

Ejemplo 2: cambio del nombre de una línea de base de revisiones

En el siguiente ejemplo de update-patch-baseline se cambia el nombre de la línea de base de revisiones especificada.

aws ssm update-patch-baseline \ --baseline-id "pb-0713accee01234567" \ --name "Windows-Server-2012-R2-Important-and-Critical-Security-Updates"

Para obtener más información, consulte Actualizar o eliminar una línea base de parche < https://docs.aws.amazon.com/systems-manager/ latest/userguide/patch - baseline-update-or-delete .html>`__ en la Guía del usuario de AWS Systems Manager.

  • Para obtener API más información, consulte la Referencia de comandos UpdatePatchBaseline.AWS CLI

En el siguiente ejemplo de código se muestra cómo usar update-resource-data-sync.

AWS CLI

Para actualizar la sincronización de datos de un recurso

En el siguiente update-resource-data-sync ejemplo, se actualiza la sincronización SyncFromSource de datos de un recurso.

aws ssm update-resource-data-sync \ --sync-name exampleSync \ --sync-type SyncFromSource \ --sync-source '{"SourceType":"SingleAccountMultiRegions", "SourceRegions":["us-east-1", "us-west-2"]}'

Este comando no genera ninguna salida.

Para obtener más información, consulte Configuración del explorador de Systems Manager para mostrar datos de varias cuentas y regiones en la Guía del usuario de AWS Systems Manager.

En el siguiente ejemplo de código se muestra cómo usar update-service-setting.

AWS CLI

Para actualizar la configuración del servicio para el rendimiento del almacén de parámetros

En el siguiente update-service-setting ejemplo, se actualiza la configuración actual del servicio del rendimiento del almacén de parámetros en la región especificada para utilizar un rendimiento mayor.

aws ssm update-service-setting \ --setting-id arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled \ --setting-value true

Este comando no genera ninguna salida.

Para obtener más información, consulte Aumentar el rendimiento del almacén de parámetros en la Guía del usuario de AWS Systems Manager.

  • Para API obtener más información, consulte UpdateServiceSettingla Referencia de AWS CLI comandos.