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.
DescribeSnapshots
Devuelve información acerca de instantáneas del clúster. De forma predeterminada, DescribeSnapshots muestra todas las instantáneas; si lo desea, puede describir una sola instantánea o solo las instantáneas asociadas a un clúster en particular.
Sintaxis de la solicitud
{
"ClusterName": "string",
"MaxResults": number,
"NextToken": "string",
"ShowDetail": boolean,
"SnapshotName": "string",
"Source": "string"
}Parámetros de la solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.
La solicitud acepta los siguientes datos en formato JSON.
- ClusterName
-
Un identificador de clúster proporcionado por el usuario. Si se especifica este parámetro, solo se describen las instantáneas asociadas a ese clúster específico.
Tipo: cadena
Requerido: no
- MaxResults
-
El número máximo de registros que se deben incluir en la respuesta. Si existen más registros que el MaxResults valor especificado, se incluye un token en la respuesta para poder recuperar los resultados restantes.
Tipo: entero
Obligatorio: no
- NextToken
-
Un argumento opcional para pasarlo en caso de que el número total de registros supere el valor de MaxResults. Si se devuelve “NextToken”, hay más resultados disponibles. El valor de “NextToken” es un token de paginación único para cada página. Vuelva a realizar la llamada con el token devuelto para recuperar la página siguiente. Conserve todos los demás argumentos sin cambios.
Tipo: cadena
Requerido: no
- ShowDetail
-
Un valor booleano que, si es verdadero, la configuración de la partición se incluye en la descripción de la instantánea.
Tipo: Booleano
Obligatorio: no
- SnapshotName
-
El nombre de la instantánea proporcionado por el usuario. Si se especifica este parámetro, solo se describe la instantánea nombrada.
Tipo: cadena
Requerido: no
- Source
-
Si se establece en el sistema, el resultado muestra las instantáneas que MemoryDB creó automáticamente. Si se configura como usuario, el resultado muestra las instantáneas que se crearon manualmente. Si se omite, el resultado muestra las instantáneas creadas automática y manualmente.
Tipo: cadena
Requerido: no
Sintaxis de la respuesta
{
"NextToken": "string",
"Snapshots": [
{
"ARN": "string",
"ClusterConfiguration": {
"Description": "string",
"EngineVersion": "string",
"MaintenanceWindow": "string",
"Name": "string",
"NodeType": "string",
"NumShards": number,
"ParameterGroupName": "string",
"Port": number,
"Shards": [
{
"Configuration": {
"ReplicaCount": number,
"Slots": "string"
},
"Name": "string",
"Size": "string",
"SnapshotCreationTime": number
}
],
"SnapshotRetentionLimit": number,
"SnapshotWindow": "string",
"SubnetGroupName": "string",
"TopicArn": "string",
"VpcId": "string"
},
"DataTiering": "string",
"KmsKeyId": "string",
"Name": "string",
"Source": "string",
"Status": "string"
}
]
}Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
- NextToken
-
Un argumento opcional que se debe pasar en caso de que el número total de registros supere el valor de MaxResults. Si se devuelve “NextToken”, hay más resultados disponibles. El valor de “NextToken” es un token de paginación único para cada página. Vuelva a realizar la llamada con el token devuelto para recuperar la página siguiente. Conserve todos los demás argumentos sin cambios.
Tipo: cadena
- Snapshots
-
Una lista de instantáneas. Cada elemento de la lista contiene información detallada sobre una instantánea.
Tipo: matriz de objetos Snapshot
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- InvalidParameterCombinationException
-
Código de estado HTTP: 400
- InvalidParameterValueException
-
Código de estado HTTP: 400
- ServiceLinkedRoleNotFoundFault
-
Código de estado HTTP: 400
- SnapshotNotFoundFault
-
Código de estado HTTP: 400
Véase también
Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulta lo siguiente:
