Ejemplos de contactos de Incident Manager que utilizan la AWS CLI - AWS Command Line Interface
Acciones

Esta documentación es para la versión 1 de AWS CLI. Para obtener documentación relacionada con la versión 2 de AWS CLI, consulte la Guía del usuario de la versión 2.

Ejemplos de contactos de Incident Manager que utilizan la AWS CLI

En los siguientes ejemplos de código se muestra cómo ejecutar acciones e implementar escenarios comunes usando la AWS Command Line Interface con contactos de Incident 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.

En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.

Acciones

En el siguiente ejemplo de código, se muestra cómo utilizar accept-page.

AWS CLI

Para aceptar una página durante una interacción

En el siguiente ejemplo de accept-page, se utiliza un código de aceptación enviado al canal de contacto para aceptar una página.

aws ssm-contacts accept-page \
    --page-id "arn:aws:ssm-contacts:us-east-2:682428703967:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3" \
    --accept-type READ \
    --accept-code 425440

Este comando no genera ninguna salida.

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

  • Para obtener detalles sobre la API, consulte AcceptPage en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar activate-contact-channel.

AWS CLI

Para activar un canal de contacto de un contacto

En el siguiente ejemplo de activate-contact-channel, se activa un canal de contacto y se puede utilizar como parte de un incidente.

aws ssm-contacts activate-contact-channel \
    --contact-channel-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d" \
    --activation-code "466136"

Este comando no genera ninguna salida.

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

  • Para obtener información sobre la API, consulte ActivateContactChannel en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar command-name.

AWS CLI

Para eliminar un contacto

En el siguiente ejemplo de command-name, se elimina un contacto. Ya no se podrá acceder al contacto desde ningún plan de escalamiento que haga referencia a dicho contacto.

aws ssm-contacts delete-contact \
    --contact-id "arn:aws:ssm-contacts:us-east-1:682428703967:contact/alejr"

Este comando no genera ninguna salida.

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

  • Para obtener información sobre la API, consulte CommandName en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar create-contact-channel.

AWS CLI

Para crear un canal de contacto

Crea un canal de contacto de tipo SMS para el contacto Akua Mansa. Se pueden crear canales de contacto de tipo SMS, EMAIL o VOICE.

aws ssm-contacts create-contact-channel \
    --contact-id "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" \
    --name "akuas sms-test" \
    --type SMS \
    --delivery-address '{"SimpleAddress": "+15005550199"}'

Salida:

{
    "ContactChannelArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/02f506b9-ea5d-4764-af89-2daa793ff024"
}

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

  • Para obtener información sobre la API, consulte CreateContactChannel en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar create-contact.

AWS CLI

Para crear un contacto

En el siguiente ejemplo de create-contact, se crea un contacto en su entorno con un plan en blanco. El plan se puede actualizar después de crear los canales de contacto. Utilice el comando create-contact-channel con el ARN de salida de este comando. Después de crear los canales de contacto para este contacto, utilice update-contact para actualizar el plan.

aws ssm-contacts create-contact \
    --alias "akuam" \
    --display-name "Akua Mansa" \
    --type PERSONAL \
    --plan '{"Stages": []}'

Salida:

{
    "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
}

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

  • Para obtener información sobre la API, consulte CreateContact en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar deactivate-contact-channel.

AWS CLI

Para desactivar un canal de contacto

En el siguiente ejemplo de deactivate-contact-channel, se desactiva un canal de contacto. La desactivación de un canal de contacto significa que dicho canal dejará de paginarse durante un incidente. Puede reactivar un canal de contacto en cualquier momento con el comando activate-contact-channel.

aws ssm-contacts deactivate-contact-channel \
    --contact-channel-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"

Este comando no genera ninguna salida.

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

  • Para obtener información sobre de la API, consulte DeactivateContactChannel en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar delete-contact-channel.

AWS CLI

Para eliminar un canal de contacto

En el siguiente ejemplo de delete-contact-channel, se elimina un canal de contacto. Al eliminar un canal de contacto, se garantiza que dicho canal no se pagine durante un incidente.

aws ssm-contacts delete-contact-channel \
    --contact-channel-id "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/13149bad-52ee-45ea-ae1e-45857f78f9b2"

