Para recursos semelhantes aos do Amazon Timestream para, considere o Amazon Timestream LiveAnalytics para InfluxDB. Ele oferece ingestão de dados simplificada e tempos de resposta de consulta de um dígito em milissegundos para análises em tempo real. Saiba mais [aqui](https://docs.aws.amazon.com//timestream/latest/developerguide/timestream-for-influxdb.html).
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
As seguintes ações são compatíveis com a gravação do Amazon Timestream:
+ [CreateBatchLoadTask](API_CreateBatchLoadTask.md)
+ [CreateDatabase](API_CreateDatabase.md)
+ [CreateTable](API_CreateTable.md)
+ [DeleteDatabase](API_DeleteDatabase.md)
+ [DeleteTable](API_DeleteTable.md)
+ [DescribeBatchLoadTask](API_DescribeBatchLoadTask.md)
+ [DescribeDatabase](API_DescribeDatabase.md)
+ [DescribeEndpoints](API_DescribeEndpoints.md)
+ [DescribeTable](API_DescribeTable.md)
+ [ListBatchLoadTasks](API_ListBatchLoadTasks.md)
+ [ListDatabases](API_ListDatabases.md)
+ [ListTables](API_ListTables.md)
+ [ListTagsForResource](API_ListTagsForResource.md)
+ [ResumeBatchLoadTask](API_ResumeBatchLoadTask.md)
+ [TagResource](API_TagResource.md)
+ [UntagResource](API_UntagResource.md)
+ [UpdateDatabase](API_UpdateDatabase.md)
+ [UpdateTable](API_UpdateTable.md)
+ [WriteRecords](API_WriteRecords.md)
As seguintes ações são compatíveis com a consulta do Amazon Timestream:
+ [CancelQuery](API_query_CancelQuery.md)
+ [CreateScheduledQuery](API_query_CreateScheduledQuery.md)
+ [DeleteScheduledQuery](API_query_DeleteScheduledQuery.md)
+ [DescribeAccountSettings](API_query_DescribeAccountSettings.md)
+ [DescribeEndpoints](API_query_DescribeEndpoints.md)
+ [DescribeScheduledQuery](API_query_DescribeScheduledQuery.md)
+ [ExecuteScheduledQuery](API_query_ExecuteScheduledQuery.md)
+ [ListScheduledQueries](API_query_ListScheduledQueries.md)
+ [ListTagsForResource](API_query_ListTagsForResource.md)
+ [PrepareQuery](API_query_PrepareQuery.md)
+ [Query](API_query_Query.md)
+ [TagResource](API_query_TagResource.md)
+ [UntagResource](API_query_UntagResource.md)
+ [UpdateAccountSettings](API_query_UpdateAccountSettings.md)
+ [UpdateScheduledQuery](API_query_UpdateScheduledQuery.md)
# Gravação do Amazon Timestream
As seguintes ações são compatíveis com a gravação do Amazon Timestream:
+ [CreateBatchLoadTask](API_CreateBatchLoadTask.md)
+ [CreateDatabase](API_CreateDatabase.md)
+ [CreateTable](API_CreateTable.md)
+ [DeleteDatabase](API_DeleteDatabase.md)
+ [DeleteTable](API_DeleteTable.md)
+ [DescribeBatchLoadTask](API_DescribeBatchLoadTask.md)
+ [DescribeDatabase](API_DescribeDatabase.md)
+ [DescribeEndpoints](API_DescribeEndpoints.md)
+ [DescribeTable](API_DescribeTable.md)
+ [ListBatchLoadTasks](API_ListBatchLoadTasks.md)
+ [ListDatabases](API_ListDatabases.md)
+ [ListTables](API_ListTables.md)
+ [ListTagsForResource](API_ListTagsForResource.md)
+ [ResumeBatchLoadTask](API_ResumeBatchLoadTask.md)
+ [TagResource](API_TagResource.md)
+ [UntagResource](API_UntagResource.md)
+ [UpdateDatabase](API_UpdateDatabase.md)
+ [UpdateTable](API_UpdateTable.md)
+ [WriteRecords](API_WriteRecords.md)
# CreateBatchLoadTask
Cria uma tarefa de carregamento em lote do Timestream. Uma tarefa de carregamento em lote processa dados de uma fonte CSV em um local do S3 e grava em uma tabela do Timestream. Um mapeamento da origem para o destino é definido em uma tarefa de carregamento em lote. Erros e eventos são gravados em um relatório em um local do S3. Para o relatório, se a AWS KMS chave não for especificada, o relatório será criptografado com uma chave gerenciada do S3 quando `SSE_S3` for a opção. Caso contrário, um erro será gerado. Para obter mais informações, consulte [Chaves gerenciadas pela AWS](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). [Cotas de serviço se aplicam](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). Consulte a [amostra de código](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-batch-load.html) para obter detalhes.
## Sintaxe da solicitação
```
{
"ClientToken": "string",
"DataModelConfiguration": {
"DataModel": {
"DimensionMappings": [
{
"DestinationColumn": "string",
"SourceColumn": "string"
}
],
"MeasureNameColumn": "string",
"MixedMeasureMappings": [
{
"MeasureName": "string",
"MeasureValueType": "string",
"MultiMeasureAttributeMappings": [
{
"MeasureValueType": "string",
"SourceColumn": "string",
"TargetMultiMeasureAttributeName": "string"
}
],
"SourceColumn": "string",
"TargetMeasureName": "string"
}
],
"MultiMeasureMappings": {
"MultiMeasureAttributeMappings": [
{
"MeasureValueType": "string",
"SourceColumn": "string",
"TargetMultiMeasureAttributeName": "string"
}
],
"TargetMultiMeasureName": "string"
},
"TimeColumn": "string",
"TimeUnit": "string"
},
"DataModelS3Configuration": {
"BucketName": "string",
"ObjectKey": "string"
}
},
"DataSourceConfiguration": {
"CsvConfiguration": {
"ColumnSeparator": "string",
"EscapeChar": "string",
"NullValue": "string",
"QuoteChar": "string",
"TrimWhiteSpace": boolean
},
"DataFormat": "string",
"DataSourceS3Configuration": {
"BucketName": "string",
"ObjectKeyPrefix": "string"
}
},
"RecordVersion": number,
"ReportConfiguration": {
"ReportS3Configuration": {
"BucketName": "string",
"EncryptionOption": "string",
"KmsKeyId": "string",
"ObjectKeyPrefix": "string"
}
},
"TargetDatabaseName": "string",
"TargetTableName": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [ClientToken](#API_CreateBatchLoadTask_RequestSyntax) **
Tipo: string
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 64.
Obrigatório: não
** [DataModelConfiguration](#API_CreateBatchLoadTask_RequestSyntax) **
Tipo: objeto [DataModelConfiguration](API_DataModelConfiguration.md)
Obrigatório: não
** [DataSourceConfiguration](#API_CreateBatchLoadTask_RequestSyntax) **
Define detalhes de configuração sobre a fonte de dados para uma tarefa de carregamento em lote.
Tipo: objeto [DataSourceConfiguration](API_DataSourceConfiguration.md)
Obrigatório: sim
** [RecordVersion](#API_CreateBatchLoadTask_RequestSyntax) **
Tipo: longo
Obrigatório: não
** [ReportConfiguration](#API_CreateBatchLoadTask_RequestSyntax) **
Configuração do relatório para uma tarefa de carregamento em lote. Contém detalhes sobre onde os relatórios de erros são armazenados.
Tipo: objeto [ReportConfiguration](API_ReportConfiguration.md)
Obrigatório: sim
** [TargetDatabaseName](#API_CreateBatchLoadTask_RequestSyntax) **
Banco de dados Timestream de destino para uma tarefa de carregamento em lote.
Tipo: string
Padrão: `[a-zA-Z0-9_.-]+`
Obrigatório: sim
** [TargetTableName](#API_CreateBatchLoadTask_RequestSyntax) **
Tabela de Timestream de destino para uma tarefa de carregamento em lote.
Tipo: string
Padrão: `[a-zA-Z0-9_.-]+`
Obrigatório: sim
## Sintaxe da resposta
```
{
"TaskId": "string"
}
```
## Elementos de resposta
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.
** [TaskId](#API_CreateBatchLoadTask_ResponseSyntax) **
ID da tarefa de carregamento em lote.
Tipo: string
Restrições de tamanho: comprimento mínimo de 3. O comprimento máximo é 32.
Padrão: `[A-Z0-9]+`
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem autorização para executar esta ação.
Código de status HTTP: 400
** ConflictException **
O Timestream não conseguiu processar essa solicitação porque ela contém um recurso que já existe.
Código de status HTTP: 400
** InternalServerException **
O Timestream não conseguiu processar totalmente essa solicitação devido a um erro interno do servidor.
Código de status HTTP: 500
** InvalidEndpointException **
O endpoint solicitado não era válido.
Código de status HTTP: 400
** ResourceNotFoundException **
A operação tentou acessar um recurso inexistente. O recurso pode não estar especificado corretamente ou seu status pode não ser ATIVO.
Código de status HTTP: 400
** ServiceQuotaExceededException **
A cota de instância do recurso foi excedida para essa conta.
Código de status HTTP: 400
** ThrottlingException **
Muitas solicitações foram feitas por um usuário e elas excederam as cotas de serviço. A solicitação foi acelerada.
Código de status HTTP: 400
** ValidationException **
Uma solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/CreateBatchLoadTask)
# CreateDatabase
Cria um banco de dados do Timestream. Se a AWS KMS chave não for especificada, o banco de dados será criptografado com uma AWS KMS chave gerenciada do Timestream localizada em sua conta. Para obter mais informações, consulte [Chaves gerenciadas pela AWS](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). [Cotas de serviço se aplicam](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). Consulte a [amostra de código](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-db.html) para obter detalhes.
## Sintaxe da solicitação
```
{
"DatabaseName": "string",
"KmsKeyId": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [DatabaseName](#API_CreateDatabase_RequestSyntax) **
O nome do banco de dados do Timestream.
Tipo: string
Restrições de tamanho: tamanho mínimo 3. Tamanho máximo de 256.
Padrão: `[a-zA-Z0-9_.-]+`
Obrigatório: Sim
** [KmsKeyId](#API_CreateDatabase_RequestSyntax) **
A AWS KMS chave para o banco de dados. Se a AWS KMS chave não for especificada, o banco de dados será criptografado com uma AWS KMS chave gerenciada do Timestream localizada em sua conta. Para obter mais informações, consulte [Chaves gerenciadas pela AWS](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).
Tipo: string
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 2.048.
Obrigatório: não
** [Tags](#API_CreateDatabase_RequestSyntax) **
Uma lista de pares de chave-valor para rotular a tabela.
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
```
{
"Database": {
"Arn": "string",
"CreationTime": number,
"DatabaseName": "string",
"KmsKeyId": "string",
"LastUpdatedTime": number,
"TableCount": number
}
}
```
## Elementos de resposta
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.
** [Database](#API_CreateDatabase_ResponseSyntax) **
O banco de dados do Timestream criado recentemente.
Tipo: objeto [Database](API_Database.md)
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem autorização para executar esta ação.
Código de status HTTP: 400
** ConflictException **
O Timestream não conseguiu processar essa solicitação porque ela contém um recurso que já existe.
Código de status HTTP: 400
** InternalServerException **
O Timestream não conseguiu processar totalmente essa solicitação devido a um erro interno do servidor.
Código de status HTTP: 500
** InvalidEndpointException **
O endpoint solicitado não era válido.
Código de status HTTP: 400
** InvalidEndpointException **
O endpoint solicitado não era válido.
Código de status HTTP: 400
** ServiceQuotaExceededException **
A cota de instância do recurso foi excedida para essa conta.
Código de status HTTP: 400
** ThrottlingException **
Muitas solicitações foram feitas por um usuário e elas excederam as cotas de serviço. A solicitação foi acelerada.
Código de status HTTP: 400
** ValidationException **
Uma solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/CreateDatabase)
# CreateTable
Adiciona uma nova tabela a um banco de dados existente em sua conta. Em um Conta da AWS, os nomes das tabelas devem ser pelo menos exclusivos em cada região se estiverem no mesmo banco de dados. Será possível ter nomes de tabela idênticos na mesma região se as tabelas estiverem em bancos de dados separados. Ao criar a tabela, especifique o nome da tabela, o nome do banco de dados e as propriedades de retenção. [Cotas de serviço se aplicam](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). Consulte a [amostra de código](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-table.html) para obter detalhes.
## Sintaxe da solicitação
```
{
"DatabaseName": "string",
"MagneticStoreWriteProperties": {
"EnableMagneticStoreWrites": boolean,
"MagneticStoreRejectedDataLocation": {
"S3Configuration": {
"BucketName": "string",
"EncryptionOption": "string",
"KmsKeyId": "string",
"ObjectKeyPrefix": "string"
}
}
},
"RetentionProperties": {
"MagneticStoreRetentionPeriodInDays": number,
"MemoryStoreRetentionPeriodInHours": number
},
"Schema": {
"CompositePartitionKey": [
{
"EnforcementInRecord": "string",
"Name": "string",
"Type": "string"
}
]
},
"TableName": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [DatabaseName](#API_CreateTable_RequestSyntax) **
O nome do banco de dados do Timestream.
Tipo: string
Restrições de tamanho: tamanho mínimo 3. Tamanho máximo de 256.
Padrão: `[a-zA-Z0-9_.-]+`
Obrigatório: sim
** [MagneticStoreWriteProperties](#API_CreateTable_RequestSyntax) **
Contém propriedades a serem definidas na tabela ao habilitar gravações de armazenamento magnético.
Tipo: objeto [MagneticStoreWriteProperties](API_MagneticStoreWriteProperties.md)
Obrigatório: não
** [RetentionProperties](#API_CreateTable_RequestSyntax) **
O período durante o qual seus dados de séries temporais devem ser armazenados na memória e no armazenamento magnético.
Tipo: objeto [RetentionProperties](API_RetentionProperties.md)
Obrigatório: não
** [Schema](#API_CreateTable_RequestSyntax) **
O esquema da tabela.
Tipo: objeto [Schema](API_Schema.md)
Obrigatório: não
** [TableName](#API_CreateTable_RequestSyntax) **
O nome da tabela do Timestream.
Tipo: string
Restrições de tamanho: tamanho mínimo 3. Tamanho máximo de 256.
Padrão: `[a-zA-Z0-9_.-]+`
Obrigatório: sim
** [Tags](#API_CreateTable_RequestSyntax) **
Uma lista de pares de chave-valor para rotular a tabela.
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
```
{
"Table": {
"Arn": "string",
"CreationTime": number,
"DatabaseName": "string",
"LastUpdatedTime": number,
"MagneticStoreWriteProperties": {
"EnableMagneticStoreWrites": boolean,
"MagneticStoreRejectedDataLocation": {
"S3Configuration": {
"BucketName": "string",
"EncryptionOption": "string",
"KmsKeyId": "string",
"ObjectKeyPrefix": "string"
}
}
},
"RetentionProperties": {
"MagneticStoreRetentionPeriodInDays": number,
"MemoryStoreRetentionPeriodInHours": number
},
"Schema": {
"CompositePartitionKey": [
{
"EnforcementInRecord": "string",
"Name": "string",
"Type": "string"
}
]
},
"TableName": "string",
"TableStatus": "string"
}
}
```
## Elementos de resposta
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.
** [Table](#API_CreateTable_ResponseSyntax) **
A tabela Timestream recém-criada.
Tipo: objeto [Table](API_Table.md)
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem autorização para executar esta ação.
Código de status HTTP: 400
** ConflictException **
O Timestream não conseguiu processar essa solicitação porque ela contém um recurso que já existe.
Código de status HTTP: 400
** InternalServerException **
O Timestream não conseguiu processar totalmente essa solicitação devido a um erro interno do servidor.
Código de status HTTP: 500
** InvalidEndpointException **
O endpoint solicitado não era válido.
Código de status HTTP: 400
** InvalidEndpointException **
O endpoint solicitado não era válido.
Código de status HTTP: 400
** ResourceNotFoundException **
A operação tentou acessar um recurso inexistente. O recurso pode não estar especificado corretamente ou seu status pode não ser ATIVO.
Código de status HTTP: 400
** ServiceQuotaExceededException **
A cota de instância do recurso foi excedida para essa conta.
Código de status HTTP: 400
** ThrottlingException **
Muitas solicitações foram feitas por um usuário e elas excederam as cotas de serviço. A solicitação foi acelerada.
Código de status HTTP: 400
** ValidationException **
Uma solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/CreateTable)
# DeleteDatabase
Exclui um determinado banco de dados do Timestream. *Essa operação é irreversível. Depois que um banco de dados é excluído, os dados de séries temporais de suas tabelas não podem ser recuperados.*
**nota**
Todas as tabelas no banco de dados devem ser excluídas primeiro, ou um ValidationException erro será gerado.
Devido à natureza das novas tentativas distribuídas, a operação pode retornar um sucesso ou um ResourceNotFoundException. Os clientes devem considerá-los equivalentes.
Consulte a [amostra de código](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-db.html) para obter detalhes.
## Sintaxe da solicitação
```
{
"DatabaseName": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [DatabaseName](#API_DeleteDatabase_RequestSyntax) **
O nome do banco de dados do Timestream a ser excluído.
Tipo: string
Restrições de tamanho: tamanho mínimo 3. O comprimento máximo é 256.
Obrigatório: sim
## Elementos de resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem autorização para executar esta ação.
Código de status HTTP: 400
** InternalServerException **
O Timestream não conseguiu processar totalmente essa solicitação devido a um erro interno do servidor.
Código de status HTTP: 500
** InvalidEndpointException **
O endpoint solicitado não era válido.
Código de status HTTP: 400
** ResourceNotFoundException **
A operação tentou acessar um recurso inexistente. O recurso pode não estar especificado corretamente ou seu status pode não ser ATIVO.
Código de status HTTP: 400
** ThrottlingException **
Muitas solicitações foram feitas por um usuário e elas excederam as cotas de serviço. A solicitação foi acelerada.
Código de status HTTP: 400
** ValidationException **
Uma solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DeleteDatabase)
# DeleteTable
Exclui uma determinada tabela de Timestream. Essa operação é irreversível. Depois que uma tabela do banco de dados Timestream é excluída, os dados de série temporais armazenados na tabela não podem ser recuperados.
**nota**
Devido à natureza das novas tentativas distribuídas, a operação pode retornar um sucesso ou um ResourceNotFoundException. Os clientes devem considerá-los equivalentes.
Consulte a [amostra de código](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-table.html) para obter detalhes.
## Sintaxe da solicitação
```
{
"DatabaseName": "string",
"TableName": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [DatabaseName](#API_DeleteTable_RequestSyntax) **
O nome do banco de dados no qual o banco de dados do Timestream deve ser excluído.
Tipo: string
Restrições de tamanho: tamanho mínimo 3. O comprimento máximo é 256.
Obrigatório: sim
** [TableName](#API_DeleteTable_RequestSyntax) **
Nome da tabela do Timestream a ser excluída.
Tipo: string
Restrições de tamanho: tamanho mínimo 3. O comprimento máximo é 256.
Obrigatório: sim
## Elementos de resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem autorização para executar esta ação.
Código de status HTTP: 400
** InternalServerException **
O Timestream não conseguiu processar totalmente essa solicitação devido a um erro interno do servidor.
Código de status HTTP: 500
** InvalidEndpointException **
O endpoint solicitado não era válido.
Código de status HTTP: 400
** ResourceNotFoundException **
A operação tentou acessar um recurso inexistente. O recurso pode não estar especificado corretamente ou seu status pode não ser ATIVO.
Código de status HTTP: 400
** ThrottlingException **
Muitas solicitações foram feitas por um usuário e elas excederam as cotas de serviço. A solicitação foi acelerada.
Código de status HTTP: 400
** ValidationException **
Uma solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DeleteTable)
# DescribeBatchLoadTask
Retorna informações sobre a tarefa de carregamento em lote, incluindo configurações, mapeamentos, progresso e outros detalhes. [Cotas de serviço se aplicam](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). Consulte a [amostra de código](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-batch-load.html) para obter detalhes.
## Sintaxe da solicitação
```
{
"TaskId": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [TaskId](#API_DescribeBatchLoadTask_RequestSyntax) **
ID da tarefa de carregamento em lote.
Tipo: string
Restrições de tamanho: comprimento mínimo de 3. O comprimento máximo é 32.
Padrão: `[A-Z0-9]+`
Obrigatório: sim
## Sintaxe da resposta
```
{
"BatchLoadTaskDescription": {
"CreationTime": number,
"DataModelConfiguration": {
"DataModel": {
"DimensionMappings": [
{
"DestinationColumn": "string",
"SourceColumn": "string"
}
],
"MeasureNameColumn": "string",
"MixedMeasureMappings": [
{
"MeasureName": "string",
"MeasureValueType": "string",
"MultiMeasureAttributeMappings": [
{
"MeasureValueType": "string",
"SourceColumn": "string",
"TargetMultiMeasureAttributeName": "string"
}
],
"SourceColumn": "string",
"TargetMeasureName": "string"
}
],
"MultiMeasureMappings": {
"MultiMeasureAttributeMappings": [
{
"MeasureValueType": "string",
"SourceColumn": "string",
"TargetMultiMeasureAttributeName": "string"
}
],
"TargetMultiMeasureName": "string"
},
"TimeColumn": "string",
"TimeUnit": "string"
},
"DataModelS3Configuration": {
"BucketName": "string",
"ObjectKey": "string"
}
},
"DataSourceConfiguration": {
"CsvConfiguration": {
"ColumnSeparator": "string",
"EscapeChar": "string",
"NullValue": "string",
"QuoteChar": "string",
"TrimWhiteSpace": boolean
},
"DataFormat": "string",
"DataSourceS3Configuration": {
"BucketName": "string",
"ObjectKeyPrefix": "string"
}
},
"ErrorMessage": "string",
"LastUpdatedTime": number,
"ProgressReport": {
"BytesMetered": number,
"FileFailures": number,
"ParseFailures": number,
"RecordIngestionFailures": number,
"RecordsIngested": number,
"RecordsProcessed": number
},
"RecordVersion": number,
"ReportConfiguration": {
"ReportS3Configuration": {
"BucketName": "string",
"EncryptionOption": "string",
"KmsKeyId": "string",
"ObjectKeyPrefix": "string"
}
},
"ResumableUntil": number,
"TargetDatabaseName": "string",
"TargetTableName": "string",
"TaskId": "string",
"TaskStatus": "string"
}
}
```
## Elementos de resposta
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.
** [BatchLoadTaskDescription](#API_DescribeBatchLoadTask_ResponseSyntax) **
Descrição da tarefa de carregamento em lote.
Tipo: objeto [BatchLoadTaskDescription](API_BatchLoadTaskDescription.md)
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem autorização para executar esta ação.
Código de status HTTP: 400
** InternalServerException **
O Timestream não conseguiu processar totalmente essa solicitação devido a um erro interno do servidor.
Código de status HTTP: 500
** InvalidEndpointException **
O endpoint solicitado não era válido.
Código de status HTTP: 400
** ResourceNotFoundException **
A operação tentou acessar um recurso inexistente. O recurso pode não estar especificado corretamente ou seu status pode não ser ATIVO.
Código de status HTTP: 400
** ThrottlingException **
Muitas solicitações foram feitas por um usuário e elas excederam as cotas de serviço. A solicitação foi acelerada.
Código de status HTTP: 400
## Consulte também
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/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DescribeBatchLoadTask)
# DescribeDatabase
Retorna informações sobre o banco de dados, incluindo o nome do banco de dados, a hora em que o banco de dados foi criado e o número total de tabelas encontradas no banco de dados. [Cotas de serviço se aplicam](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). Consulte a [amostra de código](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-db.html) para obter detalhes.
## Sintaxe da solicitação
```
{
"DatabaseName": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [DatabaseName](#API_DescribeDatabase_RequestSyntax) **
O nome do banco de dados do Timestream.
Tipo: string
Restrições de tamanho: tamanho mínimo 3. O comprimento máximo é 256.
Obrigatório: sim
## Sintaxe da resposta
```
{
"Database": {
"Arn": "string",
"CreationTime": number,
"DatabaseName": "string",
"KmsKeyId": "string",
"LastUpdatedTime": number,
"TableCount": number
}
}
```
## Elementos de resposta
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.
** [Database](#API_DescribeDatabase_ResponseSyntax) **
O nome da tabela do Timestream.
Tipo: objeto [Database](API_Database.md)
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem autorização para executar esta ação.
Código de status HTTP: 400
** InternalServerException **
O Timestream não conseguiu processar totalmente essa solicitação devido a um erro interno do servidor.
Código de status HTTP: 500
** InvalidEndpointException **
O endpoint solicitado não era válido.
Código de status HTTP: 400
** ResourceNotFoundException **
A operação tentou acessar um recurso inexistente. O recurso pode não estar especificado corretamente ou seu status pode não ser ATIVO.
Código de status HTTP: 400
** ThrottlingException **
Muitas solicitações foram feitas por um usuário e elas excederam as cotas de serviço. A solicitação foi acelerada.
Código de status HTTP: 400
** ValidationException **
Uma solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DescribeDatabase)
# DescribeEndpoints
Retorna uma lista de endpoints disponíveis para fazer chamadas de API Timestream. Essa operação de API está disponível por meio da Gravação e da Consulta APIs.
Como o SDKs Timestream foi projetado para trabalhar de forma transparente com a arquitetura do serviço, incluindo o gerenciamento e o mapeamento dos endpoints do serviço, *não recomendamos que você use essa operação de API, a menos que*:
+ Você está usando [endpoints da VPC (AWS PrivateLink) com Timestream](https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints)
+ Seu aplicativo usa uma linguagem de programação que ainda não tem suporte para SDK
+ Você precisa de um melhor controle sobre a implantação do lado do cliente
Para obter informações detalhadas sobre como e quando usar e implementar DescribeEndpoints, consulte [The Endpoint Discovery Pattern](https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery).
## Sintaxe da resposta
```
{
"Endpoints": [
{
"Address": "string",
"CachePeriodInMinutes": number
}
]
}
```
## Elementos de resposta
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.
** [Endpoints](#API_DescribeEndpoints_ResponseSyntax) **
Um objeto `Endpoints` é retornado quando uma solicitação `DescribeEndpoints` é feita.
Tipo: matriz de objetos [Endpoint](API_Endpoint.md)
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** InternalServerException **
O Timestream não conseguiu processar totalmente essa solicitação devido a um erro interno do servidor.
Código de status HTTP: 500
** ThrottlingException **
Muitas solicitações foram feitas por um usuário e elas excederam as cotas de serviço. A solicitação foi acelerada.
Código de status HTTP: 400
** ValidationException **
Uma solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DescribeEndpoints)
# DescribeTable
Retorna informações sobre a tabela, incluindo seu nome, o nome do banco de dados, a duração de retenção do armazenamento de memória e o armazenamento magnético. [Cotas de serviço se aplicam](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). Consulte a [amostra de código](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-table.html) para obter detalhes.
## Sintaxe da solicitação
```
{
"DatabaseName": "string",
"TableName": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [DatabaseName](#API_DescribeTable_RequestSyntax) **
O nome do banco de dados do Timestream.
Tipo: string
Restrições de tamanho: tamanho mínimo 3. O comprimento máximo é 256.
Obrigatório: sim
** [TableName](#API_DescribeTable_RequestSyntax) **
O nome da tabela do Timestream.
Tipo: string
Restrições de tamanho: tamanho mínimo 3. O comprimento máximo é 256.
Obrigatório: sim
## Sintaxe da resposta
```
{
"Table": {
"Arn": "string",
"CreationTime": number,
"DatabaseName": "string",
"LastUpdatedTime": number,
"MagneticStoreWriteProperties": {
"EnableMagneticStoreWrites": boolean,
"MagneticStoreRejectedDataLocation": {
"S3Configuration": {
"BucketName": "string",
"EncryptionOption": "string",
"KmsKeyId": "string",
"ObjectKeyPrefix": "string"
}
}
},
"RetentionProperties": {
"MagneticStoreRetentionPeriodInDays": number,
"MemoryStoreRetentionPeriodInHours": number
},
"Schema": {
"CompositePartitionKey": [
{
"EnforcementInRecord": "string",
"Name": "string",
"Type": "string"
}
]
},
"TableName": "string",
"TableStatus": "string"
}
}
```
## Elementos de resposta
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.
** [Table](#API_DescribeTable_ResponseSyntax) **
Tabela do Timestream.
Tipo: objeto [Table](API_Table.md)
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem autorização para executar esta ação.
Código de status HTTP: 400
** InternalServerException **
O Timestream não conseguiu processar totalmente essa solicitação devido a um erro interno do servidor.
Código de status HTTP: 500
** InvalidEndpointException **
O endpoint solicitado não era válido.
Código de status HTTP: 400
** ResourceNotFoundException **
A operação tentou acessar um recurso inexistente. O recurso pode não estar especificado corretamente ou seu status pode não ser ATIVO.
Código de status HTTP: 400
** ThrottlingException **
Muitas solicitações foram feitas por um usuário e elas excederam as cotas de serviço. A solicitação foi acelerada.
Código de status HTTP: 400
** ValidationException **
Uma solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DescribeTable)
# ListBatchLoadTasks
Fornece uma lista de tarefas de carregamento em lote, junto com o nome, status, até quando a tarefa pode ser retomada e outros detalhes. Consulte a [amostra de código](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-batch-load-tasks.html) para obter detalhes.
## Sintaxe da solicitação
```
{
"MaxResults": number,
"NextToken": "string",
"TaskStatus": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [MaxResults](#API_ListBatchLoadTasks_RequestSyntax) **
O número total de itens para retornar na saída. Se o número total de itens disponíveis for maior que o valor especificado, um NextToken será fornecido na saída. Para retomar a paginação, forneça o NextToken valor como argumento de uma invocação de API subsequente.
Tipo: inteiro
Faixa válida: valor mínimo de 1. Valor máximo de 100.
Obrigatório: não
** [NextToken](#API_ListBatchLoadTasks_RequestSyntax) **
Um token para especificar onde iniciar a paginação. Isso é NextToken de uma resposta previamente truncada.
Tipo: string
Obrigatório: não
** [TaskStatus](#API_ListBatchLoadTasks_RequestSyntax) **
Status da tarefa de carregamento em lote.
Tipo: string
Valores válidos: `CREATED | IN_PROGRESS | FAILED | SUCCEEDED | PROGRESS_STOPPED | PENDING_RESUME`
Obrigatório: não
## Sintaxe da resposta
```
{
"BatchLoadTasks": [
{
"CreationTime": number,
"DatabaseName": "string",
"LastUpdatedTime": number,
"ResumableUntil": number,
"TableName": "string",
"TaskId": "string",
"TaskStatus": "string"
}
],
"NextToken": "string"
}
```
## Elementos de resposta
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.
** [BatchLoadTasks](#API_ListBatchLoadTasks_ResponseSyntax) **
Uma lista de detalhes da tarefa de carregamento em lote.
Tipo: matriz de objetos [BatchLoadTask](API_BatchLoadTask.md)
** [NextToken](#API_ListBatchLoadTasks_ResponseSyntax) **
Um token para especificar onde iniciar a paginação. Forneça o próximo ListBatchLoadTasksRequest.
Tipo: string
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem autorização para executar esta ação.
Código de status HTTP: 400
** InternalServerException **
O Timestream não conseguiu processar totalmente essa solicitação devido a um erro interno do servidor.
Código de status HTTP: 500
** InvalidEndpointException **
O endpoint solicitado não era válido.
Código de status HTTP: 400
** ThrottlingException **
Muitas solicitações foram feitas por um usuário e elas excederam as cotas de serviço. A solicitação foi acelerada.
Código de status HTTP: 400
** ValidationException **
Uma solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ListBatchLoadTasks)
# ListDatabases
Retorna uma lista de seus bancos de dados Timestream. [Cotas de serviço se aplicam](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). Consulte a [amostra de código](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-db.html) para obter detalhes.
## Sintaxe da solicitação
```
{
"MaxResults": number,
"NextToken": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [MaxResults](#API_ListDatabases_RequestSyntax) **
O número total de itens para retornar na saída. Se o número total de itens disponíveis for maior que o valor especificado, um NextToken será fornecido na saída. Para retomar a paginação, forneça o NextToken valor como argumento de uma invocação de API subsequente.
Tipo: inteiro
Intervalo válido: valor mínimo de 1. Valor máximo de 20.
Obrigatório: não
** [NextToken](#API_ListDatabases_RequestSyntax) **
Token de paginação. Para retomar a paginação, forneça o NextToken valor como argumento de uma invocação de API subsequente.
Tipo: string
Obrigatório: não
## Sintaxe da resposta
```
{
"Databases": [
{
"Arn": "string",
"CreationTime": number,
"DatabaseName": "string",
"KmsKeyId": "string",
"LastUpdatedTime": number,
"TableCount": number
}
],
"NextToken": "string"
}
```
## Elementos de resposta
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.
** [Databases](#API_ListDatabases_ResponseSyntax) **
Uma lista de nomes de bancos de dados.
Tipo: matriz de objetos [Database](API_Database.md)
** [NextToken](#API_ListDatabases_ResponseSyntax) **
Token de paginação. Esse parâmetro é retornado quando a resposta está truncada.
Tipo: string
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem autorização para executar esta ação.
Código de status HTTP: 400
** InternalServerException **
O Timestream não conseguiu processar totalmente essa solicitação devido a um erro interno do servidor.
Código de status HTTP: 500
** InvalidEndpointException **
O endpoint solicitado não era válido.
Código de status HTTP: 400
** ThrottlingException **
Muitas solicitações foram feitas por um usuário e elas excederam as cotas de serviço. A solicitação foi acelerada.
Código de status HTTP: 400
** ValidationException **
Uma solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ListDatabases)
# ListTables
Fornece uma lista de tabelas, junto com o nome, o status e as propriedades de retenção de cada tabela. Consulte a [amostra de código](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-table.html) para obter detalhes.
## Sintaxe da solicitação
```
{
"DatabaseName": "string",
"MaxResults": number,
"NextToken": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [DatabaseName](#API_ListTables_RequestSyntax) **
O nome do banco de dados do Timestream.
Tipo: string
Restrições de tamanho: tamanho mínimo 3. O comprimento máximo é 256.
Obrigatório: não
** [MaxResults](#API_ListTables_RequestSyntax) **
O número total de itens para retornar na saída. Se o número total de itens disponíveis for maior que o valor especificado, um NextToken será fornecido na saída. Para retomar a paginação, forneça o NextToken valor como argumento de uma invocação de API subsequente.
Tipo: inteiro
Intervalo válido: valor mínimo de 1. Valor máximo de 20.
Obrigatório: não
** [NextToken](#API_ListTables_RequestSyntax) **
Token de paginação. Para retomar a paginação, forneça o NextToken valor como argumento de uma invocação de API subsequente.
Tipo: string
Obrigatório: não
## Sintaxe da resposta
```
{
"NextToken": "string",
"Tables": [
{
"Arn": "string",
"CreationTime": number,
"DatabaseName": "string",
"LastUpdatedTime": number,
"MagneticStoreWriteProperties": {
"EnableMagneticStoreWrites": boolean,
"MagneticStoreRejectedDataLocation": {
"S3Configuration": {
"BucketName": "string",
"EncryptionOption": "string",
"KmsKeyId": "string",
"ObjectKeyPrefix": "string"
}
}
},
"RetentionProperties": {
"MagneticStoreRetentionPeriodInDays": number,
"MemoryStoreRetentionPeriodInHours": number
},
"Schema": {
"CompositePartitionKey": [
{
"EnforcementInRecord": "string",
"Name": "string",
"Type": "string"
}
]
},
"TableName": "string",
"TableStatus": "string"
}
]
}
```
## Elementos de resposta
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_ListTables_ResponseSyntax) **
Um token para especificar onde iniciar a paginação. Isso é NextToken de uma resposta previamente truncada.
Tipo: string
** [Tables](#API_ListTables_ResponseSyntax) **
Uma lista de tabelas.
Tipo: matriz de objetos [Table](API_Table.md)
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem autorização para executar esta ação.
Código de status HTTP: 400
** InternalServerException **
O Timestream não conseguiu processar totalmente essa solicitação devido a um erro interno do servidor.
Código de status HTTP: 500
** InvalidEndpointException **
O endpoint solicitado não era válido.
Código de status HTTP: 400
** ResourceNotFoundException **
A operação tentou acessar um recurso inexistente. O recurso pode não estar especificado corretamente ou seu status pode não ser ATIVO.
Código de status HTTP: 400
** ThrottlingException **
Muitas solicitações foram feitas por um usuário e elas excederam as cotas de serviço. A solicitação foi acelerada.
Código de status HTTP: 400
** ValidationException **
Uma solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-write-2018-11-01/ListTables)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ListTables)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ListTables)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListTables)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ListTables)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ListTables)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ListTables)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListTables)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ListTables)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ListTables)
# ListTagsForResource
Lista todas as tags em um recurso do Timestream.
## Sintaxe da solicitação
```
{
"ResourceARN": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [ResourceARN](#API_ListTagsForResource_RequestSyntax) **
O recurso do Timestream com as tags a serem listadas. Esse valor é um nome do recurso da Amazon (ARN).
Tipo: string
Restrições de comprimento: tamanho mínimo de 1. O comprimento máximo é 1011.
Obrigatório: sim
## Sintaxe da resposta
```
{
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Elementos de resposta
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) **
As tags atualmente associadas ao recurso Timestream.
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
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** InvalidEndpointException **
O endpoint solicitado não era válido.
Código de status HTTP: 400
** ResourceNotFoundException **
A operação tentou acessar um recurso inexistente. O recurso pode não estar especificado corretamente ou seu status pode não ser ATIVO.
Código de status HTTP: 400
** ThrottlingException **
Muitas solicitações foram feitas por um usuário e elas excederam as cotas de serviço. A solicitação foi acelerada.
Código de status HTTP: 400
** ValidationException **
Uma solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ListTagsForResource)
# ResumeBatchLoadTask
## Sintaxe da solicitação
```
{
"TaskId": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [TaskId](#API_ResumeBatchLoadTask_RequestSyntax) **
O ID da tarefa de carregamento em lote a ser retomada.
Tipo: string
Restrições de tamanho: comprimento mínimo de 3. O comprimento máximo é 32.
Padrão: `[A-Z0-9]+`
Obrigatório: sim
## Elementos de resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem autorização para executar esta ação.
Código de status HTTP: 400
** InternalServerException **
O Timestream não conseguiu processar totalmente essa solicitação devido a um erro interno do servidor.
Código de status HTTP: 500
** InvalidEndpointException **
O endpoint solicitado não era válido.
Código de status HTTP: 400
** ResourceNotFoundException **
A operação tentou acessar um recurso inexistente. O recurso pode não estar especificado corretamente ou seu status pode não ser ATIVO.
Código de status HTTP: 400
** ThrottlingException **
Muitas solicitações foram feitas por um usuário e elas excederam as cotas de serviço. A solicitação foi acelerada.
Código de status HTTP: 400
** ValidationException **
Uma solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ResumeBatchLoadTask)
# TagResource
Associa um conjunto de tags a um recurso Timestream. Em seguida, você pode ativar essas tags definidas pelo usuário para que elas apareçam no console de Faturamento e Gerenciamento de custos para o controle da alocação de custos.
## Sintaxe da solicitação
```
{
"ResourceARN": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [ResourceARN](#API_TagResource_RequestSyntax) **
Identifica o recurso Timestream ao qual as tags devem ser adicionadas. Esse valor é um nome do recurso da Amazon (ARN).
Tipo: string
Restrições de comprimento: tamanho mínimo de 1. O comprimento máximo é 1011.
Obrigatório: sim
** [Tags](#API_TagResource_RequestSyntax) **
As tags a serem atribuídas ao recurso do Amazon Neptune.
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
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** InvalidEndpointException **
O endpoint solicitado não era válido.
Código de status HTTP: 400
** ResourceNotFoundException **
A operação tentou acessar um recurso inexistente. O recurso pode não estar especificado corretamente ou seu status pode não ser ATIVO.
Código de status HTTP: 400
** ServiceQuotaExceededException **
A cota de instância do recurso foi excedida para essa conta.
Código de status HTTP: 400
** ThrottlingException **
Muitas solicitações foram feitas por um usuário e elas excederam as cotas de serviço. A solicitação foi acelerada.
Código de status HTTP: 400
** ValidationException **
Uma solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-write-2018-11-01/TagResource)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/TagResource)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/TagResource)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/TagResource)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/TagResource)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/TagResource)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/TagResource)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/TagResource)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/TagResource)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/TagResource)
# UntagResource
Remove a associação de tags de um recurso Timestream.
## Sintaxe da solicitação
```
{
"ResourceARN": "string",
"TagKeys": [ "string" ]
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [ResourceARN](#API_UntagResource_RequestSyntax) **
O recurso do Timestream do qual as tags serão removidas. Esse valor é um nome do recurso da Amazon (ARN).
Tipo: string
Restrições de comprimento: tamanho mínimo de 1. O comprimento máximo é 1011.
Obrigatório: sim
** [TagKeys](#API_UntagResource_RequestSyntax) **
Uma lista de chaves de tags. As tags existentes do recurso cujas chaves são membros dessa lista serão removidas do recurso Timestream.
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 comprimento máximo é 128.
Obrigatório: sim
## Elementos de resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** InvalidEndpointException **
O endpoint solicitado não era válido.
Código de status HTTP: 400
** ResourceNotFoundException **
A operação tentou acessar um recurso inexistente. O recurso pode não estar especificado corretamente ou seu status pode não ser ATIVO.
Código de status HTTP: 400
** ServiceQuotaExceededException **
A cota de instância do recurso foi excedida para essa conta.
Código de status HTTP: 400
** ThrottlingException **
Muitas solicitações foram feitas por um usuário e elas excederam as cotas de serviço. A solicitação foi acelerada.
Código de status HTTP: 400
** ValidationException **
Uma solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/UntagResource)
# UpdateDatabase
Modifica a AWS KMS chave de um banco de dados existente. Ao atualizar o banco de dados, você deve especificar o nome do banco de dados e o identificador da nova AWS KMS chave a ser usada (`KmsKeyId`). Se houver alguma solicitação simultânea `UpdateDatabase`, o primeiro escritor vence.
Consulte a [amostra de código](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-db.html) para obter detalhes.
## Sintaxe da solicitação
```
{
"DatabaseName": "string",
"KmsKeyId": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [DatabaseName](#API_UpdateDatabase_RequestSyntax) **
O nome do banco de dados.
Tipo: string
Restrições de tamanho: tamanho mínimo 3. O comprimento máximo é 256.
Obrigatório: sim
** [KmsKeyId](#API_UpdateDatabase_RequestSyntax) **
O identificador da nova AWS KMS chave (`KmsKeyId`) a ser usada para criptografar os dados armazenados no banco de dados. Se o `KmsKeyId` atualmente registrado no banco de dados for o mesmo que o `KmsKeyId` na solicitação, nenhuma atualização será feita.
Você pode especificar a `KmsKeyId` usando qualquer um dos seguintes itens:
+ ID da chave: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ ARN da chave: `arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ Nome do alias: `alias/ExampleAlias`
+ ARN do alias: `arn:aws:kms:us-east-1:111122223333:alias/ExampleAlias`
Tipo: string
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 2048.
Obrigatório: sim
## Sintaxe da resposta
```
{
"Database": {
"Arn": "string",
"CreationTime": number,
"DatabaseName": "string",
"KmsKeyId": "string",
"LastUpdatedTime": number,
"TableCount": number
}
}
```
## Elementos de resposta
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.
** [Database](#API_UpdateDatabase_ResponseSyntax) **
Um contêiner de nível superior para uma mesa. Bancos de dados e tabelas são os conceitos fundamentais de gerenciamento no Amazon Timestream. Todas as tabelas em um banco de dados são criptografadas com a mesma AWS KMS chave.
Tipo: objeto [Database](API_Database.md)
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem autorização para executar esta ação.
Código de status HTTP: 400
** InternalServerException **
O Timestream não conseguiu processar totalmente essa solicitação devido a um erro interno do servidor.
Código de status HTTP: 500
** InvalidEndpointException **
O endpoint solicitado não era válido.
Código de status HTTP: 400
** ResourceNotFoundException **
A operação tentou acessar um recurso inexistente. O recurso pode não estar especificado corretamente ou seu status pode não ser ATIVO.
Código de status HTTP: 400
** ServiceQuotaExceededException **
A cota de instância do recurso foi excedida para essa conta.
Código de status HTTP: 400
** ThrottlingException **
Muitas solicitações foram feitas por um usuário e elas excederam as cotas de serviço. A solicitação foi acelerada.
Código de status HTTP: 400
** ValidationException **
Uma solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/UpdateDatabase)
# UpdateTable
Modifica a duração de retenção do armazenamento em memória e do armazenamento magnético para sua tabela Timestream. Observe que a alteração na duração da retenção entra em vigor imediatamente. Por exemplo, se o período de retenção do armazenamento de memória foi inicialmente definido para 2 horas e depois alterado para 24 horas, o armazenamento de memória será capaz de armazenar 24 horas de dados, mas será preenchido com 24 horas de dados 22 horas após a alteração ter sido feita. O Timestream não recupera dados do armazenamento magnético para preencher o armazenamento de memória.
Consulte a [amostra de código](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-table.html) para obter detalhes.
## Sintaxe da solicitação
```
{
"DatabaseName": "string",
"MagneticStoreWriteProperties": {
"EnableMagneticStoreWrites": boolean,
"MagneticStoreRejectedDataLocation": {
"S3Configuration": {
"BucketName": "string",
"EncryptionOption": "string",
"KmsKeyId": "string",
"ObjectKeyPrefix": "string"
}
}
},
"RetentionProperties": {
"MagneticStoreRetentionPeriodInDays": number,
"MemoryStoreRetentionPeriodInHours": number
},
"Schema": {
"CompositePartitionKey": [
{
"EnforcementInRecord": "string",
"Name": "string",
"Type": "string"
}
]
},
"TableName": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [DatabaseName](#API_UpdateTable_RequestSyntax) **
O nome do banco de dados do Timestream.
Tipo: string
Restrições de tamanho: tamanho mínimo 3. O comprimento máximo é 256.
Obrigatório: sim
** [MagneticStoreWriteProperties](#API_UpdateTable_RequestSyntax) **
Contém propriedades a serem definidas na tabela ao habilitar gravações de armazenamento magnético.
Tipo: objeto [MagneticStoreWriteProperties](API_MagneticStoreWriteProperties.md)
Obrigatório: não
** [RetentionProperties](#API_UpdateTable_RequestSyntax) **
A duração da retenção da memória e do armazenamento magnético.
Tipo: objeto [RetentionProperties](API_RetentionProperties.md)
Obrigatório: não
** [Schema](#API_UpdateTable_RequestSyntax) **
O esquema da tabela.
Tipo: objeto [Schema](API_Schema.md)
Obrigatório: não
** [TableName](#API_UpdateTable_RequestSyntax) **
O nome da tabela do Timestream.
Tipo: string
Restrições de tamanho: tamanho mínimo 3. O comprimento máximo é 256.
Obrigatório: sim
## Sintaxe da resposta
```
{
"Table": {
"Arn": "string",
"CreationTime": number,
"DatabaseName": "string",
"LastUpdatedTime": number,
"MagneticStoreWriteProperties": {
"EnableMagneticStoreWrites": boolean,
"MagneticStoreRejectedDataLocation": {
"S3Configuration": {
"BucketName": "string",
"EncryptionOption": "string",
"KmsKeyId": "string",
"ObjectKeyPrefix": "string"
}
}
},
"RetentionProperties": {
"MagneticStoreRetentionPeriodInDays": number,
"MemoryStoreRetentionPeriodInHours": number
},
"Schema": {
"CompositePartitionKey": [
{
"EnforcementInRecord": "string",
"Name": "string",
"Type": "string"
}
]
},
"TableName": "string",
"TableStatus": "string"
}
}
```
## Elementos de resposta
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.
** [Table](#API_UpdateTable_ResponseSyntax) **
A tabela Timestream atualizada.
Tipo: objeto [Table](API_Table.md)
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem autorização para executar esta ação.
Código de status HTTP: 400
** InternalServerException **
O Timestream não conseguiu processar totalmente essa solicitação devido a um erro interno do servidor.
Código de status HTTP: 500
** InvalidEndpointException **
O endpoint solicitado não era válido.
Código de status HTTP: 400
** ResourceNotFoundException **
A operação tentou acessar um recurso inexistente. O recurso pode não estar especificado corretamente ou seu status pode não ser ATIVO.
Código de status HTTP: 400
** ThrottlingException **
Muitas solicitações foram feitas por um usuário e elas excederam as cotas de serviço. A solicitação foi acelerada.
Código de status HTTP: 400
** ValidationException **
Uma solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/UpdateTable)
# WriteRecords
Permite que você grave seus dados de séries temporais no Timestream. É possível especificar um único ponto de dados ou um lote de pontos de dados a serem inseridos no sistema. O Timestream oferece um esquema flexível que detecta automaticamente os nomes das colunas e os tipos de dados das tabelas do Timestream com base nos nomes das dimensões e nos tipos de dados dos pontos de dados especificados ao invocar gravações no banco de dados.
O Timestream é compatível com uma eventual semântica de leitura final consistente. Isso significa que quando você consulta dados imediatamente após gravar um lote de dados no Timestream, os resultados da consulta podem não refletir os resultados de uma operação de gravação recém-concluída. Os resultados também podem incluir alguns dados obsoletos. Se você repetir a solicitação da consulta após um curto período de tempo, os resultados devem retornar os dados mais recentes. [Cotas de serviço se aplicam](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html).
Consulte a [amostra de código](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.write.html) para obter detalhes.
**Upserts**
Você pode usar o parâmetro `Version` em uma solicitação `WriteRecords` para atualizar pontos de dados. O Timestream rastreia um número de versão com cada registro. A `Version` padrão é `1` quando não é especificado para o registro na solicitação. O Timestream atualiza o valor de medida de um registro existente junto com o valor da `Version` quando recebe uma solicitação de gravação com um número de `Version` maior para esse registro. Quando recebe uma solicitação de atualização em que o valor da medida é o mesmo do registro existente, o Timestream ainda atualiza a `Version`, se for maior que o valor existente de `Version`. É possível atualizar um ponto de dados quantas vezes quiser, desde que o valor da `Version` aumente continuamente.
Por exemplo, suponha que você grave um novo registro sem indicar `Version` na solicitação. O Timestream armazena esse registro e o define a `Version` como `1`. Agora, suponha que você tente atualizar esse registro com uma solicitação `WriteRecords` do mesmo registro com um valor de medida diferente, mas, como antes, não forneça a `Version`. Nesse caso, o Timestream rejeitará essa atualização com um `RejectedRecordsException`, já que a versão do registro atualizado não é maior que o valor existente de Versão.
No entanto, se você reenviasse a solicitação de atualização com `Version` definido como `2`, o Timestream conseguiria atualizar o valor do registro e a `Version` seria definida como `2`. Em seguida, suponha que você tenha enviado uma solicitação `WriteRecords` com esse mesmo registro e um valor de medida idêntico, mas com `Version` definida como `3`. Nesse caso, o Timestream apenas atualizaria a `Version` para `3`. Quaisquer atualizações adicionais precisariam enviar um número de versão maior que `3`, ou as solicitações de atualização receberiam um `RejectedRecordsException`.
## Sintaxe da solicitação
```
{
"CommonAttributes": {
"Dimensions": [
{
"DimensionValueType": "string",
"Name": "string",
"Value": "string"
}
],
"MeasureName": "string",
"MeasureValue": "string",
"MeasureValues": [
{
"Name": "string",
"Type": "string",
"Value": "string"
}
],
"MeasureValueType": "string",
"Time": "string",
"TimeUnit": "string",
"Version": number
},
"DatabaseName": "string",
"Records": [
{
"Dimensions": [
{
"DimensionValueType": "string",
"Name": "string",
"Value": "string"
}
],
"MeasureName": "string",
"MeasureValue": "string",
"MeasureValues": [
{
"Name": "string",
"Type": "string",
"Value": "string"
}
],
"MeasureValueType": "string",
"Time": "string",
"TimeUnit": "string",
"Version": number
}
],
"TableName": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [CommonAttributes](#API_WriteRecords_RequestSyntax) **
Um registro que contém os atributos comuns de medida, dimensão, tempo e versão compartilhados entre todos os registros na solicitação. Os atributos de medida e dimensão especificados serão mesclados com os atributos de medida e dimensão no objeto de registros quando os dados forem gravados no Timestream. As dimensões não podem se sobrepor, ou um `ValidationException` será lançado. Em outras palavras, um registro deve conter dimensões com nomes exclusivos.
Tipo: objeto [Record](API_Record.md)
Obrigatório: não
** [DatabaseName](#API_WriteRecords_RequestSyntax) **
O nome do banco de dados do Timestream.
Tipo: string
Restrições de tamanho: tamanho mínimo 3. O comprimento máximo é 256.
Obrigatório: sim
** [Records](#API_WriteRecords_RequestSyntax) **
Uma matriz de registros que contém os atributos exclusivos de medida, dimensão, tempo e versão para cada ponto de dados de série temporal.
Tipo: matriz de objetos [Record](API_Record.md)
Membros da matriz: número mínimo de 1 item. Número máximo de 100 itens.
Obrigatório: sim
** [TableName](#API_WriteRecords_RequestSyntax) **
O nome da tabela do Timestream.
Tipo: string
Restrições de tamanho: tamanho mínimo 3. O comprimento máximo é 256.
Obrigatório: sim
## Sintaxe da resposta
```
{
"RecordsIngested": {
"MagneticStore": number,
"MemoryStore": number,
"Total": number
}
}
```
## Elementos de resposta
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.
** [RecordsIngested](#API_WriteRecords_ResponseSyntax) **
Informações sobre os registros ingeridos por essa solicitação.
Tipo: objeto [RecordsIngested](API_RecordsIngested.md)
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem autorização para executar esta ação.
Código de status HTTP: 400
** InternalServerException **
O Timestream não conseguiu processar totalmente essa solicitação devido a um erro interno do servidor.
Código de status HTTP: 500
** InvalidEndpointException **
O endpoint solicitado não era válido.
Código de status HTTP: 400
** RejectedRecordsException **
WriteRecords lançaria essa exceção nos seguintes casos:
+ Registros com dados duplicados nos quais há vários registros com as mesmas dimensões, registros de data/hora e nomes de medidas, mas:
+ Os valores das medidas são diferentes
+ A versão não está presente na solicitação *ou* o valor da versão no novo registro é igual ou inferior ao valor existente
Nesse caso, se o Timestream rejeitar dados, o campo `ExistingVersion` na resposta `RejectedRecords` indicará a versão atual do registro. Para forçar uma atualização, você pode reenviar a solicitação com uma versão do conjunto de registros com um valor maior que a `ExistingVersion`.
+ Registros com registros de data/hora que estão fora da duração de retenção do armazenamento na memória.
+ Registros com dimensões ou medidas que excedem os limites definidos pelo Timestream.
Para obter mais informações, consulte [Cotas](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) no Guia do desenvolvedor do Amazon Timestream.
** RejectedRecords **
Código de status HTTP: 400
** ResourceNotFoundException **
A operação tentou acessar um recurso inexistente. O recurso pode não estar especificado corretamente ou seu status pode não ser ATIVO.
Código de status HTTP: 400
** ThrottlingException **
Muitas solicitações foram feitas por um usuário e elas excederam as cotas de serviço. A solicitação foi acelerada.
Código de status HTTP: 400
** ValidationException **
Uma solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/WriteRecords)
# Consulta do Amazon Timestream
As seguintes ações são compatíveis com a consulta do Amazon Timestream:
+ [CancelQuery](API_query_CancelQuery.md)
+ [CreateScheduledQuery](API_query_CreateScheduledQuery.md)
+ [DeleteScheduledQuery](API_query_DeleteScheduledQuery.md)
+ [DescribeAccountSettings](API_query_DescribeAccountSettings.md)
+ [DescribeEndpoints](API_query_DescribeEndpoints.md)
+ [DescribeScheduledQuery](API_query_DescribeScheduledQuery.md)
+ [ExecuteScheduledQuery](API_query_ExecuteScheduledQuery.md)
+ [ListScheduledQueries](API_query_ListScheduledQueries.md)
+ [ListTagsForResource](API_query_ListTagsForResource.md)
+ [PrepareQuery](API_query_PrepareQuery.md)
+ [Query](API_query_Query.md)
+ [TagResource](API_query_TagResource.md)
+ [UntagResource](API_query_UntagResource.md)
+ [UpdateAccountSettings](API_query_UpdateAccountSettings.md)
+ [UpdateScheduledQuery](API_query_UpdateScheduledQuery.md)
# CancelQuery
Cancela uma consulta que foi emitida. O cancelamento é fornecido somente se a consulta não tiver sido concluída antes da emissão da solicitação de cancelamento. Como o cancelamento é uma operação idempotente, as solicitações de cancelamento subsequentes retornarão a `CancellationMessage`, indicando que a consulta já foi cancelada. Consulte a [amostra de código](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.cancel-query.html) para obter detalhes.
## Sintaxe da solicitação
```
{
"QueryId": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [QueryId](#API_query_CancelQuery_RequestSyntax) **
O ID da consulta que precisa ser cancelada. `QueryID` é retornado como parte do resultado da consulta.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 64.
Padrão: `[a-zA-Z0-9]+`
Obrigatório: sim
## Sintaxe da resposta
```
{
"CancellationMessage": "string"
}
```
## Elementos de resposta
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.
** [CancellationMessage](#API_query_CancelQuery_ResponseSyntax) **
A `CancellationMessage` é retornada quando uma solicitação `CancelQuery` para a consulta especificada por `QueryId` já foi emitida.
Tipo: string
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem as permissões necessárias para acessar as configurações da conta.
Código de status HTTP: 400
** InternalServerException **
Ocorreu um erro interno ao processar a solicitação.
Código de status HTTP: 400
** InvalidEndpointException **
O endpoint solicitado é inválido.
Código de status HTTP: 400
** ThrottlingException **
A solicitação foi restringida devido ao excesso de solicitações.
Código de status HTTP: 400
** ValidationException **
Solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/CancelQuery)
# CreateScheduledQuery
Crie uma consulta agendada que será executada em seu nome na programação configurada. O Timestream assume a função de execução fornecida como parte do parâmetro `ScheduledQueryExecutionRoleArn` para executar a consulta. É possível utilizar o parâmetro `NotificationConfiguration` para configurar a notificação das suas operações de consulta agendada.
## Sintaxe da solicitação
```
{
"ClientToken": "string",
"ErrorReportConfiguration": {
"S3Configuration": {
"BucketName": "string",
"EncryptionOption": "string",
"ObjectKeyPrefix": "string"
}
},
"KmsKeyId": "string",
"Name": "string",
"NotificationConfiguration": {
"SnsConfiguration": {
"TopicArn": "string"
}
},
"QueryString": "string",
"ScheduleConfiguration": {
"ScheduleExpression": "string"
},
"ScheduledQueryExecutionRoleArn": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"TargetConfiguration": {
"TimestreamConfiguration": {
"DatabaseName": "string",
"DimensionMappings": [
{
"DimensionValueType": "string",
"Name": "string"
}
],
"MeasureNameColumn": "string",
"MixedMeasureMappings": [
{
"MeasureName": "string",
"MeasureValueType": "string",
"MultiMeasureAttributeMappings": [
{
"MeasureValueType": "string",
"SourceColumn": "string",
"TargetMultiMeasureAttributeName": "string"
}
],
"SourceColumn": "string",
"TargetMeasureName": "string"
}
],
"MultiMeasureMappings": {
"MultiMeasureAttributeMappings": [
{
"MeasureValueType": "string",
"SourceColumn": "string",
"TargetMultiMeasureAttributeName": "string"
}
],
"TargetMultiMeasureName": "string"
},
"TableName": "string",
"TimeColumn": "string"
}
}
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [ClientToken](#API_query_CreateScheduledQuery_RequestSyntax) **
Usar a ClientToken torna a chamada para CreateScheduledQuery idempotente, em outras palavras, fazer a mesma solicitação repetidamente produzirá o mesmo resultado. Fazer várias CreateScheduledQuery solicitações idênticas tem o mesmo efeito que fazer uma única solicitação.
+ Se CreateScheduledQuery for chamado sem um`ClientToken`, o Query SDK gerará um `ClientToken` em seu nome.
+ Após oito horas, qualquer solicitação com o mesmo `ClientToken` será tratada como uma nova solicitação.
Tipo: string
Restrições de comprimento: comprimento mínimo de 32. O comprimento máximo é 128.
Obrigatório: não
** [ErrorReportConfiguration](#API_query_CreateScheduledQuery_RequestSyntax) **
Configuração para relatórios de erros. Relatórios de erros serão gerados quando um problema for encontrado ao gravar resultados de consultas.
Tipo: objeto [ErrorReportConfiguration](API_query_ErrorReportConfiguration.md)
Obrigatório: sim
** [KmsKeyId](#API_query_CreateScheduledQuery_RequestSyntax) **
A chave do Amazon KMS utilizada para criptografar o recurso de consulta agendada em repouso. Se a chave do Amazon KMS não for especificada, o recurso de consulta agendada será criptografado com uma chave do Amazon KMS de propriedade do Timestream. Para especificar uma chave do KMS, use o ID de chave, o ARN de chave, o nome de alias ou o ARN de alias. Ao usar um nome de alias, use *alias/* como prefixo.
Se for ErrorReportConfiguration usado `SSE_KMS` como tipo de criptografia, o mesmo KmsKeyId será usado para criptografar o relatório de erros em repouso.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 2.048.
Obrigatório: não
** [Name](#API_query_CreateScheduledQuery_RequestSyntax) **
Nome da consulta agendada.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 64.
Padrão: `[a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+`
Obrigatório: sim
** [NotificationConfiguration](#API_query_CreateScheduledQuery_RequestSyntax) **
Configuração de notificação para a consulta agendada. Uma notificação é enviada pelo Timestream quando uma execução de consulta é finalizada, quando seu estado é atualizado ou quando ela é excluída.
Tipo: objeto [NotificationConfiguration](API_query_NotificationConfiguration.md)
Obrigatório: sim
** [QueryString](#API_query_CreateScheduledQuery_RequestSyntax) **
String de consulta a ser executada. Nomes de parâmetros podem ser especificados no caractere `@` da string de consulta, seguido por um identificador. O parâmetro nomeado `@scheduled_runtime` é reservado e pode ser utilizado na consulta para obter o horário em que ela está programada para ser executada.
O timestamp, calculado de acordo com o ScheduleConfiguration parâmetro, será o valor do `@scheduled_runtime` parâmetro para cada execução de consulta. Por exemplo, considere uma instância de uma consulta agendada em execução em 2021-12-01 00:00:00. Para esse caso, o parâmetro `@scheduled_runtime` é inicializado no registro de data/hora 2021-12-01 00:00:00 ao chamar a consulta.
Tipo: string
Restrições de comprimento: tamanho mínimo de 1. O comprimento máximo é 262144.
Obrigatório: sim
** [ScheduleConfiguration](#API_query_CreateScheduledQuery_RequestSyntax) **
Configuração da programação da consulta.
Tipo: objeto [ScheduleConfiguration](API_query_ScheduleConfiguration.md)
Obrigatório: sim
** [ScheduledQueryExecutionRoleArn](#API_query_CreateScheduledQuery_RequestSyntax) **
O ARN do perfil do IAM que o Timestream assumirá ao executar a consulta agendada.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 2048.
Obrigatório: sim
** [Tags](#API_query_CreateScheduledQuery_RequestSyntax) **
Uma lista de pares chave/valor para rotular a consulta agendada.
Tipo: matriz de objetos [Tag](API_query_Tag.md)
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.
Obrigatório: não
** [TargetConfiguration](#API_query_CreateScheduledQuery_RequestSyntax) **
Configuração utilizada para gravar o resultado de uma consulta.
Tipo: objeto [TargetConfiguration](API_query_TargetConfiguration.md)
Obrigatório: não
## Sintaxe da resposta
```
{
"Arn": "string"
}
```
## Elementos de resposta
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.
** [Arn](#API_query_CreateScheduledQuery_ResponseSyntax) **
ARN referente à consulta agendada criada.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 2.048.
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem as permissões necessárias para acessar as configurações da conta.
Código de status HTTP: 400
** ConflictException **
Não é possível obter resultados de uma consulta cancelada.
Código de status HTTP: 400
** InternalServerException **
Ocorreu um erro interno ao processar a solicitação.
Código de status HTTP: 400
** InvalidEndpointException **
O endpoint solicitado é inválido.
Código de status HTTP: 400
** ServiceQuotaExceededException **
Service quota excedida.
Código de status HTTP: 400
** ThrottlingException **
A solicitação foi restringida devido ao excesso de solicitações.
Código de status HTTP: 400
** ValidationException **
Solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/CreateScheduledQuery)
# DeleteScheduledQuery
Exclui uma determinada consulta agendada. Essa operação é irreversível.
## Sintaxe da solicitação
```
{
"ScheduledQueryArn": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [ScheduledQueryArn](#API_query_DeleteScheduledQuery_RequestSyntax) **
ARN da consulta agendada.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 2048.
Obrigatório: sim
## Elementos de resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem as permissões necessárias para acessar as configurações da conta.
Código de status HTTP: 400
** InternalServerException **
Ocorreu um erro interno ao processar a solicitação.
Código de status HTTP: 400
** InvalidEndpointException **
O endpoint solicitado é inválido.
Código de status HTTP: 400
** ResourceNotFoundException **
Não foi possível encontrar o recurso solicitado.
** ScheduledQueryArn **
ARN da consulta agendada.
Código de status HTTP: 400
** ThrottlingException **
A solicitação foi restringida devido ao excesso de solicitações.
Código de status HTTP: 400
** ValidationException **
Solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/DeleteScheduledQuery)
# DescribeAccountSettings
Descreve as configurações da sua conta que incluem o modelo de preços de consulta e o máximo configurado que TCUs o serviço pode usar para sua carga de trabalho de consulta.
Você será cobrado apenas pela duração das unidades de computação usadas para suas workloads.
## Sintaxe da resposta
```
{
"MaxQueryTCU": number,
"QueryCompute": {
"ComputeMode": "string",
"ProvisionedCapacity": {
"ActiveQueryTCU": number,
"LastUpdate": {
"Status": "string",
"StatusMessage": "string",
"TargetQueryTCU": number
},
"NotificationConfiguration": {
"RoleArn": "string",
"SnsConfiguration": {
"TopicArn": "string"
}
}
}
},
"QueryPricingModel": "string"
}
```
## Elementos de resposta
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.
** [MaxQueryTCU](#API_query_DescribeAccountSettings_ResponseSyntax) **
O número máximo de [unidades computacionais do Timestream](https://docs.aws.amazon.com/timestream/latest/developerguide/tcu.html) (TCUs) que o serviço usará a qualquer momento para atender às suas consultas. Para realizar consultas, é necessário estabelecer uma capacidade mínima de 4 TCU. É possível estabelecer o número máximo de TCU em múltiplos de 4, como 4, 8, 16, 32 e assim por diante. Essa configuração é aplicável somente para o uso sob demanda de (TCUs).
Tipo: inteiro
** [QueryCompute](#API_query_DescribeAccountSettings_ResponseSyntax) **
Um objeto que contém as configurações de uso de Timestream Compute Units (TCUs) em sua conta para a carga de trabalho de consulta. QueryCompute está disponível somente na região Ásia-Pacífico (Mumbai).
Tipo: objeto [QueryComputeResponse](API_query_QueryComputeResponse.md)
** [QueryPricingModel](#API_query_DescribeAccountSettings_ResponseSyntax) **
Modelo de preços para consultas em sua conta.
O parâmetro `QueryPricingModel` é usado por várias operações do Timestream, no entanto, a operação da API `UpdateAccountSettings` não reconhece nenhum valor além de `COMPUTE_UNITS`.
Tipo: string
Valores válidos: `BYTES_SCANNED | COMPUTE_UNITS`
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem as permissões necessárias para acessar as configurações da conta.
Código de status HTTP: 400
** InternalServerException **
Ocorreu um erro interno ao processar a solicitação.
Código de status HTTP: 400
** InvalidEndpointException **
O endpoint solicitado é inválido.
Código de status HTTP: 400
** ThrottlingException **
A solicitação foi restringida devido ao excesso de solicitações.
Código de status HTTP: 400
## Consulte também
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/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/DescribeAccountSettings)
# DescribeEndpoints
DescribeEndpoints retorna uma lista de endpoints disponíveis para fazer chamadas à API Timestream. Essa API está disponível por meio de gravação e consulta.
Como o SDKs Timestream foi projetado para trabalhar de forma transparente com a arquitetura do serviço, incluindo o gerenciamento e o mapeamento dos endpoints do serviço, *não é recomendável usar essa API, a menos que*:
+ Você está usando [endpoints da VPC (AWS PrivateLink) com Timestream ](https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints)
+ Seu aplicativo usa uma linguagem de programação que ainda não tem suporte para SDK
+ Você precisa de um melhor controle sobre a implantação do lado do cliente
Para obter informações detalhadas sobre como e quando usar e implementar DescribeEndpoints, consulte [The Endpoint Discovery Pattern](https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery).
## Sintaxe da resposta
```
{
"Endpoints": [
{
"Address": "string",
"CachePeriodInMinutes": number
}
]
}
```
## Elementos de resposta
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.
** [Endpoints](#API_query_DescribeEndpoints_ResponseSyntax) **
Um objeto `Endpoints` é retornado quando uma solicitação `DescribeEndpoints` é feita.
Tipo: matriz de objetos [Endpoint](API_query_Endpoint.md)
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** InternalServerException **
Ocorreu um erro interno ao processar a solicitação.
Código de status HTTP: 400
** ThrottlingException **
A solicitação foi restringida devido ao excesso de solicitações.
Código de status HTTP: 400
** ValidationException **
Solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/DescribeEndpoints)
# DescribeScheduledQuery
Fornece informações detalhadas a respeito de uma consulta agendada.
## Sintaxe da solicitação
```
{
"ScheduledQueryArn": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [ScheduledQueryArn](#API_query_DescribeScheduledQuery_RequestSyntax) **
ARN da consulta agendada.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 2048.
Obrigatório: sim
## Sintaxe da resposta
```
{
"ScheduledQuery": {
"Arn": "string",
"CreationTime": number,
"ErrorReportConfiguration": {
"S3Configuration": {
"BucketName": "string",
"EncryptionOption": "string",
"ObjectKeyPrefix": "string"
}
},
"KmsKeyId": "string",
"LastRunSummary": {
"ErrorReportLocation": {
"S3ReportLocation": {
"BucketName": "string",
"ObjectKey": "string"
}
},
"ExecutionStats": {
"BytesMetered": number,
"CumulativeBytesScanned": number,
"DataWrites": number,
"ExecutionTimeInMillis": number,
"QueryResultRows": number,
"RecordsIngested": number
},
"FailureReason": "string",
"InvocationTime": number,
"QueryInsightsResponse": {
"OutputBytes": number,
"OutputRows": number,
"QuerySpatialCoverage": {
"Max": {
"PartitionKey": [ "string" ],
"TableArn": "string",
"Value": number
}
},
"QueryTableCount": number,
"QueryTemporalRange": {
"Max": {
"TableArn": "string",
"Value": number
}
}
},
"RunStatus": "string",
"TriggerTime": number
},
"Name": "string",
"NextInvocationTime": number,
"NotificationConfiguration": {
"SnsConfiguration": {
"TopicArn": "string"
}
},
"PreviousInvocationTime": number,
"QueryString": "string",
"RecentlyFailedRuns": [
{
"ErrorReportLocation": {
"S3ReportLocation": {
"BucketName": "string",
"ObjectKey": "string"
}
},
"ExecutionStats": {
"BytesMetered": number,
"CumulativeBytesScanned": number,
"DataWrites": number,
"ExecutionTimeInMillis": number,
"QueryResultRows": number,
"RecordsIngested": number
},
"FailureReason": "string",
"InvocationTime": number,
"QueryInsightsResponse": {
"OutputBytes": number,
"OutputRows": number,
"QuerySpatialCoverage": {
"Max": {
"PartitionKey": [ "string" ],
"TableArn": "string",
"Value": number
}
},
"QueryTableCount": number,
"QueryTemporalRange": {
"Max": {
"TableArn": "string",
"Value": number
}
}
},
"RunStatus": "string",
"TriggerTime": number
}
],
"ScheduleConfiguration": {
"ScheduleExpression": "string"
},
"ScheduledQueryExecutionRoleArn": "string",
"State": "string",
"TargetConfiguration": {
"TimestreamConfiguration": {
"DatabaseName": "string",
"DimensionMappings": [
{
"DimensionValueType": "string",
"Name": "string"
}
],
"MeasureNameColumn": "string",
"MixedMeasureMappings": [
{
"MeasureName": "string",
"MeasureValueType": "string",
"MultiMeasureAttributeMappings": [
{
"MeasureValueType": "string",
"SourceColumn": "string",
"TargetMultiMeasureAttributeName": "string"
}
],
"SourceColumn": "string",
"TargetMeasureName": "string"
}
],
"MultiMeasureMappings": {
"MultiMeasureAttributeMappings": [
{
"MeasureValueType": "string",
"SourceColumn": "string",
"TargetMultiMeasureAttributeName": "string"
}
],
"TargetMultiMeasureName": "string"
},
"TableName": "string",
"TimeColumn": "string"
}
}
}
}
```
## Elementos de resposta
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.
** [ScheduledQuery](#API_query_DescribeScheduledQuery_ResponseSyntax) **
Consulta agendada.
Tipo: objeto [ScheduledQueryDescription](API_query_ScheduledQueryDescription.md)
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem as permissões necessárias para acessar as configurações da conta.
Código de status HTTP: 400
** InternalServerException **
Ocorreu um erro interno ao processar a solicitação.
Código de status HTTP: 400
** InvalidEndpointException **
O endpoint solicitado é inválido.
Código de status HTTP: 400
** ResourceNotFoundException **
Não foi possível encontrar o recurso solicitado.
** ScheduledQueryArn **
ARN da consulta agendada.
Código de status HTTP: 400
** ThrottlingException **
A solicitação foi restringida devido ao excesso de solicitações.
Código de status HTTP: 400
** ValidationException **
Solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/DescribeScheduledQuery)
# ExecuteScheduledQuery
Você pode usar essa API para executar uma consulta agendada manualmente.
Se você ativou `QueryInsights`, essa API também retornará insights e métricas relacionadas à consulta que você executou como parte de uma notificação do Amazon SNS. `QueryInsights` ajuda no ajuste do desempenho de sua consulta. Para mais informações sobre `QueryInsights`, consulte [Uso de insights de consulta para otimizar consultas no Amazon Timestream](https://docs.aws.amazon.com/timestream/latest/developerguide/using-query-insights.html).
## Sintaxe da solicitação
```
{
"ClientToken": "string",
"InvocationTime": number,
"QueryInsights": {
"Mode": "string"
},
"ScheduledQueryArn": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [ClientToken](#API_query_ExecuteScheduledQuery_RequestSyntax) **
Não usado.
Tipo: string
Restrições de comprimento: comprimento mínimo de 32. O comprimento máximo é 128.
Obrigatório: não
** [InvocationTime](#API_query_ExecuteScheduledQuery_RequestSyntax) **
Registro de data/hora em UTC. A consulta será executada como se tivesse sido invocada nesse registro de data/hora.
Tipo: Timestamp
Obrigatório: sim
** [QueryInsights](#API_query_ExecuteScheduledQuery_RequestSyntax) **
Encapsula as configurações para ativar o `QueryInsights`.
A ativação do `QueryInsights` retorna insights e métricas como parte da notificação do Amazon SNS para a consulta executada. Você pode usar o `QueryInsights` para ajustar o desempenho e o custo de sua consulta.
Tipo: objeto [ScheduledQueryInsights](API_query_ScheduledQueryInsights.md)
Obrigatório: não
** [ScheduledQueryArn](#API_query_ExecuteScheduledQuery_RequestSyntax) **
ARN da consulta agendada.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 2048.
Obrigatório: sim
## Elementos de resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem as permissões necessárias para acessar as configurações da conta.
Código de status HTTP: 400
** InternalServerException **
Ocorreu um erro interno ao processar a solicitação.
Código de status HTTP: 400
** InvalidEndpointException **
O endpoint solicitado é inválido.
Código de status HTTP: 400
** ResourceNotFoundException **
Não foi possível encontrar o recurso solicitado.
** ScheduledQueryArn **
ARN da consulta agendada.
Código de status HTTP: 400
** ThrottlingException **
A solicitação foi restringida devido ao excesso de solicitações.
Código de status HTTP: 400
** ValidationException **
Solicitação inválida ou malformada.
Código de status HTTP: 400
## Exemplos
### Mensagem de notificação de consulta agendada para o modo ENABLED\$1WITH\$1RATE\$1CONTROL
O exemplo a seguir mostra uma mensagem de notificação de consulta agendada bem-sucedida para o modo `ENABLED_WITH_RATE_CONTROL` do parâmetro `QueryInsights`.
```
"SuccessNotificationMessage": {
"type": "MANUAL_TRIGGER_SUCCESS",
"arn": "arn:aws:timestream:::scheduled-query/sq-test-49c6ed55-c2e7-4cc2-9956-4a0ecea13420-80e05b035236a4c3",
"scheduledQueryRunSummary": {
"invocationEpochSecond": 1723710546,
"triggerTimeMillis": 1723710547490,
"runStatus": "MANUAL_TRIGGER_SUCCESS",
"executionStats": {
"executionTimeInMillis": 17343,
"dataWrites": 1024,
"bytesMetered": 0,
"cumulativeBytesScanned": 600,
"recordsIngested": 1,
"queryResultRows": 1
},
"queryInsightsResponse": {
"querySpatialCoverage": {
"max": {
"value": 1.0,
"tableArn": "arn:aws:timestream:::database/BaseDb/table/BaseTable",
"partitionKey": [
"measure_name"
]
}
},
"queryTemporalRange": {
"max": {
"value": 2399999999999,
"tableArn": "arn:aws:timestream:::database/BaseDb/table/BaseTable"
}
},
"queryTableCount": 1,
"outputRows": 1,
"outputBytes": 59
}
}
}
```
### Mensagem de notificação de consulta agendada para o modo DISABLED
O exemplo a seguir mostra uma mensagem de notificação de consulta agendada bem-sucedida para o modo `DISABLED` do parâmetro `QueryInsights`.
```
"SuccessNotificationMessage": {
"type": "MANUAL_TRIGGER_SUCCESS",
"arn": "arn:aws:timestream:::scheduled-query/sq-test-fa109d9e-6528-4a0d-ac40-482fa05e657f-140faaeecdc5b2a7",
"scheduledQueryRunSummary": {
"invocationEpochSecond": 1723711401,
"triggerTimeMillis": 1723711402144,
"runStatus": "MANUAL_TRIGGER_SUCCESS",
"executionStats": {
"executionTimeInMillis": 17992,
"dataWrites": 1024,
"bytesMetered": 0,
"cumulativeBytesScanned": 600,
"recordsIngested": 1,
"queryResultRows": 1
}
}
}
```
### Mensagem de notificação de falha para o modo ENABLED\$1WITH\$1RATE\$1CONTROL
O exemplo a seguir mostra uma mensagem de notificação de consulta agendada com falha para o modo `ENABLED_WITH_RATE_CONTROL` do parâmetro `QueryInsights`.
```
"FailureNotificationMessage": {
"type": "MANUAL_TRIGGER_FAILURE",
"arn": "arn:aws:timestream:::scheduled-query/sq-test-b261670d-790c-4116-9db5-0798071b18b1-b7e27a1d79be226d",
"scheduledQueryRunSummary": {
"invocationEpochSecond": 1727915513,
"triggerTimeMillis": 1727915513894,
"runStatus": "MANUAL_TRIGGER_FAILURE",
"executionStats": {
"executionTimeInMillis": 10777,
"dataWrites": 0,
"bytesMetered": 0,
"cumulativeBytesScanned": 0,
"recordsIngested": 0,
"queryResultRows": 4
},
"errorReportLocation": {
"s3ReportLocation": {
"bucketName": "amzn-s3-demo-bucket",
"objectKey": "4my-organization-f7a3c5d065a1a95e/1727915513/MANUAL/1727915513894/5e14b3df-b147-49f4-9331-784f749b68ae"
}
},
"failureReason": "Schedule encountered some errors and is incomplete. Please take a look at error report for further details"
}
}
```
### Mensagem de notificação de falha para o modo DISABLED
O exemplo a seguir mostra uma mensagem de notificação de consulta agendada com falha para o modo `DISABLED` do parâmetro `QueryInsights`.
```
"FailureNotificationMessage": {
"type": "MANUAL_TRIGGER_FAILURE",
"arn": "arn:aws:timestream:::scheduled-query/sq-test-b261670d-790c-4116-9db5-0798071b18b1-b7e27a1d79be226d",
"scheduledQueryRunSummary": {
"invocationEpochSecond": 1727915194,
"triggerTimeMillis": 1727915195119,
"runStatus": "MANUAL_TRIGGER_FAILURE",
"executionStats": {
"executionTimeInMillis": 10777,
"dataWrites": 0,
"bytesMetered": 0,
"cumulativeBytesScanned": 0,
"recordsIngested": 0,
"queryResultRows": 4
},
"errorReportLocation": {
"s3ReportLocation": {
"bucketName": "amzn-s3-demo-bucket",
"objectKey": "4my-organization-b7e27a1d79be226d/1727915194/MANUAL/1727915195119/08dea9f5-9a0a-4e63-a5f7-ded23247bb98"
}
},
"failureReason": "Schedule encountered some errors and is incomplete. Please take a look at error report for further details"
}
}
```
## Consulte também
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/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ExecuteScheduledQuery)
# ListScheduledQueries
Obtém uma lista de todas as consultas agendadas na conta e na região da Amazon do chamador. `ListScheduledQueries`eventualmente é consistente.
## Sintaxe da solicitação
```
{
"MaxResults": number,
"NextToken": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [MaxResults](#API_query_ListScheduledQueries_RequestSyntax) **
O número máximo de itens a retornar na saída. Se o número total de itens disponíveis for maior que o valor especificado, um `NextToken` será fornecido na saída. Para retomar a paginação, forneça o valor `NextToken` no argumento de um comando subsequente `ListScheduledQueriesRequest`.
Tipo: inteiro
Intervalo válido: valor mínimo de 1. Valor máximo de 1.000.
Obrigatório: não
** [NextToken](#API_query_ListScheduledQueries_RequestSyntax) **
Um token de paginação para retomar a paginação.
Tipo: string
Obrigatório: não
## Sintaxe da resposta
```
{
"NextToken": "string",
"ScheduledQueries": [
{
"Arn": "string",
"CreationTime": number,
"ErrorReportConfiguration": {
"S3Configuration": {
"BucketName": "string",
"EncryptionOption": "string",
"ObjectKeyPrefix": "string"
}
},
"LastRunStatus": "string",
"Name": "string",
"NextInvocationTime": number,
"PreviousInvocationTime": number,
"State": "string",
"TargetDestination": {
"TimestreamDestination": {
"DatabaseName": "string",
"TableName": "string"
}
}
}
]
}
```
## Elementos de resposta
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_query_ListScheduledQueries_ResponseSyntax) **
Um token para especificar onde iniciar a paginação. Isso é NextToken de uma resposta previamente truncada.
Tipo: string
** [ScheduledQueries](#API_query_ListScheduledQueries_ResponseSyntax) **
Uma lista de consultas agendadas.
Tipo: matriz de objetos [ScheduledQuery](API_query_ScheduledQuery.md)
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem as permissões necessárias para acessar as configurações da conta.
Código de status HTTP: 400
** InternalServerException **
Ocorreu um erro interno ao processar a solicitação.
Código de status HTTP: 400
** InvalidEndpointException **
O endpoint solicitado é inválido.
Código de status HTTP: 400
** ThrottlingException **
A solicitação foi restringida devido ao excesso de solicitações.
Código de status HTTP: 400
** ValidationException **
Solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ListScheduledQueries)
# ListTagsForResource
Lista todas as tags em um recurso de consulta do Timestream.
## Sintaxe da solicitação
```
{
"MaxResults": number,
"NextToken": "string",
"ResourceARN": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [MaxResults](#API_query_ListTagsForResource_RequestSyntax) **
O número máximo de tarefas a serem retornadas.
Tipo: inteiro
Intervalo válido: valor mínimo de 1. Valor máximo de 200.
Obrigatório: não
** [NextToken](#API_query_ListTagsForResource_RequestSyntax) **
Um token de paginação para retomar a paginação.
Tipo: string
Obrigatório: não
** [ResourceARN](#API_query_ListTagsForResource_RequestSyntax) **
O recurso do Timestream com as tags a serem listadas. Esse valor é um nome do recurso da Amazon (ARN).
Tipo: string
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 2048.
Obrigatório: sim
## Sintaxe da resposta
```
{
"NextToken": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Elementos de resposta
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_query_ListTagsForResource_ResponseSyntax) **
Um token de paginação para retomar a paginação com uma chamada subsequente para `ListTagsForResourceResponse`.
Tipo: string
** [Tags](#API_query_ListTagsForResource_ResponseSyntax) **
As tags atualmente associadas ao recurso Timestream.
Tipo: matriz de objetos [Tag](API_query_Tag.md)
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** InvalidEndpointException **
O endpoint solicitado é inválido.
Código de status HTTP: 400
** ResourceNotFoundException **
Não foi possível encontrar o recurso solicitado.
** ScheduledQueryArn **
ARN da consulta agendada.
Código de status HTTP: 400
** ThrottlingException **
A solicitação foi restringida devido ao excesso de solicitações.
Código de status HTTP: 400
** ValidationException **
Solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ListTagsForResource)
# PrepareQuery
Uma operação síncrona que permite enviar uma consulta com parâmetros a serem armazenados pelo Timestream para execução posterior. O Timestream só suporta o uso desta operação com `ValidateOnly` definido como. `true`
## Sintaxe da solicitação
```
{
"QueryString": "string",
"ValidateOnly": boolean
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [QueryString](#API_query_PrepareQuery_RequestSyntax) **
A string de consulta Timestream que você deseja usar como uma instrução preparada. Nomes de parâmetros podem ser especificados no caractere `@` da string de consulta, seguido por um identificador.
Tipo: string
Restrições de comprimento: tamanho mínimo de 1. O comprimento máximo é 262144.
Obrigatório: sim
** [ValidateOnly](#API_query_PrepareQuery_RequestSyntax) **
Ao definir esse valor como `true`, o Timestream só validará se a string de consulta é uma consulta Timestream válida e não armazenará a consulta preparada para uso posterior.
Tipo: booliano
Obrigatório: não
## Sintaxe da resposta
```
{
"Columns": [
{
"Aliased": boolean,
"DatabaseName": "string",
"Name": "string",
"TableName": "string",
"Type": {
"ArrayColumnInfo": {
"Name": "string",
"Type": "Type"
},
"RowColumnInfo": [
{
"Name": "string",
"Type": "Type"
}
],
"ScalarType": "string",
"TimeSeriesMeasureValueColumnInfo": {
"Name": "string",
"Type": "Type"
}
}
}
],
"Parameters": [
{
"Name": "string",
"Type": {
"ArrayColumnInfo": {
"Name": "string",
"Type": "Type"
},
"RowColumnInfo": [
{
"Name": "string",
"Type": "Type"
}
],
"ScalarType": "string",
"TimeSeriesMeasureValueColumnInfo": {
"Name": "string",
"Type": "Type"
}
}
}
],
"QueryString": "string"
}
```
## Elementos de resposta
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.
** [Columns](#API_query_PrepareQuery_ResponseSyntax) **
Uma lista das colunas da cláusula SELECT da string de consulta enviada.
Tipo: matriz de objetos [SelectColumn](API_query_SelectColumn.md)
** [Parameters](#API_query_PrepareQuery_ResponseSyntax) **
Uma lista de parâmetros usados na sequência de caracteres de consulta enviada.
Tipo: matriz de objetos [ParameterMapping](API_query_ParameterMapping.md)
** [QueryString](#API_query_PrepareQuery_ResponseSyntax) **
A sequência de caracteres de consulta que você deseja preparar.
Tipo: string
Restrições de comprimento: tamanho mínimo de 1. O comprimento máximo é 262144.
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem as permissões necessárias para acessar as configurações da conta.
Código de status HTTP: 400
** InternalServerException **
Ocorreu um erro interno ao processar a solicitação.
Código de status HTTP: 400
** InvalidEndpointException **
O endpoint solicitado é inválido.
Código de status HTTP: 400
** ThrottlingException **
A solicitação foi restringida devido ao excesso de solicitações.
Código de status HTTP: 400
** ValidationException **
Solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/PrepareQuery)
# Query
`Query` é uma operação síncrona que permite que você execute uma consulta em seus dados do Amazon Timestream.
Se você ativou `QueryInsights`, essa API também retornará informações e métricas relacionadas à consulta que você executou. `QueryInsights` ajuda no ajuste do desempenho de sua consulta. Para mais informações sobre `QueryInsights`, consulte [Uso de insights de consulta para otimizar consultas no Amazon Timestream](https://docs.aws.amazon.com/timestream/latest/developerguide/using-query-insights.html).
**nota**
O número máximo de solicitações de API `Query` que você pode fazer com o `QueryInsights` ativado é de 1 consulta por segundo (QPS). Se você exceder essa taxa de consulta, isso poderá resultar em um controle de utilização.
`Query` atingirá o tempo limite após 60 segundos. Você deve atualizar o tempo limite padrão no SDK para suportar um tempo limite de 60 segundos. Consulte a [amostra de código](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.run-query.html) para obter detalhes.
Sua solicitação de consulta falhará nos seguintes casos:
+ Se você enviar uma `Query` solicitação com o mesmo token de cliente fora da janela de idempotência de 5 minutos.
+ Se você enviar uma `Query` solicitação com o mesmo token de cliente, mas alterar outros parâmetros, dentro da janela de idempotência de 5 minutos.
+ Se o tamanho da linha (incluindo os metadados da consulta) exceder 1 MB, a consulta falhará com a seguinte mensagem de erro:
`Query aborted as max page response size has been exceeded by the output result row`
+ Se o principal do IAM do iniciador da consulta e do leitor de resultados não forem os mesmos, and/or o iniciador da consulta e o leitor de resultados não tiverem a mesma string de consulta nas solicitações de consulta, a consulta falhará com um `Invalid pagination token` erro.
## Sintaxe da solicitação
```
{
"ClientToken": "string",
"MaxRows": number,
"NextToken": "string",
"QueryInsights": {
"Mode": "string"
},
"QueryString": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [ClientToken](#API_query_Query_RequestSyntax) **
Sequência exclusiva, com distinção entre maiúsculas e minúsculas, de até 64 caracteres ASCII, especificada quando uma `Query` solicitação é feita. Fornecer um `ClientToken` torna a chamada `Query` *idempotente*. Isso significa que executar a mesma consulta repetidamente produzirá o mesmo resultado. Em outras palavras, fazer várias solicitações `Query` idênticas tem o mesmo efeito de se fazer uma única solicitação. Após o uso `ClientToken` em uma consulta, observe o seguinte:
+ Se a API de consulta for instanciada sem um `ClientToken`, o SDK de consulta gerará um `ClientToken` em seu nome.
+ Se a `Query` invocação contiver apenas o, `ClientToken` mas não incluir um`NextToken`, essa invocação de será `Query` considerada uma nova execução de consulta.
+ Se a invocação contiver `NextToken`, essa invocação específica será considerada uma invocação subsequente de uma chamada anterior para a API de consulta e um conjunto de resultados será retornado.
+ Após 4 horas, qualquer solicitação com a mesma `ClientToken` é tratada como uma nova solicitação.
Tipo: string
Restrições de comprimento: comprimento mínimo de 32. O comprimento máximo é 128.
Obrigatório: não
** [MaxRows](#API_query_Query_RequestSyntax) **
O número total de itens para retornar na saída `Query`. A execução inicial de `Query` com um `MaxRows` valor especificado retornará o conjunto de resultados da consulta em dois casos:
+ O tamanho do resultado é menor que `1MB`.
+ O número de linhas no conjunto de resultados é menor que o valor de `maxRows`.
Caso contrário, a invocação inicial de retorna `Query` apenas a `NextToken`, que pode ser usada em chamadas subsequentes para buscar o conjunto de resultados. Para retomar a paginação, forneça o valor `NextToken` no argumento de um comando subsequente.
Se o tamanho da linha for grande (por exemplo, uma linha tem muitas colunas), o Timestream pode retornar menos linhas para evitar que o tamanho da resposta exceda o limite de 1 MB. Se não `MaxRows` for fornecido, o Timestream enviará o número necessário de linhas para atingir o limite de 1 MB.
Tipo: inteiro
Intervalo válido: valor mínimo de 1. Valor máximo de 1.000.
Obrigatório: não
** [NextToken](#API_query_Query_RequestSyntax) **
Um token de paginação usado para retornar um conjunto de resultados. Quando a API `Query` é invocada usando `NextToken`, essa invocação específica é considerada uma invocação subsequente de uma chamada anterior para `Query`, e um conjunto de resultados é retornado. No entanto, se a `Query` invocação contiver apenas o `ClientToken`, essa invocação de será `Query` considerada uma nova consulta executada.
Observe o seguinte ao usar NextToken em uma consulta:
+ Um token de paginação pode ser usado para até cinco `Query` invocações OU por uma duração de até 1 hora, o que ocorrer primeiro.
+ Usar o mesmo `NextToken` retornará o mesmo conjunto de registros. Para continuar paginando o conjunto de resultados, você deve usar o mais recente `nextToken`.
+ Suponha que uma `Query` invocação retorne dois `NextToken` valores, `TokenA` e `TokenB`. Se `TokenB` for usado em uma `Query` invocação subsequente, será invalidado e `TokenA` não poderá ser reutilizado.
+ Para solicitar um conjunto de resultados anterior de uma consulta após o início da paginação, você deve invocar novamente a API de consulta.
+ O último `NextToken` deve ser usado para paginar até `null` ser retornado, momento em que um novo `NextToken` deve ser usado.
+ Se o principal do IAM do iniciador da consulta e do leitor de resultados não forem os mesmos, and/or o iniciador da consulta e o leitor de resultados não tiverem a mesma string de consulta nas solicitações de consulta, a consulta falhará com um `Invalid pagination token` erro.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 2.048.
Obrigatório: não
** [QueryInsights](#API_query_Query_RequestSyntax) **
Encapsula as configurações para ativar o `QueryInsights`.
A ativação `QueryInsights` retorna insights e métricas, além dos resultados da consulta que você executou. Você pode usar `QueryInsights` para ajustar o desempenho da consulta.
Tipo: objeto [QueryInsights](API_query_QueryInsights.md)
Obrigatório: não
** [QueryString](#API_query_Query_RequestSyntax) **
A consulta a ser executada pelo Timestream.
Tipo: string
Restrições de comprimento: tamanho mínimo de 1. O comprimento máximo é 262144.
Obrigatório: sim
## Sintaxe da resposta
```
{
"ColumnInfo": [
{
"Name": "string",
"Type": {
"ArrayColumnInfo": "ColumnInfo",
"RowColumnInfo": [
"ColumnInfo"
],
"ScalarType": "string",
"TimeSeriesMeasureValueColumnInfo": "ColumnInfo"
}
}
],
"NextToken": "string",
"QueryId": "string",
"QueryInsightsResponse": {
"OutputBytes": number,
"OutputRows": number,
"QuerySpatialCoverage": {
"Max": {
"PartitionKey": [ "string" ],
"TableArn": "string",
"Value": number
}
},
"QueryTableCount": number,
"QueryTemporalRange": {
"Max": {
"TableArn": "string",
"Value": number
}
},
"UnloadPartitionCount": number,
"UnloadWrittenBytes": number,
"UnloadWrittenRows": number
},
"QueryStatus": {
"CumulativeBytesMetered": number,
"CumulativeBytesScanned": number,
"ProgressPercentage": number
},
"Rows": [
{
"Data": [
{
"ArrayValue": [
"Datum"
],
"NullValue": boolean,
"RowValue": "Row",
"ScalarValue": "string",
"TimeSeriesValue": [
{
"Time": "string",
"Value": "Datum"
}
]
}
]
}
]
}
```
## Elementos de resposta
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.
** [ColumnInfo](#API_query_Query_ResponseSyntax) **
Os tipos de dados da coluna do conjunto de resultados retornado.
Tipo: matriz de objetos [ColumnInfo](API_query_ColumnInfo.md)
** [NextToken](#API_query_Query_ResponseSyntax) **
Um token de paginação que pode ser usado novamente em uma `Query` chamada para obter o próximo conjunto de resultados.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 2.048.
** [QueryId](#API_query_Query_ResponseSyntax) **
Um ID exclusivo para a consulta em questão.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 64.
Padrão: `[a-zA-Z0-9]+`
** [QueryInsightsResponse](#API_query_Query_ResponseSyntax) **
Encapsulamentos `QueryInsights` contendo insights e métricas relacionadas à consulta que você executou.
Tipo: objeto [QueryInsightsResponse](API_query_QueryInsightsResponse.md)
** [QueryStatus](#API_query_Query_ResponseSyntax) **
Informações sobre o status da consulta, incluindo progresso e bytes examinados.
Tipo: objeto [QueryStatus](API_query_QueryStatus.md)
** [Rows](#API_query_Query_ResponseSyntax) **
As linhas do conjunto de resultados retornado pela consulta.
Tipo: matriz de objetos [Row](API_query_Row.md)
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem as permissões necessárias para acessar as configurações da conta.
Código de status HTTP: 400
** ConflictException **
Não é possível obter resultados de uma consulta cancelada.
Código de status HTTP: 400
** InternalServerException **
Ocorreu um erro interno ao processar a solicitação.
Código de status HTTP: 400
** InvalidEndpointException **
O endpoint solicitado é inválido.
Código de status HTTP: 400
** QueryExecutionException **
O Timestream não conseguiu executar a consulta com êxito.
Código de status HTTP: 400
** ThrottlingException **
A solicitação foi restringida devido ao excesso de solicitações.
Código de status HTTP: 400
** ValidationException **
Solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-query-2018-11-01/Query)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/Query)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/Query)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/Query)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/Query)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/Query)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/Query)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/Query)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/Query)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/Query)
# TagResource
Associa um conjunto de etiquetas a um recurso do Timestream. Em seguida, você pode ativar essas tags definidas pelo usuário para que elas apareçam no console de Faturamento e Gerenciamento de custos para o controle da alocação de custos.
## Sintaxe da solicitação
```
{
"ResourceARN": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [ResourceARN](#API_query_TagResource_RequestSyntax) **
Identifica o recurso Timestream ao qual as tags devem ser adicionadas. Esse valor é um nome do recurso da Amazon (ARN).
Tipo: string
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 2048.
Obrigatório: sim
** [Tags](#API_query_TagResource_RequestSyntax) **
As tags a serem atribuídas ao recurso do Amazon Neptune.
Tipo: matriz de objetos [Tag](API_query_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
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** InvalidEndpointException **
O endpoint solicitado é inválido.
Código de status HTTP: 400
** ResourceNotFoundException **
Não foi possível encontrar o recurso solicitado.
** ScheduledQueryArn **
ARN da consulta agendada.
Código de status HTTP: 400
** ServiceQuotaExceededException **
Service quota excedida.
Código de status HTTP: 400
** ThrottlingException **
A solicitação foi restringida devido ao excesso de solicitações.
Código de status HTTP: 400
** ValidationException **
Solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-query-2018-11-01/TagResource)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/TagResource)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/TagResource)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/TagResource)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/TagResource)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/TagResource)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/TagResource)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/TagResource)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/TagResource)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/TagResource)
# UntagResource
Remove a associação de tags de um recurso de consulta do Timestream.
## Sintaxe da solicitação
```
{
"ResourceARN": "string",
"TagKeys": [ "string" ]
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [ResourceARN](#API_query_UntagResource_RequestSyntax) **
O recurso do Timestream do qual as tags serão removidas. Esse valor é um nome do recurso da Amazon (ARN).
Tipo: string
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 2048.
Obrigatório: sim
** [TagKeys](#API_query_UntagResource_RequestSyntax) **
Uma lista de chaves de tags. As tags existentes do recurso cujas chaves são membros dessa lista serão removidas do recurso Timestream.
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 comprimento máximo é 128.
Obrigatório: sim
## Elementos de resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** InvalidEndpointException **
O endpoint solicitado é inválido.
Código de status HTTP: 400
** ResourceNotFoundException **
Não foi possível encontrar o recurso solicitado.
** ScheduledQueryArn **
ARN da consulta agendada.
Código de status HTTP: 400
** ThrottlingException **
A solicitação foi restringida devido ao excesso de solicitações.
Código de status HTTP: 400
** ValidationException **
Solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/UntagResource)
# UpdateAccountSettings
Faz a transição da sua conta TCUs para uso nos preços de consulta e modifica o máximo de unidades computacionais de consulta que você configurou. Se você reduzir o valor de `MaxQueryTCU` para a configuração desejada, o novo valor poderá levar até 24 horas para entrar em vigor.
**nota**
Depois de fazer a transição de sua conta TCUs para uso nos preços de consulta, você não pode fazer a transição para o uso de bytes escaneados para preços de consulta.
## Sintaxe da solicitação
```
{
"MaxQueryTCU": number,
"QueryCompute": {
"ComputeMode": "string",
"ProvisionedCapacity": {
"NotificationConfiguration": {
"RoleArn": "string",
"SnsConfiguration": {
"TopicArn": "string"
}
},
"TargetQueryTCU": number
}
},
"QueryPricingModel": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [MaxQueryTCU](#API_query_UpdateAccountSettings_RequestSyntax) **
O número máximo de unidades de computação que o serviço usará em qualquer momento para atender às suas consultas. Para realizar consultas, é necessário estabelecer uma capacidade mínima de 4 TCU. É possível estabelecer o número máximo de TCU em múltiplos de 4, como 4, 8, 16, 32 e assim por diante. O valor máximo compatível para `MaxQueryTCU` é de 1000. Para solicitar um aumento desse limite flexível, entre em contato com o AWS Support. Para obter mais informações sobre cotas padrão para maxQueryTCU, consulte Cotas padrão. Essa configuração é aplicável somente para o uso sob demanda de Timestream Compute Units (). TCUs
O valor máximo compatível para `MaxQueryTCU` é de 1000. Para solicitar um aumento desse limite flexível, entre em contato com o AWS Support. Para obter mais informações sobre cotas padrão para`maxQueryTCU`, consulte [Cotas padrão](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.default).
Tipo: inteiro
Obrigatório: não
** [QueryCompute](#API_query_UpdateAccountSettings_RequestSyntax) **
Modifica as configurações de computação de consulta definidas em sua conta, incluindo o modelo de preços de consulta e as unidades de computação Timestream provisionadas () em sua conta. TCUs QueryCompute está disponível somente na região Ásia-Pacífico (Mumbai).
Essa API é idempotente, o que significa que fazer a mesma solicitação várias vezes terá o mesmo efeito que fazer a solicitação uma vez.
Tipo: objeto [QueryComputeRequest](API_query_QueryComputeRequest.md)
Obrigatório: não
** [QueryPricingModel](#API_query_UpdateAccountSettings_RequestSyntax) **
O modelo de preços para consultas em uma conta.
O parâmetro `QueryPricingModel` é usado por várias operações do Timestream, no entanto, a operação da API `UpdateAccountSettings` não reconhece nenhum valor além de `COMPUTE_UNITS`.
Tipo: string
Valores válidos: `BYTES_SCANNED | COMPUTE_UNITS`
Obrigatório: não
## Sintaxe da resposta
```
{
"MaxQueryTCU": number,
"QueryCompute": {
"ComputeMode": "string",
"ProvisionedCapacity": {
"ActiveQueryTCU": number,
"LastUpdate": {
"Status": "string",
"StatusMessage": "string",
"TargetQueryTCU": number
},
"NotificationConfiguration": {
"RoleArn": "string",
"SnsConfiguration": {
"TopicArn": "string"
}
}
}
},
"QueryPricingModel": "string"
}
```
## Elementos de resposta
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.
** [MaxQueryTCU](#API_query_UpdateAccountSettings_ResponseSyntax) **
O número máximo configurado de unidades de computação que o serviço usará em qualquer momento para atender às suas consultas.
Tipo: inteiro
** [QueryCompute](#API_query_UpdateAccountSettings_ResponseSyntax) **
Confirma as configurações atualizadas da conta para consultar dados em sua conta. QueryCompute está disponível somente na região Ásia-Pacífico (Mumbai).
Tipo: objeto [QueryComputeResponse](API_query_QueryComputeResponse.md)
** [QueryPricingModel](#API_query_UpdateAccountSettings_ResponseSyntax) **
O modelo de preços de uma conta.
Tipo: string
Valores válidos: `BYTES_SCANNED | COMPUTE_UNITS`
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem as permissões necessárias para acessar as configurações da conta.
Código de status HTTP: 400
** InternalServerException **
Ocorreu um erro interno ao processar a solicitação.
Código de status HTTP: 400
** InvalidEndpointException **
O endpoint solicitado é inválido.
Código de status HTTP: 400
** ThrottlingException **
A solicitação foi restringida devido ao excesso de solicitações.
Código de status HTTP: 400
** ValidationException **
Solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/UpdateAccountSettings)
# UpdateScheduledQuery
Atualizar uma consulta agendada.
## Sintaxe da solicitação
```
{
"ScheduledQueryArn": "string",
"State": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [ScheduledQueryArn](#API_query_UpdateScheduledQuery_RequestSyntax) **
ARN da consulta agendada.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 2048.
Obrigatório: sim
** [State](#API_query_UpdateScheduledQuery_RequestSyntax) **
Estado da consulta agendada.
Tipo: string
Valores válidos: `ENABLED | DISABLED`
Obrigatório: sim
## Elementos de resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem as permissões necessárias para acessar as configurações da conta.
Código de status HTTP: 400
** InternalServerException **
Ocorreu um erro interno ao processar a solicitação.
Código de status HTTP: 400
** InvalidEndpointException **
O endpoint solicitado é inválido.
Código de status HTTP: 400
** ResourceNotFoundException **
Não foi possível encontrar o recurso solicitado.
** ScheduledQueryArn **
ARN da consulta agendada.
Código de status HTTP: 400
** ThrottlingException **
A solicitação foi restringida devido ao excesso de solicitações.
Código de status HTTP: 400
** ValidationException **
Solicitação inválida ou malformada.
Código de status HTTP: 400
## Consulte também
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/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/UpdateScheduledQuery)