> Source: https://www.ymotongpoo.com/works/otel-specs-ja/semconv/object-stores/s3/


# AWS S3クライアントスパンに関するセマンティック規約

**ステータス**: [Development][DocumentStatus]

<!-- semconv span.aws.s3.client -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start -->

**Status:** ![Development](https://img.shields.io/badge/-development-blue)

AWS S3クライアントスパンに関するセマンティック規約は、一般的な[AWS SDKセマンティック規約](/works/otel-specs-ja/semconv/cloud-providers/aws-sdk/)を拡張します。

**スパン種別**は`CLIENT`であるべきです（SHOULD）。

**スパンステータス**は[エラーの記録](/works/otel-specs-ja/semconv/general/recording-errors/)文書に従うべきです（SHOULD）。

**Attributes:**

| Key | Stability | [Requirement Level](/works/otel-specs-ja/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values |
| --- | --- | --- | --- | --- | --- |
| [`rpc.system`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/rpc/) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>`rpc.system.name`に置き換えられました。 | `Required` | string | `aws-api`という値。 | `aws-api` |
| [`aws.extended_request_id`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/aws/) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` If available. | string | レスポンスヘッダー`x-amz-id-2`で返されるAWS拡張リクエストID。 | `wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=` |
| [`aws.request_id`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/aws/) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | レスポンスヘッダー`x-amzn-requestid`、`x-amzn-request-id`、`x-amz-request-id`のいずれかで返されるAWSリクエストID。 | `79b9da39-b7ae-508a-a6bc-864b2829c622`; `C9ER4AJX75574TDJ` |
| [`aws.s3.bucket`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/aws/) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | リクエストが参照するS3バケット名。[S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html)操作の`--bucket`パラメータに対応します。[1] | `some-bucket-name` |
| [`aws.s3.copy_source`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/aws/) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | コピー操作におけるコピー元オブジェクト（`bucket`/`key`の形式）。[2] | `someFile.yml` |
| [`aws.s3.delete`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/aws/) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | 削除対象のオブジェクトを指定する削除リクエストコンテナ。[3] | `Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=boolean` |
| [`aws.s3.key`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/aws/) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | リクエストが参照するS3オブジェクトキー。[S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html)操作の`--key`パラメータに対応します。[4] | `someFile.yml` |
| [`aws.s3.part_number`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/aws/) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | int | マルチパートアップロード操作でアップロードされているパートの番号。1から10,000までの正の整数です。[5] | `3456` |
| [`aws.s3.upload_id`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/aws/) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | マルチパートアップロードを識別するアップロードID。[6] | `dfRtDYWFbkRONycy.Yxwh66Yjlx.cph0gtNBtJ` |
| [`cloud.region`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/cloud/) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | 要求されたサービスへのアクセス先となるAWSリージョン。[7] | `us-east-1`; `us-west-2` |
| [`rpc.method`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/rpc/) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | AWS SDKによって返される、リクエストに対応する操作の名前。 | `GetItem`; `PutItem` |
| [`rpc.service`](https://opentelemetry.io/docs/specs/semconv/registry/attributes/rpc/) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>完全修飾名であることが期待される`rpc.method`に含めるべき値です。 | `Recommended` | string | AWS SDKによって返される、リクエスト先のサービス名。 | `DynamoDB`; `S3` |

**[1] `aws.s3.bucket`:** `bucket`属性は、バケットを参照するすべてのS3操作、つまりバケット名を必須パラメータとして要求するすべての操作に適用されます。
これは`list-buckets`を除くほぼすべてのS3操作に当てはまります。

**[2] `aws.s3.copy_source`:** `copy_source`属性はS3のコピー操作に適用され、[S3 API内のcopy-object操作](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html)の`--copy-source`パラメータに対応します。
特に、次の操作に当てはまります。

- [copy-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html)
- [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html)

**[3] `aws.s3.delete`:** `delete`属性は、[delete-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-object.html)操作にのみ適用されます。
`delete`属性は、[S3 API内のdelete-objects操作](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-objects.html)の`--delete`パラメータに対応します。

**[4] `aws.s3.key`:** `key`属性は、オブジェクトに関連するすべてのS3操作、つまりオブジェクトキーを必須パラメータとして要求するすべての操作に適用されます。
特に、次の操作に当てはまります。

- [copy-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html)
- [delete-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-object.html)
- [get-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/get-object.html)
- [head-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/head-object.html)
- [put-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/put-object.html)
- [restore-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/restore-object.html)
- [select-object-content](https://docs.aws.amazon.com/cli/latest/reference/s3api/select-object-content.html)
- [abort-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/abort-multipart-upload.html)
- [complete-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/complete-multipart-upload.html)
- [create-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/create-multipart-upload.html)
- [list-parts](https://docs.aws.amazon.com/cli/latest/reference/s3api/list-parts.html)
- [upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html)
- [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html)

**[5] `aws.s3.part_number`:** `part_number`属性は、[upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html)操作と[upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html)操作にのみ適用されます。
`part_number`属性は、[S3 API内のupload-part操作](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html)の`--part-number`パラメータに対応します。

**[6] `aws.s3.upload_id`:** `upload_id`属性は、S3のマルチパートアップロード操作に適用され、[S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html)のマルチパート操作の`--upload-id`パラメータに対応します。
特に、次の操作に当てはまります。

- [abort-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/abort-multipart-upload.html)
- [complete-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/complete-multipart-upload.html)
- [list-parts](https://docs.aws.amazon.com/cli/latest/reference/s3api/list-parts.html)
- [upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html)
- [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html)

**[7] `cloud.region`:** 特定のAWSサービス呼び出しに対してSDKクライアントが対象とするAWSリージョンを指定します。この属性の値は、[AWSのドキュメント](https://docs.aws.amazon.com/global-infrastructure/latest/regions/aws-regions.html#available-regions)に記載されているAWSリージョンコードに従うべきです（should）。

---

`rpc.system`には、次のよく知られた値の一覧があります。これらのいずれかが該当する場合は、対応する値を使用しなければなりません（MUST）。そうでない場合は、独自の値を使用してもかまいません（MAY）。

| Value | Description | Stability |
| --- | --- | --- |
| `apache_dubbo` | Apache Dubbo | ![Development](https://img.shields.io/badge/-development-blue) |
| `connect_rpc` | Connect RPC | ![Development](https://img.shields.io/badge/-development-blue) |
| `dotnet_wcf` | .NET WCF | ![Development](https://img.shields.io/badge/-development-blue) |
| `grpc` | gRPC | ![Development](https://img.shields.io/badge/-development-blue) |
| `java_rmi` | Java RMI | ![Development](https://img.shields.io/badge/-development-blue) |
| `jsonrpc` | JSON-RPC | ![Development](https://img.shields.io/badge/-development-blue) |
| `onc_rpc` | [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) | ![Development](https://img.shields.io/badge/-development-blue) |

<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

