

# Exemplos do CloudWatch Synthetics usando a AWS CLI
<a name="cli_synthetics_code_examples"></a>

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o CloudWatch Synthetics.

*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.

**Topics**
+ [Ações](#actions)

## Ações
<a name="actions"></a>

### `associate-resource`
<a name="synthetics_AssociateResource_cli_topic"></a>

O código de exemplo a seguir mostra como usar `associate-resource`.

**AWS CLI**  
**Como associar um canário a um grupo**  
O exemplo de `associate-resource` a seguir associa um canário a um grupo chamado `demo_group`.  

```
aws synthetics associate-resource \
    --group-identifier demo_group \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary
```
Este comando não produz saída.  
Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*.  
+  Consulte detalhes da API em [AssociateResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/associate-resource.html) na *Referência de comandos da AWS CLI*. 

### `create-canary`
<a name="synthetics_CreateCanary_cli_topic"></a>

O código de exemplo a seguir mostra como usar `create-canary`.

**AWS CLI**  
**Como criar um canário**  
O exemplo de `create-canary` a seguir cria um canário chamado `demo_canary`.  

```
aws synthetics create-canary \
    --name demo_canary \
    --code '{"S3Bucket": "artifacts3bucket", "S3Key":"demo_canary.zip", "Handler": "index.lambda_handler"}' \
    --artifact-s3-location s3://amzn-s3-demo-bucket/demo_canary.zip \
    --execution-role-arn arn:aws:iam::123456789012:role/demo_canary_role \
    --schedule Expression="rate(10 minutes)" \
    --runtime-version syn-nodejs-puppeteer-9.1
```
Resultado:  

```
{
    "Canary": {
        "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
        "Name": "demo_canary",
        "Code": {
            "Handler": "index.lambda_handler"
        },
        "ExecutionRoleArn": "arn:aws:iam::123456789012:role/demo_canary_role",
        "Schedule": {
            "Expression": "rate(10 minutes)",
            "DurationInSeconds": 0
        },
        "RunConfig": {
            "TimeoutInSeconds": 600,
            "MemoryInMB": 1000,
            "ActiveTracing": false
        },
        "SuccessRetentionPeriodInDays": 31,
        "FailureRetentionPeriodInDays": 31,
        "Status": {
            "State": "CREATING",
            "StateReasonCode": "CREATE_PENDING"
        },
        "Timeline": {
            "Created": "2024-10-15T19:03:08.826000+05:30",
            "LastModified": "2024-10-15T19:03:08.826000+05:30"
        },
        "ArtifactS3Location": "amzn-s3-demo-bucket/demo_canary.zip",
        "RuntimeVersion": "syn-nodejs-puppeteer-9.1",
        "Tags": {}
    }
}
```
Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*.  
+  Consulte detalhes da API em [CreateCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/create-canary.html) na *Referência de comandos da AWS CLI*. 

### `create-group`
<a name="synthetics_CreateGroup_cli_topic"></a>

O código de exemplo a seguir mostra como usar `create-group`.

**AWS CLI**  
**Para criar um grupo**  
O exemplo `create-group` a seguir cria um grupo chamado `demo_group`.  

```
aws synthetics create-group \
    --name demo_group
```
Resultado:  

```
{
    "Group": {
        "Id": "example123",
        "Name": "demo_group",
        "Arn": "arn:aws:synthetics:us-east-1:123456789012:group:example123",
        "Tags": {},
        "CreatedTime": "2024-10-15T14:47:23.811000+05:30",
        "LastModifiedTime": "2024-10-15T14:47:23.811000+05:30"
    }
}
```
Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*.  
+  Consulte detalhes da API em [CreateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/create-group.html) na *Referência de comandos da AWS CLI*. 

### `delete-canary`
<a name="synthetics_DeleteCanary_cli_topic"></a>

O código de exemplo a seguir mostra como usar `delete-canary`.

**AWS CLI**  
**Como excluir permanentemente um canário**  
O exemplo de `delete-canary` a seguir exclui um canário chamado `demo_canary`.  

```
aws synthetics delete-canary \
    --name demo_canary
```
Este comando não produz saída.  
Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*.  
+  Consulte detalhes da API em [DeleteCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/delete-canary.html) na *Referência de comandos da AWS CLI*. 

### `delete-group`
<a name="synthetics_DeleteGroup_cli_topic"></a>

O código de exemplo a seguir mostra como usar `delete-group`.

**AWS CLI**  
**Para excluir um grupo**  
O exemplo de `delete-group` a seguir exclui um grupo chamado `demo_group`.  

```
aws synthetics delete-group \
    --group-identifier demo_group
```
Este comando não produz saída.  
Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*.  
+  Consulte detalhes da API em [DeleteGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/delete-group.html) na *Referência de comandos da AWS CLI*. 

### `describe-canaries-last-run`
<a name="synthetics_DescribeCanariesLastRun_cli_topic"></a>

O código de exemplo a seguir mostra como usar `describe-canaries-last-run`.

**AWS CLI**  
**Como ver informações da execução mais recente de cada canário**  
O exemplo de `describe-canaries-last-run` a seguir retorna a execução mais recente de cada canário que você criou.  

```
aws synthetics describe-canaries-last-run
```
Resultado:  

```
{
    "CanariesLastRun": [
        {
            "CanaryName": "demo_canary",
            "LastRun": {
                "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
                "Name": "demo_canary",
                "Status": {
                    "State": "PASSED",
                    "StateReason": "",
                    "StateReasonCode": ""
                },
                "Timeline": {
                    "Started": "2024-10-15T19:20:39.691000+05:30",
                    "Completed": "2024-10-15T19:20:58.211000+05:30"
                },
                "ArtifactS3Location": "cw-syn-results-123456789012-us-east-1/canary/us-east-1/demo_canary-abc-example1234/2024/10/15/13/50-39-690"
            }
        }
    ]
}
```
Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*.  
+  Consulte detalhes da API em [DescribeCanariesLastRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/describe-canaries-last-run.html) na *Referência de comandos da AWS CLI*. 

### `describe-canaries`
<a name="synthetics_DescribeCanaries_cli_topic"></a>

O código de exemplo a seguir mostra como usar `describe-canaries`.

**AWS CLI**  
**Como listar canários em sua conta**  
O exemplo de `describe-canaries` a seguir lista os detalhes de canários em sua conta.  

```
aws synthetics describe-canaries
```
Resultado:  

```
{
    "Canaries": [
        {
            "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
            "Name": "demo_canary",
            "Code": {
                "SourceLocationArn": "arn:aws:lambda:us-east-1:123456789012:layer:cwsyn-demo_canary-a1b2c3d4-5678-90ab-cdef-example11111b8:1",
                "Handler": "pageLoadBlueprint.handler"
            },
            "ExecutionRoleArn": "arn:aws:iam::123456789012:role/service-role/CloudWatchSyntheticsRole-demo_canary-a12-a123bc456789",
            "Schedule": {
                "Expression": "rate(5 minutes)",
                "DurationInSeconds": 0
            },
            "RunConfig": {
                "TimeoutInSeconds": 300,
                "MemoryInMB": 1000,
                "ActiveTracing": false
            },
            "SuccessRetentionPeriodInDays": 31,
            "FailureRetentionPeriodInDays": 31,
            "Status": {
            "State": "RUNNING"
            },
            "Timeline": {
                "Created": "2024-10-15T18:55:15.168000+05:30",
                "LastModified": "2024-10-15T18:55:40.540000+05:30",
                "LastStarted": "2024-10-15T18:55:40.540000+05:30"
            },
            "ArtifactS3Location": "cw-syn-results-123456789012-us-east-1/canary/us-east-1/demo_canary-a12-a123bc456789",
            "EngineArn": "arn:aws:lambda:us-east-1:123456789012:function:cwsyn-demo_canary-a1b2c3d4-5678-90ab-cdef-example111118:1",
            "RuntimeVersion": "syn-nodejs-puppeteer-9.1",
            "Tags": {
                "blueprint": "heartbeat"
            }
        }
    ]
}
```
Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*.  
+  Consulte detalhes da API em [DescribeCanaries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/describe-canaries.html) na *Referência de comandos da AWS CLI*. 

### `describe-runtime-versions`
<a name="synthetics_DescribeRuntimeVersions_cli_topic"></a>

O código de exemplo a seguir mostra como usar `describe-runtime-versions`.

**AWS CLI**  
**Como retornar uma lista de versões de runtime do canário do Synthetics**  
O exemplo de `describe-runtime-versions` a seguir retorna a lista de versões de runtime do canário do Synthetics.  

```
aws synthetics describe-runtime-versions
```
Resultado:  

```
{
    "RuntimeVersions": [
        {
            "VersionName": "syn-nodejs-puppeteer-9.1",
            "Description": "Security fixes and bug fix for date range error in har. Dependencies: Node JS 20.x, Puppeteer-core 22.12.1, Chromium 126.0.6478.126",
            "ReleaseDate": "2024-10-02T05:30:00+05:30"
        },
        {
            "VersionName": "syn-nodejs-puppeteer-9.0",
            "Description": "Upgraded Chromium and Puppeteer. Dependencies: Node JS 20.x, Puppeteer-core 22.12.1, Chromium 126.0.6478.126",
            "ReleaseDate": "2024-07-22T05:30:00+05:30"
        },
        {
            "VersionName": "syn-nodejs-puppeteer-8.0",
            "Description": "Upgraded Chromium and Puppeteer. Dependencies: Node JS 20.x, Puppeteer-core 22.10.0, Chromium 125.0.6422.112",
            "ReleaseDate": "2024-06-21T05:30:00+05:30"
        },
        {
            "VersionName": "syn-nodejs-puppeteer-7.0",
            "Description": "Upgraded Chromium and Puppeteer. Dependencies: Node JS 18.x, Puppeteer-core 21.9.0, Chromium 121.0.6167.139",
            "ReleaseDate": "2024-03-08T05:30:00+05:30"
            },
        {
            "VersionName": "syn-nodejs-puppeteer-6.2",
            "Description": "Updated shared libraries for Chromium and added ephemeral storage monitoring. Dependencies: Node JS 18.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146",
            "ReleaseDate": "2024-02-02T05:30:00+05:30"
        },
        {
            "VersionName": "syn-nodejs-puppeteer-6.1",
            "Description": "Added puppeteer launch retry. Dependencies: Node JS 18.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146",
            "ReleaseDate": "2023-11-13T05:30:00+05:30",
            "DeprecationDate": "2024-03-08T13:30:00+05:30"
        },
        {
            "VersionName": "syn-nodejs-puppeteer-6.0",
            "Description": "Reduced X-Ray traces of a canary run, improved duration metric and upgraded to NodeJS 18.x. Dependencies: Node JS 18.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146",
            "ReleaseDate": "2023-09-15T05:30:00+05:30",
            "DeprecationDate": "2024-03-08T13:30:00+05:30"
        },
        {
            "VersionName": "syn-nodejs-puppeteer-5.2",
            "Description": "Updated shared libraries for Chromium. Dependencies: Node JS 16.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146",
            "ReleaseDate": "2024-02-01T05:30:00+05:30"
        },
        {
            "VersionName": "syn-nodejs-puppeteer-5.1",
            "Description": "Fixes a bug about missing request headers in har. Dependencies: Node JS 16.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146",
            "ReleaseDate": "2023-08-09T05:30:00+05:30",
            "DeprecationDate": "2024-03-08T13:30:00+05:30"
        },
        {
            "VersionName": "syn-nodejs-puppeteer-5.0",
            "Description": "Upgraded Puppeteer and Chromium. Dependencies: Node JS 16.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146",
            "ReleaseDate": "2023-07-21T05:30:00+05:30",
            "DeprecationDate": "2024-03-08T13:30:00+05:30"
        },
        {
            "VersionName": "syn-nodejs-puppeteer-4.0",
            "Description": "Upgraded to NodeJS 16.x. Dependencies: Node JS 16.x, Puppeteer-core 5.5.0, Chromium 92.0.4512.0",
            "ReleaseDate": "2023-05-01T05:30:00+05:30",
            "DeprecationDate": "2024-03-08T13:30:00+05:30"
        }
    ]
}
```
Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*.  
+  Consulte detalhes da API em [DescribeRuntimeVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/describe-runtime-versions.html) na *Referência de comandos da AWS CLI*. 

### `disassociate-resource`
<a name="synthetics_DisassociateResource_cli_topic"></a>

O código de exemplo a seguir mostra como usar `disassociate-resource`.

**AWS CLI**  
**Como remover um canário de um grupo**  
O exemplo de `disassociate-resource` a seguir remove um canário do grupo chamado `demo_group`.  

```
aws synthetics disassociate-resource \
    --group-identifier demo_group \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary
```
Este comando não produz saída.  
Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*.  
+  Consulte detalhes da API em [DisassociateResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/disassociate-resource.html) na *Referência de comandos da AWS CLI*. 

### `get-canary-runs`
<a name="synthetics_GetCanaryRuns_cli_topic"></a>

O código de exemplo a seguir mostra como usar `get-canary-runs`.

**AWS CLI**  
**Como recuperar uma lista de execuções para um canário especificado**  
O exemplo de `get-canary-runs` a seguir recupera uma lista de execuções do canário chamado `demo_canary`.  

```
aws synthetics get-canary-runs \
    --name demo_canary
```
Resultado:  

```
{
    "CanaryRuns": [
        {
            "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
            "Name": "demo_canary",
            "Status": {
                "State": "PASSED",
                "StateReason": "",
                "StateReasonCode": ""
            },
            "Timeline": {
                "Started": "2024-10-16T10:38:57.013000+05:30",
                "Completed": "2024-10-16T10:39:25.793000+05:30"
            },
            "ArtifactS3Location": "cw-syn-results-123456789012-us-east-1/canary/us-east-1/demo_canary-abc-example1234/2024/10/15/13/50-39-690"
        }
    ]
}
```
Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*.  
+  Consulte detalhes da API em [GetCanaryRuns](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/get-canary-runs.html) na *Referência de comandos da AWS CLI*. 

### `get-canary`
<a name="synthetics_GetCanary_cli_topic"></a>

O código de exemplo a seguir mostra como usar `get-canary`.

**AWS CLI**  
**Como recuperar informações completas sobre um canário**  
O exemplo de `get-canary` a seguir recupera informações completas sobre o canário chamado `demo_canary`.  

```
aws synthetics get-canary \
    --name demo_canary
```
Resultado:  

```
{
    "Canary": {
        "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
        "Name": "demo_canary",
        "Code": {
            "SourceLocationArn": "arn:aws:lambda:us-east-1:123456789012:layer:cwsyn-demo_canary-a1b2c3d4-5678-90ab-cdef-example111118:1",
            "Handler": "pageLoadBlueprint.handler"
        },
        "ExecutionRoleArn": "arn:aws:iam::123456789012:role/demo_canary_role",
        "Schedule": {
            "Expression": "rate(10 minutes)",
            "DurationInSeconds": 0
        },
        "RunConfig": {
            "TimeoutInSeconds": 300,
            "MemoryInMB": 1000,
            "ActiveTracing": false
        },
        "SuccessRetentionPeriodInDays": 31,
        "FailureRetentionPeriodInDays": 31,
        "Status": {
            "State": "RUNNING"
        },
        "Timeline": {
            "Created": "2024-10-15T18:55:15.168000+05:30",
            "LastModified": "2024-10-15T18:55:40.540000+05:30",
            "LastStarted": "2024-10-15T18:55:40.540000+05:30"
        },
        "ArtifactS3Location": "cw-syn-results-123456789012-us-east-1/canary/us-east-1/demo_canary-a12-a123bc456789",
        "EngineArn": "arn:aws:lambda:us-east-1:123456789012:function:cwsyn-demo_canary-a1b2c3d4-5678-90ab-cdef-example111118:1",
        "RuntimeVersion": "syn-nodejs-puppeteer-9.1",
        "Tags": {
            "blueprint": "heartbeat"
        }
    }
}
```
Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*.  
+  Consulte detalhes da API em [GetCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/get-canary.html) na *Referência de comandos da AWS CLI*. 

### `get-group`
<a name="synthetics_GetGroup_cli_topic"></a>

O código de exemplo a seguir mostra como usar `get-group`.

**AWS CLI**  
**Como retornar informações sobre um grupo**  
O exemplo de `get-group` a seguir retorna informações sobre o grupo chamado `demo_group`.  

```
aws synthetics get-group \
    --group-identifier demo_group
```
Resultado:  

```
{
    "Group": {
        "Id": "example123",
        "Name": "demo_group",
        "Arn": "arn:aws:synthetics:us-east-1:123456789012:group:example123",
        "Tags": {},
        "CreatedTime": "2024-10-15T14:47:23.811000+05:30",
        "LastModifiedTime": "2024-10-15T14:47:23.811000+05:30"
    }
}
```
Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*.  
+  Consulte detalhes da API em [GetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/get-group.html) na *Referência de comandos da AWS CLI*. 

### `list-associated-groups`
<a name="synthetics_ListAssociatedGroups_cli_topic"></a>

O código de exemplo a seguir mostra como usar `list-associated-groups`.

**AWS CLI**  
**Como retornar uma lista dos grupos**  
O exemplo de `list-associated-groups` a seguir retorna uma lista dos grupos associados ao canário chamado `demo_canary`.  

```
aws synthetics list-associated-groups \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary
```
Resultado:  

```
{
    "Groups": [
        {
            "Id": "example123",
            "Name": "demo_group",
            "Arn": "arn:aws:synthetics:us-east-1:123456789012:group:example123"
        }
    ]
}
```
Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*.  
+  Consulte detalhes da API em [ListAssociatedGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/list-associated-groups.html) na *Referência de comandos da AWS CLI*. 

### `list-group-resources`
<a name="synthetics_ListGroupResources_cli_topic"></a>

O código de exemplo a seguir mostra como usar `list-group-resources`.

**AWS CLI**  
**Como retornar uma lista dos ARNs dos canários associados ao grupo especificado**  
O exemplo de `list-group-resources` a seguir retorna uma lista dos ARNs dos canários associados ao grupo chamado `demo_group`.  

```
aws synthetics list-group-resources \
    --group-identifier demo_group
```
Resultado:  

```
{
    "Resources": [
        "arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary"
    ]
}
```
Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*.  
+  Para ver detalhes da API, consulte [ListGroupResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/list-group-resources.html) na *Referência de comandos da AWS CLI*. 

### `list-groups`
<a name="synthetics_ListGroups_cli_topic"></a>

O código de exemplo a seguir mostra como usar `list-groups`.

**AWS CLI**  
**Como retornar uma lista de todos os grupos na conta**  
O exemplo de `list-groups` a seguir retorna uma lista de todos os grupos na conta.  

```
aws synthetics list-groups
```
Resultado:  

```
{
    "Groups": [
        {
            "Id": "example123",
            "Name": "demo_group",
            "Arn": "arn:aws:synthetics:us-east-1:123456789012:group:example123"
        }
    ]
}
```
Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*.  
+  Consulte detalhes da API em [ListGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/list-groups.html) na *Referência de comandos da AWS CLI*. 

### `list-tags-for-resource`
<a name="synthetics_ListTagsForResource_cli_topic"></a>

O código de exemplo a seguir mostra como usar `list-tags-for-resource`.

**AWS CLI**  
**Exemplo 1: como exibir as tags associadas a um canário**  
O exemplo de `list-tags-for-resource` a seguir retorna as tags associadas a um canário chamado `demo_canary`.  

```
aws synthetics list-tags-for-resource \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary
```
Resultado:  

```
{
    "Tags": {
        "blueprint": "heartbeat"
    }
}
```
**Exemplo 2: como exibir as tags associadas a um grupo**  
O exemplo de `list-tags-for-resource` a seguir retorna as tags associadas a um grupo chamado `demo_group`.  

```
aws  synthetics list-tags-for-resource \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:group:example123
```
Resultado:  

```
{
    "Tags": {
        "team": "Devops"
    }
}
```
Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*.  
+  Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/list-tags-for-resource.html) na *AWS CLI Command Reference*. 