Este comando no genera ninguna salida.

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

  • Para obtener información sobre la API, consulte DeleteContactChannel en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar delete-contact.

AWS CLI

Para eliminar un contacto

En el siguiente ejemplo de delete-contact, se elimina un contacto. Ya no se podrá acceder al contacto desde ningún plan de escalamiento que haga referencia a dicho contacto.

aws ssm-contacts delete-contact \
    --contact-id "arn:aws:ssm-contacts:us-east-1:111122223333:contact/alejr"

Este comando no genera ninguna salida.

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

  • Para obtener información sobre la API, consulte DeleteContact en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar describe-engagement.

AWS CLI

Para describir los detalles de una interacción

En el siguiente ejemplo de describe-engagement, se enumeran los detalles de una interacción con un contacto o un plan de escalamiento. El asunto y el contenido se envían a los canales de contacto.

aws ssm-contacts describe-engagement \
    --engagement-id "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"

Salida:

{
    "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
    "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356",
    "Sender": "cli",
    "Subject": "cli-test",
    "Content": "Testing engagements via CLI",
    "PublicSubject": "cli-test",
    "PublicContent": "Testing engagements va CLI",
    "StartTime": "2021-05-18T18:25:41.151000+00:00"
}

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

  • Para obtener información sobre la API, consulte DescribeEngagement en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar describe-page.

AWS CLI

Para enumerar los detalles de una página en un canal de contacto

En el siguiente ejemplo de describe-page, se enumeran los detalles de una página para un canal de contacto. La página incluirá el asunto y el contenido proporcionados.

aws ssm-contacts describe-page \
    --page-id "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93"

Salida:

{
    "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93",
    "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0",
    "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
    "Sender": "cli",
    "Subject": "cli-test",
    "Content": "Testing engagements via CLI",
    "PublicSubject": "cli-test",
    "PublicContent": "Testing engagements va CLI",
    "SentTime": "2021-05-18T18:43:29.301000+00:00",
    "ReadTime": "2021-05-18T18:43:55.708000+00:00",
    "DeliveryTime": "2021-05-18T18:43:55.265000+00:00"
}

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

  • Para obtener información sobre la API, consulte DescribePage en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar get-contact-channel.

AWS CLI

Para enumerar los detalles de un canal de contacto

En el siguiente ejemplo de get-contact-channel, se enumeran los detalles de un canal de contacto.

aws ssm-contacts get-contact-channel \
    --contact-channel-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"

Salida:

{
    "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
    "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
    "Name": "akuas sms",
    "Type": "SMS",
    "DeliveryAddress": {
        "SimpleAddress": "+15005550199"
    },
    "ActivationStatus": "ACTIVATED"
}

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

  • Para obtener información sobre la API, consulte GetContactChannel en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar get-contact-policy.

AWS CLI

Para enumerar las políticas de recursos de un contacto

En el siguiente ejemplo de get-contact-policy, se enumeran las políticas de recursos asociadas al contacto especificado.

aws ssm-contacts get-contact-policy \
    --contact-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"

Salida:

{
    "ContactArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
    "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"SharePolicyForDocumentationDralia\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"222233334444\"},\"Action\":[\"ssm-contacts:GetContact\",\"ssm-contacts:StartEngagement\",\"ssm-contacts:DescribeEngagement\",\"ssm-contacts:ListPagesByEngagement\",\"ssm-contacts:StopEngagement\"],\"Resource\":[\"arn:aws:ssm-contacts:*:111122223333:contact/akuam\",\"arn:aws:ssm-contacts:*:111122223333:engagement/akuam/*\"]}]}"
}

Para obtener más información, consulte Working with shared contacts and response plans en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte GetContactPolicy en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar get-contact.

AWS CLI

Ejemplo 1: descripción de un plan de contactos

En el siguiente ejemplo de get-contact, se describe un contacto.

aws ssm-contacts get-contact \
    --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"

Salida:

{
    "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
    "Alias": "akuam",
    "DisplayName": "Akua Mansa",
    "Type": "PERSONAL",
    "Plan": {
        "Stages": [
            {
                "DurationInMinutes": 5,
                "Targets": [
                    {
                        "ChannelTargetInfo": {
                            "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65",
                            "RetryIntervalInMinutes": 1
                        }
                    }
                ]
            },
            {
                "DurationInMinutes": 5,
                "Targets": [
                    {
                        "ChannelTargetInfo": {
                            "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad",
                            "RetryIntervalInMinutes": 1
                        }
                    }
                ]
            },
            {
                "DurationInMinutes": 5,
                "Targets": [
                    {
                        "ChannelTargetInfo": {
                            "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a",
                            "RetryIntervalInMinutes": 1
                        }
                    }
                ]
            }
        ]
    }
}

Ejemplo 2: descripción de un plan de escalamiento

En el siguiente ejemplo de get-contact, se describe un plan de escalamiento.

aws ssm-contacts get-contact \
--contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation"

Salida:

{
    "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
    "Alias": "example_escalation",
    "DisplayName": "Example Escalation",
    "Type": "ESCALATION",
    "Plan": {
        "Stages": [
            {
                "DurationInMinutes": 5,
                "Targets": [
                    {
                        "ContactTargetInfo": {
                            "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
                            "IsEssential": true
                        }
                    }
                ]
            },
            {
                "DurationInMinutes": 5,
                "Targets": [
                    {
                        "ContactTargetInfo": {
                            "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr",
                            "IsEssential": false
                        }
                    }
                ]
            },
            {
                "DurationInMinutes": 0,
                "Targets": [
                    {
                        "ContactTargetInfo": {
                            "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi",
                            "IsEssential": false
                        }
                    }
                ]
            }
        ]
    }
}

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

  • Para obtener información sobre la API, consulte GetContact en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar list-contact-channels.

AWS CLI

Para enumerar los canales de contacto de un contacto

En el siguiente ejemplo de list-contact-channels, se enumeran los canales de contacto disponibles del contacto especificado.

aws ssm-contacts list-contact-channels \
    --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"

Salida:

{
    [
        {
            "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
            "Name": "akuas email",
            "Type": "EMAIL",
            "DeliveryAddress": {
                "SimpleAddress": "akuam@example.com"
            },
            "ActivationStatus": "NOT_ACTIVATED"
        },
        {
            "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
            "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
            "Name": "akuas sms",
            "Type": "SMS",
            "DeliveryAddress": {
                "SimpleAddress": "+15005550100"
            },
            "ActivationStatus": "ACTIVATED"
        }
    ]
}

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

  • Para obtener información sobre la API, consulte ListContactChannels en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar list-contacts.

AWS CLI

Para enumerar todos los planes de escalamiento y los contactos

En el siguiente ejemplo de list-contacts, se enumeran los contactos y los planes de escalamiento de su cuenta.

aws ssm-contacts list-contacts

Salida:

{
    "Contacts": [
        {
            "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
            "Alias": "akuam",
            "DisplayName": "Akua Mansa",
            "Type": "PERSONAL"
        },
        {
            "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr",
            "Alias": "alejr",
            "DisplayName": "Alejandro Rosalez",
            "Type": "PERSONAL"
        },
        {
            "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi",
            "Alias": "anasi",
            "DisplayName": "Ana Carolina Silva",
            "Type": "PERSONAL"
        },
        {
            "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
            "Alias": "example_escalation",
            "DisplayName": "Example Escalation",
            "Type": "ESCALATION"
        }
    ]
}

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

  • Para obtener información sobre la API, consulte ListContacts en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar list-engagements.

AWS CLI

Para enumerar todas las interacciones

En el siguiente ejemplo de list-engagements, se enumeran las interacciones con los planes de escalamiento y los contactos. También puede enumerar las interacciones de un solo incidente.

aws ssm-contacts list-engagements

Salida:

{
    "Engagements": [
        {
            "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/91792571-0b53-4821-9f73-d25d13d9e529",
            "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
            "Sender": "cli",
            "StartTime": "2021-05-18T20:37:50.300000+00:00"
        },
        {
            "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0",
            "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
            "Sender": "cli",
            "StartTime": "2021-05-18T18:40:26.666000+00:00"
        },
        {
            "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356",
            "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
            "Sender": "cli",
            "StartTime": "2021-05-18T18:25:41.151000+00:00"
        },
        {
            "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f",
            "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
            "Sender": "cli",
            "StartTime": "2021-05-18T18:20:58.093000+00:00"
        }
    ]
}

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

  • Para obtener información sobre la API, consulte ListEngagements en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar list-page-receipts.

