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á.
# APIs de consulta do Neptune
**Ações de consulta do Gremlin:**
+ [ExecuteGremlinQuery (ação)](#ExecuteGremlinQuery)
+ [ExecuteGremlinExplainQuery (ação)](#ExecuteGremlinExplainQuery)
+ [ExecuteGremlinProfileQuery (ação)](#ExecuteGremlinProfileQuery)
+ [ListGremlinQueries (ação)](#ListGremlinQueries)
+ [GetGremlinQueryStatus (ação)](#GetGremlinQueryStatus)
+ [CancelGremlinQuery (ação)](#CancelGremlinQuery)
**Ações de consulta do openCypher:**
+ [ExecuteOpenCypherQuery (ação)](#ExecuteOpenCypherQuery)
+ [ExecuteOpenCypherExplainQuery (ação)](#ExecuteOpenCypherExplainQuery)
+ [ListOpenCypherQueries (ação)](#ListOpenCypherQueries)
+ [GetOpenCypherQueryStatus (ação)](#GetOpenCypherQueryStatus)
+ [CancelOpenCypherQuery (ação)](#CancelOpenCypherQuery)
**Estruturas de consulta:**
+ [QueryEvalStats (estrutura)](#QueryEvalStats)
+ [GremlinQueryStatus (estrutura)](#GremlinQueryStatus)
+ [GremlinQueryStatusAttributes (estrutura)](#GremlinQueryStatusAttributes)
## ExecuteGremlinQuery (ação)
O nome da CLI da AWS para essa API é: `execute-gremlin-query`.
Esse comando executa uma consulta do Gremlin. O Amazon Neptune é compatível com o Apache TinkerPop3 e o Gremlin, então você pode usar a linguagem de percursos Gremlin para consultar o grafo, conforme descrito em [The Graph](https://tinkerpop.apache.org/docs/current/reference/#graph) na documentação do Apache TinkerPop3. Mais detalhes também podem ser encontrados em [Acessar o grafo do Neptune com o Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin.html).
Ao invocar essa operação em um cluster do Neptune com a autenticação do IAM habilitada, o usuário ou o perfil do IAM que faz a solicitação deve ter uma política anexada que viabilize uma das seguintes ações do IAM nesse cluster, dependendo da consulta:
+ [neptune-db:ReadDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery)
+ [neptune-db:WriteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery)
+ [neptune-db:DeleteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery)
Observe que a chave de condição do IAM [neptune-db:QueryLanguage:Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) pode ser usada no documento de política para restringir o uso de consultas do Gremlin (consulte [Chaves de condição disponíveis em declarações de política de acesso a dados do IAM do Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)).
**Solicitação**
+ **gremlinQuery** (na CLI: `--gremlin-query`): *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8).
Usando essa API, é possível executar consultas do Gremlin no formato de string da mesma forma que é possível no uso do endpoint HTTP. A interface é compatível com qualquer versão do Gremlin que o cluster de banco de dados esteja usando (consulte a [seção sobre o cliente do Tinkerpop](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-client.html#best-practices-gremlin-java-latest) para determinar qual versão do Gremlin é compatível com a versão do mecanismo).
+ **serializer** (na CLI: `--serializer`): uma string, do tipo: `string` (uma string codificada em UTF-8).
Se não forem nulos, os resultados da consulta serão gerados em uma mensagem de resposta serializada no formato especificado por esse parâmetro. Consulte a seção [GraphSON](https://tinkerpop.apache.org/docs/current/reference/#_graphson) na documentação do TinkerPop para obter uma lista dos formatos compatíveis no momento.
**Resposta**
+ **meta**: um documento, do tipo `document` (um conteúdo aberto independente de protocolo representado por um modelo de dados semelhante a JSON).
Metadados sobre a consulta do Gremlin.
+ **requestId**: uma string, do tipo: `string` (uma string codificada em UTF-8).
O identificador exclusivo da consulta do Gremlin.
+ **result**: um documento, do tipo `document` (um conteúdo aberto independente de protocolo representado por um modelo de dados semelhante a JSON).
A saída da consulta do Gremlin do servidor.
+ **status**: um objeto [GremlinQueryStatusAttributes](#GremlinQueryStatusAttributes).
O status da consulta do Gremlin.
**Erros**
+ [QueryTooLargeException](data-api-dp-errors.md#QueryTooLargeException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [QueryLimitExceededException](data-api-dp-errors.md#QueryLimitExceededException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [QueryLimitException](data-api-dp-errors.md#QueryLimitException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [CancelledByUserException](data-api-dp-errors.md#CancelledByUserException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [MalformedQueryException](data-api-dp-errors.md#MalformedQueryException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## ExecuteGremlinExplainQuery (ação)
O nome da CLI da AWS para essa API é: `execute-gremlin-explain-query`.
Executa uma consulta do Gremlin Explain.
O Amazon Neptune adicionou um atributo do Gremlin denominado `explain` que oferece uma ferramenta de autoatendimento para entender a abordagem de execução adotada pelo mecanismo do Neptune para a consulta. Você o invoca adicionando um parâmetro `explain` a uma chamada HTTP que envia uma consulta do Gremlin.
O atributo explain fornece informações sobre a estrutura lógica dos planos de execução da consulta. É possível usar essas informações para identificar possíveis gargalos de execução e de avaliação e ajustar a consulta, conforme explicado em [Ajustar consultas do Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html). Você também pode usar as dicas de consulta para melhorar os planos de execução das consultas.
Ao invocar essa operação em um cluster do Neptune com a autenticação do IAM habilitada, o usuário ou o perfil do IAM que faz a solicitação deve ter uma política anexada que viabilize uma das seguintes ações do IAM nesse cluster, dependendo da consulta:
+ [neptune-db:ReadDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery)
+ [neptune-db:WriteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery)
+ [neptune-db:DeleteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery)
Observe que a chave de condição do IAM [neptune-db:QueryLanguage:Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) pode ser usada no documento de política para restringir o uso de consultas do Gremlin (consulte [Chaves de condição disponíveis em declarações de política de acesso a dados do IAM do Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)).
**Solicitação**
+ **gremlinQuery** (na CLI: `--gremlin-query`): *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8).
A string de consulta do explain do Gremlin.
**Resposta**
+ **output**: um ReportAsText, do tipo: `blob` (um bloco de dados binários não interpretados).
Um blob de texto que contém o resultado de explain do Gremlin, conforme descrito em [Ajustar consultas do Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html).
**Erros**
+ [QueryTooLargeException](data-api-dp-errors.md#QueryTooLargeException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [QueryLimitExceededException](data-api-dp-errors.md#QueryLimitExceededException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [QueryLimitException](data-api-dp-errors.md#QueryLimitException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [CancelledByUserException](data-api-dp-errors.md#CancelledByUserException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [MalformedQueryException](data-api-dp-errors.md#MalformedQueryException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## ExecuteGremlinProfileQuery (ação)
O nome da CLI da AWS para essa API é: `execute-gremlin-profile-query`.
Executa a consulta de perfil do Gremlin, que executa um percurso especificado, coleta várias métricas sobre a execução e produz um relatório de perfil como saída. Consulte [API de perfil do Gremlin no Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html) para obter detalhes.
Ao invocar essa operação em um cluster do Neptune com a autenticação do IAM habilitada, o usuário ou o perfil do IAM que faz a solicitação deve ter uma política anexada que viabilize a ação do IAM [neptune-db:ReadDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery) nesse cluster.
Observe que a chave de condição do IAM [neptune-db:QueryLanguage:Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) pode ser usada no documento de política para restringir o uso de consultas do Gremlin (consulte [Chaves de condição disponíveis em declarações de política de acesso a dados do IAM do Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)).
**Solicitação**
+ **chop** (na CLI: `--chop`): um valor inteiro, do tipo: `integer` (um valor inteiro assinado de 32 bits).
Se diferente de zero, fará com que a string de resultados seja truncada nesse número de caracteres. Se definido como zero, a string conterá todos os resultados.
+ **gremlinQuery** (na CLI: `--gremlin-query`): *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8).
A string de consulta do Gremlin para o perfil.
+ **indexOps** (na CLI: `--index-ops`): um valor booliano, do tipo: `boolean` (um valor booliano (verdadeiro ou falso)).
Se esse sinalizador for definido como `TRUE`, os resultados incluirão um relatório detalhado de todas as operações de índice que ocorreram durante a execução e a serialização da consulta.
+ **results** (na CLI: `--results`): um valor booliano, do tipo: `boolean` (um valor booliano (verdadeiro ou falso)).
Se esse sinalizador for definido como `TRUE`, os resultados da consulta serão coletados e exibidos como parte do relatório de perfil. Se `FALSE`, somente a contagem de resultados será exibida.
+ **serializer** (na CLI: `--serializer`): uma string, do tipo: `string` (uma string codificada em UTF-8).
Se não forem nulos, os resultados coletados serão retornados em uma mensagem de resposta serializada no formato especificado por esse parâmetro. Consulte [API de perfil do Gremlin no Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html) para obter mais informações.
**Resposta**
+ **output**: um ReportAsText, do tipo: `blob` (um bloco de dados binários não interpretados).
Um blob de texto que contém o resultado de perfil do Gremlin. Consulte [API de perfil do Gremlin no Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html) para obter detalhes.
**Erros**
+ [QueryTooLargeException](data-api-dp-errors.md#QueryTooLargeException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [QueryLimitExceededException](data-api-dp-errors.md#QueryLimitExceededException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [QueryLimitException](data-api-dp-errors.md#QueryLimitException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [CancelledByUserException](data-api-dp-errors.md#CancelledByUserException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [MalformedQueryException](data-api-dp-errors.md#MalformedQueryException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## ListGremlinQueries (ação)
O nome da CLI da AWS para essa API é: `list-gremlin-queries`.
Lista as consultas ativas do Gremlin. Consulte [API de status de consulta do Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status.html) para obter detalhes sobre a saída.
Ao invocar essa operação em um cluster do Neptune com a autenticação do IAM habilitada, o usuário ou o perfil do IAM que faz a solicitação deve ter uma política anexada que viabilize a ação do IAM [neptune-db:GetQueryStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) nesse cluster.
Observe que a chave de condição do IAM [neptune-db:QueryLanguage:Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) pode ser usada no documento de política para restringir o uso de consultas do Gremlin (consulte [Chaves de condição disponíveis em declarações de política de acesso a dados do IAM do Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)).
**Solicitação**
+ **includeWaiting** (na CLI: `--include-waiting`): um valor booliano, do tipo: `boolean` (um valor booliano (verdadeiro ou falso)).
Se definido como `TRUE`, a lista exibida incluirá consultas em espera. O padrão é `FALSE`;
**Resposta**
+ **acceptedQueryCount**: um valor inteiro, do tipo: `integer` (um valor inteiro assinado de 32 bits).
O número de consultas que foram aceitas, mas ainda não concluídas, incluindo as consultas na fila.
+ **queries**: um array de objetos [GremlinQueryStatus](#GremlinQueryStatus).
Uma lista das consultas atuais.
+ **runningQueryCount**: um valor inteiro, do tipo: `integer` (um valor inteiro assinado de 32 bits).
O número de consultas do Gremlin em execução no momento.
**Erros**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## GetGremlinQueryStatus (ação)
O nome da CLI da AWS para essa API é: `get-gremlin-query-status`.
Obtém o status de uma consulta do Gremlin especificada.
Ao invocar essa operação em um cluster do Neptune com a autenticação do IAM habilitada, o usuário ou o perfil do IAM que faz a solicitação deve ter uma política anexada que viabilize a ação do IAM [neptune-db:GetQueryStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) nesse cluster.
Observe que a chave de condição do IAM [neptune-db:QueryLanguage:Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) pode ser usada no documento de política para restringir o uso de consultas do Gremlin (consulte [Chaves de condição disponíveis em declarações de política de acesso a dados do IAM do Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)).
**Solicitação**
+ **queryId** (na CLI: `--query-id`): *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8).
O identificador exclusivo que identifica a consulta do Gremlin.
**Resposta**
+ **queryEvalStats**: um objeto [QueryEvalStats](#QueryEvalStats).
O status da avaliação da consulta do Gremlin.
+ **queryId**: uma string, do tipo: `string` (uma string codificada em UTF-8).
O ID da consulta para a qual o status está sendo exibido.
+ **queryString**: uma string, do tipo: `string` (uma string codificada em UTF-8).
A string de consulta do Gremlin.
**Erros**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## CancelGremlinQuery (ação)
O nome da CLI da AWS para essa API é: `cancel-gremlin-query`.
Cancela uma consulta do Gremlin. Consulte [Cancelamento de consultas do Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status-cancel.html) para obter mais informações.
Ao invocar essa operação em um cluster do Neptune com a autenticação do IAM habilitada, o usuário ou o perfil do IAM que faz a solicitação deve ter uma política anexada que viabilize a ação do IAM [neptune-db:CancelQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelquery) nesse cluster.
**Solicitação**
+ **queryId** (na CLI: `--query-id`): *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8).
O identificador exclusivo que identifica a consulta a ser cancelada.
**Resposta**
+ **status**: uma string, do tipo: `string` (uma string codificada em UTF-8).
O status do cancelamento
**Erros**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## *Ações de consulta do openCypher:*
## ExecuteOpenCypherQuery (ação)
O nome da CLI da AWS para essa API é: `execute-open-cypher-query`.
Executa uma consulta do openCypher. Consulte [Acessar o grafo do Netuno com o openCypher](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher.html) para obter mais informações.
O Neptune é compatível com a criação de aplicações de grafos usando o openCypher, atualmente uma das linguagens de consulta mais populares entre os desenvolvedores que trabalham com bancos de dados de grafos. Desenvolvedores, analistas de negócios e cientistas de dados gostam da sintaxe inspirada em SQL declarativa do openCypher porque ela oferece uma estrutura conhecida para consultar grafos de propriedades.
A linguagem openCypher foi originalmente desenvolvida pela Neo4j e, depois, passou a ser de código aberto em 2015 e contribuiu para o [projeto openCypher](https://opencypher.org/) sob uma licença de código aberto Apache 2.
Observe que, ao invocar essa operação em um cluster do Neptune com a autenticação do IAM habilitada, o usuário ou o perfil do IAM que faz a solicitação deve ter uma política anexada que viabilize uma das seguintes ações do IAM nesse cluster, dependendo da consulta:
+ [neptune-db:ReadDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery)
+ [neptune-db:WriteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery)
+ [neptune-db:DeleteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery)
Observe também que a chave de condição do IAM [neptune-db:QueryLanguage:OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) pode ser usada no documento de política para restringir o uso de consultas do openCypher (consulte [Chaves de condição disponíveis em declarações de política de acesso a dados do IAM do Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)).
**Solicitação**
+ **openCypherQuery** (na CLI: `--open-cypher-query`): *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8).
A string de consulta do openCypher a ser executada.
+ **parameters** (na CLI: `--parameters`): uma string, do tipo: `string` (uma string codificada em UTF-8).
Os parâmetros de consulta do openCypher para execução da consulta. Consulte [Exemplos de consulta parametrizada do openCypher](https://docs.aws.amazon.com/neptune/latest/userguide/opencypher-parameterized-queries.html) para obter mais informações.
**Resposta**
+ **results**: *obrigatório:* um documento, do tipo `document` (um conteúdo aberto independente de protocolo representado por um modelo de dados semelhante a JSON).
Os resultados de openCypherquery.
**Erros**
+ [QueryTooLargeException](data-api-dp-errors.md#QueryTooLargeException)
+ [InvalidNumericDataException](data-api-dp-errors.md#InvalidNumericDataException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [QueryLimitExceededException](data-api-dp-errors.md#QueryLimitExceededException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [QueryLimitException](data-api-dp-errors.md#QueryLimitException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [CancelledByUserException](data-api-dp-errors.md#CancelledByUserException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [MalformedQueryException](data-api-dp-errors.md#MalformedQueryException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## ExecuteOpenCypherExplainQuery (ação)
O nome da CLI da AWS para essa API é: `execute-open-cypher-explain-query`.
Executa uma solicitação `explain` do openCypher. Consulte [O atributo explain do openCypher](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-explain.html) para obter mais informações.
Ao invocar essa operação em um cluster do Neptune com a autenticação do IAM habilitada, o usuário ou o perfil do IAM que faz a solicitação deve ter uma política anexada que viabilize a ação do IAM [neptune-db:ReadDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery) nesse cluster.
Observe que a chave de condição do IAM [neptune-db:QueryLanguage:OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) pode ser usada no documento de política para restringir o uso de consultas do openCypher (consulte [Chaves de condição disponíveis em declarações de política de acesso a dados do IAM do Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)).
**Solicitação**
+ **explainMode** (na CLI :`--explain-mode`): *obrigatório:* um OpenCypherExplainMode, do tipo: `string` (uma string codificada em UTF-8).
O modo `explain` do openCypher. Pode ser `static`, `dynamic` ou `details`.
+ **openCypherQuery** (na CLI: `--open-cypher-query`): *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8).
A string de consulta do openCypher.
+ **parameters** (na CLI: `--parameters`): uma string, do tipo: `string` (uma string codificada em UTF-8).
Os parâmetros de consulta do openCypher.
**Resposta**
+ **results**: *obrigatório:* um Blob, do tipo: `blob` (um bloco de dados binários não interpretados).
Um blob de texto que contém os resultados `explain` do openCypher.
**Erros**
+ [QueryTooLargeException](data-api-dp-errors.md#QueryTooLargeException)
+ [InvalidNumericDataException](data-api-dp-errors.md#InvalidNumericDataException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [QueryLimitExceededException](data-api-dp-errors.md#QueryLimitExceededException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [QueryLimitException](data-api-dp-errors.md#QueryLimitException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [CancelledByUserException](data-api-dp-errors.md#CancelledByUserException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [MalformedQueryException](data-api-dp-errors.md#MalformedQueryException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## ListOpenCypherQueries (ação)
O nome da CLI da AWS para essa API é: `list-open-cypher-queries`.
Lista as consultas ativas do openCypher. Consulte [Endpoint de status do openCypher no Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-status.html) para obter mais informações.
Ao invocar essa operação em um cluster do Neptune com a autenticação do IAM habilitada, o usuário ou o perfil do IAM que faz a solicitação deve ter uma política anexada que viabilize a ação do IAM [neptune-db:GetQueryStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) nesse cluster.
Observe que a chave de condição do IAM [neptune-db:QueryLanguage:OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) pode ser usada no documento de política para restringir o uso de consultas do openCypher (consulte [Chaves de condição disponíveis em declarações de política de acesso a dados do IAM do Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)).
**Solicitação**
+ **includeWaiting** (na CLI: `--include-waiting`): um valor booliano, do tipo: `boolean` (um valor booliano (verdadeiro ou falso)).
Quando definido como `TRUE` e outros parâmetros não estão presentes, faz com que as informações de status das consultas em espera sejam geradas, bem como das consultas em execução.
**Resposta**
+ **acceptedQueryCount**: um valor inteiro, do tipo: `integer` (um valor inteiro assinado de 32 bits).
O número de consultas que foram aceitas, mas ainda não concluídas, incluindo as consultas na fila.
+ **queries**: um array de objetos [GremlinQueryStatus](#GremlinQueryStatus).
Uma lista das consultas atuais do openCypher.
+ **runningQueryCount**: um valor inteiro, do tipo: `integer` (um valor inteiro assinado de 32 bits).
O número de consultas do openCypher em execução no momento.
**Erros**
+ [InvalidNumericDataException](data-api-dp-errors.md#InvalidNumericDataException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## GetOpenCypherQueryStatus (ação)
O nome da CLI da AWS para essa API é: `get-open-cypher-query-status`.
Recupera o status de uma consulta do openCypher especificada.
Ao invocar essa operação em um cluster do Neptune com a autenticação do IAM habilitada, o usuário ou o perfil do IAM que faz a solicitação deve ter uma política anexada que viabilize a ação do IAM [neptune-db:GetQueryStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) nesse cluster.
Observe que a chave de condição do IAM [neptune-db:QueryLanguage:OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) pode ser usada no documento de política para restringir o uso de consultas do openCypher (consulte [Chaves de condição disponíveis em declarações de política de acesso a dados do IAM do Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)).
**Solicitação**
+ **queryId** (na CLI: `--query-id`): *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8).
O ID exclusivo da consulta do openCypher para a qual recuperar o status da consulta.
**Resposta**
+ **queryEvalStats**: um objeto [QueryEvalStats](#QueryEvalStats).
O status de avaliação da consulta do openCypher.
+ **queryId**: uma string, do tipo: `string` (uma string codificada em UTF-8).
O ID exclusivo da consulta para a qual o status está sendo exibido.
+ **queryString**: uma string, do tipo: `string` (uma string codificada em UTF-8).
A string de consulta do openCypher.
**Erros**
+ [InvalidNumericDataException](data-api-dp-errors.md#InvalidNumericDataException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## CancelOpenCypherQuery (ação)
O nome da CLI da AWS para essa API é: `cancel-open-cypher-query`.
Cancela uma consulta do openCypher especificada. Consulte [Endpoint de status do openCypher no Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-status.html) para obter mais informações.
Ao invocar essa operação em um cluster do Neptune com a autenticação do IAM habilitada, o usuário ou o perfil do IAM que faz a solicitação deve ter uma política anexada que viabilize a ação do IAM [neptune-db:CancelQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelquery) nesse cluster.
**Solicitação**
+ **queryId** (na CLI: `--query-id`): *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8).
O ID exclusivo da consulta do openCypher a ser cancelada.
+ **silent** (na CLI: `--silent`): um valor booliano, do tipo: `boolean` (um valor booliano (verdadeiro ou falso)).
Se definido como `TRUE`, faz com que o cancelamento da consulta do openCypher ocorra silenciosamente.
**Resposta**
+ **payload**: um valor booliano, do tipo: `boolean` (um valor booliano (verdadeiro ou falso)).
A carga útil de cancelamento da consulta do openCypher.
+ **status**: uma string, do tipo: `string` (uma string codificada em UTF-8).
O status de cancelamento da consulta do openCypher.
**Erros**
+ [InvalidNumericDataException](data-api-dp-errors.md#InvalidNumericDataException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## *Estruturas de consulta:*
## QueryEvalStats (estrutura)
Estrutura para capturar estatísticas de consultas, como quantas consultas estão sendo executadas, aceitas ou aguardando e seus detalhes.
**Campos**
+ **cancelled**: é um valor booliano, do tipo: `boolean` (um valor booliano (verdadeiro ou falso)).
Defina como `TRUE` se a consulta foi cancelada ou FALSE, caso contrário.
+ **elapsed**: é um valor inteiro, do tipo: `integer` (um valor inteiro assinado de 32 bits).
O número de milissegundos em que a consulta esteve em execução até agora.
+ **subqueries**: é um documento, do tipo `document` (um conteúdo aberto independente de protocolo representado por um modelo de dados semelhante a JSON).
O número de subconsultas nesta consulta.
+ **waited**: é um valor inteiro, do tipo: `integer` (um valor inteiro assinado de 32 bits).
Indica quanto tempo a consulta esperou, em milissegundos.
## GremlinQueryStatus (estrutura)
Captura o status de uma consulta do Gremlin (consulte a página [API de status de consulta do Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status.html)).
**Campos**
+ **queryEvalStats**: é um objeto [QueryEvalStats](#QueryEvalStats).
As estatísticas da consulta do Gremlin.
+ **queryId**: é uma string, do tipo: `string` (uma string codificada em UTF-8).
O ID da consulta do Gremlin.
+ **queryString**: é uma string, do tipo: `string` (uma string codificada em UTF-8).
A string da consulta do Gremlin.
## GremlinQueryStatusAttributes (estrutura)
Contém componentes de status de uma consulta do Gremlin.
**Campos**
+ **attributes**: é um documento, do tipo `document` (um conteúdo aberto independente de protocolo representado por um modelo de dados semelhante a JSON).
Atributos do status da consulta do Gremlin.
+ **code**: é um valor inteiro, do tipo: `integer` (um valor inteiro assinado de 32 bits).
O código de resposta HTTP gerado pela solicitação de consulta do Gremlin.
+ **message**: é uma string, do tipo: `string` (uma string codificada em UTF-8).
A mensagem de status.