As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# Referência de API
<a name="API_Reference"></a>

Esta seção fornece a documentação das operações de API do Amazon Personalize. Para obter uma lista de endpoints do Amazon Personalize por região, consulte [Regiões e endpoints da AWS](https://docs.aws.amazon.com/general/latest/gr/personalize.html) na *Referência geral da AWS *.

**Topics**
+ [Ações](API_Operations.md)
+ [Tipos de dados](API_Types.md)
+ [Erros comuns](CommonErrors.md)
+ [Parâmetros gerais](CommonParameters.md)

# Ações
<a name="API_Operations"></a>

O Amazon Personalize oferece suporte às seguintes ações:
+  [CreateBatchInferenceJob](API_CreateBatchInferenceJob.md) 
+  [CreateBatchSegmentJob](API_CreateBatchSegmentJob.md) 
+  [CreateCampaign](API_CreateCampaign.md) 
+  [CreateDataDeletionJob](API_CreateDataDeletionJob.md) 
+  [CreateDataset](API_CreateDataset.md) 
+  [CreateDatasetExportJob](API_CreateDatasetExportJob.md) 
+  [CreateDatasetGroup](API_CreateDatasetGroup.md) 
+  [CreateDatasetImportJob](API_CreateDatasetImportJob.md) 
+  [CreateEventTracker](API_CreateEventTracker.md) 
+  [CreateFilter](API_CreateFilter.md) 
+  [CreateMetricAttribution](API_CreateMetricAttribution.md) 
+  [CreateRecommender](API_CreateRecommender.md) 
+  [CreateSchema](API_CreateSchema.md) 
+  [CreateSolution](API_CreateSolution.md) 
+  [CreateSolutionVersion](API_CreateSolutionVersion.md) 
+  [DeleteCampaign](API_DeleteCampaign.md) 
+  [DeleteDataset](API_DeleteDataset.md) 
+  [DeleteDatasetGroup](API_DeleteDatasetGroup.md) 
+  [DeleteEventTracker](API_DeleteEventTracker.md) 
+  [DeleteFilter](API_DeleteFilter.md) 
+  [DeleteMetricAttribution](API_DeleteMetricAttribution.md) 
+  [DeleteRecommender](API_DeleteRecommender.md) 
+  [DeleteSchema](API_DeleteSchema.md) 
+  [DeleteSolution](API_DeleteSolution.md) 
+  [DescribeAlgorithm](API_DescribeAlgorithm.md) 
+  [DescribeBatchInferenceJob](API_DescribeBatchInferenceJob.md) 
+  [DescribeBatchSegmentJob](API_DescribeBatchSegmentJob.md) 
+  [DescribeCampaign](API_DescribeCampaign.md) 
+  [DescribeDataDeletionJob](API_DescribeDataDeletionJob.md) 
+  [DescribeDataset](API_DescribeDataset.md) 
+  [DescribeDatasetExportJob](API_DescribeDatasetExportJob.md) 
+  [DescribeDatasetGroup](API_DescribeDatasetGroup.md) 
+  [DescribeDatasetImportJob](API_DescribeDatasetImportJob.md) 
+  [DescribeEventTracker](API_DescribeEventTracker.md) 
+  [DescribeFeatureTransformation](API_DescribeFeatureTransformation.md) 
+  [DescribeFilter](API_DescribeFilter.md) 
+  [DescribeMetricAttribution](API_DescribeMetricAttribution.md) 
+  [DescribeRecipe](API_DescribeRecipe.md) 
+  [DescribeRecommender](API_DescribeRecommender.md) 
+  [DescribeSchema](API_DescribeSchema.md) 
+  [DescribeSolution](API_DescribeSolution.md) 
+  [DescribeSolutionVersion](API_DescribeSolutionVersion.md) 
+  [GetSolutionMetrics](API_GetSolutionMetrics.md) 
+  [ListBatchInferenceJobs](API_ListBatchInferenceJobs.md) 
+  [ListBatchSegmentJobs](API_ListBatchSegmentJobs.md) 
+  [ListCampaigns](API_ListCampaigns.md) 
+  [ListDataDeletionJobs](API_ListDataDeletionJobs.md) 
+  [ListDatasetExportJobs](API_ListDatasetExportJobs.md) 
+  [ListDatasetGroups](API_ListDatasetGroups.md) 
+  [ListDatasetImportJobs](API_ListDatasetImportJobs.md) 
+  [ListDatasets](API_ListDatasets.md) 
+  [ListEventTrackers](API_ListEventTrackers.md) 
+  [ListFilters](API_ListFilters.md) 
+  [ListMetricAttributionMetrics](API_ListMetricAttributionMetrics.md) 
+  [ListMetricAttributions](API_ListMetricAttributions.md) 
+  [ListRecipes](API_ListRecipes.md) 
+  [ListRecommenders](API_ListRecommenders.md) 
+  [ListSchemas](API_ListSchemas.md) 
+  [ListSolutions](API_ListSolutions.md) 
+  [ListSolutionVersions](API_ListSolutionVersions.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [StartRecommender](API_StartRecommender.md) 
+  [StopRecommender](API_StopRecommender.md) 
+  [StopSolutionVersionCreation](API_StopSolutionVersionCreation.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateCampaign](API_UpdateCampaign.md) 
+  [UpdateDataset](API_UpdateDataset.md) 
+  [UpdateMetricAttribution](API_UpdateMetricAttribution.md) 
+  [UpdateRecommender](API_UpdateRecommender.md) 
+  [UpdateSolution](API_UpdateSolution.md) 

Os eventos do Amazon Personalize oferecem suporte às seguintes ações:
+  [PutActionInteractions](API_UBS_PutActionInteractions.md) 
+  [PutActions](API_UBS_PutActions.md) 
+  [PutEvents](API_UBS_PutEvents.md) 
+  [PutItems](API_UBS_PutItems.md) 
+  [PutUsers](API_UBS_PutUsers.md) 

O runtime do Amazon Personalize oferece suporte às seguintes ações:
+  [GetActionRecommendations](API_RS_GetActionRecommendations.md) 
+  [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) 
+  [GetRecommendations](API_RS_GetRecommendations.md) 

# Amazon Personalize
<a name="API_Operations_Amazon_Personalize"></a>

O Amazon Personalize oferece suporte às seguintes ações:
+  [CreateBatchInferenceJob](API_CreateBatchInferenceJob.md) 
+  [CreateBatchSegmentJob](API_CreateBatchSegmentJob.md) 
+  [CreateCampaign](API_CreateCampaign.md) 
+  [CreateDataDeletionJob](API_CreateDataDeletionJob.md) 
+  [CreateDataset](API_CreateDataset.md) 
+  [CreateDatasetExportJob](API_CreateDatasetExportJob.md) 
+  [CreateDatasetGroup](API_CreateDatasetGroup.md) 
+  [CreateDatasetImportJob](API_CreateDatasetImportJob.md) 
+  [CreateEventTracker](API_CreateEventTracker.md) 
+  [CreateFilter](API_CreateFilter.md) 
+  [CreateMetricAttribution](API_CreateMetricAttribution.md) 
+  [CreateRecommender](API_CreateRecommender.md) 
+  [CreateSchema](API_CreateSchema.md) 
+  [CreateSolution](API_CreateSolution.md) 
+  [CreateSolutionVersion](API_CreateSolutionVersion.md) 
+  [DeleteCampaign](API_DeleteCampaign.md) 
+  [DeleteDataset](API_DeleteDataset.md) 
+  [DeleteDatasetGroup](API_DeleteDatasetGroup.md) 
+  [DeleteEventTracker](API_DeleteEventTracker.md) 
+  [DeleteFilter](API_DeleteFilter.md) 
+  [DeleteMetricAttribution](API_DeleteMetricAttribution.md) 
+  [DeleteRecommender](API_DeleteRecommender.md) 
+  [DeleteSchema](API_DeleteSchema.md) 
+  [DeleteSolution](API_DeleteSolution.md) 
+  [DescribeAlgorithm](API_DescribeAlgorithm.md) 
+  [DescribeBatchInferenceJob](API_DescribeBatchInferenceJob.md) 
+  [DescribeBatchSegmentJob](API_DescribeBatchSegmentJob.md) 
+  [DescribeCampaign](API_DescribeCampaign.md) 
+  [DescribeDataDeletionJob](API_DescribeDataDeletionJob.md) 
+  [DescribeDataset](API_DescribeDataset.md) 
+  [DescribeDatasetExportJob](API_DescribeDatasetExportJob.md) 
+  [DescribeDatasetGroup](API_DescribeDatasetGroup.md) 
+  [DescribeDatasetImportJob](API_DescribeDatasetImportJob.md) 
+  [DescribeEventTracker](API_DescribeEventTracker.md) 
+  [DescribeFeatureTransformation](API_DescribeFeatureTransformation.md) 
+  [DescribeFilter](API_DescribeFilter.md) 
+  [DescribeMetricAttribution](API_DescribeMetricAttribution.md) 
+  [DescribeRecipe](API_DescribeRecipe.md) 
+  [DescribeRecommender](API_DescribeRecommender.md) 
+  [DescribeSchema](API_DescribeSchema.md) 
+  [DescribeSolution](API_DescribeSolution.md) 
+  [DescribeSolutionVersion](API_DescribeSolutionVersion.md) 
+  [GetSolutionMetrics](API_GetSolutionMetrics.md) 
+  [ListBatchInferenceJobs](API_ListBatchInferenceJobs.md) 
+  [ListBatchSegmentJobs](API_ListBatchSegmentJobs.md) 
+  [ListCampaigns](API_ListCampaigns.md) 
+  [ListDataDeletionJobs](API_ListDataDeletionJobs.md) 
+  [ListDatasetExportJobs](API_ListDatasetExportJobs.md) 
+  [ListDatasetGroups](API_ListDatasetGroups.md) 
+  [ListDatasetImportJobs](API_ListDatasetImportJobs.md) 
+  [ListDatasets](API_ListDatasets.md) 
+  [ListEventTrackers](API_ListEventTrackers.md) 
+  [ListFilters](API_ListFilters.md) 
+  [ListMetricAttributionMetrics](API_ListMetricAttributionMetrics.md) 
+  [ListMetricAttributions](API_ListMetricAttributions.md) 
+  [ListRecipes](API_ListRecipes.md) 
+  [ListRecommenders](API_ListRecommenders.md) 
+  [ListSchemas](API_ListSchemas.md) 
+  [ListSolutions](API_ListSolutions.md) 
+  [ListSolutionVersions](API_ListSolutionVersions.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [StartRecommender](API_StartRecommender.md) 
+  [StopRecommender](API_StopRecommender.md) 
+  [StopSolutionVersionCreation](API_StopSolutionVersionCreation.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateCampaign](API_UpdateCampaign.md) 
+  [UpdateDataset](API_UpdateDataset.md) 
+  [UpdateMetricAttribution](API_UpdateMetricAttribution.md) 
+  [UpdateRecommender](API_UpdateRecommender.md) 
+  [UpdateSolution](API_UpdateSolution.md) 

# CreateBatchInferenceJob
<a name="API_CreateBatchInferenceJob"></a>

Gera recomendações em lote com base em uma lista de itens ou usuários armazenados no Amazon S3 e exporta as recomendações para um bucket do Amazon S3.

Para gerar recomendações em lote, especifique o ARN de uma versão da solução e um URI do Amazon S3 para os dados de entrada e saída. Para personalização do usuário, itens populares e soluções de classificação personalizada, o trabalho de inferência em lote gera uma lista de itens recomendados para cada ID de usuário no arquivo de entrada. Para soluções de itens relacionados, o trabalho gera uma lista de itens recomendados para cada ID de item no arquivo de entrada.

Para obter mais informações, consulte [Criar um trabalho de inferência em lote](https://docs.aws.amazon.com/personalize/latest/dg/getting-batch-recommendations.html).

 Se a fórmula Similar-Items for utilizada, o Amazon Personalize poderá adicionar temas descritivos às recomendações em lote. Para gerar temas, defina o modo do trabalho como `THEME_GENERATION` e especifique o nome do campo que contém os nomes dos itens nos dados de entrada.

 Para obter mais informações sobre a geração de temas, consulte [Recomendações em lote com temas do Content Generator](https://docs.aws.amazon.com/personalize/latest/dg/themed-batch-recommendations.html). 

Você não pode obter recomendações de lote com o Trending-Now ou com as receitas. Next-Best-Action

## Sintaxe da solicitação
<a name="API_CreateBatchInferenceJob_RequestSyntax"></a>

```
{
   "batchInferenceJobConfig": { 
      "itemExplorationConfig": { 
         "string" : "string" 
      },
      "rankingInfluence": { 
         "string" : number 
      }
   },
   "batchInferenceJobMode": "string",
   "filterArn": "string",
   "jobInput": { 
      "s3DataSource": { 
         "kmsKeyArn": "string",
         "path": "string"
      }
   },
   "jobName": "string",
   "jobOutput": { 
      "s3DataDestination": { 
         "kmsKeyArn": "string",
         "path": "string"
      }
   },
   "numResults": number,
   "roleArn": "string",
   "solutionVersionArn": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ],
   "themeGenerationConfig": { 
      "fieldsForThemeGeneration": { 
         "itemName": "string"
      }
   }
}
```

## Parâmetros da solicitação
<a name="API_CreateBatchInferenceJob_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [batchInferenceJobConfig](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-batchInferenceJobConfig"></a>
Os detalhes da configuração de um trabalho de inferência em lote.  
Tipo: objeto [BatchInferenceJobConfig](API_BatchInferenceJobConfig.md)  
Obrigatório: não

 ** [batchInferenceJobMode](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-batchInferenceJobMode"></a>
O modo do trabalho de inferência em lote. Para gerar temas descritivos para grupos de itens semelhantes, defina o modo de trabalho como `THEME_GENERATION`. Se não quiser gerar temas, use a `BATCH_INFERENCE` padrão.  
 Ao receber recomendações em lote com temas, são gerados custos adicionais. Para obter mais informações, consulte [Preços do Amazon Personalize](https://aws.amazon.com/personalize/pricing/).   
Tipo: string  
Valores válidos: `BATCH_INFERENCE | THEME_GENERATION`   
Obrigatório: não

 ** [filterArn](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-filterArn"></a>
O ARN do filtro a ser aplicado ao trabalho de inferência em lote. Para obter mais informações sobre como usar filtros, consulte [Filtrar recomendações em lote](https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html).  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [jobInput](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-jobInput"></a>
O caminho do Amazon S3 que leva ao arquivo de entrada no qual basear suas recomendações. O material de entrada deve estar em formato JSON.  
Tipo: objeto [BatchInferenceJobInput](API_BatchInferenceJobInput.md)  
Obrigatório: Sim

 ** [jobName](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-jobName"></a>
O nome do trabalho de inferência em lote a ser criado.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Sim

 ** [jobOutput](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-jobOutput"></a>
O caminho para o bucket do Amazon S3 no qual a saída do trabalho é armazenada.  
Tipo: objeto [BatchInferenceJobOutput](API_BatchInferenceJobOutput.md)  
Obrigatório: Sim

 ** [numResults](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-numResults"></a>
O número de recomendações a serem recuperadas.  
Tipo: inteiro  
Obrigatório: não

 ** [roleArn](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-roleArn"></a>
O ARN da função Amazon Identity and Access Management que tem permissões para ler e gravar em seus buckets de entrada e saída do Amazon S3, respectivamente.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Obrigatório: Sim

 ** [solutionVersionArn](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-solutionVersionArn"></a>
O nome do recurso da Amazon (ARN) da versão da solução que será usado para gerar as recomendações de inferência em lote.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [tags](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-tags"></a>
Uma lista de [tags](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) a serem aplicadas ao trabalho de inferência em lote.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

 ** [themeGenerationConfig](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-themeGenerationConfig"></a>
Para trabalhos de geração de temas, especifique o nome da coluna no conjunto de dados de itens que contém o nome de cada item.  
Tipo: objeto [ThemeGenerationConfig](API_ThemeGenerationConfig.md)  
Obrigatório: não

## Sintaxe da resposta
<a name="API_CreateBatchInferenceJob_ResponseSyntax"></a>

```
{
   "batchInferenceJobArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateBatchInferenceJob_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [batchInferenceJobArn](#API_CreateBatchInferenceJob_ResponseSyntax) **   <a name="personalize-CreateBatchInferenceJob-response-batchInferenceJobArn"></a>
O ARN do trabalho de inferência em lote.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## Erros
<a name="API_CreateBatchInferenceJob_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** LimitExceededException **   
O limite de número de solicitações por segundo foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
O recurso especificado já existe.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de status HTTP: 400

 ** TooManyTagsException **   
Você excedeu o número máximo de tags que pode aplicar a esse recurso.   
Código de Status HTTP: 400

## Consulte também
<a name="API_CreateBatchInferenceJob_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateBatchInferenceJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateBatchInferenceJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateBatchInferenceJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateBatchInferenceJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateBatchInferenceJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateBatchInferenceJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateBatchInferenceJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateBatchInferenceJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateBatchInferenceJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateBatchInferenceJob) 

# CreateBatchSegmentJob
<a name="API_CreateBatchSegmentJob"></a>

Cria um trabalho de segmento em lote. A operação pode gerenciar até 50 milhões de registros, e o arquivo de entrada deve estar no formato JSON. Para obter mais informações, consulte [Receber recomendações em lote e segmentos de usuários](https://docs.aws.amazon.com/personalize/latest/dg/recommendations-batch.html).

## Sintaxe da solicitação
<a name="API_CreateBatchSegmentJob_RequestSyntax"></a>

```
{
   "filterArn": "string",
   "jobInput": { 
      "s3DataSource": { 
         "kmsKeyArn": "string",
         "path": "string"
      }
   },
   "jobName": "string",
   "jobOutput": { 
      "s3DataDestination": { 
         "kmsKeyArn": "string",
         "path": "string"
      }
   },
   "numResults": number,
   "roleArn": "string",
   "solutionVersionArn": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

## Parâmetros da solicitação
<a name="API_CreateBatchSegmentJob_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [filterArn](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-filterArn"></a>
O ARN do filtro a ser aplicado ao trabalho do segmento em lote. Para obter mais informações sobre como usar filtros, consulte [Filtrar recomendações em lote](https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html).  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [jobInput](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-jobInput"></a>
O caminho do Amazon S3 para os dados de entrada usados para gerar o trabalho do segmento em lote.  
Tipo: objeto [BatchSegmentJobInput](API_BatchSegmentJobInput.md)  
Obrigatório: Sim

 ** [jobName](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-jobName"></a>
O nome do trabalho do segmento em lote a ser criado.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Sim

 ** [jobOutput](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-jobOutput"></a>
O caminho do Amazon S3 para o bucket no qual a saída do trabalho será armazenada.  
Tipo: objeto [BatchSegmentJobOutput](API_BatchSegmentJobOutput.md)  
Obrigatório: Sim

 ** [numResults](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-numResults"></a>
O número de usuários previstos gerados pelo trabalho do segmento em lote para cada linha de dados de entrada. O número máximo de usuários por segmento é de 5 milhões.  
Tipo: inteiro  
Obrigatório: não

 ** [roleArn](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-roleArn"></a>
O ARN da função Amazon Identity and Access Management que tem permissões para ler e gravar em seus buckets de entrada e saída do Amazon S3, respectivamente.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Obrigatório: Sim

 ** [solutionVersionArn](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-solutionVersionArn"></a>
O nome do recurso da Amazon (ARN) da versão da solução que você quer que o trabalho do segmento em lote use para gerar segmentos em lote.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [tags](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-tags"></a>
Uma lista de [tags](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) a serem aplicadas ao trabalho do segmento em lote.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

## Sintaxe da resposta
<a name="API_CreateBatchSegmentJob_ResponseSyntax"></a>

```
{
   "batchSegmentJobArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateBatchSegmentJob_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [batchSegmentJobArn](#API_CreateBatchSegmentJob_ResponseSyntax) **   <a name="personalize-CreateBatchSegmentJob-response-batchSegmentJobArn"></a>
O ARN do trabalho do segmento em lote.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## Erros
<a name="API_CreateBatchSegmentJob_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** LimitExceededException **   
O limite de número de solicitações por segundo foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
O recurso especificado já existe.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de status HTTP: 400

 ** TooManyTagsException **   
Você excedeu o número máximo de tags que pode aplicar a esse recurso.   
Código de Status HTTP: 400

## Consulte também
<a name="API_CreateBatchSegmentJob_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateBatchSegmentJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateBatchSegmentJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateBatchSegmentJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateBatchSegmentJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateBatchSegmentJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateBatchSegmentJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateBatchSegmentJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateBatchSegmentJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateBatchSegmentJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateBatchSegmentJob) 

# CreateCampaign
<a name="API_CreateCampaign"></a>

**Importante**  
 Os custos da campanha são acumulados enquanto ela está ativa. Para evitar custos desnecessários, certifique-se de excluir a campanha quando terminar. Para obter mais informações sobre os custos das campanhas, consulte [Preços do Amazon Personalize](https://aws.amazon.com/personalize/pricing/).

Crie uma campanha que implanta uma versão da solução. Quando um cliente liga para o [GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html)e [GetPersonalizedRanking](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html) APIs, uma campanha é especificada na solicitação.

 **TPS provisionado mínimo e ajuste de escala automático** 

**Importante**  
 Um `minProvisionedTPS` alto aumentará o custo. Recomendamos começar com 1 para `minProvisionedTPS` (o padrão). Monitore seu uso usando CloudWatch as métricas da Amazon e aumente as `minProvisionedTPS` conforme necessário.

 Ao criar uma campanha do Amazon Personalize, é possível especificar o mínimo de transações provisionadas por segundo (`minProvisionedTPS`) para a campanha. Esse é o throughput de transação básico para a campanha provisionada pelo Amazon Personalize. Ele define a cobrança mínima para a campanha enquanto ela está ativa. Transação é uma solicitação `GetRecommendations` ou `GetPersonalizedRanking` única. O `minProvisionedTPS` padrão é um.

 Se o TPS ultrapassar o `minProvisionedTPS`, o Amazon Personalize fará um ajuste de escala automático da capacidade provisionada, mas nunca a definirá como abaixo de `minProvisionedTPS`. Há um pequeno atraso no aumento da capacidade, o que pode causar perda de transações. Quando o tráfego é reduzido, a capacidade retorna ao `minProvisionedTPS`. 

Você recebe cobrança pelo TPS mínimo provisionado ou, se as solicitações excederem o `minProvisionedTPS`, o TPS real. O TPS real é o número total de solicitações de recomendação realizadas. Recomendamos começar com uma baixa`minProvisionedTPS`, monitorar seu uso usando CloudWatch as métricas da Amazon e, em seguida, aumentá-las `minProvisionedTPS` conforme necessário.

Para obter mais informações sobre custos de campanhas, consulte [Preços do Amazon Personalize](https://aws.amazon.com/personalize/pricing/).

 **Status** 

Uma campanha pode estar em um dos seguintes estados:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS

Para obter o status da campanha, ligue [DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html).

**nota**  
Aguarde até que o `status` da campanha seja `ACTIVE` para pedir recomendações à campanha.

**Relacionado APIs**
+  [ListCampaigns](https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html) 
+  [DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) 
+  [UpdateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateCampaign.html) 
+  [DeleteCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteCampaign.html) 

## Sintaxe da solicitação
<a name="API_CreateCampaign_RequestSyntax"></a>

```
{
   "campaignConfig": { 
      "enableMetadataWithRecommendations": boolean,
      "itemExplorationConfig": { 
         "string" : "string" 
      },
      "rankingInfluence": { 
         "string" : number 
      },
      "syncWithLatestSolutionVersion": boolean
   },
   "minProvisionedTPS": number,
   "name": "string",
   "solutionVersionArn": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

## Parâmetros da solicitação
<a name="API_CreateCampaign_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [campaignConfig](#API_CreateCampaign_RequestSyntax) **   <a name="personalize-CreateCampaign-request-campaignConfig"></a>
Os detalhes de configuração de uma campanha.  
Tipo: objeto [CampaignConfig](API_CampaignConfig.md)  
Obrigatório: não

 ** [minProvisionedTPS](#API_CreateCampaign_RequestSyntax) **   <a name="personalize-CreateCampaign-request-minProvisionedTPS"></a>
Especifica o mínimo de transações provisionadas (recomendações) solicitadas por segundo para o qual o Amazon Personalize oferecerá suporte. Uma `minProvisionedTPS` alta aumentará sua conta. Recomendamos começar com 1 para `minProvisionedTPS` (o padrão). Monitore seu uso usando CloudWatch as métricas da Amazon e aumente as `minProvisionedTPS` conforme necessário.  
Tipo: inteiro  
Intervalo válido: valor mínimo de 1.  
Obrigatório: não

 ** [name](#API_CreateCampaign_RequestSyntax) **   <a name="personalize-CreateCampaign-request-name"></a>
Um nome para a nova campanha. O nome da campanha deve ser exclusivo na sua conta.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Sim

 ** [solutionVersionArn](#API_CreateCampaign_RequestSyntax) **   <a name="personalize-CreateCampaign-request-solutionVersionArn"></a>
O nome de recurso da Amazon (ARN) do modelo treinado a ser implantado com a campanha. Para especificar a versão mais recente da solução, indique o ARN da *solução* no formato `SolutionArn/$LATEST`. Você deve usar esse formato se você `syncWithLatestSolutionVersion` definir como `True` no [CampaignConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html).   
 Para implantar um modelo que não seja a versão mais recente da solução, especifique o ARN da versão da solução.   
 Para obter informações sobre as atualizações automáticas das campanhas, consulte [Habilitar as atualizações de campanha automáticas](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update).   
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [tags](#API_CreateCampaign_RequestSyntax) **   <a name="personalize-CreateCampaign-request-tags"></a>
Uma lista de [tags](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) a serem aplicadas à campanha.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

## Sintaxe da resposta
<a name="API_CreateCampaign_ResponseSyntax"></a>

```
{
   "campaignArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateCampaign_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [campaignArn](#API_CreateCampaign_ResponseSyntax) **   <a name="personalize-CreateCampaign-response-campaignArn"></a>
O nome do recurso da Amazon (ARN) da campanha.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## Erros
<a name="API_CreateCampaign_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** LimitExceededException **   
O limite de número de solicitações por segundo foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
O recurso especificado já existe.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de status HTTP: 400

 ** TooManyTagsException **   
Você excedeu o número máximo de tags que pode aplicar a esse recurso.   
Código de Status HTTP: 400

## Consulte também
<a name="API_CreateCampaign_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateCampaign) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateCampaign) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateCampaign) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateCampaign) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateCampaign) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateCampaign) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateCampaign) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateCampaign) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateCampaign) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateCampaign) 

# CreateDataDeletionJob
<a name="API_CreateDataDeletionJob"></a>

Cria um trabalho em lote que exclui todas as referências a usuários específicos de um grupo de conjuntos de dados do Amazon Personalize em lotes. Você especifica os usuários a serem excluídos em um arquivo CSV com os UserIDs em um bucket do Amazon S3. Depois da conclusão de um trabalho, o Amazon Personalize deixa de treinar seus dados e não considera mais os usuários ao gerar os segmentos. Para obter mais informações sobre criar um trabalho de exclusão de dados, consulte [Excluir usuários](https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html).
+ Seu arquivo de entrada deve ser um arquivo CSV com uma única coluna USER\$1ID que lista os usuários. IDs Para obter mais informações sobre como preparar o arquivo CSV, consulte [Preparar seu arquivo de exclusão de dados e enviá-lo para o Amazon S3](https://docs.aws.amazon.com/personalize/latest/dg/prepare-deletion-input-file.html).
+ Para permitir o Amazon Personalize para acessar seu arquivo CSV de entrada com UserIDs, você deve especificar um perfil de serviço do IAM que tenha permissão para ler a fonte de dados. Esse perfil precisa de permissões de `GetObject` e `ListBucket` para o bucket e seu conteúdo. Essas permissões são iguais às da importação de dados. Para obter informações sobre como conceder acesso ao bucket do Amazon S3, consulte [Conceder ao Amazon Personalize acesso aos recursos do Amazon S3](https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html). 

 Depois que você criar um trabalho, poderá levar até um dia para excluir todas as referências aos usuários dos conjuntos de dados e modelos. Até que o trabalho seja concluído, o Amazon Personalize continua usando os dados durante o treinamento. E se você usar uma fórmula de segmentação de usuários, eles podem aparecer em segmentos de usuários. 

 **Status** 

Um trabalho de exclusão de dados pode ter um dos seguintes status:
+ PENDENTE > EM ANDAMENTO > CONCLUÍDO -ou- FALHA

Para obter o status do trabalho de exclusão de dados, chame a operação [DescribeDataDeletionJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html)da API e especifique o Amazon Resource Name (ARN) do trabalho. Se o status for Falha, a resposta incluirá uma chave `failureReason` que descreve por que o trabalho falhou.

**Relacionado APIs**
+  [ListDataDeletionJobs](https://docs.aws.amazon.com/personalize/latest/dg/API_ListDataDeletionJobs.html) 
+  [DescribeDataDeletionJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html) 

## Sintaxe da solicitação
<a name="API_CreateDataDeletionJob_RequestSyntax"></a>

```
{
   "datasetGroupArn": "string",
   "dataSource": { 
      "dataLocation": "string"
   },
   "jobName": "string",
   "roleArn": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

## Parâmetros da solicitação
<a name="API_CreateDataDeletionJob_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetGroupArn](#API_CreateDataDeletionJob_RequestSyntax) **   <a name="personalize-CreateDataDeletionJob-request-datasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do grupo do conjunto de dados que tem os conjuntos contendo os registros que você quer excluir.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [dataSource](#API_CreateDataDeletionJob_RequestSyntax) **   <a name="personalize-CreateDataDeletionJob-request-dataSource"></a>
O bucket do Amazon S3 que contém a lista de UserIDs a serem excluídos.  
Tipo: objeto [DataSource](API_DataSource.md)  
Obrigatório: Sim

 ** [jobName](#API_CreateDataDeletionJob_RequestSyntax) **   <a name="personalize-CreateDataDeletionJob-request-jobName"></a>
O nome do trabalho de exclusão de dados.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Sim

 ** [roleArn](#API_CreateDataDeletionJob_RequestSyntax) **   <a name="personalize-CreateDataDeletionJob-request-roleArn"></a>
O nome do recurso da Amazon (ARN) do perfil do IAM que tem permissão para ler a fonte de dados do Amazon S3.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Obrigatório: Sim

 ** [tags](#API_CreateDataDeletionJob_RequestSyntax) **   <a name="personalize-CreateDataDeletionJob-request-tags"></a>
Uma lista de [tags](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) a serem aplicadas ao trabalho de exclusão de dados do conjunto de dados.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

## Sintaxe da resposta
<a name="API_CreateDataDeletionJob_ResponseSyntax"></a>

```
{
   "dataDeletionJobArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateDataDeletionJob_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [dataDeletionJobArn](#API_CreateDataDeletionJob_ResponseSyntax) **   <a name="personalize-CreateDataDeletionJob-response-dataDeletionJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de exclusão de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## Erros
<a name="API_CreateDataDeletionJob_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** LimitExceededException **   
O limite de número de solicitações por segundo foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
O recurso especificado já existe.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de status HTTP: 400

 ** TooManyTagsException **   
Você excedeu o número máximo de tags que pode aplicar a esse recurso.   
Código de Status HTTP: 400

## Consulte também
<a name="API_CreateDataDeletionJob_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateDataDeletionJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateDataDeletionJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateDataDeletionJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateDataDeletionJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateDataDeletionJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateDataDeletionJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateDataDeletionJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateDataDeletionJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateDataDeletionJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateDataDeletionJob) 

# CreateDataset
<a name="API_CreateDataset"></a>

Cria um conjunto de dados vazio e o adiciona ao grupo de conjuntos de dados especificado. Use [CreateDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html)para importar seus dados de treinamento para um conjunto de dados.

Há cinco tipos de conjunto de dados:
+ Interações com itens
+ Itens
+ Usuários
+ Interações com ações
+ Ações

Cada tipo de conjunto de dados tem um esquema associado com tipos de campos necessários. Somente o conjunto de dados `Item interactions` é necessário para treinar um modelo (também conhecido como criação de uma solução).

Um conjunto de dados pode estar em um dos seguintes estados:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -ou- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS

Para obter o status do conjunto de dados, ligue para [DescribeDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html).

**Relacionado APIs**
+  [CreateDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html) 
+  [ListDatasets](https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasets.html) 
+  [DescribeDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html) 
+  [DeleteDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDataset.html) 

## Sintaxe da solicitação
<a name="API_CreateDataset_RequestSyntax"></a>

```
{
   "datasetGroupArn": "string",
   "datasetType": "string",
   "name": "string",
   "schemaArn": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

## Parâmetros da solicitação
<a name="API_CreateDataset_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetGroupArn](#API_CreateDataset_RequestSyntax) **   <a name="personalize-CreateDataset-request-datasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do grupo de conjuntos de dados ao qual o conjunto de dados será adicionado.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [datasetType](#API_CreateDataset_RequestSyntax) **   <a name="personalize-CreateDataset-request-datasetType"></a>
O tipo de conjunto de dados.  
Um dos seguintes valores (não diferencia maiúsculas e minúsculas):  
+ Interações
+ Itens
+ Usuários
+ Ações
+ Action\$1Interactions
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `^[A-Za-z_]+$`   
Obrigatório: Sim

 ** [name](#API_CreateDataset_RequestSyntax) **   <a name="personalize-CreateDataset-request-name"></a>
O nome do conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Sim

 ** [schemaArn](#API_CreateDataset_RequestSyntax) **   <a name="personalize-CreateDataset-request-schemaArn"></a>
O ARN do esquema ao qual o conjunto de dados será associado. O esquema define os campos do conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [tags](#API_CreateDataset_RequestSyntax) **   <a name="personalize-CreateDataset-request-tags"></a>
Uma lista de [tags](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) a serem aplicadas ao conjunto de dados.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

## Sintaxe da resposta
<a name="API_CreateDataset_ResponseSyntax"></a>

```
{
   "datasetArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateDataset_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [datasetArn](#API_CreateDataset_ResponseSyntax) **   <a name="personalize-CreateDataset-response-datasetArn"></a>
O ARN do conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## Erros
<a name="API_CreateDataset_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** LimitExceededException **   
O limite de número de solicitações por segundo foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
O recurso especificado já existe.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de status HTTP: 400

 ** TooManyTagsException **   
Você excedeu o número máximo de tags que pode aplicar a esse recurso.   
Código de Status HTTP: 400

## Consulte também
<a name="API_CreateDataset_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateDataset) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateDataset) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateDataset) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateDataset) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateDataset) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateDataset) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateDataset) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateDataset) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateDataset) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateDataset) 

# CreateDatasetExportJob
<a name="API_CreateDatasetExportJob"></a>

 Cria um trabalho que exporta dados de seu conjunto de dados para um bucket do Amazon S3. Para permitir que o Amazon Personalize exporte os dados de treinamento, você deve especificar um perfil do IAM vinculado ao serviço que dê permissões `PutObject` ao Amazon Personalize para seu bucket do Amazon S3. Para obter informações, consulte [Exportação de um conjunto de dados](https://docs.aws.amazon.com/personalize/latest/dg/export-data.html) no guia do desenvolvedor do Amazon Personalize. 

 **Status** 

Um trabalho de exportação do conjunto de dados pode estar em um dos seguintes estados:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE ou CREATE FAILED

 Para obter o status do trabalho de exportação [DescribeDatasetExportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html), chame e especifique o Amazon Resource Name (ARN) do trabalho de exportação do conjunto de dados. A exportação do conjunto de dados estará concluída quando o status for ACTIVE. Se o status for exibido como CREATE FAILED, a resposta incluirá uma chave `failureReason` que descreve por que o trabalho falhou. 

## Sintaxe da solicitação
<a name="API_CreateDatasetExportJob_RequestSyntax"></a>

```
{
   "datasetArn": "string",
   "ingestionMode": "string",
   "jobName": "string",
   "jobOutput": { 
      "s3DataDestination": { 
         "kmsKeyArn": "string",
         "path": "string"
      }
   },
   "roleArn": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

## Parâmetros da solicitação
<a name="API_CreateDatasetExportJob_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetArn](#API_CreateDatasetExportJob_RequestSyntax) **   <a name="personalize-CreateDatasetExportJob-request-datasetArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados que contém os dados para exportação.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [ingestionMode](#API_CreateDatasetExportJob_RequestSyntax) **   <a name="personalize-CreateDatasetExportJob-request-ingestionMode"></a>
Os dados a serem exportados, com base em como você importou os dados. Você pode optar por exportar somente `BULK` os dados importados usando um trabalho de importação de conjunto de dados, somente `PUT` os dados importados de forma incremental (usando o console PutUsers e PutItems as operações) ou `ALL` para os dois tipos. PutEvents O valor padrão é `PUT`.   
Tipo: string  
Valores válidos: `BULK | PUT | ALL`   
Obrigatório: não

 ** [jobName](#API_CreateDatasetExportJob_RequestSyntax) **   <a name="personalize-CreateDatasetExportJob-request-jobName"></a>
O nome do trabalho de exportação do conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Sim

 ** [jobOutput](#API_CreateDatasetExportJob_RequestSyntax) **   <a name="personalize-CreateDatasetExportJob-request-jobOutput"></a>
O caminho do bucket do Amazon S3 no qual a saída do trabalho é armazenada.  
Tipo: objeto [DatasetExportJobOutput](API_DatasetExportJobOutput.md)  
Obrigatório: Sim

 ** [roleArn](#API_CreateDatasetExportJob_RequestSyntax) **   <a name="personalize-CreateDatasetExportJob-request-roleArn"></a>
O nome do recurso da Amazon (ARN) de um perfil de serviço do IAM com permissões para adicionar dados ao bucket do Amazon S3 de saída.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Obrigatório: Sim

 ** [tags](#API_CreateDatasetExportJob_RequestSyntax) **   <a name="personalize-CreateDatasetExportJob-request-tags"></a>
Uma lista de [tags](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) a serem aplicadas ao trabalho de exportação do conjunto de dados.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

## Sintaxe da resposta
<a name="API_CreateDatasetExportJob_ResponseSyntax"></a>

```
{
   "datasetExportJobArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateDatasetExportJob_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [datasetExportJobArn](#API_CreateDatasetExportJob_ResponseSyntax) **   <a name="personalize-CreateDatasetExportJob-response-datasetExportJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de exportação do conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## Erros
<a name="API_CreateDatasetExportJob_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** LimitExceededException **   
O limite de número de solicitações por segundo foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
O recurso especificado já existe.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de status HTTP: 400

 ** TooManyTagsException **   
Você excedeu o número máximo de tags que pode aplicar a esse recurso.   
Código de Status HTTP: 400

## Consulte também
<a name="API_CreateDatasetExportJob_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateDatasetExportJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateDatasetExportJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateDatasetExportJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateDatasetExportJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateDatasetExportJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateDatasetExportJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateDatasetExportJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateDatasetExportJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateDatasetExportJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateDatasetExportJob) 

# CreateDatasetGroup
<a name="API_CreateDatasetGroup"></a>

Cria um grupo de conjuntos de dados vazio. Um grupo do conjunto de dados é um contêiner para recursos do Amazon Personalize. Um grupo de conjuntos de dados pode conter no máximo três conjuntos de dados, um para cada tipo de conjunto de dados:
+ Interações com itens
+ Itens
+ Usuários
+ Ações
+ Interações com ações

 Um grupo de conjuntos de dados pode ser um grupo de conjuntos de dados de domínio, em que você especifica um domínio e usa recursos pré-configurados, como recomendações, ou um grupo de conjuntos de dados personalizados, em que você usa recursos personalizados, como uma solução com uma versão da solução, que você implanta com uma campanha. Se começar com um grupo de conjunto de dados de domínio, você ainda pode adicionar recursos personalizados, como soluções e versões de soluções treinadas com fórmulas para casos de uso personalizados e implantadas com campanhas. 

Um grupo de conjuntos de dados pode estar em um dos seguintes estados:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING

Para obter o status do grupo de conjuntos de dados, ligue para [DescribeDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html). Se o status for exibido como CREATE FAILED, a resposta incluirá uma chave `failureReason` que descreve por que a criação falhou.

**nota**  
Você deve esperar até que o `status` do grupo de conjuntos de dados esteja `ACTIVE` antes de adicionar um conjunto de dados ao grupo.

Você pode especificar uma chave AWS Key Management Service (KMS) para criptografar os conjuntos de dados no grupo. Se você especificar uma chave KMS, também deverá incluir um perfil do IAM AWS Identity and Access Management que tenha permissão para acessar a chave.

**APIs que exigem um ARN do grupo de conjuntos de dados na solicitação**
+  [CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html) 
+  [CreateEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html) 
+  [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) 

**Relacionado APIs**
+  [ListDatasetGroups](https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetGroups.html) 
+  [DescribeDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html) 
+  [DeleteDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDatasetGroup.html) 

## Sintaxe da solicitação
<a name="API_CreateDatasetGroup_RequestSyntax"></a>

```
{
   "domain": "string",
   "kmsKeyArn": "string",
   "name": "string",
   "roleArn": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

## Parâmetros da solicitação
<a name="API_CreateDatasetGroup_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [domain](#API_CreateDatasetGroup_RequestSyntax) **   <a name="personalize-CreateDatasetGroup-request-domain"></a>
O domínio do grupo de conjuntos de dados. Especifique um domínio para criar um grupo de conjunto de dados de domínio. O domínio que você especifica determina os esquemas padrão para conjuntos de dados e os casos de uso disponíveis para os recomendadores. Se você não especificar um domínio, crie um grupo de conjuntos de dados personalizados com versões da solução que você implanta com uma campanha.   
Tipo: string  
Valores válidos: `ECOMMERCE | VIDEO_ON_DEMAND`   
Obrigatório: não

 ** [kmsKeyArn](#API_CreateDatasetGroup_RequestSyntax) **   <a name="personalize-CreateDatasetGroup-request-kmsKeyArn"></a>
O Amazon Resource Name (ARN) de uma chave AWS Key Management Service (KMS) usada para criptografar os conjuntos de dados.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 2048.  
Padrão: `arn:aws.*:kms:.*:[0-9]{12}:key/.*`   
Obrigatório: não

 ** [name](#API_CreateDatasetGroup_RequestSyntax) **   <a name="personalize-CreateDatasetGroup-request-name"></a>
O nome do grupo de conjuntos de dados.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Sim

 ** [roleArn](#API_CreateDatasetGroup_RequestSyntax) **   <a name="personalize-CreateDatasetGroup-request-roleArn"></a>
O ARN da função AWS Identity and Access Management (IAM) que tem permissões para acessar a chave AWS Key Management Service (KMS). O fornecimento de um perfil do IAM só é válido quando também se especifica uma chave KMS.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Obrigatório: não

 ** [tags](#API_CreateDatasetGroup_RequestSyntax) **   <a name="personalize-CreateDatasetGroup-request-tags"></a>
Uma lista de [tags](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) a serem aplicadas ao grupo de conjuntos de dados.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

## Sintaxe da resposta
<a name="API_CreateDatasetGroup_ResponseSyntax"></a>

```
{
   "datasetGroupArn": "string",
   "domain": "string"
}
```

## Elementos de resposta
<a name="API_CreateDatasetGroup_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [datasetGroupArn](#API_CreateDatasetGroup_ResponseSyntax) **   <a name="personalize-CreateDatasetGroup-response-datasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do novo grupo de conjuntos de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

 ** [domain](#API_CreateDatasetGroup_ResponseSyntax) **   <a name="personalize-CreateDatasetGroup-response-domain"></a>
O domínio do novo grupo de conjuntos de dados do domínio.  
Tipo: string  
Valores válidos: `ECOMMERCE | VIDEO_ON_DEMAND` 

## Erros
<a name="API_CreateDatasetGroup_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** LimitExceededException **   
O limite de número de solicitações por segundo foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
O recurso especificado já existe.  
Código de status HTTP: 400

 ** TooManyTagsException **   
Você excedeu o número máximo de tags que pode aplicar a esse recurso.   
Código de Status HTTP: 400

## Consulte também
<a name="API_CreateDatasetGroup_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateDatasetGroup) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateDatasetGroup) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateDatasetGroup) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateDatasetGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateDatasetGroup) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateDatasetGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateDatasetGroup) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateDatasetGroup) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateDatasetGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateDatasetGroup) 

# CreateDatasetImportJob
<a name="API_CreateDatasetImportJob"></a>

Cria um trabalho que importa dados de treinamento de uma fonte de dados (bucket do Amazon S3) para um conjunto de dados do Amazon Personalize. Para permitir que o Amazon Personalize importe os dados de treinamento, você deve especificar um perfil de serviço do IAM que tenha permissão para ler a fonte de dados, pois o Amazon Personalize faz uma cópia dos seus dados e os processa internamente. Para obter informações sobre como conceder acesso ao bucket do Amazon S3, consulte [Conceder ao Amazon Personalize acesso aos recursos do Amazon S3](https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html). 

Se você já criou um recomendador ou implantou uma versão da solução personalizada com uma campanha, a forma como os novos registros em massa influenciam as recomendações depende do caso de uso de domínio ou da fórmula que você usa. Para obter mais informações, consulte [Como os novos dados influenciam as recomendações em tempo real](https://docs.aws.amazon.com/personalize/latest/dg/how-new-data-influences-recommendations.html).

**Importante**  
Por padrão, um trabalho de importação do conjunto de dados substitui todos os dados existentes no conjunto de dados que você importou em massa. Para adicionar novos registros sem substituir os dados existentes, especifique INCREMENTAL para o modo de importação na CreateDatasetImportJob operação.

 **Status** 

Um trabalho de importação do conjunto de dados pode estar em um dos seguintes estados:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED

Para obter o status do trabalho de importação, ligue [DescribeDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html), fornecendo o Amazon Resource Name (ARN) do trabalho de importação do conjunto de dados. A exportação do conjunto de dados estará concluída quando o status for ACTIVE. Se o status for exibido como CREATE FAILED, a resposta incluirá uma chave `failureReason` que descreve por que o trabalho falhou.

**nota**  
A importação é demorada. Você deve aguardar até que o status seja ACTIVE antes de treinar um modelo usando o conjunto de dados.

**Relacionado APIs**
+  [ListDatasetImportJobs](https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetImportJobs.html) 
+  [DescribeDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html) 

## Sintaxe da solicitação
<a name="API_CreateDatasetImportJob_RequestSyntax"></a>

```
{
   "datasetArn": "string",
   "dataSource": { 
      "dataLocation": "string"
   },
   "importMode": "string",
   "jobName": "string",
   "publishAttributionMetricsToS3": boolean,
   "roleArn": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

## Parâmetros da solicitação
<a name="API_CreateDatasetImportJob_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetArn](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="personalize-CreateDatasetImportJob-request-datasetArn"></a>
O ARN do conjunto de dados que recebe os dados importados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [dataSource](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="personalize-CreateDatasetImportJob-request-dataSource"></a>
O bucket do Amazon S3 que contém os dados de treinamento a importar.  
Tipo: objeto [DataSource](API_DataSource.md)  
Obrigatório: Sim

 ** [importMode](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="personalize-CreateDatasetImportJob-request-importMode"></a>
Especifique como adicionar os novos registros a um conjunto de dados existente. O modo de importação padrão é `FULL`. Se você não importou registros em massa para o conjunto de dados anteriormente, só pode especificar `FULL`.  
+ Especifique `FULL` para substituir todos os dados em massa existentes no seu conjunto de dados. Os dados que você importou individualmente não são substituídos.
+ Especifique `INCREMENTAL` para acrescentar os novos registros aos dados existentes no seu conjunto de dados. O Amazon Personalize substitui qualquer registro com o mesmo ID pelo novo.
Tipo: string  
Valores válidos: `FULL | INCREMENTAL`   
Obrigatório: não

 ** [jobName](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="personalize-CreateDatasetImportJob-request-jobName"></a>
O nome do trabalho de importação do conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Sim

 ** [publishAttributionMetricsToS3](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="personalize-CreateDatasetImportJob-request-publishAttributionMetricsToS3"></a>
Se você criou uma atribuição de métrica, especifique se deseja publicar métricas para esse trabalho de importação no Amazon S3  
Tipo: booliano  
Obrigatório: não

 ** [roleArn](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="personalize-CreateDatasetImportJob-request-roleArn"></a>
O ARN do perfil do IAM que tem permissão para ler a fonte de dados do Amazon S3.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Obrigatório: não

 ** [tags](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="personalize-CreateDatasetImportJob-request-tags"></a>
Uma lista de [tags](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) a serem aplicadas ao trabalho de importação do conjunto de dados.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

## Sintaxe da resposta
<a name="API_CreateDatasetImportJob_ResponseSyntax"></a>

```
{
   "datasetImportJobArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateDatasetImportJob_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [datasetImportJobArn](#API_CreateDatasetImportJob_ResponseSyntax) **   <a name="personalize-CreateDatasetImportJob-response-datasetImportJobArn"></a>
O ARN do trabalho de importação do conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## Erros
<a name="API_CreateDatasetImportJob_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** LimitExceededException **   
O limite de número de solicitações por segundo foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
O recurso especificado já existe.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de status HTTP: 400

 ** TooManyTagsException **   
Você excedeu o número máximo de tags que pode aplicar a esse recurso.   
Código de Status HTTP: 400

## Consulte também
<a name="API_CreateDatasetImportJob_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateDatasetImportJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateDatasetImportJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateDatasetImportJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateDatasetImportJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateDatasetImportJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateDatasetImportJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateDatasetImportJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateDatasetImportJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateDatasetImportJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateDatasetImportJob) 

# CreateEventTracker
<a name="API_CreateEventTracker"></a>

Cria um rastreador de eventos que você usa ao adicionar dados de eventos a um grupo de conjuntos de dados especificado usando a [PutEvents](https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html)API.

**nota**  
Somente um rastreador de eventos pode ser associado a um grupo de conjuntos de dados. Você receberá um erro se chamar `CreateEventTracker` usando o mesmo grupo de conjuntos de dados de um rastreador de eventos existente.

Quando você cria um rastreador de eventos, a resposta inclui uma ID de acompanhamento, que você passa como parâmetro ao usar a [PutEvents](https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html)operação. Depois, o Amazon Personalize anexará os dados de eventos ao conjunto de dados de interações com itens do grupo de conjuntos de dados que você especificar no rastreador de eventos. 

O rastreador de eventos pode estar em um dos seguintes estados:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS

Para obter o status do rastreador de eventos, ligue [DescribeEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html).

**nota**  
O rastreador de eventos deve estar no estado ATIVO antes de usar o ID de rastreamento.

**Relacionado APIs**
+  [ListEventTrackers](https://docs.aws.amazon.com/personalize/latest/dg/API_ListEventTrackers.html) 
+  [DescribeEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html) 
+  [DeleteEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteEventTracker.html) 

## Sintaxe da solicitação
<a name="API_CreateEventTracker_RequestSyntax"></a>

```
{
   "datasetGroupArn": "string",
   "name": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

## Parâmetros da solicitação
<a name="API_CreateEventTracker_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetGroupArn](#API_CreateEventTracker_RequestSyntax) **   <a name="personalize-CreateEventTracker-request-datasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados que recebe os dados de eventos.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [name](#API_CreateEventTracker_RequestSyntax) **   <a name="personalize-CreateEventTracker-request-name"></a>
O nome do rastreador de eventos.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Sim

 ** [tags](#API_CreateEventTracker_RequestSyntax) **   <a name="personalize-CreateEventTracker-request-tags"></a>
Uma lista de [tags](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) a serem aplicadas ao rastreador de eventos.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

## Sintaxe da resposta
<a name="API_CreateEventTracker_ResponseSyntax"></a>

```
{
   "eventTrackerArn": "string",
   "trackingId": "string"
}
```

## Elementos de resposta
<a name="API_CreateEventTracker_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [eventTrackerArn](#API_CreateEventTracker_ResponseSyntax) **   <a name="personalize-CreateEventTracker-response-eventTrackerArn"></a>
O ARN do rastreador de eventos.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

 ** [trackingId](#API_CreateEventTracker_ResponseSyntax) **   <a name="personalize-CreateEventTracker-response-trackingId"></a>
O ID do rastreador de eventos. Inclua esse ID nas solicitações para a [PutEvents](https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html)API.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.

## Erros
<a name="API_CreateEventTracker_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** LimitExceededException **   
O limite de número de solicitações por segundo foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
O recurso especificado já existe.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de status HTTP: 400

 ** TooManyTagsException **   
Você excedeu o número máximo de tags que pode aplicar a esse recurso.   
Código de Status HTTP: 400

## Consulte também
<a name="API_CreateEventTracker_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateEventTracker) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateEventTracker) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateEventTracker) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateEventTracker) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateEventTracker) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateEventTracker) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateEventTracker) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateEventTracker) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateEventTracker) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateEventTracker) 

# CreateFilter
<a name="API_CreateFilter"></a>

Cria um filtro de recomendação. Para obter mais informações, consulte [Filtrar recomendações e segmentos de usuários](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).

## Sintaxe da solicitação
<a name="API_CreateFilter_RequestSyntax"></a>

```
{
   "datasetGroupArn": "string",
   "filterExpression": "string",
   "name": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

## Parâmetros da solicitação
<a name="API_CreateFilter_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetGroupArn](#API_CreateFilter_RequestSyntax) **   <a name="personalize-CreateFilter-request-datasetGroupArn"></a>
O ARN do grupo do conjunto de dados ao qual o filtro pertence.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [filterExpression](#API_CreateFilter_RequestSyntax) **   <a name="personalize-CreateFilter-request-filterExpression"></a>
A expressão do filtro define quais itens são incluídos ou excluídos das recomendações. A expressão do filtro deve seguir regras de formato específicas. Para obter informações sobre estrutura e sintaxe de expressões de filtro, consulte [Expressões do filtro](https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html).  
Tipo: string  
Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 2.500.  
Obrigatório: Sim

 ** [name](#API_CreateFilter_RequestSyntax) **   <a name="personalize-CreateFilter-request-name"></a>
O nome do filtro a ser criado.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Sim

 ** [tags](#API_CreateFilter_RequestSyntax) **   <a name="personalize-CreateFilter-request-tags"></a>
Uma lista de [tags](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) para aplicar ao filtro.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

## Sintaxe da resposta
<a name="API_CreateFilter_ResponseSyntax"></a>

```
{
   "filterArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateFilter_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [filterArn](#API_CreateFilter_ResponseSyntax) **   <a name="personalize-CreateFilter-response-filterArn"></a>
O ARN do novo filtro.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## Erros
<a name="API_CreateFilter_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** LimitExceededException **   
O limite de número de solicitações por segundo foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
O recurso especificado já existe.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de status HTTP: 400

 ** TooManyTagsException **   
Você excedeu o número máximo de tags que pode aplicar a esse recurso.   
Código de Status HTTP: 400

## Consulte também
<a name="API_CreateFilter_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateFilter) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateFilter) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateFilter) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateFilter) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateFilter) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateFilter) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateFilter) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateFilter) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateFilter) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateFilter) 

# CreateMetricAttribution
<a name="API_CreateMetricAttribution"></a>

Cria uma atribuição métrica. Uma atribuição métrica cria relatórios sobre os dados que você importa para o Amazon Personalize. Dependendo de como você importou os dados, você pode visualizar relatórios na Amazon CloudWatch ou no Amazon S3. Para obter mais informações, consulte [Como medir o impacto das recomendações](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html).

## Sintaxe da solicitação
<a name="API_CreateMetricAttribution_RequestSyntax"></a>

```
{
   "datasetGroupArn": "string",
   "metrics": [ 
      { 
         "eventType": "string",
         "expression": "string",
         "metricName": "string"
      }
   ],
   "metricsOutputConfig": { 
      "roleArn": "string",
      "s3DataDestination": { 
         "kmsKeyArn": "string",
         "path": "string"
      }
   },
   "name": "string"
}
```

## Parâmetros da solicitação
<a name="API_CreateMetricAttribution_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetGroupArn](#API_CreateMetricAttribution_RequestSyntax) **   <a name="personalize-CreateMetricAttribution-request-datasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do grupo de conjuntos de dados de destino da atribuição de métrica.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [metrics](#API_CreateMetricAttribution_RequestSyntax) **   <a name="personalize-CreateMetricAttribution-request-metrics"></a>
Uma lista de atributos de métrica para a atribuição de métrica. Cada atributo de métrica especifica um tipo de evento a ser monitorado e uma função. As funções disponíveis são `SUM()` ou `SAMPLECOUNT()`. Para as funções SUM(), forneça o tipo de conjunto de dados (Interações ou Itens) e a coluna a ser somada como parâmetro. Por exemplo, SUM(Items.PRICE).  
Tipo: matriz de objetos [MetricAttribute](API_MetricAttribute.md)  
Membros da matriz: número máximo de 10 itens.  
Obrigatório: Sim

 ** [metricsOutputConfig](#API_CreateMetricAttribution_RequestSyntax) **   <a name="personalize-CreateMetricAttribution-request-metricsOutputConfig"></a>
Os detalhes da configuração de saída para a atribuição de métrica.  
Tipo: objeto [MetricAttributionOutput](API_MetricAttributionOutput.md)  
Obrigatório: Sim

 ** [name](#API_CreateMetricAttribution_RequestSyntax) **   <a name="personalize-CreateMetricAttribution-request-name"></a>
Um nome para a atribuição de métrica.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_CreateMetricAttribution_ResponseSyntax"></a>

```
{
   "metricAttributionArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateMetricAttribution_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [metricAttributionArn](#API_CreateMetricAttribution_ResponseSyntax) **   <a name="personalize-CreateMetricAttribution-response-metricAttributionArn"></a>
O nome do recurso da Amazon (ARN) da nova atribuição de métrica.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## Erros
<a name="API_CreateMetricAttribution_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** LimitExceededException **   
O limite de número de solicitações por segundo foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
O recurso especificado já existe.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_CreateMetricAttribution_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateMetricAttribution) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateMetricAttribution) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateMetricAttribution) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateMetricAttribution) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateMetricAttribution) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateMetricAttribution) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateMetricAttribution) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateMetricAttribution) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateMetricAttribution) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateMetricAttribution) 

# CreateRecommender
<a name="API_CreateRecommender"></a>

Cria um recomendador com a fórmula (um caso de uso de grupo de conjunto de dados de domínio) que você especificar. Você cria recomendadores para um grupo de conjuntos de dados de domínio e especifica o Amazon Resource Name (ARN) do recomendador ao fazer uma solicitação. [GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) 

 **Mínimo de solicitações de recomendação por segundo** 

**Importante**  
Uma `minRecommendationRequestsPerSecond` alta aumentará sua conta. Recomendamos começar com 1 para `minRecommendationRequestsPerSecond` (o padrão). Monitore seu uso usando CloudWatch as métricas da Amazon e aumente as `minRecommendationRequestsPerSecond` conforme necessário.

Ao criar um recomendador, você pode configurar as solicitações mínimas de recomendação do recomendador por segundo. As solicitações mínimas de recomendação por segundo (`minRecommendationRequestsPerSecond`) especificam o throughput da solicitação de recomendação da linha de base provisionada pelo Amazon Personalize. O padrão minRecommendationRequests PerSecond é`1`. Uma solicitação de recomendação é uma operação `GetRecommendations` única. O throughput de solicitações é medido em solicitações por segundo, e o Amazon Personalize usa suas solicitações por segundo para derivar suas solicitações por hora e o preço do uso do seu recomendador. 

 Se as suas solicitações por segundo aumentarem além de `minRecommendationRequestsPerSecond`, o Amazon Personalize fará o ajuste de escala automático da capacidade provisionada para cima ou para baixo, mas nunca abaixo de `minRecommendationRequestsPerSecond`. Há um pequeno atraso no aumento da capacidade, o que pode causar perda de solicitações.

 Sua fatura é a maior entre as solicitações mínimas por hora (com base em minRecommendationRequestsPerSecond) ou o número real de solicitações. A taxa de transferência real da solicitação usada é calculada como a média requests/second dentro de uma janela de uma hora. Recomendamos começar com o padrão`minRecommendationRequestsPerSecond`, rastrear seu uso usando CloudWatch as métricas da Amazon e, em seguida, aumentá-las `minRecommendationRequestsPerSecond` conforme necessário. 

 **Status** 

Um recomendador pode estar em um dos seguintes estados:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ STOP PENDING > STOP IN\$1PROGRESS > INACTIVE > START PENDING > START IN\$1PROGRESS > ACTIVE
+ DELETE PENDING > DELETE IN\$1PROGRESS

Para obter o status de recomendador, ligue [DescribeRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html).

**nota**  
Aguarde até que o `status` do recomendador seja `ACTIVE` antes de pedir recomendações ao recomendador.

**Relacionado APIs**
+  [ListRecommenders](https://docs.aws.amazon.com/personalize/latest/dg/API_ListRecommenders.html) 
+  [DescribeRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html) 
+  [UpdateRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateRecommender.html) 
+  [DeleteRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteRecommender.html) 

## Sintaxe da solicitação
<a name="API_CreateRecommender_RequestSyntax"></a>

```
{
   "datasetGroupArn": "string",
   "name": "string",
   "recipeArn": "string",
   "recommenderConfig": { 
      "enableMetadataWithRecommendations": boolean,
      "itemExplorationConfig": { 
         "string" : "string" 
      },
      "minRecommendationRequestsPerSecond": number,
      "trainingDataConfig": { 
         "excludedDatasetColumns": { 
            "string" : [ "string" ]
         },
         "includedDatasetColumns": { 
            "string" : [ "string" ]
         }
      }
   },
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

## Parâmetros da solicitação
<a name="API_CreateRecommender_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetGroupArn](#API_CreateRecommender_RequestSyntax) **   <a name="personalize-CreateRecommender-request-datasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do grupo de conjuntos de dados de domínio de destino para o recomendador.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [name](#API_CreateRecommender_RequestSyntax) **   <a name="personalize-CreateRecommender-request-name"></a>
O nome do recomendador.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Sim

 ** [recipeArn](#API_CreateRecommender_RequestSyntax) **   <a name="personalize-CreateRecommender-request-recipeArn"></a>
O nome do recurso da Amazon (ARN) da fórmula que o recomendador usará. Para um recomendador, uma fórmula é um caso de uso de grupo de conjuntos de dados do domínio. Somente casos de uso de grupo de conjuntos de dados de domínio podem ser usados para criar um recomendador. Para obter informações sobre casos de uso, consulte [Como escolher casos de uso de recomendadores](https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html).   
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [recommenderConfig](#API_CreateRecommender_RequestSyntax) **   <a name="personalize-CreateRecommender-request-recommenderConfig"></a>
Os detalhes de configuração do recomendador.  
Tipo: objeto [RecommenderConfig](API_RecommenderConfig.md)  
Obrigatório: não

 ** [tags](#API_CreateRecommender_RequestSyntax) **   <a name="personalize-CreateRecommender-request-tags"></a>
Uma lista de [tags](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) para aplicar ao recomendador.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

## Sintaxe da resposta
<a name="API_CreateRecommender_ResponseSyntax"></a>

```
{
   "recommenderArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateRecommender_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [recommenderArn](#API_CreateRecommender_ResponseSyntax) **   <a name="personalize-CreateRecommender-response-recommenderArn"></a>
O nome do recurso da Amazon (ARN) do recomendador.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## Erros
<a name="API_CreateRecommender_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** LimitExceededException **   
O limite de número de solicitações por segundo foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
O recurso especificado já existe.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de status HTTP: 400

 ** TooManyTagsException **   
Você excedeu o número máximo de tags que pode aplicar a esse recurso.   
Código de Status HTTP: 400

## Consulte também
<a name="API_CreateRecommender_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateRecommender) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateRecommender) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateRecommender) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateRecommender) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateRecommender) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateRecommender) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateRecommender) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateRecommender) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateRecommender) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateRecommender) 

# CreateSchema
<a name="API_CreateSchema"></a>

Cria um esquema do Amazon Personalize com base na string de esquema especificada. O esquema criado deve estar no formato Avro JSON.

O Amazon Personalize reconhece três variantes de esquema. Cada esquema é associado a um tipo de conjunto de dados e tem um conjunto de campos e palavras-chave necessários. Se estiver criando um esquema para um conjunto de dados em um grupo de conjuntos de dados de Domínio, forneça o domínio desse grupo. Você especifica um esquema ao ligar [CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html).

Para saber mais sobre esquemas, consulte [Conjuntos de dados e esquemas](https://docs.aws.amazon.com/personalize/latest/dg/how-it-works-dataset-schema.html).

**Relacionado APIs**
+  [ListSchemas](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSchemas.html) 
+  [DescribeSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html) 
+  [DeleteSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSchema.html) 

## Sintaxe da solicitação
<a name="API_CreateSchema_RequestSyntax"></a>

```
{
   "domain": "string",
   "name": "string",
   "schema": "string"
}
```

## Parâmetros da solicitação
<a name="API_CreateSchema_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [domain](#API_CreateSchema_RequestSyntax) **   <a name="personalize-CreateSchema-request-domain"></a>
O domínio do esquema. Se estiver criando um esquema para um conjunto de dados em um grupo de conjuntos de dados de domínio, especifique o domínio que escolheu quando criou o grupo de conjuntos de dados de domínio.  
Tipo: string  
Valores válidos: `ECOMMERCE | VIDEO_ON_DEMAND`   
Obrigatório: não

 ** [name](#API_CreateSchema_RequestSyntax) **   <a name="personalize-CreateSchema-request-name"></a>
O nome do esquema.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Sim

 ** [schema](#API_CreateSchema_RequestSyntax) **   <a name="personalize-CreateSchema-request-schema"></a>
Um esquema no formato Avro JSON.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 20 mil.  
Obrigatório: sim

## Sintaxe da resposta
<a name="API_CreateSchema_ResponseSyntax"></a>

```
{
   "schemaArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateSchema_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [schemaArn](#API_CreateSchema_ResponseSyntax) **   <a name="personalize-CreateSchema-response-schemaArn"></a>
O nome do recurso da Amazon (ARN) do esquema criado.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## Erros
<a name="API_CreateSchema_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** LimitExceededException **   
O limite de número de solicitações por segundo foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
O recurso especificado já existe.  
Código de Status HTTP: 400

## Consulte também
<a name="API_CreateSchema_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateSchema) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateSchema) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateSchema) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateSchema) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateSchema) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateSchema) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateSchema) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateSchema) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateSchema) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateSchema) 

# CreateSolution
<a name="API_CreateSolution"></a>

**Importante**  
Por padrão, todas as novas soluções usam o treinamento automático. Com o treinamento automático, você acumula custos de treinamento enquanto sua solução está ativa. Ao terminar, você poderá [atualizar a solução](https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateSolution.html) para desativar o treinamento automático e evitar custos desnecessários. Para obter mais informações sobre os custos dos treinamentos, consulte [Preços do Amazon Personalize](https://aws.amazon.com/personalize/pricing/).

Cria a configuração para treinar um modelo (criando uma versão da solução). Essa configuração inclui a fórmula a ser usada para o treinamento de modelos e configuração de treinamento opcional, como colunas a serem usadas em parâmetros de treinamento e transformação de recursos. Para obter mais informações sobre como configurar uma solução, consulte [Criar e configurar uma solução](https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html). 

 Por padrão, as novas soluções usam o treinamento automático para criar versões da solução a cada 7 dias. Você pode alterar a frequência do treinamento. A criação da versão da solução começa dentro de uma hora após a solução se tornar ativa. Se você criar manualmente uma versão da solução dentro desse período, ela pulará o primeiro treinamento automático. Para obter mais informações, consulte [Configurar o treinamento automático](https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html).

 Para desativar o treinamento automático, defina `performAutoTraining` como false. Se você desativar o treinamento automático, deverá criar manualmente uma versão da solução chamando a [CreateSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html)operação.

Após o início do treinamento, você pode obter o Amazon Resource Name (ARN) da versão da solução com a operação da [ListSolutionVersions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html)API. Para obter seu status, use [DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html)o. 

Após a conclusão do treinamento, você pode avaliar a precisão do modelo ligando para [GetSolutionMetrics](https://docs.aws.amazon.com/personalize/latest/dg/API_GetSolutionMetrics.html). Quando estiver satisfeito com a versão da solução, você a implanta usando [CreateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html). A campanha fornece recomendações a um cliente por meio da [GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html)API.

**nota**  
O Amazon Personalize não oferece suporte à configuração de `hpoObjective` para otimização de hiperparâmetros no momento.

 **Status** 

Uma solução pode estar em um dos seguintes estados:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS

Para obter o status da solução, ligue [DescribeSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html). Se você usa o treinamento manual, ele deve estar ativo antes de você chamar `CreateSolutionVersion`.

**Relacionado APIs**
+  [UpdateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateSolution.html) 
+  [ListSolutions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html) 
+  [CreateSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html) 
+  [DescribeSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html) 
+  [DeleteSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html) 
+  [ListSolutionVersions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html) 
+  [DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html) 

## Sintaxe da solicitação
<a name="API_CreateSolution_RequestSyntax"></a>

```
{
   "datasetGroupArn": "string",
   "eventType": "string",
   "name": "string",
   "performAutoML": boolean,
   "performAutoTraining": boolean,
   "performHPO": boolean,
   "performIncrementalUpdate": boolean,
   "recipeArn": "string",
   "solutionConfig": { 
      "algorithmHyperParameters": { 
         "string" : "string" 
      },
      "autoMLConfig": { 
         "metricName": "string",
         "recipeList": [ "string" ]
      },
      "autoTrainingConfig": { 
         "schedulingExpression": "string"
      },
      "eventsConfig": { 
         "eventParametersList": [ 
            { 
               "eventType": "string",
               "eventValueThreshold": number,
               "weight": number
            }
         ]
      },
      "eventValueThreshold": "string",
      "featureTransformationParameters": { 
         "string" : "string" 
      },
      "hpoConfig": { 
         "algorithmHyperParameterRanges": { 
            "categoricalHyperParameterRanges": [ 
               { 
                  "name": "string",
                  "values": [ "string" ]
               }
            ],
            "continuousHyperParameterRanges": [ 
               { 
                  "maxValue": number,
                  "minValue": number,
                  "name": "string"
               }
            ],
            "integerHyperParameterRanges": [ 
               { 
                  "maxValue": number,
                  "minValue": number,
                  "name": "string"
               }
            ]
         },
         "hpoObjective": { 
            "metricName": "string",
            "metricRegex": "string",
            "type": "string"
         },
         "hpoResourceConfig": { 
            "maxNumberOfTrainingJobs": "string",
            "maxParallelTrainingJobs": "string"
         }
      },
      "optimizationObjective": { 
         "itemAttribute": "string",
         "objectiveSensitivity": "string"
      },
      "trainingDataConfig": { 
         "excludedDatasetColumns": { 
            "string" : [ "string" ]
         },
         "includedDatasetColumns": { 
            "string" : [ "string" ]
         }
      }
   },
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

## Parâmetros da solicitação
<a name="API_CreateSolution_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetGroupArn](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-datasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do grupo de conjuntos de dados que fornece os dados de treinamento.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [eventType](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-eventType"></a>
Quando você tem vários tipos de eventos (usando um campo de esquema `EVENT_TYPE`), esse parâmetro especifica qual tipo de evento (por exemplo, "clique" ou "curtida") é usado para treinar o modelo.  
Se você não fornecer um `eventType`, o Amazon Personalize usará todas as interações para treinamento com o mesmo peso, independentemente do tipo.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: não

 ** [name](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-name"></a>
O nome da solução.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Sim

 ** [performAutoML](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-performAutoML"></a>
Não recomendamos a habilitação do machine learning automatizado. Em vez disso, faça a correspondência entre o caso de uso e as fórmulas do Amazon Personalize disponíveis. Para obter mais informações, consulte [Escolher uma fórmula](https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html).
Se será realizado machine learning automatizado (AutoML). O padrão é `false`. Para esse caso, você deve especificar `recipeArn`.  
Quando definido como `true`, o Amazon Personalize analisa seus dados de treinamento e seleciona a fórmula e os hiperparâmetros de USER\$1PERSONALIZATION ideais. Neste caso, você deve omitir `recipeArn`. O Amazon Personalize determina a fórmula ideal executando testes com valores diferentes para os hiperparâmetros. O AutoML prolonga o processo de treinamento em comparação com a seleção de uma fórmula específica.  
Tipo: booliano  
Obrigatório: não

 ** [performAutoTraining](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-performAutoTraining"></a>
Se a solução usa treinamento automático para criar novas versões da solução (modelos treinados). O padrão é `True` e a solução cria automaticamente uma versão a cada 7 dias. Você pode alterar a frequência do treinamento especificando a `AutoTrainingConfig` como parte da configuração da solução `schedulingExpression`. Para obter mais informações sobre o treinamento automático, consulte [Configurar o treinamento automático](https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html).  
 A criação da versão da solução começa dentro de uma hora após a solução se tornar ativa. Se você criar manualmente uma versão da solução dentro desse período, ela pulará o primeiro treinamento automático.   
 Após o início do treinamento, você pode obter o Amazon Resource Name (ARN) da versão da solução com a operação da [ListSolutionVersions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html)API. Para obter seu status, use [DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html)o.   
Tipo: booliano  
Obrigatório: não

 ** [performHPO](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-performHPO"></a>
Se a otimização de hiperparâmetros (HPO) deve ou não ser realizada na fórmula especificada ou selecionada. O padrão é `false`.  
Ao executar o AutoML, esse parâmetro é sempre `true`, e você não deve defini-lo como `false`.  
Tipo: booliano  
Obrigatório: não

 ** [performIncrementalUpdate](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-performIncrementalUpdate"></a>
Se você deve realizar atualizações incrementais de treinamento em seu modelo. Quando ativado, isso permite que o modelo aprenda com novos dados com mais frequência sem exigir um novo treinamento completo, o que permite uma personalização quase em tempo real. Esse parâmetro é suportado somente para soluções que usam a receita de similaridade semântica.  
Tipo: booliano  
Obrigatório: não

 ** [recipeArn](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-recipeArn"></a>
O nome do recurso da Amazon (ARN) da fórmula a ser usada no treinamento do modelo. Isso é necessário quando `performAutoML` é falso. Para obter informações sobre as diferentes receitas do Amazon Personalize e suas ARNs, consulte Como [escolher uma](https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html) receita.   
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [solutionConfig](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-solutionConfig"></a>
As propriedades de configuração da solução. Quando `performAutoML` é definido como verdadeiro, o Amazon Personalize avalia somente a seção `autoMLConfig` da configuração da solução.  
O Amazon Personalize não oferece suporte à configuração do `hpoObjective` no momento.
Tipo: objeto [SolutionConfig](API_SolutionConfig.md)  
Obrigatório: não

 ** [tags](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-tags"></a>
Uma lista de [tags](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) para aplicar à solução.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

## Sintaxe da resposta
<a name="API_CreateSolution_ResponseSyntax"></a>

```
{
   "solutionArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateSolution_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [solutionArn](#API_CreateSolution_ResponseSyntax) **   <a name="personalize-CreateSolution-response-solutionArn"></a>
O ARN da solução.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## Erros
<a name="API_CreateSolution_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** LimitExceededException **   
O limite de número de solicitações por segundo foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
O recurso especificado já existe.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de status HTTP: 400

 ** TooManyTagsException **   
Você excedeu o número máximo de tags que pode aplicar a esse recurso.   
Código de Status HTTP: 400

## Consulte também
<a name="API_CreateSolution_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateSolution) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateSolution) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateSolution) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateSolution) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateSolution) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateSolution) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateSolution) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateSolution) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateSolution) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateSolution) 

# CreateSolutionVersion
<a name="API_CreateSolutionVersion"></a>

Treina ou treina novamente uma solução ativa em um grupo de conjuntos de dados personalizados. Uma solução é criada usando a [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)operação e deve estar no estado ATIVO antes da chamada`CreateSolutionVersion`. Uma nova versão da solução é criada sempre que você chama essa operação.

 **Status** 

Uma versão da solução pode estar em um dos seguintes estados:
+ CREATE PENDING
+ CREATE IN\$1PROGRESS
+ ACTIVE
+ CREATE FAILED
+ CREATE STOPPING
+ CREATE STOPPED

Para obter o status da versão, ligue [DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html). Espere até que o status apareça como ATIVO antes de chamar `CreateCampaign`.

Se o status for exibido como CREATE FAILED, a resposta incluirá uma chave `failureReason` que descreve por que o trabalho falhou.

**Relacionado APIs**
+  [ListSolutionVersions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html) 
+  [DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html) 
+  [ListSolutions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html) 
+  [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) 
+  [DescribeSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html) 
+  [DeleteSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html) 

## Sintaxe da solicitação
<a name="API_CreateSolutionVersion_RequestSyntax"></a>

```
{
   "name": "string",
   "solutionArn": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ],
   "trainingMode": "string"
}
```

## Parâmetros da solicitação
<a name="API_CreateSolutionVersion_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [name](#API_CreateSolutionVersion_RequestSyntax) **   <a name="personalize-CreateSolutionVersion-request-name"></a>
O nome da versão da solução.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: não

 ** [solutionArn](#API_CreateSolutionVersion_RequestSyntax) **   <a name="personalize-CreateSolutionVersion-request-solutionArn"></a>
O nome do recurso da Amazon (ARN) da solução que contém as informações de configuração do treinamento.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [tags](#API_CreateSolutionVersion_RequestSyntax) **   <a name="personalize-CreateSolutionVersion-request-tags"></a>
Uma lista de [tags](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) para aplicar à versão da solução.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

 ** [trainingMode](#API_CreateSolutionVersion_RequestSyntax) **   <a name="personalize-CreateSolutionVersion-request-trainingMode"></a>
O escopo do treinamento a ser realizado ao criar uma versão da solução. O padrão é `FULL`. Isso cria um modelo completamente novo com base na totalidade dos dados de treinamento dos conjuntos de dados em seu grupo de conjuntos de dados.   
Se você usar [User-Personalization](https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html), poderá especificar um modo de treinamento de `UPDATE`. Isso atualiza o modelo para considerar novos itens para recomendações. Não é uma reciclagem completa. Você ainda deve concluir uma reciclagem completa semanalmente. Se você especificar `UPDATE`, o Amazon Personalize interromperá as atualizações automáticas da versão da solução. Para retomar as atualizações, crie uma nova solução com o modo de treinamento definido como `FULL` e implante-a em uma campanha. Para obter informações sobre as atualizações automáticas, consulte [Atualizações automáticas](https://docs.aws.amazon.com/personalize/latest/dg/use-case-recipe-features.html#maintaining-with-automatic-updates).   
A opção `UPDATE` só pode ser usada quando você já tem uma versão ativa da solução criada a partir da solução de entrada usando a opção `FULL`, e a solução de entrada foi treinada com a fórmula [User-Personalization](https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html) ou a fórmula [HRNN-Coldstart](https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html).  
Tipo: string  
Valores válidos: `FULL | UPDATE | AUTOTRAIN`   
Obrigatório: não

## Sintaxe da resposta
<a name="API_CreateSolutionVersion_ResponseSyntax"></a>

```
{
   "solutionVersionArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateSolutionVersion_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [solutionVersionArn](#API_CreateSolutionVersion_ResponseSyntax) **   <a name="personalize-CreateSolutionVersion-response-solutionVersionArn"></a>
O ARN da nova versão da solução.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## Erros
<a name="API_CreateSolutionVersion_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** LimitExceededException **   
O limite de número de solicitações por segundo foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
O recurso especificado já existe.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de status HTTP: 400

 ** TooManyTagsException **   
Você excedeu o número máximo de tags que pode aplicar a esse recurso.   
Código de Status HTTP: 400

## Consulte também
<a name="API_CreateSolutionVersion_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateSolutionVersion) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateSolutionVersion) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateSolutionVersion) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateSolutionVersion) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateSolutionVersion) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateSolutionVersion) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateSolutionVersion) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateSolutionVersion) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateSolutionVersion) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateSolutionVersion) 

# DeleteCampaign
<a name="API_DeleteCampaign"></a>

Remove uma campanha excluindo a implantação da solução. A solução na qual a campanha se baseia não é excluída e pode ser reimplantada quando necessário. Uma campanha excluída não pode mais ser especificada em uma [GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html)solicitação. Para obter informações sobre a criação de campanhas, consulte [CreateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html).

## Sintaxe da solicitação
<a name="API_DeleteCampaign_RequestSyntax"></a>

```
{
   "campaignArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DeleteCampaign_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [campaignArn](#API_DeleteCampaign_RequestSyntax) **   <a name="personalize-DeleteCampaign-request-campaignArn"></a>
O nome do recurso da Amazon (ARN) da campanha a ser excluída.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Elementos de resposta
<a name="API_DeleteCampaign_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_DeleteCampaign_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DeleteCampaign_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteCampaign) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteCampaign) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteCampaign) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteCampaign) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteCampaign) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteCampaign) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteCampaign) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteCampaign) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteCampaign) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DeleteCampaign) 

# DeleteDataset
<a name="API_DeleteDataset"></a>

Exclui um conjunto de dados. Você não pode excluir um conjunto de dados se ele estiver associado a `DatasetImportJob` ou `SolutionVersion` estiver no estado CREATE PENDING ou IN PROGRESS. Para obter mais informações sobre como excluir conjuntos de dados, consulte [Excluir um conjunto de dados](https://docs.aws.amazon.com/personalize/latest/dg/delete-dataset.html). 

## Sintaxe da solicitação
<a name="API_DeleteDataset_RequestSyntax"></a>

```
{
   "datasetArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DeleteDataset_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetArn](#API_DeleteDataset_RequestSyntax) **   <a name="personalize-DeleteDataset-request-datasetArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados a ser excluído.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Elementos de resposta
<a name="API_DeleteDataset_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_DeleteDataset_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DeleteDataset_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteDataset) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteDataset) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteDataset) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteDataset) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteDataset) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteDataset) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteDataset) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteDataset) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteDataset) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DeleteDataset) 

# DeleteDatasetGroup
<a name="API_DeleteDatasetGroup"></a>

Exclui um grupo de conjuntos de dados. Antes de excluir um grupo de conjuntos de dados, você deve excluir o seguinte:
+ Todos os rastreadores de eventos associados.
+ Todas as soluções associadas.
+ Todos os conjuntos de dados no grupo de conjuntos de dados.

## Sintaxe da solicitação
<a name="API_DeleteDatasetGroup_RequestSyntax"></a>

```
{
   "datasetGroupArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DeleteDatasetGroup_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetGroupArn](#API_DeleteDatasetGroup_RequestSyntax) **   <a name="personalize-DeleteDatasetGroup-request-datasetGroupArn"></a>
O ARN do grupo de conjuntos de dados a ser excluído.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Elementos de resposta
<a name="API_DeleteDatasetGroup_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_DeleteDatasetGroup_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DeleteDatasetGroup_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteDatasetGroup) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteDatasetGroup) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteDatasetGroup) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteDatasetGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteDatasetGroup) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteDatasetGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteDatasetGroup) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteDatasetGroup) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteDatasetGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DeleteDatasetGroup) 

# DeleteEventTracker
<a name="API_DeleteEventTracker"></a>

Exclui o rastreador de eventos. Não exclui o conjunto de dados do grupo de conjuntos de dados. Para obter mais informações sobre rastreadores de eventos, consulte. [CreateEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html)

## Sintaxe da solicitação
<a name="API_DeleteEventTracker_RequestSyntax"></a>

```
{
   "eventTrackerArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DeleteEventTracker_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [eventTrackerArn](#API_DeleteEventTracker_RequestSyntax) **   <a name="personalize-DeleteEventTracker-request-eventTrackerArn"></a>
O nome do recurso da Amazon (ARN) do rastreador de eventos a ser excluído.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Elementos de resposta
<a name="API_DeleteEventTracker_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_DeleteEventTracker_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DeleteEventTracker_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteEventTracker) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteEventTracker) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteEventTracker) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteEventTracker) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteEventTracker) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteEventTracker) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteEventTracker) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteEventTracker) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteEventTracker) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DeleteEventTracker) 

# DeleteFilter
<a name="API_DeleteFilter"></a>

Exclui um filtro.

## Sintaxe da solicitação
<a name="API_DeleteFilter_RequestSyntax"></a>

```
{
   "filterArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DeleteFilter_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [filterArn](#API_DeleteFilter_RequestSyntax) **   <a name="personalize-DeleteFilter-request-filterArn"></a>
O ARN do filtro a ser excluído.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Elementos de resposta
<a name="API_DeleteFilter_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_DeleteFilter_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DeleteFilter_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteFilter) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteFilter) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteFilter) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteFilter) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteFilter) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteFilter) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteFilter) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteFilter) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteFilter) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DeleteFilter) 

# DeleteMetricAttribution
<a name="API_DeleteMetricAttribution"></a>

Exclui a atribuição de uma métrica.

## Sintaxe da solicitação
<a name="API_DeleteMetricAttribution_RequestSyntax"></a>

```
{
   "metricAttributionArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DeleteMetricAttribution_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [metricAttributionArn](#API_DeleteMetricAttribution_RequestSyntax) **   <a name="personalize-DeleteMetricAttribution-request-metricAttributionArn"></a>
O nome do recurso da Amazon (ARN) da atribuição da métrica.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Elementos de resposta
<a name="API_DeleteMetricAttribution_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_DeleteMetricAttribution_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DeleteMetricAttribution_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteMetricAttribution) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteMetricAttribution) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteMetricAttribution) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteMetricAttribution) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteMetricAttribution) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteMetricAttribution) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteMetricAttribution) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteMetricAttribution) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteMetricAttribution) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DeleteMetricAttribution) 

# DeleteRecommender
<a name="API_DeleteRecommender"></a>

Desativa e remove um recomendador. Um recomendador excluído não pode mais ser especificado em uma [GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html)solicitação.

## Sintaxe da solicitação
<a name="API_DeleteRecommender_RequestSyntax"></a>

```
{
   "recommenderArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DeleteRecommender_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [recommenderArn](#API_DeleteRecommender_RequestSyntax) **   <a name="personalize-DeleteRecommender-request-recommenderArn"></a>
O nome do recurso da Amazon (ARN) do recomendador a ser excluído.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Elementos de resposta
<a name="API_DeleteRecommender_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_DeleteRecommender_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DeleteRecommender_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteRecommender) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteRecommender) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteRecommender) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteRecommender) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteRecommender) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteRecommender) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteRecommender) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteRecommender) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteRecommender) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DeleteRecommender) 

# DeleteSchema
<a name="API_DeleteSchema"></a>

Exclui um esquema. Antes de excluir um esquema, você deve excluir todos os conjuntos de dados que fazem referência ao esquema. Para obter mais informações sobre esquemas, consulte [CreateSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html).

## Sintaxe da solicitação
<a name="API_DeleteSchema_RequestSyntax"></a>

```
{
   "schemaArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DeleteSchema_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [schemaArn](#API_DeleteSchema_RequestSyntax) **   <a name="personalize-DeleteSchema-request-schemaArn"></a>
O nome do recurso da Amazon (ARN) do esquema a ser excluído.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Elementos de resposta
<a name="API_DeleteSchema_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_DeleteSchema_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DeleteSchema_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteSchema) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteSchema) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteSchema) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteSchema) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteSchema) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteSchema) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteSchema) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteSchema) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteSchema) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DeleteSchema) 

# DeleteSolution
<a name="API_DeleteSolution"></a>

Exclui todas as versões de uma solução e o próprio objeto `Solution`. Antes de excluir uma solução, você deve excluir todas as campanhas com base na solução. Para determinar quais campanhas estão usando a solução, ligue [ListCampaigns](https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html)e forneça o Amazon Resource Name (ARN) da solução. Você não pode excluir uma solução se um `SolutionVersion` associado estiver no estado CREATE PENDING ou IN PROGRESS. Para obter mais informações sobre soluções, consulte [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html).

## Sintaxe da solicitação
<a name="API_DeleteSolution_RequestSyntax"></a>

```
{
   "solutionArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DeleteSolution_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [solutionArn](#API_DeleteSolution_RequestSyntax) **   <a name="personalize-DeleteSolution-request-solutionArn"></a>
O ARN da solução a ser excluída.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Elementos de resposta
<a name="API_DeleteSolution_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_DeleteSolution_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DeleteSolution_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteSolution) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteSolution) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteSolution) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteSolution) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteSolution) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteSolution) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteSolution) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteSolution) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteSolution) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DeleteSolution) 

# DescribeAlgorithm
<a name="API_DescribeAlgorithm"></a>

Descreve o algoritmo fornecido.

## Sintaxe da solicitação
<a name="API_DescribeAlgorithm_RequestSyntax"></a>

```
{
   "algorithmArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DescribeAlgorithm_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [algorithmArn](#API_DescribeAlgorithm_RequestSyntax) **   <a name="personalize-DescribeAlgorithm-request-algorithmArn"></a>
O nome do recurso da Amazon (ARN) do algoritmo a ser descrito.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_DescribeAlgorithm_ResponseSyntax"></a>

```
{
   "algorithm": { 
      "algorithmArn": "string",
      "algorithmImage": { 
         "dockerURI": "string",
         "name": "string"
      },
      "creationDateTime": number,
      "defaultHyperParameterRanges": { 
         "categoricalHyperParameterRanges": [ 
            { 
               "isTunable": boolean,
               "name": "string",
               "values": [ "string" ]
            }
         ],
         "continuousHyperParameterRanges": [ 
            { 
               "isTunable": boolean,
               "maxValue": number,
               "minValue": number,
               "name": "string"
            }
         ],
         "integerHyperParameterRanges": [ 
            { 
               "isTunable": boolean,
               "maxValue": number,
               "minValue": number,
               "name": "string"
            }
         ]
      },
      "defaultHyperParameters": { 
         "string" : "string" 
      },
      "defaultResourceConfig": { 
         "string" : "string" 
      },
      "lastUpdatedDateTime": number,
      "name": "string",
      "roleArn": "string",
      "trainingInputMode": "string"
   }
}
```

## Elementos de resposta
<a name="API_DescribeAlgorithm_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [algorithm](#API_DescribeAlgorithm_ResponseSyntax) **   <a name="personalize-DescribeAlgorithm-response-algorithm"></a>
Uma lista das propriedades do algoritmo.  
Tipo: objeto [Algorithm](API_Algorithm.md)

## Erros
<a name="API_DescribeAlgorithm_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DescribeAlgorithm_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeAlgorithm) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeAlgorithm) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeAlgorithm) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeAlgorithm) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeAlgorithm) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeAlgorithm) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeAlgorithm) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeAlgorithm) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeAlgorithm) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeAlgorithm) 

# DescribeBatchInferenceJob
<a name="API_DescribeBatchInferenceJob"></a>

Obtém as propriedades de um trabalho de inferência em lote, incluindo nome, nome do recurso da Amazon (ARN), status, configurações de entrada e saída e o ARN da versão da solução usada para gerar as recomendações.

## Sintaxe da solicitação
<a name="API_DescribeBatchInferenceJob_RequestSyntax"></a>

```
{
   "batchInferenceJobArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DescribeBatchInferenceJob_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [batchInferenceJobArn](#API_DescribeBatchInferenceJob_RequestSyntax) **   <a name="personalize-DescribeBatchInferenceJob-request-batchInferenceJobArn"></a>
O ARN do trabalho de inferência em lote a ser descrito.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_DescribeBatchInferenceJob_ResponseSyntax"></a>

```
{
   "batchInferenceJob": { 
      "batchInferenceJobArn": "string",
      "batchInferenceJobConfig": { 
         "itemExplorationConfig": { 
            "string" : "string" 
         },
         "rankingInfluence": { 
            "string" : number 
         }
      },
      "batchInferenceJobMode": "string",
      "creationDateTime": number,
      "failureReason": "string",
      "filterArn": "string",
      "jobInput": { 
         "s3DataSource": { 
            "kmsKeyArn": "string",
            "path": "string"
         }
      },
      "jobName": "string",
      "jobOutput": { 
         "s3DataDestination": { 
            "kmsKeyArn": "string",
            "path": "string"
         }
      },
      "lastUpdatedDateTime": number,
      "numResults": number,
      "roleArn": "string",
      "solutionVersionArn": "string",
      "status": "string",
      "themeGenerationConfig": { 
         "fieldsForThemeGeneration": { 
            "itemName": "string"
         }
      }
   }
}
```

## Elementos de resposta
<a name="API_DescribeBatchInferenceJob_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [batchInferenceJob](#API_DescribeBatchInferenceJob_ResponseSyntax) **   <a name="personalize-DescribeBatchInferenceJob-response-batchInferenceJob"></a>
Informações sobre o trabalho de inferência em lote especificado.  
Tipo: objeto [BatchInferenceJob](API_BatchInferenceJob.md)

## Erros
<a name="API_DescribeBatchInferenceJob_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DescribeBatchInferenceJob_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeBatchInferenceJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeBatchInferenceJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeBatchInferenceJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeBatchInferenceJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeBatchInferenceJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeBatchInferenceJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeBatchInferenceJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeBatchInferenceJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeBatchInferenceJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeBatchInferenceJob) 

# DescribeBatchSegmentJob
<a name="API_DescribeBatchSegmentJob"></a>

Obtém as propriedades de um trabalho de segmento em lote, incluindo nome, nome do recurso da Amazon (ARN), status, configurações de entrada e saída e o ARN da versão da solução usada para gerar os segmentos.

## Sintaxe da solicitação
<a name="API_DescribeBatchSegmentJob_RequestSyntax"></a>

```
{
   "batchSegmentJobArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DescribeBatchSegmentJob_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [batchSegmentJobArn](#API_DescribeBatchSegmentJob_RequestSyntax) **   <a name="personalize-DescribeBatchSegmentJob-request-batchSegmentJobArn"></a>
O ARN do trabalho do segmento em lote a ser descrito.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_DescribeBatchSegmentJob_ResponseSyntax"></a>

```
{
   "batchSegmentJob": { 
      "batchSegmentJobArn": "string",
      "creationDateTime": number,
      "failureReason": "string",
      "filterArn": "string",
      "jobInput": { 
         "s3DataSource": { 
            "kmsKeyArn": "string",
            "path": "string"
         }
      },
      "jobName": "string",
      "jobOutput": { 
         "s3DataDestination": { 
            "kmsKeyArn": "string",
            "path": "string"
         }
      },
      "lastUpdatedDateTime": number,
      "numResults": number,
      "roleArn": "string",
      "solutionVersionArn": "string",
      "status": "string"
   }
}
```

## Elementos de resposta
<a name="API_DescribeBatchSegmentJob_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [batchSegmentJob](#API_DescribeBatchSegmentJob_ResponseSyntax) **   <a name="personalize-DescribeBatchSegmentJob-response-batchSegmentJob"></a>
Informações sobre o trabalho de inferência em lote especificado.  
Tipo: objeto [BatchSegmentJob](API_BatchSegmentJob.md)

## Erros
<a name="API_DescribeBatchSegmentJob_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DescribeBatchSegmentJob_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeBatchSegmentJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeBatchSegmentJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeBatchSegmentJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeBatchSegmentJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeBatchSegmentJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeBatchSegmentJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeBatchSegmentJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeBatchSegmentJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeBatchSegmentJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeBatchSegmentJob) 

# DescribeCampaign
<a name="API_DescribeCampaign"></a>

Descreve a campanha em questão, incluindo seu status.

Uma campanha pode estar em um dos seguintes estados:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS

Quando o `status` é`CREATE FAILED`, a resposta inclui a `failureReason` chave, que descreve o motivo.

Para obter mais informações sobre campanhas, consulte [CreateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html).

## Sintaxe da solicitação
<a name="API_DescribeCampaign_RequestSyntax"></a>

```
{
   "campaignArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DescribeCampaign_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [campaignArn](#API_DescribeCampaign_RequestSyntax) **   <a name="personalize-DescribeCampaign-request-campaignArn"></a>
O nome do recurso da Amazon (ARN) da campanha.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_DescribeCampaign_ResponseSyntax"></a>

```
{
   "campaign": { 
      "campaignArn": "string",
      "campaignConfig": { 
         "enableMetadataWithRecommendations": boolean,
         "itemExplorationConfig": { 
            "string" : "string" 
         },
         "rankingInfluence": { 
            "string" : number 
         },
         "syncWithLatestSolutionVersion": boolean
      },
      "creationDateTime": number,
      "failureReason": "string",
      "lastUpdatedDateTime": number,
      "latestCampaignUpdate": { 
         "campaignConfig": { 
            "enableMetadataWithRecommendations": boolean,
            "itemExplorationConfig": { 
               "string" : "string" 
            },
            "rankingInfluence": { 
               "string" : number 
            },
            "syncWithLatestSolutionVersion": boolean
         },
         "creationDateTime": number,
         "failureReason": "string",
         "lastUpdatedDateTime": number,
         "minProvisionedTPS": number,
         "solutionVersionArn": "string",
         "status": "string"
      },
      "minProvisionedTPS": number,
      "name": "string",
      "solutionVersionArn": "string",
      "status": "string"
   }
}
```

## Elementos de resposta
<a name="API_DescribeCampaign_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [campaign](#API_DescribeCampaign_ResponseSyntax) **   <a name="personalize-DescribeCampaign-response-campaign"></a>
O campo `latestCampaignUpdate` só é retornado quando a campanha teve pelo menos uma chamada `UpdateCampaign`. 
As propriedades da campanha.  
O campo `latestCampaignUpdate` só é retornado quando a campanha teve pelo menos uma chamada `UpdateCampaign`.
Tipo: objeto [Campaign](API_Campaign.md)

## Erros
<a name="API_DescribeCampaign_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DescribeCampaign_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeCampaign) 

# DescribeDataDeletionJob
<a name="API_DescribeDataDeletionJob"></a>

Descreve o trabalho de exclusão de dados criado por [CreateDataDeletionJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataDeletionJob.html), incluindo o status do trabalho.

## Sintaxe da solicitação
<a name="API_DescribeDataDeletionJob_RequestSyntax"></a>

```
{
   "dataDeletionJobArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DescribeDataDeletionJob_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [dataDeletionJobArn](#API_DescribeDataDeletionJob_RequestSyntax) **   <a name="personalize-DescribeDataDeletionJob-request-dataDeletionJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de exclusão de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_DescribeDataDeletionJob_ResponseSyntax"></a>

```
{
   "dataDeletionJob": { 
      "creationDateTime": number,
      "dataDeletionJobArn": "string",
      "datasetGroupArn": "string",
      "dataSource": { 
         "dataLocation": "string"
      },
      "failureReason": "string",
      "jobName": "string",
      "lastUpdatedDateTime": number,
      "numDeleted": number,
      "roleArn": "string",
      "status": "string"
   }
}
```

## Elementos de resposta
<a name="API_DescribeDataDeletionJob_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [dataDeletionJob](#API_DescribeDataDeletionJob_ResponseSyntax) **   <a name="personalize-DescribeDataDeletionJob-response-dataDeletionJob"></a>
Informações sobre o trabalho de exclusão de dados, incluindo o status.  
O status tem um dos valores a seguir:  
+ PENDING
+ IN\$1PROGRESS
+ CONCLUÍDO
+ FAILED
Tipo: objeto [DataDeletionJob](API_DataDeletionJob.md)

## Erros
<a name="API_DescribeDataDeletionJob_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DescribeDataDeletionJob_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeDataDeletionJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeDataDeletionJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeDataDeletionJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeDataDeletionJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDataDeletionJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeDataDeletionJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeDataDeletionJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDataDeletionJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeDataDeletionJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeDataDeletionJob) 

# DescribeDataset
<a name="API_DescribeDataset"></a>

Descreve o conjunto de dados em questão. Para obter mais informações sobre conjuntos de dados, consulte [CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html).

## Sintaxe da solicitação
<a name="API_DescribeDataset_RequestSyntax"></a>

```
{
   "datasetArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DescribeDataset_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetArn](#API_DescribeDataset_RequestSyntax) **   <a name="personalize-DescribeDataset-request-datasetArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados a ser descrito.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_DescribeDataset_ResponseSyntax"></a>

```
{
   "dataset": { 
      "creationDateTime": number,
      "datasetArn": "string",
      "datasetGroupArn": "string",
      "datasetType": "string",
      "lastUpdatedDateTime": number,
      "latestDatasetUpdate": { 
         "creationDateTime": number,
         "failureReason": "string",
         "lastUpdatedDateTime": number,
         "schemaArn": "string",
         "status": "string"
      },
      "name": "string",
      "schemaArn": "string",
      "status": "string",
      "trackingId": "string"
   }
}
```

## Elementos de resposta
<a name="API_DescribeDataset_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [dataset](#API_DescribeDataset_ResponseSyntax) **   <a name="personalize-DescribeDataset-response-dataset"></a>
Uma lista das propriedades do conjunto de dados.  
Tipo: objeto [Dataset](API_Dataset.md)

## Erros
<a name="API_DescribeDataset_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DescribeDataset_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeDataset) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeDataset) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeDataset) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeDataset) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDataset) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeDataset) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeDataset) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDataset) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeDataset) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeDataset) 

# DescribeDatasetExportJob
<a name="API_DescribeDatasetExportJob"></a>

Descreve o trabalho de exportação do conjunto de dados criado por [CreateDatasetExportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html), incluindo o status do trabalho de exportação.

## Sintaxe da solicitação
<a name="API_DescribeDatasetExportJob_RequestSyntax"></a>

```
{
   "datasetExportJobArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DescribeDatasetExportJob_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetExportJobArn](#API_DescribeDatasetExportJob_RequestSyntax) **   <a name="personalize-DescribeDatasetExportJob-request-datasetExportJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de exportação do conjunto de dados a ser descrito.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_DescribeDatasetExportJob_ResponseSyntax"></a>

```
{
   "datasetExportJob": { 
      "creationDateTime": number,
      "datasetArn": "string",
      "datasetExportJobArn": "string",
      "failureReason": "string",
      "ingestionMode": "string",
      "jobName": "string",
      "jobOutput": { 
         "s3DataDestination": { 
            "kmsKeyArn": "string",
            "path": "string"
         }
      },
      "lastUpdatedDateTime": number,
      "roleArn": "string",
      "status": "string"
   }
}
```

## Elementos de resposta
<a name="API_DescribeDatasetExportJob_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [datasetExportJob](#API_DescribeDatasetExportJob_ResponseSyntax) **   <a name="personalize-DescribeDatasetExportJob-response-datasetExportJob"></a>
Informações sobre o trabalho de exportação do conjunto de dados, incluindo o status.  
O status é um dos valores a seguir:  
+ CREATE PENDING
+ CREATE IN\$1PROGRESS
+ ACTIVE
+ CREATE FAILED
Tipo: objeto [DatasetExportJob](API_DatasetExportJob.md)

## Erros
<a name="API_DescribeDatasetExportJob_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DescribeDatasetExportJob_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeDatasetExportJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeDatasetExportJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeDatasetExportJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeDatasetExportJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDatasetExportJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeDatasetExportJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeDatasetExportJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDatasetExportJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeDatasetExportJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeDatasetExportJob) 

# DescribeDatasetGroup
<a name="API_DescribeDatasetGroup"></a>

Descreve o grupo de conjuntos de dados fornecido. Para obter mais informações sobre grupos de conjuntos de dados, consulte [CreateDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html).

## Sintaxe da solicitação
<a name="API_DescribeDatasetGroup_RequestSyntax"></a>

```
{
   "datasetGroupArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DescribeDatasetGroup_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetGroupArn](#API_DescribeDatasetGroup_RequestSyntax) **   <a name="personalize-DescribeDatasetGroup-request-datasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do grupo de conjuntos de dados a ser descrito.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_DescribeDatasetGroup_ResponseSyntax"></a>

```
{
   "datasetGroup": { 
      "creationDateTime": number,
      "datasetGroupArn": "string",
      "domain": "string",
      "failureReason": "string",
      "kmsKeyArn": "string",
      "lastUpdatedDateTime": number,
      "name": "string",
      "roleArn": "string",
      "status": "string"
   }
}
```

## Elementos de resposta
<a name="API_DescribeDatasetGroup_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [datasetGroup](#API_DescribeDatasetGroup_ResponseSyntax) **   <a name="personalize-DescribeDatasetGroup-response-datasetGroup"></a>
Uma lista das propriedades do grupo de conjuntos de dados.  
Tipo: objeto [DatasetGroup](API_DatasetGroup.md)

## Erros
<a name="API_DescribeDatasetGroup_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DescribeDatasetGroup_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeDatasetGroup) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeDatasetGroup) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeDatasetGroup) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeDatasetGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDatasetGroup) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeDatasetGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeDatasetGroup) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDatasetGroup) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeDatasetGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeDatasetGroup) 

# DescribeDatasetImportJob
<a name="API_DescribeDatasetImportJob"></a>

Descreve o trabalho de importação do conjunto de dados criado por [CreateDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html), incluindo o status do trabalho de importação.

## Sintaxe da solicitação
<a name="API_DescribeDatasetImportJob_RequestSyntax"></a>

```
{
   "datasetImportJobArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DescribeDatasetImportJob_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetImportJobArn](#API_DescribeDatasetImportJob_RequestSyntax) **   <a name="personalize-DescribeDatasetImportJob-request-datasetImportJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de importação do conjunto de dados a ser descrito.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_DescribeDatasetImportJob_ResponseSyntax"></a>

```
{
   "datasetImportJob": { 
      "creationDateTime": number,
      "datasetArn": "string",
      "datasetImportJobArn": "string",
      "dataSource": { 
         "dataLocation": "string"
      },
      "failureReason": "string",
      "importMode": "string",
      "jobName": "string",
      "lastUpdatedDateTime": number,
      "publishAttributionMetricsToS3": boolean,
      "roleArn": "string",
      "status": "string"
   }
}
```

## Elementos de resposta
<a name="API_DescribeDatasetImportJob_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [datasetImportJob](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="personalize-DescribeDatasetImportJob-response-datasetImportJob"></a>
Informações sobre o trabalho de importação do conjunto de dados, incluindo o status.  
O status é um dos valores a seguir:  
+ CREATE PENDING
+ CREATE IN\$1PROGRESS
+ ACTIVE
+ CREATE FAILED
Tipo: objeto [DatasetImportJob](API_DatasetImportJob.md)

## Erros
<a name="API_DescribeDatasetImportJob_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DescribeDatasetImportJob_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeDatasetImportJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeDatasetImportJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeDatasetImportJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeDatasetImportJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDatasetImportJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeDatasetImportJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeDatasetImportJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDatasetImportJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeDatasetImportJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeDatasetImportJob) 

# DescribeEventTracker
<a name="API_DescribeEventTracker"></a>

Descreve um rastreador de eventos. A resposta inclui o `trackingId` e o `status` do rastreador de eventos. Para obter mais informações sobre rastreadores de eventos, consulte. [CreateEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html)

## Sintaxe da solicitação
<a name="API_DescribeEventTracker_RequestSyntax"></a>

```
{
   "eventTrackerArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DescribeEventTracker_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [eventTrackerArn](#API_DescribeEventTracker_RequestSyntax) **   <a name="personalize-DescribeEventTracker-request-eventTrackerArn"></a>
O nome do recurso da Amazon (ARN) do rastreador de eventos a ser descrito.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_DescribeEventTracker_ResponseSyntax"></a>

```
{
   "eventTracker": { 
      "accountId": "string",
      "creationDateTime": number,
      "datasetGroupArn": "string",
      "eventTrackerArn": "string",
      "lastUpdatedDateTime": number,
      "name": "string",
      "status": "string",
      "trackingId": "string"
   }
}
```

## Elementos de resposta
<a name="API_DescribeEventTracker_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [eventTracker](#API_DescribeEventTracker_ResponseSyntax) **   <a name="personalize-DescribeEventTracker-response-eventTracker"></a>
Um objeto que descreve o rastreador de eventos.  
Tipo: objeto [EventTracker](API_EventTracker.md)

## Erros
<a name="API_DescribeEventTracker_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DescribeEventTracker_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeEventTracker) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeEventTracker) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeEventTracker) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeEventTracker) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeEventTracker) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeEventTracker) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeEventTracker) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeEventTracker) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeEventTracker) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeEventTracker) 

# DescribeFeatureTransformation
<a name="API_DescribeFeatureTransformation"></a>

Descreve a transformação de um determinado atributo.

## Sintaxe da solicitação
<a name="API_DescribeFeatureTransformation_RequestSyntax"></a>

```
{
   "featureTransformationArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DescribeFeatureTransformation_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [featureTransformationArn](#API_DescribeFeatureTransformation_RequestSyntax) **   <a name="personalize-DescribeFeatureTransformation-request-featureTransformationArn"></a>
O nome do recurso da Amazon (ARN) da transformação do atributo a ser descrito.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_DescribeFeatureTransformation_ResponseSyntax"></a>

```
{
   "featureTransformation": { 
      "creationDateTime": number,
      "defaultParameters": { 
         "string" : "string" 
      },
      "featureTransformationArn": "string",
      "lastUpdatedDateTime": number,
      "name": "string",
      "status": "string"
   }
}
```

## Elementos de resposta
<a name="API_DescribeFeatureTransformation_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [featureTransformation](#API_DescribeFeatureTransformation_ResponseSyntax) **   <a name="personalize-DescribeFeatureTransformation-response-featureTransformation"></a>
Uma lista das FeatureTransformation propriedades.  
Tipo: objeto [FeatureTransformation](API_FeatureTransformation.md)

## Erros
<a name="API_DescribeFeatureTransformation_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DescribeFeatureTransformation_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeFeatureTransformation) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeFeatureTransformation) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeFeatureTransformation) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeFeatureTransformation) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeFeatureTransformation) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeFeatureTransformation) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeFeatureTransformation) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeFeatureTransformation) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeFeatureTransformation) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeFeatureTransformation) 

# DescribeFilter
<a name="API_DescribeFilter"></a>

Descreve as propriedades de um filtro.

## Sintaxe da solicitação
<a name="API_DescribeFilter_RequestSyntax"></a>

```
{
   "filterArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DescribeFilter_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [filterArn](#API_DescribeFilter_RequestSyntax) **   <a name="personalize-DescribeFilter-request-filterArn"></a>
O ARN da coisa a ser descrita.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_DescribeFilter_ResponseSyntax"></a>

```
{
   "filter": { 
      "creationDateTime": number,
      "datasetGroupArn": "string",
      "failureReason": "string",
      "filterArn": "string",
      "filterExpression": "string",
      "lastUpdatedDateTime": number,
      "name": "string",
      "status": "string"
   }
}
```

## Elementos de resposta
<a name="API_DescribeFilter_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [filter](#API_DescribeFilter_ResponseSyntax) **   <a name="personalize-DescribeFilter-response-filter"></a>
Os detalhes do filtro.  
Tipo: objeto [Filter](API_Filter.md)

## Erros
<a name="API_DescribeFilter_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DescribeFilter_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeFilter) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeFilter) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeFilter) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeFilter) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeFilter) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeFilter) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeFilter) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeFilter) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeFilter) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeFilter) 

# DescribeMetricAttribution
<a name="API_DescribeMetricAttribution"></a>

Descreve uma atribuição métrica.

## Sintaxe da solicitação
<a name="API_DescribeMetricAttribution_RequestSyntax"></a>

```
{
   "metricAttributionArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DescribeMetricAttribution_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [metricAttributionArn](#API_DescribeMetricAttribution_RequestSyntax) **   <a name="personalize-DescribeMetricAttribution-request-metricAttributionArn"></a>
O nome do recurso da Amazon (ARN) da atribuição da métrica.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_DescribeMetricAttribution_ResponseSyntax"></a>

```
{
   "metricAttribution": { 
      "creationDateTime": number,
      "datasetGroupArn": "string",
      "failureReason": "string",
      "lastUpdatedDateTime": number,
      "metricAttributionArn": "string",
      "metricsOutputConfig": { 
         "roleArn": "string",
         "s3DataDestination": { 
            "kmsKeyArn": "string",
            "path": "string"
         }
      },
      "name": "string",
      "status": "string"
   }
}
```

## Elementos de resposta
<a name="API_DescribeMetricAttribution_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [metricAttribution](#API_DescribeMetricAttribution_ResponseSyntax) **   <a name="personalize-DescribeMetricAttribution-response-metricAttribution"></a>
Os detalhes da atribuição métrica.  
Tipo: objeto [MetricAttribution](API_MetricAttribution.md)

## Erros
<a name="API_DescribeMetricAttribution_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DescribeMetricAttribution_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeMetricAttribution) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeMetricAttribution) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeMetricAttribution) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeMetricAttribution) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeMetricAttribution) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeMetricAttribution) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeMetricAttribution) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeMetricAttribution) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeMetricAttribution) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeMetricAttribution) 

# DescribeRecipe
<a name="API_DescribeRecipe"></a>

Descreve uma fórmula.

Uma fórmula contém três itens:
+ Um algoritmo que treina um modelo.
+ Hiperparâmetros que governam o treinamento.
+ Informações de transformação de atributo para modificar os dados de entrada antes do treinamento.

O Amazon Personalize fornece um conjunto de fórmulas predefinidas. Você especifica uma receita ao criar uma solução com a [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)API. `CreateSolution`treina um modelo usando o algoritmo na receita especificada e um conjunto de dados de treinamento. A solução, quando implantada como uma campanha, pode fornecer recomendações usando a [GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html)API.

## Sintaxe da solicitação
<a name="API_DescribeRecipe_RequestSyntax"></a>

```
{
   "recipeArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DescribeRecipe_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [recipeArn](#API_DescribeRecipe_RequestSyntax) **   <a name="personalize-DescribeRecipe-request-recipeArn"></a>
O nome do recurso da Amazon (ARN) da fórmula de imagem.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_DescribeRecipe_ResponseSyntax"></a>

```
{
   "recipe": { 
      "algorithmArn": "string",
      "creationDateTime": number,
      "description": "string",
      "featureTransformationArn": "string",
      "lastUpdatedDateTime": number,
      "name": "string",
      "recipeArn": "string",
      "recipeType": "string",
      "status": "string"
   }
}
```

## Elementos de resposta
<a name="API_DescribeRecipe_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [recipe](#API_DescribeRecipe_ResponseSyntax) **   <a name="personalize-DescribeRecipe-response-recipe"></a>
Um objeto que descreve a fórmula.  
Tipo: objeto [Recipe](API_Recipe.md)

## Erros
<a name="API_DescribeRecipe_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DescribeRecipe_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeRecipe) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeRecipe) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeRecipe) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeRecipe) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeRecipe) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeRecipe) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeRecipe) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeRecipe) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeRecipe) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeRecipe) 

# DescribeRecommender
<a name="API_DescribeRecommender"></a>

Descreve o recomendador fornecido, incluindo seu status.

Um recomendador pode estar em um dos seguintes estados:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ STOP PENDING > STOP IN\$1PROGRESS > INACTIVE > START PENDING > START IN\$1PROGRESS > ACTIVE
+ DELETE PENDING > DELETE IN\$1PROGRESS

Quando o `status` é`CREATE FAILED`, a resposta inclui a `failureReason` chave, que descreve o motivo.

A `modelMetrics` chave é nula quando o recomendador está sendo criado ou excluído.

Para obter mais informações sobre recomendadores, consulte. [CreateRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html)

## Sintaxe da solicitação
<a name="API_DescribeRecommender_RequestSyntax"></a>

```
{
   "recommenderArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DescribeRecommender_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [recommenderArn](#API_DescribeRecommender_RequestSyntax) **   <a name="personalize-DescribeRecommender-request-recommenderArn"></a>
O nome do recurso da Amazon (ARN) da regra do nome do recurso da Amazon.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_DescribeRecommender_ResponseSyntax"></a>

```
{
   "recommender": { 
      "creationDateTime": number,
      "datasetGroupArn": "string",
      "failureReason": "string",
      "lastUpdatedDateTime": number,
      "latestRecommenderUpdate": { 
         "creationDateTime": number,
         "failureReason": "string",
         "lastUpdatedDateTime": number,
         "recommenderConfig": { 
            "enableMetadataWithRecommendations": boolean,
            "itemExplorationConfig": { 
               "string" : "string" 
            },
            "minRecommendationRequestsPerSecond": number,
            "trainingDataConfig": { 
               "excludedDatasetColumns": { 
                  "string" : [ "string" ]
               },
               "includedDatasetColumns": { 
                  "string" : [ "string" ]
               }
            }
         },
         "status": "string"
      },
      "modelMetrics": { 
         "string" : number 
      },
      "name": "string",
      "recipeArn": "string",
      "recommenderArn": "string",
      "recommenderConfig": { 
         "enableMetadataWithRecommendations": boolean,
         "itemExplorationConfig": { 
            "string" : "string" 
         },
         "minRecommendationRequestsPerSecond": number,
         "trainingDataConfig": { 
            "excludedDatasetColumns": { 
               "string" : [ "string" ]
            },
            "includedDatasetColumns": { 
               "string" : [ "string" ]
            }
         }
      },
      "status": "string"
   }
}
```

## Elementos de resposta
<a name="API_DescribeRecommender_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [recommender](#API_DescribeRecommender_ResponseSyntax) **   <a name="personalize-DescribeRecommender-response-recommender"></a>
As propriedades do recomendador.  
Tipo: objeto [Recommender](API_Recommender.md)

## Erros
<a name="API_DescribeRecommender_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DescribeRecommender_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeRecommender) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeRecommender) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeRecommender) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeRecommender) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeRecommender) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeRecommender) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeRecommender) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeRecommender) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeRecommender) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeRecommender) 

# DescribeSchema
<a name="API_DescribeSchema"></a>

Descreve um esquema. Para obter mais informações sobre esquemas, consulte [CreateSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html).

## Sintaxe da solicitação
<a name="API_DescribeSchema_RequestSyntax"></a>

```
{
   "schemaArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DescribeSchema_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [schemaArn](#API_DescribeSchema_RequestSyntax) **   <a name="personalize-DescribeSchema-request-schemaArn"></a>
O nome do recurso da Amazon (ARN) do esquema.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_DescribeSchema_ResponseSyntax"></a>

```
{
   "schema": { 
      "creationDateTime": number,
      "domain": "string",
      "lastUpdatedDateTime": number,
      "name": "string",
      "schema": "string",
      "schemaArn": "string"
   }
}
```

## Elementos de resposta
<a name="API_DescribeSchema_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [schema](#API_DescribeSchema_ResponseSyntax) **   <a name="personalize-DescribeSchema-response-schema"></a>
O esquema solicitado.  
Tipo: objeto [DatasetSchema](API_DatasetSchema.md)

## Erros
<a name="API_DescribeSchema_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DescribeSchema_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeSchema) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeSchema) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeSchema) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeSchema) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeSchema) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeSchema) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeSchema) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeSchema) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeSchema) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeSchema) 

# DescribeSolution
<a name="API_DescribeSolution"></a>

Descreve uma solução. Para obter mais informações sobre soluções, consulte [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html).

## Sintaxe da solicitação
<a name="API_DescribeSolution_RequestSyntax"></a>

```
{
   "solutionArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DescribeSolution_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [solutionArn](#API_DescribeSolution_RequestSyntax) **   <a name="personalize-DescribeSolution-request-solutionArn"></a>
O nome do recurso da Amazon (ARN) da solução a ser implantada.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_DescribeSolution_ResponseSyntax"></a>

```
{
   "solution": { 
      "autoMLResult": { 
         "bestRecipeArn": "string"
      },
      "creationDateTime": number,
      "datasetGroupArn": "string",
      "eventType": "string",
      "lastUpdatedDateTime": number,
      "latestSolutionUpdate": { 
         "creationDateTime": number,
         "failureReason": "string",
         "lastUpdatedDateTime": number,
         "performAutoTraining": boolean,
         "performIncrementalUpdate": boolean,
         "solutionUpdateConfig": { 
            "autoTrainingConfig": { 
               "schedulingExpression": "string"
            },
            "eventsConfig": { 
               "eventParametersList": [ 
                  { 
                     "eventType": "string",
                     "eventValueThreshold": number,
                     "weight": number
                  }
               ]
            }
         },
         "status": "string"
      },
      "latestSolutionVersion": { 
         "creationDateTime": number,
         "failureReason": "string",
         "lastUpdatedDateTime": number,
         "solutionVersionArn": "string",
         "status": "string",
         "trainingMode": "string",
         "trainingType": "string"
      },
      "name": "string",
      "performAutoML": boolean,
      "performAutoTraining": boolean,
      "performHPO": boolean,
      "performIncrementalUpdate": boolean,
      "recipeArn": "string",
      "solutionArn": "string",
      "solutionConfig": { 
         "algorithmHyperParameters": { 
            "string" : "string" 
         },
         "autoMLConfig": { 
            "metricName": "string",
            "recipeList": [ "string" ]
         },
         "autoTrainingConfig": { 
            "schedulingExpression": "string"
         },
         "eventsConfig": { 
            "eventParametersList": [ 
               { 
                  "eventType": "string",
                  "eventValueThreshold": number,
                  "weight": number
               }
            ]
         },
         "eventValueThreshold": "string",
         "featureTransformationParameters": { 
            "string" : "string" 
         },
         "hpoConfig": { 
            "algorithmHyperParameterRanges": { 
               "categoricalHyperParameterRanges": [ 
                  { 
                     "name": "string",
                     "values": [ "string" ]
                  }
               ],
               "continuousHyperParameterRanges": [ 
                  { 
                     "maxValue": number,
                     "minValue": number,
                     "name": "string"
                  }
               ],
               "integerHyperParameterRanges": [ 
                  { 
                     "maxValue": number,
                     "minValue": number,
                     "name": "string"
                  }
               ]
            },
            "hpoObjective": { 
               "metricName": "string",
               "metricRegex": "string",
               "type": "string"
            },
            "hpoResourceConfig": { 
               "maxNumberOfTrainingJobs": "string",
               "maxParallelTrainingJobs": "string"
            }
         },
         "optimizationObjective": { 
            "itemAttribute": "string",
            "objectiveSensitivity": "string"
         },
         "trainingDataConfig": { 
            "excludedDatasetColumns": { 
               "string" : [ "string" ]
            },
            "includedDatasetColumns": { 
               "string" : [ "string" ]
            }
         }
      },
      "status": "string"
   }
}
```

## Elementos de resposta
<a name="API_DescribeSolution_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [solution](#API_DescribeSolution_ResponseSyntax) **   <a name="personalize-DescribeSolution-response-solution"></a>
Um objeto que descreve a solução.  
Tipo: objeto [Solution](API_Solution.md)

## Erros
<a name="API_DescribeSolution_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DescribeSolution_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeSolution) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeSolution) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeSolution) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeSolution) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeSolution) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeSolution) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeSolution) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeSolution) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeSolution) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeSolution) 

# DescribeSolutionVersion
<a name="API_DescribeSolutionVersion"></a>

Descreve uma versão de uma solução. Para obter mais informações sobre soluções, consulte [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) 

## Sintaxe da solicitação
<a name="API_DescribeSolutionVersion_RequestSyntax"></a>

```
{
   "solutionVersionArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DescribeSolutionVersion_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [solutionVersionArn](#API_DescribeSolutionVersion_RequestSyntax) **   <a name="personalize-DescribeSolutionVersion-request-solutionVersionArn"></a>
O nome do recurso da Amazon (ARN) da versão da solução.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_DescribeSolutionVersion_ResponseSyntax"></a>

```
{
   "solutionVersion": { 
      "creationDateTime": number,
      "datasetGroupArn": "string",
      "eventType": "string",
      "failureReason": "string",
      "lastUpdatedDateTime": number,
      "name": "string",
      "performAutoML": boolean,
      "performHPO": boolean,
      "performIncrementalUpdate": boolean,
      "recipeArn": "string",
      "solutionArn": "string",
      "solutionConfig": { 
         "algorithmHyperParameters": { 
            "string" : "string" 
         },
         "autoMLConfig": { 
            "metricName": "string",
            "recipeList": [ "string" ]
         },
         "autoTrainingConfig": { 
            "schedulingExpression": "string"
         },
         "eventsConfig": { 
            "eventParametersList": [ 
               { 
                  "eventType": "string",
                  "eventValueThreshold": number,
                  "weight": number
               }
            ]
         },
         "eventValueThreshold": "string",
         "featureTransformationParameters": { 
            "string" : "string" 
         },
         "hpoConfig": { 
            "algorithmHyperParameterRanges": { 
               "categoricalHyperParameterRanges": [ 
                  { 
                     "name": "string",
                     "values": [ "string" ]
                  }
               ],
               "continuousHyperParameterRanges": [ 
                  { 
                     "maxValue": number,
                     "minValue": number,
                     "name": "string"
                  }
               ],
               "integerHyperParameterRanges": [ 
                  { 
                     "maxValue": number,
                     "minValue": number,
                     "name": "string"
                  }
               ]
            },
            "hpoObjective": { 
               "metricName": "string",
               "metricRegex": "string",
               "type": "string"
            },
            "hpoResourceConfig": { 
               "maxNumberOfTrainingJobs": "string",
               "maxParallelTrainingJobs": "string"
            }
         },
         "optimizationObjective": { 
            "itemAttribute": "string",
            "objectiveSensitivity": "string"
         },
         "trainingDataConfig": { 
            "excludedDatasetColumns": { 
               "string" : [ "string" ]
            },
            "includedDatasetColumns": { 
               "string" : [ "string" ]
            }
         }
      },
      "solutionVersionArn": "string",
      "status": "string",
      "trainingHours": number,
      "trainingMode": "string",
      "trainingType": "string",
      "tunedHPOParams": { 
         "algorithmHyperParameters": { 
            "string" : "string" 
         }
      }
   }
}
```

## Elementos de resposta
<a name="API_DescribeSolutionVersion_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [solutionVersion](#API_DescribeSolutionVersion_ResponseSyntax) **   <a name="personalize-DescribeSolutionVersion-response-solutionVersion"></a>
A versão da solução.  
Tipo: objeto [SolutionVersion](API_SolutionVersion.md)

## Erros
<a name="API_DescribeSolutionVersion_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DescribeSolutionVersion_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeSolutionVersion) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeSolutionVersion) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeSolutionVersion) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeSolutionVersion) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeSolutionVersion) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeSolutionVersion) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeSolutionVersion) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeSolutionVersion) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeSolutionVersion) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeSolutionVersion) 

# GetSolutionMetrics
<a name="API_GetSolutionMetrics"></a>

Obtém as métricas para a versão da solução especificada.

## Sintaxe da solicitação
<a name="API_GetSolutionMetrics_RequestSyntax"></a>

```
{
   "solutionVersionArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_GetSolutionMetrics_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [solutionVersionArn](#API_GetSolutionMetrics_RequestSyntax) **   <a name="personalize-GetSolutionMetrics-request-solutionVersionArn"></a>
O nome do recurso da Amazon (ARN) da versão da solução a ser implantada.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_GetSolutionMetrics_ResponseSyntax"></a>

```
{
   "metrics": { 
      "string" : number 
   },
   "solutionVersionArn": "string"
}
```

## Elementos de resposta
<a name="API_GetSolutionMetrics_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [metrics](#API_GetSolutionMetrics_ResponseSyntax) **   <a name="personalize-GetSolutionMetrics-response-metrics"></a>
Obtém métricas para uma versão da solução. Para obter mais informações, consulte [Avaliação de uma versão da solução com métricas](https://docs.aws.amazon.com/personalize/latest/dg/working-with-training-metrics.html).  
Tipo: mapa de string para double  
Entradas do mapa: número máximo de 100 itens.  
Restrições de tamanhos de chave: tamanho máximo de 256.

 ** [solutionVersionArn](#API_GetSolutionMetrics_ResponseSyntax) **   <a name="personalize-GetSolutionMetrics-response-solutionVersionArn"></a>
O mesmo ARN da versão da solução especificada na solicitação.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## Erros
<a name="API_GetSolutionMetrics_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_GetSolutionMetrics_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/GetSolutionMetrics) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/GetSolutionMetrics) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/GetSolutionMetrics) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/GetSolutionMetrics) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/GetSolutionMetrics) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/GetSolutionMetrics) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/GetSolutionMetrics) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/GetSolutionMetrics) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/GetSolutionMetrics) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/GetSolutionMetrics) 

# ListBatchInferenceJobs
<a name="API_ListBatchInferenceJobs"></a>

Obtém uma lista dos trabalhos de inferência em lote que foram executados a partir de uma versão da solução.

## Sintaxe da solicitação
<a name="API_ListBatchInferenceJobs_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string",
   "solutionVersionArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_ListBatchInferenceJobs_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [maxResults](#API_ListBatchInferenceJobs_RequestSyntax) **   <a name="personalize-ListBatchInferenceJobs-request-maxResults"></a>
O número máximo de resultados do trabalho de inferência em lote a serem retornados em cada página. O valor padrão é 100.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [nextToken](#API_ListBatchInferenceJobs_RequestSyntax) **   <a name="personalize-ListBatchInferenceJobs-request-nextToken"></a>
O token para recuperação do próximo conjunto de resultados.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}`   
Obrigatório: não

 ** [solutionVersionArn](#API_ListBatchInferenceJobs_RequestSyntax) **   <a name="personalize-ListBatchInferenceJobs-request-solutionVersionArn"></a>
O nome do recurso da Amazon (ARN) da versão da solução da qual os trabalhos de inferência em lote foram criados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

## Sintaxe da resposta
<a name="API_ListBatchInferenceJobs_ResponseSyntax"></a>

```
{
   "batchInferenceJobs": [ 
      { 
         "batchInferenceJobArn": "string",
         "batchInferenceJobMode": "string",
         "creationDateTime": number,
         "failureReason": "string",
         "jobName": "string",
         "lastUpdatedDateTime": number,
         "solutionVersionArn": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Elementos de resposta
<a name="API_ListBatchInferenceJobs_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [batchInferenceJobs](#API_ListBatchInferenceJobs_ResponseSyntax) **   <a name="personalize-ListBatchInferenceJobs-response-batchInferenceJobs"></a>
Uma lista contendo informações sobre cada trabalho retornado.  
Tipo: matriz de objetos [BatchInferenceJobSummary](API_BatchInferenceJobSummary.md)  
Membros da matriz: número máximo de 100 itens.

 ** [nextToken](#API_ListBatchInferenceJobs_ResponseSyntax) **   <a name="personalize-ListBatchInferenceJobs-response-nextToken"></a>
O token para recuperação do próximo conjunto de resultados. O valor é `null` quando não há mais resultados a serem retornados.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}` 

## Erros
<a name="API_ListBatchInferenceJobs_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** InvalidNextTokenException **   
O token de ID não é válido.  
Código de Status HTTP: 400

## Consulte também
<a name="API_ListBatchInferenceJobs_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListBatchInferenceJobs) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListBatchInferenceJobs) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListBatchInferenceJobs) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListBatchInferenceJobs) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListBatchInferenceJobs) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListBatchInferenceJobs) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListBatchInferenceJobs) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListBatchInferenceJobs) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListBatchInferenceJobs) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListBatchInferenceJobs) 

# ListBatchSegmentJobs
<a name="API_ListBatchSegmentJobs"></a>

Obtém uma lista dos trabalhos de segmento em lote que foram executados a partir de uma versão da solução especificada por você.

## Sintaxe da solicitação
<a name="API_ListBatchSegmentJobs_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string",
   "solutionVersionArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_ListBatchSegmentJobs_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [maxResults](#API_ListBatchSegmentJobs_RequestSyntax) **   <a name="personalize-ListBatchSegmentJobs-request-maxResults"></a>
O número máximo de resultados do trabalho de segmento em lote a serem retornados em cada página. O valor padrão é 100.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [nextToken](#API_ListBatchSegmentJobs_RequestSyntax) **   <a name="personalize-ListBatchSegmentJobs-request-nextToken"></a>
O token para recuperação do próximo conjunto de resultados.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}`   
Obrigatório: não

 ** [solutionVersionArn](#API_ListBatchSegmentJobs_RequestSyntax) **   <a name="personalize-ListBatchSegmentJobs-request-solutionVersionArn"></a>
O nome do recurso da Amazon (ARN) da versão da solução que os trabalhos de segmento em lote usaram para gerar segmentos em lote.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

## Sintaxe da resposta
<a name="API_ListBatchSegmentJobs_ResponseSyntax"></a>

```
{
   "batchSegmentJobs": [ 
      { 
         "batchSegmentJobArn": "string",
         "creationDateTime": number,
         "failureReason": "string",
         "jobName": "string",
         "lastUpdatedDateTime": number,
         "solutionVersionArn": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Elementos de resposta
<a name="API_ListBatchSegmentJobs_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [batchSegmentJobs](#API_ListBatchSegmentJobs_ResponseSyntax) **   <a name="personalize-ListBatchSegmentJobs-response-batchSegmentJobs"></a>
Uma lista contendo informações sobre cada trabalho retornado.  
Tipo: matriz de objetos [BatchSegmentJobSummary](API_BatchSegmentJobSummary.md)  
Membros da matriz: número máximo de 100 itens.

 ** [nextToken](#API_ListBatchSegmentJobs_ResponseSyntax) **   <a name="personalize-ListBatchSegmentJobs-response-nextToken"></a>
O token para recuperação do próximo conjunto de resultados. O valor é `null` quando não há mais resultados a serem retornados.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}` 

## Erros
<a name="API_ListBatchSegmentJobs_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** InvalidNextTokenException **   
O token de ID não é válido.  
Código de Status HTTP: 400

## Consulte também
<a name="API_ListBatchSegmentJobs_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListBatchSegmentJobs) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListBatchSegmentJobs) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListBatchSegmentJobs) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListBatchSegmentJobs) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListBatchSegmentJobs) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListBatchSegmentJobs) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListBatchSegmentJobs) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListBatchSegmentJobs) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListBatchSegmentJobs) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListBatchSegmentJobs) 

# ListCampaigns
<a name="API_ListCampaigns"></a>

Retorna uma lista de campanhas que usam a solução fornecida. Quando uma solução não é especificada, todas as campanhas associadas à conta são listadas. A resposta fornece as propriedades para cada campanha, incluindo o nome do recurso da Amazon (ARN). Para obter mais informações sobre campanhas, consulte [CreateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html).

## Sintaxe da solicitação
<a name="API_ListCampaigns_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string",
   "solutionArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_ListCampaigns_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [maxResults](#API_ListCampaigns_RequestSyntax) **   <a name="personalize-ListCampaigns-request-maxResults"></a>
O número máximo de campanhas a serem retornadas.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [nextToken](#API_ListCampaigns_RequestSyntax) **   <a name="personalize-ListCampaigns-request-nextToken"></a>
Um token retornado da chamada anterior [ListCampaigns](https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html)para obter o próximo conjunto de campanhas (se existirem).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}`   
Obrigatório: não

 ** [solutionArn](#API_ListCampaigns_RequestSyntax) **   <a name="personalize-ListCampaigns-request-solutionArn"></a>
O nome do recurso da Amazon (ARN) da solução para a qual listar as campanhas. Quando uma solução não é especificada, todas as campanhas associadas à conta são listadas.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

## Sintaxe da resposta
<a name="API_ListCampaigns_ResponseSyntax"></a>

```
{
   "campaigns": [ 
      { 
         "campaignArn": "string",
         "creationDateTime": number,
         "failureReason": "string",
         "lastUpdatedDateTime": number,
         "name": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Elementos de resposta
<a name="API_ListCampaigns_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [campaigns](#API_ListCampaigns_ResponseSyntax) **   <a name="personalize-ListCampaigns-response-campaigns"></a>
Uma lista das campanhas.  
Tipo: matriz de objetos [CampaignSummary](API_CampaignSummary.md)  
Membros da matriz: número máximo de 100 itens.

 ** [nextToken](#API_ListCampaigns_ResponseSyntax) **   <a name="personalize-ListCampaigns-response-nextToken"></a>
Um token para obter o próximo conjunto de campanhas (se existirem).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}` 

## Erros
<a name="API_ListCampaigns_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** InvalidNextTokenException **   
O token de ID não é válido.  
Código de Status HTTP: 400

## Consulte também
<a name="API_ListCampaigns_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListCampaigns) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListCampaigns) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListCampaigns) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListCampaigns) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListCampaigns) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListCampaigns) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListCampaigns) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListCampaigns) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListCampaigns) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListCampaigns) 

# ListDataDeletionJobs
<a name="API_ListDataDeletionJobs"></a>

Retorna uma lista de trabalhos de exclusão de dados para um grupo de conjuntos de dados ordenados por horário de criação do mais recente para o mais antigo. Quando um grupo de conjuntos de dados não é especificado, todos os trabalhos de exclusão de dados associados à conta são listados. A resposta fornece as propriedades para cada trabalho, incluindo o nome do recurso da Amazon (ARN). Para obter mais informações sobre trabalhos de exclusão de dados, consulte [Excluir usuários](https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html).

## Sintaxe da solicitação
<a name="API_ListDataDeletionJobs_RequestSyntax"></a>

```
{
   "datasetGroupArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## Parâmetros da solicitação
<a name="API_ListDataDeletionJobs_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetGroupArn](#API_ListDataDeletionJobs_RequestSyntax) **   <a name="personalize-ListDataDeletionJobs-request-datasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do grupo de conjuntos de dados a ser excluído.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [maxResults](#API_ListDataDeletionJobs_RequestSyntax) **   <a name="personalize-ListDataDeletionJobs-request-maxResults"></a>
O número máximo de trabalhos de exclusão de dados a serem retornados.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [nextToken](#API_ListDataDeletionJobs_RequestSyntax) **   <a name="personalize-ListDataDeletionJobs-request-nextToken"></a>
Um token retornado da chamada anterior para `ListDataDeletionJobs` a fim de obter o próximo conjunto de trabalhos (se houver).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}`   
Obrigatório: Não

## Sintaxe da resposta
<a name="API_ListDataDeletionJobs_ResponseSyntax"></a>

```
{
   "dataDeletionJobs": [ 
      { 
         "creationDateTime": number,
         "dataDeletionJobArn": "string",
         "datasetGroupArn": "string",
         "failureReason": "string",
         "jobName": "string",
         "lastUpdatedDateTime": number,
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Elementos de resposta
<a name="API_ListDataDeletionJobs_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [dataDeletionJobs](#API_ListDataDeletionJobs_ResponseSyntax) **   <a name="personalize-ListDataDeletionJobs-response-dataDeletionJobs"></a>
A lista de trabalhos de exclusão de dados.  
Tipo: matriz de objetos [DataDeletionJobSummary](API_DataDeletionJobSummary.md)  
Membros da matriz: número máximo de 100 itens.

 ** [nextToken](#API_ListDataDeletionJobs_ResponseSyntax) **   <a name="personalize-ListDataDeletionJobs-response-nextToken"></a>
Um token para obter o próximo conjunto de trabalhos de importação de conjuntos de dados (se houver).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}` 

## Erros
<a name="API_ListDataDeletionJobs_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** InvalidNextTokenException **   
O token de ID não é válido.  
Código de Status HTTP: 400

## Consulte também
<a name="API_ListDataDeletionJobs_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListDataDeletionJobs) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListDataDeletionJobs) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListDataDeletionJobs) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListDataDeletionJobs) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListDataDeletionJobs) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListDataDeletionJobs) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListDataDeletionJobs) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListDataDeletionJobs) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListDataDeletionJobs) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListDataDeletionJobs) 

# ListDatasetExportJobs
<a name="API_ListDatasetExportJobs"></a>

Retorna uma lista de trabalhos de exportação de conjuntos de dados que usam o conjunto de dados fornecido. Quando um conjunto de dados não é especificado, todos os trabalhos de exportação do conjunto de dados associados à conta são listados. A resposta fornece as propriedades para cada trabalho de exportação do conjunto de dados, incluindo o nome do recurso da Amazon (ARN). Para obter mais informações sobre trabalhos de exportação de conjuntos de dados, consulte [CreateDatasetExportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html). Para obter mais informações sobre conjuntos de dados, consulte [CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html).

## Sintaxe da solicitação
<a name="API_ListDatasetExportJobs_RequestSyntax"></a>

```
{
   "datasetArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## Parâmetros da solicitação
<a name="API_ListDatasetExportJobs_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetArn](#API_ListDatasetExportJobs_RequestSyntax) **   <a name="personalize-ListDatasetExportJobs-request-datasetArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados para o qual listar os trabalhos de exportação do conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [maxResults](#API_ListDatasetExportJobs_RequestSyntax) **   <a name="personalize-ListDatasetExportJobs-request-maxResults"></a>
O número máximo de trabalhos de exportação de conjuntos de dados a serem retornados.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [nextToken](#API_ListDatasetExportJobs_RequestSyntax) **   <a name="personalize-ListDatasetExportJobs-request-nextToken"></a>
Um token retornado da chamada anterior `ListDatasetExportJobs` para obter o próximo conjunto de trabalhos de exportação do conjunto de dados (se existirem).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}`   
Obrigatório: Não

## Sintaxe da resposta
<a name="API_ListDatasetExportJobs_ResponseSyntax"></a>

```
{
   "datasetExportJobs": [ 
      { 
         "creationDateTime": number,
         "datasetExportJobArn": "string",
         "failureReason": "string",
         "jobName": "string",
         "lastUpdatedDateTime": number,
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Elementos de resposta
<a name="API_ListDatasetExportJobs_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [datasetExportJobs](#API_ListDatasetExportJobs_ResponseSyntax) **   <a name="personalize-ListDatasetExportJobs-response-datasetExportJobs"></a>
A lista de trabalhos de exportação de conjuntos de dados.  
Tipo: matriz de objetos [DatasetExportJobSummary](API_DatasetExportJobSummary.md)  
Membros da matriz: número máximo de 100 itens.

 ** [nextToken](#API_ListDatasetExportJobs_ResponseSyntax) **   <a name="personalize-ListDatasetExportJobs-response-nextToken"></a>
Um token para obter o próximo conjunto de trabalhos de exportação do conjunto de dados (se existirem).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}` 

## Erros
<a name="API_ListDatasetExportJobs_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** InvalidNextTokenException **   
O token de ID não é válido.  
Código de Status HTTP: 400

## Consulte também
<a name="API_ListDatasetExportJobs_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListDatasetExportJobs) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListDatasetExportJobs) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListDatasetExportJobs) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListDatasetExportJobs) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListDatasetExportJobs) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListDatasetExportJobs) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListDatasetExportJobs) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListDatasetExportJobs) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListDatasetExportJobs) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListDatasetExportJobs) 

# ListDatasetGroups
<a name="API_ListDatasetGroups"></a>

Retorna uma lista de grupos de conjuntos de dados. A resposta fornece as propriedades para cada grupo de conjuntos de dados, incluindo o nome do recurso da Amazon (ARN). Para obter mais informações sobre grupos de conjuntos de dados, consulte [CreateDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html).

## Sintaxe da solicitação
<a name="API_ListDatasetGroups_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string"
}
```

## Parâmetros da solicitação
<a name="API_ListDatasetGroups_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [maxResults](#API_ListDatasetGroups_RequestSyntax) **   <a name="personalize-ListDatasetGroups-request-maxResults"></a>
O número máximo de grupos de conjuntos de dados a serem retornados.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [nextToken](#API_ListDatasetGroups_RequestSyntax) **   <a name="personalize-ListDatasetGroups-request-nextToken"></a>
Um token retornado da chamada anterior `ListDatasetGroups` para obter o próximo conjunto de grupos de conjuntos de dados (se existirem).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}`   
Obrigatório: Não

## Sintaxe da resposta
<a name="API_ListDatasetGroups_ResponseSyntax"></a>

```
{
   "datasetGroups": [ 
      { 
         "creationDateTime": number,
         "datasetGroupArn": "string",
         "domain": "string",
         "failureReason": "string",
         "lastUpdatedDateTime": number,
         "name": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Elementos de resposta
<a name="API_ListDatasetGroups_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [datasetGroups](#API_ListDatasetGroups_ResponseSyntax) **   <a name="personalize-ListDatasetGroups-response-datasetGroups"></a>
A lista dos seus grupos de conjuntos de dados.  
Tipo: matriz de objetos [DatasetGroupSummary](API_DatasetGroupSummary.md)  
Membros da matriz: número máximo de 100 itens.

 ** [nextToken](#API_ListDatasetGroups_ResponseSyntax) **   <a name="personalize-ListDatasetGroups-response-nextToken"></a>
Um token para obter o próximo conjunto de grupos de conjuntos de dados (se existirem).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}` 

## Erros
<a name="API_ListDatasetGroups_Errors"></a>

 ** InvalidNextTokenException **   
O token de ID não é válido.  
Código de Status HTTP: 400

## Consulte também
<a name="API_ListDatasetGroups_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListDatasetGroups) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListDatasetGroups) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListDatasetGroups) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListDatasetGroups) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListDatasetGroups) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListDatasetGroups) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListDatasetGroups) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListDatasetGroups) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListDatasetGroups) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListDatasetGroups) 

# ListDatasetImportJobs
<a name="API_ListDatasetImportJobs"></a>

Retorna uma lista de trabalhos de importação de conjuntos de dados que usam o conjunto de dados fornecido. Quando um conjunto de dados não é especificado, todos os trabalhos de importação de conjuntos de dados associados à conta são listados. A resposta fornece as propriedades para cada trabalho de importação do conjunto de dados, incluindo o nome do recurso da Amazon (ARN). Para obter mais informações sobre trabalhos de importação de conjuntos de dados, consulte [CreateDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html). Para obter mais informações sobre conjuntos de dados, consulte [CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html).

## Sintaxe da solicitação
<a name="API_ListDatasetImportJobs_RequestSyntax"></a>

```
{
   "datasetArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## Parâmetros da solicitação
<a name="API_ListDatasetImportJobs_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetArn](#API_ListDatasetImportJobs_RequestSyntax) **   <a name="personalize-ListDatasetImportJobs-request-datasetArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados que recebe os dados importados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [maxResults](#API_ListDatasetImportJobs_RequestSyntax) **   <a name="personalize-ListDatasetImportJobs-request-maxResults"></a>
O número máximo de trabalhos de importação do conjunto de dados.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [nextToken](#API_ListDatasetImportJobs_RequestSyntax) **   <a name="personalize-ListDatasetImportJobs-request-nextToken"></a>
Um token retornado da chamada anterior `ListDatasetImportJobs` para obter o próximo conjunto de trabalhos de importação do conjunto de dados (se existirem).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}`   
Obrigatório: Não

## Sintaxe da resposta
<a name="API_ListDatasetImportJobs_ResponseSyntax"></a>

```
{
   "datasetImportJobs": [ 
      { 
         "creationDateTime": number,
         "datasetImportJobArn": "string",
         "failureReason": "string",
         "importMode": "string",
         "jobName": "string",
         "lastUpdatedDateTime": number,
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Elementos de resposta
<a name="API_ListDatasetImportJobs_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [datasetImportJobs](#API_ListDatasetImportJobs_ResponseSyntax) **   <a name="personalize-ListDatasetImportJobs-response-datasetImportJobs"></a>
Lista as tarefas de importação do conjunto de dados.  
Tipo: matriz de objetos [DatasetImportJobSummary](API_DatasetImportJobSummary.md)  
Membros da matriz: número máximo de 100 itens.

 ** [nextToken](#API_ListDatasetImportJobs_ResponseSyntax) **   <a name="personalize-ListDatasetImportJobs-response-nextToken"></a>
Um token para obter o próximo conjunto de trabalhos de importação de conjuntos de dados (se existirem).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}` 

## Erros
<a name="API_ListDatasetImportJobs_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** InvalidNextTokenException **   
O token de ID não é válido.  
Código de Status HTTP: 400

## Consulte também
<a name="API_ListDatasetImportJobs_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListDatasetImportJobs) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListDatasetImportJobs) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListDatasetImportJobs) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListDatasetImportJobs) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListDatasetImportJobs) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListDatasetImportJobs) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListDatasetImportJobs) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListDatasetImportJobs) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListDatasetImportJobs) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListDatasetImportJobs) 

# ListDatasets
<a name="API_ListDatasets"></a>

Retorna a lista de conjuntos de dados contidos no grupo de conjuntos de dados fornecido. A resposta fornece as propriedades para cada conjunto de dados, incluindo o nome do recurso da Amazon (ARN). Para obter mais informações sobre conjuntos de dados, consulte [CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html).

## Sintaxe da solicitação
<a name="API_ListDatasets_RequestSyntax"></a>

```
{
   "datasetGroupArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## Parâmetros da solicitação
<a name="API_ListDatasets_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetGroupArn](#API_ListDatasets_RequestSyntax) **   <a name="personalize-ListDatasets-request-datasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do grupo de conjuntos de dados que fornece os dados de treinamento.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [maxResults](#API_ListDatasets_RequestSyntax) **   <a name="personalize-ListDatasets-request-maxResults"></a>
O número máximo de conjunto de dados a serem retornados.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [nextToken](#API_ListDatasets_RequestSyntax) **   <a name="personalize-ListDatasets-request-nextToken"></a>
Um token retornado da chamada anterior `ListDatasets` para obter o próximo conjunto de trabalhos de importação do conjunto de dados (se existirem).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}`   
Obrigatório: Não

## Sintaxe da resposta
<a name="API_ListDatasets_ResponseSyntax"></a>

```
{
   "datasets": [ 
      { 
         "creationDateTime": number,
         "datasetArn": "string",
         "datasetType": "string",
         "lastUpdatedDateTime": number,
         "name": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Elementos de resposta
<a name="API_ListDatasets_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [datasets](#API_ListDatasets_ResponseSyntax) **   <a name="personalize-ListDatasets-response-datasets"></a>
Uma matriz de objetos `Dataset`. Cada objeto fornece informações de metadados.  
Tipo: matriz de objetos [DatasetSummary](API_DatasetSummary.md)  
Membros da matriz: número máximo de 100 itens.

 ** [nextToken](#API_ListDatasets_ResponseSyntax) **   <a name="personalize-ListDatasets-response-nextToken"></a>
Um token para obter o próximo conjunto de conjuntos de dados (se existirem).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}` 

## Erros
<a name="API_ListDatasets_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** InvalidNextTokenException **   
O token de ID não é válido.  
Código de Status HTTP: 400

## Consulte também
<a name="API_ListDatasets_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListDatasets) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListDatasets) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListDatasets) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListDatasets) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListDatasets) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListDatasets) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListDatasets) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListDatasets) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListDatasets) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListDatasets) 

# ListEventTrackers
<a name="API_ListEventTrackers"></a>

Retorna a lista de rastreadores de eventos associados à conta. A resposta fornece as propriedades para cada rastreador de eventos, incluindo o nome do recurso da Amazon (ARN) e o ID do rastreamento. Para obter mais informações sobre rastreadores de eventos, consulte. [CreateEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html)

## Sintaxe da solicitação
<a name="API_ListEventTrackers_RequestSyntax"></a>

```
{
   "datasetGroupArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## Parâmetros da solicitação
<a name="API_ListEventTrackers_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetGroupArn](#API_ListEventTrackers_RequestSyntax) **   <a name="personalize-ListEventTrackers-request-datasetGroupArn"></a>
O ARN de um grupo de conjuntos de dados usado para filtrar a resposta.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [maxResults](#API_ListEventTrackers_RequestSyntax) **   <a name="personalize-ListEventTrackers-request-maxResults"></a>
O número máximo de rastreadores de eventos a serem retornados.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [nextToken](#API_ListEventTrackers_RequestSyntax) **   <a name="personalize-ListEventTrackers-request-nextToken"></a>
Um token retornado da chamada anterior `ListEventTrackers` para obter o próximo conjunto de rastreadores de eventos (se existirem).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}`   
Obrigatório: Não

## Sintaxe da resposta
<a name="API_ListEventTrackers_ResponseSyntax"></a>

```
{
   "eventTrackers": [ 
      { 
         "creationDateTime": number,
         "eventTrackerArn": "string",
         "lastUpdatedDateTime": number,
         "name": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Elementos de resposta
<a name="API_ListEventTrackers_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [eventTrackers](#API_ListEventTrackers_ResponseSyntax) **   <a name="personalize-ListEventTrackers-response-eventTrackers"></a>
Uma lista de rastreadores de eventos.  
Tipo: matriz de objetos [EventTrackerSummary](API_EventTrackerSummary.md)  
Membros da matriz: número máximo de 100 itens.

 ** [nextToken](#API_ListEventTrackers_ResponseSyntax) **   <a name="personalize-ListEventTrackers-response-nextToken"></a>
Um token para obter o próximo conjunto de rastreadores de eventos (se existirem).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}` 

## Erros
<a name="API_ListEventTrackers_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** InvalidNextTokenException **   
O token de ID não é válido.  
Código de Status HTTP: 400

## Consulte também
<a name="API_ListEventTrackers_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListEventTrackers) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListEventTrackers) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListEventTrackers) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListEventTrackers) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListEventTrackers) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListEventTrackers) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListEventTrackers) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListEventTrackers) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListEventTrackers) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListEventTrackers) 

# ListFilters
<a name="API_ListFilters"></a>

Lista todos os filtros que pertencem a um determinado grupo de conjuntos de dados.

## Sintaxe da solicitação
<a name="API_ListFilters_RequestSyntax"></a>

```
{
   "datasetGroupArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## Parâmetros da solicitação
<a name="API_ListFilters_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetGroupArn](#API_ListFilters_RequestSyntax) **   <a name="personalize-ListFilters-request-datasetGroupArn"></a>
O ARN do grupo do conjunto de dados que contém os filtros.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [maxResults](#API_ListFilters_RequestSyntax) **   <a name="personalize-ListFilters-request-maxResults"></a>
O número máximo de filtros a serem retornados.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [nextToken](#API_ListFilters_RequestSyntax) **   <a name="personalize-ListFilters-request-nextToken"></a>
Um token retornado da chamada anterior `ListFilters` para obter o próximo conjunto de filtros (se existirem).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}`   
Obrigatório: Não

## Sintaxe da resposta
<a name="API_ListFilters_ResponseSyntax"></a>

```
{
   "Filters": [ 
      { 
         "creationDateTime": number,
         "datasetGroupArn": "string",
         "failureReason": "string",
         "filterArn": "string",
         "lastUpdatedDateTime": number,
         "name": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Elementos de resposta
<a name="API_ListFilters_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [Filters](#API_ListFilters_ResponseSyntax) **   <a name="personalize-ListFilters-response-Filters"></a>
Uma lista de descobertas retornadas.  
Tipo: matriz de objetos [FilterSummary](API_FilterSummary.md)  
Membros da matriz: número máximo de 100 itens.

 ** [nextToken](#API_ListFilters_ResponseSyntax) **   <a name="personalize-ListFilters-response-nextToken"></a>
Um token para obter o próximo conjunto de filtros (se existirem).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}` 

## Erros
<a name="API_ListFilters_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** InvalidNextTokenException **   
O token de ID não é válido.  
Código de Status HTTP: 400

## Consulte também
<a name="API_ListFilters_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListFilters) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListFilters) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListFilters) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListFilters) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListFilters) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListFilters) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListFilters) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListFilters) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListFilters) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListFilters) 

# ListMetricAttributionMetrics
<a name="API_ListMetricAttributionMetrics"></a>

Lista as métricas para a atribuição métrica.

## Sintaxe da solicitação
<a name="API_ListMetricAttributionMetrics_RequestSyntax"></a>

```
{
   "maxResults": number,
   "metricAttributionArn": "string",
   "nextToken": "string"
}
```

## Parâmetros da solicitação
<a name="API_ListMetricAttributionMetrics_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [maxResults](#API_ListMetricAttributionMetrics_RequestSyntax) **   <a name="personalize-ListMetricAttributionMetrics-request-maxResults"></a>
O número máximo de resultados a serem retornados ao mesmo tempo.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [metricAttributionArn](#API_ListMetricAttributionMetrics_RequestSyntax) **   <a name="personalize-ListMetricAttributionMetrics-request-metricAttributionArn"></a>
O nome do recurso da Amazon (ARN) da atribuição métrica para a qual recuperar atributos.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [nextToken](#API_ListMetricAttributionMetrics_RequestSyntax) **   <a name="personalize-ListMetricAttributionMetrics-request-nextToken"></a>
Especifique o token de paginação retornado por uma solicitação anterior para recuperar a próxima página de resultados.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}`   
Obrigatório: Não

## Sintaxe da resposta
<a name="API_ListMetricAttributionMetrics_ResponseSyntax"></a>

```
{
   "metrics": [ 
      { 
         "eventType": "string",
         "expression": "string",
         "metricName": "string"
      }
   ],
   "nextToken": "string"
}
```

## Elementos de resposta
<a name="API_ListMetricAttributionMetrics_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [metrics](#API_ListMetricAttributionMetrics_ResponseSyntax) **   <a name="personalize-ListMetricAttributionMetrics-response-metrics"></a>
As métricas para a atribuição métrica especificada.  
Tipo: matriz de objetos [MetricAttribute](API_MetricAttribute.md)  
Membros da matriz: número máximo de 10 itens.

 ** [nextToken](#API_ListMetricAttributionMetrics_ResponseSyntax) **   <a name="personalize-ListMetricAttributionMetrics-response-nextToken"></a>
Especifique o token de paginação retornado por uma solicitação anterior `ListMetricAttributionMetricsResponse` para recuperar a próxima página de resultados.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}` 

## Erros
<a name="API_ListMetricAttributionMetrics_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** InvalidNextTokenException **   
O token de ID não é válido.  
Código de Status HTTP: 400

## Consulte também
<a name="API_ListMetricAttributionMetrics_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListMetricAttributionMetrics) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListMetricAttributionMetrics) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListMetricAttributionMetrics) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListMetricAttributionMetrics) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListMetricAttributionMetrics) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListMetricAttributionMetrics) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListMetricAttributionMetrics) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListMetricAttributionMetrics) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListMetricAttributionMetrics) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListMetricAttributionMetrics) 

# ListMetricAttributions
<a name="API_ListMetricAttributions"></a>

Lista as atribuições métricas.

## Sintaxe da solicitação
<a name="API_ListMetricAttributions_RequestSyntax"></a>

```
{
   "datasetGroupArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## Parâmetros da solicitação
<a name="API_ListMetricAttributions_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetGroupArn](#API_ListMetricAttributions_RequestSyntax) **   <a name="personalize-ListMetricAttributions-request-datasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do grupo de conjuntos de dados da atribuição métrica.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [maxResults](#API_ListMetricAttributions_RequestSyntax) **   <a name="personalize-ListMetricAttributions-request-maxResults"></a>
O número máximo de atribuições métricas a serem retornadas em uma página de resultados.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [nextToken](#API_ListMetricAttributions_RequestSyntax) **   <a name="personalize-ListMetricAttributions-request-nextToken"></a>
Especifique o token de paginação retornado por uma solicitação anterior para recuperar a próxima página de resultados.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}`   
Obrigatório: Não

## Sintaxe da resposta
<a name="API_ListMetricAttributions_ResponseSyntax"></a>

```
{
   "metricAttributions": [ 
      { 
         "creationDateTime": number,
         "failureReason": "string",
         "lastUpdatedDateTime": number,
         "metricAttributionArn": "string",
         "name": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Elementos de resposta
<a name="API_ListMetricAttributions_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [metricAttributions](#API_ListMetricAttributions_ResponseSyntax) **   <a name="personalize-ListMetricAttributions-response-metricAttributions"></a>
A lista de atribuições métricas.  
Tipo: matriz de objetos [MetricAttributionSummary](API_MetricAttributionSummary.md)  
Membros da matriz: número máximo de 100 itens.

 ** [nextToken](#API_ListMetricAttributions_ResponseSyntax) **   <a name="personalize-ListMetricAttributions-response-nextToken"></a>
Especifique o token de paginação retornado por uma solicitação anterior para recuperar a próxima página de resultados.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}` 

## Erros
<a name="API_ListMetricAttributions_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** InvalidNextTokenException **   
O token de ID não é válido.  
Código de Status HTTP: 400

## Consulte também
<a name="API_ListMetricAttributions_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListMetricAttributions) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListMetricAttributions) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListMetricAttributions) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListMetricAttributions) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListMetricAttributions) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListMetricAttributions) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListMetricAttributions) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListMetricAttributions) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListMetricAttributions) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListMetricAttributions) 

# ListRecipes
<a name="API_ListRecipes"></a>

Retorna uma lista de fórmulas disponíveis. A resposta fornece as propriedades de cada fórmula, incluindo o nome do recurso da Amazon (ARN) da fórmula.

## Sintaxe da solicitação
<a name="API_ListRecipes_RequestSyntax"></a>

```
{
   "domain": "string",
   "maxResults": number,
   "nextToken": "string",
   "recipeProvider": "string"
}
```

## Parâmetros da solicitação
<a name="API_ListRecipes_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [domain](#API_ListRecipes_RequestSyntax) **   <a name="personalize-ListRecipes-request-domain"></a>
 Os filtros retornaram fórmulas por domínio para um grupo de conjuntos de dados de domínio. Somente fórmulas (casos de uso do grupo de conjuntos de dados do domínio) desse domínio são incluídas na resposta. Caso você não especifique um domínio, todas as fórmulas são retornadas.   
Tipo: string  
Valores válidos: `ECOMMERCE | VIDEO_ON_DEMAND`   
Obrigatório: não

 ** [maxResults](#API_ListRecipes_RequestSyntax) **   <a name="personalize-ListRecipes-request-maxResults"></a>
     o número máximo de resultados a serem retornados.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [nextToken](#API_ListRecipes_RequestSyntax) **   <a name="personalize-ListRecipes-request-nextToken"></a>
Um token retornado da chamada anterior `ListRecipes` para obter o próximo conjunto de fórmulas (se existirem).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}`   
Obrigatório: não

 ** [recipeProvider](#API_ListRecipes_RequestSyntax) **   <a name="personalize-ListRecipes-request-recipeProvider"></a>
O padrão é `SERVICE`.  
Tipo: String  
Valores válidos: `SERVICE`   
Obrigatório: não

## Sintaxe da resposta
<a name="API_ListRecipes_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "recipes": [ 
      { 
         "creationDateTime": number,
         "domain": "string",
         "lastUpdatedDateTime": number,
         "name": "string",
         "recipeArn": "string",
         "status": "string"
      }
   ]
}
```

## Elementos de resposta
<a name="API_ListRecipes_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [nextToken](#API_ListRecipes_ResponseSyntax) **   <a name="personalize-ListRecipes-response-nextToken"></a>
Um token usado para obter o próximo conjunto de resultados.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}` 

 ** [recipes](#API_ListRecipes_ResponseSyntax) **   <a name="personalize-ListRecipes-response-recipes"></a>
A lista de fórmulas disponíveis.  
Tipo: matriz de objetos [RecipeSummary](API_RecipeSummary.md)  
Membros da matriz: número máximo de 100 itens.

## Erros
<a name="API_ListRecipes_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** InvalidNextTokenException **   
O token de ID não é válido.  
Código de Status HTTP: 400

## Consulte também
<a name="API_ListRecipes_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListRecipes) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListRecipes) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListRecipes) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListRecipes) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListRecipes) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListRecipes) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListRecipes) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListRecipes) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListRecipes) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListRecipes) 

# ListRecommenders
<a name="API_ListRecommenders"></a>

Retorna uma lista de recomendadores em um determinado grupo de conjuntos de dados do Domínio. Quando um grupo de conjuntos de dados de domínio não é especificado, todos os recomendadores associados à conta são listados. A resposta fornece as propriedades para cada recomendador, incluindo o nome do recurso da Amazon (ARN). Para obter mais informações sobre recomendadores, consulte. [CreateRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html)

## Sintaxe da solicitação
<a name="API_ListRecommenders_RequestSyntax"></a>

```
{
   "datasetGroupArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## Parâmetros da solicitação
<a name="API_ListRecommenders_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetGroupArn](#API_ListRecommenders_RequestSyntax) **   <a name="personalize-ListRecommenders-request-datasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do grupo de conjuntos de dados do domínio para os quais os recomendadores são listados. Quando um grupo de conjuntos de dados de domínio não é especificado, todos os recomendadores associados à conta são listados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [maxResults](#API_ListRecommenders_RequestSyntax) **   <a name="personalize-ListRecommenders-request-maxResults"></a>
     o número máximo de resultados a serem retornados.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [nextToken](#API_ListRecommenders_RequestSyntax) **   <a name="personalize-ListRecommenders-request-nextToken"></a>
Um token retornado da chamada anterior `ListRecommenders` para obter o próximo conjunto de recomendadores (se existirem).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}`   
Obrigatório: Não

## Sintaxe da resposta
<a name="API_ListRecommenders_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "recommenders": [ 
      { 
         "creationDateTime": number,
         "datasetGroupArn": "string",
         "lastUpdatedDateTime": number,
         "name": "string",
         "recipeArn": "string",
         "recommenderArn": "string",
         "recommenderConfig": { 
            "enableMetadataWithRecommendations": boolean,
            "itemExplorationConfig": { 
               "string" : "string" 
            },
            "minRecommendationRequestsPerSecond": number,
            "trainingDataConfig": { 
               "excludedDatasetColumns": { 
                  "string" : [ "string" ]
               },
               "includedDatasetColumns": { 
                  "string" : [ "string" ]
               }
            }
         },
         "status": "string"
      }
   ]
}
```

## Elementos de resposta
<a name="API_ListRecommenders_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [nextToken](#API_ListRecommenders_ResponseSyntax) **   <a name="personalize-ListRecommenders-response-nextToken"></a>
Um token para obter o próximo conjunto de recomendadores (se existirem).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}` 

 ** [recommenders](#API_ListRecommenders_ResponseSyntax) **   <a name="personalize-ListRecommenders-response-recommenders"></a>
Uma lista dos recomendadores.  
Tipo: matriz de objetos [RecommenderSummary](API_RecommenderSummary.md)  
Membros da matriz: número máximo de 100 itens.

## Erros
<a name="API_ListRecommenders_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** InvalidNextTokenException **   
O token de ID não é válido.  
Código de Status HTTP: 400

## Consulte também
<a name="API_ListRecommenders_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListRecommenders) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListRecommenders) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListRecommenders) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListRecommenders) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListRecommenders) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListRecommenders) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListRecommenders) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListRecommenders) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListRecommenders) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListRecommenders) 

# ListSchemas
<a name="API_ListSchemas"></a>

Retorna a lista de esquemas associados à conta. A resposta fornece as propriedades para cada esquema, incluindo o nome do recurso da Amazon (ARN). Para obter mais informações sobre esquemas, consulte [CreateSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html).

## Sintaxe da solicitação
<a name="API_ListSchemas_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string"
}
```

## Parâmetros da solicitação
<a name="API_ListSchemas_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [maxResults](#API_ListSchemas_RequestSyntax) **   <a name="personalize-ListSchemas-request-maxResults"></a>
O número máximo de esquemas a serem retornadas.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [nextToken](#API_ListSchemas_RequestSyntax) **   <a name="personalize-ListSchemas-request-nextToken"></a>
Um token retornado da chamada anterior `ListSchemas` para obter o próximo conjunto de esquemas (se existirem).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}`   
Obrigatório: Não

## Sintaxe da resposta
<a name="API_ListSchemas_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "schemas": [ 
      { 
         "creationDateTime": number,
         "domain": "string",
         "lastUpdatedDateTime": number,
         "name": "string",
         "schemaArn": "string"
      }
   ]
}
```

## Elementos de resposta
<a name="API_ListSchemas_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [nextToken](#API_ListSchemas_ResponseSyntax) **   <a name="personalize-ListSchemas-response-nextToken"></a>
Um token usado para obter o próximo conjunto de esquemas (se existirem).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}` 

 ** [schemas](#API_ListSchemas_ResponseSyntax) **   <a name="personalize-ListSchemas-response-schemas"></a>
Uma lista de esquemas.  
Tipo: matriz de objetos [DatasetSchemaSummary](API_DatasetSchemaSummary.md)  
Membros da matriz: número máximo de 100 itens.

## Erros
<a name="API_ListSchemas_Errors"></a>

 ** InvalidNextTokenException **   
O token de ID não é válido.  
Código de Status HTTP: 400

## Consulte também
<a name="API_ListSchemas_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListSchemas) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListSchemas) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListSchemas) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListSchemas) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListSchemas) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListSchemas) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListSchemas) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListSchemas) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListSchemas) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListSchemas) 

# ListSolutions
<a name="API_ListSolutions"></a>

Retorna uma lista de soluções que usam um determinado grupo de conjuntos de dados. Quando um grupo de conjuntos de dados não é especificado, todas as soluções associadas à conta são listadas. A resposta fornece as propriedades para cada solução, incluindo o nome do recurso da Amazon (ARN). Para obter mais informações sobre soluções, consulte [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html).

## Sintaxe da solicitação
<a name="API_ListSolutions_RequestSyntax"></a>

```
{
   "datasetGroupArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## Parâmetros da solicitação
<a name="API_ListSolutions_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetGroupArn](#API_ListSolutions_RequestSyntax) **   <a name="personalize-ListSolutions-request-datasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do grupo de conjuntos de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [maxResults](#API_ListSolutions_RequestSyntax) **   <a name="personalize-ListSolutions-request-maxResults"></a>
O número máximo de soluções a serem retornadas.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [nextToken](#API_ListSolutions_RequestSyntax) **   <a name="personalize-ListSolutions-request-nextToken"></a>
Um token retornado da chamada anterior `ListSolutions` para obter o próximo conjunto de soluções (se existirem).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}`   
Obrigatório: Não

## Sintaxe da resposta
<a name="API_ListSolutions_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "solutions": [ 
      { 
         "creationDateTime": number,
         "lastUpdatedDateTime": number,
         "name": "string",
         "recipeArn": "string",
         "solutionArn": "string",
         "status": "string"
      }
   ]
}
```

## Elementos de resposta
<a name="API_ListSolutions_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [nextToken](#API_ListSolutions_ResponseSyntax) **   <a name="personalize-ListSolutions-response-nextToken"></a>
Um símbolo para obter o próximo conjunto de soluções (se existirem).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}` 

 ** [solutions](#API_ListSolutions_ResponseSyntax) **   <a name="personalize-ListSolutions-response-solutions"></a>
Uma lista das soluções atuais.  
Tipo: matriz de objetos [SolutionSummary](API_SolutionSummary.md)  
Membros da matriz: número máximo de 100 itens.

## Erros
<a name="API_ListSolutions_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** InvalidNextTokenException **   
O token de ID não é válido.  
Código de Status HTTP: 400

## Consulte também
<a name="API_ListSolutions_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListSolutions) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListSolutions) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListSolutions) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListSolutions) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListSolutions) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListSolutions) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListSolutions) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListSolutions) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListSolutions) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListSolutions) 

# ListSolutionVersions
<a name="API_ListSolutionVersions"></a>

Retorna uma lista de versões da solução para a solução fornecida. Quando uma solução não é especificada, todas as versões da solução associadas à conta são listadas. A resposta fornece as propriedades para cada versão da solução, incluindo o nome do recurso da Amazon (ARN).

## Sintaxe da solicitação
<a name="API_ListSolutionVersions_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string",
   "solutionArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_ListSolutionVersions_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [maxResults](#API_ListSolutionVersions_RequestSyntax) **   <a name="personalize-ListSolutionVersions-request-maxResults"></a>
O número máximo de versões a serem retornadas.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [nextToken](#API_ListSolutionVersions_RequestSyntax) **   <a name="personalize-ListSolutionVersions-request-nextToken"></a>
Um token retornado da chamada anterior `ListSolutionVersions` para obter o próximo conjunto de versões da solução (se existirem).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}`   
Obrigatório: não

 ** [solutionArn](#API_ListSolutionVersions_RequestSyntax) **   <a name="personalize-ListSolutionVersions-request-solutionArn"></a>
O nome do recurso da Amazon (ARN) da solução.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

## Sintaxe da resposta
<a name="API_ListSolutionVersions_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "solutionVersions": [ 
      { 
         "creationDateTime": number,
         "failureReason": "string",
         "lastUpdatedDateTime": number,
         "solutionVersionArn": "string",
         "status": "string",
         "trainingMode": "string",
         "trainingType": "string"
      }
   ]
}
```

## Elementos de resposta
<a name="API_ListSolutionVersions_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [nextToken](#API_ListSolutionVersions_ResponseSyntax) **   <a name="personalize-ListSolutionVersions-response-nextToken"></a>
Um token para obter o próximo conjunto de versões da solução (se existirem).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 1500.  
Padrão: `\p{ASCII}{0,1500}` 

 ** [solutionVersions](#API_ListSolutionVersions_ResponseSyntax) **   <a name="personalize-ListSolutionVersions-response-solutionVersions"></a>
Uma lista de versões da solução descrevendo as propriedades da versão.  
Tipo: matriz de objetos [SolutionVersionSummary](API_SolutionVersionSummary.md)  
Membros da matriz: número máximo de 100 itens.

## Erros
<a name="API_ListSolutionVersions_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** InvalidNextTokenException **   
O token de ID não é válido.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_ListSolutionVersions_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListSolutionVersions) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListSolutionVersions) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListSolutionVersions) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListSolutionVersions) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListSolutionVersions) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListSolutionVersions) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListSolutionVersions) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListSolutionVersions) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListSolutionVersions) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListSolutionVersions) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Obtenha uma lista de [tags](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) anexadas a um recurso.

## Sintaxe da solicitação
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
{
   "resourceArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_ListTagsForResource_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [resourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="personalize-ListTagsForResource-request-resourceArn"></a>
O nome do recurso da Amazon (ARN) da fonte de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
{
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

## Elementos de resposta
<a name="API_ListTagsForResource_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="personalize-ListTagsForResource-response-tags"></a>
A chave da tag de recurso.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.

## Erros
<a name="API_ListTagsForResource_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_ListTagsForResource_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListTagsForResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListTagsForResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListTagsForResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListTagsForResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListTagsForResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListTagsForResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListTagsForResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListTagsForResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListTagsForResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListTagsForResource) 

# StartRecommender
<a name="API_StartRecommender"></a>

Inicia um recomendador que está INATIVO. Começar um recomendador não cria novos modelos, mas retoma o faturamento e a reciclagem automática do recomendador.

## Sintaxe da solicitação
<a name="API_StartRecommender_RequestSyntax"></a>

```
{
   "recommenderArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_StartRecommender_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [recommenderArn](#API_StartRecommender_RequestSyntax) **   <a name="personalize-StartRecommender-request-recommenderArn"></a>
O nome do recurso da Amazon (ARN) do recomendador a ser iniciado.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_StartRecommender_ResponseSyntax"></a>

```
{
   "recommenderArn": "string"
}
```

## Elementos de resposta
<a name="API_StartRecommender_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [recommenderArn](#API_StartRecommender_ResponseSyntax) **   <a name="personalize-StartRecommender-response-recommenderArn"></a>
O nome do recurso da Amazon (ARN) do recomendador que você iniciou.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## Erros
<a name="API_StartRecommender_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_StartRecommender_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/StartRecommender) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/StartRecommender) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/StartRecommender) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/StartRecommender) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/StartRecommender) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/StartRecommender) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/StartRecommender) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/StartRecommender) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/StartRecommender) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/StartRecommender) 

# StopRecommender
<a name="API_StopRecommender"></a>

Interrompe um recomendador que está ATIVO. Interromper um recomendador interrompe a cobrança e a reciclagem automática do recomendador.

## Sintaxe da solicitação
<a name="API_StopRecommender_RequestSyntax"></a>

```
{
   "recommenderArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_StopRecommender_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [recommenderArn](#API_StopRecommender_RequestSyntax) **   <a name="personalize-StopRecommender-request-recommenderArn"></a>
O nome do recurso da Amazon (ARN) do recomendador a ser interrompido.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_StopRecommender_ResponseSyntax"></a>

```
{
   "recommenderArn": "string"
}
```

## Elementos de resposta
<a name="API_StopRecommender_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [recommenderArn](#API_StopRecommender_ResponseSyntax) **   <a name="personalize-StopRecommender-response-recommenderArn"></a>
O nome do recurso da Amazon (ARN) do recomendador que você interrompeu.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## Erros
<a name="API_StopRecommender_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_StopRecommender_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/StopRecommender) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/StopRecommender) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/StopRecommender) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/StopRecommender) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/StopRecommender) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/StopRecommender) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/StopRecommender) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/StopRecommender) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/StopRecommender) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/StopRecommender) 

# StopSolutionVersionCreation
<a name="API_StopSolutionVersionCreation"></a>

Interrompe a criação de uma versão da solução que esteja no estado CREATE\$1PENDING ou CREATE IN\$1PROGRESS. 

Dependendo do estado atual da versão da solução, o estado da versão da solução muda da seguinte forma:
+ CREATE\$1PENDING > CREATE\$1STOPED

  or
+ CREATE\$1IN\$1PROGRESS > CREATE\$1STOPING> CREATE\$1STOPED

Você será cobrado por todo o treinamento concluído até interromper a criação da versão da solução. Você não pode continuar criando uma versão da solução depois que ela for interrompida.

## Sintaxe da solicitação
<a name="API_StopSolutionVersionCreation_RequestSyntax"></a>

```
{
   "solutionVersionArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_StopSolutionVersionCreation_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [solutionVersionArn](#API_StopSolutionVersionCreation_RequestSyntax) **   <a name="personalize-StopSolutionVersionCreation-request-solutionVersionArn"></a>
O nome do recurso da Amazon (ARN) da versão da solução a ser implantada.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Elementos de resposta
<a name="API_StopSolutionVersionCreation_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_StopSolutionVersionCreation_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_StopSolutionVersionCreation_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/StopSolutionVersionCreation) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/StopSolutionVersionCreation) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/StopSolutionVersionCreation) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/StopSolutionVersionCreation) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/StopSolutionVersionCreation) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/StopSolutionVersionCreation) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/StopSolutionVersionCreation) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/StopSolutionVersionCreation) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/StopSolutionVersionCreation) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/StopSolutionVersionCreation) 

# TagResource
<a name="API_TagResource"></a>

A lista de tags a serem adicionadas a um recurso.

## Sintaxe da solicitação
<a name="API_TagResource_RequestSyntax"></a>

```
{
   "resourceArn": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

## Parâmetros da solicitação
<a name="API_TagResource_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [resourceArn](#API_TagResource_RequestSyntax) **   <a name="personalize-TagResource-request-resourceArn"></a>
O nome do recurso da Amazon (ARN) da fonte de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [tags](#API_TagResource_RequestSyntax) **   <a name="personalize-TagResource-request-tags"></a>
As tags a serem aplicadas ao recurso. Para obter mais informações, consulte [Tagging Amazon Personalize resources](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html).  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: sim

## Elementos de resposta
<a name="API_TagResource_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_TagResource_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** LimitExceededException **   
O limite de número de solicitações por segundo foi excedido.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de status HTTP: 400

 ** TooManyTagsException **   
Você excedeu o número máximo de tags que pode aplicar a esse recurso.   
Código de Status HTTP: 400

## Consulte também
<a name="API_TagResource_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/TagResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/TagResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/TagResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/TagResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/TagResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/TagResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/TagResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/TagResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/TagResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

Remove as tags especificadas que estão anexadas a um recurso. Para obter mais informações, consulte [Remover as tags dos recursos do Amazon Personalize](https://docs.aws.amazon.com/personalize/latest/dg/tags-remove.html).

## Sintaxe da solicitação
<a name="API_UntagResource_RequestSyntax"></a>

```
{
   "resourceArn": "string",
   "tagKeys": [ "string" ]
}
```

## Parâmetros da solicitação
<a name="API_UntagResource_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [resourceArn](#API_UntagResource_RequestSyntax) **   <a name="personalize-UntagResource-request-resourceArn"></a>
O nome do recurso da Amazon (ARN) da fonte de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [tagKeys](#API_UntagResource_RequestSyntax) **   <a name="personalize-UntagResource-request-tagKeys"></a>
As chaves das tags a serem removidas.  
Tipo: matriz de strings  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Restrições de tamanho: tamanho mínimo 1. O tamanho máximo é 128.  
Padrão: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Obrigatório: sim

## Elementos de resposta
<a name="API_UntagResource_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_UntagResource_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de status HTTP: 400

 ** TooManyTagKeysException **   
A solicitação contém mais chaves de tag do que as que podem ser associadas a um recurso (50 chaves de tag por recurso).   
Código de Status HTTP: 400

## Consulte também
<a name="API_UntagResource_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/UntagResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/UntagResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/UntagResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UntagResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UntagResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/UntagResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/UntagResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UntagResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/UntagResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/UntagResource) 

# UpdateCampaign
<a name="API_UpdateCampaign"></a>

 Atualiza uma campanha para implantar uma versão retreinada da solução com uma campanha existente, alterar `minProvisionedTPS` da sua campanha ou modificar a configuração dela, por exemplo, a configuração de exploração. Por exemplo, você pode definir `enableMetadataWithRecommendations` como verdadeiro para uma campanha existente.

 Para atualizar uma campanha e começar a usar automaticamente a versão mais recente da solução, especifique o seguinte:
+ Para o parâmetro `SolutionVersionArn`, especifique o nome do recurso da Amazon (ARN) da solução no formato `SolutionArn/$LATEST`. 
+  Na `campaignConfig`, defina `syncWithLatestSolutionVersion` como `true`. 

Para atualizar uma campanha, o status da campanha deve ser ATIVO ou FALHA NA CRIAÇÃO. Verifique o status da campanha usando a [DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html)operação.

**nota**  
Você ainda pode receber recomendações de uma campanha enquanto uma atualização está em andamento. A campanha usará a versão anterior da solução e a configuração da campanha para gerar recomendações até que o status de atualização mais recente da campanha seja`Active`. 

Para obter mais informações sobre a atualização de uma campanha, incluindo exemplos de código, consulte [Atualização de uma campanha](https://docs.aws.amazon.com/personalize/latest/dg/update-campaigns.html). Para obter informações sobre como criar uma campanha, consulte [Criar uma campanha](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html)

## Sintaxe da solicitação
<a name="API_UpdateCampaign_RequestSyntax"></a>

```
{
   "campaignArn": "string",
   "campaignConfig": { 
      "enableMetadataWithRecommendations": boolean,
      "itemExplorationConfig": { 
         "string" : "string" 
      },
      "rankingInfluence": { 
         "string" : number 
      },
      "syncWithLatestSolutionVersion": boolean
   },
   "minProvisionedTPS": number,
   "solutionVersionArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_UpdateCampaign_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [campaignArn](#API_UpdateCampaign_RequestSyntax) **   <a name="personalize-UpdateCampaign-request-campaignArn"></a>
O nome do recurso da Amazon (ARN) da campanha.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [campaignConfig](#API_UpdateCampaign_RequestSyntax) **   <a name="personalize-UpdateCampaign-request-campaignConfig"></a>
Os detalhes de configuração de uma campanha.  
Tipo: objeto [CampaignConfig](API_CampaignConfig.md)  
Obrigatório: não

 ** [minProvisionedTPS](#API_UpdateCampaign_RequestSyntax) **   <a name="personalize-UpdateCampaign-request-minProvisionedTPS"></a>
Especifica o mínimo de transações provisionadas (recomendações) solicitadas por segundo para o qual o Amazon Personalize oferecerá suporte. Uma `minProvisionedTPS` alta aumentará sua conta. Recomendamos começar com 1 para `minProvisionedTPS` (o padrão). Acompanhe seu uso usando CloudWatch as métricas da Amazon e aumente as `minProvisionedTPS` conforme necessário.  
Tipo: inteiro  
Intervalo válido: valor mínimo de 1.  
Obrigatório: não

 ** [solutionVersionArn](#API_UpdateCampaign_RequestSyntax) **   <a name="personalize-UpdateCampaign-request-solutionVersionArn"></a>
O nome do recurso da Amazon (ARN) do novo modelo a ser implantado. Para especificar a versão mais recente da solução, indique o ARN da *solução* no formato `SolutionArn/$LATEST`. Você deve usar esse formato se você `syncWithLatestSolutionVersion` definir como `True` no [CampaignConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html).   
 Para implantar um modelo que não seja a versão mais recente da solução, especifique o ARN da versão da solução.   
 Para obter informações sobre as atualizações automáticas das campanhas, consulte [Habilitar as atualizações de campanha automáticas](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update).   
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

## Sintaxe da resposta
<a name="API_UpdateCampaign_ResponseSyntax"></a>

```
{
   "campaignArn": "string"
}
```

## Elementos de resposta
<a name="API_UpdateCampaign_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [campaignArn](#API_UpdateCampaign_ResponseSyntax) **   <a name="personalize-UpdateCampaign-response-campaignArn"></a>
O mesmo ARN da campanha fornecido na solicitação.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## Erros
<a name="API_UpdateCampaign_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_UpdateCampaign_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma linguagem específica AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/UpdateCampaign) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/UpdateCampaign) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/UpdateCampaign) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateCampaign) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UpdateCampaign) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateCampaign) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/UpdateCampaign) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateCampaign) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/UpdateCampaign) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/UpdateCampaign) 

# UpdateDataset
<a name="API_UpdateDataset"></a>

Atualize um conjunto de dados para substituir seu esquema por um novo ou existente. Para obter mais informações, consulte [Substituir o esquema de um conjunto de dados](https://docs.aws.amazon.com/personalize/latest/dg/updating-dataset-schema.html). 

## Sintaxe da solicitação
<a name="API_UpdateDataset_RequestSyntax"></a>

```
{
   "datasetArn": "string",
   "schemaArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_UpdateDataset_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetArn](#API_UpdateDataset_RequestSyntax) **   <a name="personalize-UpdateDataset-request-datasetArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados que você deseja atualizar.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [schemaArn](#API_UpdateDataset_RequestSyntax) **   <a name="personalize-UpdateDataset-request-schemaArn"></a>
O nome do recurso da Amazon (ARN) do esquema.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_UpdateDataset_ResponseSyntax"></a>

```
{
   "datasetArn": "string"
}
```

## Elementos de resposta
<a name="API_UpdateDataset_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [datasetArn](#API_UpdateDataset_ResponseSyntax) **   <a name="personalize-UpdateDataset-response-datasetArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## Erros
<a name="API_UpdateDataset_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_UpdateDataset_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/UpdateDataset) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/UpdateDataset) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/UpdateDataset) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateDataset) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UpdateDataset) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateDataset) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/UpdateDataset) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateDataset) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/UpdateDataset) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/UpdateDataset) 

# UpdateMetricAttribution
<a name="API_UpdateMetricAttribution"></a>

Atualiza uma atribuição métrica.

## Sintaxe da solicitação
<a name="API_UpdateMetricAttribution_RequestSyntax"></a>

```
{
   "addMetrics": [ 
      { 
         "eventType": "string",
         "expression": "string",
         "metricName": "string"
      }
   ],
   "metricAttributionArn": "string",
   "metricsOutputConfig": { 
      "roleArn": "string",
      "s3DataDestination": { 
         "kmsKeyArn": "string",
         "path": "string"
      }
   },
   "removeMetrics": [ "string" ]
}
```

## Parâmetros da solicitação
<a name="API_UpdateMetricAttribution_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [addMetrics](#API_UpdateMetricAttribution_RequestSyntax) **   <a name="personalize-UpdateMetricAttribution-request-addMetrics"></a>
Adicione novos atributos métricos à atribuição métrica.  
Tipo: matriz de objetos [MetricAttribute](API_MetricAttribute.md)  
Membros da matriz: número máximo de 10 itens.  
Obrigatório: não

 ** [metricAttributionArn](#API_UpdateMetricAttribution_RequestSyntax) **   <a name="personalize-UpdateMetricAttribution-request-metricAttributionArn"></a>
O nome do recurso da Amazon (ARN) da atribuição de métrica a ser atualizada.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [metricsOutputConfig](#API_UpdateMetricAttribution_RequestSyntax) **   <a name="personalize-UpdateMetricAttribution-request-metricsOutputConfig"></a>
Uma configuração de saída para a atribuição métrica.  
Tipo: objeto [MetricAttributionOutput](API_MetricAttributionOutput.md)  
Obrigatório: não

 ** [removeMetrics](#API_UpdateMetricAttribution_RequestSyntax) **   <a name="personalize-UpdateMetricAttribution-request-removeMetrics"></a>
Remova os atributos métricos da atribuição métrica.  
Tipo: matriz de strings  
Membros da matriz: número máximo de 10 itens.  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: não

## Sintaxe da resposta
<a name="API_UpdateMetricAttribution_ResponseSyntax"></a>

```
{
   "metricAttributionArn": "string"
}
```

## Elementos de resposta
<a name="API_UpdateMetricAttribution_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [metricAttributionArn](#API_UpdateMetricAttribution_ResponseSyntax) **   <a name="personalize-UpdateMetricAttribution-response-metricAttributionArn"></a>
O nome do recurso da Amazon (ARN) da atribuição de métrica que você atualizou.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## Erros
<a name="API_UpdateMetricAttribution_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
O recurso especificado já existe.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_UpdateMetricAttribution_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/UpdateMetricAttribution) 

# UpdateRecommender
<a name="API_UpdateRecommender"></a>

Atualiza o recomendador para modificar a configuração do recomendador. Se você atualizar o recomendador para modificar as colunas usadas no treinamento, o Amazon Personalize iniciará automaticamente um novo treinamento completo dos modelos que apoiam seu recomendador. Enquanto a atualização é concluída, você ainda pode receber recomendações do recomendador. Até que a reciclagem seja concluída, o recomendador usa a configuração anterior. Para rastrear o status dessa atualização, use `latestRecommenderUpdate` retornado na operação [DescribeRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html). 

## Sintaxe da solicitação
<a name="API_UpdateRecommender_RequestSyntax"></a>

```
{
   "recommenderArn": "string",
   "recommenderConfig": { 
      "enableMetadataWithRecommendations": boolean,
      "itemExplorationConfig": { 
         "string" : "string" 
      },
      "minRecommendationRequestsPerSecond": number,
      "trainingDataConfig": { 
         "excludedDatasetColumns": { 
            "string" : [ "string" ]
         },
         "includedDatasetColumns": { 
            "string" : [ "string" ]
         }
      }
   }
}
```

## Parâmetros da solicitação
<a name="API_UpdateRecommender_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [recommenderArn](#API_UpdateRecommender_RequestSyntax) **   <a name="personalize-UpdateRecommender-request-recommenderArn"></a>
O nome do recurso da Amazon (ARN) do recomendador a ser modificado.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [recommenderConfig](#API_UpdateRecommender_RequestSyntax) **   <a name="personalize-UpdateRecommender-request-recommenderConfig"></a>
Os detalhes de configuração do recomendador.  
Tipo: objeto [RecommenderConfig](API_RecommenderConfig.md)  
Obrigatório: sim

## Sintaxe da resposta
<a name="API_UpdateRecommender_ResponseSyntax"></a>

```
{
   "recommenderArn": "string"
}
```

## Elementos de resposta
<a name="API_UpdateRecommender_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [recommenderArn](#API_UpdateRecommender_ResponseSyntax) **   <a name="personalize-UpdateRecommender-response-recommenderArn"></a>
O mesmo nome do recurso da Amazon (ARN) do recomendador, conforme fornecido na solicitação.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## Erros
<a name="API_UpdateRecommender_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_UpdateRecommender_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/UpdateRecommender) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/UpdateRecommender) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/UpdateRecommender) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateRecommender) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UpdateRecommender) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateRecommender) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/UpdateRecommender) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateRecommender) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/UpdateRecommender) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/UpdateRecommender) 

# UpdateSolution
<a name="API_UpdateSolution"></a>

Atualiza uma solução do Amazon Personalize para usar sua configuração automática de treinamento. Ao atualizar uma solução, você pode definir se ela usa o treinamento automático e alterar a frequência com que ele acontece. Para obter mais informações sobre como atualizar sua solução, consulte [Como atualizar sua solução](https://docs.aws.amazon.com/personalize/latest/dg/updating-solution.html).

A atualização da solução pode estar em um dos seguintes estados:

CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED

Para obter o status de uma atualização da solução, chame a operação da [DescribeSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html)API e encontre o status no`latestSolutionUpdate`. 

## Sintaxe da solicitação
<a name="API_UpdateSolution_RequestSyntax"></a>

```
{
   "performAutoTraining": boolean,
   "performIncrementalUpdate": boolean,
   "solutionArn": "string",
   "solutionUpdateConfig": { 
      "autoTrainingConfig": { 
         "schedulingExpression": "string"
      },
      "eventsConfig": { 
         "eventParametersList": [ 
            { 
               "eventType": "string",
               "eventValueThreshold": number,
               "weight": number
            }
         ]
      }
   }
}
```

## Parâmetros da solicitação
<a name="API_UpdateSolution_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [performAutoTraining](#API_UpdateSolution_RequestSyntax) **   <a name="personalize-UpdateSolution-request-performAutoTraining"></a>
Se a solução usa treinamento automático para criar novas versões da solução (modelos treinados). Você pode alterar a frequência do treinamento especificando a `AutoTrainingConfig` como parte da configuração da solução `schedulingExpression`.   
 Se você ativar o treinamento automático, o primeiro começará dentro de uma hora após a atualização da solução. Se você criar manualmente uma versão da solução dentro desse período, ela pulará o primeiro treinamento automático. Para obter mais informações sobre o treinamento automático, consulte [Configurar o treinamento automático](https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html).   
 Após o início do treinamento, você pode obter o Amazon Resource Name (ARN) da versão da solução com a operação da [ListSolutionVersions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html)API. Para obter seu status, use [DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html)o.   
Tipo: booliano  
Obrigatório: não

 ** [performIncrementalUpdate](#API_UpdateSolution_RequestSyntax) **   <a name="personalize-UpdateSolution-request-performIncrementalUpdate"></a>
Se você deve realizar atualizações incrementais de treinamento em seu modelo. Quando ativado, isso permite que o modelo aprenda com novos dados com mais frequência sem exigir um novo treinamento completo, o que permite uma personalização quase em tempo real. Esse parâmetro é suportado somente para soluções que usam a receita de similaridade semântica.  
Tipo: booliano  
Obrigatório: não

 ** [solutionArn](#API_UpdateSolution_RequestSyntax) **   <a name="personalize-UpdateSolution-request-solutionArn"></a>
O nome do recurso da Amazon (ARN) da solução a ser atualizada.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [solutionUpdateConfig](#API_UpdateSolution_RequestSyntax) **   <a name="personalize-UpdateSolution-request-solutionUpdateConfig"></a>
Novos detalhes da configuração da solução.  
Tipo: objeto [SolutionUpdateConfig](API_SolutionUpdateConfig.md)  
Obrigatório: não

## Sintaxe da resposta
<a name="API_UpdateSolution_ResponseSyntax"></a>

```
{
   "solutionArn": "string"
}
```

## Elementos de resposta
<a name="API_UpdateSolution_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [solutionArn](#API_UpdateSolution_ResponseSyntax) **   <a name="personalize-UpdateSolution-response-solutionArn"></a>
O mesmo nome do recurso da Amazon (ARN) da solução, conforme fornecido na solicitação.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## Erros
<a name="API_UpdateSolution_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** LimitExceededException **   
O limite de número de solicitações por segundo foi excedido.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_UpdateSolution_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/UpdateSolution) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/UpdateSolution) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/UpdateSolution) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateSolution) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UpdateSolution) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateSolution) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/UpdateSolution) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateSolution) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/UpdateSolution) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/UpdateSolution) 

# Eventos do Amazon Personalize
<a name="API_Operations_Amazon_Personalize_Events"></a>

Os eventos do Amazon Personalize oferecem suporte às seguintes ações:
+  [PutActionInteractions](API_UBS_PutActionInteractions.md) 
+  [PutActions](API_UBS_PutActions.md) 
+  [PutEvents](API_UBS_PutEvents.md) 
+  [PutItems](API_UBS_PutItems.md) 
+  [PutUsers](API_UBS_PutUsers.md) 

# PutActionInteractions
<a name="API_UBS_PutActionInteractions"></a>

Registra os dados de eventos de interações com ações. Um evento de *interação com ação* é uma interação entre um usuário e uma *ação*. Por exemplo, um usuário que realize uma ação, como inscrever-se em um programa de associação ou baixar a aplicação.

 Para obter mais informações sobre como registrar interações com ações, consulte [Registrar eventos de interação com ações](https://docs.aws.amazon.com/personalize/latest/dg/recording-action-interaction-events.html). Para obter mais informações sobre ações em um conjunto de dados de ações, consulte [Conjunto de dados de ações](https://docs.aws.amazon.com/personalize/latest/dg/actions-datasets.html).

## Sintaxe da Solicitação
<a name="API_UBS_PutActionInteractions_RequestSyntax"></a>

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

{
   "actionInteractions": [ 
      { 
         "actionId": "string",
         "eventId": "string",
         "eventType": "string",
         "impression": [ "string" ],
         "properties": "string",
         "recommendationId": "string",
         "sessionId": "string",
         "timestamp": number,
         "userId": "string"
      }
   ],
   "trackingId": "string"
}
```

## Parâmetros da solicitação de URI
<a name="API_UBS_PutActionInteractions_RequestParameters"></a>

A solicitação não usa nenhum parâmetro de URI.

## Corpo da Solicitação
<a name="API_UBS_PutActionInteractions_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [actionInteractions](#API_UBS_PutActionInteractions_RequestSyntax) **   <a name="personalize-UBS_PutActionInteractions-request-actionInteractions"></a>
Uma lista de eventos de interações com ações da sessão.  
Tipo: matriz de objetos [ActionInteraction](API_UBS_ActionInteraction.md)  
Membros da matriz: número mínimo de 1 item. Número máximo de 10 itens.  
Obrigatório: Sim

 ** [trackingId](#API_UBS_PutActionInteractions_RequestSyntax) **   <a name="personalize-UBS_PutActionInteractions-request-trackingId"></a>
O ID do rastreador de eventos de interações com ações. Ao criar um conjunto de dados de interações com ações, o Amazon Personalize cria um rastreador de eventos de interações com ações para você. Para obter mais informações, consulte [ID do rastreador de eventos de interação com ações](https://docs.aws.amazon.com/personalize/latest/dg/action-interaction-tracker-id.html).  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 256.  
Obrigatório: sim

## Sintaxe da resposta
<a name="API_UBS_PutActionInteractions_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_UBS_PutActionInteractions_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_UBS_PutActionInteractions_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de Status HTTP: 409

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de status HTTP: 404

## Consulte Também
<a name="API_UBS_PutActionInteractions_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/PutActionInteractions) 

# PutActions
<a name="API_UBS_PutActions"></a>

Adiciona uma ou mais ações a um conjunto de dados de ações. Para obter mais informações, consulte [Importar ações individualmente](https://docs.aws.amazon.com/personalize/latest/dg/importing-actions.html). 

## Sintaxe da Solicitação
<a name="API_UBS_PutActions_RequestSyntax"></a>

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

{
   "actions": [ 
      { 
         "actionId": "string",
         "properties": "string"
      }
   ],
   "datasetArn": "string"
}
```

## Parâmetros da solicitação de URI
<a name="API_UBS_PutActions_RequestParameters"></a>

A solicitação não usa nenhum parâmetro de URI.

## Corpo da Solicitação
<a name="API_UBS_PutActions_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [actions](#API_UBS_PutActions_RequestSyntax) **   <a name="personalize-UBS_PutActions-request-actions"></a>
Uma lista de dados de ações.  
Tipo: matriz de objetos [Action](API_UBS_Action.md)  
Membros da matriz: número mínimo de 1 item. Número máximo de 10 itens.  
Obrigatório: Sim

 ** [datasetArn](#API_UBS_PutActions_RequestSyntax) **   <a name="personalize-UBS_PutActions-request-datasetArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados de ações ao qual você está adicionando a ação ou as ações.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_UBS_PutActions_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_UBS_PutActions_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_UBS_PutActions_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de Status HTTP: 409

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de status HTTP: 404

## Consulte Também
<a name="API_UBS_PutActions_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-events-2018-03-22/PutActions) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-events-2018-03-22/PutActions) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/PutActions) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutActions) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/PutActions) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutActions) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-events-2018-03-22/PutActions) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutActions) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-events-2018-03-22/PutActions) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/PutActions) 

# PutEvents
<a name="API_UBS_PutEvents"></a>

Registra os dados dos eventos de interações com itens. Para obter mais informações, consulte [Registrar eventos de interação com itens](https://docs.aws.amazon.com/personalize/latest/dg/recording-item-interaction-events.html).

**nota**  
 Se você usar uma AWS Lambda função para chamar a PutEvents operação, a função de execução da função deverá ter permissão para realizar a `personalize:PutEvents` ação com o caractere curinga `*` no `Resource` elemento. 

## Sintaxe da Solicitação
<a name="API_UBS_PutEvents_RequestSyntax"></a>

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

{
   "eventList": [ 
      { 
         "eventId": "string",
         "eventType": "string",
         "eventValue": number,
         "impression": [ "string" ],
         "itemId": "string",
         "metricAttribution": { 
            "eventAttributionSource": "string"
         },
         "properties": "string",
         "recommendationId": "string",
         "sentAt": number
      }
   ],
   "sessionId": "string",
   "trackingId": "string",
   "userId": "string"
}
```

## Parâmetros da solicitação de URI
<a name="API_UBS_PutEvents_RequestParameters"></a>

A solicitação não usa nenhum parâmetro de URI.

## Corpo da Solicitação
<a name="API_UBS_PutEvents_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [eventList](#API_UBS_PutEvents_RequestSyntax) **   <a name="personalize-UBS_PutEvents-request-eventList"></a>
Uma lista de dados de eventos da sessão.  
Tipo: matriz de objetos [Event](API_UBS_Event.md)  
Membros da matriz: número mínimo de 1 item. Número máximo de 10 itens.  
Obrigatório: Sim

 ** [sessionId](#API_UBS_PutEvents_RequestSyntax) **   <a name="personalize-UBS_PutEvents-request-sessionId"></a>
O nome do usuário associado à sessão. Seu aplicativo gera o sessionId quando um usuário visita seu site pela primeira vez ou usa seu aplicativo. O Amazon Personalize usa o sessionId para associar eventos ao usuário antes que ele faça login. Para obter mais informações, consulte [Registrar eventos de interação com itens](https://docs.aws.amazon.com/personalize/latest/dg/recording-item-interaction-events.html).  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 256.  
Obrigatório: sim

 ** [trackingId](#API_UBS_PutEvents_RequestSyntax) **   <a name="personalize-UBS_PutEvents-request-trackingId"></a>
O ID da transação do evento. O ID é gerado por uma chamada para a [CreateEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html)API.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 256.  
Obrigatório: sim

 ** [userId](#API_UBS_PutEvents_RequestSyntax) **   <a name="personalize-UBS_PutEvents-request-userId"></a>
O usuário associado ao evento.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 256.  
Obrigatório: não

## Sintaxe da resposta
<a name="API_UBS_PutEvents_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_UBS_PutEvents_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_UBS_PutEvents_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de Status HTTP: 400

## Consulte também
<a name="API_UBS_PutEvents_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-events-2018-03-22/PutEvents) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-events-2018-03-22/PutEvents) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/PutEvents) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutEvents) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/PutEvents) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutEvents) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-events-2018-03-22/PutEvents) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutEvents) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-events-2018-03-22/PutEvents) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/PutEvents) 

# PutItems
<a name="API_UBS_PutItems"></a>

Adiciona um ou mais itens a um conjunto de dados Itens. Para obter mais informações, consulte [Como importar itens individualmente](https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html). 

## Sintaxe da Solicitação
<a name="API_UBS_PutItems_RequestSyntax"></a>

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

{
   "datasetArn": "string",
   "items": [ 
      { 
         "itemId": "string",
         "properties": "string"
      }
   ]
}
```

## Parâmetros da solicitação de URI
<a name="API_UBS_PutItems_RequestParameters"></a>

A solicitação não usa nenhum parâmetro de URI.

## Corpo da Solicitação
<a name="API_UBS_PutItems_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetArn](#API_UBS_PutItems_RequestSyntax) **   <a name="personalize-UBS_PutItems-request-datasetArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados de itens ao qual você está adicionando o item ou itens.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [items](#API_UBS_PutItems_RequestSyntax) **   <a name="personalize-UBS_PutItems-request-items"></a>
Uma lista de dados do item.  
Tipo: matriz de objetos [Item](API_UBS_Item.md)  
Membros da matriz: número mínimo de 1 item. Número máximo de 10 itens.  
Obrigatório: sim

## Sintaxe da resposta
<a name="API_UBS_PutItems_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_UBS_PutItems_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_UBS_PutItems_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de Status HTTP: 409

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de status HTTP: 404

## Consulte Também
<a name="API_UBS_PutItems_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-events-2018-03-22/PutItems) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-events-2018-03-22/PutItems) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/PutItems) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutItems) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/PutItems) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutItems) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-events-2018-03-22/PutItems) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutItems) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-events-2018-03-22/PutItems) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/PutItems) 

# PutUsers
<a name="API_UBS_PutUsers"></a>

Adiciona um ou mais usuários a um conjunto de dados de usuários. Para obter mais informações, consulte [Como importar usuários individuais](https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html).

## Sintaxe da Solicitação
<a name="API_UBS_PutUsers_RequestSyntax"></a>

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

{
   "datasetArn": "string",
   "users": [ 
      { 
         "properties": "string",
         "userId": "string"
      }
   ]
}
```

## Parâmetros da solicitação de URI
<a name="API_UBS_PutUsers_RequestParameters"></a>

A solicitação não usa nenhum parâmetro de URI.

## Corpo da Solicitação
<a name="API_UBS_PutUsers_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [datasetArn](#API_UBS_PutUsers_RequestSyntax) **   <a name="personalize-UBS_PutUsers-request-datasetArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados Usuários ao qual você está adicionando o usuário ou usuários.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [users](#API_UBS_PutUsers_RequestSyntax) **   <a name="personalize-UBS_PutUsers-request-users"></a>
Uma lista de dados do usuário.  
Tipo: matriz de objetos [User](API_UBS_User.md)  
Membros da matriz: número mínimo de 1 item. Número máximo de 10 itens.  
Obrigatório: sim

## Sintaxe da resposta
<a name="API_UBS_PutUsers_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_UBS_PutUsers_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_UBS_PutUsers_Errors"></a>

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
Código de Status HTTP: 409

 ** ResourceNotFoundException **   
Não foi possível encontrar o recurso especificado.  
Código de status HTTP: 404

## Consulte Também
<a name="API_UBS_PutUsers_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-events-2018-03-22/PutUsers) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-events-2018-03-22/PutUsers) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/PutUsers) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutUsers) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/PutUsers) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutUsers) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-events-2018-03-22/PutUsers) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutUsers) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-events-2018-03-22/PutUsers) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/PutUsers) 

# Runtime do Amazon Personalize
<a name="API_Operations_Amazon_Personalize_Runtime"></a>

O runtime do Amazon Personalize oferece suporte às seguintes ações:
+  [GetActionRecommendations](API_RS_GetActionRecommendations.md) 
+  [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) 
+  [GetRecommendations](API_RS_GetRecommendations.md) 

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

Exibe uma lista de ações recomendadas em ordem decrescente por pontuação de previsão. Use a API `GetActionRecommendations` se você tiver uma campanha personalizada que implante uma versão da solução treinada com uma fórmula PERSONALIZED\$1ACTIONS. 

Para obter mais informações sobre fórmulas PERSONALIZED\$1ACTIONS, consulte [PERSONALIZED\$1ACTIONS recipes](https://docs.aws.amazon.com/personalize/latest/dg/nexts-best-action-recipes.html). Para obter mais informações sobre como obter recomendações de ações, consulte [Obter recomendações de ações](https://docs.aws.amazon.com/personalize/latest/dg/get-action-recommendations.html).

## Sintaxe da Solicitação
<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 da solicitação de URI
<a name="API_RS_GetActionRecommendations_RequestParameters"></a>

A solicitação não usa nenhum parâmetro de URI.

## Corpo da Solicitação
<a name="API_RS_GetActionRecommendations_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [campaignArn](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-campaignArn"></a>
O nome do recurso da Amazon (ARN) da campanha a ser usada para obter recomendações de ações. Essa campanha deve implantar uma versão da solução treinada com uma fórmula PERSONALIZED\$1ACTIONS.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [filterArn](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-filterArn"></a>
O ARN do filtro a ser aplicado às recomendações retornadas. Para obter mais informações, consulte [Filtrar recomendações](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
Ao usar esse parâmetro, verifique se o recurso de filtro é `ACTIVE`.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [filterValues](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-filterValues"></a>
Os valores a serem usados ao filtrar as recomendações. Para cada parâmetro de espaço reservado em sua expressão de filtro, forneça o nome do parâmetro (em maiúsculas e minúsculas) como uma chave e os valores do filtro como o valor correspondente. Separe vários valores para um parâmetro com uma vírgula.   
Para expressões de filtros que usem um elemento `INCLUDE` para incluir ações, é necessário fornecer valores para todos os parâmetros definidos na expressão. Para filtros com expressões que usem um elemento `EXCLUDE` para excluir ações, é possível omitir os `filter-values`. Nesse caso, o Amazon Personalize não usa essa parte da expressão para filtrar recomendações.  
Para obter mais informações, consulte [Filtrar recomendações e segmentos de usuários](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
Tipo: mapa de string para string  
Entradas do mapa: número máximo de 25 itens.  
Restrições de tamanhos de chave: tamanho máximo de 50.  
Padrão da chave: `[A-Za-z0-9_]+`   
Restrições de tamanho de valor: tamanho máximo de 1.000.  
Obrigatório: não

 ** [numResults](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-numResults"></a>
     o número máximo de resultados a serem retornados. O padrão é 5. O máximo é cem.  
Tipo: inteiro  
Intervalo válido: valor mínimo de 0.  
Obrigatório: não

 ** [userId](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-userId"></a>
O ID do usuário para o qual fornecer recomendações de ações.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: não

## Sintaxe da resposta
<a name="API_RS_GetActionRecommendations_ResponseSyntax"></a>

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

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

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

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [actionList](#API_RS_GetActionRecommendations_ResponseSyntax) **   <a name="personalize-RS_GetActionRecommendations-response-actionList"></a>
Uma lista de recomendações de ações em ordem decrescente por pontuação de previsão. Pode haver, no máximo, cem ações na lista. Para obter informações sobre pontuações de ações, consulte [How action recommendation scoring works](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>
O ID da recomendação.  
Tipo: string

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

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
O recurso especificado não existe.  
Código de status HTTP: 404

## Consulte Também
<a name="API_RS_GetActionRecommendations_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando 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>

Classifica novamente uma lista de itens recomendados para um determinado usuário. O primeiro item na lista é considerado pelo item de maior interesse para o usuário.

**nota**  
A solução por trás da campanha precisa ter sido criada com uma fórmula do tipo PERSONALIZED\$1RANKING.

## Sintaxe da Solicitação
<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 da solicitação de URI
<a name="API_RS_GetPersonalizedRanking_RequestParameters"></a>

A solicitação não usa nenhum parâmetro de URI.

## Corpo da Solicitação
<a name="API_RS_GetPersonalizedRanking_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [campaignArn](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-campaignArn"></a>
O nome do recurso da Amazon (ARN) da campanha a ser usada para gerar a classificação personalizada.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [context](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-context"></a>
Os metadados contextuais a serem usados ao obter recomendações. Os metadados contextuais incluem qualquer informação de interação que possa ser relevante ao obter as recomendações de um usuário, como a localização atual do usuário ou o tipo de dispositivo.  
Tipo: mapa de string para string  
Entradas do mapa: número máximo de 150 itens.  
Restrições de tamanhos de chave: tamanho máximo de 150.  
Padrão da chave: `[A-Za-z\d_]+`   
Restrições de tamanho de valor: tamanho máximo de 1.000.  
Obrigatório: não

 ** [filterArn](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-filterArn"></a>
O nome do recurso da Amazon (ARN) de um filtro que você criou para incluir ou excluir itens das recomendações de um determinado usuário. Para obter mais informações, consulte [Filtrar recomendações](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [filterValues](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-filterValues"></a>
Os valores a serem usados ao filtrar as recomendações. Para cada parâmetro de espaço reservado em sua expressão de filtro, forneça o nome do parâmetro (em maiúsculas e minúsculas) como uma chave e os valores do filtro como o valor correspondente. Separe vários valores para um parâmetro com uma vírgula.   
Para expressões de filtro que usam um elemento `INCLUDE` para incluir itens, você deve fornecer valores para todos os parâmetros definidos na expressão. Para filtros com expressões que usam um `EXCLUDE` elemento para excluir itens, você pode omitir o`filter-values`. Nesse caso, o Amazon Personalize não usa essa parte da expressão para filtrar recomendações.  
Para obter mais informações, consulte [Filtrar recomendações](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
Tipo: mapa de string para string  
Entradas do mapa: número máximo de 25 itens.  
Restrições de tamanhos de chave: tamanho máximo de 50.  
Padrão da chave: `[A-Za-z0-9_]+`   
Restrições de tamanho de valor: tamanho máximo de 1.000.  
Obrigatório: não

 ** [inputList](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-inputList"></a>
Uma lista de itens (por `itemId`) para classificar. Se um item não foi incluído no conjunto de dados de treinamento, o item será anexado ao final da lista reclassificada. Se você estiver incluindo metadados nas recomendações, o máximo será cinquenta. Caso contrário, o máximo será quinhentos.  
Tipo: matriz de strings  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Sim

 ** [metadataColumns](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-metadataColumns"></a>
Se você habilitou os metadados nas recomendações ao criar ou atualizar a campanha, especifique as colunas de metadados do conjunto de dados de itens a serem incluídas na classificação personalizada. A chave do mapa é `ITEMS` e o valor é uma lista de nomes de colunas do conjunto de dados de itens. O número máximo de colunas que podem ser fornecidas é dez.  
 Para obter informações sobre como habilitar metadados para uma campanha, consulte [Enabling metadata in recommendations for a campaign](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata).   
Tipo: string para a matriz do mapa de strings  
Entradas do mapa: número máximo de um item.  
Restrições de tamanho de chave: tamanho máximo de 256.  
Membros da matriz: número máximo de 99 itens.  
Restrições de tamanho: tamanho máximo de 150.  
Obrigatório: não

 ** [userId](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-userId"></a>
O usuário para o qual você deseja que a campanha forneça uma classificação personalizada.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: sim

## Sintaxe da resposta
<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 resposta
<a name="API_RS_GetPersonalizedRanking_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [personalizedRanking](#API_RS_GetPersonalizedRanking_ResponseSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-response-personalizedRanking"></a>
Uma lista de itens na ordem mais provável de interesse para o usuário. O máximo é 500.  
Tipo: matriz de objetos [PredictedItem](API_RS_PredictedItem.md)

 ** [recommendationId](#API_RS_GetPersonalizedRanking_ResponseSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-response-recommendationId"></a>
O ID da recomendação.  
Tipo: string

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

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
O recurso especificado não existe.  
Código de status HTTP: 404

## Consulte Também
<a name="API_RS_GetPersonalizedRanking_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando 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>

Retorna uma lista de itens recomendados. Para campanhas, o nome do recurso da Amazon (ARN) da campanha é obrigatório e a entrada necessária do usuário e do item depende do tipo de fórmula usada para criar a solução de apoio à campanha da seguinte forma:
+ USER\$1PERSONALIZATION - `userId` obrigatório, não usado `itemId`
+ RELATED\$1ITEMS - `itemId` obrigatório, não usado `userId`

**nota**  
Campanhas que são apoiadas por uma solução criada usando uma fórmula do tipo PERSONALIZED\$1RANKING usam a API. [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md)

 Para recomendadores, o ARN do recomendador é obrigatório e o item necessário e a entrada do usuário dependem do caso de uso (fórmula baseada em domínio) que sustenta o recomendador. Para obter informações sobre os requisitos de casos de uso, consulte [Como escolher casos de uso recomendados](https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html). 

## Sintaxe da Solicitação
<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 da solicitação de URI
<a name="API_RS_GetRecommendations_RequestParameters"></a>

A solicitação não usa nenhum parâmetro de URI.

## Corpo da Solicitação
<a name="API_RS_GetRecommendations_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [campaignArn](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-campaignArn"></a>
O nome do recurso da Amazon (ARN) da campanha a ser usada para obter recomendações.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [context](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-context"></a>
Os metadados contextuais a serem usados ao obter recomendações. Os metadados contextuais incluem qualquer informação de interação que possa ser relevante ao obter as recomendações de um usuário, como a localização atual do usuário ou o tipo de dispositivo.  
Tipo: mapa de string para string  
Entradas do mapa: número máximo de 150 itens.  
Restrições de tamanhos de chave: tamanho máximo de 150.  
Padrão da chave: `[A-Za-z\d_]+`   
Restrições de tamanho de valor: tamanho máximo de 1.000.  
Obrigatório: não

 ** [filterArn](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-filterArn"></a>
O ARN do filtro a ser aplicado às recomendações retornadas. Para obter mais informações, consulte [Filtrar recomendações](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
Ao usar esse parâmetro, verifique se o recurso de filtro é `ACTIVE`.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [filterValues](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-filterValues"></a>
Os valores a serem usados ao filtrar as recomendações. Para cada parâmetro de espaço reservado em sua expressão de filtro, forneça o nome do parâmetro (em maiúsculas e minúsculas) como uma chave e os valores do filtro como o valor correspondente. Separe vários valores para um parâmetro com uma vírgula.   
Para expressões de filtro que usam um elemento `INCLUDE` para incluir itens, você deve fornecer valores para todos os parâmetros definidos na expressão. Para filtros com expressões que usam um `EXCLUDE` elemento para excluir itens, você pode omitir o `filter-values`. Nesse caso, o Amazon Personalize não usa essa parte da expressão para filtrar recomendações.   
Para obter mais informações, consulte [Filtrar recomendações e segmentos de usuários](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
Tipo: mapa de string para string  
Entradas do mapa: número máximo de 25 itens.  
Restrições de tamanhos de chave: tamanho máximo de 50.  
Padrão da chave: `[A-Za-z0-9_]+`   
Restrições de tamanho de valor: tamanho máximo de 1.000.  
Obrigatório: não

 ** [itemId](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-itemId"></a>
O ID do item para o qual fornecer recomendações.  
Obrigatório para o tipo de fórmula `RELATED_ITEMS`.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: não

 ** [metadataColumns](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-metadataColumns"></a>
Se você habilitou os metadados nas recomendações ao criar ou atualizar a campanha ou o recomendador, especifique as colunas de metadados do conjunto de dados de itens a serem incluídas nas recomendações de itens. A chave do mapa é `ITEMS` e o valor é uma lista de nomes de colunas do conjunto de dados de itens. O número máximo de colunas que podem ser fornecidas é dez.  
 Para obter informações sobre como habilitar metadados para uma campanha, consulte [Enabling metadata in recommendations for a campaign](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata). Para obter informações sobre como habilitar metadados para uma recomendador, consulte [Enabling metadata in recommendations for a recommender](https://docs.aws.amazon.com/personalize/latest/dg/creating-recommenders.html#create-recommender-return-metadata).   
Tipo: string para a matriz do mapa de strings  
Entradas do mapa: número máximo de um item.  
Restrições de tamanho de chave: tamanho máximo de 256.  
Membros da matriz: número máximo de 99 itens.  
Restrições de tamanho: tamanho máximo de 150.  
Obrigatório: não

 ** [numResults](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-numResults"></a>
     o número máximo de resultados a serem retornados. O padrão é 25. Se você estiver incluindo metadados nas recomendações, o máximo será cinquenta. Caso contrário, o máximo será quinhentos.  
Tipo: inteiro  
Intervalo válido: valor mínimo de 0.  
Obrigatório: não

 ** [promotions](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-promotions"></a>
As promoções a serem aplicadas à solicitação de recomendação. Uma promoção define regras de negócios adicionais que se aplicam a um subconjunto configurável de itens recomendados.  
Tipo: matriz de objetos [Promotion](API_RS_Promotion.md)  
Membros da matriz: número máximo de 1 item.  
Obrigatório: não

 ** [recommenderArn](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-recommenderArn"></a>
O nome do recurso da Amazon (ARN) do recomendador a ser usado para obter recomendações. Forneça um ARN de recomendação se você criou um grupo de conjuntos de dados de domínio com um recomendador para um caso de uso de domínio.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [userId](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-userId"></a>
O ID do usuário para o qual fornecer recomendações.  
Obrigatório para o tipo de fórmula `USER_PERSONALIZATION`.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: não

## Sintaxe da resposta
<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 resposta
<a name="API_RS_GetRecommendations_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [itemList](#API_RS_GetRecommendations_ResponseSyntax) **   <a name="personalize-RS_GetRecommendations-response-itemList"></a>
Uma lista de recomendações classificadas em ordem decrescente por pontuação de previsão. Pode haver no máximo 500 itens na lista.  
Tipo: matriz de objetos [PredictedItem](API_RS_PredictedItem.md)

 ** [recommendationId](#API_RS_GetRecommendations_ResponseSyntax) **   <a name="personalize-RS_GetRecommendations-response-recommendationId"></a>
O ID da recomendação.  
Tipo: string

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

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
O recurso especificado não existe.  
Código de status HTTP: 404

## Consulte Também
<a name="API_RS_GetRecommendations_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando 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) 

# Tipos de dados
<a name="API_Types"></a>

O Amazon Personalize oferece suporte aos seguintes tipos de dados:
+  [Algorithm](API_Algorithm.md) 
+  [AlgorithmImage](API_AlgorithmImage.md) 
+  [AutoMLConfig](API_AutoMLConfig.md) 
+  [AutoMLResult](API_AutoMLResult.md) 
+  [AutoTrainingConfig](API_AutoTrainingConfig.md) 
+  [BatchInferenceJob](API_BatchInferenceJob.md) 
+  [BatchInferenceJobConfig](API_BatchInferenceJobConfig.md) 
+  [BatchInferenceJobInput](API_BatchInferenceJobInput.md) 
+  [BatchInferenceJobOutput](API_BatchInferenceJobOutput.md) 
+  [BatchInferenceJobSummary](API_BatchInferenceJobSummary.md) 
+  [BatchSegmentJob](API_BatchSegmentJob.md) 
+  [BatchSegmentJobInput](API_BatchSegmentJobInput.md) 
+  [BatchSegmentJobOutput](API_BatchSegmentJobOutput.md) 
+  [BatchSegmentJobSummary](API_BatchSegmentJobSummary.md) 
+  [Campaign](API_Campaign.md) 
+  [CampaignConfig](API_CampaignConfig.md) 
+  [CampaignSummary](API_CampaignSummary.md) 
+  [CampaignUpdateSummary](API_CampaignUpdateSummary.md) 
+  [CategoricalHyperParameterRange](API_CategoricalHyperParameterRange.md) 
+  [ContinuousHyperParameterRange](API_ContinuousHyperParameterRange.md) 
+  [DataDeletionJob](API_DataDeletionJob.md) 
+  [DataDeletionJobSummary](API_DataDeletionJobSummary.md) 
+  [Dataset](API_Dataset.md) 
+  [DatasetExportJob](API_DatasetExportJob.md) 
+  [DatasetExportJobOutput](API_DatasetExportJobOutput.md) 
+  [DatasetExportJobSummary](API_DatasetExportJobSummary.md) 
+  [DatasetGroup](API_DatasetGroup.md) 
+  [DatasetGroupSummary](API_DatasetGroupSummary.md) 
+  [DatasetImportJob](API_DatasetImportJob.md) 
+  [DatasetImportJobSummary](API_DatasetImportJobSummary.md) 
+  [DatasetSchema](API_DatasetSchema.md) 
+  [DatasetSchemaSummary](API_DatasetSchemaSummary.md) 
+  [DatasetSummary](API_DatasetSummary.md) 
+  [DatasetUpdateSummary](API_DatasetUpdateSummary.md) 
+  [DataSource](API_DataSource.md) 
+  [DefaultCategoricalHyperParameterRange](API_DefaultCategoricalHyperParameterRange.md) 
+  [DefaultContinuousHyperParameterRange](API_DefaultContinuousHyperParameterRange.md) 
+  [DefaultHyperParameterRanges](API_DefaultHyperParameterRanges.md) 
+  [DefaultIntegerHyperParameterRange](API_DefaultIntegerHyperParameterRange.md) 
+  [EventParameters](API_EventParameters.md) 
+  [EventsConfig](API_EventsConfig.md) 
+  [EventTracker](API_EventTracker.md) 
+  [EventTrackerSummary](API_EventTrackerSummary.md) 
+  [FeatureTransformation](API_FeatureTransformation.md) 
+  [FieldsForThemeGeneration](API_FieldsForThemeGeneration.md) 
+  [Filter](API_Filter.md) 
+  [FilterSummary](API_FilterSummary.md) 
+  [HPOConfig](API_HPOConfig.md) 
+  [HPOObjective](API_HPOObjective.md) 
+  [HPOResourceConfig](API_HPOResourceConfig.md) 
+  [HyperParameterRanges](API_HyperParameterRanges.md) 
+  [IntegerHyperParameterRange](API_IntegerHyperParameterRange.md) 
+  [MetricAttribute](API_MetricAttribute.md) 
+  [MetricAttribution](API_MetricAttribution.md) 
+  [MetricAttributionOutput](API_MetricAttributionOutput.md) 
+  [MetricAttributionSummary](API_MetricAttributionSummary.md) 
+  [OptimizationObjective](API_OptimizationObjective.md) 
+  [Recipe](API_Recipe.md) 
+  [RecipeSummary](API_RecipeSummary.md) 
+  [Recommender](API_Recommender.md) 
+  [RecommenderConfig](API_RecommenderConfig.md) 
+  [RecommenderSummary](API_RecommenderSummary.md) 
+  [RecommenderUpdateSummary](API_RecommenderUpdateSummary.md) 
+  [S3DataConfig](API_S3DataConfig.md) 
+  [Solution](API_Solution.md) 
+  [SolutionConfig](API_SolutionConfig.md) 
+  [SolutionSummary](API_SolutionSummary.md) 
+  [SolutionUpdateConfig](API_SolutionUpdateConfig.md) 
+  [SolutionUpdateSummary](API_SolutionUpdateSummary.md) 
+  [SolutionVersion](API_SolutionVersion.md) 
+  [SolutionVersionSummary](API_SolutionVersionSummary.md) 
+  [Tag](API_Tag.md) 
+  [ThemeGenerationConfig](API_ThemeGenerationConfig.md) 
+  [TrainingDataConfig](API_TrainingDataConfig.md) 
+  [TunedHPOParams](API_TunedHPOParams.md) 

Os eventos do Amazon Personalize oferecem suporte aos seguintes tipos de dados:
+  [Action](API_UBS_Action.md) 
+  [ActionInteraction](API_UBS_ActionInteraction.md) 
+  [Event](API_UBS_Event.md) 
+  [Item](API_UBS_Item.md) 
+  [MetricAttribution](API_UBS_MetricAttribution.md) 
+  [User](API_UBS_User.md) 

O runtime do Amazon Personalize oferece suporte aos seguintes tipos de dados:
+  [PredictedAction](API_RS_PredictedAction.md) 
+  [PredictedItem](API_RS_PredictedItem.md) 
+  [Promotion](API_RS_Promotion.md) 

# Amazon Personalize
<a name="API_Types_Amazon_Personalize"></a>

O Amazon Personalize oferece suporte aos seguintes tipos de dados:
+  [Algorithm](API_Algorithm.md) 
+  [AlgorithmImage](API_AlgorithmImage.md) 
+  [AutoMLConfig](API_AutoMLConfig.md) 
+  [AutoMLResult](API_AutoMLResult.md) 
+  [AutoTrainingConfig](API_AutoTrainingConfig.md) 
+  [BatchInferenceJob](API_BatchInferenceJob.md) 
+  [BatchInferenceJobConfig](API_BatchInferenceJobConfig.md) 
+  [BatchInferenceJobInput](API_BatchInferenceJobInput.md) 
+  [BatchInferenceJobOutput](API_BatchInferenceJobOutput.md) 
+  [BatchInferenceJobSummary](API_BatchInferenceJobSummary.md) 
+  [BatchSegmentJob](API_BatchSegmentJob.md) 
+  [BatchSegmentJobInput](API_BatchSegmentJobInput.md) 
+  [BatchSegmentJobOutput](API_BatchSegmentJobOutput.md) 
+  [BatchSegmentJobSummary](API_BatchSegmentJobSummary.md) 
+  [Campaign](API_Campaign.md) 
+  [CampaignConfig](API_CampaignConfig.md) 
+  [CampaignSummary](API_CampaignSummary.md) 
+  [CampaignUpdateSummary](API_CampaignUpdateSummary.md) 
+  [CategoricalHyperParameterRange](API_CategoricalHyperParameterRange.md) 
+  [ContinuousHyperParameterRange](API_ContinuousHyperParameterRange.md) 
+  [DataDeletionJob](API_DataDeletionJob.md) 
+  [DataDeletionJobSummary](API_DataDeletionJobSummary.md) 
+  [Dataset](API_Dataset.md) 
+  [DatasetExportJob](API_DatasetExportJob.md) 
+  [DatasetExportJobOutput](API_DatasetExportJobOutput.md) 
+  [DatasetExportJobSummary](API_DatasetExportJobSummary.md) 
+  [DatasetGroup](API_DatasetGroup.md) 
+  [DatasetGroupSummary](API_DatasetGroupSummary.md) 
+  [DatasetImportJob](API_DatasetImportJob.md) 
+  [DatasetImportJobSummary](API_DatasetImportJobSummary.md) 
+  [DatasetSchema](API_DatasetSchema.md) 
+  [DatasetSchemaSummary](API_DatasetSchemaSummary.md) 
+  [DatasetSummary](API_DatasetSummary.md) 
+  [DatasetUpdateSummary](API_DatasetUpdateSummary.md) 
+  [DataSource](API_DataSource.md) 
+  [DefaultCategoricalHyperParameterRange](API_DefaultCategoricalHyperParameterRange.md) 
+  [DefaultContinuousHyperParameterRange](API_DefaultContinuousHyperParameterRange.md) 
+  [DefaultHyperParameterRanges](API_DefaultHyperParameterRanges.md) 
+  [DefaultIntegerHyperParameterRange](API_DefaultIntegerHyperParameterRange.md) 
+  [EventParameters](API_EventParameters.md) 
+  [EventsConfig](API_EventsConfig.md) 
+  [EventTracker](API_EventTracker.md) 
+  [EventTrackerSummary](API_EventTrackerSummary.md) 
+  [FeatureTransformation](API_FeatureTransformation.md) 
+  [FieldsForThemeGeneration](API_FieldsForThemeGeneration.md) 
+  [Filter](API_Filter.md) 
+  [FilterSummary](API_FilterSummary.md) 
+  [HPOConfig](API_HPOConfig.md) 
+  [HPOObjective](API_HPOObjective.md) 
+  [HPOResourceConfig](API_HPOResourceConfig.md) 
+  [HyperParameterRanges](API_HyperParameterRanges.md) 
+  [IntegerHyperParameterRange](API_IntegerHyperParameterRange.md) 
+  [MetricAttribute](API_MetricAttribute.md) 
+  [MetricAttribution](API_MetricAttribution.md) 
+  [MetricAttributionOutput](API_MetricAttributionOutput.md) 
+  [MetricAttributionSummary](API_MetricAttributionSummary.md) 
+  [OptimizationObjective](API_OptimizationObjective.md) 
+  [Recipe](API_Recipe.md) 
+  [RecipeSummary](API_RecipeSummary.md) 
+  [Recommender](API_Recommender.md) 
+  [RecommenderConfig](API_RecommenderConfig.md) 
+  [RecommenderSummary](API_RecommenderSummary.md) 
+  [RecommenderUpdateSummary](API_RecommenderUpdateSummary.md) 
+  [S3DataConfig](API_S3DataConfig.md) 
+  [Solution](API_Solution.md) 
+  [SolutionConfig](API_SolutionConfig.md) 
+  [SolutionSummary](API_SolutionSummary.md) 
+  [SolutionUpdateConfig](API_SolutionUpdateConfig.md) 
+  [SolutionUpdateSummary](API_SolutionUpdateSummary.md) 
+  [SolutionVersion](API_SolutionVersion.md) 
+  [SolutionVersionSummary](API_SolutionVersionSummary.md) 
+  [Tag](API_Tag.md) 
+  [ThemeGenerationConfig](API_ThemeGenerationConfig.md) 
+  [TrainingDataConfig](API_TrainingDataConfig.md) 
+  [TunedHPOParams](API_TunedHPOParams.md) 

# Algorithm
<a name="API_Algorithm"></a>

Descreve um algoritmo personalizado.

## Conteúdo
<a name="API_Algorithm_Contents"></a>

 ** algorithmArn **   <a name="personalize-Type-Algorithm-algorithmArn"></a>
O nome do recurso da Amazon (ARN) do algoritmo.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** algorithmImage **   <a name="personalize-Type-Algorithm-algorithmImage"></a>
O URI do contêiner do Docker para a imagem do algoritmo.  
Tipo: objeto [AlgorithmImage](API_AlgorithmImage.md)  
Obrigatório: Não

 ** creationDateTime **   <a name="personalize-Type-Algorithm-creationDateTime"></a>
A data e a hora (no horário Unix) em que o algoritmo foi criado.  
Tipo: Carimbo de data/hora  
Obrigatório: Não

 ** defaultHyperParameterRanges **   <a name="personalize-Type-Algorithm-defaultHyperParameterRanges"></a>
Especifica os hiperparâmetros padrão, seus intervalos e se eles podem ser ajustados. Um hiperparâmetro ajustável pode ter seu valor determinado durante a otimização do hiperparâmetro (HPO).  
Tipo: objeto [DefaultHyperParameterRanges](API_DefaultHyperParameterRanges.md)  
Obrigatório: Não

 ** defaultHyperParameters **   <a name="personalize-Type-Algorithm-defaultHyperParameters"></a>
Especifica os hiperparâmetros padrão.  
Tipo: mapa de string para string  
Entradas do mapa: número máximo de 100 itens.  
Restrições de tamanhos de chave: tamanho máximo de 256.  
Restrições de tamanho de valor: tamanho máximo de 1.000.  
Obrigatório: Não

 ** defaultResourceConfig **   <a name="personalize-Type-Algorithm-defaultResourceConfig"></a>
Especifica o número máximo padrão de trabalhos de treinamento e trabalhos de treinamento paralelos.  
Tipo: mapa de string para string  
Entradas do mapa: número máximo de 100 itens.  
Restrições de tamanhos de chave: tamanho máximo de 256.  
Restrições de tamanho de valor: tamanho máximo de 1.000.  
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-Algorithm-lastUpdatedDateTime"></a>
A data e a hora (no horário do Unix) em que o algoritmo foi atualizado pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** name **   <a name="personalize-Type-Algorithm-name"></a>
O nome do algoritmo.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** roleArn **   <a name="personalize-Type-Algorithm-roleArn"></a>
O nome do recurso da Amazon (ARN) da função.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** trainingInputMode **   <a name="personalize-Type-Algorithm-trainingInputMode"></a>
O modo de entrada do treinamento.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_Algorithm_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Algorithm) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Algorithm) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Algorithm) 

# AlgorithmImage
<a name="API_AlgorithmImage"></a>

Descreve a imagem de um algoritmo.

## Conteúdo
<a name="API_AlgorithmImage_Contents"></a>

 ** dockerURI **   <a name="personalize-Type-AlgorithmImage-dockerURI"></a>
O URI do contêiner do Docker para a imagem do algoritmo.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Sim

 ** name **   <a name="personalize-Type-AlgorithmImage-name"></a>
O nome da imagem do algoritmo.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

## Consulte também
<a name="API_AlgorithmImage_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/AlgorithmImage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/AlgorithmImage) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/AlgorithmImage) 

# AutoMLConfig
<a name="API_AutoMLConfig"></a>

Quando a solução executa o AutoML (`performAutoML` é true em [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)), o Amazon Personalize determina qual fórmula da lista especificada otimiza a métrica fornecida. Em seguida, o Amazon Personalize usa essa fórmula para a solução.

## Conteúdo
<a name="API_AutoMLConfig_Contents"></a>

 ** metricName **   <a name="personalize-Type-AutoMLConfig-metricName"></a>
A métrica a ser otimizada.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

 ** recipeList **   <a name="personalize-Type-AutoMLConfig-recipeList"></a>
A lista de fórmulas elegíveis.  
Tipo: matriz de strings  
Membros da matriz: número máximo de 100 itens.  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

## Consulte também
<a name="API_AutoMLConfig_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/AutoMLConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/AutoMLConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/AutoMLConfig) 

# AutoMLResult
<a name="API_AutoMLResult"></a>

Quando a solução executa o AutoML (`performAutoML` é verdadeiro em [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)), especifica a fórmula que melhor otimizou a métrica especificada.

## Conteúdo
<a name="API_AutoMLResult_Contents"></a>

 ** bestRecipeArn **   <a name="personalize-Type-AutoMLResult-bestRecipeArn"></a>
O nome do recurso da Amazon (ARN) da melhor fórmula.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

## Consulte também
<a name="API_AutoMLResult_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/AutoMLResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/AutoMLResult) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/AutoMLResult) 

# AutoTrainingConfig
<a name="API_AutoTrainingConfig"></a>

A configuração de treinamento automática a ser usada quando `performAutoTraining` é verdadeira.

## Conteúdo
<a name="API_AutoTrainingConfig_Contents"></a>

 ** schedulingExpression **   <a name="personalize-Type-AutoTrainingConfig-schedulingExpression"></a>
Especifica a frequência do treinamento automático de novas versões da solução. Especifique uma expressão no formato rate (*unidade* de *valor*). Para o valor, especifique um número entre 1 e 30. Para a unidade, especifique `day` ou `days`. Por exemplo, para criar automaticamente uma nova versão da solução a cada 5 dias, especifique `rate(5 days)`. O padrão são 7 dias.  
Para obter mais informações sobre o treinamento automático, consulte [Criar e configurar uma solução](https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html).  
Tipo: String  
Restrições de comprimento: tamanho mínimo de 1. O tamanho máximo é 16.  
Padrão: : `rate\(\d+ days?\)`   
Obrigatório: Não

## Consulte também
<a name="API_AutoTrainingConfig_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/AutoTrainingConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/AutoTrainingConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/AutoTrainingConfig) 

# BatchInferenceJob
<a name="API_BatchInferenceJob"></a>

Contém informações sobre um trabalho de inferência em lote.

## Conteúdo
<a name="API_BatchInferenceJob_Contents"></a>

 ** batchInferenceJobArn **   <a name="personalize-Type-BatchInferenceJob-batchInferenceJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de inferência em lote.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** batchInferenceJobConfig **   <a name="personalize-Type-BatchInferenceJob-batchInferenceJobConfig"></a>
Um mapa de string para string dos detalhes de configuração de um trabalho de inferência em lote.  
Tipo: objeto [BatchInferenceJobConfig](API_BatchInferenceJobConfig.md)  
Obrigatório: Não

 ** batchInferenceJobMode **   <a name="personalize-Type-BatchInferenceJob-batchInferenceJobMode"></a>
O modo do trabalho.  
Tipo: String  
Valores Válidos: `BATCH_INFERENCE | THEME_GENERATION`   
Obrigatório: Não

 ** creationDateTime **   <a name="personalize-Type-BatchInferenceJob-creationDateTime"></a>
A hora em que o trabalho de inferência em lote foi criado.  
Tipo: Timestamp  
Obrigatório: Não

 ** failureReason **   <a name="personalize-Type-BatchInferenceJob-failureReason"></a>
Se houver falha no trabalho de inferência em lote, o motivo da falha.  
Tipo: String  
Obrigatório: Não

 ** filterArn **   <a name="personalize-Type-BatchInferenceJob-filterArn"></a>
O ARN do filtro usado no trabalho do inferência em lote.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** jobInput **   <a name="personalize-Type-BatchInferenceJob-jobInput"></a>
O caminho do Amazon S3 que leva aos dados de entrada usados para gerar o trabalho de inferência em lote.  
Tipo: objeto [BatchInferenceJobInput](API_BatchInferenceJobInput.md)  
Obrigatório: Não

 ** jobName **   <a name="personalize-Type-BatchInferenceJob-jobName"></a>
O nome do trabalho de inferência em lote.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** jobOutput **   <a name="personalize-Type-BatchInferenceJob-jobOutput"></a>
O bucket do Amazon S3 que contém os dados de saída gerados pelo trabalho de inferência em lote.  
Tipo: objeto [BatchInferenceJobOutput](API_BatchInferenceJobOutput.md)  
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-BatchInferenceJob-lastUpdatedDateTime"></a>
A hora em que o trabalho de inferência em lote foi atualizado pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** numResults **   <a name="personalize-Type-BatchInferenceJob-numResults"></a>
O número de recomendações geradas pelo trabalho de inferência em lote. Esse número inclui as mensagens de erro geradas para registros de entrada com falha.  
Tipo: inteiro  
Obrigatório: Não

 ** roleArn **   <a name="personalize-Type-BatchInferenceJob-roleArn"></a>
O ARN do perfil do IAM que solicitou o trabalho de inferência em lote.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Obrigatório: Não

 ** solutionVersionArn **   <a name="personalize-Type-BatchInferenceJob-solutionVersionArn"></a>
O nome do recurso da Amazon (ARN) da versão da solução a partir da qual o trabalho de inferência em lote foi criado.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** status **   <a name="personalize-Type-BatchInferenceJob-status"></a>
O status do trabalho de inferência em lote. O status tem um dos valores a seguir:  
+ PENDING
+ IN PROGRESS
+ ACTIVE
+ CREATE FAILED
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

 ** themeGenerationConfig **   <a name="personalize-Type-BatchInferenceJob-themeGenerationConfig"></a>
As configurações de geração do tema do trabalho.  
Tipo: objeto [ThemeGenerationConfig](API_ThemeGenerationConfig.md)  
Obrigatório: Não

## Consulte também
<a name="API_BatchInferenceJob_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJob) 

# BatchInferenceJobConfig
<a name="API_BatchInferenceJobConfig"></a>

Os detalhes de configuração de um trabalho de inferência em lote.

## Conteúdo
<a name="API_BatchInferenceJobConfig_Contents"></a>

 ** itemExplorationConfig **   <a name="personalize-Type-BatchInferenceJobConfig-itemExplorationConfig"></a>
Um mapa de string para string que especifica os hiperparâmetros de configuração de exploração, incluindo `explorationWeight` e `explorationItemAgeCutOff`, que você deseja usar para configurar a quantidade de exploração de itens que o Amazon Personalize usa ao recomendar itens. Consulte [User-Personalization](https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html).  
Tipo: mapa de string para string  
Entradas do mapa: número máximo de 100 itens.  
Restrições de tamanhos de chave: tamanho máximo de 256.  
Restrições de tamanho de valor: tamanho máximo de 1.000.  
Obrigatório: não

 ** rankingInfluence **   <a name="personalize-Type-BatchInferenceJobConfig-rankingInfluence"></a>
Um mapa dos valores de influência do ranking para POPULARIDADE e FRESCOR. Para cada chave, especifique um valor numérico entre 0,0 e 1,0 que determine quanta influência esse fator de classificação tem nas recomendações finais. Um valor próximo de 1,0 dá mais peso ao fator, enquanto um valor próximo de 0,0 reduz sua influência. Se não for especificado, ambos assumem como padrão 0,0.  
Tipo: mapa de string para double  
Chaves válidas: `POPULARITY | FRESHNESS`   
Intervalo válido: valor mínimo de 0. Valor máximo de 1.  
Obrigatório: Não

## Consulte também
<a name="API_BatchInferenceJobConfig_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWSSDKs, consulte o seguinte:
+  [AWSSDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobConfig) 
+  [AWSSDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJobConfig) 
+  [AWSSDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobConfig) 

# BatchInferenceJobInput
<a name="API_BatchInferenceJobInput"></a>

A configuração de entrada de um trabalho de inferência em lote.

## Conteúdo
<a name="API_BatchInferenceJobInput_Contents"></a>

 ** s3DataSource **   <a name="personalize-Type-BatchInferenceJobInput-s3DataSource"></a>
O URI da localização do Amazon S3 que contém seus dados de entrada. O bucket do Amazon S3 deve estar na mesma região que o endpoint da API que você está chamando.  
Tipo: objeto [S3DataConfig](API_S3DataConfig.md)  
Obrigatório: Sim

## Consulte também
<a name="API_BatchInferenceJobInput_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJobInput) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobInput) 

# BatchInferenceJobOutput
<a name="API_BatchInferenceJobOutput"></a>

Os parâmetros de configuração de saída de um trabalho de inferência em lote.

## Conteúdo
<a name="API_BatchInferenceJobOutput_Contents"></a>

 ** s3DataDestination **   <a name="personalize-Type-BatchInferenceJobOutput-s3DataDestination"></a>
Informações sobre o bucket do Amazon S3 no qual a saída do trabalho de inferência em lotes é armazenada.  
Tipo: objeto [S3DataConfig](API_S3DataConfig.md)  
Obrigatório: Sim

## Consulte também
<a name="API_BatchInferenceJobOutput_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJobOutput) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobOutput) 

# BatchInferenceJobSummary
<a name="API_BatchInferenceJobSummary"></a>

Uma versão truncada de [BatchInferenceJob.](https://docs.aws.amazon.com/personalize/latest/dg/API_BatchInferenceJob.html) A operação [ListBatchInferenceJobs](https://docs.aws.amazon.com/personalize/latest/dg/API_ListBatchInferenceJobs.html) retorna uma lista de resumos de trabalhos de inferência em lote.

## Conteúdo
<a name="API_BatchInferenceJobSummary_Contents"></a>

 ** batchInferenceJobArn **   <a name="personalize-Type-BatchInferenceJobSummary-batchInferenceJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de inferência em lote.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** batchInferenceJobMode **   <a name="personalize-Type-BatchInferenceJobSummary-batchInferenceJobMode"></a>
O modo do trabalho.  
Tipo: String  
Valores Válidos: `BATCH_INFERENCE | THEME_GENERATION`   
Obrigatório: Não

 ** creationDateTime **   <a name="personalize-Type-BatchInferenceJobSummary-creationDateTime"></a>
A hora em que o trabalho de inferência em lote foi criado.  
Tipo: Timestamp  
Obrigatório: Não

 ** failureReason **   <a name="personalize-Type-BatchInferenceJobSummary-failureReason"></a>
Se houver falha no trabalho de inferência em lote, o motivo da falha.  
Tipo: String  
Obrigatório: Não

 ** jobName **   <a name="personalize-Type-BatchInferenceJobSummary-jobName"></a>
O nome do trabalho de inferência em lote.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-BatchInferenceJobSummary-lastUpdatedDateTime"></a>
A hora em que o trabalho de inferência em lote foi atualizado pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** solutionVersionArn **   <a name="personalize-Type-BatchInferenceJobSummary-solutionVersionArn"></a>
O ARN da versão da solução usada pelo trabalho de inferência em lote.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** status **   <a name="personalize-Type-BatchInferenceJobSummary-status"></a>
O status do trabalho de inferência em lote. O status tem um dos valores a seguir:  
+ PENDING
+ IN PROGRESS
+ ACTIVE
+ CREATE FAILED
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_BatchInferenceJobSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJobSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobSummary) 

# BatchSegmentJob
<a name="API_BatchSegmentJob"></a>

Contém informações sobre um trabalho do segmento em lote.

## Conteúdo
<a name="API_BatchSegmentJob_Contents"></a>

 ** batchSegmentJobArn **   <a name="personalize-Type-BatchSegmentJob-batchSegmentJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho do segmento em lote.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** creationDateTime **   <a name="personalize-Type-BatchSegmentJob-creationDateTime"></a>
A hora em que o trabalho do segmento em lote foi criado.  
Tipo: Timestamp  
Obrigatório: Não

 ** failureReason **   <a name="personalize-Type-BatchSegmentJob-failureReason"></a>
Se houver falha no trabalho do segmento em lote, o motivo da falha.  
Tipo: String  
Obrigatório: Não

 ** filterArn **   <a name="personalize-Type-BatchSegmentJob-filterArn"></a>
O ARN do filtro usado no trabalho do segmento em lote.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** jobInput **   <a name="personalize-Type-BatchSegmentJob-jobInput"></a>
O caminho do Amazon S3 que leva aos dados de entrada usados para gerar o trabalho do segmento em lote.  
Tipo: objeto [BatchSegmentJobInput](API_BatchSegmentJobInput.md)  
Obrigatório: Não

 ** jobName **   <a name="personalize-Type-BatchSegmentJob-jobName"></a>
O nome do trabalho do segmento em lote.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** jobOutput **   <a name="personalize-Type-BatchSegmentJob-jobOutput"></a>
O bucket do Amazon S3 que contém os dados de saída gerados pelo trabalho do segmento em lote.  
Tipo: objeto [BatchSegmentJobOutput](API_BatchSegmentJobOutput.md)  
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-BatchSegmentJob-lastUpdatedDateTime"></a>
A hora em que o trabalho do segmento em lote foi atualizado pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** numResults **   <a name="personalize-Type-BatchSegmentJob-numResults"></a>
O número de usuários previstos gerados pelo trabalho do segmento em lote para cada linha de dados de entrada. O número máximo de usuários por segmento é de 5 milhões.  
Tipo: inteiro  
Obrigatório: Não

 ** roleArn **   <a name="personalize-Type-BatchSegmentJob-roleArn"></a>
O ARN da função Amazon Identity and Access Management do perfil do IAM que solicitou o trabalho do segmento em lote.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Obrigatório: Não

 ** solutionVersionArn **   <a name="personalize-Type-BatchSegmentJob-solutionVersionArn"></a>
O nome do recurso da Amazon (ARN) da versão da solução usada pelo trabalho do segmento em lote para gerar segmentos em lote.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** status **   <a name="personalize-Type-BatchSegmentJob-status"></a>
O status do trabalho do segmento em lote. O status tem um dos valores a seguir:  
+ PENDING
+ IN PROGRESS
+ ACTIVE
+ CREATE FAILED
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_BatchSegmentJob_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchSegmentJob) 

# BatchSegmentJobInput
<a name="API_BatchSegmentJobInput"></a>

A configuração de entrada de um trabalho do segmento em lote.

## Conteúdo
<a name="API_BatchSegmentJobInput_Contents"></a>

 ** s3DataSource **   <a name="personalize-Type-BatchSegmentJobInput-s3DataSource"></a>
Os detalhes de configuração de um bucket de entrada ou saída do Amazon S3.  
Tipo: objeto [S3DataConfig](API_S3DataConfig.md)  
Obrigatório: Sim

## Consulte também
<a name="API_BatchSegmentJobInput_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJobInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJobInput) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchSegmentJobInput) 

# BatchSegmentJobOutput
<a name="API_BatchSegmentJobOutput"></a>

Os parâmetros de configuração de saída de um trabalho do segmento em lote.

## Conteúdo
<a name="API_BatchSegmentJobOutput_Contents"></a>

 ** s3DataDestination **   <a name="personalize-Type-BatchSegmentJobOutput-s3DataDestination"></a>
Os detalhes de configuração de um bucket de entrada ou saída do Amazon S3.  
Tipo: objeto [S3DataConfig](API_S3DataConfig.md)  
Obrigatório: Sim

## Consulte também
<a name="API_BatchSegmentJobOutput_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJobOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJobOutput) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchSegmentJobOutput) 

# BatchSegmentJobSummary
<a name="API_BatchSegmentJobSummary"></a>

Uma versão truncada do datatype [BatchInferenceJob](https://docs.aws.amazon.com/personalize/latest/dg/API_BatchSegmentJob.html). A operação [ListBatchSegmentJobs](https://docs.aws.amazon.com/personalize/latest/dg/API_ListBatchSegmentJobs.html) retorna uma lista de resumos de trabalhos do segmento em lote.

## Conteúdo
<a name="API_BatchSegmentJobSummary_Contents"></a>

 ** batchSegmentJobArn **   <a name="personalize-Type-BatchSegmentJobSummary-batchSegmentJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho do segmento em lote.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** creationDateTime **   <a name="personalize-Type-BatchSegmentJobSummary-creationDateTime"></a>
A hora em que o trabalho do segmento em lote foi criado.  
Tipo: Timestamp  
Obrigatório: Não

 ** failureReason **   <a name="personalize-Type-BatchSegmentJobSummary-failureReason"></a>
Se houver falha no trabalho do segmento em lote, o motivo da falha.  
Tipo: String  
Obrigatório: Não

 ** jobName **   <a name="personalize-Type-BatchSegmentJobSummary-jobName"></a>
O nome do trabalho do segmento em lote.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-BatchSegmentJobSummary-lastUpdatedDateTime"></a>
A hora em que o trabalho do segmento em lote foi atualizado pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** solutionVersionArn **   <a name="personalize-Type-BatchSegmentJobSummary-solutionVersionArn"></a>
O nome do recurso da Amazon (ARN) da versão da solução usada pelo trabalho do segmento em lote para gerar segmentos em lote.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** status **   <a name="personalize-Type-BatchSegmentJobSummary-status"></a>
O status do trabalho do segmento em lote. O status tem um dos valores a seguir:  
+ PENDING
+ IN PROGRESS
+ ACTIVE
+ CREATE FAILED
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_BatchSegmentJobSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJobSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchSegmentJobSummary) 

# Campaign
<a name="API_Campaign"></a>

Um objeto que descreve a implantação de uma versão da solução. Para obter mais informações sobre campanhas, consulte [CreateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html).

## Conteúdo
<a name="API_Campaign_Contents"></a>

 ** campaignArn **   <a name="personalize-Type-Campaign-campaignArn"></a>
O nome do recurso da Amazon (ARN) da campanha.   
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** campaignConfig **   <a name="personalize-Type-Campaign-campaignConfig"></a>
Os detalhes de configuração de uma campanha.  
Tipo: objeto [CampaignConfig](API_CampaignConfig.md)  
Obrigatório: Não

 ** creationDateTime **   <a name="personalize-Type-Campaign-creationDateTime"></a>
A data e a hora (no formato Unix) em que a campanha foi criada.  
Tipo: Timestamp  
Obrigatório: Não

 ** failureReason **   <a name="personalize-Type-Campaign-failureReason"></a>
Se uma campanha falhar, a razão por trás da falha.  
Tipo: String  
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-Campaign-lastUpdatedDateTime"></a>
A data e a hora (no formato Unix) em que a campanha foi atualizada pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** latestCampaignUpdate **   <a name="personalize-Type-Campaign-latestCampaignUpdate"></a>
Fornece um resumo das propriedades de uma atualização de campanha. Para obter uma lista completa, chame a API [DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html).  
O campo `latestCampaignUpdate` só é retornado quando a campanha teve pelo menos uma chamada `UpdateCampaign`. 
Tipo: objeto [CampaignUpdateSummary](API_CampaignUpdateSummary.md)  
Obrigatório: Não

 ** minProvisionedTPS **   <a name="personalize-Type-Campaign-minProvisionedTPS"></a>
Especifica as transações (recomendações) provisionadas mínimas solicitadas por segundo. Uma `minProvisionedTPS` alta aumentará sua conta. Recomendamos começar com 1 para `minProvisionedTPS` (o padrão). Monitore seu uso com as métricas do Amazon CloudWatch e aumente o `minProvisionedTPS` conforme necessário.  
Tipo: inteiro  
Intervalo válido: valor mínimo de 1.  
Obrigatório: Não

 ** name **   <a name="personalize-Type-Campaign-name"></a>
O nome da campanha.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** solutionVersionArn **   <a name="personalize-Type-Campaign-solutionVersionArn"></a>
O nome de recurso da Amazon (ARN) da versão da solução que a campanha usa.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** status **   <a name="personalize-Type-Campaign-status"></a>
O status da campanha.  
Uma campanha pode estar em um dos seguintes estados:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_Campaign_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Campaign) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Campaign) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Campaign) 

# CampaignConfig
<a name="API_CampaignConfig"></a>

Os detalhes de configuração de uma campanha.

## Conteúdo
<a name="API_CampaignConfig_Contents"></a>

 ** enableMetadataWithRecommendations **   <a name="personalize-Type-CampaignConfig-enableMetadataWithRecommendations"></a>
Se os metadados com recomendações estão ou não habilitados para a campanha. Se habilitada, será possível especificar as colunas do conjunto de dados de itens na solicitação de recomendações. O Amazon Personalize exibe esses dados para cada item na resposta da recomendação. Para obter informações sobre como habilitar metadados para uma campanha, consulte [Enabling metadata in recommendations for a campaign](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata).  
 Se você habilitar metadados nas recomendações, haverá custos adicionais. Para obter mais informações, consulte [Preços do Amazon Personalize](https://aws.amazon.com/personalize/pricing/).   
Tipo: booliano  
Obrigatório: não

 ** itemExplorationConfig **   <a name="personalize-Type-CampaignConfig-itemExplorationConfig"></a>
Especifica os hiperparâmetros de configuração de exploração, incluindo `explorationWeight` e `explorationItemAgeCutOff`, que você deseja usar para configurar a quantidade de exploração de itens que o Amazon Personalize usa ao recomendar itens. Forneça dados `itemExplorationConfig` somente se sua solução usar a fórmula de [User-Personalization](https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html).  
Tipo: mapa de string para string  
Entradas do mapa: número máximo de 100 itens.  
Restrições de tamanhos de chave: tamanho máximo de 256.  
Restrições de tamanho de valor: tamanho máximo de 1.000.  
Obrigatório: não

 ** rankingInfluence **   <a name="personalize-Type-CampaignConfig-rankingInfluence"></a>
Um mapa dos valores de influência do ranking para POPULARIDADE e FRESCOR. Para cada chave, especifique um valor numérico entre 0,0 e 1,0 que determine quanta influência esse fator de classificação tem nas recomendações finais. Um valor próximo de 1,0 dá mais peso ao fator, enquanto um valor próximo de 0,0 reduz sua influência. Se não for especificado, ambos assumem como padrão 0,0.  
Tipo: mapa de string para double  
Chaves válidas: `POPULARITY | FRESHNESS`   
Intervalo válido: valor mínimo de 0. Valor máximo de 1.  
Obrigatório: não

 ** syncWithLatestSolutionVersion **   <a name="personalize-Type-CampaignConfig-syncWithLatestSolutionVersion"></a>
Se a campanha é atualizada automaticamente para usar a versão da solução mais recente (modelo treinado) de uma solução. Se você especificar `True`, deverá especificar também o ARN da sua *solução* para o parâmetro `SolutionVersionArn`. Deve estar no formato `SolutionArn/$LATEST`. O padrão é `False`, e você deve atualizar manualmente a campanha para implantar a versão mais recente da solução.   
 Para obter informações sobre as atualizações automáticas das campanhas, consulte [Habilitar as atualizações de campanha automáticas](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update).   
Tipo: booliano  
Obrigatório: não

## Consulte também
<a name="API_CampaignConfig_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWSSDKs, consulte o seguinte:
+  [AWSSDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CampaignConfig) 
+  [AWSSDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CampaignConfig) 
+  [AWSSDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CampaignConfig) 

# CampaignSummary
<a name="API_CampaignSummary"></a>

Fornece um resumo das propriedades da campanha. Para obter uma lista completa, chame a API [DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html).

## Conteúdo
<a name="API_CampaignSummary_Contents"></a>

 ** campaignArn **   <a name="personalize-Type-CampaignSummary-campaignArn"></a>
O nome do recurso da Amazon (ARN) da campanha.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** creationDateTime **   <a name="personalize-Type-CampaignSummary-creationDateTime"></a>
A data e a hora (no horário Unix) em que a campanha foi criada.  
Tipo: Timestamp  
Obrigatório: Não

 ** failureReason **   <a name="personalize-Type-CampaignSummary-failureReason"></a>
Se uma campanha falhar, a razão por trás da falha.  
Tipo: String  
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-CampaignSummary-lastUpdatedDateTime"></a>
A data e a hora (no horário do Unix) em que a campanha foi atualizada pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** name **   <a name="personalize-Type-CampaignSummary-name"></a>
O nome da campanha.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** status **   <a name="personalize-Type-CampaignSummary-status"></a>
O status da campanha.  
Uma campanha pode estar em um dos seguintes estados:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_CampaignSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CampaignSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CampaignSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CampaignSummary) 

# CampaignUpdateSummary
<a name="API_CampaignUpdateSummary"></a>

Fornece um resumo das propriedades de uma atualização de campanha. Para obter uma lista completa, chame a API [DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html).

## Conteúdo
<a name="API_CampaignUpdateSummary_Contents"></a>

 ** campaignConfig **   <a name="personalize-Type-CampaignUpdateSummary-campaignConfig"></a>
Os detalhes de configuração de uma campanha.  
Tipo: objeto [CampaignConfig](API_CampaignConfig.md)  
Obrigatório: Não

 ** creationDateTime **   <a name="personalize-Type-CampaignUpdateSummary-creationDateTime"></a>
A data e a hora (no horário Unix) em que a atualização da campanha foi criada.  
Tipo: Timestamp  
Obrigatório: Não

 ** failureReason **   <a name="personalize-Type-CampaignUpdateSummary-failureReason"></a>
Se uma atualização da campanha falhar, o motivo da falha.  
Tipo: String  
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-CampaignUpdateSummary-lastUpdatedDateTime"></a>
A data e hora (no horário Unix) em que a atualização da campanha foi atualizada pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** minProvisionedTPS **   <a name="personalize-Type-CampaignUpdateSummary-minProvisionedTPS"></a>
Especifica o mínimo de transações provisionadas (recomendações) solicitadas por segundo para o qual o Amazon Personalize oferecerá suporte.  
Tipo: inteiro  
Intervalo válido: valor mínimo de 1.  
Obrigatório: Não

 ** solutionVersionArn **   <a name="personalize-Type-CampaignUpdateSummary-solutionVersionArn"></a>
O nome do recurso da Amazon (ARN) da versão da solução implantada.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** status **   <a name="personalize-Type-CampaignUpdateSummary-status"></a>
O status da atualização da campanha.  
Uma atualização de campanha pode estar em um dos seguintes estados:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_CampaignUpdateSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CampaignUpdateSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CampaignUpdateSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CampaignUpdateSummary) 

# CategoricalHyperParameterRange
<a name="API_CategoricalHyperParameterRange"></a>

Fornece o nome e o intervalo de um hiperparâmetro categórico.

## Conteúdo
<a name="API_CategoricalHyperParameterRange_Contents"></a>

 ** name **   <a name="personalize-Type-CategoricalHyperParameterRange-name"></a>
O nome do hiperparâmetro.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

 ** values **   <a name="personalize-Type-CategoricalHyperParameterRange-values"></a>
Uma lista das categorias do hiperparâmetro.  
Tipo: matriz de strings  
Membros da matriz: número máximo de 100 itens.  
Restrições de tamanho: tamanho máximo de 1000.  
Obrigatório: Não

## Consulte também
<a name="API_CategoricalHyperParameterRange_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CategoricalHyperParameterRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CategoricalHyperParameterRange) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CategoricalHyperParameterRange) 

# ContinuousHyperParameterRange
<a name="API_ContinuousHyperParameterRange"></a>

Fornece o nome e o intervalo de um hiperparâmetro contínuo.

## Conteúdo
<a name="API_ContinuousHyperParameterRange_Contents"></a>

 ** maxValue **   <a name="personalize-Type-ContinuousHyperParameterRange-maxValue"></a>
O valor máximo permitido para o hiperparâmetro.  
Tipo: duplo  
Intervalo válido: valor mínimo de -1.000.000.  
Obrigatório: Não

 ** minValue **   <a name="personalize-Type-ContinuousHyperParameterRange-minValue"></a>
O valor mínimo permitido para o hiperparâmetro.  
Tipo: duplo  
Intervalo válido: valor mínimo de -1.000.000.  
Obrigatório: Não

 ** name **   <a name="personalize-Type-ContinuousHyperParameterRange-name"></a>
O nome do hiperparâmetro.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_ContinuousHyperParameterRange_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ContinuousHyperParameterRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ContinuousHyperParameterRange) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ContinuousHyperParameterRange) 

# DataDeletionJob
<a name="API_DataDeletionJob"></a>

Descreve um trabalho que exclui todas as referências a usuários específicos de um grupo de conjuntos de dados do Amazon Personalize em lotes. Para obter mais informações sobre como criar um trabalho de exclusão de dados, consulte [Excluir usuários](https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html).

## Conteúdo
<a name="API_DataDeletionJob_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DataDeletionJob-creationDateTime"></a>
A data e a hora de criação (no horário do Unix) do trabalho de exclusão de dados.  
Tipo: Timestamp  
Obrigatório: Não

 ** dataDeletionJobArn **   <a name="personalize-Type-DataDeletionJob-dataDeletionJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de exclusão de dados.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** datasetGroupArn **   <a name="personalize-Type-DataDeletionJob-datasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do grupo de conjuntos de dados contendo os registros a serem excluídos.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** dataSource **   <a name="personalize-Type-DataDeletionJob-dataSource"></a>
Descreve a fonte de dados que contém os dados a serem carregados em um conjunto de dados ou a lista de registros a serem excluídos do Amazon Personalize.  
Tipo: objeto [DataSource](API_DataSource.md)  
Obrigatório: Não

 ** failureReason **   <a name="personalize-Type-DataDeletionJob-failureReason"></a>
Se o trabalho de exclusão de dados falhar, informe o motivo.  
Tipo: String  
Obrigatório: Não

 ** jobName **   <a name="personalize-Type-DataDeletionJob-jobName"></a>
O nome do trabalho de exclusão de dados.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-DataDeletionJob-lastUpdatedDateTime"></a>
A data e a hora (no horário do Unix) em que o trabalho de exclusão de dados foi atualizado pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** numDeleted **   <a name="personalize-Type-DataDeletionJob-numDeleted"></a>
O número de registros excluídos por um trabalho Concluído.  
Tipo: inteiro  
Obrigatório: Não

 ** roleArn **   <a name="personalize-Type-DataDeletionJob-roleArn"></a>
O nome do recurso da Amazon (ARN) do perfil do IAM que tem permissão para ler a fonte de dados do Amazon S3.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Obrigatório: Não

 ** status **   <a name="personalize-Type-DataDeletionJob-status"></a>
O status do trabalho de exclusão de dados.  
Um trabalho de exclusão de dados pode ter um dos seguintes status:  
+ PENDENTE > EM ANDAMENTO > CONCLUÍDO -ou- FALHA
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_DataDeletionJob_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DataDeletionJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DataDeletionJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DataDeletionJob) 

# DataDeletionJobSummary
<a name="API_DataDeletionJobSummary"></a>

Fornece um resumo das propriedades de um trabalho de exclusão de dados. Para obter uma lista completa, chame a operação da API [DescribeDataDeletionJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html).

## Conteúdo
<a name="API_DataDeletionJobSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DataDeletionJobSummary-creationDateTime"></a>
A data e a hora de criação (no horário do Unix) do trabalho de exclusão de dados.  
Tipo: Timestamp  
Obrigatório: Não

 ** dataDeletionJobArn **   <a name="personalize-Type-DataDeletionJobSummary-dataDeletionJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de exclusão de dados.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** datasetGroupArn **   <a name="personalize-Type-DataDeletionJobSummary-datasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do grupo de conjuntos de dados contendo os registros do trabalho excluídos.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** failureReason **   <a name="personalize-Type-DataDeletionJobSummary-failureReason"></a>
Se o trabalho de exclusão de dados falhar, informe o motivo.  
Tipo: String  
Obrigatório: Não

 ** jobName **   <a name="personalize-Type-DataDeletionJobSummary-jobName"></a>
O nome do trabalho de exclusão de dados.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-DataDeletionJobSummary-lastUpdatedDateTime"></a>
A data e a hora (no horário do Unix) em que o trabalho de exclusão de dados foi atualizado pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** status **   <a name="personalize-Type-DataDeletionJobSummary-status"></a>
O status do trabalho de exclusão de dados.  
Um trabalho de exclusão de dados pode ter um dos seguintes status:  
+ PENDENTE > EM ANDAMENTO > CONCLUÍDO -ou- FALHA
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_DataDeletionJobSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DataDeletionJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DataDeletionJobSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DataDeletionJobSummary) 

# Dataset
<a name="API_Dataset"></a>

Fornece metadados para um conjunto de dados.

## Conteúdo
<a name="API_Dataset_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-Dataset-creationDateTime"></a>
A data e a hora de criação (no horário do Unix) do conjunto de dados.  
Tipo: Timestamp  
Obrigatório: não

 ** datasetArn **   <a name="personalize-Type-Dataset-datasetArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados para o qual você deseja metadados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** datasetGroupArn **   <a name="personalize-Type-Dataset-datasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do grupo de conjuntos de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** datasetType **   <a name="personalize-Type-Dataset-datasetType"></a>
Um dos seguintes valores:  
+ Interações
+ Itens
+ Usuários
+ Ações
+ Action\$1Interactions
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `^[A-Za-z_]+$`   
Obrigatório: não

 ** lastUpdatedDateTime **   <a name="personalize-Type-Dataset-lastUpdatedDateTime"></a>
Um registro de data e hora que mostra quando o conjunto de dados foi atualizado.  
Tipo: Timestamp  
Obrigatório: não

 ** latestDatasetUpdate **   <a name="personalize-Type-Dataset-latestDatasetUpdate"></a>
Descreve a última atualização do conjunto de dados.  
Tipo: objeto [DatasetUpdateSummary](API_DatasetUpdateSummary.md)  
Obrigatório: não

 ** name **   <a name="personalize-Type-Dataset-name"></a>
O nome do conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: não

 ** schemaArn **   <a name="personalize-Type-Dataset-schemaArn"></a>
O ARN do esquema associado.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** status **   <a name="personalize-Type-Dataset-status"></a>
O status do conjunto de dados.  
Um conjunto de dados pode estar em um dos seguintes estados:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -ou- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: não

 ** trackingId **   <a name="personalize-Type-Dataset-trackingId"></a>
O ID do rastreador de eventos para um conjunto de dados de interações com ações. Você deve especificar o ID do rastreador na operação de API `PutActionInteractions`. O Amazon Personalize o utiliza para direcionar novos dados para o conjunto de dados de interações com ações no grupo de conjuntos de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_Dataset_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWSSDKs, consulte o seguinte:
+  [AWSSDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Dataset) 
+  [AWSSDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Dataset) 
+  [AWSSDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Dataset) 

# DatasetExportJob
<a name="API_DatasetExportJob"></a>

Descreve um trabalho que exporta um conjunto de dados para um bucket do Amazon S3. Para obter mais informações, consulte [CreateDatasetExportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html).

Um trabalho de exportação do conjunto de dados pode estar em um dos seguintes estados:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE ou CREATE FAILED

## Conteúdo
<a name="API_DatasetExportJob_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetExportJob-creationDateTime"></a>
A data e a hora de criação (no horário do Unix) do trabalho de exportação do conjunto de dados.  
Tipo: Timestamp  
Obrigatório: Não

 ** datasetArn **   <a name="personalize-Type-DatasetExportJob-datasetArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados a ser exportado.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** datasetExportJobArn **   <a name="personalize-Type-DatasetExportJob-datasetExportJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de exportação do conjunto de dados.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** failureReason **   <a name="personalize-Type-DatasetExportJob-failureReason"></a>
Se o trabalho de exportação do conjunto de dados falhar, forneça o motivo.  
Tipo: String  
Obrigatório: Não

 ** ingestionMode **   <a name="personalize-Type-DatasetExportJob-ingestionMode"></a>
Os dados a serem exportados, com base em como você importou os dados. Você pode optar por exportar dados `BULK` importados usando um trabalho de importação do conjunto de dados, dados `PUT` importados de forma incremental (usando o console, as operações PutEvents, PutUsers e PutItems) ou `ALL` para os dois tipos. O valor padrão é `PUT`.   
Tipo: string  
Valores Válidos: `BULK | PUT | ALL`   
Obrigatório: Não

 ** jobName **   <a name="personalize-Type-DatasetExportJob-jobName"></a>
O nome do trabalho de exportação.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** jobOutput **   <a name="personalize-Type-DatasetExportJob-jobOutput"></a>
O caminho do bucket do Amazon S3 no qual a saída do trabalho é armazenada. Por exemplo:  
 `s3://bucket-name/folder-name/`   
Tipo: objeto [DatasetExportJobOutput](API_DatasetExportJobOutput.md)  
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetExportJob-lastUpdatedDateTime"></a>
A data e hora (no horário do Unix) em que o status do trabalho de exportação do conjunto de dados foi atualizado pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** roleArn **   <a name="personalize-Type-DatasetExportJob-roleArn"></a>
O nome do recurso da Amazon (ARN) de um perfil de serviço do IAM com permissões para adicionar dados ao bucket do Amazon S3 de saída.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** status **   <a name="personalize-Type-DatasetExportJob-status"></a>
O status do trabalho de exportação do conjunto de dados.  
Um trabalho de exportação do conjunto de dados pode estar em um dos seguintes estados:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE ou CREATE FAILED
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_DatasetExportJob_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetExportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetExportJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetExportJob) 

# DatasetExportJobOutput
<a name="API_DatasetExportJobOutput"></a>

Os parâmetros de configuração de saída de um trabalho de exportação do conjunto de dados.

## Conteúdo
<a name="API_DatasetExportJobOutput_Contents"></a>

 ** s3DataDestination **   <a name="personalize-Type-DatasetExportJobOutput-s3DataDestination"></a>
Os detalhes de configuração de um bucket de entrada ou saída do Amazon S3.  
Tipo: objeto [S3DataConfig](API_S3DataConfig.md)  
Obrigatório: Sim

## Consulte também
<a name="API_DatasetExportJobOutput_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetExportJobOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetExportJobOutput) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetExportJobOutput) 

# DatasetExportJobSummary
<a name="API_DatasetExportJobSummary"></a>

Fornece um resumo das propriedades de um trabalho de exportação do conjunto de dados. Para obter uma lista completa, chame a API [DescribeDatasetExportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html).

## Conteúdo
<a name="API_DatasetExportJobSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetExportJobSummary-creationDateTime"></a>
A data e a hora (no horário do Unix) em que o trabalho de exportação do conjunto de dados foi criado.  
Tipo: Timestamp  
Obrigatório: Não

 ** datasetExportJobArn **   <a name="personalize-Type-DatasetExportJobSummary-datasetExportJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de exportação do conjunto de dados.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** failureReason **   <a name="personalize-Type-DatasetExportJobSummary-failureReason"></a>
Se um trabalho de exportação do conjunto de dados falhar, o motivo da falha.  
Tipo: String  
Obrigatório: Não

 ** jobName **   <a name="personalize-Type-DatasetExportJobSummary-jobName"></a>
O nome do trabalho de exportação do conjunto de dados.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetExportJobSummary-lastUpdatedDateTime"></a>
A data e hora (no horário do Unix) em que o status do trabalho de exportação do conjunto de dados foi atualizado pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** status **   <a name="personalize-Type-DatasetExportJobSummary-status"></a>
O status do trabalho de exportação do conjunto de dados.  
Um trabalho de exportação do conjunto de dados pode estar em um dos seguintes estados:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE ou CREATE FAILED
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_DatasetExportJobSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetExportJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetExportJobSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetExportJobSummary) 

# DatasetGroup
<a name="API_DatasetGroup"></a>

Grupo de conjuntos de dados é uma coleção de conjuntos de dados relacionados (interações com itens, usuários, itens, ações, interações com ações). Você crie um grupo de conjuntos de dados chamando [CreateDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html). Em seguida, cria um conjunto de dados e o adiciona a um grupo de conjuntos de dados chamando [CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html). O grupo de conjuntos de dados é utilizado para criar e treinar uma solução, chamando [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html). Um grupo de conjuntos de dados só pode conter um de cada tipo de conjunto de dados.

É possível especificar uma chave do AWS Key Management Service (KMS) para criptografar os conjuntos de dados no grupo.

## Conteúdo
<a name="API_DatasetGroup_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetGroup-creationDateTime"></a>
A data e a hora de criação (no horário do Unix) do grupo do conjunto de dados.  
Tipo: Timestamp  
Obrigatório: Não

 ** datasetGroupArn **   <a name="personalize-Type-DatasetGroup-datasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do grupo de conjuntos de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** domain **   <a name="personalize-Type-DatasetGroup-domain"></a>
O domínio de um grupo de conjuntos de dados de domínio.  
Tipo: String  
Valores Válidos: `ECOMMERCE | VIDEO_ON_DEMAND`   
Obrigatório: Não

 ** failureReason **   <a name="personalize-Type-DatasetGroup-failureReason"></a>
Se a criação de um grupo de conjunto de dados falhar, forneça o motivo.  
Tipo: String  
Obrigatório: Não

 ** kmsKeyArn **   <a name="personalize-Type-DatasetGroup-kmsKeyArn"></a>
O nome do recurso da Amazon (ARN) da chave do AWS Key Management Service (KMS) a ser utilizada para criptografar os conjuntos de dados.  
Tipo: String  
Restrições de tamanho: tamanho máximo de 2048.  
Padrão: : `arn:aws.*:kms:.*:[0-9]{12}:key/.*`   
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetGroup-lastUpdatedDateTime"></a>
A data e a hora da última atualização (no horário do Unix) do grupo do conjunto de dados.  
Tipo: Timestamp  
Obrigatório: Não

 ** name **   <a name="personalize-Type-DatasetGroup-name"></a>
O nome do grupo de conjuntos de dados.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** roleArn **   <a name="personalize-Type-DatasetGroup-roleArn"></a>
O ARN do perfil do IAM do AWS Identity and Access Management que tem permissões para acessar a chave AWS Key Management Service (KMS). O fornecimento de um perfil do IAM só é válido quando também se especifica uma chave KMS.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Obrigatório: Não

 ** status **   <a name="personalize-Type-DatasetGroup-status"></a>
O status atual do grupo do conjunto de dados.  
Um grupo de conjuntos de dados pode estar em um dos seguintes estados:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_DatasetGroup_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetGroup) 

# DatasetGroupSummary
<a name="API_DatasetGroupSummary"></a>

Fornece um resumo das propriedades do grupo do conjunto de dados. Para obter uma lista completa, chame a API [DescribeDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html).

## Conteúdo
<a name="API_DatasetGroupSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetGroupSummary-creationDateTime"></a>
A data e a hora (no horário do Unix) em que o grupo do conjunto de dados foi criado.  
Tipo: Timestamp  
Obrigatório: Não

 ** datasetGroupArn **   <a name="personalize-Type-DatasetGroupSummary-datasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do grupo de conjuntos de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** domain **   <a name="personalize-Type-DatasetGroupSummary-domain"></a>
O domínio de um grupo de conjuntos de dados de domínio.  
Tipo: String  
Valores Válidos: `ECOMMERCE | VIDEO_ON_DEMAND`   
Obrigatório: Não

 ** failureReason **   <a name="personalize-Type-DatasetGroupSummary-failureReason"></a>
Se a criação de um grupo do conjunto de dados falhar, o motivo da falha.  
Tipo: String  
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetGroupSummary-lastUpdatedDateTime"></a>
A data e a hora (no horário do Unix) em que o grupo do conjunto de dados foi atualizado pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** name **   <a name="personalize-Type-DatasetGroupSummary-name"></a>
O nome do grupo de conjuntos de dados.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** status **   <a name="personalize-Type-DatasetGroupSummary-status"></a>
O status do grupo do conjunto de dados.  
Um grupo de conjuntos de dados pode estar em um dos seguintes estados:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_DatasetGroupSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetGroupSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetGroupSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetGroupSummary) 

# DatasetImportJob
<a name="API_DatasetImportJob"></a>

Descreve um trabalho que importa dados de treinamento de uma fonte de dados (bucket do Amazon S3) para um conjunto de dados do Amazon Personalize. Para obter mais informações, consulte [CreateDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html).

Um trabalho de importação do conjunto de dados pode estar em um dos seguintes estados:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE ou CREATE FAILED

## Conteúdo
<a name="API_DatasetImportJob_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetImportJob-creationDateTime"></a>
A data e a hora de criação (no horário do Unix) do trabalho de importação do conjunto de dados.  
Tipo: Timestamp  
Obrigatório: Não

 ** datasetArn **   <a name="personalize-Type-DatasetImportJob-datasetArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados que recebe os dados importados.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** datasetImportJobArn **   <a name="personalize-Type-DatasetImportJob-datasetImportJobArn"></a>
O ARN do trabalho de importação do conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** dataSource **   <a name="personalize-Type-DatasetImportJob-dataSource"></a>
O bucket do Amazon S3 que contém os dados de treinamento a importar.  
Tipo: objeto [DataSource](API_DataSource.md)  
Obrigatório: Não

 ** failureReason **   <a name="personalize-Type-DatasetImportJob-failureReason"></a>
Se o trabalho de importação do conjunto de dados falhar, forneça o motivo.  
Tipo: String  
Obrigatório: Não

 ** importMode **   <a name="personalize-Type-DatasetImportJob-importMode"></a>
O modo de importação usado pelo trabalho de importação do conjunto de dados para importar novos registros.  
Tipo: String  
Valores Válidos: `FULL | INCREMENTAL`   
Obrigatório: Não

 ** jobName **   <a name="personalize-Type-DatasetImportJob-jobName"></a>
O nome do trabalho de importação.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetImportJob-lastUpdatedDateTime"></a>
A data e a hora (no horário do Unix) em que o conjunto de dados foi atualizado pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** publishAttributionMetricsToS3 **   <a name="personalize-Type-DatasetImportJob-publishAttributionMetricsToS3"></a>
Se o trabalho publica métricas no Amazon S3 para uma atribuição métrica.  
Tipo: booliano  
Obrigatório: Não

 ** roleArn **   <a name="personalize-Type-DatasetImportJob-roleArn"></a>
O ARN do perfil do IAM que tem permissão para ler a fonte de dados do Amazon S3.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** status **   <a name="personalize-Type-DatasetImportJob-status"></a>
O status do trabalho de importação do conjunto de dados.  
Um trabalho de importação do conjunto de dados pode estar em um dos seguintes estados:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_DatasetImportJob_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetImportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetImportJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetImportJob) 

# DatasetImportJobSummary
<a name="API_DatasetImportJobSummary"></a>

Fornece um resumo das propriedades do trabalho de importação do conjunto de dados. Para obter uma lista completa, chame a API [DescribeDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html).

## Conteúdo
<a name="API_DatasetImportJobSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetImportJobSummary-creationDateTime"></a>
A data e a hora (no horário do Unix) em que o trabalho de importação do conjunto de dados foi criado.  
Tipo: Timestamp  
Obrigatório: Não

 ** datasetImportJobArn **   <a name="personalize-Type-DatasetImportJobSummary-datasetImportJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de importação de conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** failureReason **   <a name="personalize-Type-DatasetImportJobSummary-failureReason"></a>
Se o trabalho de importação do conjunto de dados falhar, o motivo da falha.  
Tipo: String  
Obrigatório: Não

 ** importMode **   <a name="personalize-Type-DatasetImportJobSummary-importMode"></a>
O modo de importação que o trabalho de importação do conjunto de dados usou para atualizar os dados no conjunto de dados. Para obter mais informações, consulte [Atualização dos dados em massa existentes](https://docs.aws.amazon.com/personalize/latest/dg/updating-existing-bulk-data.html).   
Tipo: String  
Valores Válidos: `FULL | INCREMENTAL`   
Obrigatório: Não

 ** jobName **   <a name="personalize-Type-DatasetImportJobSummary-jobName"></a>
O nome do trabalho de importação do conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetImportJobSummary-lastUpdatedDateTime"></a>
A data e hora (no horário do Unix) em que o status do trabalho de importação do conjunto de dados foi atualizado pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** status **   <a name="personalize-Type-DatasetImportJobSummary-status"></a>
O status do trabalho de importação do conjunto de dados.  
Um trabalho de importação do conjunto de dados pode estar em um dos seguintes estados:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_DatasetImportJobSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetImportJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetImportJobSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetImportJobSummary) 

# DatasetSchema
<a name="API_DatasetSchema"></a>

Descreve o esquema de um conjunto de dados. Para obter mais informações sobre esquemas, consulte [CreateSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html).

## Conteúdo
<a name="API_DatasetSchema_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetSchema-creationDateTime"></a>
A data e a hora (no horário do Unix) em que o esquema foi criado.  
Tipo: Timestamp  
Obrigatório: Não

 ** domain **   <a name="personalize-Type-DatasetSchema-domain"></a>
O domínio de um esquema criado para um conjunto de dados em um grupo de conjuntos de dados de domínio.  
Tipo: String  
Valores Válidos: `ECOMMERCE | VIDEO_ON_DEMAND`   
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetSchema-lastUpdatedDateTime"></a>
A data e a hora (no horário do Unix) em que o esquema foi atualizado pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** name **   <a name="personalize-Type-DatasetSchema-name"></a>
O nome do esquema.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** schema **   <a name="personalize-Type-DatasetSchema-schema"></a>
O esquema.  
Tipo: String  
Restrições de tamanho: tamanho máximo de 20 mil.  
Obrigatório: Não

 ** schemaArn **   <a name="personalize-Type-DatasetSchema-schemaArn"></a>
O nome de recurso da Amazon (ARN) do esquema.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

## Consulte também
<a name="API_DatasetSchema_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetSchema) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetSchema) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetSchema) 

# DatasetSchemaSummary
<a name="API_DatasetSchemaSummary"></a>

Fornece um resumo das propriedades do esquema do conjunto de dados. Para obter uma lista completa, chame a API [DescribeSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html).

## Conteúdo
<a name="API_DatasetSchemaSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetSchemaSummary-creationDateTime"></a>
A data e a hora (no horário do Unix) em que o esquema foi criado.  
Tipo: Timestamp  
Obrigatório: Não

 ** domain **   <a name="personalize-Type-DatasetSchemaSummary-domain"></a>
O domínio de um esquema criado para um conjunto de dados em um grupo de conjuntos de dados de domínio.  
Tipo: String  
Valores Válidos: `ECOMMERCE | VIDEO_ON_DEMAND`   
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetSchemaSummary-lastUpdatedDateTime"></a>
A data e a hora (no horário do Unix) em que o esquema foi atualizado pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** name **   <a name="personalize-Type-DatasetSchemaSummary-name"></a>
O nome do esquema.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** schemaArn **   <a name="personalize-Type-DatasetSchemaSummary-schemaArn"></a>
O nome de recurso da Amazon (ARN) do esquema.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

## Consulte também
<a name="API_DatasetSchemaSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetSchemaSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetSchemaSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetSchemaSummary) 

# DatasetSummary
<a name="API_DatasetSummary"></a>

Fornece um resumo das propriedades de um conjunto de dados. Para obter uma listagem completa, chame a [DescribeDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html)API.

## Conteúdo
<a name="API_DatasetSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetSummary-creationDateTime"></a>
A data e a hora (no horário do Unix) em que o conjunto de dados foi criado.  
Tipo: Timestamp  
Obrigatório: não

 ** datasetArn **   <a name="personalize-Type-DatasetSummary-datasetArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** datasetType **   <a name="personalize-Type-DatasetSummary-datasetType"></a>
O tipo de conjunto de dados. Um dos seguintes valores:  
+ Interações
+ Itens
+ Usuários
+ Event-Interactions
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `^[A-Za-z_]+$`   
Obrigatório: não

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetSummary-lastUpdatedDateTime"></a>
A data e a hora (no horário do Unix) em que o conjunto de dados foi atualizado pela última vez.  
Tipo: Timestamp  
Obrigatório: não

 ** name **   <a name="personalize-Type-DatasetSummary-name"></a>
O nome do conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: não

 ** status **   <a name="personalize-Type-DatasetSummary-status"></a>
O status do conjunto de dados.  
Um conjunto de dados pode estar em um dos seguintes estados:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -ou- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_DatasetSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWSSDKs, consulte o seguinte:
+  [AWSSDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetSummary) 
+  [AWSSDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetSummary) 
+  [AWSSDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetSummary) 

# DatasetUpdateSummary
<a name="API_DatasetUpdateSummary"></a>

Descreve uma atualização para um conjunto de dados.

## Conteúdo
<a name="API_DatasetUpdateSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetUpdateSummary-creationDateTime"></a>
A data e a hora de criação (no horário do Unix) da atualização do conjunto de dados.  
Tipo: Timestamp  
Obrigatório: Não

 ** failureReason **   <a name="personalize-Type-DatasetUpdateSummary-failureReason"></a>
Se a atualização de um conjunto de dados falhar, forneça o motivo.  
Tipo: String  
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetUpdateSummary-lastUpdatedDateTime"></a>
A data e a hora da última atualização (no horário do Unix) do conjunto de dados.  
Tipo: Timestamp  
Obrigatório: Não

 ** schemaArn **   <a name="personalize-Type-DatasetUpdateSummary-schemaArn"></a>
O Nome do Recurso da Amazon (ARN) do esquema que substituiu o esquema anterior do conjunto de dados.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** status **   <a name="personalize-Type-DatasetUpdateSummary-status"></a>
O status da atualização do conjunto de dados.   
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_DatasetUpdateSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetUpdateSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetUpdateSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetUpdateSummary) 

# DataSource
<a name="API_DataSource"></a>

Descreve a fonte de dados que contém os dados a serem carregados em um conjunto de dados ou a lista de registros a serem excluídos do Amazon Personalize.

## Conteúdo
<a name="API_DataSource_Contents"></a>

 ** dataLocation **   <a name="personalize-Type-DataSource-dataLocation"></a>
Para os trabalhos de importação de conjuntos de dados, o caminho para o bucket do Amazon S3 em que os dados que você quer carregar no conjunto de dados estão armazenados. Para trabalhos de exclusão de dados, o caminho para o bucket do Amazon S3 que armazena a lista de registros a serem excluídos.   
 Por exemplo:   
 `s3://bucket-name/folder-name/fileName.csv`   
Se seus arquivos CSV estiverem em uma pasta no bucket do Amazon S3 e você quiser que seu trabalho de importação ou exclusão de dados considere vários arquivos, especifique o caminho da pasta. Com um trabalho de exclusão de dados, o Amazon Personalize usa todos os arquivos da pasta e de qualquer subpasta. Use a sintaxe a seguir com uma `/` após o nome da pasta:  
 `s3://bucket-name/folder-name/`   
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `(s3|http|https)://.+`   
Obrigatório: Não

## Consulte também
<a name="API_DataSource_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DataSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DataSource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DataSource) 

# DefaultCategoricalHyperParameterRange
<a name="API_DefaultCategoricalHyperParameterRange"></a>

Fornece o nome e o intervalo padrão de um hiperparâmetro categórico e se o hiperparâmetro é ajustável. Um hiperparâmetro ajustável pode ter seu valor determinado durante a otimização do hiperparâmetro (HPO).

## Conteúdo
<a name="API_DefaultCategoricalHyperParameterRange_Contents"></a>

 ** isTunable **   <a name="personalize-Type-DefaultCategoricalHyperParameterRange-isTunable"></a>
Se o hiperparâmetro é ajustável.  
Tipo: booliano  
Obrigatório: Não

 ** name **   <a name="personalize-Type-DefaultCategoricalHyperParameterRange-name"></a>
O nome do hiperparâmetro.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

 ** values **   <a name="personalize-Type-DefaultCategoricalHyperParameterRange-values"></a>
Uma lista das categorias do hiperparâmetro.  
Tipo: matriz de strings  
Membros da matriz: número máximo de 100 itens.  
Restrições de tamanho: tamanho máximo de 1000.  
Obrigatório: Não

## Consulte também
<a name="API_DefaultCategoricalHyperParameterRange_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DefaultCategoricalHyperParameterRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DefaultCategoricalHyperParameterRange) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DefaultCategoricalHyperParameterRange) 

# DefaultContinuousHyperParameterRange
<a name="API_DefaultContinuousHyperParameterRange"></a>

Fornece o nome e o intervalo padrão de um hiperparâmetro contínuo e se o hiperparâmetro é ajustável. Um hiperparâmetro ajustável pode ter seu valor determinado durante a otimização do hiperparâmetro (HPO).

## Conteúdo
<a name="API_DefaultContinuousHyperParameterRange_Contents"></a>

 ** isTunable **   <a name="personalize-Type-DefaultContinuousHyperParameterRange-isTunable"></a>
Se o hiperparâmetro é ajustável.  
Tipo: booliano  
Obrigatório: Não

 ** maxValue **   <a name="personalize-Type-DefaultContinuousHyperParameterRange-maxValue"></a>
O valor máximo permitido para o hiperparâmetro.  
Tipo: duplo  
Intervalo válido: valor mínimo de -1.000.000.  
Obrigatório: Não

 ** minValue **   <a name="personalize-Type-DefaultContinuousHyperParameterRange-minValue"></a>
O valor mínimo permitido para o hiperparâmetro.  
Tipo: duplo  
Intervalo válido: valor mínimo de -1.000.000.  
Obrigatório: Não

 ** name **   <a name="personalize-Type-DefaultContinuousHyperParameterRange-name"></a>
O nome do hiperparâmetro.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_DefaultContinuousHyperParameterRange_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DefaultContinuousHyperParameterRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DefaultContinuousHyperParameterRange) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DefaultContinuousHyperParameterRange) 

# DefaultHyperParameterRanges
<a name="API_DefaultHyperParameterRanges"></a>

Especifica os hiperparâmetros e seus intervalos padrão. Os hiperparâmetros podem ser categóricos, contínuos ou de valor inteiro.

## Conteúdo
<a name="API_DefaultHyperParameterRanges_Contents"></a>

 ** categoricalHyperParameterRanges **   <a name="personalize-Type-DefaultHyperParameterRanges-categoricalHyperParameterRanges"></a>
Os hiperparâmetros categóricos e seus intervalos padrão.  
Tipo: matriz de objetos [DefaultCategoricalHyperParameterRange](API_DefaultCategoricalHyperParameterRange.md)  
Membros da matriz: número máximo de 100 itens.  
Obrigatório: Não

 ** continuousHyperParameterRanges **   <a name="personalize-Type-DefaultHyperParameterRanges-continuousHyperParameterRanges"></a>
Os hiperparâmetros contínuos e seus intervalos padrão.  
Tipo: matriz de objetos [DefaultContinuousHyperParameterRange](API_DefaultContinuousHyperParameterRange.md)  
Membros da matriz: número máximo de 100 itens.  
Obrigatório: Não

 ** integerHyperParameterRanges **   <a name="personalize-Type-DefaultHyperParameterRanges-integerHyperParameterRanges"></a>
Os hiperparâmetros de valor inteiro e seus intervalos padrão.  
Tipo: matriz de objetos [DefaultIntegerHyperParameterRange](API_DefaultIntegerHyperParameterRange.md)  
Membros da matriz: número máximo de 100 itens.  
Obrigatório: Não

## Consulte também
<a name="API_DefaultHyperParameterRanges_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DefaultHyperParameterRanges) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DefaultHyperParameterRanges) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DefaultHyperParameterRanges) 

# DefaultIntegerHyperParameterRange
<a name="API_DefaultIntegerHyperParameterRange"></a>

Fornece o nome e o intervalo padrão de um hiperparâmetro de valor inteiro e se o hiperparâmetro é ajustável. Um hiperparâmetro ajustável pode ter seu valor determinado durante a otimização do hiperparâmetro (HPO).

## Conteúdo
<a name="API_DefaultIntegerHyperParameterRange_Contents"></a>

 ** isTunable **   <a name="personalize-Type-DefaultIntegerHyperParameterRange-isTunable"></a>
Indica se o hiperparâmetro é ajustável.  
Tipo: booliano  
Obrigatório: Não

 ** maxValue **   <a name="personalize-Type-DefaultIntegerHyperParameterRange-maxValue"></a>
O valor máximo permitido para o hiperparâmetro.  
Tipo: inteiro  
Intervalo válido: valor máximo de 1.000.000.  
Obrigatório: Não

 ** minValue **   <a name="personalize-Type-DefaultIntegerHyperParameterRange-minValue"></a>
O valor mínimo permitido para o hiperparâmetro.  
Tipo: inteiro  
Intervalo válido: valor mínimo de -1.000.000.  
Obrigatório: Não

 ** name **   <a name="personalize-Type-DefaultIntegerHyperParameterRange-name"></a>
O nome do hiperparâmetro.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_DefaultIntegerHyperParameterRange_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DefaultIntegerHyperParameterRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DefaultIntegerHyperParameterRange) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DefaultIntegerHyperParameterRange) 

# EventParameters
<a name="API_EventParameters"></a>

Descreve os parâmetros dos eventos, que são usados na criação da solução.

## Conteúdo
<a name="API_EventParameters_Contents"></a>

 ** eventType **   <a name="personalize-Type-EventParameters-eventType"></a>
O nome do tipo de evento a ser considerado para a criação da solução.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

 ** eventValueThreshold **   <a name="personalize-Type-EventParameters-eventValueThreshold"></a>
O limite do tipo de evento. Somente eventos com valor maior que ou igual a esse limite serão considerados para a criação da solução.  
Tipo: duplo  
Obrigatório: Não

 ** weight **   <a name="personalize-Type-EventParameters-weight"></a>
O peso do tipo de evento. Um peso maior significa maior importância do tipo de evento para a solução criada.  
Tipo: duplo  
Intervalo válido: valor mínimo de 0. Valor máximo de 1.  
Obrigatório: Não

## Consulte também
<a name="API_EventParameters_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/EventParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/EventParameters) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/EventParameters) 

# EventsConfig
<a name="API_EventsConfig"></a>

Descreve a configuração dos eventos, que são usados na criação da solução.

## Conteúdo
<a name="API_EventsConfig_Contents"></a>

 ** eventParametersList **   <a name="personalize-Type-EventsConfig-eventParametersList"></a>
Uma lista de parâmetros de eventos, que inclui tipos de eventos e os respectivos limites e pesos de valores de eventos.  
Tipo: matriz de objetos [EventParameters](API_EventParameters.md)  
Membros da matriz: número máximo de 10 itens.  
Obrigatório: Não

## Consulte também
<a name="API_EventsConfig_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/EventsConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/EventsConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/EventsConfig) 

# EventTracker
<a name="API_EventTracker"></a>

Fornece informações sobre um rastreador de eventos.

## Conteúdo
<a name="API_EventTracker_Contents"></a>

 ** accountId **   <a name="personalize-Type-EventTracker-accountId"></a>
A conta do AWS proprietária do rastreador de eventos.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

 ** creationDateTime **   <a name="personalize-Type-EventTracker-creationDateTime"></a>
A data e a hora (no formato Unix) em que o rastreador de eventos foi criado.  
Tipo: Timestamp  
Obrigatório: Não

 ** datasetGroupArn **   <a name="personalize-Type-EventTracker-datasetGroupArn"></a>
O Nome do Recurso da Amazon (ARN) do conjunto de dados que recebe os dados de eventos.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** eventTrackerArn **   <a name="personalize-Type-EventTracker-eventTrackerArn"></a>
O ARN do rastreador de eventos.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-EventTracker-lastUpdatedDateTime"></a>
A data e a hora (no horário do Unix) em que o rastreador de eventos foi atualizado pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** name **   <a name="personalize-Type-EventTracker-name"></a>
O nome do rastreador de eventos.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** status **   <a name="personalize-Type-EventTracker-status"></a>
O status do rastreador de eventos.  
Um rastreador de eventos pode estar em um dos seguintes estados:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

 ** trackingId **   <a name="personalize-Type-EventTracker-trackingId"></a>
O ID do rastreador de eventos. Inclua esse ID nas solicitações para a API [PutEvents](https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html).  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_EventTracker_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/EventTracker) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/EventTracker) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/EventTracker) 

# EventTrackerSummary
<a name="API_EventTrackerSummary"></a>

Fornece um resumo das propriedades de um rastreador de eventos. Para obter uma lista completa, chame a API [DescribeEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html).

## Conteúdo
<a name="API_EventTrackerSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-EventTrackerSummary-creationDateTime"></a>
A data e a hora (no horário do Unix) em que o rastreador de eventos foi criado.  
Tipo: Timestamp  
Obrigatório: Não

 ** eventTrackerArn **   <a name="personalize-Type-EventTrackerSummary-eventTrackerArn"></a>
O Nome do Recurso da Amazon (ARN) do rastreador de eventos.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-EventTrackerSummary-lastUpdatedDateTime"></a>
A data e a hora (no horário do Unix) em que o rastreador de eventos foi atualizado pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** name **   <a name="personalize-Type-EventTrackerSummary-name"></a>
O nome do rastreador de eventos.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** status **   <a name="personalize-Type-EventTrackerSummary-status"></a>
O status do rastreador de eventos.  
Um rastreador de eventos pode estar em um dos seguintes estados:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_EventTrackerSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/EventTrackerSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/EventTrackerSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/EventTrackerSummary) 

# FeatureTransformation
<a name="API_FeatureTransformation"></a>

Fornece informações sobre transformação de atributos. A transformação de atributos é o processo de modificação dos dados de entrada brutos para uma forma mais adequada ao treinamento de modelo.

## Conteúdo
<a name="API_FeatureTransformation_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-FeatureTransformation-creationDateTime"></a>
A data e a hora de criação (no horário do Unix) da transformação do atributo.  
Tipo: Timestamp  
Obrigatório: Não

 ** defaultParameters **   <a name="personalize-Type-FeatureTransformation-defaultParameters"></a>
Fornece os parâmetros padrão para transformação de atributos.  
Tipo: mapa de string para string  
Entradas do mapa: número máximo de 100 itens.  
Restrições de tamanhos de chave: tamanho máximo de 256.  
Restrições de tamanho de valor: tamanho máximo de 1.000.  
Obrigatório: Não

 ** featureTransformationArn **   <a name="personalize-Type-FeatureTransformation-featureTransformationArn"></a>
O Nome do Recurso da Amazon (ARN) do objeto FeatureTransformation.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-FeatureTransformation-lastUpdatedDateTime"></a>
A data e a hora da última atualização (no horário do Unix) da transformação do atributo.  
Tipo: Timestamp  
Obrigatório: Não

 ** name **   <a name="personalize-Type-FeatureTransformation-name"></a>
O nome da transformação do atributo.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** status **   <a name="personalize-Type-FeatureTransformation-status"></a>
O status da transformação do atributo.  
A transformação do atributo pode estar em um dos seguintes estados:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_FeatureTransformation_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/FeatureTransformation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/FeatureTransformation) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/FeatureTransformation) 

# FieldsForThemeGeneration
<a name="API_FieldsForThemeGeneration"></a>

Um mapa de string para string dos detalhes de configuração para geração de temas.

## Conteúdo
<a name="API_FieldsForThemeGeneration_Contents"></a>

 ** itemName **   <a name="personalize-Type-FieldsForThemeGeneration-itemName"></a>
O nome da coluna do conjunto de dados de itens que armazena o nome de cada item no conjunto de dados.  
Tipo: String  
Restrições de tamanho: tamanho máximo de 150.  
Padrão: : `[A-Za-z_][A-Za-z\d_]*`   
Exigido: Sim

## Consulte também
<a name="API_FieldsForThemeGeneration_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/FieldsForThemeGeneration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/FieldsForThemeGeneration) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/FieldsForThemeGeneration) 

# Filter
<a name="API_Filter"></a>

Contém informações sobre um filtro de recomendação, incluindo seu ARN, status e expressão do filtro.

## Conteúdo
<a name="API_Filter_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-Filter-creationDateTime"></a>
A hora em que o filtro foi criado.  
Tipo: Timestamp  
Obrigatório: Não

 ** datasetGroupArn **   <a name="personalize-Type-Filter-datasetGroupArn"></a>
O ARN do grupo do conjunto de dados ao qual o filtro pertence.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** failureReason **   <a name="personalize-Type-Filter-failureReason"></a>
Se ocorrer falha no filtro, o motivo da falha.  
Tipo: String  
Obrigatório: Não

 ** filterArn **   <a name="personalize-Type-Filter-filterArn"></a>
O ARN do filtro.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** filterExpression **   <a name="personalize-Type-Filter-filterExpression"></a>
Especifica o tipo de interações do item a ser filtrado dos resultados da recomendação. A expressão do filtro deve seguir regras de formato específicas. Para obter informações sobre estrutura e sintaxe de expressões de filtro, consulte [Expressões do filtro](https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html).  
Tipo: String  
Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 2.500.  
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-Filter-lastUpdatedDateTime"></a>
A hora em que o filtro foi atualizado pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** name **   <a name="personalize-Type-Filter-name"></a>
O nome do filtro.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** status **   <a name="personalize-Type-Filter-status"></a>
O status do filtro.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_Filter_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Filter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Filter) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Filter) 

# FilterSummary
<a name="API_FilterSummary"></a>

Um breve resumo dos atributos de um filtro.

## Conteúdo
<a name="API_FilterSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-FilterSummary-creationDateTime"></a>
A hora em que o filtro foi criado.  
Tipo: Timestamp  
Obrigatório: Não

 ** datasetGroupArn **   <a name="personalize-Type-FilterSummary-datasetGroupArn"></a>
O ARN do grupo do conjunto de dados ao qual o filtro pertence.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** failureReason **   <a name="personalize-Type-FilterSummary-failureReason"></a>
Se ocorrer falha no filtro, o motivo da falha.  
Tipo: String  
Obrigatório: Não

 ** filterArn **   <a name="personalize-Type-FilterSummary-filterArn"></a>
O ARN do filtro.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-FilterSummary-lastUpdatedDateTime"></a>
A hora em que o filtro foi atualizado pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** name **   <a name="personalize-Type-FilterSummary-name"></a>
O nome do filtro.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** status **   <a name="personalize-Type-FilterSummary-status"></a>
O status do filtro.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_FilterSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/FilterSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/FilterSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/FilterSummary) 

# HPOConfig
<a name="API_HPOConfig"></a>

Descreve as propriedades da otimização de hiperparâmetros (HPO).

## Conteúdo
<a name="API_HPOConfig_Contents"></a>

 ** algorithmHyperParameterRanges **   <a name="personalize-Type-HPOConfig-algorithmHyperParameterRanges"></a>
Os hiperparâmetros e seus intervalos permitidos.  
Tipo: objeto [HyperParameterRanges](API_HyperParameterRanges.md)  
Obrigatório: Não

 ** hpoObjective **   <a name="personalize-Type-HPOConfig-hpoObjective"></a>
A métrica a ser otimizada durante a HPO.  
O Amazon Personalize não oferece suporte à configuração do `hpoObjective` no momento.
Tipo: objeto [HPOObjective](API_HPOObjective.md)  
Obrigatório: Não

 ** hpoResourceConfig **   <a name="personalize-Type-HPOConfig-hpoResourceConfig"></a>
Descreve a configuração de recurso para a HPO.  
Tipo: objeto [HPOResourceConfig](API_HPOResourceConfig.md)  
Obrigatório: Não

## Consulte também
<a name="API_HPOConfig_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/HPOConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/HPOConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/HPOConfig) 

# HPOObjective
<a name="API_HPOObjective"></a>

A métrica para otimizar durante a otimização de hiperparâmetros (HPO).

**nota**  
O Amazon Personalize não oferece suporte à configuração do`hpoObjective` no momento.

## Conteúdo
<a name="API_HPOObjective_Contents"></a>

 ** metricName **   <a name="personalize-Type-HPOObjective-metricName"></a>
O nome da métrica.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

 ** metricRegex **   <a name="personalize-Type-HPOObjective-metricRegex"></a>
Uma expressão regular para encontrar a métrica nos logs de tarefas de treinamento.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

 ** type **   <a name="personalize-Type-HPOObjective-type"></a>
O tipo da métrica. Os valores válidos são `Maximize` e `Minimize`.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_HPOObjective_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/HPOObjective) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/HPOObjective) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/HPOObjective) 

# HPOResourceConfig
<a name="API_HPOResourceConfig"></a>

Descreve a configuração do recurso para a otimização de hiperparâmetros (HPO).

## Conteúdo
<a name="API_HPOResourceConfig_Contents"></a>

 ** maxNumberOfTrainingJobs **   <a name="personalize-Type-HPOResourceConfig-maxNumberOfTrainingJobs"></a>
O número máximo de trabalhos de treinamento quando você cria uma versão da solução. O valor máximo de `maxNumberOfTrainingJobs` é `40`.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

 ** maxParallelTrainingJobs **   <a name="personalize-Type-HPOResourceConfig-maxParallelTrainingJobs"></a>
O número máximo de trabalhos de treinamento em paralelo quando você cria uma versão da solução. O valor máximo de `maxParallelTrainingJobs` é `10`.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_HPOResourceConfig_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/HPOResourceConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/HPOResourceConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/HPOResourceConfig) 

# HyperParameterRanges
<a name="API_HyperParameterRanges"></a>

Especifica os hiperparâmetros e seus intervalos. Os hiperparâmetros podem ser categóricos, contínuos ou de valor inteiro.

## Conteúdo
<a name="API_HyperParameterRanges_Contents"></a>

 ** categoricalHyperParameterRanges **   <a name="personalize-Type-HyperParameterRanges-categoricalHyperParameterRanges"></a>
Os hiperparâmetros categóricos e seus intervalos.  
Tipo: matriz de objetos [CategoricalHyperParameterRange](API_CategoricalHyperParameterRange.md)  
Membros da matriz: número máximo de 100 itens.  
Obrigatório: Não

 ** continuousHyperParameterRanges **   <a name="personalize-Type-HyperParameterRanges-continuousHyperParameterRanges"></a>
Os hiperparâmetros contínuos e seus intervalos.  
Tipo: matriz de objetos [ContinuousHyperParameterRange](API_ContinuousHyperParameterRange.md)  
Membros da matriz: número máximo de 100 itens.  
Obrigatório: Não

 ** integerHyperParameterRanges **   <a name="personalize-Type-HyperParameterRanges-integerHyperParameterRanges"></a>
Os hiperparâmetros de valor inteiro e seus intervalos.  
Tipo: matriz de objetos [IntegerHyperParameterRange](API_IntegerHyperParameterRange.md)  
Membros da matriz: número máximo de 100 itens.  
Obrigatório: Não

## Consulte também
<a name="API_HyperParameterRanges_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/HyperParameterRanges) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/HyperParameterRanges) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/HyperParameterRanges) 

# IntegerHyperParameterRange
<a name="API_IntegerHyperParameterRange"></a>

Fornece o nome e o intervalo de um hiperparâmetro cujo valor é um número inteiro.

## Conteúdo
<a name="API_IntegerHyperParameterRange_Contents"></a>

 ** maxValue **   <a name="personalize-Type-IntegerHyperParameterRange-maxValue"></a>
O valor máximo permitido para o hiperparâmetro.  
Tipo: inteiro  
Intervalo válido: valor máximo de 1.000.000.  
Obrigatório: Não

 ** minValue **   <a name="personalize-Type-IntegerHyperParameterRange-minValue"></a>
O valor mínimo permitido para o hiperparâmetro.  
Tipo: inteiro  
Intervalo válido: valor mínimo de -1.000.000.  
Obrigatório: Não

 ** name **   <a name="personalize-Type-IntegerHyperParameterRange-name"></a>
O nome do hiperparâmetro.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_IntegerHyperParameterRange_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/IntegerHyperParameterRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/IntegerHyperParameterRange) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/IntegerHyperParameterRange) 

# MetricAttribute
<a name="API_MetricAttribute"></a>

Contém informações sobre uma métrica que é relatada por uma atribuição métrica. Para obter mais informações, consulte [Como medir o impacto das recomendações](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html).

## Conteúdo
<a name="API_MetricAttribute_Contents"></a>

 ** eventType **   <a name="personalize-Type-MetricAttribute-eventType"></a>
O tipo de evento da métrica.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Sim

 ** expression **   <a name="personalize-Type-MetricAttribute-expression"></a>
A expressão do atributo. As funções disponíveis são `SUM()` ou `SAMPLECOUNT()`. Para as funções SUM(), forneça o tipo de conjunto de dados (Interações ou Itens) e a coluna a ser somada como parâmetro. Por exemplo, SUM(Items.PRICE).  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: sim

 ** metricName **   <a name="personalize-Type-MetricAttribute-metricName"></a>
O nome da métrica. O nome ajuda você a identificar a métrica no Amazon CloudWatch ou no Amazon S3.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Sim

## Consulte também
<a name="API_MetricAttribute_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/MetricAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttribute) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/MetricAttribute) 

# MetricAttribution
<a name="API_MetricAttribution"></a>

Contém informações sobre uma atribuição métrica. Uma atribuição métrica cria relatórios sobre os dados que você importa para o Amazon Personalize. Dependendo de como você importa os dados, você pode visualizar os relatórios no Amazon CloudWatch ou no Amazon S3. Para obter mais informações, consulte [Como medir o impacto das recomendações](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html).

## Conteúdo
<a name="API_MetricAttribution_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-MetricAttribution-creationDateTime"></a>
A data e hora da criação da atribuição métrica.  
Tipo: Timestamp  
Obrigatório: Não

 ** datasetGroupArn **   <a name="personalize-Type-MetricAttribution-datasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do grupo de conjuntos de dados da atribuição métrica.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** failureReason **   <a name="personalize-Type-MetricAttribution-failureReason"></a>
O motivo da falha da atribuição métrica.  
Tipo: String  
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-MetricAttribution-lastUpdatedDateTime"></a>
A data e hora da última atualização da atribuição métrica.  
Tipo: Timestamp  
Obrigatório: Não

 ** metricAttributionArn **   <a name="personalize-Type-MetricAttribution-metricAttributionArn"></a>
O nome do recurso da Amazon (ARN) da atribuição da métrica.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** metricsOutputConfig **   <a name="personalize-Type-MetricAttribution-metricsOutputConfig"></a>
A configuração de saída da atribuição métrica.  
Tipo: objeto [MetricAttributionOutput](API_MetricAttributionOutput.md)  
Obrigatório: Não

 ** name **   <a name="personalize-Type-MetricAttribution-name"></a>
O nome da atribuição métrica.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** status **   <a name="personalize-Type-MetricAttribution-status"></a>
O status da atribuição métrica.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_MetricAttribution_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/MetricAttribution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttribution) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/MetricAttribution) 

# MetricAttributionOutput
<a name="API_MetricAttributionOutput"></a>

Os detalhes da configuração de saída para uma atribuição métrica.

## Conteúdo
<a name="API_MetricAttributionOutput_Contents"></a>

 ** roleArn **   <a name="personalize-Type-MetricAttributionOutput-roleArn"></a>
O Amazon Resource Name (ARN) de um perfil de serviço do IAM com permissões para adicionar dados ao bucket do Amazon S3 de saída e adicionar métricas ao Amazon CloudWatch. Para obter mais informações, consulte [Como medir o impacto das recomendações](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html).  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Exigido: Sim

 ** s3DataDestination **   <a name="personalize-Type-MetricAttributionOutput-s3DataDestination"></a>
Os detalhes de configuração de um bucket de entrada ou saída do Amazon S3.  
Tipo: objeto [S3DataConfig](API_S3DataConfig.md)  
Obrigatório: Não

## Consulte também
<a name="API_MetricAttributionOutput_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/MetricAttributionOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttributionOutput) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/MetricAttributionOutput) 

# MetricAttributionSummary
<a name="API_MetricAttributionSummary"></a>

Fornece um resumo das propriedades de uma atribuição métrica. Para obter uma lista completa, chame a API [DescribeMetricAttribution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeMetricAttribution.html).

## Conteúdo
<a name="API_MetricAttributionSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-MetricAttributionSummary-creationDateTime"></a>
A data e hora da criação da atribuição métrica.  
Tipo: Timestamp  
Obrigatório: Não

 ** failureReason **   <a name="personalize-Type-MetricAttributionSummary-failureReason"></a>
O motivo da falha da atribuição métrica.  
Tipo: String  
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-MetricAttributionSummary-lastUpdatedDateTime"></a>
A data e hora da última atualização da atribuição métrica.  
Tipo: Timestamp  
Obrigatório: Não

 ** metricAttributionArn **   <a name="personalize-Type-MetricAttributionSummary-metricAttributionArn"></a>
O nome do recurso da Amazon (ARN) da atribuição da métrica.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** name **   <a name="personalize-Type-MetricAttributionSummary-name"></a>
O nome da atribuição métrica.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** status **   <a name="personalize-Type-MetricAttributionSummary-status"></a>
O status da atribuição métrica.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_MetricAttributionSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/MetricAttributionSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttributionSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/MetricAttributionSummary) 

# OptimizationObjective
<a name="API_OptimizationObjective"></a>

Descreve o objetivo adicional da solução, como maximizar os minutos de streaming ou aumentar a receita. Para obter mais informações, consulte [Otimização da solução](https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html).

## Conteúdo
<a name="API_OptimizationObjective_Contents"></a>

 ** itemAttribute **   <a name="personalize-Type-OptimizationObjective-itemAttribute"></a>
A coluna de metadados numéricos em um conjunto de dados de itens relacionado ao objetivo de otimização. Por exemplo, VIDEO\$1LENGTH (para maximizar os minutos de streaming) ou PRICE (para maximizar a receita).  
Tipo: String  
Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 150.  
Obrigatório: Não

 ** objectiveSensitivity **   <a name="personalize-Type-OptimizationObjective-objectiveSensitivity"></a>
Especifica como o Amazon Personalize equilibra a importância do seu objetivo de otimização com a relevância.  
Tipo: String  
Valores Válidos: `LOW | MEDIUM | HIGH | OFF`   
Obrigatório: Não

## Consulte também
<a name="API_OptimizationObjective_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/OptimizationObjective) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/OptimizationObjective) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/OptimizationObjective) 

# Recipe
<a name="API_Recipe"></a>

Fornece informações sobre uma fórmula. Cada fórmula fornece um algoritmo que o Amazon Personalize usa no treinamento de modelos quando você usa a operação [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html). 

## Conteúdo
<a name="API_Recipe_Contents"></a>

 ** algorithmArn **   <a name="personalize-Type-Recipe-algorithmArn"></a>
O Amazon Resource Name (ARN) do algoritmo que o Amazon Personalize usa para treinar o modelo.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** creationDateTime **   <a name="personalize-Type-Recipe-creationDateTime"></a>
A data e a hora (no formato Unix) em que a fórmula foi criada.  
Tipo: Timestamp  
Obrigatório: Não

 ** description **   <a name="personalize-Type-Recipe-description"></a>
A descrição da fórmula.  
Tipo: String  
Obrigatório: Não

 ** featureTransformationArn **   <a name="personalize-Type-Recipe-featureTransformationArn"></a>
O ARN do objeto FeatureTransformation.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-Recipe-lastUpdatedDateTime"></a>
A data e a hora (no formato Unix) em que a fórmula foi atualizada pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** name **   <a name="personalize-Type-Recipe-name"></a>
O nome da fórmula.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** recipeArn **   <a name="personalize-Type-Recipe-recipeArn"></a>
O Amazon Resource Name (ARN) da fórmula.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** recipeType **   <a name="personalize-Type-Recipe-recipeType"></a>
Um dos seguintes valores:  
+ PERSONALIZED\$1RANKING
+ RELATED\$1ITEMS
+ USER\$1PERSONALIZATION
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

 ** status **   <a name="personalize-Type-Recipe-status"></a>
O status da fórmula.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_Recipe_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Recipe) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Recipe) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Recipe) 

# RecipeSummary
<a name="API_RecipeSummary"></a>

Fornece um resumo das propriedades de uma fórmula. Para obter uma lista completa, chame a API [DescribeRecipe](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecipe.html).

## Conteúdo
<a name="API_RecipeSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-RecipeSummary-creationDateTime"></a>
A data e a hora (no horário do Unix) em que a fórmula foi criada.  
Tipo: Timestamp  
Obrigatório: Não

 ** domain **   <a name="personalize-Type-RecipeSummary-domain"></a>
O domínio da fórmula (se a fórmula for um caso de uso do grupo do conjunto de dados do domínio).  
Tipo: String  
Valores Válidos: `ECOMMERCE | VIDEO_ON_DEMAND`   
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-RecipeSummary-lastUpdatedDateTime"></a>
A data e a hora (no horário do Unix) em que a fórmula foi atualizada pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** name **   <a name="personalize-Type-RecipeSummary-name"></a>
O nome da fórmula.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** recipeArn **   <a name="personalize-Type-RecipeSummary-recipeArn"></a>
O Amazon Resource Name (ARN) da fórmula.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** status **   <a name="personalize-Type-RecipeSummary-status"></a>
O status da fórmula.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_RecipeSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/RecipeSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/RecipeSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/RecipeSummary) 

# Recommender
<a name="API_Recommender"></a>

Descreve um gerador de recomendações para um grupo do conjunto de dados de domínio. Você cria um recomendador em um grupo do conjunto de dados de domínio para um caso de uso de domínio específico (fórmula de domínio) e especifica o recomendador em uma solicitação [GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html).

## Conteúdo
<a name="API_Recommender_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-Recommender-creationDateTime"></a>
A data e a hora (no formato Unix) em que o recomendador foi criado.  
Tipo: Timestamp  
Obrigatório: Não

 ** datasetGroupArn **   <a name="personalize-Type-Recommender-datasetGroupArn"></a>
O Amazon Resource Name (ARN) do grupo do conjunto de dados de domínio que contém o recomendador.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** failureReason **   <a name="personalize-Type-Recommender-failureReason"></a>
Se um recomendador falhar, o motivo da falha.  
Tipo: String  
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-Recommender-lastUpdatedDateTime"></a>
A data e a hora (no formato Unix) em que o recomendador foi atualizado pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** latestRecommenderUpdate **   <a name="personalize-Type-Recommender-latestRecommenderUpdate"></a>
Fornece um resumo das atualizações mais recentes para o recomendador.   
Tipo: objeto [RecommenderUpdateSummary](API_RecommenderUpdateSummary.md)  
Obrigatório: Não

 ** modelMetrics **   <a name="personalize-Type-Recommender-modelMetrics"></a>
Fornece métricas de avaliação que ajudam a determinar o desempenho de um recomendador. Para obter mais informações, consulte [Avaliação de um recomendador](https://docs.aws.amazon.com/personalize/latest/dg/evaluating-recommenders.html).  
Tipo: mapa de string para double  
Entradas do mapa: número máximo de 100 itens.  
Restrições de tamanhos de chave: tamanho máximo de 256.  
Obrigatório: Não

 ** name **   <a name="personalize-Type-Recommender-name"></a>
O nome do recomendador.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** recipeArn **   <a name="personalize-Type-Recommender-recipeArn"></a>
O Amazon Resource Name (ARN) da fórmula (caso de uso do grupo do conjunto de dados de domínio) para a qual o recomendador foi criado.   
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** recommenderArn **   <a name="personalize-Type-Recommender-recommenderArn"></a>
O nome do recurso da Amazon (ARN) do recomendador.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** recommenderConfig **   <a name="personalize-Type-Recommender-recommenderConfig"></a>
Os detalhes de configuração do recomendador.  
Tipo: objeto [RecommenderConfig](API_RecommenderConfig.md)  
Obrigatório: Não

 ** status **   <a name="personalize-Type-Recommender-status"></a>
O status do recomendador.  
Um recomendador pode estar em um dos seguintes estados:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ STOP PENDING > STOP IN\$1PROGRESS > INACTIVE > START PENDING > START IN\$1PROGRESS > ACTIVE
+ DELETE PENDING > DELETE IN\$1PROGRESS
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_Recommender_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Recommender) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Recommender) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Recommender) 

# RecommenderConfig
<a name="API_RecommenderConfig"></a>

Os detalhes de configuração do recomendador.

## Conteúdo
<a name="API_RecommenderConfig_Contents"></a>

 ** enableMetadataWithRecommendations **   <a name="personalize-Type-RecommenderConfig-enableMetadataWithRecommendations"></a>
Se os metadados com recomendações estão ou não habilitados para o recomendador. Se habilitada, será possível especificar as colunas do conjunto de dados de itens na solicitação de recomendações. O Amazon Personalize exibe esses dados para cada item na resposta da recomendação. Para obter informações sobre como habilitar metadados para uma recomendador, consulte [Enabling metadata in recommendations for a recommender](https://docs.aws.amazon.com/personalize/latest/dg/creating-recommenders.html#create-recommender-return-metadata).  
 Se você habilitar metadados nas recomendações, haverá custos adicionais. Para obter mais informações, consulte [Preços do Amazon Personalize](https://aws.amazon.com/personalize/pricing/).   
Tipo: booliano  
Obrigatório: Não

 ** itemExplorationConfig **   <a name="personalize-Type-RecommenderConfig-itemExplorationConfig"></a>
Especifica os hiperparâmetros de configuração de exploração, incluindo `explorationWeight` e `explorationItemAgeCutOff`, que você deseja usar para configurar a quantidade de exploração de itens que o Amazon Personalize usa ao recomendar itens. Forneça dados `itemExplorationConfig` somente se seus recomendadores gerarem recomendações personalizadas para um usuário (não itens populares ou itens similares).  
Tipo: mapa de string para string  
Entradas do mapa: número máximo de 100 itens.  
Restrições de tamanhos de chave: tamanho máximo de 256.  
Restrições de tamanho de valor: tamanho máximo de 1.000.  
Obrigatório: Não

 ** minRecommendationRequestsPerSecond **   <a name="personalize-Type-RecommenderConfig-minRecommendationRequestsPerSecond"></a>
Especifica o mínimo de solicitações de recomendações provisionadas solicitadas por segundo para o qual o Amazon Personalize oferecerá suporte. Uma `minRecommendationRequestsPerSecond` alta aumentará sua conta. Recomendamos começar com 1 para `minRecommendationRequestsPerSecond` (o padrão). Monitore seu uso com as métricas do Amazon CloudWatch e aumente o `minRecommendationRequestsPerSecond` conforme necessário.  
Tipo: inteiro  
Intervalo válido: valor mínimo de 1.  
Obrigatório: Não

 ** trainingDataConfig **   <a name="personalize-Type-RecommenderConfig-trainingDataConfig"></a>
 Especifica a configuração dos dados de treinamento a ser usada ao criar um recomendador de domínio.   
Tipo: objeto [TrainingDataConfig](API_TrainingDataConfig.md)  
Obrigatório: Não

## Consulte também
<a name="API_RecommenderConfig_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/RecommenderConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/RecommenderConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/RecommenderConfig) 

# RecommenderSummary
<a name="API_RecommenderSummary"></a>

Fornece um resumo das propriedades do recomendador.

## Conteúdo
<a name="API_RecommenderSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-RecommenderSummary-creationDateTime"></a>
A data e a hora (no formato Unix) em que o recomendador foi criado.  
Tipo: Timestamp  
Obrigatório: Não

 ** datasetGroupArn **   <a name="personalize-Type-RecommenderSummary-datasetGroupArn"></a>
O Amazon Resource Name (ARN) do grupo do conjunto de dados de domínio que contém o recomendador.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-RecommenderSummary-lastUpdatedDateTime"></a>
A data e a hora (no formato Unix) em que o recomendador foi atualizado pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** name **   <a name="personalize-Type-RecommenderSummary-name"></a>
O nome do recomendador.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** recipeArn **   <a name="personalize-Type-RecommenderSummary-recipeArn"></a>
O Amazon Resource Name (ARN) da fórmula (caso de uso do grupo do conjunto de dados de domínio) para a qual o recomendador foi criado.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** recommenderArn **   <a name="personalize-Type-RecommenderSummary-recommenderArn"></a>
O nome do recurso da Amazon (ARN) do recomendador.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** recommenderConfig **   <a name="personalize-Type-RecommenderSummary-recommenderConfig"></a>
Os detalhes de configuração do recomendador.  
Tipo: objeto [RecommenderConfig](API_RecommenderConfig.md)  
Obrigatório: Não

 ** status **   <a name="personalize-Type-RecommenderSummary-status"></a>
O status do recomendador. Um recomendador pode estar em um dos seguintes estados:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ STOP PENDING > STOP IN\$1PROGRESS > INACTIVE > START PENDING > START IN\$1PROGRESS > ACTIVE
+ DELETE PENDING > DELETE IN\$1PROGRESS
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_RecommenderSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/RecommenderSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/RecommenderSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/RecommenderSummary) 

# RecommenderUpdateSummary
<a name="API_RecommenderUpdateSummary"></a>

Fornece um resumo das propriedades de uma atualização do recomendador. Para obter uma lista completa, chame a API [DescribeRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html).

## Conteúdo
<a name="API_RecommenderUpdateSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-RecommenderUpdateSummary-creationDateTime"></a>
A data e a hora (no formato Unix) em que o recomendador foi atualizado pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** failureReason **   <a name="personalize-Type-RecommenderUpdateSummary-failureReason"></a>
Se uma atualização do recomendador falhar, o motivo da falha.  
Tipo: String  
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-RecommenderUpdateSummary-lastUpdatedDateTime"></a>
A data e hora (no horário Unix) em que a atualização do recomendador foi atualizada pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** recommenderConfig **   <a name="personalize-Type-RecommenderUpdateSummary-recommenderConfig"></a>
Os detalhes de configuração da atualização do recomendador.  
Tipo: objeto [RecommenderConfig](API_RecommenderConfig.md)  
Obrigatório: Não

 ** status **   <a name="personalize-Type-RecommenderUpdateSummary-status"></a>
O status da atualização do recomendador. A atualização de um recomendador pode estar em um dos seguintes estados:  
CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_RecommenderUpdateSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/RecommenderUpdateSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/RecommenderUpdateSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/RecommenderUpdateSummary) 

# S3DataConfig
<a name="API_S3DataConfig"></a>

Os detalhes de configuração de um bucket de entrada ou saída do Amazon S3.

## Conteúdo
<a name="API_S3DataConfig_Contents"></a>

 ** path **   <a name="personalize-Type-S3DataConfig-path"></a>
O caminho do arquivo do bucket do Amazon S3.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `(s3|http|https)://.+`   
Exigido: Sim

 ** kmsKeyArn **   <a name="personalize-Type-S3DataConfig-kmsKeyArn"></a>
O nome do recurso da Amazon (ARN) da chave do AWS Key Management Service (KMS) que o Amazon Personalize usa para criptografar ou descriptografar os arquivos de entrada e saída.  
Tipo: String  
Restrições de tamanho: tamanho máximo de 2048.  
Padrão: : `arn:aws.*:kms:.*:[0-9]{12}:key/.*`   
Obrigatório: Não

## Consulte também
<a name="API_S3DataConfig_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/S3DataConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/S3DataConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/S3DataConfig) 

# Solution
<a name="API_Solution"></a>

**Importante**  
Por padrão, todas as novas soluções usam o treinamento automático. Com o treinamento automático, você acumula custos de treinamento enquanto sua solução está ativa. Ao terminar, você poderá [atualizar a solução](https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateSolution.html) para desativar o treinamento automático e evitar custos desnecessários. Para obter mais informações sobre os custos dos treinamentos, consulte [Preços do Amazon Personalize](https://aws.amazon.com/personalize/pricing/).

Um objeto que fornece informações sobre uma solução. A solução inclui a fórmula personalizada, os parâmetros personalizados e os modelos treinados (versões da solução) que o Amazon Personalize usa para gerar recomendações. 

Depois de criar uma solução, não será possível mudar a configuração. Se você precisar fazer alterações, poderá [clonar a solução](https://docs.aws.amazon.com/personalize/latest/dg/cloning-solution.html) com o console do Amazon Personalize ou criar outra.

## Conteúdo
<a name="API_Solution_Contents"></a>

 ** autoMLResult **   <a name="personalize-Type-Solution-autoMLResult"></a>
Quando `performAutoML` é verdadeiro, especifica a melhor fórmula encontrada.  
Tipo: objeto [AutoMLResult](API_AutoMLResult.md)  
Obrigatório: não

 ** creationDateTime **   <a name="personalize-Type-Solution-creationDateTime"></a>
A data e a hora de criação (no horário do Unix) da solução.  
Tipo: Timestamp  
Obrigatório: não

 ** datasetGroupArn **   <a name="personalize-Type-Solution-datasetGroupArn"></a>
O Amazon Resource Name (ARN) do grupo de conjuntos de dados que fornece os dados de treinamento.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** eventType **   <a name="personalize-Type-Solution-eventType"></a>
O tipo de evento (por exemplo, “clique” ou “curtida”) utilizado para treinar o modelo. Se um `eventType` não for fornecido, o Amazon Personalize usará todas as interações para treinamento com o mesmo peso, independentemente do tipo.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: não

 ** lastUpdatedDateTime **   <a name="personalize-Type-Solution-lastUpdatedDateTime"></a>
A data e a hora (no horário do Unix) em que a solução foi atualizada pela última vez.  
Tipo: Timestamp  
Obrigatório: não

 ** latestSolutionUpdate **   <a name="personalize-Type-Solution-latestSolutionUpdate"></a>
Fornece um resumo das atualizações mais recentes na solução.  
Tipo: objeto [SolutionUpdateSummary](API_SolutionUpdateSummary.md)  
Obrigatório: não

 ** latestSolutionVersion **   <a name="personalize-Type-Solution-latestSolutionVersion"></a>
Descreve a versão mais recente da solução, incluindo o status e o ARN.  
Tipo: objeto [SolutionVersionSummary](API_SolutionVersionSummary.md)  
Obrigatório: não

 ** name **   <a name="personalize-Type-Solution-name"></a>
O nome da solução.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: não

 ** performAutoML **   <a name="personalize-Type-Solution-performAutoML"></a>
Não recomendamos a habilitação do machine learning automatizado. Em vez disso, faça a correspondência entre o caso de uso e as fórmulas do Amazon Personalize disponíveis. Para obter mais informações, consulte [Determining your use case.](https://docs.aws.amazon.com/personalize/latest/dg/determining-use-case.html) (Determinar seu caso de uso). 
Quando true, o Amazon Personalize faz uma pesquisa em busca da melhor fórmula USER\$1PERSONALIZATION na lista especificada na configuração da solução (`recipeArn` não deve ser especificado). Quando false (o padrão), o Amazon Personalize utiliza `recipeArn` para treinamento.  
Tipo: booliano  
Obrigatório: não

 ** performAutoTraining **   <a name="personalize-Type-Solution-performAutoTraining"></a>
Especifica se a solução cria automaticamente versões da solução. O padrão é `True`, e a solução cria automaticamente uma versão a cada 7 dias.  
Para obter mais informações sobre o treinamento automático, consulte [Criar e configurar uma solução](https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html).  
Tipo: booliano  
Obrigatório: não

 ** performHPO **   <a name="personalize-Type-Solution-performHPO"></a>
Se a otimização de hiperparâmetros (HPO) deve ou não ser realizada na fórmula escolhida. O padrão é `false`.  
Tipo: booliano  
Obrigatório: não

 ** performIncrementalUpdate **   <a name="personalize-Type-Solution-performIncrementalUpdate"></a>
Um valor booleano que indica se as atualizações incrementais de treinamento são realizadas no modelo. Quando ativado, isso permite que o modelo aprenda com novos dados com mais frequência sem exigir um novo treinamento completo, o que permite uma personalização quase em tempo real. Esse parâmetro é suportado somente para soluções que usam a receita de similaridade semântica.  
Tipo: booliano  
Obrigatório: não

 ** recipeArn **   <a name="personalize-Type-Solution-recipeArn"></a>
O ARN da fórmula utilizada para criar a solução. Isso é necessário quando `performAutoML` é falso.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** solutionArn **   <a name="personalize-Type-Solution-solutionArn"></a>
O ARN da solução.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** solutionConfig **   <a name="personalize-Type-Solution-solutionConfig"></a>
Descreve as propriedades de configuração da solução.  
Tipo: objeto [SolutionConfig](API_SolutionConfig.md)  
Obrigatório: não

 ** status **   <a name="personalize-Type-Solution-status"></a>
O status da solução.  
Uma solução pode estar em um dos seguintes estados:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_Solution_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWSSDKs, consulte o seguinte:
+  [AWSSDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Solution) 
+  [AWSSDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Solution) 
+  [AWSSDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Solution) 

# SolutionConfig
<a name="API_SolutionConfig"></a>

Descreve as propriedades de configuração da solução.

## Conteúdo
<a name="API_SolutionConfig_Contents"></a>

 ** algorithmHyperParameters **   <a name="personalize-Type-SolutionConfig-algorithmHyperParameters"></a>
Lista os hiperparâmetros do algoritmo e seus valores.  
Tipo: mapa de string para string  
Entradas do mapa: número máximo de 100 itens.  
Restrições de tamanhos de chave: tamanho máximo de 256.  
Restrições de tamanho de valor: tamanho máximo de 1.000.  
Obrigatório: Não

 ** autoMLConfig **   <a name="personalize-Type-SolutionConfig-autoMLConfig"></a>
O objeto [AutoMLConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_AutoMLConfig.html) contendo uma lista de fórmulas para pesquisar quando o AutoML for executado.  
Tipo: objeto [AutoMLConfig](API_AutoMLConfig.md)  
Obrigatório: Não

 ** autoTrainingConfig **   <a name="personalize-Type-SolutionConfig-autoTrainingConfig"></a>
Especifica a configuração de treinamento automática a ser usada.  
Tipo: objeto [AutoTrainingConfig](API_AutoTrainingConfig.md)  
Obrigatório: Não

 ** eventsConfig **   <a name="personalize-Type-SolutionConfig-eventsConfig"></a>
Descreve a configuração de um evento, que inclui uma lista de parâmetros do evento. É possível especificar até dez parâmetros de evento. Os eventos são usados na criação da solução.  
Tipo: objeto [EventsConfig](API_EventsConfig.md)  
Obrigatório: Não

 ** eventValueThreshold **   <a name="personalize-Type-SolutionConfig-eventValueThreshold"></a>
Apenas eventos com um valor maior ou igual a esse limite são usados para treinar um modelo.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

 ** featureTransformationParameters **   <a name="personalize-Type-SolutionConfig-featureTransformationParameters"></a>
Lista os parâmetros de transformação do atributo.  
Tipo: mapa de string para string  
Entradas do mapa: número máximo de 100 itens.  
Restrições de tamanhos de chave: tamanho máximo de 256.  
Restrições de tamanho de valor: tamanho máximo de 1.000.  
Obrigatório: Não

 ** hpoConfig **   <a name="personalize-Type-SolutionConfig-hpoConfig"></a>
Descreve as propriedades da otimização de hiperparâmetros (HPO).  
Tipo: objeto [HPOConfig](API_HPOConfig.md)  
Obrigatório: Não

 ** optimizationObjective **   <a name="personalize-Type-SolutionConfig-optimizationObjective"></a>
Descreve o objetivo adicional da solução, como maximizar os minutos de streaming ou aumentar a receita. Para obter mais informações, consulte [Otimização da solução](https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html).  
Tipo: objeto [OptimizationObjective](API_OptimizationObjective.md)  
Obrigatório: Não

 ** trainingDataConfig **   <a name="personalize-Type-SolutionConfig-trainingDataConfig"></a>
 Especifica a configuração de dados de treinamento a ser usada ao criar uma versão de solução personalizada (modelo treinado).   
Tipo: objeto [TrainingDataConfig](API_TrainingDataConfig.md)  
Obrigatório: Não

## Consulte também
<a name="API_SolutionConfig_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionConfig) 

# SolutionSummary
<a name="API_SolutionSummary"></a>

Fornece um resumo das propriedades de uma solução. Para obter uma lista completa, chame a API [DescribeSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html).

## Conteúdo
<a name="API_SolutionSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-SolutionSummary-creationDateTime"></a>
A data e a hora (no horário do Unix) em que a solução foi criada.  
Tipo: Timestamp  
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-SolutionSummary-lastUpdatedDateTime"></a>
A data e a hora (no horário do Unix) em que a solução foi atualizada pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** name **   <a name="personalize-Type-SolutionSummary-name"></a>
O nome da solução.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** recipeArn **   <a name="personalize-Type-SolutionSummary-recipeArn"></a>
O nome do recurso da Amazon (ARN) da fórmula usada pela solução.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** solutionArn **   <a name="personalize-Type-SolutionSummary-solutionArn"></a>
O nome do recurso da Amazon (ARN) da solução.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** status **   <a name="personalize-Type-SolutionSummary-status"></a>
O status da solução.  
Uma solução pode estar em um dos seguintes estados:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_SolutionSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionSummary) 

# SolutionUpdateConfig
<a name="API_SolutionUpdateConfig"></a>

Os detalhes da configuração da atualização da solução.

## Conteúdo
<a name="API_SolutionUpdateConfig_Contents"></a>

 ** autoTrainingConfig **   <a name="personalize-Type-SolutionUpdateConfig-autoTrainingConfig"></a>
A configuração de treinamento automática a ser usada quando `performAutoTraining` é verdadeira.  
Tipo: objeto [AutoTrainingConfig](API_AutoTrainingConfig.md)  
Obrigatório: Não

 ** eventsConfig **   <a name="personalize-Type-SolutionUpdateConfig-eventsConfig"></a>
Descreve a configuração de um evento, que inclui uma lista de parâmetros do evento. É possível especificar até dez parâmetros de evento. Os eventos são usados na criação da solução.  
Tipo: objeto [EventsConfig](API_EventsConfig.md)  
Obrigatório: Não

## Consulte também
<a name="API_SolutionUpdateConfig_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionUpdateConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionUpdateConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionUpdateConfig) 

# SolutionUpdateSummary
<a name="API_SolutionUpdateSummary"></a>

Fornece um resumo das propriedades da atualização de uma solução. Para obter uma lista completa, chame a [DescribeSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html)API.

## Conteúdo
<a name="API_SolutionUpdateSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-SolutionUpdateSummary-creationDateTime"></a>
A data e a hora (no formato Unix) em que a solução foi atualizada pela última vez.  
Tipo: Timestamp  
Obrigatório: não

 ** failureReason **   <a name="personalize-Type-SolutionUpdateSummary-failureReason"></a>
Se a atualização da solução falhar, o motivo da falha.  
Tipo: string  
Obrigatório: não

 ** lastUpdatedDateTime **   <a name="personalize-Type-SolutionUpdateSummary-lastUpdatedDateTime"></a>
A data e a hora (no horário do Unix) em que a solução foi atualizada pela última vez.  
Tipo: Timestamp  
Obrigatório: não

 ** performAutoTraining **   <a name="personalize-Type-SolutionUpdateSummary-performAutoTraining"></a>
Especifica se a solução cria automaticamente versões da solução.  
Tipo: booliano  
Obrigatório: não

 ** performIncrementalUpdate **   <a name="personalize-Type-SolutionUpdateSummary-performIncrementalUpdate"></a>
Um valor booleano que indica se as atualizações incrementais de treinamento são realizadas no modelo. Quando ativado, o treinamento incremental é realizado para versões da solução com campanhas ativas e permite que o modelo aprenda com novos dados com mais frequência sem exigir um novo treinamento completo, o que permite uma personalização quase em tempo real. Esse parâmetro é suportado somente para soluções que usam a receita de similaridade semântica. O padrão é `true`.  
Observe que certas pontuações e atributos (como atualizações na popularidade e no frescor do item usadas para influenciar a classificação com a aws-semantic-similarity receita) podem não ser atualizados até que o próximo treinamento completo ocorra.   
Tipo: booliano  
Obrigatório: não

 ** solutionUpdateConfig **   <a name="personalize-Type-SolutionUpdateSummary-solutionUpdateConfig"></a>
Os detalhes da configuração da solução.  
Tipo: objeto [SolutionUpdateConfig](API_SolutionUpdateConfig.md)  
Obrigatório: não

 ** status **   <a name="personalize-Type-SolutionUpdateSummary-status"></a>
O status da atualização da solução. A atualização da solução pode estar em um dos seguintes estados:  
CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_SolutionUpdateSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWSSDKs, consulte o seguinte:
+  [AWSSDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionUpdateSummary) 
+  [AWSSDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionUpdateSummary) 
+  [AWSSDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionUpdateSummary) 

# SolutionVersion
<a name="API_SolutionVersion"></a>

Um objeto que fornece informações sobre uma versão específica de uma [Solução](https://docs.aws.amazon.com/personalize/latest/dg/API_Solution.html) em um grupo de conjunto de dados personalizados.

## Conteúdo
<a name="API_SolutionVersion_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-SolutionVersion-creationDateTime"></a>
A data e a hora (no horário do Unix) em que esta versão da solução foi criada.  
Tipo: Timestamp  
Obrigatório: não

 ** datasetGroupArn **   <a name="personalize-Type-SolutionVersion-datasetGroupArn"></a>
O Amazon Resource Name (ARN) do grupo de conjunto de dados que fornece os dados de treinamento.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** eventType **   <a name="personalize-Type-SolutionVersion-eventType"></a>
O tipo de evento (por exemplo, “clique” ou “curtida”) utilizado para treinar o modelo.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: não

 ** failureReason **   <a name="personalize-Type-SolutionVersion-failureReason"></a>
Se o treinamento de uma versão da solução falhar, o motivo da falha.  
Tipo: string  
Obrigatório: não

 ** lastUpdatedDateTime **   <a name="personalize-Type-SolutionVersion-lastUpdatedDateTime"></a>
A data e a hora (no horário do Unix) em que a solução foi atualizada pela última vez.  
Tipo: Timestamp  
Obrigatório: não

 ** name **   <a name="personalize-Type-SolutionVersion-name"></a>
O nome da versão da solução.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: não

 ** performAutoML **   <a name="personalize-Type-SolutionVersion-performAutoML"></a>
Quando verdadeiro, o Amazon Personalize pesquisa a fórmula ideal de acordo com a configuração da solução. Quando falso (o padrão), o Amazon Personalize utiliza `recipeArn`.  
Tipo: booliano  
Obrigatório: não

 ** performHPO **   <a name="personalize-Type-SolutionVersion-performHPO"></a>
Se a otimização de hiperparâmetros (HPO) deve ou não ser realizada na fórmula escolhida. O padrão é `false`.  
Tipo: booliano  
Obrigatório: não

 ** performIncrementalUpdate **   <a name="personalize-Type-SolutionVersion-performIncrementalUpdate"></a>
Se a versão da solução deve realizar uma atualização incremental. Quando definido como verdadeiro, o treinamento processará somente os dados que foram alterados desde o treinamento mais recente, semelhante a quando o TrainingMode está definido como UPDATE. Isso só pode ser usado com versões da solução que usam a receita de personalização do usuário.  
Tipo: booliano  
Obrigatório: não

 ** recipeArn **   <a name="personalize-Type-SolutionVersion-recipeArn"></a>
O ARN da fórmula utilizada na solução.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** solutionArn **   <a name="personalize-Type-SolutionVersion-solutionArn"></a>
O ARN da solução.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** solutionConfig **   <a name="personalize-Type-SolutionVersion-solutionConfig"></a>
Descreve as propriedades de configuração da solução.  
Tipo: objeto [SolutionConfig](API_SolutionConfig.md)  
Obrigatório: não

 ** solutionVersionArn **   <a name="personalize-Type-SolutionVersion-solutionVersionArn"></a>
O ARN da versão da solução.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** status **   <a name="personalize-Type-SolutionVersion-status"></a>
O status da versão da solução.  
Uma versão da solução pode estar em um dos seguintes estados:  
+ CREATE PENDING
+ CREATE IN\$1PROGRESS
+ ACTIVE
+ CREATE FAILED
+ CREATE STOPPING
+ CREATE STOPPED
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: não

 ** trainingHours **   <a name="personalize-Type-SolutionVersion-trainingHours"></a>
O tempo usado para treinar o modelo. Você é cobrado pelo tempo necessário para treinar um modelo. Esse campo fica visível somente depois que o Amazon Personalize treina um modelo com sucesso.  
Tipo: duplo  
Intervalo válido: valor mínimo de 0.  
Obrigatório: não

 ** trainingMode **   <a name="personalize-Type-SolutionVersion-trainingMode"></a>
O escopo do treinamento a ser realizado ao criar uma versão da solução. Um treinamento `FULL` considera todos os dados do seu grupo de conjuntos de dados. E `UPDATE` processa somente os dados que foram modificados desde o último treinamento. Somente as versões da solução criadas com a fórmula User-Personalization podem usar `UPDATE`.   
Tipo: string  
Valores válidos: `FULL | UPDATE | AUTOTRAIN`   
Obrigatório: não

 ** trainingType **   <a name="personalize-Type-SolutionVersion-trainingType"></a>
Se a versão da solução foi criada de forma automática ou manual.  
Tipo: string  
Valores válidos: `AUTOMATIC | MANUAL`   
Obrigatório: não

 ** tunedHPOParams **   <a name="personalize-Type-SolutionVersion-tunedHPOParams"></a>
Se a otimização de hiperparâmetros foi realizada, ela contém os valores de hiperparâmetros do modelo com melhor desempenho.  
Tipo: objeto [TunedHPOParams](API_TunedHPOParams.md)  
Obrigatório: não

## Consulte também
<a name="API_SolutionVersion_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWSSDKs, consulte o seguinte:
+  [AWSSDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionVersion) 
+  [AWSSDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionVersion) 
+  [AWSSDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionVersion) 

# SolutionVersionSummary
<a name="API_SolutionVersionSummary"></a>

Fornece um resumo das propriedades de uma versão da solução. Para obter uma lista completa, chame a API [DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html).

## Conteúdo
<a name="API_SolutionVersionSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-SolutionVersionSummary-creationDateTime"></a>
A data e a hora (no horário do Unix) em que esta versão da solução foi criada.  
Tipo: Timestamp  
Obrigatório: Não

 ** failureReason **   <a name="personalize-Type-SolutionVersionSummary-failureReason"></a>
Se a versão da solução falhar, o motivo da falha.  
Tipo: String  
Obrigatório: Não

 ** lastUpdatedDateTime **   <a name="personalize-Type-SolutionVersionSummary-lastUpdatedDateTime"></a>
A data e a hora (no horário do Unix) em que a versão da solução foi atualizada pela última vez.  
Tipo: Timestamp  
Obrigatório: Não

 ** solutionVersionArn **   <a name="personalize-Type-SolutionVersionSummary-solutionVersionArn"></a>
O nome de recurso da Amazon (ARN) da versão da solução.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** status **   <a name="personalize-Type-SolutionVersionSummary-status"></a>
O status da versão da solução.  
Uma versão da solução pode estar em um dos seguintes estados:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

 ** trainingMode **   <a name="personalize-Type-SolutionVersionSummary-trainingMode"></a>
O escopo do treinamento a ser realizado ao criar uma versão da solução. Um treinamento `FULL` considera todos os dados do seu grupo de conjuntos de dados. E `UPDATE` processa somente os dados que foram modificados desde o último treinamento. Somente as versões da solução criadas com a fórmula User-Personalization podem usar `UPDATE`.   
Tipo: String  
Valores Válidos: `FULL | UPDATE | AUTOTRAIN`   
Obrigatório: Não

 ** trainingType **   <a name="personalize-Type-SolutionVersionSummary-trainingType"></a>
Se a versão da solução foi criada de forma automática ou manual.  
Tipo: String  
Valores Válidos: `AUTOMATIC | MANUAL`   
Obrigatório: Não

## Consulte também
<a name="API_SolutionVersionSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionVersionSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionVersionSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionVersionSummary) 

# Tag
<a name="API_Tag"></a>

Os metadados opcionais que você aplica a recursos para ajudar a categorizá-los e organizá-los. Cada tag consiste de uma chave e um valor opcional, que podem ser definidos. Para obter mais informações, consulte [Tagging Amazon Personalize resources](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html). 

## Conteúdo
<a name="API_Tag_Contents"></a>

 ** tagKey **   <a name="personalize-Type-Tag-tagKey"></a>
Uma parte de um par de chave/valor que compõe uma tag. Uma chave é um rótulo geral que age como uma categoria para valores de tag mais específicos.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. O tamanho máximo é 128.  
Padrão: : `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Exigido: Sim

 ** tagValue **   <a name="personalize-Type-Tag-tagValue"></a>
A parte opcional de um par de chave/valor que compõe uma tag. Um valor atua como um descritor dentro de uma categoria de tag (chave).  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 0. O tamanho máximo é 256.  
Padrão: : `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Exigido: Sim

## Consulte também
<a name="API_Tag_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Tag) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Tag) 

# ThemeGenerationConfig
<a name="API_ThemeGenerationConfig"></a>

Os detalhes de configuração para gerar temas com um trabalho de inferência em lote.

## Conteúdo
<a name="API_ThemeGenerationConfig_Contents"></a>

 ** fieldsForThemeGeneration **   <a name="personalize-Type-ThemeGenerationConfig-fieldsForThemeGeneration"></a>
Campos usados para gerar temas descritivos para um trabalho de inferência em lote.  
Tipo: objeto [FieldsForThemeGeneration](API_FieldsForThemeGeneration.md)  
Obrigatório: Sim

## Consulte também
<a name="API_ThemeGenerationConfig_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ThemeGenerationConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ThemeGenerationConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ThemeGenerationConfig) 

# TrainingDataConfig
<a name="API_TrainingDataConfig"></a>

A configuração de dados de treinamento a ser usada ao criar um recomendador de domínio ou uma versão de solução personalizada (modelo treinado).

## Conteúdo
<a name="API_TrainingDataConfig_Contents"></a>

 ** excludedDatasetColumns **   <a name="personalize-Type-TrainingDataConfig-excludedDatasetColumns"></a>
Especifica as colunas a serem excluídas do treinamento. Cada chave é um tipo de conjunto de dados e cada valor é uma lista de colunas. Exclua colunas para controlar quais dados o Amazon Personalize usa para gerar recomendações.  
 Por exemplo, você pode ter uma coluna que pretende usar apenas para filtrar recomendações. Você pode excluir essa coluna do treinamento, e o Amazon Personalize a considera somente durante a filtragem.   
Tipo: string para a matriz do mapa de strings  
Entradas do mapa: número máximo de 3 itens.  
Restrições de tamanho de chave: o tamanho máximo é 256.  
Padrão da chave: `^[A-Za-z_]+$`   
Membros da matriz: número máximo de 50 itens.  
Restrições de tamanho: tamanho máximo de 150.  
Padrão: `[A-Za-z_][A-Za-z\d_]*`   
Obrigatório: não

 ** includedDatasetColumns **   <a name="personalize-Type-TrainingDataConfig-includedDatasetColumns"></a>
Especifica as colunas a serem incluídas no treinamento. Cada chave é um tipo de conjunto de dados e cada valor é uma lista de colunas. Inclua colunas para controlar quais dados o Amazon Personalize usa para gerar recomendações.  
Por exemplo, você pode ter várias colunas no conjunto de dados de itens, mas deseja usar somente o título e a descrição para o treinamento. Você pode incluir somente essas duas colunas para treinamento e o Amazon Personalize considerará somente as colunas incluídas para treinamento.  
Tipo: string para a matriz do mapa de strings  
Entradas do mapa: número máximo de 3 itens.  
Restrições de tamanho de chave: o tamanho máximo é 256.  
Padrão da chave: `^[A-Za-z_]+$`   
Membros da matriz: número máximo de 50 itens.  
Restrições de tamanho: tamanho máximo de 150.  
Padrão: `[A-Za-z_][A-Za-z\d_]*`   
Obrigatório: Não

## Consulte também
<a name="API_TrainingDataConfig_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWSSDKs, consulte o seguinte:
+  [AWSSDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/TrainingDataConfig) 
+  [AWSSDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/TrainingDataConfig) 
+  [AWSSDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/TrainingDataConfig) 

# TunedHPOParams
<a name="API_TunedHPOParams"></a>

Se a otimização de hiperparâmetros (HPO) foi realizada, ela contém os valores de hiperparâmetros do modelo com melhor desempenho.

## Conteúdo
<a name="API_TunedHPOParams_Contents"></a>

 ** algorithmHyperParameters **   <a name="personalize-Type-TunedHPOParams-algorithmHyperParameters"></a>
Uma lista dos valores de hiperparâmetros do modelo com melhor desempenho.  
Tipo: mapa de string para string  
Entradas do mapa: número máximo de 100 itens.  
Restrições de tamanhos de chave: tamanho máximo de 256.  
Restrições de tamanho de valor: tamanho máximo de 1.000.  
Obrigatório: Não

## Consulte também
<a name="API_TunedHPOParams_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/TunedHPOParams) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/TunedHPOParams) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/TunedHPOParams) 

# Eventos do Amazon Personalize
<a name="API_Types_Amazon_Personalize_Events"></a>

Os eventos do Amazon Personalize oferecem suporte aos seguintes tipos de dados:
+  [Action](API_UBS_Action.md) 
+  [ActionInteraction](API_UBS_ActionInteraction.md) 
+  [Event](API_UBS_Event.md) 
+  [Item](API_UBS_Item.md) 
+  [MetricAttribution](API_UBS_MetricAttribution.md) 
+  [User](API_UBS_User.md) 

# Action
<a name="API_UBS_Action"></a>

Representa os metadados da ação adicionados a um conjunto de dados de ações usando a API `PutActions`. Para obter mais informações, consulte [Importar ações individualmente](https://docs.aws.amazon.com/personalize/latest/dg/importing-actions.html). 

## Conteúdo
<a name="API_UBS_Action_Contents"></a>

 ** actionId **   <a name="personalize-Type-UBS_Action-actionId"></a>
O ID associado à ação.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Obrigatório: Sim

 ** properties **   <a name="personalize-Type-UBS_Action-properties"></a>
Um mapa de string de metadados específicos da ação. Cada elemento no mapa consiste em um par de valor de chave. Por exemplo, `{"value": "100"}`.  
As chaves usam nomes em maiúsculas e minúsculas misturadas que correspondem aos campos no esquema do conjunto de dados de usuários. No exemplo anterior, `value` corresponde ao campo “VALUE” definido no esquema Ações. No caso de dados de string categóricos, para incluir várias categorias para uma única ação, separe cada uma com um separador de pipe (`|`). Por exemplo, `\"Deluxe|Premium\"`.  
Tipo: String  
Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 32 mil.  
Obrigatório: Não

## Consulte também
<a name="API_UBS_Action_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/Action) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/Action) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/Action) 

# ActionInteraction
<a name="API_UBS_ActionInteraction"></a>

Representa um evento de interação com ações enviado por meio da API `PutActionInteractions`.

## Conteúdo
<a name="API_UBS_ActionInteraction_Contents"></a>

 ** actionId **   <a name="personalize-Type-UBS_ActionInteraction-actionId"></a>
O ID da ação com a qual o usuário interagiu. Isso corresponde ao campo `ACTION_ID` do esquema de interação com ações.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Obrigatório: Sim

 ** eventType **   <a name="personalize-Type-UBS_ActionInteraction-eventType"></a>
O tipo de evento de interação com ações. É possível especificar tipos de eventos `Viewed`, `Taken` e `Not Taken`. Para obter mais informações sobre dados do tipo de evento de interação com ações, consulte [Dados de tipos de eventos](https://docs.aws.amazon.com/personalize/latest/dg/action-interaction-event-type-data.html).   
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Obrigatório: Sim

 ** sessionId **   <a name="personalize-Type-UBS_ActionInteraction-sessionId"></a>
O ID associado à visita do usuário. Seu aplicativo gera um `sessionId` exclusivo quando alguém visita seu site ou usa seu aplicativo pela primeira vez.   
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Obrigatório: Sim

 ** timestamp **   <a name="personalize-Type-UBS_ActionInteraction-timestamp"></a>
O carimbo de data e hora de quando o evento de interação com ações ocorreu. Os carimbos de data e hora devem estar no formato de hora de época do Unix, em segundos.  
Tipo: Timestamp  
Obrigatório: Sim

 ** eventId **   <a name="personalize-Type-UBS_ActionInteraction-eventId"></a>
Um ID associado ao evento. Se um ID de evento não for fornecido, o Amazon Personalize gerará um ID exclusivo para o evento. Um ID de evento não é usado como entrada para o modelo. O Amazon Personalize usa o ID do evento para distinguir eventos exclusivos. Todos os eventos subsequentes após o primeiro com o mesmo ID de evento não são usados no treinamento do modelo.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Obrigatório: Não

 ** impression **   <a name="personalize-Type-UBS_ActionInteraction-impression"></a>
Uma lista de IDs de ações que representa a sequência de ações que você mostrou ao usuário. Por exemplo, `["actionId1", "actionId2", "actionId3"]`. O Amazon Personalize não usa dados de impressões de eventos de interação com ações. Em vez disso, registre vários eventos para cada ação e use o tipo de evento `Viewed`.   
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 25 itens.  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Obrigatório: Não

 ** properties **   <a name="personalize-Type-UBS_ActionInteraction-properties"></a>
Um mapa de strings de dados específicos do evento que você pode optar por registrar. Por exemplo, se um usuário realizar uma ação diferente do ID da ação, também será possível enviar o número de ações realizadas pelo usuário.  
Cada item no mapa consiste em um par de valor de chave. Por exemplo,  
 `{"numberOfActions": "12"}`   
As chaves usam nomes em maiúsculas e minúsculas misturadas correspondentes aos campos no esquema de interações com ações. No exemplo acima, `numberOfActions` corresponde ao campo “NUMBER\$1OF\$1ACTIONS” definido no esquema de interações com ações.  
 O seguinte não pode ser incluído como uma palavra-chave para propriedades (sem distinção entre maiúsculas e minúsculas).   
+  userId 
+  sessionId 
+ eventType
+ timestamp
+ recommendationId
+ impression
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.024.  
Obrigatório: Não

 ** recommendationId **   <a name="personalize-Type-UBS_ActionInteraction-recommendationId"></a>
O ID da lista de recomendações que contém a ação com a qual o usuário interagiu.  
Tipo: String  
Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 40.  
Obrigatório: Não

 ** userId **   <a name="personalize-Type-UBS_ActionInteraction-userId"></a>
O ID do usuário que interagiu com a ação. Isso corresponde ao campo `USER_ID` do esquema de interação com ações.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Obrigatório: Não

## Consulte também
<a name="API_UBS_ActionInteraction_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/ActionInteraction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/ActionInteraction) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/ActionInteraction) 

# Event
<a name="API_UBS_Event"></a>

Representa as informações do evento de interação com itens enviadas usando a API `PutEvents`.

## Conteúdo
<a name="API_UBS_Event_Contents"></a>

 ** eventType **   <a name="personalize-Type-UBS_Event-eventType"></a>
O tipo de evento, como clicar ou download. Essa propriedade corresponde ao campo `EVENT_TYPE` do esquema do conjunto de dados de interações com itens e depende dos tipos de eventos rastreados.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Obrigatório: Sim

 ** sentAt **   <a name="personalize-Type-UBS_Event-sentAt"></a>
O timestamp (no horário do Unix) no lado do cliente quando o evento ocorreu.  
Tipo: Timestamp  
Obrigatório: Sim

 ** eventId **   <a name="personalize-Type-UBS_Event-eventId"></a>
Um ID associado ao evento. Se um ID de evento não for fornecido, o Amazon Personalize gerará um ID exclusivo para o evento. Um ID de evento não é usado como entrada para o modelo. O Amazon Personalize usa o ID do evento para distinguir eventos exclusivos. Todos os eventos subsequentes após o primeiro com o mesmo ID de evento não são usados no treinamento do modelo.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Obrigatório: Não

 ** eventValue **   <a name="personalize-Type-UBS_Event-eventValue"></a>
O valor do evento que corresponde ao campo `EVENT_VALUE` do esquema de interações com itens.  
Tipo: float  
Obrigatório: Não

 ** impression **   <a name="personalize-Type-UBS_Event-impression"></a>
Uma lista de IDs de itens que representa a sequência de itens que você mostrou ao usuário. Por exemplo, `["itemId1", "itemId2", "itemId3"]`. Forneça uma lista de itens para registrar manualmente os dados de impressões de um evento. Para obter mais informações sobre como gravar dados de impressões, consulte [Gravação de dados de impressões](https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data).   
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 25 itens.  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Obrigatório: Não

 ** itemId **   <a name="personalize-Type-UBS_Event-itemId"></a>
A chave do ID do item que corresponde ao campo `ITEM_ID` do esquema do conjunto de dados de interações com itens.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Obrigatório: Não

 ** metricAttribution **   <a name="personalize-Type-UBS_Event-metricAttribution"></a>
Contém informações sobre uma atribuição métrica associada a um evento. Para obter mais informações sobre as atribuições métricas, consulte [Como medir o impacto das recomendações](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html).  
Tipo: objeto [MetricAttribution](API_UBS_MetricAttribution.md)  
Obrigatório: Não

 ** properties **   <a name="personalize-Type-UBS_Event-properties"></a>
Um mapa de strings de dados específicos do evento que você pode optar por registrar. Por exemplo, se um usuário avaliar um filme em seu site, e não o ID do filme (`itemId`) e da avaliação (`eventValue`), você também poderá enviar o número de avaliações do filme feitas pelo usuário.  
Cada item no mapa consiste em um par de valor de chave. Por exemplo,  
 `{"numberOfRatings": "12"}`   
As chaves usam nomes em maiúsculas e minúsculas misturadas correspondentes aos campos no esquema do conjunto de dados de interações com itens. No exemplo acima, `numberOfRatings` corresponde ao campo “NUMBER\$1OF\$1RATINGS” definido no esquema do conjunto de dados de interações com itens.  
 O seguinte não pode ser incluído como uma palavra-chave para propriedades (sem distinção entre maiúsculas e minúsculas).   
+  userId 
+  sessionId 
+ eventType
+ timestamp
+ recommendationId
+ impression
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.024.  
Obrigatório: Não

 ** recommendationId **   <a name="personalize-Type-UBS_Event-recommendationId"></a>
O ID da lista de recomendações que contém o item com o qual o usuário interagiu. Forneça um `recommendationId` para que o Amazon Personalize registre implicitamente as recomendações que você mostra ao usuário como dados de impressões. Ou forneça uma `recommendationId` se você usar uma atribuição métrica para medir o impacto das recomendações.   
 Para obter mais informações sobre como gravar dados de impressões, consulte [Gravação de dados de impressões](https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data). Para obter mais informações sobre como criar atribuições métricas, consulte [Como medir o impacto das recomendações](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html).   
Tipo: String  
Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 40.  
Obrigatório: Não

## Consulte também
<a name="API_UBS_Event_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/Event) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/Event) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/Event) 

# Item
<a name="API_UBS_Item"></a>

Representa os metadados do item adicionados a um conjunto de dados de itens usando a API `PutItems`. Para obter mais informações, consulte [Como importar itens individualmente](https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html). 

## Conteúdo
<a name="API_UBS_Item_Contents"></a>

 ** itemId **   <a name="personalize-Type-UBS_Item-itemId"></a>
O ID associado ao item.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Obrigatório: Sim

 ** properties **   <a name="personalize-Type-UBS_Item-properties"></a>
Um mapa de strings de metadados específicos do item. Cada elemento no mapa consiste em um par de valor de chave. Por exemplo, `{"numberOfRatings": "12"}`.  
As chaves usam nomes de maiúsculas e minúsculas que correspondem aos campos no esquema do conjunto de dados Itens. No exemplo anterior, `numberOfRatings` corresponde ao campo 'NUMBER\$1OF\$1RATINGS' definido no esquema Itens. No caso de dados de string categóricos, para incluir várias categorias em um único item, separe cada uma com um separador de pipe (`|`). Por exemplo, `\"Horror|Action\"`.  
Tipo: String  
Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 32 mil.  
Obrigatório: Não

## Consulte também
<a name="API_UBS_Item_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/Item) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/Item) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/Item) 

# MetricAttribution
<a name="API_UBS_MetricAttribution"></a>

Contém informações sobre uma atribuição métrica associada a um evento. Para obter mais informações sobre as atribuições métricas, consulte [Como medir o impacto das recomendações](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html).

## Conteúdo
<a name="API_UBS_MetricAttribution_Contents"></a>

 ** eventAttributionSource **   <a name="personalize-Type-UBS_MetricAttribution-eventAttributionSource"></a>
A fonte do evento, como um terceiro.  
Tipo: String  
Restrições de comprimento: comprimento máximo de 1024.  
Padrão: : `^[\x20-\x7E]*[\x21-\x7E]+[\x20-\x7E]*$`   
Exigido: Sim

## Consulte também
<a name="API_UBS_MetricAttribution_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/MetricAttribution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/MetricAttribution) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/MetricAttribution) 

# User
<a name="API_UBS_User"></a>

Representa os metadados do usuário adicionados a um conjunto de dados Usuários usando a API `PutUsers`. Para obter mais informações, consulte [Como importar usuários individuais](https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html).

## Conteúdo
<a name="API_UBS_User_Contents"></a>

 ** userId **   <a name="personalize-Type-UBS_User-userId"></a>
O ID associado ao usuário.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Obrigatório: Sim

 ** properties **   <a name="personalize-Type-UBS_User-properties"></a>
Um mapa de string de metadados específicos do usuário. Cada elemento no mapa consiste em um par de valor de chave. Por exemplo, `{"numberOfVideosWatched": "45"}`.  
As chaves usam nomes de maiúsculas e minúsculas que correspondem aos campos no esquema do conjunto de dados Usuários. No exemplo anterior, `numberOfVideosWatched` corresponde ao campo 'NUMBER\$1OF\$1VIDEOS\$1WATCHED' definido no esquema Usuários. No caso de dados de string categóricos, para incluir várias categorias em um único usuário, separe cada uma com um separador de pipe (`|`). Por exemplo, `\"Member|Frequent shopper\"`.  
Tipo: String  
Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 24 mil.  
Obrigatório: Não

## Consulte também
<a name="API_UBS_User_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/User) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/User) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/User) 

# Runtime do Amazon Personalize
<a name="API_Types_Amazon_Personalize_Runtime"></a>

O runtime do Amazon Personalize oferece suporte aos seguintes tipos de dados:
+  [PredictedAction](API_RS_PredictedAction.md) 
+  [PredictedItem](API_RS_PredictedItem.md) 
+  [Promotion](API_RS_Promotion.md) 

# PredictedAction
<a name="API_RS_PredictedAction"></a>

Um objeto que identifica uma ação.

A API [GetActionRecommendations](API_RS_GetActionRecommendations.md) exibe uma lista de `PredictedAction`s.

## Conteúdo
<a name="API_RS_PredictedAction_Contents"></a>

 ** actionId **   <a name="personalize-Type-RS_PredictedAction-actionId"></a>
O ID da ação recomendada.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

 ** score **   <a name="personalize-Type-RS_PredictedAction-score"></a>
A pontuação da ação recomendada. Para obter informações sobre pontuações de ações, consulte [How action recommendation scoring works](https://docs.aws.amazon.com/personalize/latest/dg/how-action-recommendation-scoring-works.html).  
Tipo: duplo  
Obrigatório: Não

## Consulte também
<a name="API_RS_PredictedAction_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/PredictedAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/PredictedAction) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/PredictedAction) 

# PredictedItem
<a name="API_RS_PredictedItem"></a>

Um objeto que identifica um item.

As APIs [GetRecommendations](API_RS_GetRecommendations.md) e [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) retornam uma lista de `PredictedItem`s.

## Conteúdo
<a name="API_RS_PredictedItem_Contents"></a>

 ** itemId **   <a name="personalize-Type-RS_PredictedItem-itemId"></a>
O ID do item recomendado.  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

 ** metadata **   <a name="personalize-Type-RS_PredictedItem-metadata"></a>
Metadados sobre o item do conjunto de dados de itens.  
Tipo: mapa de string para string  
Restrições de tamanhos de chave: tamanho máximo de 150.  
Restrições de tamanho de valor: tamanho máximo de 20 mil.  
Obrigatório: Não

 ** promotionName **   <a name="personalize-Type-RS_PredictedItem-promotionName"></a>
O nome da promoção que incluiu o item previsto.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** reason **   <a name="personalize-Type-RS_PredictedItem-reason"></a>
Se você usa a fórmula User-Personalization-v2, uma lista dos motivos para que o item seja incluído nas recomendações. Algumas possíveis razões incluem:  
+ Item promovido: indica que o item foi incluído como parte de uma promoção que você aplicou no seu pedido de recomendação.
+ Exploração: indica que o item foi incluído na exploração. Com a exploração, as recomendações incluem itens com menos dados de interações ou relevância para o usuário. Para obter mais informações sobre exploração, consulte [Exploração](https://docs.aws.amazon.com/personalize/latest/dg/use-case-recipe-features.html#about-exploration).
+  Item popular: indica que o item foi incluído como item popular reservado. Se você usar um filtro, dependendo da quantidade de recomendações que o filtro elimina, o Amazon Personalize poderá adicionar itens de espaço reservado para atender a `numResults` do seu pedido de recomendação. Esses itens são populares com base nos dados de interações que satisfazem seus critérios de filtro. Eles não têm uma pontuação de relevância para o usuário. 
Tipo: matriz de strings  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

 ** score **   <a name="personalize-Type-RS_PredictedItem-score"></a>
Uma representação numérica da certeza do modelo de que o item será a próxima seleção do usuário. Para obter mais informações sobre lógica de pontuação, consulte [Pontuações de recomendação](getting-recommendations.md#how-scores-work).  
Tipo: duplo  
Obrigatório: Não

## Consulte também
<a name="API_RS_PredictedItem_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/PredictedItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/PredictedItem) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/PredictedItem) 

# Promotion
<a name="API_RS_Promotion"></a>

Contém informações sobre uma promoção. Uma promoção define regras de negócios adicionais que se aplicam a um subconjunto configurável de itens recomendados.

## Conteúdo
<a name="API_RS_Promotion_Contents"></a>

 ** filterArn **   <a name="personalize-Type-RS_Promotion-filterArn"></a>
O nome do recurso da Amazon (ARN) do filtro usado pela promoção. Esse filtro define os critérios para itens promovidos. Para obter mais informações, consulte [Promoção de filtros](https://docs.aws.amazon.com/personalize/latest/dg/promoting-items.html#promotion-filters).  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Não

 ** filterValues **   <a name="personalize-Type-RS_Promotion-filterValues"></a>
Os valores a serem usados ao promover itens. Para cada parâmetro de espaço reservado na expressão de filtro da sua promoção, forneça o nome do parâmetro (em maiúsculas e minúsculas correspondendo) como uma chave e os valores do filtro como o valor correspondente. Separe vários valores para um parâmetro com uma vírgula.   
Para expressões de filtro que usam um elemento `INCLUDE` para incluir itens, você deve fornecer valores para todos os parâmetros definidos na expressão. Para filtros com expressões que usam um elemento `EXCLUDE` para excluir itens, você pode omitir `filter-values`. Nesse caso, o Amazon Personalize não usa essa parte da expressão para filtrar recomendações.  
Para obter mais informações sobre como criar filtros, consulte [Recomendações de filtragem e segmentos de usuários](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
Tipo: mapa de string para string  
Entradas do mapa: número máximo de 25 itens.  
Restrições de tamanhos de chave: tamanho máximo de 50.  
Padrão da chave: `[A-Za-z0-9_]+`   
Restrições de tamanho de valor: tamanho máximo de 1.000.  
Obrigatório: Não

 ** name **   <a name="personalize-Type-RS_Promotion-name"></a>
O nome da promoção.  
Tipo: String  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: : `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Obrigatório: Não

 ** percentPromotedItems **   <a name="personalize-Type-RS_Promotion-percentPromotedItems"></a>
A porcentagem de itens recomendados aos quais aplicar a promoção.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: Não

## Consulte também
<a name="API_RS_Promotion_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/Promotion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/Promotion) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/Promotion) 

# Erros comuns
<a name="CommonErrors"></a>

Esta seção lista os erros comuns às ações de API de todos os serviços da AWS. Para saber os erros específicos de uma ação de API para esse serviço, consulte o tópico sobre a ação de API em questão.

 **AccessDeniedException**   
Você não tem acesso suficiente para executar essa ação.  
Código de Status HTTP: 400

 **IncompleteSignature**   
A assinatura da solicitação não segue os padrões da AWS.  
Código de Status HTTP: 400

 **InternalFailure**   <a name="CommonErrors-InternalFailure"></a>
O processamento da solicitação falhou por causa de um erro, uma exceção ou uma falha desconhecida.  
Código de Status HTTP: 500

 **InvalidAction**   <a name="CommonErrors-InvalidAction"></a>
A ação ou operação solicitada é inválida. Verifique se a ação foi digitada corretamente.  
Código de Status HTTP: 400

 **InvalidClientTokenId**   <a name="CommonErrors-InvalidClientTokenId"></a>
O certificado X.509 ou o ID de chave de acesso da AWS fornecido não existe em nossos registros.  
Código de status HTTP: 403

 **NotAuthorized**   <a name="CommonErrors-NotAuthorized"></a>
Você não tem permissão para realizar esta ação.  
Código de Status HTTP: 400

 **OptInRequired**   <a name="CommonErrors-OptInRequired"></a>
O ID da chave de acesso da AWS precisa de uma assinatura do serviço.  
Código de status HTTP: 403

 **RequestExpired**   <a name="CommonErrors-RequestExpired"></a>
A solicitação atingiu o serviço mais de 15 minutos após a data na solicitação ou mais de 15 minutos após a data de expiração da solicitação (como para URLs predeterminados), ou a data na solicitação está a mais de 15 minutos no futuro.  
Código de Status HTTP: 400

 **ServiceUnavailable**   <a name="CommonErrors-ServiceUnavailable"></a>
Falha na solicitação devido a um erro temporário do servidor.  
Código de status HTTP: 503

 **ThrottlingException**   <a name="CommonErrors-ThrottlingException"></a>
A solicitação foi negada devido à limitação da solicitação.  
Código de Status HTTP: 400

 **ValidationError**   <a name="CommonErrors-ValidationError"></a>
A entrada não atende às restrições especificadas por um serviço da AWS.  
Código de Status HTTP: 400

# Parâmetros gerais
<a name="CommonParameters"></a>

A lista a seguir contém os parâmetros que todas as ações usam para assinar solicitações do Signature versão 4 com uma string de consulta. Todos os parâmetros específicos de uma ação são listados no tópico para a ação. Para obter mais informações sobre o Signature versão 4, consulte [Solicitações de AWS API de assinatura](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) no *Guia do usuário do IAM*.

 **X-Amz-Algorithm**   <a name="CommonParameters-X-Amz-Algorithm"></a>
O algoritmo de hash que foi usado para criar a assinatura da solicitação.  
Condição: especifique esse parâmetro quando incluir as informações de autenticação em uma string de consulta em vez de no cabeçalho da autorização HTTP.  
Tipo: string  
Valores válidos: `AWS4-HMAC-SHA256`   
Obrigatório: condicional

 **X-Amz-Credential**   <a name="CommonParameters-X-Amz-Credential"></a>
O valor de escopo da credencial, uma string que inclui a sua chave de acesso, a data, a região visada, o serviço que está sendo solicitado e uma sequência de encerramento ("aws4\$1request"). O valor é expresso no seguinte formato: *chave\$1acesso*/*AAAAMMDD*/*região*/*serviço*/aws4\$1request.  
Para obter mais informações, consulte [Criar uma solicitação de AWS API assinada](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) no *Guia do usuário do IAM*.  
Condição: especifique esse parâmetro quando incluir as informações de autenticação em uma string de consulta em vez de no cabeçalho da autorização HTTP.  
Tipo: string  
Obrigatório: Condicional

 **X-Amz-Date**   <a name="CommonParameters-X-Amz-Date"></a>
A data usada para criar a assinatura. O formato deve ser o formato básico ISO 8601 (AAAAMMDD'T'HHMMSS'Z'). Por exemplo, a data e hora a seguir é um X-Amz-Date valor válido:`20120325T120000Z`.  
Condição: X-Amz-Date é opcional para todas as solicitações; ele pode ser usado para substituir a data usada em solicitações de assinatura. Se o cabeçalho da data for especificado no formato básico ISO 8601, não X-Amz-Date é necessário. Quando X-Amz-Date usado, ele sempre substitui o valor do cabeçalho da data. Para obter mais informações, consulte [Elementos de uma assinatura de solicitação de AWS API](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html) no *Guia do usuário do IAM*.  
Tipo: string  
Obrigatório: Condicional

 **X-Amz-Security-Token**   <a name="CommonParameters-X-Amz-Security-Token"></a>
O token de segurança temporário obtido por meio de uma chamada para AWS Security Token Service (AWS STS). Para obter uma lista de serviços que oferecem suporte a credenciais de segurança temporárias do AWS STS, consulte [Serviços da AWS que funcionam com o IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) no *Guia do usuário do IAM*.  
Condição: se você estiver usando credenciais de segurança temporárias do AWS STS, deverá incluir o token de segurança.  
Tipo: string  
Obrigatório: Condicional

 **X-Amz-Signature**   <a name="CommonParameters-X-Amz-Signature"></a>
Especifica a assinatura com codificação hexadecimal que foi calculada com base na string a ser assinada e na chave de assinatura derivada.  
Condição: especifique esse parâmetro quando incluir as informações de autenticação em uma string de consulta em vez de no cabeçalho da autorização HTTP.  
Tipo: string  
Obrigatório: Condicional

 **X-Amz-SignedHeaders**   <a name="CommonParameters-X-Amz-SignedHeaders"></a>
Especifica todos os cabeçalhos HTTP que foram incluídos como parte da solicitação canônica. Para obter mais informações sobre a especificação de cabeçalhos assinados, consulte [Criar uma solicitação de AWS API assinada](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) no Guia do *usuário do IAM*.  
Condição: especifique esse parâmetro quando incluir as informações de autenticação em uma string de consulta em vez de no cabeçalho da autorização HTTP.  
Tipo: string  
Obrigatório: Condicional