AWS CLI

Para enumerar las recepciones de páginas

En el siguiente ejemplo de command-name, se indica si un contacto ha recibido o no una página.

aws ssm-contacts list-page-receipts \
    --page-id "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3"

Salida:

{
    "Receipts": [
        {
            "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
            "ReceiptType": "DELIVERED",
            "ReceiptInfo": "425440",
            "ReceiptTime": "2021-05-18T20:42:57.485000+00:00"
        },
        {
            "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
            "ReceiptType": "READ",
            "ReceiptInfo": "425440",
            "ReceiptTime": "2021-05-18T20:42:57.907000+00:00"
        },
        {
            "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
            "ReceiptType": "SENT",
            "ReceiptInfo": "SM6656c19132f1465f9c9c1123a5dde7c9",
            "ReceiptTime": "2021-05-18T20:40:52.962000+00:00"
        }
    ]
}

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

  • Para obtener información sobre la API, consulte ListPageReceipts en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar list-pages-by-contact.

AWS CLI

Para enumerar las páginas por contacto

En el siguiente ejemplo de list-pages-by-contact, se muestran todas las páginas del contacto especificado.

aws ssm-contacts list-pages-by-contact \
    --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"

Salida:

{
    "Pages": [
        {
            "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93",
            "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0",
            "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
            "Sender": "cli",
            "SentTime": "2021-05-18T18:43:29.301000+00:00",
            "DeliveryTime": "2021-05-18T18:43:55.265000+00:00",
            "ReadTime": "2021-05-18T18:43:55.708000+00:00"
        }
    ]
}

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

  • Para obtener información sobre la API, consulte ListPagesByContact en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar list-pages-by-engagement.

AWS CLI

Para enumerar las páginas de los canales de contacto iniciadas a partir de una interacción

En el siguiente ejemplo de list-pages-by-engagement, se enumeran las páginas que han aparecido al participar en el plan de interacción definido.

aws ssm-contacts list-pages-by-engagement \
    --engagement-id "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0"

Salida:

{
    "Pages": [
        {
            "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93",
            "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0",
            "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
            "Sender": "cli",
            "SentTime": "2021-05-18T18:40:27.245000+00:00"
        }
    ]
}

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

  • Para obtener información sobre la API, consulte ListPagesByEngagement en la Referencia de comandos de la AWS CLI.

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

AWS CLI

Para enumerar las etiquetas de un contacto

En el siguiente ejemplo list-tags-for-resource, se enumeran las etiquetas del contacto especificado.

aws ssm-contacts list-tags-for-resource \
    --resource-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"

Salida:

{
    "Tags": [
        {
            "Key": "group1",
            "Value": "1"
        }
    ]
}

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

  • Para obtener información sobre la API, consulte ListTagsForResource en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar put-contact-policy.

AWS CLI

Para compartir un contacto y sus interacciones

En el siguiente ejemplo de put-contact-policy, se agrega una política de recursos al contacto Akua que comparte el contacto y las interacciones relacionadas con la entidad principal.

aws ssm-contacts put-contact-policy \
    --contact-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" \
    --policy "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"ExampleResourcePolicy\",\"Action\":[\"ssm-contacts:GetContact\",\"ssm-contacts:StartEngagement\",\"ssm-contacts:DescribeEngagement\",\"ssm-contacts:ListPagesByEngagement\",\"ssm-contacts:StopEngagement\"],\"Principal\":{\"AWS\":\"222233334444\"},\"Effect\":\"Allow\",\"Resource\":[\"arn:aws:ssm-contacts:*:111122223333:contact\/akuam\",\"arn:aws:ssm-contacts:*:111122223333:engagement\/akuam\/*\"]}]}"

Este comando no genera ninguna salida.

Para obtener más información, consulte Working with shared contacts and response plans en la Guía del usuario de Incident Manager.

  • Para obtener información sobre la API, consulte PutContactPolicy en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar send-activation-code.

AWS CLI

Para enviar un código de activación

En el siguiente ejemplo de send-activation-code, se envía un código de activación y un mensaje al canal de contacto especificado.

