Amazon ya no CodeCatalyst está abierto a nuevos clientes. Los clientes existentes pueden seguir utilizando el servicio con normalidad. Para obtener más información, consulte [Cómo migrar desde CodeCatalyst](migration.md).

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

# Propiedades de SARIF admitidas
<a name="test.sarif"></a>

El formato de intercambio de resultados de análisis estático (SARIF) es un formato de archivo de salida que está disponible en los informes de análisis de composición de software (SCA) y análisis estático en Amazon. CodeCatalyst En el siguiente ejemplo se muestra cómo configurar SARIF de forma manual en un informe de análisis estático:

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

CodeCatalyst admite las siguientes propiedades del SARIF, que se pueden utilizar para optimizar la forma en que aparecerán los resultados del análisis en sus informes.

**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>


| Name | Obligatorio | Descripción | 
| --- | --- | --- | 
| `$schema` | Sí | El URI del esquema JSON de SARIF para la versión [2.1.0](https://json.schemastore.org/sarif-2.1.0.json). | 
| `version` | Sí | CodeCatalyst solo es compatible con la versión 2.1.0 de SARIF. | 
| `runs[]` | Sí | Un archivo SARIF contiene una matriz de una o varias ejecuciones, en la que cada cual representa una ejecución única de la herramienta de análisis. | 

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


| Name | Obligatorio | Descripción | 
| --- | --- | --- | 
| `tool.driver` | Sí | Un objeto `toolComponent` que describe la herramienta de análisis. | 
| `tool.name` | No | Una propiedad que indica el nombre de la herramienta utilizada para realizar el análisis. | 
| `results[]` | Sí | Los resultados de la herramienta de análisis que se muestran en. CodeCatalyst | 

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


| Name | Obligatorio | Descripción | 
| --- | --- | --- | 
| `name` | Sí | El nombre de la herramienta de análisis. | 
| `properties.artifactScanned` | No | Número total de artefactos analizados por la herramienta. | 
| `rules[]` | Sí | Una matriz de objetos `reportingDescriptor` que representan reglas. Según estas reglas, la herramienta de análisis encuentra problemas en el código que se analiza. | 

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


| Name | Obligatorio | Descripción | 
| --- | --- | --- | 
| `id` | Sí | El identificador único de la regla que se utiliza para hacer referencia a un resultado.<br />Longitud máxima: 1024 caracteres | 
| `name` | No | Nombre de visualización de la regla.<br />Longitud máxima: 1024 caracteres | 
| `shortDescription.text` | No | Descripción abreviada de la regla.<br />Longitud máxima: 3000 caracteres | 
| `fullDescription.text` | No | Descripción completa de la regla.<br />Longitud máxima: 3000 caracteres | 
| `helpUri` | No | Cadena que se puede localizar para que contenga el URI absoluto de la documentación principal de la regla.<br />Longitud máxima: 3000 caracteres | 
| `properties.unscore` | No | Un indicador que señala si se ha puntuado el resultado del análisis. | 
| `properties.score.severity` | No | Un conjunto fijo de cadenas que especifican el nivel de gravedad del resultado.<br />Longitud máxima: 1024 caracteres | 
| `properties.cvssv3_baseSeverity` | No | Una calificación cualitativa de la gravedad según el [Common Vulnerability Scoring System v3.1](https://www.first.org/cvss/v3.1/specification-document). | 
| `properties.cvssv3_baseScore` | No | Una puntuación base de CVSS v3 que oscila entre [0.0 y 10.0](https://nvd.nist.gov/vuln-metrics/cvss). | 
| `properties.cvssv2_severity` | No | Si los valores de CVSS v3 no están disponibles, CodeCatalyst busca los valores de CVSS v2. | 
| `properties.cvssv2_score` | No | Una puntuación base de CVSS v2 que oscila entre [0.0 y 10.0](https://nvd.nist.gov/vuln-metrics/cvss). | 
| `properties.severity` | No | Un conjunto fijo de cadenas que especifican el nivel de gravedad del resultado.<br />Longitud máxima: 1024 caracteres | 
| `defaultConfiguration.level` | No | La gravedad predeterminada de una regla. | 

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


| Name | Obligatorio | Descripción | 
| --- | --- | --- | 
| `ruleId` | Sí | El identificador único de la regla que se utiliza para hacer referencia a un resultado.<br />Longitud máxima: 1024 caracteres | 
| `ruleIndex` | Sí | El índice de la regla asociada en el componente de la herramienta `rules[]`. | 
| `message.text` | Sí | Un mensaje que describe el resultado y muestra el mensaje de cada resultado.<br />Longitud máxima: 3000 caracteres | 
| `rank` | No | Un valor comprendido entre 0.0 y 100.0, ambos inclusive, que representa la prioridad o la importancia del resultado. En esta escala se valora 0.0 como la prioridad más baja y 100.0 como la prioridad más alta. | 
| `level` | No | La gravedad del resultado.<br />Longitud máxima: 1024 caracteres | 
| `properties.unscore` | No | Un indicador que señala si se ha puntuado el resultado del análisis. | 
| `properties.score.severity` | No | Un conjunto fijo de cadenas que especifican el nivel de gravedad del resultado.<br />Longitud máxima: 1024 caracteres | 
| `properties.cvssv3_baseSeverity` | No | Una calificación cualitativa de la gravedad según el [Common Vulnerability Scoring System v3.1](https://www.first.org/cvss/v3.1/specification-document). | 
| `properties.cvssv3_baseScore` | No | Una puntuación base de CVSS v3 que oscila entre [0.0 y 10.0](https://nvd.nist.gov/vuln-metrics/cvss). | 
| `properties.cvssv2_severity` | No | Si los valores de CVSS v3 no están disponibles, CodeCatalyst busca los valores de CVSS v2. | 
| `properties.cvssv2_score` | No | Una puntuación base de CVSS v2 que oscila entre [0.0 y 10.0](https://nvd.nist.gov/vuln-metrics/cvss). | 
| `properties.severity` | No | Un conjunto fijo de cadenas que especifican el nivel de gravedad del resultado.<br />Longitud máxima: 1024 caracteres | 
| `locations[]` | Sí | El conjunto de ubicaciones en las que se detectó el resultado. Solo se debe incluir una ubicación, a menos que el problema solo se pueda corregir realizando un cambio en cada ubicación especificada. CodeCatalyst utiliza el primer valor de la matriz de ubicaciones para anotar el resultado.<br />Número máximo de objetos `location`: 10 | 
| `relatedLocations[]` | No | Una lista de ubicaciones adicionales a las que se hace referencia en el resultado.<br />Número máximo de objetos `location`: 50 | 
| `fixes[]` | No | Matriz de `fix` objetos que representan la recomendación proporcionada por la herramienta de digitalización. CodeCatalyst utiliza la primera recomendación de la `fixes` matriz. | 

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


| Name | Obligatorio | Descripción | 
| --- | --- | --- | 
| `physicalLocation` | Sí | Identifica el artefacto y la región. | 
| `logicalLocations[]` | No | El conjunto de ubicaciones descritas por su nombre sin hacer referencia al artefacto. | 

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


| Name | Obligatorio | Descripción | 
| --- | --- | --- | 
| `artifactLocation.uri` | Sí | El URI que indica la ubicación de un artefacto, normalmente un archivo en el repositorio o generado durante una compilación. | 
| `fileLocation.uri` | No | El URI alternativo que indica la ubicación del archivo. Se usa si se devuelve `artifactLocation.uri` vacío. | 
| `region.startLine` | Sí | El número de línea del primer carácter de la región. | 
| `region.startColumn` | Sí | El número de columna del primer carácter de la región. | 
| `region.endLine` | Sí | El número de línea del último carácter de la región. | 
| `region.endColumn` | Sí | El número de columna del último carácter de la región. | 

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


| Name | Obligatorio | Description (Descripción) | 
| --- | --- | --- | 
| `fullyQualifiedName` | No | Información adicional que describe la ubicación del resultado.<br />Longitud máxima: 1024 caracteres | 

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


| Name | Obligatorio | Description (Descripción) | 
| --- | --- | --- | 
| `description.text` | No | Un mensaje que muestra una recomendación para cada resultado.<br />Longitud máxima: 3000 caracteres | 
| `artifactChanges.[0].artifactLocation.uri` | No | El URI que indica la ubicación del artefacto que se debe actualizar. |