A Amazon não CodeCatalyst está mais aberta a novos clientes. Os clientes atuais podem continuar usando o serviço normalmente. Para obter mais informações, consulte [Como migrar do CodeCatalyst](migration.md).

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

# Propriedades SARIF compatíveis
<a name="test.sarif"></a>

O Static Analysis Results Interchange Format (SARIF) é um formato de arquivo de saída que está disponível em análise de composição de software (SCA) e relatórios de análise estática na Amazon. CodeCatalyst O exemplo a seguir mostra como configurar manualmente o SARIF em um relatório de análise estática:

```
Reports:
MySAReport:
Format: SARIFSA
IncludePaths:
    - output/sa_report.json
SuccessCriteria:
    StaticAnalysisFinding:
    Number: 25
    Severity: HIGH
```

CodeCatalyst suporta as seguintes propriedades SARIF, que podem ser usadas para otimizar a forma como os resultados da análise aparecerão em seus relatórios.

**Topics**
+ [Objeto `sarifLog`](#test.sarif.sarifLog)
+ [Objeto `run`](#test.sarif.run)
+ [Objeto `toolComponent`](#test.sarif.toolComponent)
+ [Objeto `reportingDescriptor`](#test.sarif.reportingDescriptor)
+ [Objeto `result`](#test.sarif.result)
+ [Objeto `location`](#test.sarif.location)
+ [Objeto `physicalLocation`](#test.sarif.physicalLocation)
+ [Objeto `logicalLocation`](#test.sarif.logicalLocation)
+ [Objeto `fix`](#test.sarif.fix)

## Objeto `sarifLog`
<a name="test.sarif.sarifLog"></a>


| Nome | Obrigatório | Descrição | 
| --- | --- | --- | 
|  `$schema`  |  Sim  |  O URI do esquema SARIF JSON para a versão [2.1.0](https://json.schemastore.org/sarif-2.1.0.json).  | 
|  `version`  |  Sim  |  CodeCatalyst suporta apenas a versão 2.1.0 do SARIF.  | 
|  `runs[]`  |  Sim  |  Um arquivo SARIF contém uma ou mais execuções, cada uma das quais representando uma única execução da ferramenta de análise.  | 

## Objeto `run`
<a name="test.sarif.run"></a>


| Nome | Obrigatório | Descrição | 
| --- | --- | --- | 
|  `tool.driver`  |  Sim  |  Um objeto `toolComponent` que descreve a ferramenta de análise.  | 
|  `tool.name`  |  Não  |  Uma propriedade que indica o nome da ferramenta usada para realizar a análise.  | 
|  `results[]`  |  Sim  |  Os resultados da ferramenta de análise que são exibidos em CodeCatalyst.  | 

## Objeto `toolComponent`
<a name="test.sarif.toolComponent"></a>


| Nome | Obrigatório | Descrição | 
| --- | --- | --- | 
|  `name`  |  Sim  |  O nome da ferramenta de análise.  | 
|  `properties.artifactScanned`  |  Não  |  Um número total de artefatos analisados pela ferramenta.  | 
|  `rules[]`  |  Sim  |  Uma matriz de objetos `reportingDescriptor` que representam regras. Com base nessas regras, a ferramenta de análise encontra problemas no código que é analisado.  | 

## Objeto `reportingDescriptor`
<a name="test.sarif.reportingDescriptor"></a>


| Nome | Obrigatório | Descrição | 
| --- | --- | --- | 
|  `id`  |  Sim  |  O identificador exclusivo da regra que é usada para referenciar uma descoberta. Tamanho máximo: 1.024 caracteres  | 
|  `name`  |  Não  |  O nome de exibição da regra. Tamanho máximo: 1.024 caracteres  | 
|  `shortDescription.text`  |  Não  |  Uma descrição resumida da regra. Tamanho máximo: 3.000 caracteres  | 
|  `fullDescription.text`  |  Não  |  Uma descrição completa da regra. Tamanho máximo: 3.000 caracteres  | 
|  `helpUri`  |  Não  |  Uma string que pode ser localizada para conter o URI absoluto da documentação primária da regra. Tamanho máximo: 3.000 caracteres  | 
|  `properties.unscore`  |  Não  |  Um sinalizador que indica se a descoberta do escaneamento foi pontuada.  | 
|  `properties.score.severity`  |  Não  |  Um conjunto fixo de strings que especificam o nível de gravidade da descoberta. Tamanho máximo: 1.024 caracteres  | 
|  `properties.cvssv3_baseSeverity`  |  Não  |  Uma classificação de gravidade qualitativa do [Sistema de pontuação de vulnerabilidades comuns v3.1](https://www.first.org/cvss/v3.1/specification-document).  | 
|  `properties.cvssv3_baseScore`  |  Não  |  Uma pontuação básica do CVSS v3 variando de [0,0 a 10,0](https://nvd.nist.gov/vuln-metrics/cvss).  | 
|  `properties.cvssv2_severity`  |  Não  |  Se os valores do CVSS v3 não estiverem disponíveis, CodeCatalyst pesquisa os valores do CVSS v2.  | 
|  `properties.cvssv2_score`  |  Não  |  Uma pontuação básica do CVSS v2 variando de [0,0 a 10,0](https://nvd.nist.gov/vuln-metrics/cvss).  | 
|  `properties.severity`  |  Não  |  Um conjunto fixo de strings que especificam o nível de gravidade da descoberta. Tamanho máximo: 1.024 caracteres  | 
|  `defaultConfiguration.level`  |  Não  |  A gravidade padrão de uma regra.  | 

## Objeto `result`
<a name="test.sarif.result"></a>


| Nome | Obrigatório | Descrição | 
| --- | --- | --- | 
|  `ruleId`  |  Sim  |  O identificador exclusivo da regra que é usada para referenciar uma descoberta. Tamanho máximo: 1.024 caracteres  | 
|  `ruleIndex`  |  Sim  |  O índice da regra associada no componente da ferramenta `rules[]`.  | 
|  `message.text`  |  Sim  |  Uma mensagem que descreve o resultado e exibe a mensagem de cada descoberta. Tamanho máximo: 3.000 caracteres  | 
|  `rank`  |  Não  |  Um valor entre 0,0 e 100,0, inclusive, que representa a prioridade ou importância do resultado. Essa escala considera 0,0 como a prioridade mais baixa e 100,0 como a prioridade mais alta.  | 
|  `level`  |  Não  |  A gravidade do resultado. Tamanho máximo: 1.024 caracteres  | 
|  `properties.unscore`  |  Não  |  Um sinalizador que indica se a descoberta do escaneamento foi pontuada.  | 
|  `properties.score.severity`  |  Não  |  Um conjunto fixo de strings que especificam o nível de gravidade da descoberta. Tamanho máximo: 1.024 caracteres  | 
|  `properties.cvssv3_baseSeverity`  |  Não  |  Uma classificação de gravidade qualitativa do [Sistema de pontuação de vulnerabilidades comuns v3.1](https://www.first.org/cvss/v3.1/specification-document).  | 
|  `properties.cvssv3_baseScore`  |  Não  |  Uma pontuação básica do CVSS v3 variando de [0,0 a 10,0](https://nvd.nist.gov/vuln-metrics/cvss).  | 
|  `properties.cvssv2_severity`  |  Não  |  Se os valores do CVSS v3 não estiverem disponíveis, CodeCatalyst pesquisa os valores do CVSS v2.  | 
|  `properties.cvssv2_score`  |  Não  |  Uma pontuação básica do CVSS v2 variando de [0,0 a 10,0](https://nvd.nist.gov/vuln-metrics/cvss).  | 
|  `properties.severity`  |  Não  |  Um conjunto fixo de strings que especificam o nível de gravidade da descoberta. Tamanho máximo: 1.024 caracteres  | 
|  `locations[]`  |  Sim  |  O conjunto de locais em que o resultado foi detectado. Somente um local deve ser incluído, a menos que o problema só possa ser corrigido fazendo uma alteração em cada local especificado. CodeCatalyst usa o primeiro valor na matriz de localização para anotar o resultado. Número máximo de objetos `location`: 10  | 
|  `relatedLocations[]`  |  Não  |  Uma lista de referências de localizações adicionais na descoberta. Número máximo de objetos `location`: 50  | 
|  `fixes[]`  |  Não  |  Uma matriz de `fix` objetos que representam a recomendação fornecida pela ferramenta de digitalização. CodeCatalyst usa a primeira recomendação na `fixes` matriz.  | 

## Objeto `location`
<a name="test.sarif.location"></a>


| Nome | Obrigatório | Descrição | 
| --- | --- | --- | 
|  `physicalLocation`  |  Sim  |  Identifica o artefato e a região.  | 
|  `logicalLocations[]`  |  Não  |  O conjunto de locais descritos pelo nome sem referência ao artefato.  | 

## Objeto `physicalLocation`
<a name="test.sarif.physicalLocation"></a>


| Nome | Obrigatório | Descrição | 
| --- | --- | --- | 
|  `artifactLocation.uri`  |  Sim  |  O URI que indica a localização de um artefato, geralmente um arquivo no repositório ou gerado durante uma compilação.  | 
|  `fileLocation.uri`  |  Não  |  O URI de retorno indicando a localização do arquivo. Isso será usado se `artifactLocation.uri` retornar vazio.  | 
|  `region.startLine`  |  Sim  |  O número da linha do primeiro caractere na região.  | 
|  `region.startColumn`  |  Sim  |  O número da coluna do primeiro caractere na região.  | 
|  `region.endLine`  |  Sim  |  O número da linha do último caractere na região.  | 
|  `region.endColumn`  |  Sim  |  O número da coluna do último caractere na região.  | 

## Objeto `logicalLocation`
<a name="test.sarif.logicalLocation"></a>


| Nome | Obrigatório | Description | 
| --- | --- | --- | 
|  `fullyQualifiedName`  |  Não  |  Informações adicionais que descrevem a localização do resultado. Tamanho máximo: 1.024 caracteres  | 

## Objeto `fix`
<a name="test.sarif.fix"></a>


| Nome | Obrigatório | Description | 
| --- | --- | --- | 
|  `description.text`  |  Não  |  Uma mensagem que exibe uma recomendação para cada descoberta. Tamanho máximo: 3.000 caracteres  | 
|  `artifactChanges.[0].artifactLocation.uri`  |  Não  |  O URI que indica a localização do artefato que precisa ser atualizado.  |