### `start-canary`
<a name="synthetics_StartCanary_cli_topic"></a>

O código de exemplo a seguir mostra como usar `start-canary`.

**AWS CLI**  
**Como executar um canário**  
O exemplo de `start-canary` a seguir executa um canário chamado `demo_canary`.  

```
aws synthetics start-canary \
    --name demo_canary
```
Este comando não produz saída.  
Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*.  
+  Consulte detalhes da API em [StartCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/start-canary.html) na *Referência de comandos da AWS CLI*. 

### `stop-canary`
<a name="synthetics_StopCanary_cli_topic"></a>

O código de exemplo a seguir mostra como usar `stop-canary`.

**AWS CLI**  
**Como interromper um canário**  
O exemplo de `stop-canary` a seguir interrompe o canário chamado `demo_canary`.  

```
aws synthetics stop-canary \
    --name demo_canary
```
Este comando não produz saída.  
Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*.  
+  Consulte detalhes da API em [StopCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/stop-canary.html) na *Referência de comandos da AWS CLI*. 

### `tag-resource`
<a name="synthetics_TagResource_cli_topic"></a>

O código de exemplo a seguir mostra como usar `tag-resource`.

**AWS CLI**  
**Exemplo 1: como atribuir uma tag ao canário**  
O exemplo de `tag-resource` a seguir atribui uma tag ao canário chamado `demo_canary`.  

