Amazon CodeCatalyst は新規のお客様には提供されなくなりました。既存のお客様は、通常どおりサービスを引き続き使用できます。詳細については、「[CodeCatalyst から移行する方法](migration.md)」を参照してください。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# サポートされている SARIF プロパティ
<a name="test.sarif"></a>

Static Analysis Results Interchange Format (SARIF) は、Amazon CodeCatalyst のソフトウェア構成分析 (SCA) レポートおよび静的分析レポートで使用可能な出力ファイル形式です。次の例は、静的分析レポートで SARIF を手動で設定する方法を示しています。

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

CodeCatalyst では、次の SARIF プロパティがサポートされています。これらのプロパティを使用して、レポートにおける分析結果の表示を最適化できます。

**Topics**
+ [`sarifLog` オブジェクト](#test.sarif.sarifLog)
+ [`run` オブジェクト](#test.sarif.run)
+ [`toolComponent` オブジェクト](#test.sarif.toolComponent)
+ [`reportingDescriptor` オブジェクト](#test.sarif.reportingDescriptor)
+ [`result` オブジェクト](#test.sarif.result)
+ [`location` オブジェクト](#test.sarif.location)
+ [`physicalLocation` オブジェクト](#test.sarif.physicalLocation)
+ [`logicalLocation` オブジェクト](#test.sarif.logicalLocation)
+ [`fix` オブジェクト](#test.sarif.fix)

## `sarifLog` オブジェクト
<a name="test.sarif.sarifLog"></a>


| 名前 | 必要 | 説明 | 
| --- | --- | --- | 
| `$schema` | はい | バージョン [2.1.0](https://json.schemastore.org/sarif-2.1.0.json) の SARIF JSON スキーマの URI です。 | 
| `version` | はい | CodeCatalyst は、SARIF バージョン 2.1.0 のみをサポートしています。 | 
| `runs[]` | はい | SARIF ファイルには 1 つまたは複数の実行で構成された配列が含まれており、それぞれが分析ツールの単一の実行を表します。 | 

## `run` オブジェクト
<a name="test.sarif.run"></a>


| 名前 | 必要 | 説明 | 
| --- | --- | --- | 
| `tool.driver` | はい | 分析ツールを説明する `toolComponent` オブジェクトです。 | 
| `tool.name` | いいえ | 分析の実行に使用されるツールの名前を示すプロパティです。 | 
| `results[]` | はい | CodeCatalyst に表示される分析ツールの結果です。 | 

## `toolComponent` オブジェクト
<a name="test.sarif.toolComponent"></a>


| 名前 | 必要 | 説明 | 
| --- | --- | --- | 
| `name` | はい | 分析ツールの名前です。 | 
| `properties.artifactScanned` | いいえ | 分析ツールで分析されたアーティファクトの合計数です。 | 
| `rules[]` | はい | ルールを表す `reportingDescriptor` オブジェクトの配列です。分析ツールでは、これらのルールに基づいて、分析されたコードの問題を検出します。 | 

## `reportingDescriptor` オブジェクト
<a name="test.sarif.reportingDescriptor"></a>


| 名前 | 必要 | 説明 | 
| --- | --- | --- | 
| `id` | はい | 検出結果の参照に使用される、ルールの一意の識別子です。<br />最大長: 1,024 文字 | 
| `name` | いいえ | ルールの表示名です。<br />最大長: 1,024 文字 | 
| `shortDescription.text` | いいえ | ルールの短い説明です。<br />最大長: 3,000 文字 | 
| `fullDescription.text` | いいえ | ルールの完全な説明です。<br />最大長: 3,000 文字 | 
| `helpUri` | いいえ | ルールのプライマリドキュメントの絶対 URI を含むようにローカライズできる文字列です。<br />最大長: 3,000 文字 | 
| `properties.unscore` | いいえ | スキャンの検出結果がスコアリングされているかを示すフラグです。 | 
| `properties.score.severity` | いいえ | 検出結果の重要度レベルを指定する固定された文字列セットです。<br />最大長: 1,024 文字 | 
| `properties.cvssv3_baseSeverity` | いいえ | [Common Vulnerability Scoring System v3.1](https://www.first.org/cvss/v3.1/specification-document) に基づく重要度の定性評価です。 | 
| `properties.cvssv3_baseScore` | いいえ | CVSS v3 ベーススコアの範囲は [0.0～10.0](https://nvd.nist.gov/vuln-metrics/cvss) です。 | 
| `properties.cvssv2_severity` | いいえ | CVSS v3 値が存在しない場合、CodeCatalyst は CVSS v2 値を検索します。 | 
| `properties.cvssv2_score` | いいえ | CVSS v2 ベーススコアの範囲は [0.0～10.0](https://nvd.nist.gov/vuln-metrics/cvss) です。 | 
| `properties.severity` | いいえ | 検出結果の重要度レベルを指定する固定された文字列セットです。<br />最大長: 1,024 文字 | 
| `defaultConfiguration.level` | いいえ | ルールのデフォルトの重要度です。 | 

## `result` オブジェクト
<a name="test.sarif.result"></a>


| 名前 | 必要 | 説明 | 
| --- | --- | --- | 
| `ruleId` | はい | 検出結果の参照に使用される、ルールの一意の識別子です。<br />最大長: 1,024 文字 | 
| `ruleIndex` | はい | ツールコンポーネント `rules[]` 内で関連付けられたルールのインデックスです。 | 
| `message.text` | はい | 結果を説明するメッセージです。各検出結果に対してメッセージを表示します。<br />最大長: 3,000 文字 | 
| `rank` | いいえ | 結果の優先度、すなわち重要度を 0.0～100.0 の範囲で表す値です。このスケール値では、0.0 が最低優先度、100.0 が最高優先度を示します。 | 
| `level` | いいえ | 結果の重要度です。<br />最大長: 1,024 文字 | 
| `properties.unscore` | いいえ | スキャンの検出結果がスコアリングされているかを示すフラグです。 | 
| `properties.score.severity` | いいえ | 検出結果の重要度レベルを指定する固定された文字列セットです。<br />最大長: 1,024 文字 | 
| `properties.cvssv3_baseSeverity` | いいえ | [Common Vulnerability Scoring System v3.1](https://www.first.org/cvss/v3.1/specification-document) に基づく重要度の定性評価です。 | 
| `properties.cvssv3_baseScore` | いいえ | CVSS v3 ベーススコアの範囲は [0.0～10.0](https://nvd.nist.gov/vuln-metrics/cvss) です。 | 
| `properties.cvssv2_severity` | いいえ | CVSS v3 値が存在しない場合、CodeCatalyst は CVSS v2 値を検索します。 | 
| `properties.cvssv2_score` | いいえ | CVSS v2 ベーススコアの範囲は [0.0～10.0](https://nvd.nist.gov/vuln-metrics/cvss) です。 | 
| `properties.severity` | いいえ | 検出結果の重要度レベルを指定する固定された文字列セットです。<br />最大長: 1,024 文字 | 
| `locations[]` | はい | 結果が検出された場所のセットです。問題を修正するためにすべての指定された場所で変更が必要な場合を除き、1 つの場所のみを含めます。CodeCatalyst は、location 配列内の最初の値を使用して結果に注釈を付けます。<br />`location` オブジェクトの最大数: 10 | 
| `relatedLocations[]` | いいえ | 検出結果に関連する他の場所の参照リストです。<br />`location` オブジェクトの最大数: 50 | 
| `fixes[]` | いいえ | スキャンツールで提供される修正推奨を示す `fix` オブジェクトの配列です。CodeCatalyst は、`fixes` 配列内の最初の修正推奨を使用します。 | 

## `location` オブジェクト
<a name="test.sarif.location"></a>


| 名前 | 必要 | 説明 | 
| --- | --- | --- | 
| `physicalLocation` | はい | アーティファクトとリージョンを識別します。 | 
| `logicalLocations[]` | いいえ | アーティファクトを参照せずに名前で示される場所のセットです。 | 

## `physicalLocation` オブジェクト
<a name="test.sarif.physicalLocation"></a>


| 名前 | 必要 | 説明 | 
| --- | --- | --- | 
| `artifactLocation.uri` | はい | アーティファクトの場所を示す URI です。通常は、リポジトリ内に存在するファイルまたはビルド中に生成されるファイルを指します。 | 
| `fileLocation.uri` | いいえ | ファイルの場所を示すフォールバック URI です。これは、`artifactLocation.uri` が空を返す場合に使用されます。 | 
| `region.startLine` | はい | そのリージョン内で最初に文字が存在する行番号です。 | 
| `region.startColumn` | はい | そのリージョン内で最初に文字が存在する列番号です。 | 
| `region.endLine` | はい | そのリージョン内で最後に文字が存在する行番号です。 | 
| `region.endColumn` | はい | そのリージョン内で最後に文字が存在する列番号です。 | 

## `logicalLocation` オブジェクト
<a name="test.sarif.logicalLocation"></a>


| 名前 | 必要 | 説明 | 
| --- | --- | --- | 
| `fullyQualifiedName` | いいえ | 結果の場所を示す追加情報です。<br />最大長: 1,024 文字 | 

## `fix` オブジェクト
<a name="test.sarif.fix"></a>


| 名前 | 必要 | 説明 | 
| --- | --- | --- | 
| `description.text` | いいえ | 各検出結果に対する修正推奨を表示するメッセージです。<br />最大長: 3,000 文字 | 
| `artifactChanges.[0].artifactLocation.uri` | いいえ | 更新する必要があるアーティファクトの場所を示す URI です。 |