aws ssm-contacts send-activation-code \
    --contact-channel-id "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/8ddae2d1-12c8-4e45-b852-c8587266c400"

Este comando no genera ninguna salida.

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

  • Para obtener más información sobre la API, consulte SendActivationCode en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar start-engagement.

AWS CLI

Ejemplo 1: paginación de los canales de contacto de un contacto

Las siguientes páginas de start-engagement son los canales de contacto del contacto. Los campos sender, subject, public-subject y public-content se pueden rellenar libremente. Incident Manager envía el contenido de subject y content a los canales de contacto VOICE o EMAIL proporcionados. Incident Manager envía el contenido de public-subject y public-content a los canales de contacto SMS proporcionados. El contenido de sender se utiliza para saber quién inició la interacción.

aws ssm-contacts start-engagement \
    --contact-id  "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" \
    --sender "cli" \
    --subject "cli-test" \
    --content "Testing engagements via CLI" \
    --public-subject "cli-test" \
    --public-content "Testing engagements va CLI"

Salida:

{
    "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f"
}

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

Ejemplo 2: paginación de un contacto en el plan de escalamiento proporcionado

En el siguiente ejemplo de start-engagement, se interactúa con el contacto a través de un plan de escalamiento. Cada contacto se pagina de acuerdo con su plan de interacción.

aws ssm-contacts start-engagement \
    --contact-id  "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation" \
    --sender "cli" \
    --subject "cli-test" \
    --content "Testing engagements via CLI" \
    --public-subject "cli-test" \
    --public-content "Testing engagements va CLI"

Salida:

{
    "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"
}

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

  • Para obtener información sobre la API, consulte StartEngagement en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar stop-engagement.

AWS CLI

Para detener una interacción

En el siguiente ejemplo de stop-engagement, se impide que una interacción pagine más contactos y canales de contacto.

aws ssm-contacts stop-engagement \
    --engagement-id "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"

Este comando no genera ninguna salida.

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

  • Para obtener información sobre la API, consulte StopEngagement en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar tag-resource.

AWS CLI

Para etiquetar un contacto

En el siguiente ejemplo de tag-resource, se etiqueta un contacto especificado con el par clave-valor de etiquetas proporcionado.

aws ssm-contacts tag-resource \
    --resource-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" \
    --tags '[{"Key":"group1","Value":"1"}]'

Este comando no genera ninguna salida.

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

  • Para ver los detalles de la API, consulte TagResource en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar untag-resource.

AWS CLI

Para eliminar etiquetas de un contacto

En el siguiente ejemplo de untag-resource, se elimina la etiqueta group1 del contacto especificado.

aws ssm-contacts untag-resource \
    --resource-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" \
    --tag-keys "group1"

Este comando no genera ninguna salida.

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

  • Para obtener información sobre la API, consulte UntagResource en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar update-contact-channel.

AWS CLI

Para actualizar un canal de contacto

En el siguiente ejemplo de update-contact-channel, se actualiza el nombre y la dirección de entrega de un canal de contacto.

aws ssm-contacts update-contact-channel \
    --contact-channel-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad" \
    --name "akuas voice channel" \
    --delivery-address '{"SimpleAddress": "+15005550198"}'

Este comando no genera ninguna salida.

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

  • Para obtener información sobre la API, consulte UpdateContactChannel en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar update-contact.

AWS CLI

Para actualizar el plan de interacción del contacto

En el siguiente ejemplo de update-contact, se actualiza el plan de interacción del contacto Akua para incluir los tres tipos de canales de contacto. Esto se hace después de crear los canales de contacto para Akua.

aws ssm-contacts update-contact \
    --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" \
    --plan '{"Stages": [{"DurationInMinutes": 5, "Targets": [{"ChannelTargetInfo": {"ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65","RetryIntervalInMinutes": 1 }}]}, {"DurationInMinutes": 5, "Targets": [{"ChannelTargetInfo":{"ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad", "RetryIntervalInMinutes": 1}}]}, {"DurationInMinutes": 5, "Targets": [{"ChannelTargetInfo": {"ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a","RetryIntervalInMinutes": 1 }}]}]}'

Este comando no genera ninguna salida.

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

  • Para obtener información sobre la API, consulte UpdateContact en la Referencia de comandos de la AWS CLI.