CreateFramework - AWS Backup

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

CreateFramework

Cria uma framework com um ou mais controles. Uma framework é uma coleção de controles podem ser utilizados para avaliar suas práticas de backup. Usando controles personalizáveis pré-criados para definir suas políticas, você pode avaliar se as suas práticas de backup estão em conformidade com as suas políticas e quais recursos ainda não estão em conformidade.

Sintaxe da Solicitação

POST /audit/frameworks HTTP/1.1 Content-type: application/json { "FrameworkControls": [ { "ControlInputParameters": [ { "ParameterName": "string", "ParameterValue": "string" } ], "ControlName": "string", "ControlScope": { "ComplianceResourceIds": [ "string" ], "ComplianceResourceTypes": [ "string" ], "Tags": { "string" : "string" } } } ], "FrameworkDescription": "string", "FrameworkName": "string", "FrameworkTags": { "string" : "string" }, "IdempotencyToken": "string" }

URIParâmetros de solicitação

A solicitação não usa nenhum URI parâmetro.

Corpo da Solicitação

A solicitação aceita os seguintes dados no JSON formato.

FrameworkControls

Os controles que compõem a estrutura. Cada controle na lista tem um nome, parâmetros de entrada e escopo.

Tipo: matriz de objetos FrameworkControl

Obrigatório: Sim

FrameworkDescription

Uma descrição opcional da framework com no máximo 1.024 caracteres.

Tipo: string

Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 1.024.

Padrão: .*\S.*

Obrigatório: Não

FrameworkName

O nome exclusivo da framework. Esse nome deve ter entre 1 e 256 caracteres, começando com uma letra, e consistir em letras (a-z, A-Z), números (0-9) e sublinhados (_).

Tipo: string

Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.

Padrão: [a-zA-Z][_a-zA-Z0-9]*

Exigido: Sim

FrameworkTags

As tags a serem atribuídas à estrutura.

Tipo: mapa de string para string

Obrigatório: Não

IdempotencyToken

Uma string escolhida pelo cliente que você pode usar para distinguir entre chamadas idênticas para CreateFrameworkInput. 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

Obrigatório: Não

Sintaxe da Resposta

HTTP/1.1 200 Content-type: application/json { "FrameworkArn": "string", "FrameworkName": "string" }

Elementos de Resposta

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

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

FrameworkArn

Um nome de recurso da Amazon (ARN) que identifica de forma exclusiva um recurso. O formato do ARN depende do tipo de recurso.

Tipo: string

FrameworkName

O nome exclusivo da framework. Esse nome deve ter entre 1 e 256 caracteres, começando com uma letra, e consistir em letras (a-z, A-Z), números (0-9) e sublinhados (_).

Tipo: string

Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.

Padrão: [a-zA-Z][_a-zA-Z0-9]*

Erros

Para obter informações sobre os erros comuns a todas as ações, consulte Erros comuns.

AlreadyExistsException

O recurso necessário já existe.

HTTPCódigo de status: 400

InvalidParameterValueException

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

HTTPCódigo de status: 400

LimitExceededException

Um limite na solicitação foi excedido; por exemplo, o número máximo de itens permitidos em uma solicitação.

HTTPCódigo de status: 400

MissingParameterValueException

Indica que um parâmetro necessário está ausente.

HTTPCódigo de status: 400

ServiceUnavailableException

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

HTTPCódigo de status: 500

Consulte também

Para obter mais informações sobre como usar isso API em um idioma específico AWS SDKs, consulte o seguinte: