Esta documentação é somente para a versão 1 da AWS CLI. Para obter a documentação relacionada à AWS CLI versão 2, consulte o Guia do usuário da versão 2.
Exemplos do Incident Manager Contacts usando a AWS CLI
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Incident Manager Contacts.
Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
Tópicos
Ações
O código de exemplo a seguir mostra como usar accept-page
.
- AWS CLI
-
Como aceitar uma página durante uma interação
O exemplo
accept-page
a seguir usa um código de aceitação enviado ao canal de contato para aceitar uma 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-typeREAD
\ --accept-code425440
Este comando não produz saída
Para obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte AcceptPage
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar activate-contact-channel
.
- AWS CLI
-
Ativar o canal de comunicação de um contato.
O exemplo
activate-contact-channel
a seguir ativa um canal de contato e o torna utilizável como parte de um 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 não produz saída.
Para obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte ActivateContactChannel
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar command-name
.
- AWS CLI
-
Para excluir um contato
O exemplo
command-name
a seguir exclui um contato. O contato não estará mais acessível a partir de nenhum plano de escalonamento que se refira a ele.aws ssm-contacts delete-contact \ --contact-id
"arn:aws:ssm-contacts:us-east-1:682428703967:contact/alejr"
Este comando não produz saída.
Para obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte CommandName
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar create-contact-channel
.
- AWS CLI
-
Para criar um canal de contato
Cria um canal de contato do tipo SMS para o contato Akua Mansa. Canais de contato podem ser criados do tipo SMS, E-MAIL ou VOZ.
aws ssm-contacts create-contact-channel \ --contact-id
"arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"
\ --name"akuas sms-test"
\ --typeSMS
\ --delivery-address '{"SimpleAddress": "+15005550199"}
'Saída:
{ "ContactChannelArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/02f506b9-ea5d-4764-af89-2daa793ff024" }
Para obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte CreateContactChannel
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar create-contact
.
- AWS CLI
-
Para criar um contato
O exemplo
create-contact
a seguir cria um contato em seu ambiente com um plano em branco. O plano pode ser atualizado após a criação dos canais de contato. Use o comando create-contact-channel com o ARN de saída desse comando. Depois de criar canais de contato para esse contato, use update-contact para atualizar o plano.aws ssm-contacts create-contact \ --alias
"akuam"
\ --display-name"Akua Mansa"
\ --typePERSONAL
\ --plan '{"Stages": []}
'Saída:
{ "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" }
Para obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte CreateContact
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar deactivate-contact-channel
.
- AWS CLI
-
Para desativar um canal de contato
O exemplo
deactivate-contact-channel
a seguir desativa um canal de contato. Desativar um canal de contato significa que o canal de contato não será mais paginado durante um incidente. Você também pode reativar um canal de contato a qualquer momento usando o comandoactivate-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 não produz saída.
Para obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte DeactivateContactChannel
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar delete-contact-channel
.
- AWS CLI
-
Para excluir um canal de contato
O exemplo
delete-contact-channel
a seguir exclui um canal de contato. A exclusão de um canal de contato garante que o canal de contato não seja paginado durante um 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 não produz saída.
Para obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte DeleteContactChannel
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar delete-contact
.
- AWS CLI
-
Para excluir um contato
O exemplo
delete-contact
a seguir exclui um contato. O contato não estará mais acessível a partir de nenhum plano de escalonamento que se refira a ele.aws ssm-contacts delete-contact \ --contact-id
"arn:aws:ssm-contacts:us-east-1:111122223333:contact/alejr"
Este comando não produz saída.
Para obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte DeleteContact
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar describe-engagement
.
- AWS CLI
-
Para descrever os detalhes de uma interação
O exemplo
describe-engagement
a seguir lista os detalhes de uma interação com um plano de contato ou escalonamento. O assunto e o conteúdo são enviados para os canais de contato.aws ssm-contacts describe-engagement \ --engagement-id
"arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"
Saída:
{ "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 obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte DescribeEngagement
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar describe-page
.
- AWS CLI
-
Para listar os detalhes de uma página em um canal de contato
O exemplo
describe-page
a seguir lista os detalhes de uma página em um canal de contato. A página incluirá o assunto e o conteúdo fornecidos.aws ssm-contacts describe-page \ --page-id
"arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93"
Saída:
{ "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 obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte DescribePage
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar get-contact-channel
.
- AWS CLI
-
Para listar os detalhes de um canal de contato
O exemplo
get-contact-channel
a seguir lista os detalhes de um canal de contato.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"
Saída:
{ "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 obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte GetContactChannel
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar get-contact-policy
.
- AWS CLI
-
Para listar as políticas de recursos de um contato
O exemplo
get-contact-policy
a seguir lista as políticas de recursos associadas ao contato especificado.aws ssm-contacts get-contact-policy \ --contact-arn
"arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"
Saída:
{ "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 obter mais informações, consulte Como trabalhar com contatos e planos de resposta no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte GetContactPolicy
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar get-contact
.
- AWS CLI
-
Exemplo 1: descrever um plano de contato
O exemplo
get-contact
a seguir descreve um contato.aws ssm-contacts get-contact \ --contact-id
"arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
Saída:
{ "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 } } ] } ] } }
Exemplo 2: descrever um plano de escalonamento
O exemplo
get-contact
a seguir descreve um plano de escalonamento.aws ssm-contacts get-contact \ --contact-id
"arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation"
Saída:
{ "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 obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte GetContact
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-contact-channels
.
- AWS CLI
-
Para listar os canais de contato de um contato
O exemplo
list-contact-channels
a seguir lista os canais de contato disponíveis do contato especificado.aws ssm-contacts list-contact-channels \ --contact-id
"arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
Saída:
{ [ { "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 obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte ListContactChannels
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-contacts
.
- AWS CLI
-
Para listar todos os planos e contatos de escalonamento
O exemplo
list-contacts
a seguir lista os contatos e os planos de escalonamento em sua conta.aws ssm-contacts list-contacts
Saída:
{ "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 obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte ListContacts
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-engagements
.
- AWS CLI
-
Para listar todas as interações
O exemplo
list-engagements
a seguir lista os compromissos com planos e contatos de escalonamento. Você também pode listar interações para um único incidente.aws ssm-contacts list-engagements
Saída:
{ "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 obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte ListEngagements
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-page-receipts
.
- AWS CLI
-
Para listar os recibos da página
O exemplo
command-name
a seguir lista se uma página foi recebida ou não por um contato.aws ssm-contacts list-page-receipts \ --page-id
"arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3"
Saída:
{ "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 obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte ListPageReceipts
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-pages-by-contact
.
- AWS CLI
-
Para listar páginas por contato
O exemplo
list-pages-by-contact
a seguir lista todas as páginas do contato especificado.aws ssm-contacts list-pages-by-contact \ --contact-id
"arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
Saída:
{ "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 obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte ListPagesByContact
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-pages-by-engagement
.
- AWS CLI
-
Como páginas para canais de contato iniciados a partir de uma interação.
O exemplo
list-pages-by-engagement
a seguir lista as páginas que ocorreram ao interagir com o plano de interação 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"
Saída:
{ "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 obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte ListPagesByEngagement
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-tags-for-resource
.
- AWS CLI
-
Para listar tags para um contato
O exemplo
list-tags-for-resource
a seguir lista as tags do contato especificado.aws ssm-contacts list-tags-for-resource \ --resource-arn
"arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"
Saída:
{ "Tags": [ { "Key": "group1", "Value": "1" } ] }
Para obter mais informações, consulte Marcações no Guia do usuário do Incident Manager.
-
Para obter detalhes sobre a API, consulte ListTagsForResource
na AWS CLI Command Reference.
-
O código de exemplo a seguir mostra como usar put-contact-policy
.
- AWS CLI
-
Como compartilhar um contato e interações
O exemplo
put-contact-policy
a seguir adiciona uma política de recursos ao contato Akua que compartilha o contato e os compromissos relacionados com a entidade 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 não produz saída.
Para obter mais informações, consulte Como trabalhar com contatos e planos de resposta no Guia do usuário do Incident Manager.
-
Consulte detalhes da API em PutContactPolicy
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar send-activation-code
.
- AWS CLI
-
Como enviar um código de ativação
O exemplo
send-activation-code
a seguir envia um código de ativação e uma mensagem para o canal de contato 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 não produz saída.
Para obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte SendActivationCode
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar start-engagement
.
- AWS CLI
-
Exemplo 1: paginar os canais de comunicação de um contato.
As páginas de
start-engagement
a seguir entram em contato com os canais de contato. Remetente, assunto, assunto público e conteúdo público estão todos livres de campos. O Incident Manager envia o assunto e o conteúdo para os canais de contato de VOZ ou E-MAIL fornecidos. O Incident Manager envia o assunto público e o conteúdo público para os canais de contato por SMS fornecidos. O remetente é usado para rastrear quem iniciou a interação.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"
Saída:
{ "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f" }
Para obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
Exemplo 2: paginar um contato no plano de escalonamento fornecido.
O
start-engagement
a seguir envolve os contatos por meio de um plano de escalonamento. Cada contato é paginado de acordo com seu plano de interação.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"
Saída:
{ "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356" }
Para obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte StartEngagement
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar stop-engagement
.
- AWS CLI
-
Como interromper uma interação
O exemplo
stop-engagement
a seguir impede que uma interação pagine outros contatos e canais de contato.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 não produz saída.
Para obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte StopEngagement
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar tag-resource
.
- AWS CLI
-
Como marcar um contato
O exemplo
tag-resource
a seguir marca um contato especificado com o par de chave-valor de tag fornecido.aws ssm-contacts tag-resource \ --resource-arn
"arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"
\ --tags '[{"Key":"group1","Value":"1"}]
'Este comando não produz saída.
Para obter mais informações, consulte Marcações no Guia do usuário do Incident Manager.
-
Para obter detalhes da API, consulte TagResource
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar untag-resource
.
- AWS CLI
-
Para remover tags de um contato
O exemplo
untag-resource
a seguir remove a tag group1 do contato especificado.aws ssm-contacts untag-resource \ --resource-arn
"arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"
\ --tag-keys"group1"
Este comando não produz saída.
Para obter mais informações, consulte Marcações no Guia do usuário do Incident Manager.
-
Para obter detalhes sobre a API, consulte UntagResource
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar update-contact-channel
.
- AWS CLI
-
Para atualizar um canal de contato
O exemplo
update-contact-channel
a seguir atualiza o nome e o endereço de entrega de um canal de contato.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 não produz saída.
Para obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte UpdateContactChannel
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar update-contact
.
- AWS CLI
-
Para atualizar o plano de interação do contato
O exemplo
update-contact
a seguir atualiza o plano de engajamento do contato Akua para incluir os três tipos de canais de contatos. Isso é feito depois de criar canais de contato 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 não produz saída.
Para obter mais informações, consulte Contatos no Guia do usuário do Incident Manager.
-
Para ver detalhes da API, consulte UpdateContact
na Referência de comandos da AWS CLI.
-