# 使用 AWS CLI 的 CloudWatch Observability Admin 示例
<a name="cli_observabilityadmin_code_examples"></a>

以下代码示例演示如何通过将 AWS Command Line Interface 与 CloudWatch Observability Admin 结合使用，来执行操作和实现常见场景。

*操作是大型程序的代码摘录*，必须在上下文中运行。您可以通过操作了解如何调用单个服务函数，还可以通过函数相关场景的上下文查看操作。

每个示例都包含一个指向完整源代码的链接，您可以从中找到有关如何在上下文中设置和运行代码的说明。

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

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

### `get-telemetry-evaluation-status-for-organization`
<a name="observabilityadmin_GetTelemetryEvaluationStatusForOrganization_cli_topic"></a>

以下代码示例演示了如何使用 `get-telemetry-evaluation-status-for-organization`。

**AWS CLI**  
**获取组织的遥测载入状态**  
以下 `get-telemetry-evaluation-status-for-organization` 示例返回组织的遥测配置功能的当前载入状态。  

```
aws observabilityadmin get-telemetry-evaluation-status-for-organization
```
输出：  

```
{
    "Status": "RUNNING"
}
```
有关更多信息，请参阅《Amazon CloudWatch 用户指南》**中的[审计 CloudWatch 遥测配置](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html)。  
+  有关 API 详细信息，请参阅《AWS CLI Command Reference》**中的 [GetTelemetryEvaluationStatusForOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/get-telemetry-evaluation-status-for-organization.html)。

### `get-telemetry-evaluation-status`
<a name="observabilityadmin_GetTelemetryEvaluationStatus_cli_topic"></a>

以下代码示例演示了如何使用 `get-telemetry-evaluation-status`。

**AWS CLI**  
**获取账户的遥测载入状态**  
以下 `get-telemetry-evaluation-status` 示例返回指定账户中遥测配置功能的当前载入状态。  

```
aws observabilityadmin get-telemetry-evaluation-status
```
输出：  

```
{
    "Status": "RUNNING"
}
```
有关更多信息，请参阅《Amazon CloudWatch 用户指南》**中的[审计 CloudWatch 遥测配置](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html)。  
+  有关 API 详细信息，请参阅《AWS CLI Command Reference》**中的 [GetTelemetryEvaluationStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/get-telemetry-evaluation-status.html)。

### `list-resource-telemetry-for-organization`
<a name="observabilityadmin_ListResourceTelemetryForOrganization_cli_topic"></a>

以下代码示例演示了如何使用 `list-resource-telemetry-for-organization`。

**AWS CLI**  
**检索组织的遥测配置**  
以下 `list-resource-telemetry-for-organization` 示例返回组织中用于遥测配置支持的 AWS 资源的遥测配置列表。  

```
aws observabilityadmin list-resource-telemetry-for-organization \
    --resource-types  AWS::EC2::Instance
```
输出：  

```
{
    "TelemetryConfigurations": [
        {
            "AccountIdentifier": "111111111111",
            "TelemetryConfigurationState": {
                "Logs": "NotApplicable",
                "Metrics": "Disabled",
                "Traces": "NotApplicable"
            },
            "ResourceType": "AWS::EC2::Instance",
            "ResourceIdentifier": "i-a166400b",
            "ResourceTags": {
                "Name": "dev"
            },
            "LastUpdateTimeStamp": 1733168548521
        },
        {
            "AccountIdentifier": "222222222222",
            "TelemetryConfigurationState": {
                "Logs": "NotApplicable",
                "Metrics": "Disabled",
                "Traces": "NotApplicable"
            },
            "ResourceType": "AWS::EC2::Instance",
            "ResourceIdentifier": "i-b188560f",
            "ResourceTags": {
                "Name": "apache"
            },
            "LastUpdateTimeStamp": 1732744260182
        }
    ]
}
```
有关更多信息，请参阅《Amazon CloudWatch 用户指南》**中的[审计 CloudWatch 遥测配置](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html)。  
+  有关 API 详细信息，请参阅《AWS CLI Command Reference》**中的 [ListResourceTelemetryForOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/list-resource-telemetry-for-organization.html)。

### `list-resource-telemetry`
<a name="observabilityadmin_ListResourceTelemetry_cli_topic"></a>

以下代码示例演示了如何使用 `list-resource-telemetry`。

