

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

# Mecanismo de plano de dados do Neptune, redefinição rápida e APIs de estrutura geral
<a name="data-api-dp-environment-APIs"></a>

**Operações do mecanismo:**
+ [GetEngineStatus (ação)](#GetEngineStatus)
+ [ExecuteFastReset (ação)](#ExecuteFastReset)

**Estruturas de operação do mecanismo:**
+ [QueryLanguageVersion (estrutura)](#QueryLanguageVersion)
+ [FastResetToken (estrutura)](#FastResetToken)

## GetEngineStatus (ação)
<a name="GetEngineStatus"></a>

         O nome da CLI da AWS para essa API é: `get-engine-status`.

Recupera o status do banco de dados de grafos no host.

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:GetEngineStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getenginestatus) nesse cluster.

**Solicitação**
+ *Sem parâmetros de solicitação.*

**Resposta**
+ **dbEngineVersion**: uma string, do tipo: `string` (uma string codificada em UTF-8).

  Defina como a versão do mecanismo do Neptune em execução no cluster de banco de dados. Se essa versão do mecanismo tiver sido corrigida manualmente desde que foi lançada, o número da versão terá o prefixo `Patch-`.
+ **dfeQueryEngine**: uma string, do tipo: `string` (uma string codificada em UTF-8).

  Defina como `enabled` se o mecanismo do DFE estiver totalmente habilitado, ou `viaQueryHint` (o padrão) se o mecanismo do DFE for usado somente com consultas que tenham a dica de consulta `useDFE` definida como `true`.
+ **features**: uma matriz de mapa dos pares de valor-chave em que:

      Cada chave é uma string, do tipo: `string` (uma string codificada em UTF-8).

      Cada valor é um documento, do tipo: `document` (um conteúdo aberto independente de protocolo representado por um modelo de dados semelhante a JSON).

  Contém informações de status sobre os atributos habilitados no cluster de banco de dados.
+ **gremlin**: um objeto [QueryLanguageVersion](#QueryLanguageVersion).

  Contém informações sobre a linguagem de consulta Gremlin disponível no cluster. Especificamente, contém um campo de versão que especifica a versão atual do TinkerPop que está sendo usada pelo mecanismo.
+ **labMode**: uma matriz de mapa dos pares de valor-chave em que:

      Cada chave é uma string, do tipo: `string` (uma string codificada em UTF-8).

      Cada valor é uma string, do tipo: `string` (uma string codificada em UTF-8).

  Contém as configurações do modo de laboratório usadas pelo mecanismo.
+ **opencypher**: um objeto [QueryLanguageVersion](#QueryLanguageVersion).

  Contém informações sobre a linguagem de consulta openCypher disponível no cluster. Especificamente, contém um campo de versão que especifica a versão atual do openCypher que está sendo usada pelo mecanismo.
+ **role**: uma string, do tipo: `string` (uma string codificada em UTF-8).

  Defina como `reader` se a instância for uma réplica de leitura ou como `writer` se a instância for a principal.
+ **rollingBackTrxCount**: um valor inteiro, do tipo: `integer` (um valor inteiro assinado de 32 bits).

  Se houver transações que estiverem sendo revertidas, esse campo será definido como o número dessas transações. Se não houver nenhuma, o campo não aparecerá.
+ **rollingBackTrxEarliestStartTime**: uma string, do tipo: `string` (uma string codificada em UTF-8).

  Defina como a hora de início da transação mais antiga revertida. Se nenhuma transação estiver sendo revertida, o campo não aparecerá.
+ **settings**: uma matriz de mapa dos pares de valor-chave em que:

      Cada chave é uma string, do tipo: `string` (uma string codificada em UTF-8).

      Cada valor é uma string, do tipo: `string` (uma string codificada em UTF-8).

  Contém informações sobre as configurações atuais no cluster de banco de dados. Por exemplo, contém a configuração de tempo limite da consulta de cluster atual (`clusterQueryTimeoutInMs`).
+ **sparql**: um objeto [QueryLanguageVersion](#QueryLanguageVersion).

  Contém informações sobre a linguagem de consulta SPARQL disponível no cluster. Especificamente, contém um campo de versão que especifica a versão atual do SPARQL que está sendo usada pelo mecanismo.
+ **startTime**: uma string, do tipo: `string` (uma string codificada em UTF-8).

  Defina como a hora UTC em que o processo do servidor atual foi iniciado.
+ **status**: uma string, do tipo: `string` (uma string codificada em UTF-8).

  Defina como `healthy` se a instância não estiver com problemas. Se a instância estiver se recuperando de um travamento ou sendo reinicializada e houver transações ativas em execução no desligamento do servidor mais recente, o status será definido como `recovery`.

**Erros**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [InternalFailureException](data-api-dp-errors.md#InternalFailureException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)

## ExecuteFastReset (ação)
<a name="ExecuteFastReset"></a>

         O nome da CLI da AWS para essa API é: `execute-fast-reset`.

A API REST de redefinição rápida permite redefinir um grafo do Neptune com rapidez e facilidade, removendo todos seus dados.

A redefinição rápida do Neptune é um processo em duas etapas. Primeiro você chama `ExecuteFastReset` com `action` definido como `initiateDatabaseReset`. Isso gera um token UUID que você inclui ao chamar `ExecuteFastReset` novamente com `action` definido como `performDatabaseReset`. Consulte [Esvaziar um cluster de banco de dados do Amazon Neptune usando a API de redefinição rápida](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-fast-reset.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 a ação do IAM [neptune-db:ResetDatabase](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#resetdatabase) nesse cluster.

**Solicitação**
+ **action** (na CLI :`--action`): *obrigatório:* uma ação, do tipo: `string` (uma string codificada em UTF-8).

  A ação de redefinição rápida. Um dos seguintes valores:
  + **`initiateDatabaseReset`**: essa ação gera um token exclusivo necessário para realmente realizar a redefinição rápida.
  + **`performDatabaseReset`**: essa ação usa o token gerado pela ação `initiateDatabaseReset` para realmente realizar a redefinição rápida.

    
+ **token** (na CLI: `--token`): uma string, do tipo: `string` (uma string codificada em UTF-8).

  O token de redefinição rápida para iniciar a redefinição.

**Resposta**
+ **payload**: um objeto [FastResetToken](#FastResetToken).

  O `payload` só é gerado pela ação `initiateDatabaseReset` e contém o token exclusivo a ser usado com a ação `performDatabaseReset` para ocasionar a redefinição.
+ **status**: *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8).

  O `status` é gerado somente para a ação `performDatabaseReset` e indica se a solicitação de redefinição rápida foi aceita ou não.

**Erros**
+ [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)
+ [ServerShutdownException](data-api-dp-errors.md#ServerShutdownException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [MethodNotAllowedException](data-api-dp-errors.md#MethodNotAllowedException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)

## *Estruturas de operação do mecanismo:*
<a name="data-api-dp-environment-APIs-engine-operation-structures-spacer"></a>

## QueryLanguageVersion (estrutura)
<a name="QueryLanguageVersion"></a>

Estrutura para expressar a versão da linguagem de consulta.

**Campos**
+ **version**: é *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8).

  A versão da linguagem de consulta.

## FastResetToken (estrutura)
<a name="FastResetToken"></a>

Uma estrutura que contém o token de redefinição rápida usado para iniciar uma redefinição rápida.

**Campos**
+ **token**: é uma string, do tipo: `string` (uma string codificada em UTF-8).

  Um UUID gerado pelo banco de dados na ação `initiateDatabaseReset` e depois consumido por `performDatabaseReset` para redefinir o banco de dados.