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á.
CreateBatchSegmentJob
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.
Sintaxe da Solicitação
{
"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 solicitação aceita os dados a seguir no formato JSON.
- filterArn
-
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.
Tipo: string
Restrições de tamanho: o tamanho máximo é 256.
Padrão:
arn:([a-z\d-]+):personalize:.*:.*:.+Obrigatório: não
- jobInput
-
O caminho do Amazon S3 para os dados de entrada usados para gerar o trabalho do segmento em lote.
Tipo: objeto BatchSegmentJobInput
Obrigatório: Sim
- jobName
-
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\-_]*Exigido: Sim
- jobOutput
-
O caminho do Amazon S3 para o bucket no qual a saída do trabalho será armazenada.
Tipo: objeto BatchSegmentJobOutput
Obrigatório: Sim
- numResults
-
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
-
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+=,.@\-_/]+Exigido: Sim
- solutionVersionArn
-
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:.*:.*:.+Exigido: Sim
-
Uma lista de tags a serem aplicadas ao trabalho do segmento em lote.
Tipo: matriz de objetos Tag
Membros da Matriz: número mínimo de 0 itens. Número máximo de 200 itens.
Obrigatório: Não
Sintaxe da Resposta
{
"batchSegmentJobArn": "string"
}Elementos de Resposta
Se a ação tiver êxito, o serviço enviará de volta uma resposta HTTP 200.
Os dados a seguir são retornados no formato JSON pelo serviço.
- batchSegmentJobArn
-
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
- 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
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte:
