AWS 架构完善的代理 目前为预览版，可能会发生变化。

# API 快速入门
<a name="agent-api-quickstart"></a>

您可以完全通过 AWS CLI 或 SDK 来设置 AWS WA 代理，而无需使用控制台。本快速入门将逐步介绍如何创建配置文件、添加目标、添加应用程序上下文以及验证资格。

**注意**  
在使用 API 之前，请按照[步骤 3：配置权限和集成](agent-getting-started.md#agent-permissions-integrations)和[步骤 6：在工作负载账户中创建访问角色](agent-getting-started.md#agent-access-roles)中的说明，创建执行角色和访问角色。API 不会为您创建 IAM 角色。

## 步骤 1：创建智能体配置文件
<a name="agent-api-create-profile"></a>

使用您的执行角色、目标支柱和账户配置来创建配置文件。

**创建智能体配置文件（CLI）**

1. 运行如下命令。将占位符值替换为您的账户 ID、角色 ARN 和目标区域。
**注意**  
 您可以选择一个通用访问角色名称，或者为每个账户输入一个访问角色名称。此功能仅在 API 版本的引导配置中可用，控制台不支持。

   ```
   aws wellarchitected create-agent-profile \
       --name "my-production-profile" \
       --execution-role-arn "arn:aws:iam::{{111122223333}}:role/service-role/ExecutionRoleForWellArchitectedAgent" \
       --pillars COST_OPTIMIZATION SECURITY RESILIENCE PERFORMANCE \
       --aggregation-configuration '[{"accountId":"{{444455556666}}","accessRoleArn":"arn:aws:iam::{{444455556666}}:role/AccessRoleForWellArchitectedAgent","regions":["us-east-1","us-west-2"]}]'
   ```

1. 在响应中，记下配置文件 ARN。后续命令中需要使用该值。

## 步骤 2：添加优化目标
<a name="agent-api-create-goal"></a>

添加目标以驱动建议优先级排序。每个目标都与一个或多个优化支柱相关联。

**添加目标（CLI）**
+ 运行如下命令。将配置文件 ARN 替换为步骤 1 中的值。

  ```
  aws wellarchitected create-agent-goal \
      --profile-arn "arn:aws:wellarchitected:{{us-east-1}}:{{111122223333}}:agent-profile/{{my-production-profile}}" \
      --title "Reduce EC2 spend by 20% by Q4 through rightsizing and Reserved Instance coverage" \
      --pillars COST_OPTIMIZATION
  ```

## 步骤 3：添加应用程序上下文
<a name="agent-api-create-context"></a>

提供应用程序元数据，以便 AWS WA 代理 生成更相关的个性化建议。

**添加应用程序上下文（CLI）**
+ 运行如下命令。将配置文件 ARN 与内容字段替换为您的应用程序详细信息。

  ```
  aws wellarchitected create-agent-context \
      --profile-arn "arn:aws:wellarchitected:{{us-east-1}}:{{111122223333}}:agent-profile/{{my-production-profile}}" \
      --title "Payment processing service" \
      --context-type APPLICATION \
      --content '{"applicationOverview":"Real-time payment processing","criticality":"MISSION_CRITICAL","accountIds":["{{444455556666}}"],"regions":["us-east-1"]}'
  ```

## 步骤 4：验证配置文件资格
<a name="agent-api-verify-eligibility"></a>

检查配置文件是否有效，且具备生成建议的资格。

**验证资格（CLI）**

1. 运行以下命令：

   ```
   aws wellarchitected get-agent-profile \
       --profile-arn "arn:aws:wellarchitected:{{us-east-1}}:{{111122223333}}:agent-profile/{{my-production-profile}}" \
       --query '{eligible: eligibleForScheduledGeneration, errors: fieldErrors}'
   ```

1. 如果 `eligibleForScheduledGeneration` 为 `true`，则表示您的配置文件配置正确。计划性建议将在 48 小时内开始生成。

1. 如果 `eligibleForScheduledGeneration` 为 `false`，请查看 `fieldErrors` 映射以了解具体问题。有关常见解决方法，请参阅[AWS 架构完善的代理 故障排除](agent-troubleshooting.md)。

有关完整的 API 参考，请参阅 [AWS Well-Architected API 参考](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/Welcome.html)。