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á.
Retorna os detalhes da framework para o FrameworkName especificado.
Sintaxe da Solicitação
GET /audit/frameworks/frameworkName HTTP/1.1
Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
- frameworkName
-
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]*Exigido: Sim
Corpo da Solicitação
Essa solicitação não tem corpo.
Sintaxe da resposta
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
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
-
A data e a hora em que a framework é criada, na representação ISO 8601. O valor de
CreationTimetem 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: carimbo de data/hora
- DeploymentStatus
-
O status de implantação de uma framework. Os status são:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILEDTipo: string
- FrameworkArn
-
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
-
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
- FrameworkDescription
-
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
-
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
-
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:
-
ACTIVEquando a gravação é ativada para todos os recursos controlados pela framework. -
PARTIALLY_ACTIVEquando a gravação é desativada para pelo menos um recurso controlado pela framework. -
INACTIVEquando a gravação é desativada para todos os recursos controlados pela framework. -
UNAVAILABLEquando AWS Backup não consegue validar o status da gravação no momento.
Tipo: string
-
- IdempotencyToken
-
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
Para obter informações sobre os erros comuns a todas as ações, consulte Erros comuns.
- InvalidParameterValueException
-
Indica que há algo errado com o valor de um parâmetro. Por exemplo, o valor está fora do intervalo.
Código de status HTTP: 400
- MissingParameterValueException
-
Indica que um parâmetro necessário está ausente.
Código de status HTTP: 400
- ResourceNotFoundException
-
Um recurso necessário para a ação não existe.
Código de status HTTP: 400
- ServiceUnavailableException
-
Houve falha na solicitação devido a um erro temporário do servidor.
Código de status HTTP: 500
Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
