DescribeFramework - AWS Backup
Sintaxis de la solicitudParámetros de solicitud del URICuerpo de la solicitudSintaxis de la respuestaElementos de respuestaErroresVéase también

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.

DescribeFramework

Devuelve los detalles del marco para el FrameworkName especificado.

Sintaxis de la solicitud

GET /audit/frameworks/frameworkName HTTP/1.1

Parámetros de solicitud del URI

La solicitud utiliza los siguientes parámetros URI.

frameworkName

El nombre único de un marco.

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 256 caracteres.

Patrón: [a-zA-Z][_a-zA-Z0-9]*

Obligatorio: sí

Cuerpo de la solicitud

La solicitud no tiene un cuerpo de la solicitud.

Sintaxis de la respuesta

HTTP/1.1 200
Content-type: application/json

{
   "CreationTime": number,
   "DeploymentStatus": "string",
   "FrameworkArn": "string",
   "FrameworkControls": [ 
      { 
         "ControlInputParameters": [ 
            { 
               "ParameterName": "string",
               "ParameterValue": "string"
            }
         ],
         "ControlName": "string",
         "ControlScope": { 
            "ComplianceResourceIds": [ "string" ],
            "ComplianceResourceTypes": [ "string" ],
            "Tags": { 
               "string" : "string" 
            }
         }
      }
   ],
   "FrameworkDescription": "string",
   "FrameworkName": "string",
   "FrameworkStatus": "string",
   "IdempotencyToken": "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.

CreationTime

Es la fecha y la hora en que se creó un marco con la norma ISO 8601. El valor de CreationTime tiene una precisión de milisegundos. Por ejemplo, 2020-07-10T15:00:00.000-08:00 representa el 10 de julio de 2020 a las 15:00 h, 8 horas menos que UTC.

Tipo: marca temporal

DeploymentStatus

El estado de implementación de un marco. Los estados son:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

Tipo: cadena

FrameworkArn

Un nombre de recurso de Amazon (ARN) que identifica de forma exclusiva un recurso. El formato del ARN depende del tipo de recurso.

Tipo: cadena

FrameworkControls

Los controles que componen el marco. Cada control de la lista tiene un nombre, parámetros de entrada y alcance.

Tipo: matriz de objetos FrameworkControl

FrameworkDescription

Una descripción opcional del marco.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 0. La longitud máxima es de 1024 caracteres.

Patrón: .*\S.*

FrameworkName

El nombre único de un marco.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 256 caracteres.

Patrón: [a-zA-Z][_a-zA-Z0-9]*

FrameworkStatus

Un marco consta de uno o varios controles. Cada control rige un recurso, como los planes de copia de seguridad, las selecciones de copia de seguridad, los almacenes de copia de seguridad o los puntos de recuperación. También puede activar o desactivar la grabación de AWS Config para cada recurso. Los estados son:

  • ACTIVE cuando la grabación está activada para todos los recursos regidos por el marco.

  • PARTIALLY_ACTIVE cuando la grabación está desactivada para al menos un recurso regido por el marco.

  • INACTIVE cuando la grabación está desactivada para todos los recursos regidos por el marco.

  • UNAVAILABLEcuando AWS Backup no puede validar el estado de la grabación en este momento.

Tipo: cadena

IdempotencyToken

Una cadena elegida por el cliente que puede utilizar para distinguir entre llamadas a DescribeFrameworkOutput que, de otro modo, serían idénticas. Si se vuelve a intentar una solicitud correcta con el mismo token de idempotencia, aparece un mensaje de confirmación y no se realiza ninguna acción.

Tipo: cadena

Errores

Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.

InvalidParameterValueException

Indica que hay algún problema con el valor de un parámetro. Por ejemplo, el valor está fuera del rango.

Context

Type

Código de estado HTTP: 400

MissingParameterValueException

Indica que falta un parámetro obligatorio.

Context

Type

Código de estado HTTP: 400

ResourceNotFoundException

No existe un recurso necesario para la acción.

Context

Type

Código de estado HTTP: 400

ServiceUnavailableException

La solicitud no se ha ejecutado correctamente debido a un error temporal del servidor.

Context

Type

Código de estado HTTP: 500

Véase también

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente: