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á.

# 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)