**AWS CLI**  
**检索账户的遥测配置**  
以下 `list-resource-telemetry` 示例返回指定账户中用于遥测配置支持的 AWS 资源的遥测配置列表。  

```
aws observabilityadmin list-resource-telemetry \
    --resource-types  AWS::EC2::Instance
```
输出：  

```
{
    "TelemetryConfigurations": [
        {
            "AccountIdentifier": "111111111111",
            "TelemetryConfigurationState": {
                "Logs": "NotApplicable",
                "Metrics": "Disabled",
                "Traces": "NotApplicable"
            },
            "ResourceType": "AWS::EC2::Instance",
            "ResourceIdentifier": "i-0e979d278b040f856",
            "ResourceTags": {
                "Name": "apache"
            },
            "LastUpdateTimeStamp": 1732744260182
        }
    ]
}
```
有关更多信息，请参阅《Amazon CloudWatch 用户指南》**中的[审计 CloudWatch 遥测配置](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html)。  
+  有关 API 详细信息，请参阅《AWS CLI Command Reference》**中的 [ListResourceTelemetry](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/list-resource-telemetry.html)。

### `start-telemetry-evaluation-for-organization`
<a name="observabilityadmin_StartTelemetryEvaluationForOrganization_cli_topic"></a>

以下代码示例演示了如何使用 `start-telemetry-evaluation-for-organization`。

**AWS CLI**  
**启用遥测配置功能**  
以下 `start-telemetry-evaluation-for-organization` 示例为组织启用遥测配置功能。  

```
aws observabilityadmin start-telemetry-evaluation-for-organization
```
此命令不生成任何输出。  
有关更多信息，请参阅《Amazon CloudWatch 用户指南》**中的[开启 CloudWatch 遥测审计](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-turn-on.html)。  
+  有关 API 详细信息，请参阅《AWS CLI Command Reference》**中的 [StartTelemetryEvaluationForOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/start-telemetry-evaluation-for-organization.html)。

### `start-telemetry-evaluation`
<a name="observabilityadmin_StartTelemetryEvaluation_cli_topic"></a>

以下代码示例演示了如何使用 `start-telemetry-evaluation`。

**AWS CLI**  
**启用遥测配置功能**  
以下 `start-telemetry-evaluation` 示例在指定账户中启用遥测配置功能。  

```
aws observabilityadmin start-telemetry-evaluation
```
此命令不生成任何输出。  
有关更多信息，请参阅《Amazon CloudWatch 用户指南》**中的[开启 CloudWatch 遥测审计](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-turn-on.html)。  
+  有关 API 详细信息，请参阅《AWS CLI Command Reference》**中的 [StartTelemetryEvaluation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/start-telemetry-evaluation.html)。

### `stop-telemetry-evaluation-for-organization`
<a name="observabilityadmin_StopTelemetryEvaluationForOrganization_cli_topic"></a>

以下代码示例演示了如何使用 `stop-telemetry-evaluation-for-organization`。

**AWS CLI**  
**禁用遥测配置功能**  
以下 `stop-telemetry-evaluation-for-organization` 示例为组织禁用遥测配置功能。  

```
aws observabilityadmin stop-telemetry-evaluation-for-organization
```
此命令不生成任何输出。  
有关更多信息，请参阅《Amazon CloudWatch 用户指南》**中的[关闭 CloudWatch 遥测审计](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-turn-off.html)。  
+  有关 API 详细信息，请参阅《AWS CLI Command Reference》**中的 [StopTelemetryEvaluationForOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/stop-telemetry-evaluation-for-organization.html)。

### `stop-telemetry-evaluation`
<a name="observabilityadmin_StopTelemetryEvaluation_cli_topic"></a>

以下代码示例演示了如何使用 `stop-telemetry-evaluation`。

**AWS CLI**  
**禁用遥测配置功能**  
以下 `stop-telemetry-evaluation` 示例在指定账户中禁用遥测配置功能。  

```
aws observabilityadmin stop-telemetry-evaluation
```
此命令不生成任何输出。  
有关更多信息，请参阅《Amazon CloudWatch 用户指南》**中的[关闭 CloudWatch 遥测审计](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-turn-off.html)。  
+  有关 API 详细信息，请参阅《AWS CLI Command Reference》**中的 [StopTelemetryEvaluation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/stop-telemetry-evaluation.html)。