

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 使用 的 CloudWatch Synthetics 範例 AWS CLI
<a name="cli_synthetics_code_examples"></a>

下列程式碼範例示範如何使用 AWS Command Line Interface 搭配 CloudWatch Synthetics 來執行動作和實作常見案例。

*Actions* 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數，但您可以在其相關情境中查看內容中的動作。

每個範例均包含完整原始碼的連結，您可在連結中找到如何設定和執行內容中程式碼的相關指示。

**Topics**
+ [動作](#actions)

## 動作
<a name="actions"></a>

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

以下程式碼範例顯示如何使用 `associate-resource`。

**AWS CLI**  
**將 Canary 與群組相關聯**  
下列 `associate-resource` 範例為 Canary 與名為 `demo_group` 的群組建立關聯。  

```
aws synthetics associate-resource \
    --group-identifier demo_group \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary
```
此命令不會產生輸出。  
如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》**中的[合成監控 (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [AssociateResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/associate-resource.html)。

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

以下程式碼範例顯示如何使用 `create-canary`。

**AWS CLI**  
**建立 Canary**  
下列 `create-canary` 範例建立名為 `demo_canary` 的 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
```
輸出：  

```
{
    "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": {}
    }
}
```
如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》**中的[合成監控 (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/create-canary.html)。

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

以下程式碼範例顯示如何使用 `create-group`。

**AWS CLI**  
**建立群組**  
下列 `create-group` 範例建立名為 `demo_group` 的群組。  

```
aws synthetics create-group \
    --name demo_group
```
輸出：  

```
{
    "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"
    }
}
```
如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》**中的[合成監控 (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/create-group.html)。

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

以下程式碼範例顯示如何使用 `delete-canary`。

**AWS CLI**  
**永久刪除 Canary**  
以下 `delete-canary` 範例刪除名為 `demo_canary` 的 Canary。  

```
aws synthetics delete-canary \
    --name demo_canary
```
此命令不會產生輸出。  
如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》**中的[合成監控 (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/delete-canary.html)。

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

以下程式碼範例顯示如何使用 `delete-group`。

**AWS CLI**  
**刪除群組**  
下列 `delete-group` 範例刪除名為 `demo_group` 的群組。  

```
aws synthetics delete-group \
    --group-identifier demo_group
```
此命令不會產生輸出。  
如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》**中的[合成監控 (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)。  
+  如需 API 詳細資訊，請參閱**《AWS CLI 命令參考》中的 [DeleteGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/delete-group.html)。

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

以下程式碼範例顯示如何使用 `describe-canaries-last-run`。

**AWS CLI**  
**查看每個 Canary 最近執行的資訊**  
下列 `describe-canaries-last-run` 範例傳回您建立的每個 Canary 的最近執行資訊。  

```
aws synthetics describe-canaries-last-run
```
輸出：  

```
{
    "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"
            }
        }
    ]
}
```
如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》**中的[合成監控 (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeCanariesLastRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/describe-canaries-last-run.html)。

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

以下程式碼範例顯示如何使用 `describe-canaries`。

**AWS CLI**  
**列出您帳戶中的 Canary**  
下列 `describe-canaries` 範例列出您帳戶中的 Canary 詳細資訊。  

```
aws synthetics describe-canaries
```
輸出：  

```
{
    "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"
            }
        }
    ]
}
```
如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》**中的[合成監控 (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeCanaries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/describe-canaries.html)。

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

以下程式碼範例顯示如何使用 `describe-runtime-versions`。

**AWS CLI**  
**傳回合成 Canary 執行時期版本的清單**  
下列 `describe-runtime-versions` 範例傳回合成 Canary 執行時期版本的清單。  

```
aws synthetics describe-runtime-versions
```
輸出：  

```
{
    "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"
        }
    ]
}
```
如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》**中的[合成監控 (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeRuntimeVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/describe-runtime-versions.html)。

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

以下程式碼範例顯示如何使用 `disassociate-resource`。

**AWS CLI**  
**從群組移除 Canary**  
下列 `disassociate-resource` 範例從名為 `demo_group` 的群組中移除 Canary。  

```
aws synthetics disassociate-resource \
    --group-identifier demo_group \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary
```
此命令不會產生輸出。  
如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》**中的[合成監控 (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DisassociateResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/disassociate-resource.html)。

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

以下程式碼範例顯示如何使用 `get-canary-runs`。

**AWS CLI**  
**擷取指定 Canary 的執行清單**  
下列 `get-canary-runs` 範例擷取名為 `demo_canary` 之 Canary 的執行清單。  

```
aws synthetics get-canary-runs \
    --name demo_canary
```
輸出：  

```
{
    "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"
        }
    ]
}
```
如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》**中的[合成監控 (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetCanaryRuns](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/get-canary-runs.html)。

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

以下程式碼範例顯示如何使用 `get-canary`。

**AWS CLI**  
**擷取有關一個 Canary 的完整資訊**  
下列 `get-canary` 範例擷取名為 `demo_canary` 之 Canary 的完整資訊。  

```
aws synthetics get-canary \
    --name demo_canary
```
輸出：  

```
{
    "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"
        }
    }
}
```
如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》**中的[合成監控 (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/get-canary.html)。

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

以下程式碼範例顯示如何使用 `get-group`。

**AWS CLI**  
**傳回一個群組的相關資訊**  
下列 `get-group` 範例傳回名為 `demo_group` 之群組的相關資訊。  

```
aws synthetics get-group \
    --group-identifier demo_group
