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

# DescribeFramework
<a name="API_DescribeFramework"></a>

Retorna os detalhes da framework para o `FrameworkName` especificado.

## Sintaxe da Solicitação
<a name="API_DescribeFramework_RequestSyntax"></a>

```
GET /audit/frameworks/frameworkName HTTP/1.1
```

## Parâmetros da Solicitação de URI
<a name="API_DescribeFramework_RequestParameters"></a>

A solicitação usa os seguintes parâmetros de URI:

 ** [frameworkName](#API_DescribeFramework_RequestSyntax) **   <a name="Backup-DescribeFramework-request-uri-FrameworkName"></a>
O nome exclusivo de uma framework.  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `[a-zA-Z][_a-zA-Z0-9]*`   
Obrigatório: Sim

## Corpo da Solicitação
<a name="API_DescribeFramework_RequestBody"></a>

Essa solicitação não tem corpo.

## Sintaxe da resposta
<a name="API_DescribeFramework_ResponseSyntax"></a>

```
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 resposta
<a name="API_DescribeFramework_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [CreationTime](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-CreationTime"></a>
A data e a hora em que a framework é criada, na representação ISO 8601. O valor de `CreationTime` tem precisão de milissegundos. Por exemplo, 2020-07-10T15:00:00.000-08:00 representa o dia 10 de julho de 2020 às 15:00, 8 horas antes do UTC.  
Tipo: Timestamp

 ** [DeploymentStatus](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-DeploymentStatus"></a>
O status de implantação de uma framework. Os status são:  
 `CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED`   
Tipo: string

 ** [FrameworkArn](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkArn"></a>
Um Nome do recurso da Amazon (ARN) que identifica de forma exclusiva um recurso. O formato do ARN depende do tipo de recurso.  
Tipo: string

 ** [FrameworkControls](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkControls"></a>
Os controles que compõem o framework. Cada controle na lista tem um nome, parâmetros de entrada e escopo.  
Tipo: matriz de objetos [FrameworkControl](API_FrameworkControl.md)

 ** [FrameworkDescription](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkDescription"></a>
Uma descrição opcional da framework.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 1.024.  
Padrão: `.*\S.*` 

 ** [FrameworkName](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkName"></a>
O nome exclusivo de uma framework.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `[a-zA-Z][_a-zA-Z0-9]*` 

 ** [FrameworkStatus](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkStatus"></a>
Uma framework consiste em um ou mais controles. Cada controle rege um recurso, como planos de backup, seleções de backup, cofres de backup ou pontos de recuperação. Também é possível ativar ou desativar a gravação do AWS Config de cada recurso. Os status são:  
+  `ACTIVE` quando a gravação é ativada para todos os recursos controlados pela framework.
+  `PARTIALLY_ACTIVE` quando a gravação é desativada para pelo menos um recurso controlado pela framework.
+  `INACTIVE` quando a gravação é desativada para todos os recursos controlados pela framework.
+  `UNAVAILABLE`quando AWS Backup não consegue validar o status da gravação no momento.
Tipo: string

 ** [IdempotencyToken](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-IdempotencyToken"></a>
Uma string escolhida pelo cliente que pode ser usada para distinguir entre chamadas idênticas para `DescribeFrameworkOutput`. Tentar novamente uma solicitação com êxito com o mesmo token de idempotência resultará em uma mensagem de êxito sem nenhuma ação tomada.  
Tipo: string

## Erros
<a name="API_DescribeFramework_Errors"></a>

Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).

 ** InvalidParameterValueException **   
Indica que há algo errado com o valor de um parâmetro. Por exemplo, o valor está fora do intervalo.    
 ** Context **   
  
 ** Type **   

Código de status HTTP: 400

 ** MissingParameterValueException **   
Indica que um parâmetro necessário está ausente.    
 ** Context **   
  
 ** Type **   

Código de status HTTP: 400

 ** ResourceNotFoundException **   
Um recurso necessário para a ação não existe.    
 ** Context **   
  
 ** Type **   

Código de status HTTP: 400

 ** ServiceUnavailableException **   
Houve falha na solicitação devido a um erro temporário do servidor.    
 ** Context **   
  
 ** Type **   

Código de status HTTP: 500

## Consulte também
<a name="API_DescribeFramework_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeFramework)