

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

# API de resumen de gráficos y estadísticas del plano de datos de Neptune
<a name="data-api-dp-statistics"></a>

**Acciones estadísticas de gráficos de propiedades:**
+ [GetPropertygraphStatistics (acción)](#GetPropertygraphStatistics)
+ [ManagePropertygraphStatistics (acción)](#ManagePropertygraphStatistics)
+ [DeletePropertygraphStatistics (acción)](#DeletePropertygraphStatistics)
+ [GetPropertygraphSummary (acción)](#GetPropertygraphSummary)

**Estructuras de estadísticas:**
+ [Statistics (estructura)](#Statistics)
+ [StatisticsSummary (estructura)](#StatisticsSummary)
+ [DeleteStatisticsValueMap (estructura)](#DeleteStatisticsValueMap)
+ [RefreshStatisticsIdMap (estructura)](#RefreshStatisticsIdMap)
+ [NodeStructure (estructura)](#NodeStructure)
+ [EdgeStructure (estructura)](#EdgeStructure)
+ [SubjectStructure (estructura)](#SubjectStructure)
+ [PropertygraphSummaryValueMap (estructura)](#PropertygraphSummaryValueMap)
+ [PropertygraphSummary (estructura)](#PropertygraphSummary)

## GetPropertygraphStatistics (acción)
<a name="GetPropertygraphStatistics"></a>

         El nombre de la AWS CLI para esta API es: `get-propertygraph-statistics`.

Obtiene las estadísticas de los gráficos de propiedades (Gremlin y openCypher).

Al invocar esta operación en un clúster de Neptune que tiene habilitada la autenticación de IAM, el usuario o rol de IAM que realiza la solicitud debe tener una política adjunta que permita la acción de IAM [neptune-db:GetStatisticsStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstatisticsstatus) en dicho clúster.

**Solicitud**
+ *Ningún parámetro de solicitud.*

**Respuesta**
+ **payload**: *obligatorio:* objeto [Statistics](#Statistics).

  Estadísticas de los datos de gráficos de propiedades.
+ **status**: *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El código de devolución HTTP de la solicitud. Si la solicitud se ha realizado correctamente, el código es 200. Consulte [Códigos de error comunes para la solicitud de estadísticas del DFE](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html#neptune-dfe-statistics-errors) para obtener una lista de los errores más comunes.

**Errores**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [StatisticsNotAvailableException](data-api-dp-errors.md#StatisticsNotAvailableException)
+ [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)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [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)

## ManagePropertygraphStatistics (acción)
<a name="ManagePropertygraphStatistics"></a>

         El nombre de la AWS CLI para esta API es: `manage-propertygraph-statistics`.

Administra la generación y el uso de estadísticas de gráficos de propiedades.

Al invocar esta operación en un clúster de Neptune que tiene habilitada la autenticación de IAM, el usuario o rol de IAM que realiza la solicitud debe tener una política adjunta que permita la acción de IAM [neptune-db:ManageStatistics](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#managestatistics) en dicho clúster.

**Solicitud**
+ **mode** (en la CLI: `--mode`): un StatisticsAutoGenerationMode, del tipo: `string` (una cadena codificada con UTF-8).

  El modo de generación de estadísticas. Uno de los siguientes: `DISABLE_AUTOCOMPUTE`, `ENABLE_AUTOCOMPUTE` o `REFRESH`, el último de los cuales desencadena manualmente la generación de estadísticas del DFE.

**Respuesta**
+ **payload**: un objeto [RefreshStatisticsIdMap](#RefreshStatisticsIdMap).

  Esto solo se devuelve en el modo de actualización.
+ **status**: *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El código de devolución HTTP de la solicitud. Si la solicitud se ha realizado correctamente, el código es 200.

**Errores**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [StatisticsNotAvailableException](data-api-dp-errors.md#StatisticsNotAvailableException)
+ [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)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [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)

## DeletePropertygraphStatistics (acción)
<a name="DeletePropertygraphStatistics"></a>

         El nombre de la AWS CLI para esta API es: `delete-propertygraph-statistics`.

Elimina las estadísticas de los datos (gráficos de propiedades) de Gremlin y openCypher.

Al invocar esta operación en un clúster de Neptune que tiene habilitada la autenticación de IAM, el usuario o rol de IAM que realiza la solicitud debe tener una política adjunta que permita la acción de IAM [neptune-db:DeleteStatistics](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletestatistics) en dicho clúster.

**Solicitud**
+ *Ningún parámetro de solicitud.*

**Respuesta**
+ **payload**: un objeto [DeleteStatisticsValueMap](#DeleteStatisticsValueMap).

  La carga de eliminación.
+ **status**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El estado de cancelación.
+ **statusCode**: un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  El código de respuesta HTTP: 200 si la eliminación se realizó correctamente o 204 si no había estadísticas que eliminar.

**Errores**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [StatisticsNotAvailableException](data-api-dp-errors.md#StatisticsNotAvailableException)
+ [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)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [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)

## GetPropertygraphSummary (acción)
<a name="GetPropertygraphSummary"></a>

         El nombre de la AWS CLI para esta API es: `get-propertygraph-summary`.

Obtiene un resumen de gráficos de un gráfico de propiedades.

Al invocar esta operación en un clúster de Neptune que tiene habilitada la autenticación de IAM, el usuario o rol de IAM que realiza la solicitud debe tener una política adjunta que permita la acción de IAM [neptune-db:GetGraphSummary](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getgraphsummary) en dicho clúster.

**Solicitud**
+ **mode** (en la CLI: `--mode`): un GraphSummaryType, del tipo: `string` (una cadena codificada con UTF-8).

  El modo puede tomar uno de estos dos valores: `BASIC` (el valor predeterminado) y `DETAILED`.

**Respuesta**
+ **payload**: un objeto [PropertygraphSummaryValueMap](#PropertygraphSummaryValueMap).

  Carga que incluye la respuesta de resumen de gráficos de propiedades.
+ **statusCode**: un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  El código de devolución HTTP de la solicitud. Si la solicitud se ha realizado correctamente, el código es 200.

**Errores**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [StatisticsNotAvailableException](data-api-dp-errors.md#StatisticsNotAvailableException)
+ [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)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [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)

## *Estructuras de estadísticas:*
<a name="data-api-dp-statistics-statistics-structures-spacer"></a>

## Statistics (estructura)
<a name="Statistics"></a>

Incluye información de estadísticas. El motor DFE utiliza la información sobre los datos de gráficos de Neptune para realizar compensaciones efectivas a la hora de planificar la ejecución de las consultas. Esta información adopta la forma de estadísticas que incluyen los denominados conjuntos de características y estadísticas de predicados que pueden guiar la planificación de las consultas. Consulte [Administración de las estadísticas para que las utilice el DFE de Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html).

**Campos**
+ **active**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si la generación de estadísticas del DFE está habilitada o no.
+ **autoCompute**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si la generación automática de estadísticas está habilitada o no.
+ **date**: se trata de un valor SyntheticTimestamp\$1date\$1time, del tipo: `string` (una cadena codificada en UTF-8).

  La hora UTC a la que se generaron las estadísticas del DFE por última vez.
+ **note**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una nota sobre los problemas en el caso de que las estadísticas no sean válidas.
+ **signatureInfo**: se trata de un objeto [StatisticsSummary](#StatisticsSummary).

  Una estructura StatisticsSummary que incluye:
  + `signatureCount`: el número total de firmas en todos los conjuntos de características.
  + `instanceCount`: el número total de instancias del conjunto de características.
  + `predicateCount`: el número total de predicados únicos.
+ **statisticsId**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Indica el ID de la ejecución de generación de estadísticas actual. Un valor de -1 indica que no se ha generado ninguna estadística.

## StatisticsSummary (estructura)
<a name="StatisticsSummary"></a>

Información sobre los conjuntos de características generados en las estadísticas.

**Campos**
+ **instanceCount**: se trata de un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  El número total de instancias del conjunto de características.
+ **predicateCount**: se trata de un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  El número total de predicados únicos.
+ **signatureCount**: se trata de un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  El número total de firmas en todos los conjuntos de características.

## DeleteStatisticsValueMap (estructura)
<a name="DeleteStatisticsValueMap"></a>

La carga de DeleteStatistics.

**Campos**
+ **active**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  El estado actual de las estadísticas.
+ **statisticsId**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ID de la ejecución de generación de estadísticas que se está produciendo actualmente.

## RefreshStatisticsIdMap (estructura)
<a name="RefreshStatisticsIdMap"></a>

Estadísticas del modo `REFRESH`.

**Campos**
+ **statisticsId**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ID de la ejecución de generación de estadísticas que se está produciendo actualmente.

## NodeStructure (estructura)
<a name="NodeStructure"></a>

Una estructura de nodos.

**Campos**
+ **count**: esto es un valor Long, del tipo: `long` (valor entero firmado de 64 bits).

  Número de nodos que tienen esta estructura específica.
+ **distinctOutgoingEdgeLabels**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de las etiquetas de borde saliente distintas presentes en esta estructura específica.
+ **nodeProperties**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de propiedades de los nodos presentes en esta estructura específica.

## EdgeStructure (estructura)
<a name="EdgeStructure"></a>

Una estructura de borde.

**Campos**
+ **count**: esto es un valor Long, del tipo: `long` (valor entero firmado de 64 bits).

  El número de bordes que tiene esta estructura específica.
+ **edgeProperties**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de propiedades de los bordes presentes en esta estructura específica.

## SubjectStructure (estructura)
<a name="SubjectStructure"></a>

Una estructura de tema.

**Campos**
+ **count**: esto es un valor Long, del tipo: `long` (valor entero firmado de 64 bits).

  Número de apariciones de esta estructura específica.
+ **predicates**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de predicados presentes en esta estructura específica.

## PropertygraphSummaryValueMap (estructura)
<a name="PropertygraphSummaryValueMap"></a>

Carga de la respuesta de resumen de gráficos de propiedades.

**Campos**
+ **graphSummary**: se trata de un objeto [PropertygraphSummary](#PropertygraphSummary).

  El resumen del gráfico.
+ **lastStatisticsComputationTime**: se trata de un valor SyntheticTimestamp\$1date\$1time, del tipo: `string` (una cadena codificada en UTF-8).

  La marca temporal, en formato ISO 8601, de la hora en que Neptune calculó las estadísticas por última vez.
+ **version**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La versión de esta respuesta del resumen de gráficos.

## PropertygraphSummary (estructura)
<a name="PropertygraphSummary"></a>

La API de resumen de gráficos devuelve una lista de solo lectura de etiquetas de nodos y bordes y claves de propiedades, junto con el recuento de nodos, bordes y propiedades. Consulte [Respuesta del resumen de gráficos para un gráfico de propiedades (PG)](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-graph-summary.html#neptune-graph-summary-pg-response).

**Campos**
+ **edgeLabels**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de etiquetas de bordes distintos del gráfico.
+ **edgeProperties**: se trata de objetos LongValuedMap. Se trata de una matriz de mapeo de pares clave-valor donde:

      Cada clave es una cadena, del tipo: `string` (una cadena codificada con UTF-8).

      Cada valor es un valor Long, del tipo: `long` (valor entero firmado de 64 bits).

  Una lista de las propiedades de bordes distintos del gráfico, junto con el recuento de bordes en las que se utiliza cada propiedad.
+ **edgeStructures**: se trata de una matriz de objetos [EdgeStructure](#EdgeStructure).

  Este campo solo está presente cuando el modo solicitado es `DETAILED`. Incluye una lista de estructuras de bordes.
+ **nodeLabels**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de etiquetas de nodos distintas del gráfico.
+ **nodeProperties**: se trata de objetos LongValuedMap. Se trata de una matriz de mapeo de pares clave-valor donde:

      Cada clave es una cadena, del tipo: `string` (una cadena codificada con UTF-8).

      Cada valor es un valor Long, del tipo: `long` (valor entero firmado de 64 bits).

  El número de propiedades de nodos distintas del gráfico.
+ **nodeStructures**: se trata de una matriz de objetos [NodeStructure](#NodeStructure).

  Este campo solo está presente cuando el modo solicitado es `DETAILED`. Incluye una lista de estructuras de nodos.
+ **numEdgeLabels**: esto es un valor Long, del tipo: `long` (valor entero firmado de 64 bits).

  El número de etiquetas de bordes distintos del gráfico.
+ **numEdgeProperties**: esto es un valor Long, del tipo: `long` (valor entero firmado de 64 bits).

  El número de propiedades de bordes distintos del gráfico.
+ **numEdges**: esto es un valor Long, del tipo: `long` (valor entero firmado de 64 bits).

  El número de bordes del gráfico.
+ **numNodeLabels**: esto es un valor Long, del tipo: `long` (valor entero firmado de 64 bits).

  El número de etiquetas de nodos distintas del gráfico.
+ **numNodeProperties**: esto es un valor Long, del tipo: `long` (valor entero firmado de 64 bits).

  Una lista de las propiedades de nodos distintas del gráfico, junto con el recuento de nodos en los que se utiliza cada propiedad.
+ **numNodes**: esto es un valor Long, del tipo: `long` (valor entero firmado de 64 bits).

  El número de nodos del gráfico.
+ **totalEdgePropertyValues**: esto es un valor Long, del tipo: `long` (valor entero firmado de 64 bits).

  El número total de usos de todas las propiedades de bordes.
+ **totalNodePropertyValues**: esto es un valor Long, del tipo: `long` (valor entero firmado de 64 bits).

  El número total de usos de todas las propiedades de nodos.