Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

# Versión ejecutable de Amazon Personalize
<a name="API_Operations_Amazon_Personalize_Runtime"></a>

Versión ejecutable de Amazon Personalize admite las siguientes acciones:
+  [GetActionRecommendations](API_RS_GetActionRecommendations.md) 
+  [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) 
+  [GetRecommendations](API_RS_GetRecommendations.md) 

# GetActionRecommendations
<a name="API_RS_GetActionRecommendations"></a>

Devuelve una lista de acciones recomendadas que se ordenan en orden descendente por puntuación de predicción. Use la API `GetActionRecommendations` si tiene una campaña personalizada que implementa una versión de la solución entrenada con una receta PERSONALIZED\$1ACTIONS. 

Para obtener más información sobre las recetas PERSONALIZED\$1ACTIONS, consulte [Recetas PERSONALIZED\$1ACTIONS](https://docs.aws.amazon.com/personalize/latest/dg/nexts-best-action-recipes.html). Para obtener más información sobre cómo obtener recomendaciones de acciones, consulte [Obtención de recomendaciones de acciones](https://docs.aws.amazon.com/personalize/latest/dg/get-action-recommendations.html).

## Sintaxis de la solicitud
<a name="API_RS_GetActionRecommendations_RequestSyntax"></a>

```
POST /action-recommendations HTTP/1.1
Content-type: application/json

{
   "campaignArn": "string",
   "filterArn": "string",
   "filterValues": { 
      "string" : "string" 
   },
   "numResults": number,
   "userId": "string"
}
```

## Parámetros de solicitud del URI
<a name="API_RS_GetActionRecommendations_RequestParameters"></a>

La solicitud no utiliza ningún parámetro de URI.

## Cuerpo de la solicitud
<a name="API_RS_GetActionRecommendations_RequestBody"></a>

La solicitud acepta los siguientes datos en formato JSON.

 ** [campaignArn](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-campaignArn"></a>
El nombre de recurso de Amazon (ARN) de la campaña que se va a utilizar para obtener recomendaciones de acciones. Esta campaña debe desplegar una versión de la solución entrenada con una receta PERSONALIZED\$1ACTIONS.  
Tipo: cadena  
Limitaciones de longitud: longitud máxima de 256.  
Patrón: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obligatorio: no

 ** [filterArn](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-filterArn"></a>
ARN del filtro que se aplicará a las recomendaciones devueltas. Para obtener más información, consulte [Filtrado de recomendaciones](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
Cuando utilice este parámetro, asegúrese de que el recurso de filtro sea `ACTIVE`.  
Tipo: cadena  
Limitaciones de longitud: longitud máxima de 256.  
Patrón: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obligatorio: no

 ** [filterValues](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-filterValues"></a>
Los valores que se van a utilizar al filtrar las recomendaciones. Para cada parámetro de marcador de posición de la expresión de filtro, proporcione el nombre del parámetro (respetando mayúsculas y minúsculas) como clave y los valores del filtro como valor correspondiente. Separe los valores múltiples de un parámetro con una coma.   
En el caso de las expresiones de filtro que utilizan un elemento `INCLUDE` para incluir acciones, debe proporcionar valores para todos los parámetros definidos en la expresión. En el caso de los filtros con expresiones que utilizan un elemento `EXCLUDE` para excluir acciones, puede omitir `filter-values`. En este caso, Amazon Personalize no utiliza esa parte de la expresión para filtrar recomendaciones.  
Para obtener más información, consulte [Filtrado de recomendaciones y segmentos de usuario](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
Tipo: mapa de cadena a cadena  
Entradas de mapa: número máximo de 25 elementos.  
Limitaciones de longitud de clave: longitud máxima de 50 caracteres.  
Patrón de clave: `[A-Za-z0-9_]+`   
Limitaciones de longitud de valor: longitud máxima de 1000 caracteres.  
Obligatorio: no

 ** [numResults](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-numResults"></a>
El número de resultados que se devolverá. El valor predeterminado es 5. El máximo es 100.  
Tipo: entero  
Rango válido: valor mínimo de 0.  
Obligatorio: no

 ** [userId](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-userId"></a>
ID del usuario para el que se van a proporcionar recomendaciones de acciones.  
Tipo: cadena  
Limitaciones de longitud: longitud máxima de 256.  
Obligatorio: no

## Sintaxis de la respuesta
<a name="API_RS_GetActionRecommendations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "actionList": [ 
      { 
         "actionId": "string",
         "score": number
      }
   ],
   "recommendationId": "string"
}
```

## Elementos de respuesta
<a name="API_RS_GetActionRecommendations_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

 ** [actionList](#API_RS_GetActionRecommendations_ResponseSyntax) **   <a name="personalize-RS_GetActionRecommendations-response-actionList"></a>
Lista de recomendaciones de acciones en orden descendente por puntuación de predicción. Puede haber un máximo de 100 acciones en la lista. Para obtener información sobre las puntuaciones de las acciones, consulte [Cómo funciona la puntuación de recomendaciones de acciones](https://docs.aws.amazon.com/personalize/latest/dg/how-action-recommendation-scoring-works.html).  
Tipo: matriz de objetos [PredictedAction](API_RS_PredictedAction.md)

 ** [recommendationId](#API_RS_GetActionRecommendations_ResponseSyntax) **   <a name="personalize-RS_GetActionRecommendations-response-recommendationId"></a>
El identificador de la recomendación.  
Tipo: cadena

## Errores
<a name="API_RS_GetActionRecommendations_Errors"></a>

 ** InvalidInputException **   
Proporcione un valor válido para el campo o el parámetro.  
Código de estado HTTP: 400

 ** ResourceNotFoundException **   
El recurso especificado no existe.  
Código de estado HTTP: 404

## Véase también
<a name="API_RS_GetActionRecommendations_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetActionRecommendations) 

# GetPersonalizedRanking
<a name="API_RS_GetPersonalizedRanking"></a>

Cambia el orden de una lista de elementos recomendados para un usuario determinado. Se considera que el primer elemento de la lista es el que puede ser el más interesante para el usuario.

**nota**  
La solución relacionada con la campaña se debe haber creado utilizando una receta del tipo PERSONALIZED\$1RANKING.

## Sintaxis de la solicitud
<a name="API_RS_GetPersonalizedRanking_RequestSyntax"></a>

```
POST /personalize-ranking HTTP/1.1
Content-type: application/json

{
   "campaignArn": "string",
   "context": { 
      "string" : "string" 
   },
   "filterArn": "string",
   "filterValues": { 
      "string" : "string" 
   },
   "inputList": [ "string" ],
   "metadataColumns": { 
      "string" : [ "string" ]
   },
   "userId": "string"
}
```

## Parámetros de solicitud del URI
<a name="API_RS_GetPersonalizedRanking_RequestParameters"></a>

La solicitud no utiliza ningún parámetro de URI.

## Cuerpo de la solicitud
<a name="API_RS_GetPersonalizedRanking_RequestBody"></a>

La solicitud acepta los siguientes datos en formato JSON.

 ** [campaignArn](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-campaignArn"></a>
El nombre de recurso de Amazon (ARN) de la campaña que se va a utilizar para generar la clasificación personalizada.  
Tipo: cadena  
Limitaciones de longitud: longitud máxima de 256.  
Patrón: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obligatorio: sí

 ** [context](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-context"></a>
Los metadatos contextuales que se utilizarán para obtener recomendaciones. Los metadatos contextuales incluyen cualquier información de interacción que pueda ser relevante a la hora de obtener las recomendaciones de un usuario, como la ubicación actual del usuario o el tipo de dispositivo.  
Tipo: mapa de cadena a cadena  
Entradas de mapa: número máximo de 150 elementos.  
Limitaciones de longitud de clave: longitud máxima de 150 caracteres.  
Patrón de clave: `[A-Za-z\d_]+`   
Limitaciones de longitud de valor: longitud máxima de 1000 caracteres.  
Obligatorio: no

 ** [filterArn](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-filterArn"></a>
El nombre de recurso de Amazon (ARN) de un filtro que ha creado para incluir o excluir elementos de las recomendaciones para un usuario determinado. Para obtener más información, consulte [Filtrado de recomendaciones](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
Tipo: cadena  
Limitaciones de longitud: longitud máxima de 256.  
Patrón: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obligatorio: no

 ** [filterValues](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-filterValues"></a>
Los valores que se van a utilizar al filtrar las recomendaciones. Para cada parámetro de marcador de posición de la expresión de filtro, proporcione el nombre del parámetro (respetando mayúsculas y minúsculas) como clave y los valores del filtro como valor correspondiente. Separe los valores múltiples de un parámetro con una coma.   
En el caso de las expresiones de filtro que utilizan un elemento `INCLUDE` para incluir elementos, debe proporcionar valores para todos los parámetros definidos en la expresión. En el caso de los filtros con expresiones que utilizan un objeto `EXCLUDE` para excluir elementos, puede omitir la expresión `filter-values`. En este caso, Amazon Personalize no utiliza esa parte de la expresión para filtrar recomendaciones.  
Para obtener más información, consulte [Filtrado de recomendaciones](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
Tipo: mapa de cadena a cadena  
Entradas de mapa: número máximo de 25 elementos.  
Limitaciones de longitud de clave: longitud máxima de 50 caracteres.  
Patrón de clave: `[A-Za-z0-9_]+`   
Limitaciones de longitud de valor: longitud máxima de 1000 caracteres.  
Obligatorio: no

 ** [inputList](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-inputList"></a>
Una lista de elementos (por `itemId`) para clasificar. Si un elemento no estaba incluido en el conjunto de datos de entrenamiento, se añade al final de la lista reclasificada. Si incluye metadatos en las recomendaciones, el máximo es 50. De lo contrario, el máximo es 500.  
Tipo: matriz de cadenas  
Limitaciones de longitud: longitud máxima de 256 caracteres.  
Obligatorio: sí

 ** [metadataColumns](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-metadataColumns"></a>
Si ha habilitado los metadatos en las recomendaciones al crear o actualizar la campaña, especifique las columnas de metadatos del conjunto de datos de elementos que se van a incluir en la clasificación personalizada. La clave de asignación es `ITEMS` y el valor es una lista de nombres de columnas de su conjunto de datos de elementos. El número máximo de columnas que puede proporcionar es 10.  
 Para obtener información sobre cómo habilitar los metadatos para una campaña, consulte [Habilitación de los metadatos en las recomendaciones para una campaña](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata).   
Tipo: mapa de cadena a matriz de cadenas  
Entradas de mapa: número máximo de 1 elemento.  
Limitaciones de longitud de clave: longitud máxima de 256 caracteres.  
Miembros de la matriz: número máximo de 99 elementos.  
Limitaciones de longitud: longitud máxima de 150 caracteres.  
Obligatorio: no

 ** [userId](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-userId"></a>
El usuario para el que quiere que la campaña proporcione una clasificación personalizada.  
Tipo: cadena  
Limitaciones de longitud: longitud máxima de 256 caracteres.  
Obligatorio: sí

## Sintaxis de la respuesta
<a name="API_RS_GetPersonalizedRanking_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "personalizedRanking": [ 
      { 
         "itemId": "string",
         "metadata": { 
            "string" : "string" 
         },
         "promotionName": "string",
         "reason": [ "string" ],
         "score": number
      }
   ],
   "recommendationId": "string"
}
```

## Elementos de respuesta
<a name="API_RS_GetPersonalizedRanking_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

 ** [personalizedRanking](#API_RS_GetPersonalizedRanking_ResponseSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-response-personalizedRanking"></a>
Una lista de elementos por orden de interés más probable para el usuario. El máximo es 500.  
Tipo: matriz de objetos [PredictedItem](API_RS_PredictedItem.md)

 ** [recommendationId](#API_RS_GetPersonalizedRanking_ResponseSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-response-recommendationId"></a>
El identificador de la recomendación.  
Tipo: cadena

## Errores
<a name="API_RS_GetPersonalizedRanking_Errors"></a>

 ** InvalidInputException **   
Proporcione un valor válido para el campo o el parámetro.  
Código de estado HTTP: 400

 ** ResourceNotFoundException **   
El recurso especificado no existe.  
Código de estado HTTP: 404

## Véase también
<a name="API_RS_GetPersonalizedRanking_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 

# GetRecommendations
<a name="API_RS_GetRecommendations"></a>

Devuelve una lista de elementos recomendados. Para las campañas, se requiere el nombre del recurso de Amazon (ARN) de la campaña y la entrada requerida de usuario y elemento depende del tipo de receta utilizado para crear la solución que respalda la campaña, de la siguiente manera:
+ USER\$1PERSONALIZATION: `userId` obligatorio, `itemId` no utilizado
+ RELATED\$1ITEMS: `itemId` obligatorio, `userId` no utilizado

**nota**  
Las campañas respaldadas por una solución creada con una receta del tipo PERSONALIZED\$1RANKING utilizan la API [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md).

 Para los recomendadores, se requiere el ARN del recomendador y la entrada requerida de usuario y elemento dependen del caso de uso (receta basada en el dominio) que respalda al recomendador. Para obtener información sobre los requisitos de los casos de uso, consulte [Elección de los casos de uso de un recomendador](https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html). 

## Sintaxis de la solicitud
<a name="API_RS_GetRecommendations_RequestSyntax"></a>

```
POST /recommendations HTTP/1.1
Content-type: application/json

{
   "campaignArn": "string",
   "context": { 
      "string" : "string" 
   },
   "filterArn": "string",
   "filterValues": { 
      "string" : "string" 
   },
   "itemId": "string",
   "metadataColumns": { 
      "string" : [ "string" ]
   },
   "numResults": number,
   "promotions": [ 
      { 
         "filterArn": "string",
         "filterValues": { 
            "string" : "string" 
         },
         "name": "string",
         "percentPromotedItems": number
      }
   ],
   "recommenderArn": "string",
   "userId": "string"
}
```

## Parámetros de solicitud del URI
<a name="API_RS_GetRecommendations_RequestParameters"></a>

La solicitud no utiliza ningún parámetro de URI.

## Cuerpo de la solicitud
<a name="API_RS_GetRecommendations_RequestBody"></a>

La solicitud acepta los siguientes datos en formato JSON.

 ** [campaignArn](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-campaignArn"></a>
El nombre de recurso de Amazon (ARN) de la campaña que se va a utilizar para obtener recomendaciones.  
Tipo: cadena  
Limitaciones de longitud: longitud máxima de 256.  
Patrón: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obligatorio: no

 ** [context](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-context"></a>
Los metadatos contextuales que se utilizarán para obtener recomendaciones. Los metadatos contextuales incluyen cualquier información de interacción que pueda ser relevante a la hora de obtener las recomendaciones de un usuario, como la ubicación actual del usuario o el tipo de dispositivo.  
Tipo: mapa de cadena a cadena  
Entradas de mapa: número máximo de 150 elementos.  
Limitaciones de longitud de clave: longitud máxima de 150 caracteres.  
Patrón de clave: `[A-Za-z\d_]+`   
Limitaciones de longitud de valor: longitud máxima de 1000 caracteres.  
Obligatorio: no

 ** [filterArn](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-filterArn"></a>
ARN del filtro que se aplicará a las recomendaciones devueltas. Para obtener más información, consulte [Filtrado de recomendaciones](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
Cuando utilice este parámetro, asegúrese de que el recurso de filtro sea `ACTIVE`.  
Tipo: cadena  
Limitaciones de longitud: longitud máxima de 256.  
Patrón: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obligatorio: no

 ** [filterValues](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-filterValues"></a>
Los valores que se van a utilizar al filtrar las recomendaciones. Para cada parámetro de marcador de posición de la expresión de filtro, proporcione el nombre del parámetro (respetando mayúsculas y minúsculas) como clave y los valores del filtro como valor correspondiente. Separe los valores múltiples de un parámetro con una coma.   
En el caso de las expresiones de filtro que utilizan un elemento `INCLUDE` para incluir elementos, debe proporcionar valores para todos los parámetros definidos en la expresión. En el caso de los filtros con expresiones que utilizan un objeto `EXCLUDE` para excluir elementos, puede omitir la expresión `filter-values`. En este caso, Amazon Personalize no utiliza esa parte de la expresión para filtrar recomendaciones.  
Para obtener más información, consulte [Filtrado de recomendaciones y segmentos de usuario](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
Tipo: mapa de cadena a cadena  
Entradas de mapa: número máximo de 25 elementos.  
Limitaciones de longitud de clave: longitud máxima de 50 caracteres.  
Patrón de clave: `[A-Za-z0-9_]+`   
Limitaciones de longitud de valor: longitud máxima de 1000 caracteres.  
Obligatorio: no

 ** [itemId](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-itemId"></a>
El ID del elemento para el que se van a ofrecer recomendaciones.  
Necesario para el tipo de receta `RELATED_ITEMS`.  
Tipo: cadena  
Limitaciones de longitud: longitud máxima de 256.  
Obligatorio: no

 ** [metadataColumns](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-metadataColumns"></a>
Si ha habilitado los metadatos en las recomendaciones al crear o actualizar la campaña o el recomendador, especifique las columnas de metadatos del conjunto de datos de elementos que se van a incluir en las recomendaciones de elementos. La clave de asignación es `ITEMS` y el valor es una lista de nombres de columnas de su conjunto de datos de elementos. El número máximo de columnas que puede proporcionar es 10.  
 Para obtener información sobre cómo habilitar los metadatos para una campaña, consulte [Habilitación de los metadatos en las recomendaciones para una campaña](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata). Para obtener información sobre cómo habilitar los metadatos para un recomendador, consulte [Habilitación de los metadatos en las recomendaciones para un recomendador](https://docs.aws.amazon.com/personalize/latest/dg/creating-recommenders.html#create-recommender-return-metadata).   
Tipo: mapa de cadena a matriz de cadenas  
Entradas de mapa: número máximo de 1 elemento.  
Limitaciones de longitud de clave: longitud máxima de 256 caracteres.  
Miembros de la matriz: número máximo de 99 elementos.  
Limitaciones de longitud: longitud máxima de 150 caracteres.  
Obligatorio: no

 ** [numResults](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-numResults"></a>
El número de resultados que se devolverá. El valor predeterminado es 25. Si incluye metadatos en las recomendaciones, el máximo es 50. De lo contrario, el máximo es 500.  
Tipo: entero  
Rango válido: valor mínimo de 0.  
Obligatorio: no

 ** [promotions](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-promotions"></a>
Las promociones que se aplican a la solicitud de recomendación. Una promoción define reglas empresariales adicionales que se aplican a un subconjunto configurable de elementos recomendados.  
Tipo: Matriz de objetos [Promotion](API_RS_Promotion.md)  
Miembros de la matriz: número máximo de 1 elemento.  
Obligatorio: no

 ** [recommenderArn](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-recommenderArn"></a>
El nombre de recurso de Amazon (ARN) del recomendador que se va a utilizar para obtener recomendaciones. Proporcione el ARN de un recomendador si creó un grupo de conjuntos de datos de dominio con un recomendador para un caso de uso de dominio.  
Tipo: cadena  
Limitaciones de longitud: longitud máxima de 256.  
Patrón: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obligatorio: no

 ** [userId](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-userId"></a>
El ID del usuario para el que se van a proporcionar recomendaciones.  
Necesario para el tipo de receta `USER_PERSONALIZATION`.  
Tipo: cadena  
Limitaciones de longitud: longitud máxima de 256.  
Obligatorio: no

## Sintaxis de la respuesta
<a name="API_RS_GetRecommendations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "itemList": [ 
      { 
         "itemId": "string",
         "metadata": { 
            "string" : "string" 
         },
         "promotionName": "string",
         "reason": [ "string" ],
         "score": number
      }
   ],
   "recommendationId": "string"
}
```

## Elementos de respuesta
<a name="API_RS_GetRecommendations_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

 ** [itemList](#API_RS_GetRecommendations_ResponseSyntax) **   <a name="personalize-RS_GetRecommendations-response-itemList"></a>
Lista de recomendaciones ordenadas en orden descendente por puntuación de predicción. Puede haber un máximo de 500 elementos en la lista.  
Tipo: matriz de objetos [PredictedItem](API_RS_PredictedItem.md)

 ** [recommendationId](#API_RS_GetRecommendations_ResponseSyntax) **   <a name="personalize-RS_GetRecommendations-response-recommendationId"></a>
El identificador de la recomendación.  
Tipo: cadena

## Errores
<a name="API_RS_GetRecommendations_Errors"></a>

 ** InvalidInputException **   
Proporcione un valor válido para el campo o el parámetro.  
Código de estado HTTP: 400

 ** ResourceNotFoundException **   
El recurso especificado no existe.  
Código de estado HTTP: 404

## Véase también
<a name="API_RS_GetRecommendations_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetRecommendations)