View a markdown version of this page

ValidatePolicy - IAM Access Analyzer
Sintaxe da SolicitaçãoParâmetros da Solicitação de URICorpo da SolicitaçãoSintaxe da respostaElementos de respostaErrosConsulte também

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

ValidatePolicy

Solicita a validação de uma política e retorna uma lista de descobertas. As descobertas ajudam você a identificar problemas e a fornecer recomendações práticas para resolvê-los, além de permitir que você crie políticas funcionais que atendam às melhores práticas de segurança.

Sintaxe da Solicitação

POST /policy/validation?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "locale": "string",
   "policyDocument": "string",
   "policyType": "string",
   "validatePolicyResourceType": "string"
}

Parâmetros da Solicitação de URI

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

maxResults

O número máximo de resultados a serem apresentados na resposta.

nextToken

Um token usado para paginação dos resultados retornados.

Corpo da Solicitação

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

locale

O local a ser usado para localizar as descobertas.

Tipo: string

Valores válidos: DE | EN | ES | FR | IT | JA | KO | PT_BR | ZH_CN | ZH_TW

Obrigatório: não

policyDocument

O documento de política JSON a ser usado como conteúdo da política.

Tipo: String

Obrigatório: Sim

policyType

O tipo de política a ser validada. As políticas de identidade concedem permissões aos diretores do IAM. As políticas de identidade incluem políticas gerenciadas e em linha para funções, usuários e grupos do IAM.

As políticas de recursos concedem permissões aos AWS recursos. As políticas de recursos incluem políticas de confiança para funções do IAM e políticas de bucket para buckets do Amazon S3. Você pode fornecer uma entrada genérica, como política de identidade ou política de recursos, ou uma entrada específica, como política gerenciada ou política de bucket do Amazon S3.

As políticas de controle de serviços (SCPs) são um tipo de política organizacional vinculada a uma AWS organização, unidade organizacional (OU) ou conta.

Tipo: string

Valores válidos: IDENTITY_POLICY | RESOURCE_POLICY | SERVICE_CONTROL_POLICY | RESOURCE_CONTROL_POLICY

Obrigatório: Sim

validatePolicyResourceType

O tipo de recurso a ser anexado à sua política de recursos. Especifique um valor para o tipo de recurso de validação de política somente se o tipo de política forRESOURCE_POLICY. Por exemplo, para validar uma política de recursos para anexar a um bucket do Amazon S3, você pode escolher o tipo de recurso AWS::S3::Bucket de validação da política.

Para tipos de recursos não suportados como valores válidos, o IAM Access Analyzer executa verificações de políticas que se aplicam a todas as políticas de recursos. Por exemplo, para validar uma política de recursos para anexar a uma chave KMS, não especifique um valor para o tipo de recurso de validação de política e o IAM Access Analyzer executará verificações de política que se aplicam a todas as políticas de recursos.

Tipo: string

Valores válidos: AWS::S3::Bucket | AWS::S3::AccessPoint | AWS::S3::MultiRegionAccessPoint | AWS::S3ObjectLambda::AccessPoint | AWS::IAM::AssumeRolePolicyDocument | AWS::DynamoDB::Table

Obrigatório: não

Sintaxe da resposta

HTTP/1.1 200
Content-type: application/json

{
   "findings": [ 
      { 
         "findingDetails": "string",
         "findingType": "string",
         "issueCode": "string",
         "learnMoreLink": "string",
         "locations": [ 
            { 
               "path": [ 
                  { ... }
               ],
               "span": { 
                  "end": { 
                     "column": number,
                     "line": number,
                     "offset": number
                  },
                  "start": { 
                     "column": number,
                     "line": number,
                     "offset": number
                  }
               }
            }
         ]
      }
   ],
   "nextToken": "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.

findings

A lista de descobertas em uma política retornada pelo IAM Access Analyzer com base em seu conjunto de verificações de políticas.

Tipo: matriz de objetos ValidatePolicyFinding

nextToken

Um token usado para paginação dos resultados retornados.

Tipo: string

Erros

Para obter informações sobre os erros que são comuns a todas as ações, consulte Tipos de erro comuns.

AccessDeniedException

Você não tem acesso suficiente para executar esta ação.

Código de status HTTP: 403

InternalServerException

Erro interno do servidor.

retryAfterSeconds

Os segundos de espera para tentar novamente.

Código de status HTTP: 500

ThrottlingException

O limite de limitação excedeu o erro.

retryAfterSeconds

Os segundos de espera para tentar novamente.

Código de status HTTP: 429

ValidationException

Erro de exceção de validação.

fieldList

Uma lista de campos que não foram validados.

reason

O motivo da exceção.

Código de Status HTTP: 400

Consulte também

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos do idioma, consulte o seguinte: