翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# アクション
以下のアクションがサポートされています:
+ [CancelTaskExecution](API_CancelTaskExecution.md)
+ [CreateAgent](API_CreateAgent.md)
+ [CreateLocationAzureBlob](API_CreateLocationAzureBlob.md)
+ [CreateLocationEfs](API_CreateLocationEfs.md)
+ [CreateLocationFsxLustre](API_CreateLocationFsxLustre.md)
+ [CreateLocationFsxOntap](API_CreateLocationFsxOntap.md)
+ [CreateLocationFsxOpenZfs](API_CreateLocationFsxOpenZfs.md)
+ [CreateLocationFsxWindows](API_CreateLocationFsxWindows.md)
+ [CreateLocationHdfs](API_CreateLocationHdfs.md)
+ [CreateLocationNfs](API_CreateLocationNfs.md)
+ [CreateLocationObjectStorage](API_CreateLocationObjectStorage.md)
+ [CreateLocationS3](API_CreateLocationS3.md)
+ [CreateLocationSmb](API_CreateLocationSmb.md)
+ [CreateTask](API_CreateTask.md)
+ [DeleteAgent](API_DeleteAgent.md)
+ [DeleteLocation](API_DeleteLocation.md)
+ [DeleteTask](API_DeleteTask.md)
+ [DescribeAgent](API_DescribeAgent.md)
+ [DescribeLocationAzureBlob](API_DescribeLocationAzureBlob.md)
+ [DescribeLocationEfs](API_DescribeLocationEfs.md)
+ [DescribeLocationFsxLustre](API_DescribeLocationFsxLustre.md)
+ [DescribeLocationFsxOntap](API_DescribeLocationFsxOntap.md)
+ [DescribeLocationFsxOpenZfs](API_DescribeLocationFsxOpenZfs.md)
+ [DescribeLocationFsxWindows](API_DescribeLocationFsxWindows.md)
+ [DescribeLocationHdfs](API_DescribeLocationHdfs.md)
+ [DescribeLocationNfs](API_DescribeLocationNfs.md)
+ [DescribeLocationObjectStorage](API_DescribeLocationObjectStorage.md)
+ [DescribeLocationS3](API_DescribeLocationS3.md)
+ [DescribeLocationSmb](API_DescribeLocationSmb.md)
+ [DescribeTask](API_DescribeTask.md)
+ [DescribeTaskExecution](API_DescribeTaskExecution.md)
+ [ListAgents](API_ListAgents.md)
+ [ListLocations](API_ListLocations.md)
+ [ListTagsForResource](API_ListTagsForResource.md)
+ [ListTaskExecutions](API_ListTaskExecutions.md)
+ [ListTasks](API_ListTasks.md)
+ [StartTaskExecution](API_StartTaskExecution.md)
+ [TagResource](API_TagResource.md)
+ [UntagResource](API_UntagResource.md)
+ [UpdateAgent](API_UpdateAgent.md)
+ [UpdateLocationAzureBlob](API_UpdateLocationAzureBlob.md)
+ [UpdateLocationEfs](API_UpdateLocationEfs.md)
+ [UpdateLocationFsxLustre](API_UpdateLocationFsxLustre.md)
+ [UpdateLocationFsxOntap](API_UpdateLocationFsxOntap.md)
+ [UpdateLocationFsxOpenZfs](API_UpdateLocationFsxOpenZfs.md)
+ [UpdateLocationFsxWindows](API_UpdateLocationFsxWindows.md)
+ [UpdateLocationHdfs](API_UpdateLocationHdfs.md)
+ [UpdateLocationNfs](API_UpdateLocationNfs.md)
+ [UpdateLocationObjectStorage](API_UpdateLocationObjectStorage.md)
+ [UpdateLocationS3](API_UpdateLocationS3.md)
+ [UpdateLocationSmb](API_UpdateLocationSmb.md)
+ [UpdateTask](API_UpdateTask.md)
+ [UpdateTaskExecution](API_UpdateTaskExecution.md)
# CancelTaskExecution
進行中の AWS DataSync タスク実行を停止します。一部のファイルの転送が突然中断されます。宛先に転送されるファイルの内容が不完全であるか、ソースファイルと矛盾している可能性があります。
ただし、同じタスクを使用して新しいタスクの実行を開始し、終了できるようにすると、転送先のファイルコンテンツは完全で一貫性のあるものになります。これは、タスクの実行を中断する他の予期しない障害にも当てはまります。これらのすべての場合において、次のタスク実行を開始すると、DataSync は転送を正常に完了します。
## リクエストの構文
```
{
"TaskExecutionArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [TaskExecutionArn](#API_CancelTaskExecution_RequestSyntax) **
停止するタスク実行の Amazon リソースネーム (ARN)。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$`
必須: はい
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CancelTaskExecution)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CancelTaskExecution)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CancelTaskExecution)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CancelTaskExecution)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CancelTaskExecution)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CancelTaskExecution)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CancelTaskExecution)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CancelTaskExecution)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CancelTaskExecution)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CancelTaskExecution)
# CreateAgent
ストレージ環境にデプロイする AWS DataSync エージェントをアクティブ化します。アクティベーションプロセスは、エージェントを に関連付けます AWS アカウント。
エージェントをまだデプロイしていない場合は、[「Do I need a DataSync agent?」を参照してください。](https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html)
## リクエストの構文
```
{
"ActivationKey": "string",
"AgentName": "string",
"SecurityGroupArns": [ "string" ],
"SubnetArns": [ "string" ],
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VpcEndpointId": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [ActivationKey](#API_CreateAgent_RequestSyntax) **
DataSync エージェントのアクティベーションキーを指定します。アクティベーションキーがない場合は、「[Activating your agent](https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html)」を参照してください。
タイプ: 文字列
長さの制約: 最大長は 29 です。
パターン: `[A-Z0-9]{5}(-[A-Z0-9]{5}){4}`
必須: はい
** [AgentName](#API_CreateAgent_RequestSyntax) **
エージェントの名前を指定します。覚えやすい名前を指定することをお勧めします。
タイプ: 文字列
長さの制約: 最小長は 0 です。最大長は 256 です。
パターン: `^[a-zA-Z0-9\s+=._:@/-]+$`
必須: いいえ
** [SecurityGroupArns](#API_CreateAgent_RequestSyntax) **
エージェントと VPC サービスエンドポイント間のトラフィックを許可するセキュリティグループの Amazon リソースネーム (ARN) を指定します。指定できる ARN は 1 つだけです。
タイプ: 文字列の配列
配列メンバー: 1 項目の定数です。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$`
必須: いいえ
** [SubnetArns](#API_CreateAgent_RequestSyntax) **
VPC サービスエンドポイントがあるサブネットの ARN を指定します。指定できる ARN は 1 つだけです。
タイプ: 文字列の配列
配列メンバー: 1 項目の定数です。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:subnet/subnet-[a-f0-9]+$`
必須: いいえ
** [Tags](#API_CreateAgent_RequestSyntax) **
AWS リソースの分類、フィルタリング、検索に役立つラベルを指定します。エージェントには、少なくとも 1 つのタグを作成することをお勧めします。
タイプ: [TagListEntry](API_TagListEntry.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。
必須: いいえ
** [VpcEndpointId](#API_CreateAgent_RequestSyntax) **
使用している [VPC サービスエンドポイント](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#datasync-in-vpc)の ID を指定します。たとえば、VPC エンドポイント ID は `vpce-01234d5aff67890e1` のようになります。
使用する VPC サービスエンドポイントには、DataSync サービス名 (例: `com.amazonaws.us-east-2.datasync`) が含まれている必要があります。
タイプ: 文字列
パターン: `^vpce-[0-9a-f]{17}$`
必須: いいえ
## レスポンスの構文
```
{
"AgentArn": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [AgentArn](#API_CreateAgent_ResponseSyntax) **
上記でアクティブ化したエージェントの ARN。[ListAgents](https://docs.aws.amazon.com/datasync/latest/userguide/API_ListAgents.html) オペレーションを使用して、 AWS アカウント および のエージェントのリストを返します AWS リージョン。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 例
### リクエスト例
次の例では、DataSync エージェントをアクティブ化します。
```
{
"ActivationKey": "AAAAA-1AAAA-BB1CC-33333-EEEEE",
"AgentName": "MyAgent",
"Tags": [{
"Key": "Job",
"Value": "TransferJob-1"
}]
}
```
### レスポンス例
レスポンスは、アクティブ化されたエージェントの ARN を返します。
```
{
"AgentArn": "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44baca3"
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateAgent)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateAgent)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateAgent)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateAgent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateAgent)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateAgent)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateAgent)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateAgent)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateAgent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateAgent)
# CreateLocationAzureBlob
Microsoft Azure Blob Storage コンテナの転送*場所*を作成します。この場所を転送元または転送先として AWS DataSync 使用できます。コンテナに接続する [DataSync エージェント](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-creating-agent)の有無にかかわらず、転送を行うことができます。
始める前に、必ず [DataSync がどのように Azure Blob Storage にアクセス](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access)し、[アクセス層](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers)と [BLOB タイプ](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#blob-types)で動作するかを確認しておいてください。
## リクエストの構文
```
{
"AccessTier": "string",
"AgentArns": [ "string" ],
"AuthenticationType": "string",
"BlobType": "string",
"CmkSecretConfig": {
"KmsKeyArn": "string",
"SecretArn": "string"
},
"ContainerUrl": "string",
"CustomSecretConfig": {
"SecretAccessRoleArn": "string",
"SecretArn": "string"
},
"SasConfiguration": {
"Token": "string"
},
"Subdirectory": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [AccessTier](#API_CreateLocationAzureBlob_RequestSyntax) **
オブジェクトまたはファイルの転送先となるアクセス層を指定します。これは、その場所を転送先として使用する場合にのみ適用されます。詳細については、「[アクセス層](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers)」を参照してください。
タイプ: 文字列
有効な値：`HOT | COOL | ARCHIVE`
必須：いいえ
** [AgentArns](#API_CreateLocationAzureBlob_RequestSyntax) **
(オプション) Azure Blob Storage コンテナに接続できる DataSync エージェントの Amazon リソースネーム (ARN) を指定します。エージェントレスクロスクラウド転送を設定する場合は、このパラメータの値を指定する必要はありません。
複数のエージェントを指定できます。詳細については、「[複数のエージェントを転送に使用](https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html)」を参照してください。
初めてストレージの場所を作成する際は、必ずこのパラメータを正しく設定してください。作成後にストレージの場所からエージェントを追加または削除することはできません。
型: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大 8 項目。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`
必須: いいえ
** [AuthenticationType](#API_CreateLocationAzureBlob_RequestSyntax) **
DataSync が Azure Blob Storage にアクセスするために使用する認証方法を指定します。DataSync は、共有アクセス署名 (SAS) を使用して blob storage にアクセスできます。
タイプ: 文字列
有効な値：`SAS | NONE`
必須: はい
** [BlobType](#API_CreateLocationAzureBlob_RequestSyntax) **
オブジェクトまたはファイルを Azure Blob Storage に転送するときに使用する BLOB のタイプを指定します。現在、DataSync は、ブロック blobs としての Azure Blob Storage へのデータの移動のみをサポートしています。BLOB のタイプの詳細については、「[Azure Blob Storage のドキュメント](https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs)」を参照してください。
タイプ: 文字列
有効な値：`BLOCK`
必須：いいえ
** [CmkSecretConfig](#API_CreateLocationAzureBlob_RequestSyntax) **
DataSync が管理するシークレットの設定情報を指定します。これには、DataSync がカスタマーマネージド AWS KMS keyを使用して特定の AzureBlob ストレージの場所にアクセスするために使用する認証トークンが含まれます。
このパラメータを`CreateLocationAzureBlob`リクエストの一部として含める場合は、KMS キー ARN のみを指定します。DataSync は、この KMS キーを `SasConfiguration` に指定した認証トークンとともに使用して、場所のアクセス認証情報を保存する DataSync マネージドシークレットを作成します。
DataSync に、指定した KMS キーへのアクセス許可があることを確認します。詳細については、[「カスタムで暗号化されたサービスマネージドシークレットの使用 AWS KMS key](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#service-secret-custom-key)」を参照してください。
`CmkSecretConfig` (`SasConfiguration` あり) または `CustomSecretConfig` (`SasConfiguration` なし) を使用して、`CreateLocationAzureBlob` リクエストの認証情報を指定できます。同じリクエストに対して両方のパラメータを指定しないでください。
型: [CmkSecretConfig](API_CmkSecretConfig.md) オブジェクト
必須: いいえ
** [ContainerUrl](#API_CreateLocationAzureBlob_RequestSyntax) **
転送に含まれる Azure Blob Storage コンテナの URL を指定します。
タイプ: 文字列
長さの制約: 最大長は 325 です。
パターン: `^https:\/\/[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}\/[a-z0-9](-?[a-z0-9]){2,62}$`
必須: はい
** [CustomSecretConfig](#API_CreateLocationAzureBlob_RequestSyntax) **
AzureBlob ストレージロケーションの認証トークンが Secrets Manager にプレーンテキストで保存される、カスタマー管理の Secrets Manager シークレットの設定情報を指定します。この設定には、シークレット ARN、およびシークレットへのアクセスを提供する IAM ロールの ARN が含まれます。詳細については、[「管理するシークレットの使用](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#custom-secret-custom-key)」を参照してください。
`CmkSecretConfig` (`SasConfiguration` あり) または `CustomSecretConfig` (`SasConfiguration` なし) を使用して、`CreateLocationAzureBlob` リクエストの認証情報を指定できます。同じリクエストに対して両方のパラメータを指定しないでください。
型: [CustomSecretConfig](API_CustomSecretConfig.md) オブジェクト
必須: いいえ
** [SasConfiguration](#API_CreateLocationAzureBlob_RequestSyntax) **
DataSync を Azure Blob Storage にアクセスできるようにする SAS 設定を指定します。
`SasConfiguration` を使用して認証トークンを提供するが、`CmkSecretConfig` または `CustomSecretConfig` を使用してシークレット設定の詳細を指定しない場合、DataSync は AWS アカウントの Secrets Manager シークレットを使用してトークンを保存します。
型: [AzureBlobSasConfiguration](API_AzureBlobSasConfiguration.md) オブジェクト
必須: いいえ
** [Subdirectory](#API_CreateLocationAzureBlob_RequestSyntax) **
転送をコンテナ内の仮想ディレクトリ (例: `/my/images`) に制限する場合は、パスセグメントを指定します。
タイプ: 文字列
長さの制約: 最大長は 1,024 です。
パターン: `^[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}\p{C}]*$`
必須: いいえ
** [Tags](#API_CreateLocationAzureBlob_RequestSyntax) **
AWS リソースの分類、フィルタリング、および検索に役立つラベルを指定します。少なくても転送場所の名前タグを作成することを推奨します。
タイプ: [TagListEntry](API_TagListEntry.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。
必須: いいえ
## レスポンスの構文
```
{
"LocationArn": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [LocationArn](#API_CreateLocationAzureBlob_ResponseSyntax) **
作成した Azure Blob Storage の転送場所の ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationAzureBlob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationAzureBlob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationAzureBlob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationAzureBlob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationAzureBlob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationAzureBlob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationAzureBlob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationAzureBlob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationAzureBlob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationAzureBlob)
# CreateLocationEfs
Amazon EFS ファイルシステムの転送*場所*を作成します。 AWS DataSync は、この場所をデータ転送のソースまたは転送先として使用できます。
始める前に、必ず DataSync がどのように [Amazon EFS ファイルシステムにアクセス](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-access)するのかを理解してください。
## リクエストの構文
```
{
"AccessPointArn": "string",
"Ec2Config": {
"SecurityGroupArns": [ "string" ],
"SubnetArn": "string"
},
"EfsFilesystemArn": "string",
"FileSystemAccessRoleArn": "string",
"InTransitEncryption": "string",
"Subdirectory": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [AccessPointArn](#API_CreateLocationEfs_RequestSyntax) **
DataSync が Amazon EFS ファイルシステムにアクセスするために使用するアクセスポイントの Amazon リソースネーム (ARN) を指定します。
詳細については、「[Accessing restricted file systems](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam)」を参照してください。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):elasticfilesystem:[a-z\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$`
必須: いいえ
** [Ec2Config](#API_CreateLocationEfs_RequestSyntax) **
DataSync が Amazon EFS ファイルシステムの[マウントターゲット](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html)に接続するために使用する、サブネットとセキュリティグループを指定します。
タイプ: [Ec2Config](API_Ec2Config.md) オブジェクト
必須: はい
** [EfsFilesystemArn](#API_CreateLocationEfs_RequestSyntax) **
Amazon EFS ファイルシステムの ARN を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):elasticfilesystem:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]{8,40}$`
必須: はい
** [FileSystemAccessRoleArn](#API_CreateLocationEfs_RequestSyntax) **
DataSync が Amazon EFS ファイルシステムにアクセスできるようにする AWS Identity and Access Management (IAM) ロールを指定します。
このロールの作成については、「[Creating a DataSync IAM role for file system access](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role)」を参照してください。
タイプ: 文字列
長さの制約: 最大長は 2,048 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$`
必須: いいえ
** [InTransitEncryption](#API_CreateLocationEfs_RequestSyntax) **
DataSync が Amazon EFS ファイルシステムとの間でデータを転送するときに、Transport Layer Security (TLS) 1.2 暗号化を使用するかどうかを指定します。
`AccessPointArn` または `FileSystemAccessRoleArn` を使用した IAM ロールを使用してアクセスポイントを指定する場合、このパラメータを `TLS1_2` に設定する必要があります。
タイプ: 文字列
有効な値：`NONE | TLS1_2`
必須: いいえ
** [Subdirectory](#API_CreateLocationEfs_RequestSyntax) **
Amazon EFS ファイルシステムのマウントパスを指定します。これは、DataSync がファイルシステム上のデータの読み取りまたは書き込み (送信元の場所か送信先の場所かによって異なります) を行う場所です。
デフォルトで、DataSync はルートディレクトリ (または `AccessPointArn` を使用して指定する[アクセスポイント](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html)) を使用します。フォワードスラッシュ (例: `/path/to/folder`) を使用してサブディレクトリを含めることもできます。
タイプ: 文字列
長さの制約: 最大長は 4,096 です。
パターン: `^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$`
必須: いいえ
** [Tags](#API_CreateLocationEfs_RequestSyntax) **
リソースに追加するタグを表すキーと値のペアを指定します。値は空の文字列とすることができます。この値は、リソースの管理、フィルタリング、検索に役立ちます。場所の名前タグを作成することをお勧めします。
タイプ: [TagListEntry](API_TagListEntry.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。
必須: いいえ
## レスポンスの構文
```
{
"LocationArn": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [LocationArn](#API_CreateLocationEfs_ResponseSyntax) **
作成する Amazon EFS ファイルシステムの場所の Amazon リソースネーム (ARN)。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 例
### リクエスト例
次の例では、Amazon EFS ファイルシステムの場所を作成します。
```
{
"Ec2Config": {
"SubnetArn": "arn:aws:ec2:us-east-2:11122233344:subnet/subnet-1234567890abcdef1",
"SecurityGroupArns": [
"arn:aws:ec2:us-east-2:11122233344:security-group/sg-1234567890abcdef2"
]
},
"EfsFilesystemArn": "arn:aws:elasticfilesystem:us-east-2:111222333444:file-system/fs-021345abcdef6789",
"Subdirectory": "/mount/path",
"Tags": [{
"Key": "Name",
"Value": "ElasticFileSystem-1"
}]
}
```
### リクエスト例: 制限付きの Amazon EFS ファイルシステムの場所の作成
次の例では、アクセスが制限された Amazon EFS ファイルシステムの場所を作成します。このようなシナリオでは、リクエストで `AccessPointArn`、`FileSystemAccessRoleArn`、`InTransitEncryption` の値を指定しなければならない場合があります。
```
{
"AccessPointArn": "arn:aws:elasticfilesystem:us-east-2:111222333444:access-point/fsap-1234567890abcdef0",
"Ec2Config": {
"SubnetArn": "arn:aws:ec2:us-east-2:111222333444:subnet/subnet-1234567890abcdef1",
"SecurityGroupArns": [
"arn:aws:ec2:us-east-2:111222333444:security-group/sg-1234567890abcdef2"
]
},
"FileSystemAccessRoleArn": "arn:aws:iam::111222333444:role/AwsDataSyncFullAccessNew",
"InTransitEncryption": "TLS1_2",
"LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-abcdef01234567890",
"LocationUri": "efs://us-east-2.fs-021345abcdef6789/",
"Subdirectory": "/mount/path",
"Tags": [{
"Key": "Name",
"Value": "ElasticFileSystem-1"
}]
}
```
### レスポンス例
レスポンスは、Amazon EFS ファイルシステムの場所の ARN を返します。
```
{
"LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-12abcdef012345678"
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationEfs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationEfs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationEfs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationEfs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationEfs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationEfs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationEfs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationEfs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationEfs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationEfs)
# CreateLocationFsxLustre
Amazon FSx for Lustre ファイルシステムの転送*場所*を作成します。この場所をデータ転送のソースまたは送信先として AWS DataSync 使用できます。
始める前に、必ず DataSync がどのように [FSx for Lustre ファイルシステムにアクセス](https://docs.aws.amazon.com/datasync/latest/userguide/create-lustre-location.html#create-lustre-location-access)するのかを理解してください。
## リクエストの構文
```
{
"FsxFilesystemArn": "string",
"SecurityGroupArns": [ "string" ],
"Subdirectory": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [FsxFilesystemArn](#API_CreateLocationFsxLustre_RequestSyntax) **
FSx for Lustre ファイルシステムの Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$`
必須: はい
** [SecurityGroupArns](#API_CreateLocationFsxLustre_RequestSyntax) **
FSx for Lustre ファイルシステムへのアクセスを提供するセキュリティグループ (最大 5 つ) の Amazon リソースネーム (ARN) を指定します。
セキュリティグループはファイルシステムのポートにアクセスできる必要があります。ファイルシステムはセキュリティグループからのアクセスを許可する必要もあります。ファイルシステムアクセスの詳細については、「[https://docs.aws.amazon.com/fsx/latest/LustreGuide/limit-access-security-groups.html](https://docs.aws.amazon.com/fsx/latest/LustreGuide/limit-access-security-groups.html)」を参照してください。
型: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大数は 5 項目です。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$`
必須: はい
** [Subdirectory](#API_CreateLocationFsxLustre_RequestSyntax) **
FSx for Lustre ファイルシステムのマウントパスを指定します。パスにはサブディレクトリを含めることができます。
場所が送信元として使用される場合、DataSync はマウントパスからデータを読み込みます。場所が送信先として使用される場合、DataSync はデータをマウントパスに書き込みます。このパラメータを含めない場合、DataSync はファイルシステムのルートディレクトリ (`/`) を使用します。
タイプ: 文字列
長さの制約: 最大長は 4,096 です。
パターン: `^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$`
必須: いいえ
** [Tags](#API_CreateLocationFsxLustre_RequestSyntax) **
AWS リソースの分類、フィルタリング、および検索に役立つラベルを指定します。少なくても場所の名前タグを作成することを推奨します。
タイプ: [TagListEntry](API_TagListEntry.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。
必須: いいえ
## レスポンスの構文
```
{
"LocationArn": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [LocationArn](#API_CreateLocationFsxLustre_ResponseSyntax) **
作成した FSx for Lustre ファイルシステムの場所の Amazon リソースネーム (ARN)。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationFsxLustre)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationFsxLustre)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationFsxLustre)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationFsxLustre)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationFsxLustre)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationFsxLustre)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationFsxLustre)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationFsxLustre)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationFsxLustre)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationFsxLustre)
# CreateLocationFsxOntap
Amazon FSx for NetApp ONTAP ファイルシステムの転送*場所*を作成します。この場所をデータ転送のソースまたは送信先として AWS DataSync 使用できます。
始める前に、必ず DataSync がどのように [FSx for ONTAP ファイルシステムにアクセス](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access)するのかを理解してください。
## リクエストの構文
```
{
"Protocol": {
"NFS": {
"MountOptions": {
"Version": "string"
}
},
"SMB": {
"CmkSecretConfig": {
"KmsKeyArn": "string",
"SecretArn": "string"
},
"CustomSecretConfig": {
"SecretAccessRoleArn": "string",
"SecretArn": "string"
},
"Domain": "string",
"ManagedSecretConfig": {
"SecretArn": "string"
},
"MountOptions": {
"Version": "string"
},
"Password": "string",
"User": "string"
}
},
"SecurityGroupArns": [ "string" ],
"StorageVirtualMachineArn": "string",
"Subdirectory": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [Protocol](#API_CreateLocationFsxOntap_RequestSyntax) **
AWS DataSync が Amazon FSx ファイルシステムにアクセスするために使用するデータ転送プロトコルを指定します。
型: [FsxProtocol](API_FsxProtocol.md) オブジェクト
必須: はい
** [SecurityGroupArns](#API_CreateLocationFsxOntap_RequestSyntax) **
ファイルシステムの優先サブネットへのアクセスを提供する Amazon EC2 セキュリティグループを指定します。
次のポートでアウトバウンドトラフィックを許可するようにセキュリティグループを設定する必要があります (使用しているプロトコルによって異なります)。
+ **ネットワークファイルシステム (NFS)**: TCP ポート 111、635、2049
+ **サーバーメッセージブロック (SMB)**: TCP ポート 445
ファイルシステムのセキュリティグループは、同じポートでのインバウンドトラフィックも許可する必要があります。
タイプ: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大数は 5 項目です。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$`
必須: はい
** [StorageVirtualMachineArn](#API_CreateLocationFsxOntap_RequestSyntax) **
データのコピーのやり取りをするファイルシステム上のストレージ仮想マシン (SVM) の ARN を指定します。
タイプ: 文字列
長さの制約: 最大長は 162 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:storage-virtual-machine/fs-[0-9a-f]+/svm-[0-9a-f]{17,}$`
必須: はい
** [Subdirectory](#API_CreateLocationFsxOntap_RequestSyntax) **
データ転送先またはデータ転送元の SVM 内のファイル共有へのパスを指定します。
ジャンクションパス (マウントポイントとも呼ばれます)、qtree パス (NFS ファイル共有用)、または共有名 (SMB ファイル共有用) を指定できます。例えば、マウントパスは `/vol1`、`/vol1/tree1`、または `/share1` かもしれません。
SVM のルートボリューム内にはジャンクションパスを指定しないでください。詳細については、「*Amazon FSx for NetApp ONTAP ユーザーガイド*」の「[Managing FSx for ONTAP storage virtual machines](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html)」を参照してください。
タイプ: 文字列
長さの制約: 最大長は 255 です。
パターン: `^[^\u0000\u0085\u2028\u2029\r\n]{1,255}$`
必須: いいえ
** [Tags](#API_CreateLocationFsxOntap_RequestSyntax) **
AWS リソースの分類、フィルタリング、および検索に役立つラベルを指定します。少なくても場所の名前タグを作成することを推奨します。
タイプ: [TagListEntry](API_TagListEntry.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。
必須: いいえ
## レスポンスの構文
```
{
"LocationArn": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [LocationArn](#API_CreateLocationFsxOntap_ResponseSyntax) **
作成したFSx for ONTAP ファイルシステムの場所の ARN を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationFsxOntap)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationFsxOntap)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationFsxOntap)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationFsxOntap)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationFsxOntap)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationFsxOntap)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationFsxOntap)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationFsxOntap)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationFsxOntap)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationFsxOntap)
# CreateLocationFsxOpenZfs
Amazon FSx for OpenZFS ファイルシステムの転送*場所*を作成します。この場所をデータ転送のソースまたは送信先として AWS DataSync 使用できます。
始める前に、必ず DataSync がどのように [FSx for OpenZFS ファイルシステムにアクセス](https://docs.aws.amazon.com/datasync/latest/userguide/create-openzfs-location.html#create-openzfs-access)するのかを理解してください。
**注記**
`SMB` に関連するリクエストパラメータは `CreateLocationFsxOpenZfs` オペレーションではサポートされていません。
## リクエストの構文
```
{
"FsxFilesystemArn": "string",
"Protocol": {
"NFS": {
"MountOptions": {
"Version": "string"
}
},
"SMB": {
"CmkSecretConfig": {
"KmsKeyArn": "string",
"SecretArn": "string"
},
"CustomSecretConfig": {
"SecretAccessRoleArn": "string",
"SecretArn": "string"
},
"Domain": "string",
"ManagedSecretConfig": {
"SecretArn": "string"
},
"MountOptions": {
"Version": "string"
},
"Password": "string",
"User": "string"
}
},
"SecurityGroupArns": [ "string" ],
"Subdirectory": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [FsxFilesystemArn](#API_CreateLocationFsxOpenZfs_RequestSyntax) **
FSx for OpenZFS ファイルシステムの Amazon リソースネーム (ARN)。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$`
必須: はい
** [Protocol](#API_CreateLocationFsxOpenZfs_RequestSyntax) **
AWS DataSync がファイルシステムにアクセスするために使用するプロトコルのタイプ。
型: [FsxProtocol](API_FsxProtocol.md) オブジェクト
必須: はい
** [SecurityGroupArns](#API_CreateLocationFsxOpenZfs_RequestSyntax) **
FSx for OpenZFS ファイルシステムの設定に使用するセキュリティグループの ARN。
タイプ: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大数は 5 項目です。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$`
必須: はい
** [Subdirectory](#API_CreateLocationFsxOpenZfs_RequestSyntax) **
`/fsx` で始まる必要がある場所のパス内のサブディレクトリ。DataSync は、このサブディレクトリを使用してデータを読み書きします (ファイルシステムがソースまたは送信先の場所であるかどうかに応じて)。
タイプ: 文字列
長さの制約: 最大長は 4,096 です。
パターン: `^[^\u0000\u0085\u2028\u2029\r\n]{1,4096}$`
必須: いいえ
** [Tags](#API_CreateLocationFsxOpenZfs_RequestSyntax) **
リソースに追加するタグを表すキーと値のペア。値は空の文字列とすることができます。この値は、リソースの管理、フィルタリング、検索に役立ちます。場所の名前タグを作成することをお勧めします。
タイプ: [TagListEntry](API_TagListEntry.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。
必須: いいえ
## レスポンスの構文
```
{
"LocationArn": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [LocationArn](#API_CreateLocationFsxOpenZfs_ResponseSyntax) **
作成した FSx for OpenZFS ファイルシステムの場所の ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationFsxOpenZfs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationFsxOpenZfs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationFsxOpenZfs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationFsxOpenZfs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationFsxOpenZfs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationFsxOpenZfs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationFsxOpenZfs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationFsxOpenZfs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationFsxOpenZfs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationFsxOpenZfs)
# CreateLocationFsxWindows
Amazon FSx for Windows File Server ファイルシステムの転送*場所*を作成します。この場所をデータ転送のソースまたは送信先として AWS DataSync 使用できます。
始める前に、必ず DataSync がどのように [FSx for Windows File Server ファイルシステムにアクセス](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-location-access)するのかを理解してください。
## リクエストの構文
```
{
"CmkSecretConfig": {
"KmsKeyArn": "string",
"SecretArn": "string"
},
"CustomSecretConfig": {
"SecretAccessRoleArn": "string",
"SecretArn": "string"
},
"Domain": "string",
"FsxFilesystemArn": "string",
"Password": "string",
"SecurityGroupArns": [ "string" ],
"Subdirectory": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"User": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [CmkSecretConfig](#API_CreateLocationFsxWindows_RequestSyntax) **
DataSync が管理するシークレットの設定情報を指定します。これには、DataSync がカスタマーマネージドで特定の FSx Windows ストレージの場所にアクセスするために使用するパスワードが含まれます AWS KMS key。
このパラメータを`CreateLocationFsxWindows`リクエストの一部として含める場合は、KMS キー ARN のみを指定します。DataSync は、この KMS キーを に`Password`指定した とともに使用して、ロケーションアクセス認証情報を保存する DataSync マネージドシークレットを作成します。
DataSync に、指定した KMS キーへのアクセス許可があることを確認します。詳細については、[「カスタムで暗号化されたサービスマネージドシークレットの使用 AWS KMS key](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#service-secret-custom-key)」を参照してください。
`CmkSecretConfig` (`Password` あり) または `CustomSecretConfig` (`Password` なし) を使用して、`CreateLocationFsxWindows` リクエストの認証情報を指定できます。同じリクエストに対して両方のパラメータを指定しないでください。
型: [CmkSecretConfig](API_CmkSecretConfig.md) オブジェクト
必須: いいえ
** [CustomSecretConfig](#API_CreateLocationFsxWindows_RequestSyntax) **
FSx for Windows File Server ストレージの場所のパスワードが Secrets Manager のプレーンテキストで保存される、カスタマー管理の Secrets Manager シークレットの設定情報を指定します。この設定には、シークレット ARN、およびシークレットへのアクセスを提供する IAM ロールの ARN が含まれます。詳細については、[「管理するシークレットの使用](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#custom-secret-custom-key)」を参照してください。
`CmkSecretConfig` (`Password` あり) または `CustomSecretConfig` (`Password` なし) を使用して、`CreateLocationFsxWindows` リクエストの認証情報を指定できます。同じリクエストに対して両方のパラメータを指定しないでください。
型: [CustomSecretConfig](API_CustomSecretConfig.md) オブジェクト
必須: いいえ
** [Domain](#API_CreateLocationFsxWindows_RequestSyntax) **
FSx for Windows ファイルサーバーシステムが属する Windows ドメインの名前を指定します。
環境内に複数の Active Directory ドメインがある場合、このパラメータを設定することで、DataSync が適切なファイルシステムに接続できるようになります。
タイプ: 文字列
長さの制約: 最大長は 253 です。
パターン: `^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$`
必須: いいえ
** [FsxFilesystemArn](#API_CreateLocationFsxWindows_RequestSyntax) **
FSx for Windows File Server ファイルシステムの Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$`
必須: はい
** [Password](#API_CreateLocationFsxWindows_RequestSyntax) **
FSx for Windows File Server ファイルシステム内のファイル、フォルダ、ファイルメタデータをマウントしてアクセスできるアクセス許可を持つユーザーのパスワードを指定します。
タイプ: 文字列
長さの制約: 最大長は 104 です。
パターン: `^.{0,104}$`
必須: いいえ
** [SecurityGroupArns](#API_CreateLocationFsxWindows_RequestSyntax) **
ファイルシステムの優先サブネットへのアクセスを提供する Amazon EC2 セキュリティグループの ARN を指定します。
指定したセキュリティグループは、ファイルシステムのセキュリティグループと通信できる必要があります。セキュリティグループの設定については、「[https://docs.aws.amazon.com/fsx/latest/WindowsGuide/limit-access-security-groups.html](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/limit-access-security-groups.html)」を参照してください。
内部からの接続を許可しないセキュリティグループを選択した場合は、次のいずれかの操作を行います。
+ セキュリティグループをセキュリティグループ内で通信できるように設定します。
+ マウントターゲットのセキュリティグループと通信できる、別のセキュリティグループを選択します。
タイプ: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大数は 5 項目です。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$`
必須: はい
** [Subdirectory](#API_CreateLocationFsxWindows_RequestSyntax) **
スラッシュを使用して、ファイルシステムのマウントパスを指定します。これは、DataSync がデータを読み書きする場所です (送信元あるいは送信先の場所によって異なります)。
タイプ: 文字列
長さの制約: 最大長は 4,096 です。
パターン: `^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$`
必須: いいえ
** [Tags](#API_CreateLocationFsxWindows_RequestSyntax) **
AWS リソースの分類、フィルタリング、および検索に役立つラベルを指定します。少なくても場所の名前タグを作成することを推奨します。
タイプ: [TagListEntry](API_TagListEntry.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。
必須: いいえ
** [User](#API_CreateLocationFsxWindows_RequestSyntax) **
FSx for Windows File Server ファイルシステム内のファイル、フォルダ、ファイルメタデータをマウントしてアクセスできるアクセス許可を持つユーザーを指定します。
転送に適したアクセスレベルのユーザーを選択する方法については、FSx for Windows File Server の場所に「[required permissions](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions)」を参照してください。
タイプ: 文字列
長さの制約: 最大長は 104 です。
パターン: `^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$`
必須: はい
## レスポンスの構文
```
{
"LocationArn": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [LocationArn](#API_CreateLocationFsxWindows_ResponseSyntax) **
作成した FSx for Windows File Server ファイルシステムの場所の ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationFsxWindows)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationFsxWindows)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationFsxWindows)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationFsxWindows)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationFsxWindows)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationFsxWindows)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationFsxWindows)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationFsxWindows)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationFsxWindows)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationFsxWindows)
# CreateLocationHdfs
Hadoop Distributed File System (HDFS) の転送*場所*を作成します。 AWS DataSync は、この場所をデータ転送のソースまたは送信先として使用できます。
始める前に、必ず DataSync がどのように [HDFS クラスターにアクセス](https://docs.aws.amazon.com/datasync/latest/userguide/create-hdfs-location.html#accessing-hdfs)するかを理解してください。
## リクエストの構文
```
{
"AgentArns": [ "string" ],
"AuthenticationType": "string",
"BlockSize": number,
"CmkSecretConfig": {
"KmsKeyArn": "string",
"SecretArn": "string"
},
"CustomSecretConfig": {
"SecretAccessRoleArn": "string",
"SecretArn": "string"
},
"KerberosKeytab": blob,
"KerberosKrb5Conf": blob,
"KerberosPrincipal": "string",
"KmsKeyProviderUri": "string",
"NameNodes": [
{
"Hostname": "string",
"Port": number
}
],
"QopConfiguration": {
"DataTransferProtection": "string",
"RpcProtection": "string"
},
"ReplicationFactor": number,
"SimpleUser": "string",
"Subdirectory": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [AgentArns](#API_CreateLocationHdfs_RequestSyntax) **
HDFS クラスターに接続できる DataSync エージェントの Amazon リソースネーム (ARN)。
タイプ: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大 8 項目。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`
必須: はい
** [AuthenticationType](#API_CreateLocationHdfs_RequestSyntax) **
ユーザーの ID を決定するために使用される認証のタイプ。
タイプ: 文字列
有効な値：`SIMPLE | KERBEROS`
必須: はい
** [BlockSize](#API_CreateLocationHdfs_RequestSyntax) **
HDFS クラスターに書き込むデータブロックのサイズ。ブロックサイズは 512 バイトの倍数にする必要があります。デフォルトのブロックサイズは 128 メガバイト (MiB) です。
タイプ: 整数
有効範囲: 最小値 は 1,048,576 です。最大値は 1,073,741,824 です。
必須: いいえ
** [CmkSecretConfig](#API_CreateLocationHdfs_RequestSyntax) **
DataSync が管理するシークレットの設定情報を指定します。これには、DataSync がカスタマーマネージドで特定の Hadoop Distributed File System (HDFS) ストレージの場所にアクセスするために使用する Kerberos キータブが含まれます AWS KMS key。
このパラメータを`CreateLocationHdfs`リクエストの一部として含める場合は、KMS キー ARN のみを指定します。DataSync は、この KMS キーを に`KerberosKeytab`指定した とともに使用して、ロケーションアクセス認証情報を保存する DataSync マネージドシークレットを作成します。
DataSync に、指定した KMS キーへのアクセス許可があることを確認します。詳細については、[「カスタムで暗号化されたサービスマネージドシークレットの使用 AWS KMS key](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#service-secret-custom-key)」を参照してください。
`CmkSecretConfig` (`KerberosKeytab` あり) または `CustomSecretConfig` (`KerberosKeytab` なし) を使用して、`CreateLocationHdfs` リクエストの認証情報を指定できます。同じリクエストに対して両方のパラメータを指定しないでください。
型: [CmkSecretConfig](API_CmkSecretConfig.md) オブジェクト
必須: いいえ
** [CustomSecretConfig](#API_CreateLocationHdfs_RequestSyntax) **
HDFS ストレージの場所の Kerberos キータブが Secrets Manager のバイナリに保存されている、カスタマー管理の Secrets Manager シークレットの設定情報を指定します。この設定には、シークレット ARN、およびシークレットへのアクセスを提供する IAM ロールの ARN が含まれます。詳細については、[「管理するシークレットの使用](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#custom-secret-custom-key)」を参照してください。
`CmkSecretConfig` (`KerberosKeytab` あり) または `CustomSecretConfig` (`KerberosKeytab` なし) を使用して、`CreateLocationHdfs` リクエストの認証情報を指定できます。同じリクエストに対して両方のパラメータを指定しないでください。
型: [CustomSecretConfig](API_CustomSecretConfig.md) オブジェクト
必須: いいえ
** [KerberosKeytab](#API_CreateLocationHdfs_RequestSyntax) **
定義された Kerberos プリンシパルと暗号化キー間のマッピングを含む Kerberos キーテーブル (キータブ)。ファイルのアドレスを指定して、ファイルからキータブをロードできます。
`KERBEROS` を `AuthenticationType` に指定した場合、このパラメータが必要です。
タイプ: Base64 でエンコードされたバイナリデータオブジェクト
長さの制約: 最大長は 65,536 です。
必須: いいえ
** [KerberosKrb5Conf](#API_CreateLocationHdfs_RequestSyntax) **
Kerberos 構成情報を含む `krb5.conf` ファイル。ファイルのアドレスを指定して、`krb5.conf` ファイルをロードできます。 AWS CLIを使用している場合は、base64 エンコードが実行されます。それ以外の場合は、base64 でエンコードされたテキストを指定します。
`KERBEROS` を `AuthenticationType` に指定した場合、このパラメータが必要です。
タイプ: Base64 でエンコードされたバイナリデータオブジェクト
長さの制約: 最大長は 131,072 です。
必須: いいえ
** [KerberosPrincipal](#API_CreateLocationHdfs_RequestSyntax) **
HDFS クラスター上のファイルとフォルダーへのアクセス権を持つ Kerberos プリンシパル。
`KERBEROS` を `AuthenticationType` に指定した場合、このパラメータが必要です。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 256 です。
パターン: `^.+$`
必須: いいえ
** [KmsKeyProviderUri](#API_CreateLocationHdfs_RequestSyntax) **
HDFS クラスターのキー管理サーバー (KMS) の URI。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 255 です。
パターン: `^kms:\/\/http[s]?@(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])(;(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9]))*:[0-9]{1,5}\/kms$`
必須: いいえ
** [NameNodes](#API_CreateLocationHdfs_RequestSyntax) **
HDFS 名前空間を管理する NameNode。NameNode は、ファイルやディレクトリのオープン、クローズ、名前の変更などの操作を実行します。NameNode には、データのブロックを DataNode にマップするための情報が含まれています。NameNode は 1 つのみを使用できます。
タイプ: [HdfsNameNode](API_HdfsNameNode.md) オブジェクトの配列
配列メンバー: 最小数は 1 項目です。
必須: はい
** [QopConfiguration](#API_CreateLocationHdfs_RequestSyntax) **
保護の品質 (QOP) 設定では、Hadoop 分散ファイルシステム (HDFS) クラスターで構成されたリモートプロシージャコール (RPC) とデータ転送保護の設定を指定します。`QopConfiguration` が指定されなかった場合、`RpcProtection` および `DataTransferProtection` は `PRIVACY` をデフォルトにします。`RpcProtection` または `DataTransferProtection` を設定した場合、もう一方のパラメータは同じ値を想定します。
タイプ: [QopConfiguration](API_QopConfiguration.md) オブジェクト
必須: いいえ
** [ReplicationFactor](#API_CreateLocationHdfs_RequestSyntax) **
HDFS クラスターへの書き込み時にデータをレプリケートする DataNode の数。デフォルトでは、データは 3 つの DataNode にレプリケートされます。
タイプ: 整数
有効範囲: 最小値 は 1 です。最大値は 512 です。
必須: いいえ
** [SimpleUser](#API_CreateLocationHdfs_RequestSyntax) **
ホストオペレーティングシステム上のクライアントを識別するために使用されるユーザー名。
`SIMPLE` を `AuthenticationType` に指定した場合、このパラメータが必要です。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 256 です。
パターン: `^[_.A-Za-z0-9][-_.A-Za-z0-9]*$`
必須: いいえ
** [Subdirectory](#API_CreateLocationHdfs_RequestSyntax) **
HDFS クラスター内のサブディレクトリ。このサブディレクトリは、HDFS クラスターからデータを読み取り、または HDFS クラスターにデータを書き込むために使用されます。サブディレクトリが指定されていない場合、デフォルトの `/` になります。
タイプ: 文字列
長さの制約: 最大長は 4,096 です。
パターン: `^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$`
必須: いいえ
** [Tags](#API_CreateLocationHdfs_RequestSyntax) **
場所に追加するタグを表すキーと値のペア。値は空の文字列とすることができます。タグを使用してリソースに名前を付けることをお勧めします。
タイプ: [TagListEntry](API_TagListEntry.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。
必須: いいえ
## レスポンスの構文
```
{
"LocationArn": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [LocationArn](#API_CreateLocationHdfs_ResponseSyntax) **
作成されたソース HDFS クラスターの場所の ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationHdfs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationHdfs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationHdfs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationHdfs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationHdfs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationHdfs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationHdfs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationHdfs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationHdfs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationHdfs)
# CreateLocationNfs
Network File System (NFS) ファイルサーバーの転送*場所*を作成します。この場所をデータ転送のソースまたは送信先として AWS DataSync 使用できます。
始める前に、必ず DataSync がどのように [NFS ファイルサーバーにアクセス](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs)するかを理解してください。
## リクエストの構文
```
{
"MountOptions": {
"Version": "string"
},
"OnPremConfig": {
"AgentArns": [ "string" ]
},
"ServerHostname": "string",
"Subdirectory": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [MountOptions](#API_CreateLocationNfs_RequestSyntax) **
DataSync が NFS ファイルサーバーをマウントするのに使用できるオプションを指定します。
タイプ: [NfsMountOptions](API_NfsMountOptions.md) オブジェクト
必須: いいえ
** [OnPremConfig](#API_CreateLocationNfs_RequestSyntax) **
NFS ファイルサーバーに接続する DataSync エージェントの Amazon リソースネーム (ARN) を指定します。
複数のエージェントを指定できます。詳細については、「[Using multiple DataSync agents](https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html#multiple-agents)」を参照してください。
タイプ: [OnPremConfig](API_OnPremConfig.md) オブジェクト
必須: はい
** [ServerHostname](#API_CreateLocationNfs_RequestSyntax) **
DataSync エージェントが接続する NFS ファイルサーバーの DNS 名または IP アドレス (IPv4 または IPv6) を指定します。
タイプ: 文字列
長さの制約: 最大長は 255 です。
パターン: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$`
必須: はい
** [Subdirectory](#API_CreateLocationNfs_RequestSyntax) **
DataSync がマウントする NFS ファイルサーバーのエクスポートパスを指定します。
このパス (またはパスのサブディレクトリ) は、DataSync のデータ転送先または転送元となる場所です。DataSync のエクスポートの構成については、「[NFS ファイルサーバーへのアクセス](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs)」を参照してください。
タイプ: 文字列
長さの制約: 最大長は 4,096 です。
パターン: `^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]+$`
必須: はい
** [Tags](#API_CreateLocationNfs_RequestSyntax) **
AWS リソースの分類、フィルタリング、検索に役立つラベルを指定します。少なくとも場所の名前タグを作成することを推奨します。
タイプ: [TagListEntry](API_TagListEntry.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。
必須: いいえ
## レスポンスの構文
```
{
"LocationArn": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [LocationArn](#API_CreateLocationNfs_ResponseSyntax) **
NFS ファイルサーバー用に作成した転送場所の ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 例
### 例
次の例では、NFS ファイルサーバー用の DataSync 転送場所を作成します。
#### リクエスト例
```
{
"MountOptions": {
"Version": : "NFS4_0"
},
"OnPremConfig": {
"AgentArn": [ "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs" ]
},
"ServerHostname": "MyServer@amazon.com",
"Subdirectory": "/MyFolder",
"Tags": [
{
"Key": "Name",
"Value": "FileSystem-1"
}
]
}
```
### 例
レスポンスは NFS の場所の ARN を返します。
#### レスポンス例
```
{
"LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50aa"
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationNfs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationNfs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationNfs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationNfs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationNfs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationNfs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationNfs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationNfs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationNfs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationNfs)
# CreateLocationObjectStorage
オブジェクトストレージシステムの転送*場所*を作成します。 AWS DataSync は、この場所をデータ転送のソースまたは送信先として使用できます。[DataSync エージェント](https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html#when-agent-required)の有無にかかわらず転送を行うことができます。
始める前に、DataSync がオブジェクトストレージシステムで動作するための[前提条件](https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html#create-object-location-prerequisites)を理解していることを確認してください。
## リクエストの構文
```
{
"AccessKey": "string",
"AgentArns": [ "string" ],
"BucketName": "string",
"CmkSecretConfig": {
"KmsKeyArn": "string",
"SecretArn": "string"
},
"CustomSecretConfig": {
"SecretAccessRoleArn": "string",
"SecretArn": "string"
},
"SecretKey": "string",
"ServerCertificate": blob,
"ServerHostname": "string",
"ServerPort": number,
"ServerProtocol": "string",
"Subdirectory": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [AccessKey](#API_CreateLocationObjectStorage_RequestSyntax) **
オブジェクトストレージサーバーとの認証に認証情報が必要な場合、アクセスキー (ユーザー名など) を指定します。
タイプ: 文字列
長さの制約: 最小長は 0 です。最大長は 200 です。
パターン: `^.*$`
必須: いいえ
** [AgentArns](#API_CreateLocationObjectStorage_RequestSyntax) **
(オプション) オブジェクトストレージシステムに接続できる DataSync エージェントの Amazon リソースネーム (ARN) を指定します。エージェントレスクロスクラウド転送を設定する場合は、このパラメータの値を指定する必要はありません。
初めてストレージの場所を作成する際は、必ずこのパラメータを正しく設定してください。作成後にストレージの場所からエージェントを追加または削除することはできません。
型: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大 8 項目。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`
必須: いいえ
** [BucketName](#API_CreateLocationObjectStorage_RequestSyntax) **
転送に関係するオブジェクトストレージバケットの名前を指定します。
タイプ: 文字列
長さの制約: 最小長は 3 です。最大長は 63 です。
パターン: `^[a-zA-Z0-9_\-\+\.\(\)\$\p{Zs}]+$`
必須: はい
** [CmkSecretConfig](#API_CreateLocationObjectStorage_RequestSyntax) **
DataSync が管理するシークレットの設定情報を指定します。これには、DataSync が特定のオブジェクトストレージの場所にアクセスするために使用する `SecretKey` と、カスタマー管理の AWS KMS keyが含まれます。
このパラメータを`CreateLocationObjectStorage`リクエストの一部として含める場合は、KMS キー ARN のみを指定します。DataSync は、`SecretKey` パラメータに指定された値とともにこの KMS キーを使用して、DataSync が管理するシークレットを作成し、場所にアクセスするための認証情報を保存します。
DataSync に、指定した KMS キーへのアクセス許可があることを確認します。詳細については、[「カスタムで暗号化されたサービスマネージドシークレットの使用 AWS KMS key](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#service-secret-custom-key)」を参照してください。
`CmkSecretConfig` (`SecretKey` あり) または `CustomSecretConfig` (`SecretKey` なし) を使用して、`CreateLocationObjectStorage` リクエストの認証情報を指定できます。同じリクエストに対して両方のパラメータを指定しないでください。
型: [CmkSecretConfig](API_CmkSecretConfig.md) オブジェクト
必須: いいえ
** [CustomSecretConfig](#API_CreateLocationObjectStorage_RequestSyntax) **
特定のオブジェクトストレージの場所のシークレットキーが Secrets Manager のプレーンテキストで保存される、カスタマー管理の Secrets Manager シークレットの設定情報を指定します。この設定には、シークレット ARN、およびシークレットへのアクセスを提供する IAM ロールの ARN が含まれます。詳細については、[「管理するシークレットの使用](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#custom-secret-custom-key)」を参照してください。
`CmkSecretConfig` (`SecretKey` あり) または `CustomSecretConfig` (`SecretKey` なし) を使用して、`CreateLocationObjectStorage` リクエストの認証情報を指定できます。同じリクエストに対して両方のパラメータを指定しないでください。
型: [CustomSecretConfig](API_CustomSecretConfig.md) オブジェクト
必須: いいえ
** [SecretKey](#API_CreateLocationObjectStorage_RequestSyntax) **
オブジェクトストレージサーバーとの認証に認証情報が必要な場合、秘密鍵 (パスワードなど) を指定します。
を使用してシークレットを指定し`SecretKey`、 `CmkSecretConfig`または を使用してシークレット設定の詳細を指定しない場合`CustomSecretConfig`、DataSync は AWS アカウントの Secrets Manager シークレットを使用してトークンを保存します。
タイプ: 文字列
長さの制約: 最小長は 0 です。最大長は 200 です。
パターン: `^.*$`
必須: いいえ
** [ServerCertificate](#API_CreateLocationObjectStorage_RequestSyntax) **
オブジェクトストレージシステムがプライベートまたは自己署名の認証機関 (CA) を使用する場合、DataSync がそのシステムで認証するための証明書チェーンを指定します。完全な証明書チェーンを持つ `.pem` ファイルを 1 つ指定する必要があります (例: `file:///home/user/.ssh/object_storage_certificates.pem`)。
証明書チェーンには以下が含まれます。
+ オブジェクトストレージシステムの証明書
+ すべての中間証明書 (存在する場合)
+ 署名 CA のルート証明書
証明書を `.pem` ファイルに連結できます (base64 エンコーディングの前は最大 32,768 バイトまで可能)。次の `cat` コマンド例では、3 つの証明書を含む `object_storage_certificates.pem` ファイルを作成します。
`cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem`
このパラメータを使用するには、`ServerProtocol` を `HTTPS` に構成します。
タイプ: Base64 でエンコードされたバイナリデータオブジェクト
長さの制約: 最大長は 32,768 です。
必須: いいえ
** [ServerHostname](#API_CreateLocationObjectStorage_RequestSyntax) **
DataSync エージェントが接続するオブジェクトストレージサーバーのドメイン名または IP アドレス (IPv4 または IPv6) を指定します。
タイプ: 文字列
長さの制約: 最大長は 255 です。
パターン: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$`
必須: はい
** [ServerPort](#API_CreateLocationObjectStorage_RequestSyntax) **
オブジェクトストレージサーバーがインバウンドネットワークトラフィックを受け入れるポート (ポート 443 など) を指定します。
タイプ: 整数
有効範囲: 最小値 は 1 です。最大値は 65,536 です。
必須: いいえ
** [ServerProtocol](#API_CreateLocationObjectStorage_RequestSyntax) **
オブジェクトストレージサーバーが通信に使用するプロトコルを指定します。指定されなかった場合、デフォルト値は `HTTPS` です。
型: 文字列
有効な値：`HTTPS | HTTP`
必須: いいえ
** [Subdirectory](#API_CreateLocationObjectStorage_RequestSyntax) **
オブジェクトストレージサーバーのオブジェクトプレフィックスを指定します。これがソースの場所である場合、DataSync はこのプレフィックスを持つオブジェクトのみをコピーします。これが送信先の場所である場合、DataSync は、このプレフィックスを持つすべてのオブジェクトを書き込みます。
タイプ: 文字列
長さの制約: 最大長は 4,096 です。
パターン: `^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$`
必須: いいえ
** [Tags](#API_CreateLocationObjectStorage_RequestSyntax) **
リソースに追加するタグを表すキーと値のペアを指定します。タグは、リソースの管理、フィルタリング、検索に役立ちます。場所の名前タグを作成することを推奨します。
タイプ: [TagListEntry](API_TagListEntry.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。
必須: いいえ
## レスポンスの構文
```
{
"LocationArn": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [LocationArn](#API_CreateLocationObjectStorage_ResponseSyntax) **
作成するオブジェクトストレージシステムの場所の ARN を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationObjectStorage)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationObjectStorage)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationObjectStorage)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationObjectStorage)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationObjectStorage)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationObjectStorage)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationObjectStorage)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationObjectStorage)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationObjectStorage)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationObjectStorage)
# CreateLocationS3
Amazon S3 バケットの転送*場所*を作成します。 AWS DataSync は、この場所をデータ転送のソースまたは転送先として使用できます。
**重要**
始める前に、次のトピックをお読みください。
[Amazon S3 場所のストレージクラスに関する考慮事項](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes)
[DataSync を使用する場合の S3 リクエストコストの評価](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests)
詳細については、「[Configuring transfers with Amazon S3](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html)」を参照してください。
## リクエストの構文
```
{
"AgentArns": [ "string" ],
"S3BucketArn": "string",
"S3Config": {
"BucketAccessRoleArn": "string"
},
"S3StorageClass": "string",
"Subdirectory": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [AgentArns](#API_CreateLocationS3_RequestSyntax) **
(Amazon S3 on Outposts のみ) Outpost 上の DataSync エージェントの Amazon リソースネーム (ARN) を指定します。
詳細については、[DataSync エージェントをデプロイする AWS Outposts](https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent)」を参照してください。
型: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大 8 項目。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`
必須: いいえ
** [S3BucketArn](#API_CreateLocationS3_RequestSyntax) **
場所として使用する S3 バケットの ARN を指定します。(後で DataSync タスクを作成するときは、この場所がソースの場所か転送先かを指定します)。
S3 バケットが AWS Outposts リソースにある場合は、Amazon S3 アクセスポイントを指定する必要があります。詳細については、「*Amazon S3 ユーザーガイド*」の「[Amazon S3 Access Points を使用したデータアクセスの管理](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html)」を参照してください。
タイプ: 文字列
長さの制約: 最大長は 268 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|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-eusc|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-eusc|aws-iso|aws-iso-b):s3:::[a-zA-Z0-9.\-_]{1,255}$`
必須: はい
** [S3Config](#API_CreateLocationS3_RequestSyntax) **
DataSync が S3 バケットにアクセスするために使用する AWS Identity and Access Management (IAM) ロールの Amazon リソースネーム (ARN) を指定します。
詳細については、「[Providing DataSync access to S3 buckets](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access)」を参照してください。
型: [S3Config](API_S3Config.md) オブジェクト
必須: はい
** [S3StorageClass](#API_CreateLocationS3_RequestSyntax) **
Amazon S3 が転送先である場合にオブジェクトで使用するストレージクラスを指定します。
のバケットの場合 AWS リージョン、ストレージクラスはデフォルトで になります`STANDARD`。上のバケットの場合 AWS Outposts、ストレージクラスはデフォルトで になります`OUTPOSTS`。
詳細については、「[Storage class considerations with Amazon S3 transfers](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes)」を参照してください。
タイプ: 文字列
有効な値：`STANDARD | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_INSTANT_RETRIEVAL`
必須: いいえ
** [Subdirectory](#API_CreateLocationS3_RequestSyntax) **
DataSync が読み書きする S3 バケットのプレフィックスを指定します (バケットがソースまたは送信先の場所であるかどうかに応じて)。
DataSync は、スラッシュ (`/`) で始まるプレフィックス、または `//`、`/./`、または `/../` パターンを含むプレフィックスを持つオブジェクトを転送できません。例えば、次のようになります。
+ `/photos`
+ `photos//2006/January`
+ `photos/./2006/February`
+ `photos/../2006/March`
タイプ: 文字列
長さの制約: 最大長は 4,096 です。
パターン: `^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$`
必須: いいえ
** [Tags](#API_CreateLocationS3_RequestSyntax) **
AWS リソースの分類、フィルタリング、検索に役立つラベルを指定します。少なくても転送場所の名前タグを作成することを推奨します。
タイプ: [TagListEntry](API_TagListEntry.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。
必須: いいえ
## レスポンスの構文
```
{
"LocationArn": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [LocationArn](#API_CreateLocationS3_ResponseSyntax) **
作成した S3 の場所の ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationS3)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationS3)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationS3)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationS3)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationS3)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationS3)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationS3)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationS3)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationS3)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationS3)
# CreateLocationSmb
サーバーメッセージブロック (SMB) ファイルサーバーの転送*場所*を作成します。 AWS DataSync は、この場所をデータ転送のソースまたは送信先として使用できます。
始める前に、必ず DataSync がどのように SMB ファイルサーバーにアクセスするかを理解してください。詳細については、「[Providing DataSync access to SMB file servers](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)」を参照してください。
## リクエストの構文
```
{
"AgentArns": [ "string" ],
"AuthenticationType": "string",
"CmkSecretConfig": {
"KmsKeyArn": "string",
"SecretArn": "string"
},
"CustomSecretConfig": {
"SecretAccessRoleArn": "string",
"SecretArn": "string"
},
"DnsIpAddresses": [ "string" ],
"Domain": "string",
"KerberosKeytab": blob,
"KerberosKrb5Conf": blob,
"KerberosPrincipal": "string",
"MountOptions": {
"Version": "string"
},
"Password": "string",
"ServerHostname": "string",
"Subdirectory": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"User": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [AgentArns](#API_CreateLocationSmb_RequestSyntax) **
SMB ファイルサーバーに接続可能な DataSync エージェント (1 つまたは複数) を指定します。エージェントは、Amazon リソースネーム (ARN) を使用して指定します。
タイプ: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大 8 項目。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`
必須: はい
** [AuthenticationType](#API_CreateLocationSmb_RequestSyntax) **
DataSync が SMB ファイルサーバーへの接続に使用する認証プロトコルを指定します。DataSync は `NTLM` (デフォルト) と `KERBEROS` 認証をサポートしています。
詳細については、「[Providing DataSync access to SMB file servers](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)」を参照してください。
型: 文字列
有効な値：`NTLM | KERBEROS`
必須：いいえ
** [CmkSecretConfig](#API_CreateLocationSmb_RequestSyntax) **
DataSync が管理するシークレットの設定情報を指定します`KerberosKeytab`。DataSync がカスタマー管理の特定の SMB ストレージの場所にアクセスするために使用する `Password`または `NTLM` (デフォルト) および`KERBEROS`認証タイプのいずれかです AWS KMS key。
このパラメータを`CreateLocationSmbRequest`リクエストの一部として含める場合は、KMS キー ARN のみを指定します。DataSync は、この KMS キーを `Password`または `KerberosKeytab` のいずれかとともに使用して、ロケーションアクセス認証情報を保存する DataSync マネージドシークレットを作成します。
DataSync に、指定した KMS キーへのアクセス許可があることを確認します。詳細については、[「カスタムで暗号化されたサービスマネージドシークレットの使用 AWS KMS key](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#service-secret-custom-key)」を参照してください。
( `Password`または のいずれか`CmkSecretConfig`を使用`KerberosKeytab`) または `CustomSecretConfig` ( `Password`および なし`KerberosKeytab`) を使用して、`CreateLocationSmbRequest`リクエストの認証情報を指定できます。同じリクエストに パラメータ`CmkSecretConfig`と `CustomSecretConfig`パラメータの両方を指定しないでください。
型: [CmkSecretConfig](API_CmkSecretConfig.md) オブジェクト
必須: いいえ
** [CustomSecretConfig](#API_CreateLocationSmb_RequestSyntax) **
SMB ストレージの場所の認証情報が Secrets Manager にプレーンテキスト ( の場合`Password`) またはバイナリ ( の場合) として保存される、カスタマー管理の Secrets Manager シークレットの設定情報を指定します`KerberosKeytab`。この設定には、シークレット ARN、およびシークレットへのアクセスを提供する IAM ロールの ARN が含まれます。詳細については、[「管理するシークレットの使用](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#custom-secret-custom-key)」を参照してください。
`CmkSecretConfig` (`SasConfiguration` あり) または `CustomSecretConfig` (`SasConfiguration` なし) を使用して、`CreateLocationSmbRequest` リクエストの認証情報を指定できます。同じリクエストに対して両方のパラメータを指定しないでください。
型: [CustomSecretConfig](API_CustomSecretConfig.md) オブジェクト
必須: いいえ
** [DnsIpAddresses](#API_CreateLocationSmb_RequestSyntax) **
SMB ファイルサーバーが属する DNS サーバーの IPv4 または IPv6 アドレスを指定します。このパラメータは、`AuthenticationType` が `KERBEROS` に設定されている場合にのみ適用されます。
環境内に複数のドメインがある場合、このパラメータを構成することで、DataSync が適切な SMB ファイルサーバーに接続できるようになります。
型: 文字列の配列
配列メンバー: 最大数は 2 項目です。
長さの制限: 最小長は 7 です。最大長は 39 です。
パターン: `\A((25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6}))\z`
必須: いいえ
** [Domain](#API_CreateLocationSmb_RequestSyntax) **
SMB ファイルサーバーが属する Windows ドメイン名を指定します。このパラメータは、`AuthenticationType` が `NTLM` に設定されている場合にのみ適用されます。
環境内に複数のドメインがある場合、このパラメータを構成することで、DataSync が適切なファイルサーバーに接続できるようになります。
タイプ: 文字列
長さの制約: 最大長は 253 です。
パターン: `^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$`
必須: いいえ
** [KerberosKeytab](#API_CreateLocationSmb_RequestSyntax) **
Kerberos キーテーブル (keytab) ファイルを指定します。これには、Kerberos プリンシパルと暗号化キー間のマッピングが含まれます。
タスク実行エラーを回避するには、キータブファイルの作成に使用する Kerberos プリンシパルが、`KerberosPrincipal` に指定した内容と正確に一致していることを確認します。
タイプ: Base64 でエンコードされたバイナリデータオブジェクト
長さの制約: 最大長は 65,536 です。
必須: いいえ
** [KerberosKrb5Conf](#API_CreateLocationSmb_RequestSyntax) **
Kerberos 領域設定を定義する Kerberos 設定ファイル (`krb5.conf`) を指定します。
ファイルは base64 でエンコードされている必要があります。を使用している場合は AWS CLI、エンコードが自動的に行われます。
タイプ: Base64 でエンコードされたバイナリデータオブジェクト
長さの制約: 最大長は 131,072 です。
必須: いいえ
** [KerberosPrincipal](#API_CreateLocationSmb_RequestSyntax) **
Kerberos プリンシパルを指定します。これは、SMB ファイルサーバーのファイル、フォルダ、ファイルメタデータにアクセスする権限を持つ Kerberos 領域内の ID です。
Kerberos プリンシパルは `HOST/kerberosuser@MYDOMAIN.ORG` のようになります。
プリンシパル名では大文字と小文字が区別されます。このパラメータに指定したプリンシパルが、キータブファイルの作成に使用するプリンシパルと完全に一致しない場合、DataSync タスク実行は失敗します。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 256 です。
パターン: `^.+$`
必須: いいえ
** [MountOptions](#API_CreateLocationSmb_RequestSyntax) **
DataSync が SMB ファイルサーバーにアクセスするために使用する SMB プロトコルのバージョンを指定します。
タイプ: [SmbMountOptions](API_SmbMountOptions.md) オブジェクト
必須: いいえ
** [Password](#API_CreateLocationSmb_RequestSyntax) **
SMB ファイルサーバーをマウントでき、転送するファイルとフォルダにアクセスできるユーザーのパスワード。このパラメータは、`AuthenticationType` が `NTLM` に設定されている場合にのみ適用されます。
タイプ: 文字列
長さの制約: 最大長は 104 です。
パターン: `^.{0,104}$`
必須: いいえ
** [ServerHostname](#API_CreateLocationSmb_RequestSyntax) **
DataSync エージェントが接続する SMB ファイルサーバーのドメイン名または IP アドレス (IPv4 または IPv6) を指定します。
Kerberos 認証を使用している場合は、ドメイン名を指定する必要があります。
タイプ: 文字列
長さの制約: 最大長は 255 です。
パターン: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$`
必須: はい
** [Subdirectory](#API_CreateLocationSmb_RequestSyntax) **
DataSync がデータを読み書記する SMB ファイルサーバーによってエクスポートされる共有の名前を指定します。共有パスにはサブディレクトリ (例: `/path/to/subdirectory`) を含めることができます。ネットワーク内の他の SMB クライアントもこのパスをマウントできることを確認してください。
サブディレクトリ内のすべてのデータをコピーするには、DataSync が SMB 共有をマウントし、そのすべてのデータにアクセスできる必要があります。詳細については、「[Providing DataSync access to SMB file servers](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)」を参照してください。
タイプ: 文字列
長さの制約: 最大長は 4,096 です。
パターン: `^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$`
必須: はい
** [Tags](#API_CreateLocationSmb_RequestSyntax) **
AWS リソースの分類、フィルタリング、および検索に役立つラベルを指定します。少なくても場所の名前タグを作成することを推奨します。
タイプ: [TagListEntry](API_TagListEntry.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。
必須: いいえ
** [User](#API_CreateLocationSmb_RequestSyntax) **
SMB ファイルサーバー内のファイル、フォルダ、ファイルメタデータをマウントしてアクセスできるユーザーを指定します。このパラメータは、`AuthenticationType` が `NTLM` に設定されている場合にのみ適用されます。
転送に適したアクセスレベルを持つユーザーを選択する方法については、「[Providing DataSync access to SMB file servers](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)」を参照してください。
タイプ: 文字列
長さの制約: 最大長は 104 です。
パターン: `^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$`
必須: いいえ
## レスポンスの構文
```
{
"LocationArn": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [LocationArn](#API_CreateLocationSmb_ResponseSyntax) **
作成した SMB の場所の ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 例
### リクエスト例
次の例では、SMB ファイルサーバーの場所を作成します。
```
{
"AgentArns":[
"arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs",
"arn:aws:datasync:us-east-2:111222333444:agent/agent-2345noo35nnee1123ovo3"
],
"Domain":"AMAZON",
"MountOptions":{
"Version":"SMB3"
},
"Password":"string",
"ServerHostname":"MyServer.amazon.com",
"Subdirectory":"share",
"Tags":[
{
"Key":"department",
"Value":"finance"
}
],
"User":"user-1"
}
```
### レスポンス例
レスポンスが、SMB ファイルサーバーの場所 ARN を返します。
```
{
"LocationArn": "arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49"
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationSmb)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationSmb)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationSmb)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationSmb)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationSmb)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationSmb)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationSmb)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationSmb)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationSmb)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationSmb)
# CreateTask
AWS DataSync がデータを転送する場所と方法を定義する*タスク*を設定します。
タスクには、ソースの場所、転送先の場所、およびデータを転送する方法 (帯域幅制限、スケジュールなど) が含まれます。
**重要**
Amazon S3 ロケーションとの間でデータを転送する予定がある場合は、開始する前に [DataSync が S3 リクエスト料金にどのような影響を与えるか](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests)について、および [DataSync 料金ページ](https://aws.amazon.com/datasync/pricing/)を確認してください。
## リクエストの構文
```
{
"CloudWatchLogGroupArn": "string",
"DestinationLocationArn": "string",
"Excludes": [
{
"FilterType": "string",
"Value": "string"
}
],
"Includes": [
{
"FilterType": "string",
"Value": "string"
}
],
"ManifestConfig": {
"Action": "string",
"Format": "string",
"Source": {
"S3": {
"BucketAccessRoleArn": "string",
"ManifestObjectPath": "string",
"ManifestObjectVersionId": "string",
"S3BucketArn": "string"
}
}
},
"Name": "string",
"Options": {
"Atime": "string",
"BytesPerSecond": number,
"Gid": "string",
"LogLevel": "string",
"Mtime": "string",
"ObjectTags": "string",
"OverwriteMode": "string",
"PosixPermissions": "string",
"PreserveDeletedFiles": "string",
"PreserveDevices": "string",
"SecurityDescriptorCopyFlags": "string",
"TaskQueueing": "string",
"TransferMode": "string",
"Uid": "string",
"VerifyMode": "string"
},
"Schedule": {
"ScheduleExpression": "string",
"Status": "string"
},
"SourceLocationArn": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"TaskMode": "string",
"TaskReportConfig": {
"Destination": {
"S3": {
"BucketAccessRoleArn": "string",
"S3BucketArn": "string",
"Subdirectory": "string"
}
},
"ObjectVersionIds": "string",
"OutputType": "string",
"Overrides": {
"Deleted": {
"ReportLevel": "string"
},
"Skipped": {
"ReportLevel": "string"
},
"Transferred": {
"ReportLevel": "string"
},
"Verified": {
"ReportLevel": "string"
}
},
"ReportLevel": "string"
}
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [CloudWatchLogGroupArn](#API_CreateTask_RequestSyntax) **
タスクをモニタリングするための Amazon CloudWatch ロググループの Amazon リソースネーム (ARN) を指定します。
拡張モードタスクの場合、何も指定する必要はありません。DataSync は、`/aws/datasync` という名前の CloudWatch ロググループにログを自動的に送信します。
詳細については、「[Monitoring data transfers with Amazon CloudWatch Logs](https://docs.aws.amazon.com/datasync/latest/userguide/configure-logging.html)」を参照してください。
タイプ: 文字列
長さの制約: 最大長は 562 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$`
必須: いいえ
** [DestinationLocationArn](#API_CreateTask_RequestSyntax) **
転送時の場所の ARN を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
** [Excludes](#API_CreateTask_RequestSyntax) **
DataSync に転送してほしくないソースの場所内のファイル、オブジェクト、フォルダを定義する除外フィルターを指定します。詳細と例については、「[Specifying what DataSync transfers by using filters](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)」を参照してください。
タイプ: [FilterRule](API_FilterRule.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。
必須: いいえ
** [Includes](#API_CreateTask_RequestSyntax) **
包含フィルターを指定して、DataSync が転送するソースの場所内のファイル、オブジェクト、フォルダを定義します。詳細と例については、「[Specifying what DataSync transfers by using filters](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)」を参照してください。
タイプ: [FilterRule](API_FilterRule.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。
必須: いいえ
** [ManifestConfig](#API_CreateTask_RequestSyntax) **
DataSync が転送するファイルまたはオブジェクトのリストであるマニフェストを設定します。詳細と設定例については、「[Specifying what DataSync transfers by using a manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html)」を参照してください。
このパラメータを使用する場合、発信者 ID (DataSync を使用しているロール) には `iam:PassRole` アクセス許可が必要です。[AWSDataSyncFullAccess](https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess) ポリシーには、このアクセス許可が含まれています。
タイプ: [ManifestConfig](API_ManifestConfig.md) オブジェクト
必須: いいえ
** [Name](#API_CreateTask_RequestSyntax) **
タスクの名前を指定します。
タイプ: 文字列
長さの制約: 最小長は 0 です。最大長は 256 です。
パターン: `^[a-zA-Z0-9\s+=._:@/-]+$`
必須: いいえ
** [Options](#API_CreateTask_RequestSyntax) **
ファイルメタデータの保存、データ整合性の検証など、タスクの設定を指定します。
タイプ: [Options](API_Options.md) オブジェクト
必須: いいえ
** [Schedule](#API_CreateTask_RequestSyntax) **
タスクを実行するスケジュールを指定します。詳細については、「[タスクのスケジュール](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html)」を参照してください。
タイプ: [TaskSchedule](API_TaskSchedule.md) オブジェクト
必須: いいえ
** [SourceLocationArn](#API_CreateTask_RequestSyntax) **
転送時のソースの場所の ARN を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
** [Tags](#API_CreateTask_RequestSyntax) **
タスクに適用するタグを指定します。
*タグ*は、DataSync リソースの管理、フィルタリング、検索に役立つキーバリューペアです。
タイプ: [TagListEntry](API_TagListEntry.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。
必須: いいえ
** [TaskMode](#API_CreateTask_RequestSyntax) **
データ転送用に次のいずれかのタスクモードを指定します。
+ `ENHANCED` - 基本モードよりも高いパフォーマンスでオブジェクトを事実上無制限に転送します。拡張モードタスクは、データの一覧表示、準備、転送、検証を並行して行うことで、データ転送プロセスを最適化します。拡張モードは現在、Amazon S3 ロケーション間の転送、エージェントなしでの Azure Blob と Amazon S3 間の転送、エージェントなしでの他のクラウドと Amazon S3 間の転送に使用できます。
**注記**
拡張モードタスクを作成するには、`CreateTask` オペレーションの呼び出しに使用する IAM ロールに `iam:CreateServiceLinkedRole` アクセス許可が必要です。
+ `BASIC` (デフォルト) - AWS ストレージと他のサポートされているすべての DataSync ロケーション間でファイルまたはオブジェクトを転送します。基本モードタスクは、データセット内のファイル、オブジェクト、ディレクトリの数に対する[クォータ](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-limits.html)の対象となります。基本モードはデータの準備、転送、検証を順に実行するため、ほとんどのワークロードで拡張モードよりも速度は遅くなります。
詳細については、[「Understanding task mode differences](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html#task-mode-differences)」を参照してください。
型: 文字列
有効な値：`BASIC | ENHANCED`
必須：いいえ
** [TaskReportConfig](#API_CreateTask_RequestSyntax) **
DataSync 転送に関する詳細情報を提供するタスクレポートの設定方法を指定します。詳細については、「[Monitoring your DataSync transfers with task reports](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html)」を参照してください。
このパラメータを使用する場合、発信者 ID (DataSync を使用しているロール) には `iam:PassRole` アクセス許可が必要です。[AWSDataSyncFullAccess](https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess) ポリシーには、このアクセス許可が含まれています。
タイプ: [TaskReportConfig](API_TaskReportConfig.md) オブジェクト
必須: いいえ
## レスポンスの構文
```
{
"TaskArn": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [TaskArn](#API_CreateTask_ResponseSyntax) **
タスクの Amazon リソースネーム (ARN)。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:task/task-[0-9a-f]{17}$`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 例
### 拡張モードタスクのリクエスト例
次の例では、拡張モードを使用する DataSync タスクを作成します。
基本モードタスクを作成する場合とは異なり、Amazon CloudWatch ロググループを指定する必要はありません。拡張モードタスクでは、DataSync はタスクログを `/aws/datasync` という名前のロググループに自動的に送信します。そのロググループが に存在しない場合 AWS リージョン、DataSync はタスクの作成時にユーザーに代わってロググループを作成します。
```
{
"SourceLocationArn": "arn:aws:datasync:us-east-1:111222333444:location/1111aaaa2222bbbb3",
"DestinationLocationArn": "arn:aws:datasync:us-east-1:111222333444:location/0000zzzz1111yyyy2",
"Name": "My Enhanced mode task",
"TaskMode": "ENHANCED",
"Options": {
"TransferMode": "CHANGED",
"VerifyMode": "ONLY_FILES_TRANSFERRED",
"ObjectTags": "PRESERVE",
"LogLevel": "TRANSFER"
}
}
```
### 基本モードタスクのリクエスト例
次の例では、基本モードを使用する DataSync タスクを作成します。
```
{
"SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-1111aaaa2222bbbb3",
"DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-0000zzzz1111yyyy2",
"Name": "My Basic mode task",
"TaskMode": "BASIC",
"Options": {
"Atime": "BEST_EFFORT",
"Gid": "NONE",
"Mtime": "PRESERVE",
"PosixPermissions": "PRESERVE",
"PreserveDevices": "NONE",
"PreserveDeletedFiles": "PRESERVE",
"Uid": "NONE",
"VerifyMode": "ONLY_FILES_TRANSFERRED"
},
"Schedule": {
"ScheduleExpression": "0 12 ? * SUN,WED *"
},
"CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group:/log-group-name:*",
"Tags": [
{
"Key": "Name",
"Value": "Migration-wave-1"
}
]
}
```
### レスポンス例
次のレスポンスには、作成されたタスクの ARN が含まれます。
```
{
"TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026"
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateTask)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateTask)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateTask)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateTask)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateTask)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateTask)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateTask)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateTask)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateTask)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateTask)
# DeleteAgent
から AWS DataSync エージェントリソースを削除します AWS アカウント。
この操作 (元に戻すことはできませんでは、エージェントの仮想マシン (VM) や Amazon EC2 インスタンスはストレージ環境から削除されないことに注意してください。次のステップでは、VM またはインスタンスをストレージ環境から削除するか、再利用して[新しいエージェントを有効化できます](https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html)。
## リクエストの構文
```
{
"AgentArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [AgentArn](#API_DeleteAgent_RequestSyntax) **
削除するエージェントの Amazon リソースネーム (ARN)。`ListAgents` オペレーションを使用して、アカウントのエージェントと のリストを返します AWS リージョン。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`
必須: はい
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DeleteAgent)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DeleteAgent)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DeleteAgent)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DeleteAgent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DeleteAgent)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DeleteAgent)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DeleteAgent)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DeleteAgent)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DeleteAgent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DeleteAgent)
# DeleteLocation
転送場所リソースを削除します AWS DataSync。
## リクエストの構文
```
{
"LocationArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [LocationArn](#API_DeleteLocation_RequestSyntax) **
削除する場所の Amazon リソースネーム (ARN)。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DeleteLocation)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DeleteLocation)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DeleteLocation)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DeleteLocation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DeleteLocation)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DeleteLocation)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DeleteLocation)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DeleteLocation)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DeleteLocation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DeleteLocation)
# DeleteTask
転送タスクリソースを削除します AWS DataSync。
## リクエストの構文
```
{
"TaskArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [TaskArn](#API_DeleteTask_RequestSyntax) **
削除するタスクの Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:task/task-[0-9a-f]{17}$`
必須: はい
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DeleteTask)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DeleteTask)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DeleteTask)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DeleteTask)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DeleteTask)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DeleteTask)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DeleteTask)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DeleteTask)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DeleteTask)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DeleteTask)
# DescribeAgent
エージェントの名前、サービスエンドポイントタイプ、ステータスなど、 AWS DataSync エージェントに関する情報を返します。
## リクエストの構文
```
{
"AgentArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [AgentArn](#API_DescribeAgent_RequestSyntax) **
情報を取得する DataSync エージェントの Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`
必須: はい
## レスポンスの構文
```
{
"AgentArn": "string",
"CreationTime": number,
"EndpointType": "string",
"LastConnectionTime": number,
"Name": "string",
"Platform": {
"Version": "string"
},
"PrivateLinkConfig": {
"PrivateLinkEndpoint": "string",
"SecurityGroupArns": [ "string" ],
"SubnetArns": [ "string" ],
"VpcEndpointId": "string"
},
"Status": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [AgentArn](#API_DescribeAgent_ResponseSyntax) **
エージェントの ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`
** [CreationTime](#API_DescribeAgent_ResponseSyntax) **
エージェントが[アクティブ化](https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html)された時刻。
タイプ: タイムスタンプ
** [EndpointType](#API_DescribeAgent_ResponseSyntax) **
エージェントが接続されている[サービスエンドポイント](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html)のタイプ。
タイプ: 文字列
有効な値：`PUBLIC | PRIVATE_LINK | FIPS | FIPS_PRIVATE_LINK`
** [LastConnectionTime](#API_DescribeAgent_ResponseSyntax) **
エージェントが最後に DataSync サービスと通信した時刻。
タイプ: タイムスタンプ
** [Name](#API_DescribeAgent_ResponseSyntax) **
エージェントの名前。
タイプ: 文字列
長さの制約: 最小長は 0 です。最大長は 256 です。
パターン: `^[a-zA-Z0-9\s+=._:@/-]+$`
** [Platform](#API_DescribeAgent_ResponseSyntax) **
バージョン番号など、エージェントに関するプラットフォーム関連の詳細。
タイプ: [Platform](API_Platform.md) オブジェクト
** [PrivateLinkConfig](#API_DescribeAgent_ResponseSyntax) **
[VPC サービスエンドポイント](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc)に接続するときにエージェントが使用するネットワーク設定。
タイプ: [PrivateLinkConfig](API_PrivateLinkConfig.md) オブジェクト
** [Status](#API_DescribeAgent_ResponseSyntax) **
エージェントのステータス。
+ ステータスが `ONLINE` の場合、エージェントは適切に構成されており、使用可能です。
+ ステータスが `OFFLINE` の場合、エージェントは DataSync と 5 分以上通信していません。これは、いくつかの理由で発生する可能性があります。詳細については、「[エージェントがオフラインの場合の対処方法](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline)」を参照してください。
タイプ: 文字列
有効な値：`ONLINE | OFFLINE`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 例
### リクエスト例
次の例では、リクエストで指定されたエージェントに関する情報を返します。
```
{
"AgentArn": "arn:aws:datasync:us-east-2:111122223333:agent/agent-1234567890abcdef0"
}
```
### レスポンス例
次のレスポンス例は、パブリックサービスエンドポイントを使用するエージェントについて説明しています。
```
{
"AgentArn": "arn:aws:datasync:us-east-2:111122223333:agent/agent-1234567890abcdef0",
"Name": "Data center migration agent",
"Status": "ONLINE",
"LastConnectionTime": "2022-10-17T17:21:35.540000+00:00",
"CreationTime": "2022-10-05T20:52:29.499000+00:00",
"EndpointType": "PUBLIC",
"Platform": {
"Version": "2"
}
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeAgent)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeAgent)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeAgent)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeAgent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeAgent)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeAgent)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeAgent)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeAgent)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeAgent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeAgent)
# DescribeLocationAzureBlob
Microsoft Azure Blob Storage の AWS DataSync 転送場所の設定方法の詳細を提供します。
## リクエストの構文
```
{
"LocationArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [LocationArn](#API_DescribeLocationAzureBlob_RequestSyntax) **
Azure Blob Storage の転送場所の Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
## レスポンスの構文
```
{
"AccessTier": "string",
"AgentArns": [ "string" ],
"AuthenticationType": "string",
"BlobType": "string",
"CmkSecretConfig": {
"KmsKeyArn": "string",
"SecretArn": "string"
},
"CreationTime": number,
"CustomSecretConfig": {
"SecretAccessRoleArn": "string",
"SecretArn": "string"
},
"LocationArn": "string",
"LocationUri": "string",
"ManagedSecretConfig": {
"SecretArn": "string"
}
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [AccessTier](#API_DescribeLocationAzureBlob_ResponseSyntax) **
オブジェクトまたはファイルの転送先となるアクセス層。これは、その場所を転送先として使用する場合にのみ適用されます。詳細については、「[アクセス層](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers)」を参照してください。
タイプ: 文字列
有効な値：`HOT | COOL | ARCHIVE`
** [AgentArns](#API_DescribeLocationAzureBlob_ResponseSyntax) **
Azure Blob Storage コンテナに接続できる DataSync エージェントの ARN。
タイプ: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大 8 項目。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`
** [AuthenticationType](#API_DescribeLocationAzureBlob_ResponseSyntax) **
DataSync が Azure Blob Storage にアクセスするために使用する認証方法です。DataSync は、共有アクセス署名 (SAS) を使用して blob storage にアクセスできます。
タイプ: 文字列
有効な値：`SAS | NONE`
** [BlobType](#API_DescribeLocationAzureBlob_ResponseSyntax) **
オブジェクトやファイルを Azure Blob Storage に転送するときに使用したいブロブのタイプ。現在、DataSync は、ブロック blobs としての Azure Blob Storage へのデータの移動のみをサポートしています。BLOB のタイプの詳細については、「[Azure Blob Storage のドキュメント](https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs)」を参照してください。
タイプ: 文字列
有効な値：`BLOCK`
** [CmkSecretConfig](#API_DescribeLocationAzureBlob_ResponseSyntax) **
DataSync が特定のストレージの場所にアクセスするために使用する認証トークンなど、DataSync が管理するシークレットと、カスタマー管理の AWS KMS keyの設定情報について説明します。
型: [CmkSecretConfig](API_CmkSecretConfig.md) オブジェクト
** [CreationTime](#API_DescribeLocationAzureBlob_ResponseSyntax) **
Azure Blob storage 転送場所が作成された時刻。
タイプ: タイムスタンプ
** [CustomSecretConfig](#API_DescribeLocationAzureBlob_ResponseSyntax) **
DataSync が特定のストレージロケーションにアクセスするために使用する認証トークンなど、カスタマーマネージドシークレットの設定情報と、シークレットへのアクセスを提供するカスタマーマネージド AWS Identity and Access Management (IAM) ロールについて説明します。
型: [CustomSecretConfig](API_CustomSecretConfig.md) オブジェクト
** [LocationArn](#API_DescribeLocationAzureBlob_ResponseSyntax) **
Azure Blob storage の転送場所の ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
** [LocationUri](#API_DescribeLocationAzureBlob_ResponseSyntax) **
転送に関係する Azure Blob storage コンテナーの URL。
タイプ: 文字列
長さの制約: 最大長は 4,360 です。
パターン: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$`
** [ManagedSecretConfig](#API_DescribeLocationAzureBlob_ResponseSyntax) **
DataSync が特定のストレージの場所にアクセスするために使用する認証トークンなど、DataSync が管理するシークレットの設定情報について説明します。DataSync AWSは、デフォルトマネージド KMS キーを使用してこのシークレットを暗号化します AWS Secrets Manager。
型: [ManagedSecretConfig](API_ManagedSecretConfig.md) オブジェクト
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationAzureBlob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationAzureBlob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationAzureBlob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationAzureBlob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationAzureBlob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationAzureBlob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationAzureBlob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationAzureBlob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationAzureBlob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationAzureBlob)
# DescribeLocationEfs
Amazon EFS ファイルシステムの AWS DataSync 転送場所の設定方法の詳細を提供します。
## リクエストの構文
```
{
"LocationArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [LocationArn](#API_DescribeLocationEfs_RequestSyntax) **
情報を取得する Amazon EFS ファイルシステムの場所の Amazon リソースネーム (ARN)。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
## レスポンスの構文
```
{
"AccessPointArn": "string",
"CreationTime": number,
"Ec2Config": {
"SecurityGroupArns": [ "string" ],
"SubnetArn": "string"
},
"FileSystemAccessRoleArn": "string",
"InTransitEncryption": "string",
"LocationArn": "string",
"LocationUri": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [AccessPointArn](#API_DescribeLocationEfs_ResponseSyntax) **
DataSync が Amazon EFS ファイルシステムにアクセスするために使用するアクセスポイントの ARN。
詳細については、「[Accessing restricted file systems](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam)」を参照してください。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):elasticfilesystem:[a-z\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$`
** [CreationTime](#API_DescribeLocationEfs_ResponseSyntax) **
場所が作成された時刻。
タイプ: タイムスタンプ
** [Ec2Config](#API_DescribeLocationEfs_ResponseSyntax) **
AWS DataSync が Amazon EFS ファイルシステムの[マウントターゲット](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html)の 1 つに接続するために使用するサブネットとセキュリティグループ。
型: [Ec2Config](API_Ec2Config.md) オブジェクト
** [FileSystemAccessRoleArn](#API_DescribeLocationEfs_ResponseSyntax) **
DataSync が Amazon EFS ファイルシステムにアクセスできるようにする AWS Identity and Access Management (IAM) ロール。
詳細については、「[Creating a DataSync IAM role for file system access](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role)」を参照してください。
タイプ: 文字列
長さの制約: 最大長は 2,048 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$`
** [InTransitEncryption](#API_DescribeLocationEfs_ResponseSyntax) **
DataSync が Amazon EFS ファイルシステムとの間でデータを転送するときに、Transport Layer Security (TLS) 暗号化を使用するかどうかを示します。
タイプ: 文字列
有効な値：`NONE | TLS1_2`
** [LocationArn](#API_DescribeLocationEfs_ResponseSyntax) **
Amazon EFS ファイルシステムの場所の ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
** [LocationUri](#API_DescribeLocationEfs_ResponseSyntax) **
Amazon EFS ファイルシステムの場所の URL。
タイプ: 文字列
長さの制約: 最大長は 4,360 です。
パターン: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 例
### リクエスト例
次の例は、特定の Amazon EFS ファイルシステムの場所に関する情報を取得する方法を示しています。
```
{
"LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-12abcdef012345678"
}
```
### レスポンス例
次の例は、Amazon EFS ファイルシステムに関する場所の詳細を返します。
```
{
"CreationTime": 1653319021.353,
"Ec2Config": {
"SubnetArn": "arn:aws:ec2:us-east-2:111222333444:subnet/subnet-1234567890abcdef1",
"SecurityGroupArns": [
"arn:aws:ec2:us-east-2:111222333444:security-group/sg-1234567890abcdef2"
]
},
"LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-abcdef01234567890",
"LocationUri": "efs://us-east-2.fs-021345abcdef6789/"
}
```
### レスポンス例: 制限付きの Amazon EFS ファイルシステムの場所の説明
次の例では、アクセスが制限されている Amazon EFS ファイルシステムの場所の詳細 (`AccessPointArn`、`FileSystemAccessRoleArn`、`InTransitEncryption` 要素など) を返します。
```
{
"CreationTime": 1653319021.353,
"AccessPointArn": "arn:aws:elasticfilesystem:us-east-2:111222333444:access-point/fsap-1234567890abcdef0",
"Ec2Config": {
"SubnetArn": "arn:aws:ec2:us-east-2:111222333444:subnet/subnet-1234567890abcdef1",
"SecurityGroupArns": [
"arn:aws:ec2:us-east-2:111222333444:security-group/sg-1234567890abcdef2"
]
},
"FileSystemAccessRoleArn": "arn:aws:iam::111222333444:role/AwsDataSyncFullAccessNew",
"InTransitEncryption": "TLS1_2",
"LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-abcdef01234567890",
"LocationUri": "efs://us-east-2.fs-021345abcdef6789/",
"Subdirectory": "/mount/path",
"Tags": [{
"Key": "Name",
"Value": "ElasticFileSystem-1"
}]
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationEfs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationEfs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationEfs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationEfs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationEfs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationEfs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationEfs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationEfs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationEfs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationEfs)
# DescribeLocationFsxLustre
Amazon FSx for Lustre ファイルシステムの AWS DataSync 転送場所の設定方法の詳細を提供します。
## リクエストの構文
```
{
"LocationArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [LocationArn](#API_DescribeLocationFsxLustre_RequestSyntax) **
説明する FSx for Lustre の場所の Amazon リソースネーム (ARN)。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
## レスポンスの構文
```
{
"CreationTime": number,
"LocationArn": "string",
"LocationUri": "string",
"SecurityGroupArns": [ "string" ]
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [CreationTime](#API_DescribeLocationFsxLustre_ResponseSyntax) **
FSx for Lustre の場所が作成された時刻。
タイプ: タイムスタンプ
** [LocationArn](#API_DescribeLocationFsxLustre_ResponseSyntax) **
説明された FSx for Lustre の場所の Amazon リソースネーム (ARN)。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
** [LocationUri](#API_DescribeLocationFsxLustre_ResponseSyntax) **
説明された FSx for Lustre の場所の URI。
タイプ: 文字列
長さの制約: 最大長は 4,360 です。
パターン: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$`
** [SecurityGroupArns](#API_DescribeLocationFsxLustre_ResponseSyntax) **
FSx for Lustre ファイル システムに設定されるセキュリティ グループのAmazon リソースネーム (ARN)。
タイプ: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大数は 5 項目です。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationFsxLustre)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationFsxLustre)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationFsxLustre)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationFsxLustre)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationFsxLustre)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationFsxLustre)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationFsxLustre)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationFsxLustre)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationFsxLustre)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationFsxLustre)
# DescribeLocationFsxOntap
Amazon FSx for NetApp ONTAP ファイルシステムの AWS DataSync 転送場所の設定方法の詳細を提供します。
**注記**
場所に SMB が使用されている場合、`DescribeLocationFsxOntap` オペレーションは実際には `Password` を返しません。
## リクエストの構文
```
{
"LocationArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [LocationArn](#API_DescribeLocationFsxOntap_RequestSyntax) **
情報を取得する FSx for ONTAP ファイルシステム上の Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
## レスポンスの構文
```
{
"CreationTime": number,
"FsxFilesystemArn": "string",
"LocationArn": "string",
"LocationUri": "string",
"Protocol": {
"NFS": {
"MountOptions": {
"Version": "string"
}
},
"SMB": {
"CmkSecretConfig": {
"KmsKeyArn": "string",
"SecretArn": "string"
},
"CustomSecretConfig": {
"SecretAccessRoleArn": "string",
"SecretArn": "string"
},
"Domain": "string",
"ManagedSecretConfig": {
"SecretArn": "string"
},
"MountOptions": {
"Version": "string"
},
"Password": "string",
"User": "string"
}
},
"SecurityGroupArns": [ "string" ],
"StorageVirtualMachineArn": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [CreationTime](#API_DescribeLocationFsxOntap_ResponseSyntax) **
場所が作成された時刻。
タイプ: タイムスタンプ
** [FsxFilesystemArn](#API_DescribeLocationFsxOntap_ResponseSyntax) **
FSx for ONTAP ファイルシステムの ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$`
** [LocationArn](#API_DescribeLocationFsxOntap_ResponseSyntax) **
指定された場所にある FSx for ONTAP ファイルシステムの ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
** [LocationUri](#API_DescribeLocationFsxOntap_ResponseSyntax) **
FSx for ONTAP ファイル システムの場所の統一資源識別子 (URI)。
タイプ: 文字列
長さの制約: 最大長は 4,360 です。
パターン: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$`
** [Protocol](#API_DescribeLocationFsxOntap_ResponseSyntax) **
AWS DataSync が Amazon FSx ファイルシステムにアクセスするために使用するデータ転送プロトコルを指定します。
型: [FsxProtocol](API_FsxProtocol.md) オブジェクト
** [SecurityGroupArns](#API_DescribeLocationFsxOntap_ResponseSyntax) **
DataSync が FSx for ONTAP ファイルシステムにアクセスするために使用するセキュリティグループ。
タイプ: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大数は 5 項目です。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$`
** [StorageVirtualMachineArn](#API_DescribeLocationFsxOntap_ResponseSyntax) **
データのコピーのやり取りをする FSx for ONTAP ファイル システム上のストレージ仮想マシン (SVM) の ARN。
タイプ: 文字列
長さの制約: 最大長は 162 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:storage-virtual-machine/fs-[0-9a-f]+/svm-[0-9a-f]{17,}$`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationFsxOntap)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationFsxOntap)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationFsxOntap)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationFsxOntap)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationFsxOntap)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationFsxOntap)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationFsxOntap)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationFsxOntap)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationFsxOntap)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationFsxOntap)
# DescribeLocationFsxOpenZfs
Amazon FSx for OpenZFS ファイルシステムの AWS DataSync 転送場所の設定方法の詳細を提供します。
**注記**
`SMB` に関連するレスポンス要素は `DescribeLocationFsxOpenZfs` オペレーションではサポートされていません。
## リクエストの構文
```
{
"LocationArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [LocationArn](#API_DescribeLocationFsxOpenZfs_RequestSyntax) **
説明する FSx for OpenZFS の場所の Amazon リソースネーム (ARN)。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
## レスポンスの構文
```
{
"CreationTime": number,
"LocationArn": "string",
"LocationUri": "string",
"Protocol": {
"NFS": {
"MountOptions": {
"Version": "string"
}
},
"SMB": {
"CmkSecretConfig": {
"KmsKeyArn": "string",
"SecretArn": "string"
},
"CustomSecretConfig": {
"SecretAccessRoleArn": "string",
"SecretArn": "string"
},
"Domain": "string",
"ManagedSecretConfig": {
"SecretArn": "string"
},
"MountOptions": {
"Version": "string"
},
"Password": "string",
"User": "string"
}
},
"SecurityGroupArns": [ "string" ]
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [CreationTime](#API_DescribeLocationFsxOpenZfs_ResponseSyntax) **
FSx for OpenZFS の場所が作成された時刻。
タイプ: タイムスタンプ
** [LocationArn](#API_DescribeLocationFsxOpenZfs_ResponseSyntax) **
説明された FSx for OpenZFS の場所の ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
** [LocationUri](#API_DescribeLocationFsxOpenZfs_ResponseSyntax) **
説明された FSx for OpenZFS の場所の統一資源識別子 (URI)。
例: `fsxz://us-west-2.fs-1234567890abcdef02/fsx/folderA/folder`
タイプ: 文字列
長さの制約: 最大長は 4,360 です。
パターン: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$`
** [Protocol](#API_DescribeLocationFsxOpenZfs_ResponseSyntax) **
AWS DataSync がファイルシステムにアクセスするために使用するプロトコルのタイプ。
型: [FsxProtocol](API_FsxProtocol.md) オブジェクト
** [SecurityGroupArns](#API_DescribeLocationFsxOpenZfs_ResponseSyntax) **
FSx for OpenZFS ファイルシステム用に構成するセキュリティグループの ARN。
タイプ: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大数は 5 項目です。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationFsxOpenZfs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationFsxOpenZfs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationFsxOpenZfs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationFsxOpenZfs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationFsxOpenZfs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationFsxOpenZfs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationFsxOpenZfs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationFsxOpenZfs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationFsxOpenZfs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationFsxOpenZfs)
# DescribeLocationFsxWindows
Amazon FSx for Windows File Server ファイルシステムの AWS DataSync 転送場所の設定方法の詳細を提供します。
## リクエストの構文
```
{
"LocationArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [LocationArn](#API_DescribeLocationFsxWindows_RequestSyntax) **
FSx for Windows File Server の場所の Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
## レスポンスの構文
```
{
"CmkSecretConfig": {
"KmsKeyArn": "string",
"SecretArn": "string"
},
"CreationTime": number,
"CustomSecretConfig": {
"SecretAccessRoleArn": "string",
"SecretArn": "string"
},
"Domain": "string",
"LocationArn": "string",
"LocationUri": "string",
"ManagedSecretConfig": {
"SecretArn": "string"
},
"SecurityGroupArns": [ "string" ],
"User": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [CmkSecretConfig](#API_DescribeLocationFsxWindows_ResponseSyntax) **
DataSync が特定のストレージロケーションへのアクセスに使用する など、`Password`DataSync が管理するシークレットの設定情報をカスタマー管理で記述します AWS KMS key。
型: [CmkSecretConfig](API_CmkSecretConfig.md) オブジェクト
** [CreationTime](#API_DescribeLocationFsxWindows_ResponseSyntax) **
FSx for Windows File Server の場所が作成された時刻。
タイプ: タイムスタンプ
** [CustomSecretConfig](#API_DescribeLocationFsxWindows_ResponseSyntax) **
DataSync `Password`が特定のストレージロケーションにアクセスするために使用する など、カスタマーマネージドシークレットの設定情報を、シークレットへのアクセスを提供するカスタマーマネージド AWS Identity and Access Management (IAM) ロールで記述します。
型: [CustomSecretConfig](API_CustomSecretConfig.md) オブジェクト
** [Domain](#API_DescribeLocationFsxWindows_ResponseSyntax) **
FSx for Windows File Server ファイルシステムが属する Microsoft Active Directory ドメインの名前。
タイプ: 文字列
長さの制約: 最大長は 253 です。
パターン: `^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$`
** [LocationArn](#API_DescribeLocationFsxWindows_ResponseSyntax) **
FSx for Windows File Server の場所の ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
** [LocationUri](#API_DescribeLocationFsxWindows_ResponseSyntax) **
FSx for Windows File Server の場所の統一資源識別子 (URI) 。
タイプ: 文字列
長さの制約: 最大長は 4,360 です。
パターン: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$`
** [ManagedSecretConfig](#API_DescribeLocationFsxWindows_ResponseSyntax) **
DataSync が特定のストレージロケーションにアクセスするために使用する など、`Password`DataSync が管理するシークレットの設定情報について説明します。DataSync AWSは、デフォルトマネージド KMS キーを使用してこのシークレットを暗号化します AWS Secrets Manager。
型: [ManagedSecretConfig](API_ManagedSecretConfig.md) オブジェクト
** [SecurityGroupArns](#API_DescribeLocationFsxWindows_ResponseSyntax) **
ファイルシステムの優先サブネットへのアクセスを提供する Amazon EC2 セキュリティグループの ARN。
ファイルシステムアクセスのセキュリティグループの設定については、「[https://docs.aws.amazon.com/fsx/latest/WindowsGuide/limit-access-security-groups.html](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/limit-access-security-groups.html)」を参照してください。
タイプ: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大数は 5 項目です。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$`
** [User](#API_DescribeLocationFsxWindows_ResponseSyntax) **
FSx for Windows File Server ファイルシステムをマウントし、アクセスするためのアクセス許可を持つユーザー。
タイプ: 文字列
長さの制約: 最大長は 104 です。
パターン: `^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationFsxWindows)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationFsxWindows)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationFsxWindows)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationFsxWindows)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationFsxWindows)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationFsxWindows)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationFsxWindows)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationFsxWindows)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationFsxWindows)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationFsxWindows)
# DescribeLocationHdfs
Hadoop Distributed File System (HDFS) の AWS DataSync 転送場所の設定方法の詳細を提供します。
## リクエストの構文
```
{
"LocationArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [LocationArn](#API_DescribeLocationHdfs_RequestSyntax) **
HDFS の場所の Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
## レスポンスの構文
```
{
"AgentArns": [ "string" ],
"AuthenticationType": "string",
"BlockSize": number,
"CmkSecretConfig": {
"KmsKeyArn": "string",
"SecretArn": "string"
},
"CreationTime": number,
"CustomSecretConfig": {
"SecretAccessRoleArn": "string",
"SecretArn": "string"
},
"KerberosPrincipal": "string",
"KmsKeyProviderUri": "string",
"LocationArn": "string",
"LocationUri": "string",
"ManagedSecretConfig": {
"SecretArn": "string"
},
"NameNodes": [
{
"Hostname": "string",
"Port": number
}
],
"QopConfiguration": {
"DataTransferProtection": "string",
"RpcProtection": "string"
},
"ReplicationFactor": number,
"SimpleUser": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [AgentArns](#API_DescribeLocationHdfs_ResponseSyntax) **
HDFS クラスターに安全に接続できる DataSync エージェントの ARN。
タイプ: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大 8 項目。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`
** [AuthenticationType](#API_DescribeLocationHdfs_ResponseSyntax) **
ユーザーの ID を決定するために使用される認証のタイプ。
タイプ: 文字列
有効な値：`SIMPLE | KERBEROS`
** [BlockSize](#API_DescribeLocationHdfs_ResponseSyntax) **
HDFS クラスターに書き込むデータブロックのサイズ。
タイプ: 整数
有効範囲: 最小値 は 1,048,576 です。最大値は 1,073,741,824 です。
** [CmkSecretConfig](#API_DescribeLocationHdfs_ResponseSyntax) **
DataSync が特定のストレージロケーションへのアクセスに使用する など、`KerberosKeytab`DataSync が管理するシークレットの設定情報をカスタマー管理で記述します AWS KMS key。
型: [CmkSecretConfig](API_CmkSecretConfig.md) オブジェクト
** [CreationTime](#API_DescribeLocationHdfs_ResponseSyntax) **
HDFS の場所が作成された時刻。
タイプ: タイムスタンプ
** [CustomSecretConfig](#API_DescribeLocationHdfs_ResponseSyntax) **
DataSync `KerberosKeytab`が特定のストレージロケーションにアクセスするために使用する など、カスタマーマネージドシークレットの設定情報を、シークレットへのアクセスを提供するカスタマーマネージド AWS Identity and Access Management (IAM) ロールで記述します。
型: [CustomSecretConfig](API_CustomSecretConfig.md) オブジェクト
** [KerberosPrincipal](#API_DescribeLocationHdfs_ResponseSyntax) **
HDFS クラスター上のファイルとフォルダーへのアクセス権を持つ Kerberos プリンシパル。`AuthenticationType` を `KERBEROS` と定義するとき、このパラメータが使用されます。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 256 です。
パターン: `^.+$`
** [KmsKeyProviderUri](#API_DescribeLocationHdfs_ResponseSyntax) **
HDFS クラスターのキー管理サーバー (KMS) の URI。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 255 です。
パターン: `^kms:\/\/http[s]?@(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])(;(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9]))*:[0-9]{1,5}\/kms$`
** [LocationArn](#API_DescribeLocationHdfs_ResponseSyntax) **
HDFS の場所の ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
** [LocationUri](#API_DescribeLocationHdfs_ResponseSyntax) **
HDFS の場所の URI。
タイプ: 文字列
長さの制約: 最大長は 4,360 です。
パターン: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$`
** [ManagedSecretConfig](#API_DescribeLocationHdfs_ResponseSyntax) **
DataSync が特定のストレージロケーションにアクセスするために使用する など、`KerberosKeytab`DataSync が管理するシークレットの設定情報について説明します。DataSync AWSは、デフォルトマネージド KMS キーを使用してこのシークレットを暗号化します AWS Secrets Manager。
型: [ManagedSecretConfig](API_ManagedSecretConfig.md) オブジェクト
** [NameNodes](#API_DescribeLocationHdfs_ResponseSyntax) **
HDFS 名前空間を管理する NameNode。
タイプ: [HdfsNameNode](API_HdfsNameNode.md) オブジェクトの配列
配列メンバー: 最小数は 1 項目です。
** [QopConfiguration](#API_DescribeLocationHdfs_ResponseSyntax) **
保護の品質 (QOP) 設定は、HDFS クラスターで設定されたリモートプロシージャコール (RPC) とデータ転送保護の設定を指定します。
タイプ: [QopConfiguration](API_QopConfiguration.md) オブジェクト
** [ReplicationFactor](#API_DescribeLocationHdfs_ResponseSyntax) **
HDFS クラスターへの書き込み時にデータをレプリケートする DataNode の数。
タイプ: 整数
有効範囲: 最小値 は 1 です。最大値は 512 です。
** [SimpleUser](#API_DescribeLocationHdfs_ResponseSyntax) **
ホストオペレーティングシステム上のクライアントを識別するためのユーザー名。`AuthenticationType` を `SIMPLE` と定義するとき、このパラメータが使用されます。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 256 です。
パターン: `^[_.A-Za-z0-9][-_.A-Za-z0-9]*$`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationHdfs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationHdfs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationHdfs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationHdfs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationHdfs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationHdfs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationHdfs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationHdfs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationHdfs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationHdfs)
# DescribeLocationNfs
Network File System (NFS) ファイルサーバーの AWS DataSync 転送場所の設定方法の詳細を提供します。
## リクエストの構文
```
{
"LocationArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [LocationArn](#API_DescribeLocationNfs_RequestSyntax) **
情報が必要な NFS の場所の Amazon リソースネーム (ARN)を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
## レスポンスの構文
```
{
"CreationTime": number,
"LocationArn": "string",
"LocationUri": "string",
"MountOptions": {
"Version": "string"
},
"OnPremConfig": {
"AgentArns": [ "string" ]
}
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [CreationTime](#API_DescribeLocationNfs_ResponseSyntax) **
NFS の場所が作成された時刻。
タイプ: タイムスタンプ
** [LocationArn](#API_DescribeLocationNfs_ResponseSyntax) **
NFS の場所の ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
** [LocationUri](#API_DescribeLocationNfs_ResponseSyntax) **
NFS の場所の URI。
タイプ: 文字列
長さの制約: 最大長は 4,360 です。
パターン: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$`
** [MountOptions](#API_DescribeLocationNfs_ResponseSyntax) **
DataSync が NFS ファイルサーバーをマウントする際に使用するマウントオプション。
型: [NfsMountOptions](API_NfsMountOptions.md) オブジェクト
** [OnPremConfig](#API_DescribeLocationNfs_ResponseSyntax) **
Network File System (NFS) ファイルサーバーに接続できる AWS DataSync エージェント。
型: [OnPremConfig](API_OnPremConfig.md) オブジェクト
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 例
### 例
次の例では、サンプルリクエストで指定された NFS の場所に関する情報を返します。
#### リクエスト例
```
{
"LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50aa"
}
```
### 例
この例は、DescribeLocationNfs の使用方法を 1 つ示しています。
#### レスポンス例
```
{
"CreationTime": 1532660733.39,
"LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50aa",
"LocationUri": "hostname.amazon.com",
"OnPremConfig": {
"AgentArns": [ "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs" ]
}
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationNfs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationNfs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationNfs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationNfs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationNfs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationNfs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationNfs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationNfs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationNfs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationNfs)
# DescribeLocationObjectStorage
オブジェクトストレージシステムの AWS DataSync 転送場所の設定方法の詳細を提供します。
## リクエストの構文
```
{
"LocationArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [LocationArn](#API_DescribeLocationObjectStorage_RequestSyntax) **
オブジェクトストレージの場所の Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
## レスポンスの構文
```
{
"AccessKey": "string",
"AgentArns": [ "string" ],
"CmkSecretConfig": {
"KmsKeyArn": "string",
"SecretArn": "string"
},
"CreationTime": number,
"CustomSecretConfig": {
"SecretAccessRoleArn": "string",
"SecretArn": "string"
},
"LocationArn": "string",
"LocationUri": "string",
"ManagedSecretConfig": {
"SecretArn": "string"
},
"ServerCertificate": blob,
"ServerPort": number,
"ServerProtocol": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [AccessKey](#API_DescribeLocationObjectStorage_ResponseSyntax) **
オブジェクトストレージシステムとの認証に必要なアクセスキー (たとえば、ユーザー名など) 。
タイプ: 文字列
長さの制約: 最小長は 0 です。最大長は 200 です。
パターン: `^.*$`
** [AgentArns](#API_DescribeLocationObjectStorage_ResponseSyntax) **
オブジェクトストレージシステムに接続できる DataSync エージェントの ARN。
タイプ: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大 8 項目。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`
** [CmkSecretConfig](#API_DescribeLocationObjectStorage_ResponseSyntax) **
DataSync が特定の転送場所にアクセスするために使用する認証トークンや認証情報のセットなど、DataSync が管理するシークレットと、カスタマー管理の AWS KMS keyの設定情報について説明します。
型: [CmkSecretConfig](API_CmkSecretConfig.md) オブジェクト
** [CreationTime](#API_DescribeLocationObjectStorage_ResponseSyntax) **
場所が作成された時刻。
タイプ: タイムスタンプ
** [CustomSecretConfig](#API_DescribeLocationObjectStorage_ResponseSyntax) **
DataSync が特定の転送場所にアクセスするために使用する認証トークンや認証情報のセット、シークレットへのアクセスを提供するカスタマーマネージド AWS Identity and Access Management (IAM) ロールなど、カスタマーマネージドシークレットの設定情報について説明します。
型: [CustomSecretConfig](API_CustomSecretConfig.md) オブジェクト
** [LocationArn](#API_DescribeLocationObjectStorage_ResponseSyntax) **
オブジェクトストレージシステムの場所の ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
** [LocationUri](#API_DescribeLocationObjectStorage_ResponseSyntax) **
オブジェクトストレージシステムの場所の URI。
タイプ: 文字列
長さの制約: 最大長は 4,360 です。
パターン: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$`
** [ManagedSecretConfig](#API_DescribeLocationObjectStorage_ResponseSyntax) **
DataSync が特定の転送場所にアクセスするために使用する認証トークンや認証情報のセットなど、DataSync が管理するシークレットの設定情報について説明します。DataSync AWSは、デフォルトマネージド KMS キーを使用してこのシークレットを暗号化します AWS Secrets Manager。
型: [ManagedSecretConfig](API_ManagedSecretConfig.md) オブジェクト
** [ServerCertificate](#API_DescribeLocationObjectStorage_ResponseSyntax) **
システムがプライベートまたは自己署名の認証機関 (CA) を使用する場合、DataSync がオブジェクトストレージシステムで認証するための証明書チェーン。
タイプ: Base64 でエンコードされたバイナリデータオブジェクト
長さの制約: 最大長は 32,768 です。
** [ServerPort](#API_DescribeLocationObjectStorage_ResponseSyntax) **
オブジェクトストレージサーバーがインバウンドネットワークトラフィックを受け入れるポート (たとえば、ポート 443 など)
タイプ: 整数
有効範囲: 最小値 は 1 です。最大値は 65,536 です。
** [ServerProtocol](#API_DescribeLocationObjectStorage_ResponseSyntax) **
オブジェクトストレージシステムが通信に使用するプロトコル。
タイプ: 文字列
有効な値：`HTTPS | HTTP`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationObjectStorage)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationObjectStorage)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationObjectStorage)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationObjectStorage)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationObjectStorage)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationObjectStorage)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationObjectStorage)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationObjectStorage)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationObjectStorage)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationObjectStorage)
# DescribeLocationS3
S3 バケットの AWS DataSync 転送場所の設定方法の詳細を提供します。
## リクエストの構文
```
{
"LocationArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [LocationArn](#API_DescribeLocationS3_RequestSyntax) **
Amazon S3 の場所の Amazon リソースネーム (ARN) 指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
## レスポンスの構文
```
{
"AgentArns": [ "string" ],
"CreationTime": number,
"LocationArn": "string",
"LocationUri": "string",
"S3Config": {
"BucketAccessRoleArn": "string"
},
"S3StorageClass": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [AgentArns](#API_DescribeLocationS3_ResponseSyntax) **
Amazon S3 on Outposts の使用と作業時に Outpost にデプロイされた DataSync エージェントの ARN。
詳細については、[DataSync エージェントをデプロイする AWS Outposts](https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent)」を参照してください。
型: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大 8 項目。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`
** [CreationTime](#API_DescribeLocationS3_ResponseSyntax) **
Amazon S3 の場所が作成された時刻。
タイプ: タイムスタンプ
** [LocationArn](#API_DescribeLocationS3_ResponseSyntax) **
Amazon S3 の場所の ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
** [LocationUri](#API_DescribeLocationS3_ResponseSyntax) **
記述された Amazon S3 の場所の URL。
タイプ: 文字列
長さの制約: 最大長は 4,360 です。
パターン: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$`
** [S3Config](#API_DescribeLocationS3_ResponseSyntax) **
DataSync が S3 バケットにアクセスするために使用する AWS Identity and Access Management (IAM) ロールの Amazon リソースネーム (ARN) を指定します。
詳細については、「[Providing DataSync access to S3 buckets](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access)」を参照してください。
型: [S3Config](API_S3Config.md) オブジェクト
** [S3StorageClass](#API_DescribeLocationS3_ResponseSyntax) **
Amazon S3 が送信先の場所の場合、これはオブジェクト用に選択したストレージクラスです。
一部のストレージクラスの動作は、Amazon S3 のストレージコストに影響する場合があります。詳細については、「[Storage class considerations with Amazon S3 transfers](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes)」を参照してください。
タイプ: 文字列
有効な値：`STANDARD | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_INSTANT_RETRIEVAL`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 例
### 例
次の例では、サンプルリクエストで指定された Amazon S3 の場所に関する情報を返します。
#### リクエスト例
```
{
"LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3"
}
```
### 例
この例は、DescribeLocationS3 の使用方法を 1 つ示しています。
#### レスポンス例
```
{
"CreationTime": 1532660733.39,
"LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3",
"LocationUri": "s3://amzn-s3-demo-bucket",
"S3Config": {
"BucketAccessRoleArn": "arn:aws:iam::111222333444:role/amzn-s3-demo-bucket-access-role",
}
"S3StorageClass": "STANDARD"
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationS3)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationS3)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationS3)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationS3)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationS3)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationS3)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationS3)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationS3)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationS3)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationS3)
# DescribeLocationSmb
Server Message Block (SMB) ファイルサーバーの AWS DataSync 転送場所の設定方法の詳細を提供します。
## リクエストの構文
```
{
"LocationArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [LocationArn](#API_DescribeLocationSmb_RequestSyntax) **
情報が必要な SMB の場所の Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
## レスポンスの構文
```
{
"AgentArns": [ "string" ],
"AuthenticationType": "string",
"CmkSecretConfig": {
"KmsKeyArn": "string",
"SecretArn": "string"
},
"CreationTime": number,
"CustomSecretConfig": {
"SecretAccessRoleArn": "string",
"SecretArn": "string"
},
"DnsIpAddresses": [ "string" ],
"Domain": "string",
"KerberosPrincipal": "string",
"LocationArn": "string",
"LocationUri": "string",
"ManagedSecretConfig": {
"SecretArn": "string"
},
"MountOptions": {
"Version": "string"
},
"User": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [AgentArns](#API_DescribeLocationSmb_ResponseSyntax) **
SMB ファイルサーバーに接続できる DataSync エージェントの ARN。
タイプ: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大 8 項目。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`
** [AuthenticationType](#API_DescribeLocationSmb_ResponseSyntax) **
DataSync が SMB ファイルサーバーへの接続に使用する認証プロトコルを指定します。
型: 文字列
有効な値：`NTLM | KERBEROS`
** [CmkSecretConfig](#API_DescribeLocationSmb_ResponseSyntax) **
DataSync が特定のストレージロケーションへのアクセスに使用する `Password`や など、`KerberosKeytab`DataSync が管理するシークレットの設定情報をカスタマー管理で記述します AWS KMS key。
型: [CmkSecretConfig](API_CmkSecretConfig.md) オブジェクト
** [CreationTime](#API_DescribeLocationSmb_ResponseSyntax) **
SMB の場所が作成された時刻。
タイプ: タイムスタンプ
** [CustomSecretConfig](#API_DescribeLocationSmb_ResponseSyntax) **
DataSync `KerberosKeytab`が特定のストレージロケーションにアクセスするために使用する `Password`や など、カスタマーマネージドシークレットの設定情報を、シークレットへのアクセスを提供するカスタマーマネージド AWS Identity and Access Management (IAM) ロールで記述します。
型: [CustomSecretConfig](API_CustomSecretConfig.md) オブジェクト
** [DnsIpAddresses](#API_DescribeLocationSmb_ResponseSyntax) **
SMB ファイルサーバーが属する DNS サーバーの IPv4 または IPv6 アドレス。この要素は、`AuthenticationType` が `KERBEROS` に設定されている場合にのみ適用されます。
型: 文字列の配列
配列メンバー: 最大数は 2 項目です。
長さの制限: 最小長は 7 です。最大長は 39 です。
パターン: `\A((25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6}))\z`
** [Domain](#API_DescribeLocationSmb_ResponseSyntax) **
SMB ファイルサーバーが属する Windows ドメインの名前。この要素は、`AuthenticationType` が `NTLM` に設定されている場合にのみ適用されます。
タイプ: 文字列
長さの制約: 最大長は 253 です。
パターン: `^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$`
** [KerberosPrincipal](#API_DescribeLocationSmb_ResponseSyntax) **
SMB ファイルサーバーのファイル、フォルダ、ファイルメタデータにアクセスするためのアクセス許可を持つ Kerberos プリンシパル。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 256 です。
パターン: `^.+$`
** [LocationArn](#API_DescribeLocationSmb_ResponseSyntax) **
SMB の場所の ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
** [LocationUri](#API_DescribeLocationSmb_ResponseSyntax) **
SMB の場所の URI。
タイプ: 文字列
長さの制約: 最大長は 4,360 です。
パターン: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$`
** [ManagedSecretConfig](#API_DescribeLocationSmb_ResponseSyntax) **
DataSync が特定のストレージロケーションにアクセスするために使用する `Password`や など、`KerberosKeytab`DataSync が管理するシークレットの設定情報について説明します。DataSync AWSは、デフォルトマネージド KMS キーを使用してこのシークレットを暗号化します AWS Secrets Manager。
型: [ManagedSecretConfig](API_ManagedSecretConfig.md) オブジェクト
** [MountOptions](#API_DescribeLocationSmb_ResponseSyntax) **
DataSync が SMB ファイルサーバーにアクセスするために使用する SMB プロトコルバージョン。
型: [SmbMountOptions](API_SmbMountOptions.md) オブジェクト
** [User](#API_DescribeLocationSmb_ResponseSyntax) **
SMB ファイルサーバー内のファイル、フォルダ、ファイルメタデータをマウントしてアクセスできるユーザー。この要素は、`AuthenticationType` が `NTLM` に設定されている場合にのみ適用されます。
タイプ: 文字列
長さの制約: 最大長は 104 です。
パターン: `^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 例
### 例
この例は、DescribeLocationSmb の使用方法を 1 つ示しています。
#### リクエスト例
```
{
"arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49"
}
```
### 例
この例は、DescribeLocationSmb の使用方法を 1 つ示しています。
#### レスポンス例
```
{
"AgentArns":[
"arn:aws:datasync:us-east-2:111222333444:agent/agent-0bc3b3dc9bbc15145",
"arn:aws:datasync:us-east-2:111222333444:agent/agent-04b3fe3d261a18c8f"
],
"CreationTime":"1532660733.39",
"Domain":"AMAZON",
"LocationArn":"arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49",
"LocationUri":"smb://hostname.amazon.com/share",
"MountOptions":{
"Version":"SMB3"
},
"User":"user-1"
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationSmb)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationSmb)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationSmb)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationSmb)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationSmb)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationSmb)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationSmb)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationSmb)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationSmb)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationSmb)
# DescribeTask
AWS DataSync がデータを転送する場所と方法を定義する*タスク*に関する情報を提供します。
## リクエストの構文
```
{
"TaskArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [TaskArn](#API_DescribeTask_RequestSyntax) **
情報が必要な転送タスクの Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:task/task-[0-9a-f]{17}$`
必須: はい
## レスポンスの構文
```
{
"CloudWatchLogGroupArn": "string",
"CreationTime": number,
"CurrentTaskExecutionArn": "string",
"DestinationLocationArn": "string",
"DestinationNetworkInterfaceArns": [ "string" ],
"ErrorCode": "string",
"ErrorDetail": "string",
"Excludes": [
{
"FilterType": "string",
"Value": "string"
}
],
"Includes": [
{
"FilterType": "string",
"Value": "string"
}
],
"ManifestConfig": {
"Action": "string",
"Format": "string",
"Source": {
"S3": {
"BucketAccessRoleArn": "string",
"ManifestObjectPath": "string",
"ManifestObjectVersionId": "string",
"S3BucketArn": "string"
}
}
},
"Name": "string",
"Options": {
"Atime": "string",
"BytesPerSecond": number,
"Gid": "string",
"LogLevel": "string",
"Mtime": "string",
"ObjectTags": "string",
"OverwriteMode": "string",
"PosixPermissions": "string",
"PreserveDeletedFiles": "string",
"PreserveDevices": "string",
"SecurityDescriptorCopyFlags": "string",
"TaskQueueing": "string",
"TransferMode": "string",
"Uid": "string",
"VerifyMode": "string"
},
"Schedule": {
"ScheduleExpression": "string",
"Status": "string"
},
"ScheduleDetails": {
"DisabledBy": "string",
"DisabledReason": "string",
"StatusUpdateTime": number
},
"SourceLocationArn": "string",
"SourceNetworkInterfaceArns": [ "string" ],
"Status": "string",
"TaskArn": "string",
"TaskMode": "string",
"TaskReportConfig": {
"Destination": {
"S3": {
"BucketAccessRoleArn": "string",
"S3BucketArn": "string",
"Subdirectory": "string"
}
},
"ObjectVersionIds": "string",
"OutputType": "string",
"Overrides": {
"Deleted": {
"ReportLevel": "string"
},
"Skipped": {
"ReportLevel": "string"
},
"Transferred": {
"ReportLevel": "string"
},
"Verified": {
"ReportLevel": "string"
}
},
"ReportLevel": "string"
}
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [CloudWatchLogGroupArn](#API_DescribeTask_ResponseSyntax) **
タスクをモニタリングするための Amazon CloudWatch ロググループの Amazon リソースネーム (ARN)。
詳細については、「[Monitoring data transfers with Amazon CloudWatch Logs](https://docs.aws.amazon.com/datasync/latest/userguide/configure-logging.html)」を参照してください。
タイプ: 文字列
長さの制約: 最大長は 562 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$`
** [CreationTime](#API_DescribeTask_ResponseSyntax) **
タスクが作成された時刻。
タイプ: タイムスタンプ
** [CurrentTaskExecutionArn](#API_DescribeTask_ResponseSyntax) **
最新のタスク実行の ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$`
** [DestinationLocationArn](#API_DescribeTask_ResponseSyntax) **
転送時に送信先の場所の ARN を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
** [DestinationNetworkInterfaceArns](#API_DescribeTask_ResponseSyntax) **
DataSync が送信先用に作成された[ネットワークインターフェイス](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces)の ARN。
タイプ: 文字列の配列
長さの制約: 最大長は 128 です。
パターン: `^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$`
** [ErrorCode](#API_DescribeTask_ResponseSyntax) **
タスクに問題がある場合は、エラーコードを使用して問題のトラブルシューティングに役立てることができます。詳細については、「[Troubleshooting issues with DataSync transfers](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html)」を参照してください。
タイプ: 文字列
** [ErrorDetail](#API_DescribeTask_ResponseSyntax) **
タスクに問題がある場合は、エラーの詳細を使用して問題のトラブルシューティングに役立てることができます。詳細については、「[Troubleshooting issues with DataSync transfers](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html)」を参照してください。
タイプ: 文字列
** [Excludes](#API_DescribeTask_ResponseSyntax) **
DataSync に転送してほしくないソースの場所内のファイル、オブジェクト、フォルダを定義する除外フィルター。詳細と例については、「[Specifying what DataSync transfers by using filters](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)」を参照してください。
タイプ: [FilterRule](API_FilterRule.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。
** [Includes](#API_DescribeTask_ResponseSyntax) **
DataSync が転送するソースの場所内のファイル、オブジェクト、フォルダを定義するフィルターが含まれます。詳細と例については、「[Specifying what DataSync transfers by using filters](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)」を参照してください。
タイプ: [FilterRule](API_FilterRule.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。
** [ManifestConfig](#API_DescribeTask_ResponseSyntax) **
DataSync の転送を希望するファイルまたはオブジェクトを一覧表示するマニフェストを設定します。詳細については、「[Specifying what DataSync transfers by using a manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html)」を参照してください。
タイプ: [ManifestConfig](API_ManifestConfig.md) オブジェクト
** [Name](#API_DescribeTask_ResponseSyntax) **
タスクの名前。
タイプ: 文字列
長さの制約: 最小長は 0 です。最大長は 256 です。
パターン: `^[a-zA-Z0-9\s+=._:@/-]+$`
** [Options](#API_DescribeTask_ResponseSyntax) **
タスクの設定。例えば、どのファイルメタデータが保持されるか、転送終了時にデータ整合性がどのように検証されるか、帯域幅の制限などです。
タイプ: [Options](API_Options.md) オブジェクト
** [Schedule](#API_DescribeTask_ResponseSyntax) **
タスクを実行するタイミングのスケジュール。詳細については、「[タスクのスケジュール](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html)」を参照してください。
タイプ: [TaskSchedule](API_TaskSchedule.md) オブジェクト
** [ScheduleDetails](#API_DescribeTask_ResponseSyntax) **
[タスクスケジュール](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html)の詳細。
タイプ: [TaskScheduleDetails](API_TaskScheduleDetails.md) オブジェクト
** [SourceLocationArn](#API_DescribeTask_ResponseSyntax) **
転送時のソースの場所の ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
** [SourceNetworkInterfaceArns](#API_DescribeTask_ResponseSyntax) **
DataSync がソースの場所用に作成した[ネットワークインターフェイス](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces)の ARNs。
タイプ: 文字列の配列
長さの制約: 最大長は 128 です。
パターン: `^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$`
** [Status](#API_DescribeTask_ResponseSyntax) **
タスクのステータス。各ステータスの意味については、「[Task statuses](https://docs.aws.amazon.com/datasync/latest/userguide/create-task-how-to.html#understand-task-creation-statuses)」を参照してください。
タイプ: 文字列
有効な値：`AVAILABLE | CREATING | QUEUED | RUNNING | UNAVAILABLE`
** [TaskArn](#API_DescribeTask_ResponseSyntax) **
タスクの ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:task/task-[0-9a-f]{17}$`
** [TaskMode](#API_DescribeTask_ResponseSyntax) **
使用しているタスクモード。詳細については、「[Choosing a task mode for your data transfer](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)」を参照してください。
型: 文字列
有効な値：`BASIC | ENHANCED`
** [TaskReportConfig](#API_DescribeTask_ResponseSyntax) **
DataSync 転送に関する詳細情報を提供するタスクレポートの設定。詳細については、「[Monitoring your DataSync transfers with task reports](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html)」を参照してください。
タイプ: [TaskReportConfig](API_TaskReportConfig.md) オブジェクト
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 例
### リクエスト例
次の例では、情報を取得する DataSync タスクの ARN を指定します。
```
{
"TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026"
}
```
### レスポンス例
以下は `DescribeTask` レスポンスの例です。
```
{
"TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026",
"Name": "MyTask",
"TaskMode": "BASIC",
"Status": "RUNNING",
"SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-1111aaaa2222bbbb3",
"DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-0000zzzz1111yyyy2",
"CurrentTaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f",
"CreationTime": 1532660733.39,
"Options": {
"Atime": "BEST_EFFORT",
"BytesPerSecond": 1000,
"Gid": "NONE",
"Mtime": "PRESERVE",
"PosixPermissions": "PRESERVE",
"PreserveDevices": "NONE",
"PreserveDeletedFiles": "PRESERVE",
"Uid": "NONE",
"VerifyMode": "POINT_IN_TIME_CONSISTENT"
},
"CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group:/log-group-name:*"
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeTask)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeTask)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeTask)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeTask)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeTask)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeTask)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeTask)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeTask)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeTask)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeTask)
# DescribeTaskExecution
AWS DataSync タスクの実行に関する情報を提供します。このオペレーションを使用すると、行われているデータ転送の進行状況を監視したり、転送の結果を確認したりできます。
**注記**
一部の `DescribeTaskExecution` レスポンス要素は、特定のタスクモードにのみ関係します。詳細については、「[Understanding task mode differences](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html#task-mode-differences)」および[「Understanding data transfer performance counters](https://docs.aws.amazon.com/datasync/latest/userguide/transfer-performance-counters.html)」を参照してください。
## リクエストの構文
```
{
"TaskExecutionArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [TaskExecutionArn](#API_DescribeTaskExecution_RequestSyntax) **
情報が必要なタスク実行の Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$`
必須: はい
## レスポンスの構文
```
{
"BytesCompressed": number,
"BytesTransferred": number,
"BytesWritten": number,
"EndTime": number,
"EstimatedBytesToTransfer": number,
"EstimatedFilesToDelete": number,
"EstimatedFilesToTransfer": number,
"EstimatedFoldersToDelete": number,
"EstimatedFoldersToTransfer": number,
"Excludes": [
{
"FilterType": "string",
"Value": "string"
}
],
"FilesDeleted": number,
"FilesFailed": {
"Delete": number,
"Prepare": number,
"Transfer": number,
"Verify": number
},
"FilesListed": {
"AtDestinationForDelete": number,
"AtSource": number
},
"FilesPrepared": number,
"FilesSkipped": number,
"FilesTransferred": number,
"FilesVerified": number,
"FoldersDeleted": number,
"FoldersFailed": {
"Delete": number,
"List": number,
"Prepare": number,
"Transfer": number,
"Verify": number
},
"FoldersListed": {
"AtDestinationForDelete": number,
"AtSource": number
},
"FoldersPrepared": number,
"FoldersSkipped": number,
"FoldersTransferred": number,
"FoldersVerified": number,
"Includes": [
{
"FilterType": "string",
"Value": "string"
}
],
"LaunchTime": number,
"ManifestConfig": {
"Action": "string",
"Format": "string",
"Source": {
"S3": {
"BucketAccessRoleArn": "string",
"ManifestObjectPath": "string",
"ManifestObjectVersionId": "string",
"S3BucketArn": "string"
}
}
},
"Options": {
"Atime": "string",
"BytesPerSecond": number,
"Gid": "string",
"LogLevel": "string",
"Mtime": "string",
"ObjectTags": "string",
"OverwriteMode": "string",
"PosixPermissions": "string",
"PreserveDeletedFiles": "string",
"PreserveDevices": "string",
"SecurityDescriptorCopyFlags": "string",
"TaskQueueing": "string",
"TransferMode": "string",
"Uid": "string",
"VerifyMode": "string"
},
"ReportResult": {
"ErrorCode": "string",
"ErrorDetail": "string",
"Status": "string"
},
"Result": {
"ErrorCode": "string",
"ErrorDetail": "string",
"PrepareDuration": number,
"PrepareStatus": "string",
"TotalDuration": number,
"TransferDuration": number,
"TransferStatus": "string",
"VerifyDuration": number,
"VerifyStatus": "string"
},
"StartTime": number,
"Status": "string",
"TaskExecutionArn": "string",
"TaskMode": "string",
"TaskReportConfig": {
"Destination": {
"S3": {
"BucketAccessRoleArn": "string",
"S3BucketArn": "string",
"Subdirectory": "string"
}
},
"ObjectVersionIds": "string",
"OutputType": "string",
"Overrides": {
"Deleted": {
"ReportLevel": "string"
},
"Skipped": {
"ReportLevel": "string"
},
"Transferred": {
"ReportLevel": "string"
},
"Verified": {
"ReportLevel": "string"
}
},
"ReportLevel": "string"
}
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [BytesCompressed](#API_DescribeTaskExecution_ResponseSyntax) **
圧縮が適用された後にネットワーク上で DataSync が転送した物理バイト数 (圧縮可能な場合)。データが圧縮可能でない限り、この数値は通常 [BytesTransferred](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-BytesTransferred) よりも小さくなります。
タイプ: Long
** [BytesTransferred](#API_DescribeTaskExecution_ResponseSyntax) **
圧縮前に DataSync がネットワークに送信するバイト数 (圧縮可能な場合)。ネットワーク経由で転送されるバイト数については、「[BytesCompressed](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-BytesCompressed)」を参照してください。
タイプ: 長整数
** [BytesWritten](#API_DescribeTaskExecution_ResponseSyntax) **
DataSync が転送先の場所に実際に書き込んだ論理バイト数。
タイプ: Long
** [EndTime](#API_DescribeTaskExecution_ResponseSyntax) **
転送タスクが終了した時刻。
タイプ: タイムスタンプ
** [EstimatedBytesToTransfer](#API_DescribeTaskExecution_ResponseSyntax) **
DataSync が転送先の場所に書き込む論理バイト数の予定。
タイプ: 長整数
** [EstimatedFilesToDelete](#API_DescribeTaskExecution_ResponseSyntax) **
DataSync が転送先の場所で削除する予定のファイル、オブジェクト、およびディレクトリの数。送信元にない送信先のデータを削除するように[タスクを設定](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html)しない場合、値は常に `0` です。
[拡張モードタスク](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)の場合、このカウンターにはファイルまたはオブジェクトのみが含まれます。ディレクトリは [EstimatedFoldersToDelete](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-EstimatedFoldersToDelete) にカウントされます。
タイプ: Long
** [EstimatedFilesToTransfer](#API_DescribeTaskExecution_ResponseSyntax) **
DataSync がネットワーク経由で転送する予定のファイル、オブジェクト、およびディレクトリの数。この値は、DataSync が転送を[準備](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses)している間に計算されます。
これがどのように計算されるかは、主にタスクの[転送モード](https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-TransferMode)の設定によって異なります。
+ `TranserMode` が `CHANGED` に設定されている場合 - この計算は、ソースと転送先の内容の比較と、転送する必要がある差の特定に基づいて実行されます。相違点は次のとおりです。
+ ソースの場所で追加または変更されたもの。
+ 両方の場所にあり、最初の転送後に転送先で変更されたもの ([OverwriteMode](https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-OverwriteMode) が `NEVER` に設定されている場合を除く)。
+ **(基本タスクモードのみ)** DataSync が削除する予定の項目の数 ([PreserveDeletedFiles](https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-PreserveDeletedFiles) が `REMOVE` に設定されている場合)。
+ `TranserMode` が `ALL` に設定されている場合 - 計算は DataSync がソースの場所で検出した項目のみに基づいています。
[拡張モードタスク](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)の場合、このカウンターにはファイルまたはオブジェクトのみが含まれます。ディレクトリは [EstimatedFoldersToTransfer](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-EstimatedFoldersToTransfer) にカウントされます。
タイプ: Long
** [EstimatedFoldersToDelete](#API_DescribeTaskExecution_ResponseSyntax) **
DataSync が送信先ロケーションで削除する予定のディレクトリの数。送信元にない送信先のデータを削除するように[タスクを設定](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html)しない場合、値は常に `0` です。
[拡張モードタスク](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)にのみ適用されます。
タイプ: Long
** [EstimatedFoldersToTransfer](#API_DescribeTaskExecution_ResponseSyntax) **
DataSync がネットワーク経由で転送することを期待するディレクトリの数。この値は、DataSync が転送するディレクトリ[を準備する](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses)ときに計算されます。
これがどのように計算されるかは、主にタスクの[転送モード](https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-TransferMode)の設定によって異なります。
+ `TranserMode` が `CHANGED` に設定されている場合 - この計算は、ソースと転送先の内容の比較と、転送する必要がある差の特定に基づいて実行されます。相違点は次のとおりです。
+ ソースの場所で追加または変更されたもの。
+ 両方の場所にあり、最初の転送後に転送先で変更されたもの ([OverwriteMode](https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-OverwriteMode) が `NEVER` に設定されている場合を除く)。
+ `TranserMode` が `ALL` に設定されている場合 - 計算は DataSync がソースの場所で検出した項目のみに基づいています。
[拡張モードタスク](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)にのみ適用されます。
タイプ: Long
** [Excludes](#API_DescribeTaskExecution_ResponseSyntax) **
転送中に特定のデータを除外するフィルタルールのリスト。詳細と例については、「[DataSync によって転送されるデータのフィルタリング](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)」を参照してください。
タイプ: [FilterRule](API_FilterRule.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。
** [FilesDeleted](#API_DescribeTaskExecution_ResponseSyntax) **
DataSync が転送先の場所で実際に削除したファイル、オブジェクト、およびディレクトリの数。送信元にない送信先のデータを削除するように[タスクを設定](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html)しない場合、値は常に `0` です。
[拡張モードタスク](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)の場合、このカウンターにはファイルまたはオブジェクトのみが含まれます。ディレクトリは [FoldersDeleted](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-FoldersDeleted) にカウントされます。
タイプ: Long
** [FilesFailed](#API_DescribeTaskExecution_ResponseSyntax) **
タスクの実行中に DataSync が準備、転送、検証、削除に失敗したファイルまたはオブジェクトの数。
[拡張モードタスク](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)にのみ適用されます。
型: [TaskExecutionFilesFailedDetail](API_TaskExecutionFilesFailedDetail.md) オブジェクト
** [FilesListed](#API_DescribeTaskExecution_ResponseSyntax) **
DataSync がお客様の場所で見つけたファイルまたはオブジェクトの数。
[拡張モードタスク](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)にのみ適用されます。
型: [TaskExecutionFilesListedDetail](API_TaskExecutionFilesListedDetail.md) オブジェクト
** [FilesPrepared](#API_DescribeTaskExecution_ResponseSyntax) **
送信元と送信先の場所を比較した後に DataSync が転送を試みるファイルまたはオブジェクトの数。
[拡張モードタスク](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)にのみ適用されます。
このカウンターは、[すべてのデータを転送する](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-transfer-mode)ようにタスクを設定している場合には適用されません。この場合、DataSync は、場所間の違いを比較せずに、送信元から送信先にすべてコピーします。
タイプ: Long
** [FilesSkipped](#API_DescribeTaskExecution_ResponseSyntax) **
転送中に DataSync がスキップするファイル、オブジェクト、およびディレクトリの数。
[拡張モードタスク](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)の場合、このカウンターにはファイルまたはオブジェクトのみが含まれます。ディレクトリは [FoldersSkipped](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-FoldersSkipped) にカウントされます。
タイプ: Long
** [FilesTransferred](#API_DescribeTaskExecution_ResponseSyntax) **
DataSync がネットワーク経由で実際に転送したファイル、オブジェクト、およびディレクトリの数。この値は、タスクの実行中に送信元から何かが読み取られ、ネットワーク経由で送信されたときに定期的に更新されます。
DataSync が何かを転送できない場合、この値は `EstimatedFilesToTransfer` より小さくなる可能性があります。場合によっては、この値は `EstimatedFilesToTransfer` より大きくなることもあります。一部の場所タイプではこの要素は実装固有であるため、何が送信されているかを正確に把握するためのインジケータとして、あるいはタスク実行をモニタリングする目的では、これを使用しないでください。
[拡張モードタスク](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)の場合、このカウンターにはファイルまたはオブジェクトのみが含まれます。ディレクトリは [FoldersTransferred](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-FoldersTransferred) にカウントされます。
タイプ: Long
** [FilesVerified](#API_DescribeTaskExecution_ResponseSyntax) **
転送中に DataSync が検証するファイル、オブジェクト、およびディレクトリの数。
[転送されたデータのみを検証](https://docs.aws.amazon.com/datasync/latest/userguide/configure-data-verification-options.html)するようにタスクを設定すると、DataSync は状況によってはディレクトリを検証せず、また転送に失敗したファイルを検証しません。
[拡張モードタスク](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)の場合、このカウンターにはファイルまたはオブジェクトのみが含まれます。ディレクトリは [FoldersVerified](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-FoldersVerified) にカウントされます。
タイプ: Long
** [FoldersDeleted](#API_DescribeTaskExecution_ResponseSyntax) **
DataSync が送信先ロケーションで実際に削除するディレクトリの数。送信元にない送信先のデータを削除するように[タスクを設定](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html)しない場合、値は常に `0` です。
[拡張モードタスク](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)にのみ適用されます。
タイプ: Long
** [FoldersFailed](#API_DescribeTaskExecution_ResponseSyntax) **
タスクの実行中に DataSync がリスト、準備、転送、検証、削除に失敗したディレクトリの数。
[拡張モードタスク](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)にのみ適用されます。
型: [TaskExecutionFoldersFailedDetail](API_TaskExecutionFoldersFailedDetail.md) オブジェクト
** [FoldersListed](#API_DescribeTaskExecution_ResponseSyntax) **
DataSync がお客様のロケーションで見つけたディレクトリの数。
[拡張モードタスク](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)にのみ適用されます。
型: [TaskExecutionFoldersListedDetail](API_TaskExecutionFoldersListedDetail.md) オブジェクト
** [FoldersPrepared](#API_DescribeTaskExecution_ResponseSyntax) **
送信元と送信先の場所を比較した後に DataSync が転送を試みるディレクトリの数。
[拡張モードタスク](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)にのみ適用されます。
このカウンターは、[すべてのデータを転送する](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-transfer-mode)ようにタスクを設定している場合には適用されません。この場合、DataSync は、場所間の違いを比較せずに、送信元から送信先にすべてコピーします。
タイプ: Long
** [FoldersSkipped](#API_DescribeTaskExecution_ResponseSyntax) **
転送中に DataSync がスキップするディレクトリの数。
[拡張モードタスク](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)にのみ適用されます。
タイプ: Long
** [FoldersTransferred](#API_DescribeTaskExecution_ResponseSyntax) **
DataSync がネットワーク経由で実際に転送するディレクトリの数。この値は、タスクの実行中に送信元から何かが読み取られ、ネットワーク経由で送信されたときに定期的に更新されます。
DataSync が何かを転送できない場合、この値は `EstimatedFoldersToTransfer` より小さくなる可能性があります。場合によっては、この値は `EstimatedFoldersToTransfer` より大きくなることもあります。
[拡張モードタスク](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)にのみ適用されます。
タイプ: Long
** [FoldersVerified](#API_DescribeTaskExecution_ResponseSyntax) **
転送中に DataSync が検証するディレクトリの数。
[拡張モードタスク](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)にのみ適用されます。
タイプ: Long
** [Includes](#API_DescribeTaskExecution_ResponseSyntax) **
転送中に特定のデータを含めるフィルタルールのリスト。詳細と例については、「[DataSync によって転送されるデータのフィルタリング](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)」を参照してください。
タイプ: [FilterRule](API_FilterRule.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。
** [LaunchTime](#API_DescribeTaskExecution_ResponseSyntax) **
タスク実行が実際に開始された時刻。キューに入れられていないタスクの場合、`LaunchTime` と `StartTime` は通常同じになります。キューに入れられたタスクの場合、`LaunchTime` は通常 `StartTime` よりも後になります。これは、新しいタスクを開始する前に、以前にキューに入れられたタスクの実行を完了する必要があるためです。
タイプ: タイムスタンプ
** [ManifestConfig](#API_DescribeTaskExecution_ResponseSyntax) **
転送するファイルまたはオブジェクトを一覧表示するマニフェストの設定。詳細については、「[Specifying what DataSync transfers by using a manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html)」を参照してください。
タイプ: [ManifestConfig](API_ManifestConfig.md) オブジェクト
** [Options](#API_DescribeTaskExecution_ResponseSyntax) **
転送タスクがどのように構成されているかを示します。これらのオプションには、転送中に DataSync がファイル、オブジェクト、および関連するメタデータを処理する方法が含まれます。また、データの整合性の検証方法や、タスクの帯域幅制限の設定方法なども指定できます。
各オプションにはデフォルト値があります。必要な場合を除き、[StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) を呼び出す前にこれらのオプションを設定する必要はありません。
これらのタスクオプションは各タスクを実行するたびにオーバーライドできます。例えば、個々の実行に合わせて `LogLevel` を調整することができます。
タイプ: [Options](API_Options.md) オブジェクト
** [ReportResult](#API_DescribeTaskExecution_ResponseSyntax) **
DataSync が転送に関する完全な[タスクレポート](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html)を生成したかどうかを示します。
タイプ: [ReportResult](API_ReportResult.md) オブジェクト
** [Result](#API_DescribeTaskExecution_ResponseSyntax) **
タスク実行の 結果。
型: [TaskExecutionResultDetail](API_TaskExecutionResultDetail.md) オブジェクト
** [StartTime](#API_DescribeTaskExecution_ResponseSyntax) **
DataSync がタスク実行を開始するためのリクエストを送信した時刻。キューに入れられていないタスクの場合、`LaunchTime` と `StartTime` は通常同じになります。キューに入れられたタスクの場合、`LaunchTime` は通常 `StartTime` よりも後になります。これは、新しいタスクを開始する前に、以前にキューに入れられたタスクの実行を完了する必要があるためです。
タイプ: タイムスタンプ
** [Status](#API_DescribeTaskExecution_ResponseSyntax) **
タスク実行のステータス。
タスク実行ステータスの詳細については、「[タスクの実行ステータス](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses)」を参照してください。
タイプ: 文字列
有効な値：`QUEUED | CANCELLING | LAUNCHING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS | ERROR`
** [TaskExecutionArn](#API_DescribeTaskExecution_ResponseSyntax) **
ユーザーが情報を必要としたタスク実行の ARN。`TaskExecutionArn` は階層的であり、実行されたタスクの `TaskArn` を含みます。
たとえば、ARN `arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2` でタスクを実行した ARN `arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b` と `TaskExecution` の値です。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$`
** [TaskMode](#API_DescribeTaskExecution_ResponseSyntax) **
使用しているタスクモード。詳細については、「[Choosing a task mode for your data transfer](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)」を参照してください。
型: 文字列
有効な値：`BASIC | ENHANCED`
** [TaskReportConfig](#API_DescribeTaskExecution_ResponseSyntax) **
DataSync 転送に関する詳細情報を提供するタスクレポートの設定。詳細については、「[タスクレポートの作成](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html)」を参照してください。
タイプ: [TaskReportConfig](API_TaskReportConfig.md) オブジェクト
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 例
### リクエスト例
この例は `DescribeTaskExecution` リクエストを示しています。
```
{
"TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task-aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1"
}
```
### 拡張モードでのタスク実行のレスポンス例 1
次の例では、拡張モードを使用する DataSync タスク実行について説明します。実行では、除外フィルターと包含フィルターを使用して特定のデータも転送されます。
```
{
"TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task-aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1",
"Status": "SUCCESS",
"Options": {
"VerifyMode": "ONLY_FILES_TRANSFERRED",
"OverwriteMode": "ALWAYS",
"Atime": "BEST_EFFORT",
"Mtime": "PRESERVE",
"Uid": "NONE",
"Gid": "NONE",
"PreserveDeletedFiles": "PRESERVE",
"PreserveDevices": "NONE",
"PosixPermissions": "NONE",
"BytesPerSecond": -1,
"TaskQueueing": "ENABLED",
"LogLevel": "BASIC",
"TransferMode": "CHANGED",
"SecurityDescriptorCopyFlags": "NONE",
"ObjectTags": "PRESERVE"
},
"Excludes": [{
"FilterType": "SIMPLE_PATTERN",
"Value": "/archive-files"
}],
"Includes": [{
"FilterType": "SIMPLE_PATTERN",
"Value": "/files"
}],
"StartTime": "2024-10-16T11:19:56.844000-04:00",
"EstimatedFilesToTransfer": 7,
"EstimatedFoldersToTransfer": 2,
"EstimatedBytesToTransfer": 30,
"FilesTransferred": 7,
"FoldersTransferred": 2,
"BytesWritten": 30,
"BytesTransferred": 30,
"BytesCompressed": 30,
"Result": {
"PrepareDuration": 0,
"PrepareStatus": "SUCCESS",
"TotalDuration": 3310,
"TransferDuration": 0,
"TransferStatus": "SUCCESS",
"VerifyDuration": 0,
"VerifyStatus": "SUCCESS"
},
"FilesDeleted": 0,
"FilesSkipped": 0,
"FilesVerified": 7,
"EstimatedFilesToDelete": 0,
"TaskMode": "ENHANCED",
"FilesPrepared": 7,
"FilesListed": {
"AtSource": 7,
"AtDestinationForDelete": 0
},
"FilesFailed": {
"Prepare": 0,
"Transfer": 0,
"Verify": 0,
"Delete": 0
},
"FoldersDeleted": 0,
"FoldersSkipped": 0,
"FoldersVerified": 2,
"FoldersPrepared": 2,
"FoldersListed": {
"AtSource": 2,
"AtDestinationForDelete": 0
},
"FoldersFailed": {
"List": 0,
"Prepare": 0,
"Transfer": 0,
"Verify": 0,
"Delete": 0
}
}
```
### 拡張モードでのタスク実行のレスポンス例 2
次の例では、拡張モードを使用する別の DataSync タスク実行について説明します。この場合、実行ではフィルターの代わりにマニフェストを使用して特定のデータが転送されます。
```
{
"TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task-aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1",
"Status": "SUCCESS",
"Options": {
"VerifyMode": "ONLY_FILES_TRANSFERRED",
"OverwriteMode": "ALWAYS",
"Atime": "BEST_EFFORT",
"Mtime": "PRESERVE",
"Uid": "NONE",
"Gid": "NONE",
"PreserveDeletedFiles": "PRESERVE",
"PreserveDevices": "NONE",
"PosixPermissions": "NONE",
"BytesPerSecond": -1,
"TaskQueueing": "ENABLED",
"LogLevel": "TRANSFER",
"TransferMode": "CHANGED",
"SecurityDescriptorCopyFlags": "NONE",
"ObjectTags": "PRESERVE"
},
"Excludes": [],
"Includes": [],
"ManifestConfig": {
"Action": "TRANSFER",
"Format": "CSV",
"S3AccessRoleArn": "arn:aws:iam::111222333444:role/service-role/DataSyncS3ManifestAccess",
"S3Bucket": "arn:aws:s3:::manifests-datasync",
"VersionId": "Ixs7NQzEOj8BkL9r4ywX2FtDh_cPf3mG",
"Source": {
"S3": {
"ManifestObjectPath": "manifest-folder/manifest-versioned-files",
"BucketAccessRoleArn": "arn:aws:iam::111222333444:role/my-manifest-role/DataSyncS3ManifestAccess",
"S3BucketArn": "arn:aws:s3:::manifests-datasync",
"ManifestObjectVersionId": "Ixs7NQzEOj8BkL9r4ywX2FtDh_cPf3mG"
}
}
},
"StartTime": "2024-10-16T09:29:56.757000-04:00",
"EstimatedFilesToTransfer": 1,
"EstimatedFoldersToTransfer": 0,
"EstimatedBytesToTransfer": 6,
"FilesTransferred": 1,
"FoldersTransferred": 1,
"BytesWritten": 6,
"BytesTransferred": 6,
"BytesCompressed": 6,
"Result": {
"PrepareDuration": 0,
"PrepareStatus": "SUCCESS",
"TotalDuration": 3089,
"TransferDuration": 0,
"TransferStatus": "SUCCESS",
"VerifyDuration": 0,
"VerifyStatus": "SUCCESS"
},
"TaskReportConfig": {
"Destination": {
"S3": {
"Subdirectory": "reports/",
"S3BucketArn": "arn:aws:s3:::my-task-report",
"BucketAccessRoleArn": "arn:aws:iam::111222333444:role/my-task-report-role/DataSyncTaskReportS3BucketAccess"
}
},
"OutputType": "STANDARD",
"ReportLevel": "SUCCESSES_AND_ERRORS",
"ObjectVersionIds": "INCLUDE"
},
"FilesDeleted": 0,
"FilesSkipped": 0,
"FilesVerified": 1,
"ReportResult": {
"Status": "SUCCESS"
},
"EstimatedFilesToDelete": 0,
"TaskMode": "ENHANCED",
"FilesPrepared": 1,
"FilesListed": {
"AtSource": 1,
"AtDestinationForDelete": 0
},
"FilesFailed": {
"Prepare": 0,
"Transfer": 0,
"Verify": 0,
"Delete": 0
},
"FoldersDeleted": 0,
"FoldersSkipped": 0,
"FoldersVerified": 0,
"FoldersPrepared": 0,
"FoldersListed": {
"AtSource": 0,
"AtDestinationForDelete": 0
},
"FoldersFailed": {
"List": 0,
"Prepare": 0,
"Transfer": 0,
"Verify": 0,
"Delete": 0
}
}
```
### 基本モードでのタスク実行のレスポンス例
次の例では、基本モードを使用する DataSync タスク実行について説明します。
```
{
"TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task-aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1",
"BytesCompressed": 3500,
"BytesTransferred": 5000,
"BytesWritten": 5000,
"EstimatedBytesToTransfer": 5000,
"EstimatedFilesToDelete": 10,
"EstimatedFilesToTransfer": 100,
"FilesDeleted": 10,
"FilesSkipped": 0,
"FilesTransferred": 100,
"FilesVerified": 100,
"Result": {
"PrepareDuration": 100,
"PrepareStatus": "SUCCESS",
"TransferDuration": 60,
"TransferStatus": "SUCCESS",
"VerifyDuration": 30,
"VerifyStatus": "SUCCESS"
},
"StartTime": "2024-10-16T11:19:56.844000-04:00",
"Status": "SUCCESS",
"OverrideOptions": {
"Atime": "BEST_EFFORT",
"BytesPerSecond": "1000",
"Gid": "NONE",
"Mtime": "PRESERVE",
"PosixPermissions": "PRESERVE",
"PreserveDeletedFiles": "PRESERVE",
"Uid": "NONE",
"VerifyMode": "POINT_IN_TIME_CONSISTENT"
},
"TaskReportConfig": {
"Destination": {
"S3": {
"BucketAccessRoleArn": "arn:aws:iam::111222333444:role/my-datasync-role",
"S3BucketArn": "arn:aws:s3:::my-task-reports-bucket/*",
"Subdirectory": "reports"
}
},
"ObjectVersionIds": "INCLUDE",
"OutputType": "STANDARD",
"Overrides": {
"Deleted": {
"ReportLevel": "ERRORS_ONLY"
},
"Skipped": {
"ReportLevel": "SUCCESSES_AND_ERRORS"
},
"Transferred": {
"ReportLevel": "ERRORS_ONLY"
},
"Verified": {
"ReportLevel": "ERRORS_ONLY"
}
},
"ReportLevel": "ERRORS_ONLY"
}
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeTaskExecution)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeTaskExecution)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeTaskExecution)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeTaskExecution)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeTaskExecution)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeTaskExecution)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeTaskExecution)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeTaskExecution)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeTaskExecution)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeTaskExecution)
# ListAgents
リクエストで AWS リージョン 指定された AWS アカウント の に属する AWS DataSync エージェントのリストを返します。
ページネーションにより、レスポンスで返されるエージェントの数を減らすことができます。レスポンスで返された数を超えるエージェントがある場合、レスポンスはマーカーを含んでおり、次のリクエストで指定してエージェントの次のページを取得できます。
`ListAgents`の結果整合性 つまり、オペレーションを実行した結果には、エージェントを作成または削除したばかりであることが反映されません。たとえば、[CreateAgent](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateAgent.html) を使用してエージェントを作成して、 `ListAgents` を直ちに実行した場合、そのエージェントはすぐにはリストに表示されない場合があります。このような状況では、[DescribeAgent](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeAgent.html) を使用してエージェントが作成 (または削除) されたかどうかをいつでも確認できます。
## リクエストの構文
```
{
"MaxResults": number,
"NextToken": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [MaxResults](#API_ListAgents_RequestSyntax) **
レスポンスでリストする DataSync エージェントの最大数を指定します。デフォルトでは、レスポンスには最大 100 のエージェントが表示されます。
タイプ: 整数
有効範囲: 最小値 は 0 です。最大値は 100 です。
必須: いいえ
** [NextToken](#API_ListAgents_RequestSyntax) **
リソースの次の結果のリストの開始位置を示す不明瞭な文字列を指定します。
タイプ: 文字列
長さの制約: 最大長は 65,535 です。
パターン: `[a-zA-Z0-9=_-]+`
必須: いいえ
## レスポンスの構文
```
{
"Agents": [
{
"AgentArn": "string",
"Name": "string",
"Platform": {
"Version": "string"
},
"Status": "string"
}
],
"NextToken": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [Agents](#API_ListAgents_ResponseSyntax) **
リクエスト AWS アカウント で AWS リージョン 指定された の 内の DataSync エージェントのリスト。リストはエージェントの Amazon リソースネーム (ARN) 順に並べられています。
タイプ: [AgentListEntry](API_AgentListEntry.md) オブジェクトの配列
** [NextToken](#API_ListAgents_ResponseSyntax) **
リソースの次の結果のリストの開始位置を示す不明瞭な文字列。
タイプ: 文字列
長さの制約: 最大長は 65,535 です。
パターン: `[a-zA-Z0-9=_-]+`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/ListAgents)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/ListAgents)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ListAgents)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/ListAgents)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ListAgents)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/ListAgents)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/ListAgents)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/ListAgents)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/ListAgents)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ListAgents)
# ListLocations
送信元と送信先の場所のリストを返します。
レスポンスで返された数よりも多くの場所がある場合（つまり、レスポンスがエージェントの省略されたリストのみを返す場合)、レスポンスに含まれているトークンを次のリクエストで指定することで、場所の次のページを取得することができます。
## リクエストの構文
```
{
"Filters": [
{
"Name": "string",
"Operator": "string",
"Values": [ "string" ]
}
],
"MaxResults": number,
"NextToken": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [Filters](#API_ListLocations_RequestSyntax) **
API フィルターを使用して、`ListLocations` によって返されるリソースのリストを絞り込むことができます。たとえば、特定のソースの場所にあるすべてのタスクを取得するには、フィルター名 `LocationType S3` および `Operator Equals` で `ListLocations` を使用できます。
タイプ: [LocationFilter](API_LocationFilter.md) オブジェクトの配列
必須: いいえ
** [MaxResults](#API_ListLocations_RequestSyntax) **
返される場所の最大数。
タイプ: 整数
有効範囲: 最小値 は 0 です。最大値は 100 です。
必須: いいえ
** [NextToken](#API_ListLocations_RequestSyntax) **
場所の次のリストの開始位置を示す不明瞭な文字列。
タイプ: 文字列
長さの制約: 最大長は 65,535 です。
パターン: `[a-zA-Z0-9=_-]+`
必須: いいえ
## レスポンスの構文
```
{
"Locations": [
{
"LocationArn": "string",
"LocationUri": "string"
}
],
"NextToken": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [Locations](#API_ListLocations_ResponseSyntax) **
場所のリストを含む配列。
タイプ: [LocationListEntry](API_LocationListEntry.md) オブジェクトの配列
** [NextToken](#API_ListLocations_ResponseSyntax) **
場所の次のリストを返す開始位置を示す不透明な文字列。
タイプ: 文字列
長さの制約: 最大長は 65,535 です。
パターン: `[a-zA-Z0-9=_-]+`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/ListLocations)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/ListLocations)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ListLocations)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/ListLocations)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ListLocations)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/ListLocations)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/ListLocations)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/ListLocations)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/ListLocations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ListLocations)
# ListTagsForResource
AWS リソースに関連付けられているすべてのタグを返します。
## リクエストの構文
```
{
"MaxResults": number,
"NextToken": "string",
"ResourceArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [MaxResults](#API_ListTagsForResource_RequestSyntax) **
レスポンスに含める結果の数を指定します。
タイプ: 整数
有効範囲: 最小値 は 0 です。最大値は 100 です。
必須: いいえ
** [NextToken](#API_ListTagsForResource_RequestSyntax) **
リソースの次の結果のリストの開始位置を示す不明瞭な文字列を指定します。
タイプ: 文字列
長さの制約: 最大長は 65,535 です。
パターン: `[a-zA-Z0-9=_-]+`
必須: いいえ
** [ResourceArn](#API_ListTagsForResource_RequestSyntax) **
タグ情報が必要なリソースの Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:(((agent|task|location)/(agent|task|loc)-[a-z0-9]{17}(/execution/exec-[a-f0-9]{17})?)|(system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?))$`
必須: はい
## レスポンスの構文
```
{
"NextToken": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [NextToken](#API_ListTagsForResource_ResponseSyntax) **
リソースの次の結果のリストの開始位置を示す不明瞭な文字列。
タイプ: 文字列
長さの制約: 最大長は 65,535 です。
パターン: `[a-zA-Z0-9=_-]+`
** [Tags](#API_ListTagsForResource_ResponseSyntax) **
指定された EFS リソースのタグの配列。
タイプ: [TagListEntry](API_TagListEntry.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 55 項目です。
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/ListTagsForResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/ListTagsForResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ListTagsForResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/ListTagsForResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ListTagsForResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/ListTagsForResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/ListTagsForResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/ListTagsForResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/ListTagsForResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ListTagsForResource)
# ListTaskExecutions
AWS DataSync 転送タスクの実行のリストを返します。
## リクエストの構文
```
{
"MaxResults": number,
"NextToken": "string",
"TaskArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [MaxResults](#API_ListTaskExecutions_RequestSyntax) **
レスポンスに含める結果の数を指定します。
タイプ: 整数
有効範囲: 最小値 は 0 です。最大値は 100 です。
必須: いいえ
** [NextToken](#API_ListTaskExecutions_RequestSyntax) **
レスポンスの次の結果リストの開始位置を示す不明瞭な文字列を指定します。
タイプ: 文字列
長さの制約: 最大長は 65,535 です。
パターン: `[a-zA-Z0-9=_-]+`
必須: いいえ
** [TaskArn](#API_ListTaskExecutions_RequestSyntax) **
タスク実行の情報が必要な Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:task/task-[0-9a-f]{17}$`
必須: いいえ
## レスポンスの構文
```
{
"NextToken": "string",
"TaskExecutions": [
{
"Status": "string",
"TaskExecutionArn": "string",
"TaskMode": "string"
}
]
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [NextToken](#API_ListTaskExecutions_ResponseSyntax) **
リソースの次の結果のリストの開始位置を示す不明瞭な文字列。
タイプ: 文字列
長さの制約: 最大長は 65,535 です。
パターン: `[a-zA-Z0-9=_-]+`
** [TaskExecutions](#API_ListTaskExecutions_ResponseSyntax) **
タスク実行のリスト。
タイプ: [TaskExecutionListEntry](API_TaskExecutionListEntry.md) オブジェクトの配列
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/ListTaskExecutions)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/ListTaskExecutions)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ListTaskExecutions)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/ListTaskExecutions)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ListTaskExecutions)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/ListTaskExecutions)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/ListTaskExecutions)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/ListTaskExecutions)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/ListTaskExecutions)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ListTaskExecutions)
# ListTasks
作成した AWS DataSync タスクのリストを返します。
## リクエストの構文
```
{
"Filters": [
{
"Name": "string",
"Operator": "string",
"Values": [ "string" ]
}
],
"MaxResults": number,
"NextToken": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [Filters](#API_ListTasks_RequestSyntax) **
API フィルターを使用して、`ListTasks` によって返されるリソースのリストを絞り込むことができます。たとえば、特定のソースの場所にあるすべてのタスクを取得するには、フィルター名 `LocationId` そして `Operator Equals` 付きの `ListTasks` と場所の ARN を使用できます。
タイプ: [TaskFilter](API_TaskFilter.md) オブジェクトの配列
必須: いいえ
** [MaxResults](#API_ListTasks_RequestSyntax) **
返されるタスクの最大数。
タイプ: 整数
有効範囲: 最小値 は 0 です。最大値は 100 です。
必須: いいえ
** [NextToken](#API_ListTasks_RequestSyntax) **
タスクの次のリストの開始位置を示す不明瞭な文字列。
タイプ: 文字列
長さの制約: 最大長は 65,535 です。
パターン: `[a-zA-Z0-9=_-]+`
必須: いいえ
## レスポンスの構文
```
{
"NextToken": "string",
"Tasks": [
{
"Name": "string",
"Status": "string",
"TaskArn": "string",
"TaskMode": "string"
}
]
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [NextToken](#API_ListTasks_ResponseSyntax) **
タスクの次のリストを返し、開始位置を示す不明瞭な文字列。
タイプ: 文字列
長さの制約: 最大長は 65,535 です。
パターン: `[a-zA-Z0-9=_-]+`
** [Tasks](#API_ListTasks_ResponseSyntax) **
返されるすべてのタスクのリスト。
タイプ: [TaskListEntry](API_TaskListEntry.md) オブジェクトの配列
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/ListTasks)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/ListTasks)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ListTasks)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/ListTasks)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ListTasks)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/ListTasks)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/ListTasks)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/ListTasks)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/ListTasks)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ListTasks)
# StartTaskExecution
AWS DataSync 転送タスクを開始します。各タスクでは、一度に 1 つのタスク実行しか実行できません。
タスク実行には複数のステップがあります。詳細については、「[タスクの実行ステータス](https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#understand-task-execution-statuses)」を参照してください。
**重要**
Amazon S3 ロケーションとの間でデータを転送する予定がある場合は、開始する前に [DataSync が S3 リクエスト料金にどのような影響を与えるか](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests)について、および [DataSync 料金ページ](https://aws.amazon.com/datasync/pricing/)を確認してください。
## リクエストの構文
```
{
"Excludes": [
{
"FilterType": "string",
"Value": "string"
}
],
"Includes": [
{
"FilterType": "string",
"Value": "string"
}
],
"ManifestConfig": {
"Action": "string",
"Format": "string",
"Source": {
"S3": {
"BucketAccessRoleArn": "string",
"ManifestObjectPath": "string",
"ManifestObjectVersionId": "string",
"S3BucketArn": "string"
}
}
},
"OverrideOptions": {
"Atime": "string",
"BytesPerSecond": number,
"Gid": "string",
"LogLevel": "string",
"Mtime": "string",
"ObjectTags": "string",
"OverwriteMode": "string",
"PosixPermissions": "string",
"PreserveDeletedFiles": "string",
"PreserveDevices": "string",
"SecurityDescriptorCopyFlags": "string",
"TaskQueueing": "string",
"TransferMode": "string",
"Uid": "string",
"VerifyMode": "string"
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"TaskArn": "string",
"TaskReportConfig": {
"Destination": {
"S3": {
"BucketAccessRoleArn": "string",
"S3BucketArn": "string",
"Subdirectory": "string"
}
},
"ObjectVersionIds": "string",
"OutputType": "string",
"Overrides": {
"Deleted": {
"ReportLevel": "string"
},
"Skipped": {
"ReportLevel": "string"
},
"Transferred": {
"ReportLevel": "string"
},
"Verified": {
"ReportLevel": "string"
}
},
"ReportLevel": "string"
}
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [Excludes](#API_StartTaskExecution_RequestSyntax) **
タスクから除外するファイルを決定するフィルター規則のリストを指定します。リストには、除外するパターンで構成される 1 つのフィルター文字列が含まれています。パターンは「\$1」(パイプ) で区切られます (例: `"/folder1|/folder2"`)。
タイプ: [FilterRule](API_FilterRule.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。
必須: いいえ
** [Includes](#API_StartTaskExecution_RequestSyntax) **
タスクを実行するときに含めるファイルを決定するフィルター規則のリストを指定します。パターンには、インクルードするパターンで構成される 1 つのフィルター文字列が含まれる必要があります。パターンは「\$1」(パイプ) で区切られます (例: `"/folder1|/folder2"`)。
タイプ: [FilterRule](API_FilterRule.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。
必須: いいえ
** [ManifestConfig](#API_StartTaskExecution_RequestSyntax) **
DataSync が転送するファイルまたはオブジェクトのリストであるマニフェストを設定します。詳細と設定例については、「[Specifying what DataSync transfers by using a manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html)」を参照してください。
このパラメータを使用する場合、発信者 ID (DataSync を使用しているロール) には `iam:PassRole` アクセス許可が必要です。[AWSDataSyncFullAccess](https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess) ポリシーには、このアクセス許可が含まれています。
マニフェスト設定を削除するには、このパラメータを空の値で指定します。
タイプ: [ManifestConfig](API_ManifestConfig.md) オブジェクト
必須: いいえ
** [OverrideOptions](#API_StartTaskExecution_RequestSyntax) **
転送タスクがどのように構成されているかを示します。これらのオプションには、転送中に DataSync がファイル、オブジェクト、および関連するメタデータを処理する方法が含まれます。また、データの整合性の検証方法や、タスクの帯域幅制限の設定方法なども指定できます。
各オプションにはデフォルト値があります。必要な場合を除き、[StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) を呼び出す前にこれらのオプションを設定する必要はありません。
これらのタスクオプションは各タスクを実行するたびにオーバーライドできます。例えば、個々の実行に合わせて `LogLevel` を調整することができます。
タイプ: [Options](API_Options.md) オブジェクト
必須: いいえ
** [Tags](#API_StartTaskExecution_RequestSyntax) **
タスク実行を表す Amazon リソースネーム (ARN) に適用するタグを指定します。
*タグ*は、DataSync リソースの管理、フィルタリング、検索に役立つキーと値のペアです。
タイプ: [TagListEntry](API_TagListEntry.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。
必須: いいえ
** [TaskArn](#API_StartTaskExecution_RequestSyntax) **
開始するタスクの Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:task/task-[0-9a-f]{17}$`
必須: はい
** [TaskReportConfig](#API_StartTaskExecution_RequestSyntax) **
DataSync 転送に関する詳細情報を提供するタスクレポートの構成方法を指定します。詳細については、「[Monitoring your DataSync transfers with task reports](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html)」を参照してください。
このパラメータを使用する場合、発信者 ID (DataSync を使用しているロール) には `iam:PassRole` アクセス許可が必要です。[AWSDataSyncFullAccess](https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess) ポリシーには、このアクセス許可が含まれています。
タスクレポート設定を削除するには、このパラメータを空として指定します。
タイプ: [TaskReportConfig](API_TaskReportConfig.md) オブジェクト
必須: いいえ
## レスポンスの構文
```
{
"TaskExecutionArn": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [TaskExecutionArn](#API_StartTaskExecution_ResponseSyntax) **
進行中のタスク実行の ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$`
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 例
### リクエスト例
次の例では、指定したタスクのデフォルトオプションを使用してタスクの実行を開始します。
```
{
"OverrideOptions": {
"Atime": "BEST_EFFORT",
"BytesPerSecond": 1000,
"Gid": "NONE",
"Mtime": "PRESERVE",
"PosixPermissions": "PRESERVE",
"PreserveDevices": "NONE",
"PreserveDeletedFiles": "PRESERVE",
"Uid": "NONE",
"VerifyMode": "POINT_IN_TIME_CONSISTENT"
},
"TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026"
}
```
### レスポンス例
この例は、StartTaskExecution 使用方法を 1 つ示しています。
```
{
"TaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f"
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/StartTaskExecution)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/StartTaskExecution)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/StartTaskExecution)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/StartTaskExecution)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/StartTaskExecution)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/StartTaskExecution)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/StartTaskExecution)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/StartTaskExecution)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/StartTaskExecution)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/StartTaskExecution)
# TagResource
AWS リソースに*タグ*を適用します。タグは、リソースの管理、フィルタリング、検索に役立つキーと値のペアです。
これには、場所、タスク、タスク実行などの AWS DataSync リソースが含まれます。
## リクエストの構文
```
{
"ResourceArn": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [ResourceArn](#API_TagResource_RequestSyntax) **
タグを適用するリソースの Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:(((agent|task|location)/(agent|task|loc)-[a-z0-9]{17}(/execution/exec-[a-f0-9]{17})?)|(system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?))$`
必須: はい
** [Tags](#API_TagResource_RequestSyntax) **
リソースに適用するタグを指定します。
タイプ: [TagListEntry](API_TagListEntry.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。
必須: はい
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/TagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/TagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/TagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/TagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/TagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/TagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/TagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TagResource)
# UntagResource
AWS リソースからタグを削除します。
## リクエストの構文
```
{
"Keys": [ "string" ],
"ResourceArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [Keys](#API_UntagResource_RequestSyntax) **
削除するタグのキーを指定します。
タイプ: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大数は 50 項目です。
長さの制約: 最小長は 1 です。最大長は 256 です。
パターン: `^[a-zA-Z0-9\s+=._:/-]+$`
必須: はい
** [ResourceArn](#API_UntagResource_RequestSyntax) **
タグを削除するリソースの Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:(((agent|task|location)/(agent|task|loc)-[a-z0-9]{17}(/execution/exec-[a-f0-9]{17})?)|(system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?))$`
必須: はい
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UntagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UntagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UntagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UntagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UntagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UntagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UntagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UntagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UntagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UntagResource)
# UpdateAgent
AWS DataSync エージェントの名前を更新します。
## リクエストの構文
```
{
"AgentArn": "string",
"Name": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [AgentArn](#API_UpdateAgent_RequestSyntax) **
更新するエージェントの Amazon リソースネーム (ARN)。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`
必須: はい
** [Name](#API_UpdateAgent_RequestSyntax) **
エージェントの設定に使用する名前。
タイプ: 文字列
長さの制約: 最小長は 0 です。最大長は 256 です。
パターン: `^[a-zA-Z0-9\s+=._:@/-]+$`
必須: いいえ
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateAgent)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateAgent)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateAgent)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateAgent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateAgent)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateAgent)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateAgent)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateAgent)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateAgent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateAgent)
# UpdateLocationAzureBlob
で使用している Microsoft Azure Blob Storage 転送場所の次の設定を変更します AWS DataSync。
詳細については、「[Configuring transfers with Microsoft Azure Blob Storage](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html)」を参照してください。
## リクエストの構文
```
{
"AccessTier": "string",
"AgentArns": [ "string" ],
"AuthenticationType": "string",
"BlobType": "string",
"CmkSecretConfig": {
"KmsKeyArn": "string",
"SecretArn": "string"
},
"CustomSecretConfig": {
"SecretAccessRoleArn": "string",
"SecretArn": "string"
},
"LocationArn": "string",
"SasConfiguration": {
"Token": "string"
},
"Subdirectory": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [AccessTier](#API_UpdateLocationAzureBlob_RequestSyntax) **
オブジェクトまたはファイルの転送先となるアクセス層を指定します。これは、その場所を転送先として使用する場合にのみ適用されます。詳細については、「[アクセス層](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers)」を参照してください。
タイプ: 文字列
有効な値：`HOT | COOL | ARCHIVE`
必須：いいえ
** [AgentArns](#API_UpdateLocationAzureBlob_RequestSyntax) **
(オプション) Azure Blob Storage コンテナに接続できる DataSync エージェントの Amazon リソースネーム (ARN) を指定します。エージェントレスクロスクラウド転送を設定する場合は、このパラメータの値を指定する必要はありません。
複数のエージェントを指定できます。詳細については、「[複数のエージェントを転送に使用](https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html)」を参照してください。
ストレージの場所を最初に作成した後は、エージェントを追加または削除することはできません。
型: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大 8 項目。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`
必須: いいえ
** [AuthenticationType](#API_UpdateLocationAzureBlob_RequestSyntax) **
DataSync が Azure Blob Storage にアクセスするために使用する認証方法を指定します。DataSync は、共有アクセス署名 (SAS) を使用して blob storage にアクセスできます。
タイプ: 文字列
有効な値：`SAS | NONE`
必須: いいえ
** [BlobType](#API_UpdateLocationAzureBlob_RequestSyntax) **
オブジェクトまたはファイルを Azure Blob Storage に転送するときに使用する BLOB のタイプを指定します。現在、DataSync は、ブロック blobs としての Azure Blob Storage へのデータの移動のみをサポートしています。BLOB のタイプの詳細については、「[Azure Blob Storage のドキュメント](https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs)」を参照してください。
タイプ: 文字列
有効な値：`BLOCK`
必須：いいえ
** [CmkSecretConfig](#API_UpdateLocationAzureBlob_RequestSyntax) **
DataSync が特定の転送場所にアクセスするために使用する認証トークンや認証情報のセットなど、DataSync が管理するシークレットと、カスタマー管理の AWS KMS keyの設定情報を指定します。
型: [CmkSecretConfig](API_CmkSecretConfig.md) オブジェクト
必須: いいえ
** [CustomSecretConfig](#API_UpdateLocationAzureBlob_RequestSyntax) **
DataSync が特定の転送場所にアクセスするために使用する認証トークンや認証情報のセット、シークレットへのアクセスを提供するカスタマーマネージド AWS Identity and Access Management (IAM) ロールなど、カスタマーマネージドシークレットの設定情報を指定します。
型: [CustomSecretConfig](API_CustomSecretConfig.md) オブジェクト
必須: いいえ
** [LocationArn](#API_UpdateLocationAzureBlob_RequestSyntax) **
更新する Azure Blob ストレージの転送場所の ARN を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
** [SasConfiguration](#API_UpdateLocationAzureBlob_RequestSyntax) **
DataSync を Azure Blob Storage にアクセスできるようにする SAS 設定を指定します。
タイプ: [AzureBlobSasConfiguration](API_AzureBlobSasConfiguration.md) オブジェクト
必須: いいえ
** [Subdirectory](#API_UpdateLocationAzureBlob_RequestSyntax) **
転送をコンテナ内の仮想ディレクトリ (例: `/my/images`) に制限する場合は、パスセグメントを指定します。
タイプ: 文字列
長さの制約: 最大長は 1,024 です。
パターン: `^[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}\p{C}]*$`
必須: いいえ
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationAzureBlob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationAzureBlob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationAzureBlob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationAzureBlob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationAzureBlob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationAzureBlob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationAzureBlob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationAzureBlob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationAzureBlob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationAzureBlob)
# UpdateLocationEfs
使用している Amazon EFS 転送場所の次の設定パラメータを変更します AWS DataSync。
詳細については、「[Configuring AWS DataSync transfers with Amazon EFS](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html)」を参照してください。
## リクエストの構文
```
{
"AccessPointArn": "string",
"FileSystemAccessRoleArn": "string",
"InTransitEncryption": "string",
"LocationArn": "string",
"Subdirectory": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [AccessPointArn](#API_UpdateLocationEfs_RequestSyntax) **
DataSync が Amazon EFS ファイルシステムにアクセスするために使用するアクセスポイントの Amazon リソースネーム (ARN) を指定します。
詳細については、「[Accessing restricted file systems](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam)」を参照してください。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `(^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):elasticfilesystem:[a-z\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$)|(^$)`
必須: いいえ
** [FileSystemAccessRoleArn](#API_UpdateLocationEfs_RequestSyntax) **
DataSync が Amazon EFS ファイルシステムにアクセスできるようにする AWS Identity and Access Management (IAM) ロールを指定します。
このロールの作成については、「[Creating a DataSync IAM role for file system access](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role)」を参照してください。
タイプ: 文字列
長さの制約: 最大長は 2,048 です。
パターン: `(^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$)|(^$)`
必須: いいえ
** [InTransitEncryption](#API_UpdateLocationEfs_RequestSyntax) **
DataSync が Amazon EFS ファイルシステムとの間でデータを転送するときに、Transport Layer Security (TLS) 1.2 暗号化を使用するかどうかを指定します。
`AccessPointArn` または `FileSystemAccessRoleArn` を使用した IAM ロールを使用してアクセスポイントを指定する場合、このパラメータを `TLS1_2` に設定する必要があります。
タイプ: 文字列
有効な値：`NONE | TLS1_2`
必須：いいえ
** [LocationArn](#API_UpdateLocationEfs_RequestSyntax) **
更新する Amazon EFS 転送場所の Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
** [Subdirectory](#API_UpdateLocationEfs_RequestSyntax) **
Amazon EFS ファイルシステムのマウントパスを指定します。これは、DataSync がファイルシステム上のデータの読み取りまたは書き込み (送信元の場所か送信先の場所かによって異なります) を行う場所です。
デフォルトで、DataSync はルートディレクトリ (または `AccessPointArn` を使用して指定する[アクセスポイント](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html)) を使用します。フォワードスラッシュ (例: `/path/to/folder`) を使用してサブディレクトリを含めることもできます。
タイプ: 文字列
長さの制約: 最大長は 4,096 です。
パターン: `^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$`
必須: いいえ
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationEfs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationEfs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationEfs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationEfs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationEfs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationEfs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationEfs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationEfs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationEfs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationEfs)
# UpdateLocationFsxLustre
で使用している Amazon FSx for Lustre 転送場所の次の設定パラメータを変更します AWS DataSync。
詳細については、「[Configuring DataSync transfers with FSx for Lustre](https://docs.aws.amazon.com/datasync/latest/userguide/create-lustre-location.html)」を参照してください。
## リクエストの構文
```
{
"LocationArn": "string",
"Subdirectory": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [LocationArn](#API_UpdateLocationFsxLustre_RequestSyntax) **
更新する FSx for Lustre 転送場所の Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
** [Subdirectory](#API_UpdateLocationFsxLustre_RequestSyntax) **
FSx for Lustre ファイルシステムのマウントパスを指定します。パスにはサブディレクトリを含めることができます。
場所が送信元として使用される場合、DataSync はマウントパスからデータを読み込みます。場所が送信先として使用される場合、DataSync はデータをマウントパスに書き込みます。このパラメータを含めない場合、DataSync はファイルシステムのルートディレクトリ (`/`) を使用します。
タイプ: 文字列
長さの制約: 最大長は 4,096 です。
パターン: `^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$`
必須: いいえ
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationFsxLustre)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationFsxLustre)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationFsxLustre)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationFsxLustre)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationFsxLustre)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationFsxLustre)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationFsxLustre)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationFsxLustre)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationFsxLustre)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationFsxLustre)
# UpdateLocationFsxOntap
で使用している Amazon FSx for NetApp ONTAP 転送場所の次の設定パラメータを変更します AWS DataSync。
詳細については、「[Configuring transfers with Amazon FSx for NetApp ONTAP](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html)」を参照してください。
## リクエストの構文
```
{
"LocationArn": "string",
"Protocol": {
"NFS": {
"MountOptions": {
"Version": "string"
}
},
"SMB": {
"CmkSecretConfig": {
"KmsKeyArn": "string",
"SecretArn": "string"
},
"CustomSecretConfig": {
"SecretAccessRoleArn": "string",
"SecretArn": "string"
},
"Domain": "string",
"MountOptions": {
"Version": "string"
},
"Password": "string",
"User": "string"
}
},
"Subdirectory": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [LocationArn](#API_UpdateLocationFsxOntap_RequestSyntax) **
更新する FSx for ONTAP 転送場所の Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
** [Protocol](#API_UpdateLocationFsxOntap_RequestSyntax) **
DataSync が Amazon FSx ファイルシステムにアクセスするために使用するデータ転送プロトコルを指定します。
型: [FsxUpdateProtocol](API_FsxUpdateProtocol.md) オブジェクト
必須: いいえ
** [Subdirectory](#API_UpdateLocationFsxOntap_RequestSyntax) **
データの転送先または転送元となるストレージ仮想マシン (SVM) のファイル共有へのパスを指定します。
ジャンクションパス (マウントポイントとも呼ばれます)、qtree パス (NFS ファイル共有用)、または共有名 (SMB ファイル共有用) を指定できます。例えば、マウントパスは `/vol1`、`/vol1/tree1`、または `/share1` かもしれません。
SVM のルートボリューム内にはジャンクションパスを指定しないでください。詳細については、「*Amazon FSx for NetApp ONTAP ユーザーガイド*」の「[Managing FSx for ONTAP storage virtual machines](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html)」を参照してください。
タイプ: 文字列
長さの制約: 最大長は 255 です。
パターン: `^[^\u0000\u0085\u2028\u2029\r\n]{1,255}$`
必須: いいえ
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationFsxOntap)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationFsxOntap)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationFsxOntap)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationFsxOntap)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationFsxOntap)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationFsxOntap)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationFsxOntap)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationFsxOntap)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationFsxOntap)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationFsxOntap)
# UpdateLocationFsxOpenZfs
で使用している Amazon FSx for OpenZFS 転送場所の次の設定パラメータを変更します AWS DataSync。
詳細については、「[Configuring DataSync transfers with Amazon FSx for OpenZFS](https://docs.aws.amazon.com/datasync/latest/userguide/create-openzfs-location.html)」を参照してください。
**注記**
`SMB` に関連するリクエストパラメータは `UpdateLocationFsxOpenZfs` オペレーションではサポートされていません。
## リクエストの構文
```
{
"LocationArn": "string",
"Protocol": {
"NFS": {
"MountOptions": {
"Version": "string"
}
},
"SMB": {
"CmkSecretConfig": {
"KmsKeyArn": "string",
"SecretArn": "string"
},
"CustomSecretConfig": {
"SecretAccessRoleArn": "string",
"SecretArn": "string"
},
"Domain": "string",
"ManagedSecretConfig": {
"SecretArn": "string"
},
"MountOptions": {
"Version": "string"
},
"Password": "string",
"User": "string"
}
},
"Subdirectory": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [LocationArn](#API_UpdateLocationFsxOpenZfs_RequestSyntax) **
更新する FSx for OpenZFS 転送場所の Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
** [Protocol](#API_UpdateLocationFsxOpenZfs_RequestSyntax) **
AWS DataSync が Amazon FSx ファイルシステムにアクセスするために使用するデータ転送プロトコルを指定します。
型: [FsxProtocol](API_FsxProtocol.md) オブジェクト
必須: いいえ
** [Subdirectory](#API_UpdateLocationFsxOpenZfs_RequestSyntax) **
`/fsx` で始まる必要がある場所のパス内のサブディレクトリを指定します。DataSync は、このサブディレクトリを使用してデータを読み書きします (ファイルシステムがソースまたは送信先の場所であるかどうかに応じて)。
タイプ: 文字列
長さの制約: 最大長は 4,096 です。
パターン: `^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$`
必須: いいえ
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationFsxOpenZfs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationFsxOpenZfs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationFsxOpenZfs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationFsxOpenZfs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationFsxOpenZfs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationFsxOpenZfs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationFsxOpenZfs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationFsxOpenZfs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationFsxOpenZfs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationFsxOpenZfs)
# UpdateLocationFsxWindows
で使用している Amazon FSx for Windows File Server 転送場所の次の設定パラメータを変更します AWS DataSync。
詳細については、「[Configuring transfers with FSx for Windows File Server](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html)」を参照してください。
## リクエストの構文
```
{
"CmkSecretConfig": {
"KmsKeyArn": "string",
"SecretArn": "string"
},
"CustomSecretConfig": {
"SecretAccessRoleArn": "string",
"SecretArn": "string"
},
"Domain": "string",
"LocationArn": "string",
"Password": "string",
"Subdirectory": "string",
"User": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [CmkSecretConfig](#API_UpdateLocationFsxWindows_RequestSyntax) **
DataSync が特定の転送場所へのアクセスに使用する `Password`または認証情報のセット、およびカスタマーマネージドなど、DataSync が管理するシークレットの設定情報を指定します AWS KMS key。
型: [CmkSecretConfig](API_CmkSecretConfig.md) オブジェクト
必須: いいえ
** [CustomSecretConfig](#API_UpdateLocationFsxWindows_RequestSyntax) **
DataSync が特定の転送場所にアクセスするために使用する `Password`または一連の認証情報、およびシークレットへのアクセスを提供するカスタマーマネージド AWS Identity and Access Management (IAM) ロールなど、カスタマーマネージドシークレットの設定情報を指定します。
型: [CustomSecretConfig](API_CustomSecretConfig.md) オブジェクト
必須: いいえ
** [Domain](#API_UpdateLocationFsxWindows_RequestSyntax) **
FSx for Windows ファイルサーバーシステムが属する Windows ドメインの名前を指定します。
環境内に複数の Active Directory ドメインがある場合、このパラメータを設定することで、DataSync が適切なファイルシステムに接続できるようになります。
タイプ: 文字列
長さの制約: 最大長は 253 です。
パターン: `^([A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252})?$`
必須: いいえ
** [LocationArn](#API_UpdateLocationFsxWindows_RequestSyntax) **
更新する FSx for Windows File Server 転送場所の ARN を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
** [Password](#API_UpdateLocationFsxWindows_RequestSyntax) **
FSx for Windows File Server ファイルシステム内のファイル、フォルダ、ファイルメタデータをマウントしてアクセスできるアクセス許可を持つユーザーのパスワードを指定します。
タイプ: 文字列
長さの制約: 最大長は 104 です。
パターン: `^.{0,104}$`
必須: いいえ
** [Subdirectory](#API_UpdateLocationFsxWindows_RequestSyntax) **
スラッシュを使用して、ファイルシステムのマウントパスを指定します。DataSync は、このサブディレクトリを使用してデータを読み書きします (ファイルシステムがソースまたは送信先の場所であるかどうかに応じて)。
タイプ: 文字列
長さの制約: 最大長は 4,096 です。
パターン: `^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$`
必須: いいえ
** [User](#API_UpdateLocationFsxWindows_RequestSyntax) **
FSx for Windows File Server ファイルシステム内のファイル、フォルダ、ファイルメタデータをマウントしてアクセスできるアクセス許可を持つユーザーを指定します。
転送に適したアクセスレベルのユーザーを選択する方法については、FSx for Windows File Server の場所に「[required permissions](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions)」を参照してください。
タイプ: 文字列
長さの制約: 最大長は 104 です。
パターン: `^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$`
必須: いいえ
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationFsxWindows)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationFsxWindows)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationFsxWindows)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationFsxWindows)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationFsxWindows)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationFsxWindows)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationFsxWindows)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationFsxWindows)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationFsxWindows)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationFsxWindows)
# UpdateLocationHdfs
使用している Hadoop Distributed File System (HDFS) 転送場所の次の設定パラメータを変更します AWS DataSync。
詳細については、「[Configuring AWS DataSync transfers with an HDFS cluster](https://docs.aws.amazon.com/datasync/latest/userguide/create-hdfs-location.html)」を参照してください。
## リクエストの構文
```
{
"AgentArns": [ "string" ],
"AuthenticationType": "string",
"BlockSize": number,
"CmkSecretConfig": {
"KmsKeyArn": "string",
"SecretArn": "string"
},
"CustomSecretConfig": {
"SecretAccessRoleArn": "string",
"SecretArn": "string"
},
"KerberosKeytab": blob,
"KerberosKrb5Conf": blob,
"KerberosPrincipal": "string",
"KmsKeyProviderUri": "string",
"LocationArn": "string",
"NameNodes": [
{
"Hostname": "string",
"Port": number
}
],
"QopConfiguration": {
"DataTransferProtection": "string",
"RpcProtection": "string"
},
"ReplicationFactor": number,
"SimpleUser": "string",
"Subdirectory": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [AgentArns](#API_UpdateLocationHdfs_RequestSyntax) **
HDFS クラスターに接続できる DataSync エージェントの Amazon リソースネーム (ARN)。
タイプ: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大 8 項目。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`
必須: いいえ
** [AuthenticationType](#API_UpdateLocationHdfs_RequestSyntax) **
ユーザーの ID を決定するために使用される認証のタイプ。
タイプ: 文字列
有効な値：`SIMPLE | KERBEROS`
必須: いいえ
** [BlockSize](#API_UpdateLocationHdfs_RequestSyntax) **
HDFS クラスターに書き込むデータブロックのサイズ。
タイプ: 整数
有効範囲: 最小値 は 1,048,576 です。最大値は 1,073,741,824 です。
必須: いいえ
** [CmkSecretConfig](#API_UpdateLocationHdfs_RequestSyntax) **
DataSync が特定の転送場所へのアクセスに使用する `KerberosKeytab`または認証情報のセット、およびカスタマーマネージドなど、DataSync が管理するシークレットの設定情報を指定します AWS KMS key。
型: [CmkSecretConfig](API_CmkSecretConfig.md) オブジェクト
必須: いいえ
** [CustomSecretConfig](#API_UpdateLocationHdfs_RequestSyntax) **
DataSync が特定の転送場所にアクセスするために使用する `KerberosKeytab`または一連の認証情報、およびシークレットへのアクセスを提供するカスタマーマネージド AWS Identity and Access Management (IAM) ロールなど、カスタマーマネージドシークレットの設定情報を指定します。
型: [CustomSecretConfig](API_CustomSecretConfig.md) オブジェクト
必須: いいえ
** [KerberosKeytab](#API_UpdateLocationHdfs_RequestSyntax) **
定義された Kerberos プリンシパルと暗号化キー間のマッピングを含む Kerberos キーテーブル (キータブ)。ファイルのアドレスを指定して、ファイルからキータブをロードできます。
タイプ: Base64 でエンコードされたバイナリデータオブジェクト
長さの制約: 最大長は 65,536 です。
必須: いいえ
** [KerberosKrb5Conf](#API_UpdateLocationHdfs_RequestSyntax) **
Kerberos 構成情報を含む `krb5.conf` ファイル。ファイルのアドレスを指定して、`krb5.conf` ファイルをロードできます。 AWS CLIを使用している場合は、base64 エンコードが実行されます。それ以外の場合は、base64 でエンコードされたテキストを指定します。
タイプ: Base64 でエンコードされたバイナリデータオブジェクト
長さの制約: 最大長は 131,072 です。
必須: いいえ
** [KerberosPrincipal](#API_UpdateLocationHdfs_RequestSyntax) **
HDFS クラスター上のファイルとフォルダーへのアクセス権を持つ Kerberos プリンシパル。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 256 です。
パターン: `^.+$`
必須: いいえ
** [KmsKeyProviderUri](#API_UpdateLocationHdfs_RequestSyntax) **
HDFS クラスターのキー管理サーバー (KMS) の URI。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 255 です。
パターン: `^kms:\/\/http[s]?@(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])(;(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9]))*:[0-9]{1,5}\/kms$`
必須: いいえ
** [LocationArn](#API_UpdateLocationHdfs_RequestSyntax) **
ソース HDFS クラスターの場所の Amazon リソースネーム (ARN)。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
** [NameNodes](#API_UpdateLocationHdfs_RequestSyntax) **
HDFS 名前空間を管理する NameNode。NameNode は、ファイルやディレクトリのオープン、クローズ、名前の変更などの操作を実行します。NameNode には、データのブロックを DataNode にマップするための情報が含まれています。NameNode は 1 つのみを使用できます。
タイプ: [HdfsNameNode](API_HdfsNameNode.md) オブジェクトの配列
配列メンバー: 最小数は 1 項目です。
必須: いいえ
** [QopConfiguration](#API_UpdateLocationHdfs_RequestSyntax) **
保護の品質 (QOP) 設定では、Hadoop Distributed File System (HDFS) クラスターで構成されたリモートプロシージャコール (RPC) とデータ転送のプライバシー設定を指定します。
タイプ: [QopConfiguration](API_QopConfiguration.md) オブジェクト
必須: いいえ
** [ReplicationFactor](#API_UpdateLocationHdfs_RequestSyntax) **
HDFS クラスターへの書き込み時にデータをレプリケートする DataNode の数。
タイプ: 整数
有効範囲: 最小値 は 1 です。最大値は 512 です。
必須: いいえ
** [SimpleUser](#API_UpdateLocationHdfs_RequestSyntax) **
ホストオペレーティングシステム上のクライアントを識別するために使用されるユーザー名。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 256 です。
パターン: `^[_.A-Za-z0-9][-_.A-Za-z0-9]*$`
必須: いいえ
** [Subdirectory](#API_UpdateLocationHdfs_RequestSyntax) **
HDFS クラスター内のサブディレクトリ。このサブディレクトリは、HDFS クラスターからデータを読み取り、または HDFS クラスターにデータを書き込むために使用されます。
タイプ: 文字列
長さの制約: 最大長は 4,096 です。
パターン: `^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$`
必須: いいえ
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationHdfs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationHdfs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationHdfs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationHdfs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationHdfs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationHdfs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationHdfs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationHdfs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationHdfs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationHdfs)
# UpdateLocationNfs
で使用しているネットワークファイルシステム (NFS) 転送場所の次の設定パラメータを変更します AWS DataSync。
詳細については、「[Configuring AWS DataSync transfers with an NFS file server](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html)」を参照してください。
## リクエストの構文
```
{
"LocationArn": "string",
"MountOptions": {
"Version": "string"
},
"OnPremConfig": {
"AgentArns": [ "string" ]
},
"ServerHostname": "string",
"Subdirectory": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [LocationArn](#API_UpdateLocationNfs_RequestSyntax) **
更新する NFS 転送場所の Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
** [MountOptions](#API_UpdateLocationNfs_RequestSyntax) **
DataSync が NFS プロトコルを使用して場所にアクセスする方法を指定します。
タイプ: [NfsMountOptions](API_NfsMountOptions.md) オブジェクト
必須: いいえ
** [OnPremConfig](#API_UpdateLocationNfs_RequestSyntax) **
Network File System (NFS) ファイルサーバーに接続できる AWS DataSync エージェント。
型: [OnPremConfig](API_OnPremConfig.md) オブジェクト
必須: いいえ
** [ServerHostname](#API_UpdateLocationNfs_RequestSyntax) **
DataSync エージェントが接続する NFS ファイルサーバーの DNS 名または IP アドレス (IPv4 または IPv6) を指定します。
タイプ: 文字列
長さの制約: 最大長は 255 です。
パターン: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$`
必須: いいえ
** [Subdirectory](#API_UpdateLocationNfs_RequestSyntax) **
DataSync がマウントする NFS ファイルサーバーのエクスポートパスを指定します。
このパス (またはパスのサブディレクトリ) は、DataSync のデータ転送先または転送元となる場所です。DataSync のエクスポートの構成については、「[NFS ファイルサーバーへのアクセス](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs)」を参照してください。
タイプ: 文字列
長さの制約: 最大長は 4,096 です。
パターン: `^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]+$`
必須: いいえ
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationNfs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationNfs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationNfs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationNfs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationNfs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationNfs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationNfs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationNfs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationNfs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationNfs)
# UpdateLocationObjectStorage
で使用しているオブジェクトストレージ転送場所の次の設定パラメータを変更します AWS DataSync。
詳細については、「[Configuring DataSync transfers with an object storage system](https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html)」を参照してください。
## リクエストの構文
```
{
"AccessKey": "string",
"AgentArns": [ "string" ],
"CmkSecretConfig": {
"KmsKeyArn": "string",
"SecretArn": "string"
},
"CustomSecretConfig": {
"SecretAccessRoleArn": "string",
"SecretArn": "string"
},
"LocationArn": "string",
"SecretKey": "string",
"ServerCertificate": blob,
"ServerHostname": "string",
"ServerPort": number,
"ServerProtocol": "string",
"Subdirectory": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [AccessKey](#API_UpdateLocationObjectStorage_RequestSyntax) **
オブジェクトストレージサーバーとの認証に認証情報が必要な場合、アクセスキー (ユーザー名など) を指定します。
タイプ: 文字列
長さの制約: 最小長は 0 です。最大長は 200 です。
パターン: `^.*$`
必須: いいえ
** [AgentArns](#API_UpdateLocationObjectStorage_RequestSyntax) **
(オプション) オブジェクトストレージシステムに接続できる DataSync エージェントの Amazon リソースネーム (ARN) を指定します。エージェントレスクロスクラウド転送を設定する場合は、このパラメータの値を指定する必要はありません。
ストレージの場所を最初に作成した後は、エージェントを追加または削除することはできません。
型: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大 8 項目。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`
必須: いいえ
** [CmkSecretConfig](#API_UpdateLocationObjectStorage_RequestSyntax) **
DataSync が特定の転送場所にアクセスするために使用する認証トークンや認証情報のセットなど、DataSync が管理するシークレットと、カスタマー管理の AWS KMS keyの設定情報を指定します。
型: [CmkSecretConfig](API_CmkSecretConfig.md) オブジェクト
必須: いいえ
** [CustomSecretConfig](#API_UpdateLocationObjectStorage_RequestSyntax) **
DataSync が特定の転送場所にアクセスするために使用する認証トークンや認証情報のセット、シークレットへのアクセスを提供するカスタマーマネージド AWS Identity and Access Management (IAM) ロールなど、カスタマーマネージドシークレットの設定情報を指定します。
型: [CustomSecretConfig](API_CustomSecretConfig.md) オブジェクト
必須: いいえ
** [LocationArn](#API_UpdateLocationObjectStorage_RequestSyntax) **
更新するオブジェクトストレージシステムの場所の ARN を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
** [SecretKey](#API_UpdateLocationObjectStorage_RequestSyntax) **
オブジェクトストレージサーバーとの認証に認証情報が必要な場合、秘密鍵 (パスワードなど) を指定します。
を使用してシークレットを指定し`SecretKey`、 `CmkSecretConfig`または を使用してシークレット設定の詳細を指定しない場合`CustomSecretConfig`、DataSync は AWS アカウントの Secrets Manager シークレットを使用してトークンを保存します。
タイプ: 文字列
長さの制約: 最小長は 0 です。最大長は 200 です。
パターン: `^.*$`
必須: いいえ
** [ServerCertificate](#API_UpdateLocationObjectStorage_RequestSyntax) **
オブジェクトストレージシステムがプライベートまたは自己署名の認証機関 (CA) を使用する場合、DataSync がそのシステムで認証するための証明書チェーンを指定します。完全な証明書チェーンを持つ `.pem` ファイルを 1 つ指定する必要があります (例: `file:///home/user/.ssh/object_storage_certificates.pem`)。
証明書チェーンには以下が含まれます。
+ オブジェクトストレージシステムの証明書
+ すべての中間証明書 (存在する場合)
+ 署名 CA のルート証明書
証明書を `.pem` ファイルに連結できます (base64 エンコーディングの前は最大 32,768 バイトまで可能)。次の `cat` コマンド例では、3 つの証明書を含む `object_storage_certificates.pem` ファイルを作成します。
`cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem`
このパラメータを使用するには、`ServerProtocol` を `HTTPS` に構成します。
このパラメータの更新によって、進行中のタスクが妨げられることはありません。
タイプ: Base64 でエンコードされたバイナリデータオブジェクト
長さの制約: 最大長は 32,768 です。
必須: いいえ
** [ServerHostname](#API_UpdateLocationObjectStorage_RequestSyntax) **
DataSync エージェントが接続するオブジェクトストレージサーバーのドメイン名または IP アドレス (IPv4 または IPv6) を指定します。
タイプ: 文字列
長さの制約: 最大長は 255 です。
パターン: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$`
必須: いいえ
** [ServerPort](#API_UpdateLocationObjectStorage_RequestSyntax) **
オブジェクトストレージサーバーがインバウンドネットワークトラフィックを受け入れるポート (ポート 443 など) を指定します。
タイプ: 整数
有効範囲: 最小値 は 1 です。最大値は 65,536 です。
必須: いいえ
** [ServerProtocol](#API_UpdateLocationObjectStorage_RequestSyntax) **
オブジェクトストレージサーバーが通信に使用するプロトコルを指定します。
タイプ: 文字列
有効な値：`HTTPS | HTTP`
必須: いいえ
** [Subdirectory](#API_UpdateLocationObjectStorage_RequestSyntax) **
オブジェクトストレージサーバーのオブジェクトプレフィックスを指定します。これがソースの場所である場合、DataSync はこのプレフィックスを持つオブジェクトのみをコピーします。これが送信先の場所である場合、DataSync は、このプレフィックスを持つすべてのオブジェクトを書き込みます。
タイプ: 文字列
長さの制約: 最大長は 4,096 です。
パターン: `^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$`
必須: いいえ
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationObjectStorage)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationObjectStorage)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationObjectStorage)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationObjectStorage)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationObjectStorage)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationObjectStorage)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationObjectStorage)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationObjectStorage)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationObjectStorage)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationObjectStorage)
# UpdateLocationS3
使用している Amazon S3 転送場所の次の設定パラメータを変更します AWS DataSync。
**重要**
始める前に、次のトピックをお読みください。
[Amazon S3 場所のストレージクラスに関する考慮事項](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes)
[DataSync を使用する場合の S3 リクエストコストの評価](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests)
## リクエストの構文
```
{
"LocationArn": "string",
"S3Config": {
"BucketAccessRoleArn": "string"
},
"S3StorageClass": "string",
"Subdirectory": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [LocationArn](#API_UpdateLocationS3_RequestSyntax) **
更新する Amazon S3 転送場所の Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
** [S3Config](#API_UpdateLocationS3_RequestSyntax) **
DataSync が S3 バケットにアクセスするために使用する AWS Identity and Access Management (IAM) ロールの Amazon リソースネーム (ARN) を指定します。
詳細については、「[Providing DataSync access to S3 buckets](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access)」を参照してください。
型: [S3Config](API_S3Config.md) オブジェクト
必須: いいえ
** [S3StorageClass](#API_UpdateLocationS3_RequestSyntax) **
Amazon S3 が転送先である場合にオブジェクトで使用するストレージクラスを指定します。
のバケットの場合 AWS リージョン、ストレージクラスはデフォルトで になります`STANDARD`。上のバケットの場合 AWS Outposts、ストレージクラスはデフォルトで になります`OUTPOSTS`。
詳細については、「[Storage class considerations with Amazon S3 transfers](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes)」を参照してください。
タイプ: 文字列
有効な値：`STANDARD | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_INSTANT_RETRIEVAL`
必須: いいえ
** [Subdirectory](#API_UpdateLocationS3_RequestSyntax) **
DataSync が読み書きする S3 バケットのプレフィックスを指定します (バケットがソースまたは送信先の場所であるかどうかに応じて)。
DataSync は、スラッシュ (`/`) で始まるプレフィックス、または `//`、`/./`、または `/../` パターンを含むプレフィックスを持つオブジェクトを転送できません。例えば、次のようになります。
+ `/photos`
+ `photos//2006/January`
+ `photos/./2006/February`
+ `photos/../2006/March`
タイプ: 文字列
長さの制約: 最大長は 4,096 です。
パターン: `^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$`
必須: いいえ
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationS3)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationS3)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationS3)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationS3)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationS3)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationS3)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationS3)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationS3)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationS3)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationS3)
# UpdateLocationSmb
で使用しているサーバーメッセージブロック (SMB) 転送場所の次の設定パラメータを変更します AWS DataSync。
詳細については、「[Configuring AWS DataSync transfers with an SMB file server](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html)」を参照してください。
## リクエストの構文
```
{
"AgentArns": [ "string" ],
"AuthenticationType": "string",
"CmkSecretConfig": {
"KmsKeyArn": "string",
"SecretArn": "string"
},
"CustomSecretConfig": {
"SecretAccessRoleArn": "string",
"SecretArn": "string"
},
"DnsIpAddresses": [ "string" ],
"Domain": "string",
"KerberosKeytab": blob,
"KerberosKrb5Conf": blob,
"KerberosPrincipal": "string",
"LocationArn": "string",
"MountOptions": {
"Version": "string"
},
"Password": "string",
"ServerHostname": "string",
"Subdirectory": "string",
"User": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [AgentArns](#API_UpdateLocationSmb_RequestSyntax) **
SMB ファイルサーバーに接続可能な DataSync エージェント (1 つまたは複数) を指定します。エージェントは、Amazon リソースネーム (ARN) を使用して指定します。
タイプ: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大 8 項目。
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`
必須: いいえ
** [AuthenticationType](#API_UpdateLocationSmb_RequestSyntax) **
DataSync が SMB ファイルサーバーへの接続に使用する認証プロトコルを指定します。DataSync は `NTLM` (デフォルト) と `KERBEROS` 認証をサポートしています。
詳細については、「[Providing DataSync access to SMB file servers](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)」を参照してください。
型: 文字列
有効な値：`NTLM | KERBEROS`
必須：いいえ
** [CmkSecretConfig](#API_UpdateLocationSmb_RequestSyntax) **
DataSync が特定の転送場所へのアクセスに使用する `Password``KerberosKeytab`または 認証情報のセット、およびカスタマーマネージドなど、DataSync が管理するシークレットの設定情報を指定します AWS KMS key。
型: [CmkSecretConfig](API_CmkSecretConfig.md) オブジェクト
必須: いいえ
** [CustomSecretConfig](#API_UpdateLocationSmb_RequestSyntax) **
DataSync が特定の転送場所にアクセスするために使用する `Password``KerberosKeytab`または 認証情報のセット、およびシークレットへのアクセスを提供するカスタマーマネージド AWS Identity and Access Management (IAM) ロールなど、カスタマーマネージドシークレットの設定情報を指定します。
型: [CustomSecretConfig](API_CustomSecretConfig.md) オブジェクト
必須: いいえ
** [DnsIpAddresses](#API_UpdateLocationSmb_RequestSyntax) **
SMB ファイルサーバーが属する DNS サーバーの IP アドレス (IPv4 または IPv6) を指定します。このパラメータは、`AuthenticationType` が `KERBEROS` に設定されている場合にのみ適用されます。
環境内に複数のドメインがある場合、このパラメータを構成することで、DataSync が適切な SMB ファイルサーバーに接続できるようになります。
型: 文字列の配列
配列メンバー: 最大数は 2 項目です。
長さの制限: 最小長は 7 です。最大長は 39 です。
パターン: `\A((25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6}))\z`
必須: いいえ
** [Domain](#API_UpdateLocationSmb_RequestSyntax) **
SMB ファイルサーバーが属する Windows ドメイン名を指定します。このパラメータは、`AuthenticationType` が `NTLM` に設定されている場合にのみ適用されます。
環境内に複数のドメインがある場合、このパラメータを構成することで、DataSync が適切なファイルサーバーに接続できるようになります。
タイプ: 文字列
長さの制約: 最大長は 253 です。
パターン: `^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$`
必須: いいえ
** [KerberosKeytab](#API_UpdateLocationSmb_RequestSyntax) **
Kerberos キーテーブル (keytab) ファイルを指定します。これには、Kerberos プリンシパルと暗号化キー間のマッピングが含まれます。
タスク実行エラーを回避するには、キータブファイルの作成に使用する Kerberos プリンシパルが、`KerberosPrincipal` に指定した内容と正確に一致していることを確認します。
タイプ: Base64 でエンコードされたバイナリデータオブジェクト
長さの制約: 最大長は 65,536 です。
必須: いいえ
** [KerberosKrb5Conf](#API_UpdateLocationSmb_RequestSyntax) **
Kerberos 領域設定を定義する Kerberos 設定ファイル (`krb5.conf`) を指定します。
ファイルは base64 でエンコードされている必要があります。を使用している場合は AWS CLI、エンコードが自動的に行われます。
タイプ: Base64 でエンコードされたバイナリデータオブジェクト
長さの制約: 最大長は 131,072 です。
必須: いいえ
** [KerberosPrincipal](#API_UpdateLocationSmb_RequestSyntax) **
Kerberos プリンシパルを指定します。これは、SMB ファイルサーバーのファイル、フォルダ、ファイルメタデータにアクセスする権限を持つ Kerberos 領域内の ID です。
Kerberos プリンシパルは `HOST/kerberosuser@MYDOMAIN.ORG` のようになります。
プリンシパル名では大文字と小文字が区別されます。このパラメータに指定したプリンシパルが、キータブファイルの作成に使用するプリンシパルと完全に一致しない場合、DataSync タスク実行は失敗します。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 256 です。
パターン: `^.+$`
必須: いいえ
** [LocationArn](#API_UpdateLocationSmb_RequestSyntax) **
更新する SMB の場所の ARN を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`
必須: はい
** [MountOptions](#API_UpdateLocationSmb_RequestSyntax) **
が SMB ファイルサーバーにアクセス AWS DataSync するために使用するサーバーメッセージブロック (SMB) プロトコルのバージョンを指定します。
型: [SmbMountOptions](API_SmbMountOptions.md) オブジェクト
必須: いいえ
** [Password](#API_UpdateLocationSmb_RequestSyntax) **
SMB ファイルサーバーをマウントでき、転送するファイルとフォルダにアクセスできるユーザーのパスワード。このパラメータは、`AuthenticationType` が `NTLM` に設定されている場合にのみ適用されます。
タイプ: 文字列
長さの制約: 最大長は 104 です。
パターン: `^.{0,104}$`
必須: いいえ
** [ServerHostname](#API_UpdateLocationSmb_RequestSyntax) **
DataSync エージェントが接続する SMB ファイルサーバーのドメイン名または IP アドレス (IPv4 または IPv6) を指定します。
Kerberos 認証を使用している場合は、ドメイン名を指定する必要があります。
タイプ: 文字列
長さの制約: 最大長は 255 です。
パターン: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$`
必須: いいえ
** [Subdirectory](#API_UpdateLocationSmb_RequestSyntax) **
DataSync がデータを読み書記する SMB ファイルサーバーによってエクスポートされる共有の名前を指定します。共有パスにはサブディレクトリ (例: `/path/to/subdirectory`) を含めることができます。ネットワーク内の他の SMB クライアントもこのパスをマウントできることを確認してください。
指定したサブディレクトリ内のすべてのデータをコピーするには、DataSync が SMB 共有をマウントして、そのすべてのデータにアクセスできる必要があります。詳細については、「[Providing DataSync access to SMB file servers](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)」を参照してください。
タイプ: 文字列
長さの制約: 最大長は 4,096 です。
パターン: `^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$`
必須: いいえ
** [User](#API_UpdateLocationSmb_RequestSyntax) **
SMB ファイルサーバーをマウントでき、転送に関係するファイルやフォルダにアクセスする権限を持つユーザー名を指定します。このパラメータは、`AuthenticationType` が `NTLM` に設定されている場合にのみ適用されます。
転送に適したアクセスレベルを持つユーザーを選択する方法については、「[Providing DataSync access to SMB file servers](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)」を参照してください。
タイプ: 文字列
長さの制約: 最大長は 104 です。
パターン: `^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$`
必須: いいえ
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationSmb)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationSmb)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationSmb)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationSmb)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationSmb)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationSmb)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationSmb)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationSmb)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationSmb)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationSmb)
# UpdateTask
*タスク*の設定を更新し、 AWS DataSync がデータを転送する場所と方法を定義します。
## リクエストの構文
```
{
"CloudWatchLogGroupArn": "string",
"Excludes": [
{
"FilterType": "string",
"Value": "string"
}
],
"Includes": [
{
"FilterType": "string",
"Value": "string"
}
],
"ManifestConfig": {
"Action": "string",
"Format": "string",
"Source": {
"S3": {
"BucketAccessRoleArn": "string",
"ManifestObjectPath": "string",
"ManifestObjectVersionId": "string",
"S3BucketArn": "string"
}
}
},
"Name": "string",
"Options": {
"Atime": "string",
"BytesPerSecond": number,
"Gid": "string",
"LogLevel": "string",
"Mtime": "string",
"ObjectTags": "string",
"OverwriteMode": "string",
"PosixPermissions": "string",
"PreserveDeletedFiles": "string",
"PreserveDevices": "string",
"SecurityDescriptorCopyFlags": "string",
"TaskQueueing": "string",
"TransferMode": "string",
"Uid": "string",
"VerifyMode": "string"
},
"Schedule": {
"ScheduleExpression": "string",
"Status": "string"
},
"TaskArn": "string",
"TaskReportConfig": {
"Destination": {
"S3": {
"BucketAccessRoleArn": "string",
"S3BucketArn": "string",
"Subdirectory": "string"
}
},
"ObjectVersionIds": "string",
"OutputType": "string",
"Overrides": {
"Deleted": {
"ReportLevel": "string"
},
"Skipped": {
"ReportLevel": "string"
},
"Transferred": {
"ReportLevel": "string"
},
"Verified": {
"ReportLevel": "string"
}
},
"ReportLevel": "string"
}
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [CloudWatchLogGroupArn](#API_UpdateTask_RequestSyntax) **
タスクをモニタリングするための Amazon CloudWatch ロググループの Amazon リソースネーム (ARN) を指定します。
拡張モードタスクでは、ロググループ名として `/aws/datasync` を使用する必要があります。例えば、次のようになります。
`arn:aws:logs:us-east-1:111222333444:log-group:/aws/datasync:*`
詳細については、「[Monitoring data transfers with Amazon CloudWatch Logs](https://docs.aws.amazon.com/datasync/latest/userguide/configure-logging.html)」を参照してください。
タイプ: 文字列
長さの制約: 最大長は 562 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$`
必須: いいえ
** [Excludes](#API_UpdateTask_RequestSyntax) **
DataSync に転送してほしくないソースの場所内のファイル、オブジェクト、フォルダを定義する除外フィルターを指定します。詳細と例については、「[Specifying what DataSync transfers by using filters](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)」を参照してください。
タイプ: [FilterRule](API_FilterRule.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。
必須: いいえ
** [Includes](#API_UpdateTask_RequestSyntax) **
包含フィルターを指定して、DataSync が転送するソースの場所内のファイル、オブジェクト、フォルダを定義します。詳細と例については、「[Specifying what DataSync transfers by using filters](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)」を参照してください。
タイプ: [FilterRule](API_FilterRule.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。
必須: いいえ
** [ManifestConfig](#API_UpdateTask_RequestSyntax) **
DataSync が転送するファイルまたはオブジェクトのリストであるマニフェストを設定します。詳細と設定例については、「[Specifying what DataSync transfers by using a manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html)」を参照してください。
このパラメータを使用する場合、発信者 ID (DataSync を使用している IAM ロール) には `iam:PassRole` アクセス許可が必要です。[AWSDataSyncFullAccess](https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess) ポリシーには、このアクセス許可が含まれています。
マニフェスト設定を削除するには、このパラメータを空として指定します。
タイプ: [ManifestConfig](API_ManifestConfig.md) オブジェクト
必須: いいえ
** [Name](#API_UpdateTask_RequestSyntax) **
タスクの名前を指定します。
タイプ: 文字列
長さの制約: 最小長は 0 です。最大長は 256 です。
パターン: `^[a-zA-Z0-9\s+=._:@/-]+$`
必須: いいえ
** [Options](#API_UpdateTask_RequestSyntax) **
転送タスクがどのように構成されているかを示します。これらのオプションには、転送中に DataSync がファイル、オブジェクト、および関連するメタデータを処理する方法が含まれます。また、データの整合性の検証方法や、タスクの帯域幅制限の設定方法なども指定できます。
各オプションにはデフォルト値があります。必要な場合を除き、[StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) を呼び出す前にこれらのオプションを設定する必要はありません。
これらのタスクオプションは各タスクを実行するたびにオーバーライドできます。例えば、個々の実行に合わせて `LogLevel` を調整することができます。
タイプ: [Options](API_Options.md) オブジェクト
必須: いいえ
** [Schedule](#API_UpdateTask_RequestSyntax) **
タスクを実行するスケジュールを指定します。詳細については、「[タスクのスケジュール](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html)」を参照してください。
タイプ: [TaskSchedule](API_TaskSchedule.md) オブジェクト
必須: いいえ
** [TaskArn](#API_UpdateTask_RequestSyntax) **
更新したいタスクの ARN を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:task/task-[0-9a-f]{17}$`
必須: はい
** [TaskReportConfig](#API_UpdateTask_RequestSyntax) **
DataSync 転送に関する詳細情報を提供するタスクレポートの構成方法を指定します。詳細については、「[Monitoring your DataSync transfers with task reports](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html)」を参照してください。
このパラメータを使用する場合、発信者 ID (DataSync を使用している IAM ロール) には `iam:PassRole` アクセス許可が必要です。[AWSDataSyncFullAccess](https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess) ポリシーには、このアクセス許可が含まれています。
タスクレポート設定を削除するには、このパラメータを空として指定します。
タイプ: [TaskReportConfig](API_TaskReportConfig.md) オブジェクト
必須: いいえ
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateTask)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateTask)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateTask)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateTask)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateTask)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateTask)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateTask)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateTask)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateTask)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateTask)
# UpdateTaskExecution
実行中の AWS DataSync タスク実行の設定を更新します。
**注記**
現在、`UpdateTaskExecution` で変更できる `Option` は ` [BytesPerSecond](https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-BytesPerSecond) ` のみで、これは実行中またはキューに入っているタスク実行の帯域幅を調整します。
## リクエストの構文
```
{
"Options": {
"Atime": "string",
"BytesPerSecond": number,
"Gid": "string",
"LogLevel": "string",
"Mtime": "string",
"ObjectTags": "string",
"OverwriteMode": "string",
"PosixPermissions": "string",
"PreserveDeletedFiles": "string",
"PreserveDevices": "string",
"SecurityDescriptorCopyFlags": "string",
"TaskQueueing": "string",
"TransferMode": "string",
"Uid": "string",
"VerifyMode": "string"
},
"TaskExecutionArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [Options](#API_UpdateTaskExecution_RequestSyntax) **
転送タスクがどのように構成されているかを示します。これらのオプションには、転送中に DataSync がファイル、オブジェクト、および関連するメタデータを処理する方法が含まれます。また、データの整合性の検証方法や、タスクの帯域幅制限の設定方法なども指定できます。
各オプションにはデフォルト値があります。必要な場合を除き、[StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) を呼び出す前にこれらのオプションを設定する必要はありません。
これらのタスクオプションは各タスクを実行するたびにオーバーライドできます。例えば、個々の実行に合わせて `LogLevel` を調整することができます。
タイプ: [Options](API_Options.md) オブジェクト
必須: はい
** [TaskExecutionArn](#API_UpdateTaskExecution_RequestSyntax) **
更新するタスク実行の Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$`
必須: はい
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** InternalException **
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
** InvalidRequestException **
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateTaskExecution)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateTaskExecution)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateTaskExecution)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateTaskExecution)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateTaskExecution)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateTaskExecution)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateTaskExecution)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateTaskExecution)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateTaskExecution)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateTaskExecution)