AWS Well-Architected Agent está en versión de vista previa y sujeto a cambios.

# Inicio rápido de la API
<a name="agent-api-quickstart"></a>

Puede configurar AWS WA Agent completamente a través de la AWS CLI o el SDK en lugar de la consola. Esta guía de inicio rápido explica cómo crear un perfil, agregar un objetivo, agregar el contexto de la aplicación y verificar la idoneidad.

**nota**  
Antes de usar la API, cree el rol de ejecución y acceda a los roles tal y como se describe en [Paso 3: configuración de los permisos y las integraciones](agent-getting-started.md#agent-permissions-integrations) y [Paso 6: creación de roles de acceso en las cuentas de carga de trabajo](agent-getting-started.md#agent-access-roles). La API no crea roles de IAM para usted.

## Paso 1: creación de un perfil de agente
<a name="agent-api-create-profile"></a>

Cree un perfil con el rol de ejecución, los pilares de destino y la configuración de la cuenta.

**Creación de un perfil de agente (CLI)**

1. Ejecute el siguiente comando. Sustituya los valores de los marcadores de posición por los ID de cuenta, los ARN de los roles y las regiones de destino.
**nota**  
 Puede elegir un nombre de rol de acceso común o ingresar un nombre de rol de acceso por cuenta. Esto solo está disponible en la versión de la API de incorporación, no en la consola. 

   ```
   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. En la respuesta, anote el ARN del perfil. Utilizará este valor en comandos posteriores.

## Paso 2: agregación de un objetivo de optimización
<a name="agent-api-create-goal"></a>

Agregue un objetivo para impulsar la priorización de las recomendaciones. Cada objetivo está asociado a uno o varios pilares de optimización.

**Agregación de un objetivo (CLI)**
+ Ejecute el siguiente comando. Sustituya el ARN del perfil por el valor del paso 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
  ```

## Paso 3: adición del contexto de la aplicación
<a name="agent-api-create-context"></a>

Proporcione los metadatos de la aplicación para que AWS WA Agent pueda generar recomendaciones más relevantes y personalizadas.

**Adición del contexto de la aplicación (CLI)**
+ Ejecute el siguiente comando. Sustituya el ARN del perfil y los campos de contenido por los detalles de la aplicación.

  ```
  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"]}'
  ```

## Paso 4: verificación de la elegibilidad del perfil
<a name="agent-api-verify-eligibility"></a>

Compruebe que el perfil sea válido y apto para la generación de recomendaciones.

**Verificación de la elegibilidad (CLI)**

1. Use el siguiente comando:

   ```
   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. Si `eligibleForScheduledGeneration` es `true`, el perfil está configurado correctamente. Las recomendaciones programadas comenzarán a generarse en un plazo de 48 horas.

1. Si `eligibleForScheduledGeneration` es `false`, consulte el mapa de `fieldErrors` para ver si hay problemas específicos. Consulte [Resolución de problemas de AWS Well-Architected Agent](agent-troubleshooting.md) para resoluciones comunes.

Para obtener la referencia completa de la API, consulte la [Referencia de la API de AWS Well-Architected](https://docs.aws.amazon.com/wellarchitected/latest/APIReference/Welcome.html).