```
aws synthetics tag-resource \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary \
    --tags blueprint=heartbeat
```
Este comando não produz saída.  
**Exemplo 2: como atribuir uma tag ao grupo**  
O exemplo de `tag-resource` a seguir atribui uma tag ao grupo chamado `demo_group`.  

```
aws synthetics tag-resource \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:group:example123 \
    --tags team=Devops
```
Este comando não produz saída.  
Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*.  
+  Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/tag-resource.html) na *Referência de comandos da AWS CLI*. 

### `untag-resource`
<a name="synthetics_UntagResource_cli_topic"></a>

O código de exemplo a seguir mostra como usar `untag-resource`.

**AWS CLI**  
**Exemplo 1: como remover uma tag do canário**  
O exemplo de `untag-resource` a seguir remove uma tag do canário chamado `demo_canary`.  

```
aws synthetics untag-resource \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary \
    --tag-keys blueprint
```
Este comando não produz saída.  
**Exemplo 2: como remover uma tag do grupo**  
O exemplo de `untag-resource` a seguir remove uma tag do grupo chamado `demo_group`.  

```
aws synthetics untag-resource \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:group:example123 \
    --tag-keys team
```
Este comando não produz saída.  
Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*.  
+  Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/untag-resource.html) na *Referência de comandos da AWS CLI*. 

### `update-canary`
<a name="synthetics_UpdateCanary_cli_topic"></a>

O código de exemplo a seguir mostra como usar `update-canary`.

**AWS CLI**  
**Como atualizar um canário**  
O exemplo de `update-canary` a seguir atualiza a configuração de um canário chamado `demo_canary`.  

```
aws synthetics update-canary \
    --name demo_canary \
    --schedule Expression="rate(15 minutes)"
```
Este comando não produz saída.  
Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*.  
+  Consulte detalhes da API em [UpdateCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/update-canary.html) na *Referência de comandos da AWS CLI*. 