```
輸出：  

```
{
    "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"
    }
}
```
如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》**中的[合成監控 (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)。  
+  如需 API 詳細資訊，請參閱《*AWS CLI 命令參考*》中的 [GetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/get-group.html)。

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

以下程式碼範例顯示如何使用 `list-associated-groups`。

**AWS CLI**  
**傳回群組清單**  
下列 `list-associated-groups` 範例傳回與名為 `demo_canary` 之 Canary 相關聯的群組清單。  

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

```
{
    "Groups": [
        {
            "Id": "example123",
            "Name": "demo_group",
            "Arn": "arn:aws:synthetics:us-east-1:123456789012:group:example123"
        }
    ]
}
```
如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》**中的[合成監控 (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListAssociatedGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/list-associated-groups.html)。

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

以下程式碼範例顯示如何使用 `list-group-resources`。

**AWS CLI**  
**傳回與指定群組相關聯之 Canary 的 ARN 清單**  
下列 `list-group-resources` 範例傳回與名為 `demo_group` 之群組相關聯的 Canary 的 ARN 清單。  

```
aws synthetics list-group-resources \
    --group-identifier demo_group
```
輸出：  

```
{
    "Resources": [
        "arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary"
    ]
}
```
如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》**中的[合成監控 (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListGroupResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/list-group-resources.html)。

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

以下程式碼範例顯示如何使用 `list-groups`。

**AWS CLI**  
**傳回帳戶中所有群組的清單**  
下列 `list-groups` 範例傳回帳戶中所有群組的清單。  

```
aws synthetics list-groups
```
輸出：  

```
{
    "Groups": [
        {
            "Id": "example123",
            "Name": "demo_group",
            "Arn": "arn:aws:synthetics:us-east-1:123456789012:group:example123"
        }
    ]
}
```
如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》**中的[合成監控 (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/list-groups.html)。

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

以下程式碼範例顯示如何使用 `list-tags-for-resource`。

**AWS CLI**  
**範例 1：顯示與 Canary 相關聯的標籤**  
下列 `list-tags-for-resource` 範例傳回與名為 `demo_canary` 之 Canary 相關聯的標籤。  

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

```
{
    "Tags": {
        "blueprint": "heartbeat"
    }
}
```
**範例 2：顯示與群組相關聯的標籤**  
下列 `list-tags-for-resource` 範例傳回與名為 `demo_group` 之群組相關聯的標籤。  

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

```
{
    "Tags": {
        "team": "Devops"
    }
}
```
如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》**中的[合成監控 (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/list-tags-for-resource.html)。

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

以下程式碼範例顯示如何使用 `start-canary`。

**AWS CLI**  
**執行 Canary**  
下列 `start-canary` 範例會執行名為 `demo_canary` 的 Canary。  

```
aws synthetics start-canary \
    --name demo_canary
```
此命令不會產生輸出。  
如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》**中的[合成監控 (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [StartCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/start-canary.html)。

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

以下程式碼範例顯示如何使用 `stop-canary`。

**AWS CLI**  
**停止 Canary**  
下列 `stop-canary` 範例會停止名為 `demo_canary` 的 Canary。  

```
aws synthetics stop-canary \
    --name demo_canary
```
此命令不會產生輸出。  
如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》**中的[合成監控 (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI API 參考》**中的 [StopCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/stop-canary.html)。

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

以下程式碼範例顯示如何使用 `tag-resource`。

**AWS CLI**  
**範例 1：將標籤指派給 Canary**  
下列 `tag-resource` 範例將標籤指派給名為 `demo_canary` 的 Canary。  

```
aws synthetics tag-resource \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary \
    --tags blueprint=heartbeat
```
此命令不會產生輸出。  
**範例 2：將標籤指派給群組**  
下列 `tag-resource` 範例將標籤指派給名為 `demo_group` 的群組。  

```
aws synthetics tag-resource \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:group:example123 \
    --tags team=Devops
```
此命令不會產生輸出。  
如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》**中的[合成監控 (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/tag-resource.html)。

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

以下程式碼範例顯示如何使用 `untag-resource`。

**AWS CLI**  
**範例 1：從 Canary 移除標籤**  
下列 `untag-resource` 範例從名為 `demo_canary` 的 Canary 移除標籤。  

```
aws synthetics untag-resource \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary \
    --tag-keys blueprint
```
此命令不會產生輸出。  
**範例 2：從群組移除標籤**  
下列 `untag-resource` 範例會從名為 `demo_group` 的群組中移除標籤。  

```
aws synthetics untag-resource \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:group:example123 \
    --tag-keys team
```
此命令不會產生輸出。  
如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》**中的[合成監控 (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/untag-resource.html)。

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

以下程式碼範例顯示如何使用 `update-canary`。

**AWS CLI**  
**更新 Canary**  
下列 `update-canary` 範例更新名為 `demo_canary` 的 Canary 組態。  

```
aws synthetics update-canary \
    --name demo_canary \
    --schedule Expression="rate(15 minutes)"
```
此命令不會產生輸出。  
如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》**中的[合成監控 (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UpdateCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/update-canary.html)。