CreateLocationS3 - AWS DataSync
リクエストの構文リクエストパラメーターレスポンスの構文レスポンス要素エラー以下の資料も参照してください。

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

CreateLocationS3

Amazon S3 バケットの転送場所を作成します。 AWS DataSync は、この場所をデータ転送のソースまたは転送先として使用できます。

重要

始める前に、次のトピックをお読みください。

詳細については、「Configuring transfers with Amazon S3」を参照してください。

リクエストの構文

{
   "AgentArns": [ "string" ],
   "S3BucketArn": "string",
   "S3Config": { 
      "BucketAccessRoleArn": "string"
   },
   "S3StorageClass": "string",
   "Subdirectory": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

リクエストパラメーター

すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。

リクエストは以下のデータを JSON 形式で受け入れます。

AgentArns

(Amazon S3 on Outposts のみ) Outpost 上の DataSync エージェントの Amazon リソースネーム (ARN) を指定します。

詳細については、DataSync エージェントをデプロイする AWS Outposts」を参照してください。

型: 文字列の配列

配列メンバー: 最小数は 1 項目です。最大数は 4 項目です。

長さの制約: 最大長は 128 です。

パターン: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$

必須: いいえ

S3BucketArn

場所として使用する S3 バケットの ARN を指定します。(後で DataSync タスクを作成するときは、この場所がソースの場所か転送先かを指定します)。

S3 バケットが AWS Outposts リソースにある場合は、Amazon S3 アクセスポイントを指定する必要があります。詳細については、「Amazon S3 ユーザーガイド」の「Amazon S3 Access Points を使用したデータアクセスの管理」を参照してください。

タイプ: 文字列

長さの制約: 最大長は 268 です。

パターン: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):s3:[a-z\-0-9]*:[0-9]{12}:accesspoint[/:][a-zA-Z0-9\-.]{1,63}$|^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):s3-outposts:[a-z\-0-9]+:[0-9]{12}:outpost[/:][a-zA-Z0-9\-]{1,63}[/:]accesspoint[/:][a-zA-Z0-9\-]{1,63}$|^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):s3:::[a-zA-Z0-9.\-_]{1,255}$

必須: はい

S3Config

DataSync が S3 バケットにアクセスするために使用する AWS Identity and Access Management (IAM) ロールの Amazon リソースネーム (ARN) を指定します。

詳細については、S3 バケットへの DataSync アクセスの提供」を参照してください。

型: S3Config オブジェクト

必須: はい

S3StorageClass

Amazon S3 が転送先である場合にオブジェクトで使用するストレージクラスを指定します。

のバケットの場合 AWS リージョン、ストレージクラスはデフォルトで になりますSTANDARD。上のバケットの場合 AWS Outposts、ストレージクラスはデフォルトで になりますOUTPOSTS。

詳細については、「Storage class considerations with Amazon S3 transfers」を参照してください。

タイプ: 文字列

有効な値：STANDARD | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_INSTANT_RETRIEVAL

必須: いいえ

Subdirectory

DataSync が読み書きする S3 バケットのプレフィックスを指定します (バケットがソースまたは送信先の場所であるかどうかに応じて)。

注記

DataSync は、スラッシュ (/) で始まるプレフィックス、または //、/./、または /../ パターンを含むプレフィックスを持つオブジェクトを転送できません。例:

  • /photos

  • photos//2006/January

  • photos/./2006/February

  • photos/../2006/March

タイプ: 文字列

長さの制約: 最大長は 4,096 です。

パターン: ^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$

必須: いいえ

Tags

AWS リソースの分類、フィルタリング、検索に役立つラベルを指定します。少なくても転送場所の名前タグを作成することを推奨します。

タイプ: TagListEntry オブジェクトの配列

配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。

必須: いいえ

レスポンスの構文

{
   "LocationArn": "string"
}

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

LocationArn

作成した S3 の場所の ARN。

タイプ: 文字列

長さの制約: 最大長は 128 です。

パターン: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

InternalException

この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。

HTTP ステータスコード: 500

InvalidRequestException

この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。

HTTP ステータスコード: 400

以下の資料も参照してください。

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。