

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

# AWS Backup gateway
<a name="API_Operations_AWS_Backup_Gateway"></a>

以下のアクションが AWS Backup gateway によってサポートされています。
+  [AssociateGatewayToServer](API_BGW_AssociateGatewayToServer.md) 
+  [CreateGateway](API_BGW_CreateGateway.md) 
+  [DeleteGateway](API_BGW_DeleteGateway.md) 
+  [DeleteHypervisor](API_BGW_DeleteHypervisor.md) 
+  [DisassociateGatewayFromServer](API_BGW_DisassociateGatewayFromServer.md) 
+  [GetBandwidthRateLimitSchedule](API_BGW_GetBandwidthRateLimitSchedule.md) 
+  [GetGateway](API_BGW_GetGateway.md) 
+  [GetHypervisor](API_BGW_GetHypervisor.md) 
+  [GetHypervisorPropertyMappings](API_BGW_GetHypervisorPropertyMappings.md) 
+  [GetVirtualMachine](API_BGW_GetVirtualMachine.md) 
+  [ImportHypervisorConfiguration](API_BGW_ImportHypervisorConfiguration.md) 
+  [ListGateways](API_BGW_ListGateways.md) 
+  [ListHypervisors](API_BGW_ListHypervisors.md) 
+  [ListTagsForResource](API_BGW_ListTagsForResource.md) 
+  [ListVirtualMachines](API_BGW_ListVirtualMachines.md) 
+  [PutBandwidthRateLimitSchedule](API_BGW_PutBandwidthRateLimitSchedule.md) 
+  [PutHypervisorPropertyMappings](API_BGW_PutHypervisorPropertyMappings.md) 
+  [PutMaintenanceStartTime](API_BGW_PutMaintenanceStartTime.md) 
+  [StartVirtualMachinesMetadataSync](API_BGW_StartVirtualMachinesMetadataSync.md) 
+  [TagResource](API_BGW_TagResource.md) 
+  [TestHypervisorConfiguration](API_BGW_TestHypervisorConfiguration.md) 
+  [UntagResource](API_BGW_UntagResource.md) 
+  [UpdateGatewayInformation](API_BGW_UpdateGatewayInformation.md) 
+  [UpdateGatewaySoftwareNow](API_BGW_UpdateGatewaySoftwareNow.md) 
+  [UpdateHypervisor](API_BGW_UpdateHypervisor.md) 

# AssociateGatewayToServer
<a name="API_BGW_AssociateGatewayToServer"></a>

バックアップゲートウェイをサーバに関連付けます。関連付けプロセスの完了後、ゲートウェイ経由で VM をバックアップおよび復元できます。

## リクエストの構文
<a name="API_BGW_AssociateGatewayToServer_RequestSyntax"></a>

```
{
   "GatewayArn": "string",
   "ServerArn": "string"
}
```

## リクエストパラメーター
<a name="API_BGW_AssociateGatewayToServer_RequestParameters"></a>

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

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

 ** [GatewayArn](#API_BGW_AssociateGatewayToServer_RequestSyntax) **   <a name="Backup-BGW_AssociateGatewayToServer-request-GatewayArn"></a>
ゲートウェイの Amazon リソースネーム (ARN) `ListGateways` オペレーションを使用して、アカウントのゲートウェイと のリストを返します AWS リージョン。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。最大長は 180 です。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
必須: はい

 ** [ServerArn](#API_BGW_AssociateGatewayToServer_RequestSyntax) **   <a name="Backup-BGW_AssociateGatewayToServer-request-ServerArn"></a>
仮想マシンをホストするサーバーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。500 の最大長。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
必須: はい

## レスポンスの構文
<a name="API_BGW_AssociateGatewayToServer_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## レスポンス要素
<a name="API_BGW_AssociateGatewayToServer_ResponseElements"></a>

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

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

 ** [GatewayArn](#API_BGW_AssociateGatewayToServer_ResponseSyntax) **   <a name="Backup-BGW_AssociateGatewayToServer-response-GatewayArn"></a>
ゲートウェイの Amazon リソースネーム (ARN)  
タイプ: 文字列  
長さの制限: 最小長は 50 です。最大長は 180 です。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## エラー
<a name="API_BGW_AssociateGatewayToServer_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** ConflictException **   
サポートされていないため、操作を続行できません。    
 ** ErrorCode **   
操作がサポートされていない理由の説明。
HTTP ステータスコード: 400

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_AssociateGatewayToServer_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/AssociateGatewayToServer) 

# CreateGateway
<a name="API_BGW_CreateGateway"></a>

バックアップゲートウェイを作成します。ゲートウェイを作成したら、`AssociateGatewayToServer` オペレーションを使用して、ゲートウェイをサーバに関連付けることができます。

## リクエストの構文
<a name="API_BGW_CreateGateway_RequestSyntax"></a>

```
{
   "ActivationKey": "string",
   "GatewayDisplayName": "string",
   "GatewayType": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## リクエストパラメーター
<a name="API_BGW_CreateGateway_RequestParameters"></a>

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

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

 ** [ActivationKey](#API_BGW_CreateGateway_RequestSyntax) **   <a name="Backup-BGW_CreateGateway-request-ActivationKey"></a>
作成されたゲートウェイのアクティベーションキー。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 50 です。  
パターン: `[0-9a-zA-Z\-]+`   
必須: はい

 ** [GatewayDisplayName](#API_BGW_CreateGateway_RequestSyntax) **   <a name="Backup-BGW_CreateGateway-request-GatewayDisplayName"></a>
作成されたゲートウェイの表示名。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 100 です。  
パターン: `[a-zA-Z0-9-]*`   
必須: はい

 ** [GatewayType](#API_BGW_CreateGateway_RequestSyntax) **   <a name="Backup-BGW_CreateGateway-request-GatewayType"></a>
作成されたゲートウェイのタイプ。  
型: 文字列  
有効な値：`BACKUP_VM`  
必須: はい

 ** [Tags](#API_BGW_CreateGateway_RequestSyntax) **   <a name="Backup-BGW_CreateGateway-request-Tags"></a>
ゲートウェイに割り当てられる最大 50 のタグのリスト。各タグはキーバリューのペアです。  
タイプ: [Tag](API_BGW_Tag.md) オブジェクトの配列  
必須: いいえ

## レスポンスの構文
<a name="API_BGW_CreateGateway_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## レスポンス要素
<a name="API_BGW_CreateGateway_ResponseElements"></a>

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

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

 ** [GatewayArn](#API_BGW_CreateGateway_ResponseSyntax) **   <a name="Backup-BGW_CreateGateway-response-GatewayArn"></a>
作成するゲートウェイの Amazon リソースネーム (ARN)  
タイプ: 文字列  
長さの制限: 最小長は 50 です。最大長は 180 です。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## エラー
<a name="API_BGW_CreateGateway_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_CreateGateway_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/CreateGateway) 

# DeleteGateway
<a name="API_BGW_DeleteGateway"></a>

バックアップゲートウェイを削除します。

## リクエストの構文
<a name="API_BGW_DeleteGateway_RequestSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## リクエストパラメーター
<a name="API_BGW_DeleteGateway_RequestParameters"></a>

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

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

 ** [GatewayArn](#API_BGW_DeleteGateway_RequestSyntax) **   <a name="Backup-BGW_DeleteGateway-request-GatewayArn"></a>
削除するゲートウェイの Amazon リソースネーム (ARN)  
タイプ: 文字列  
長さの制限: 最小長は 50 です。最大長は 180 です。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
必須: はい

## レスポンスの構文
<a name="API_BGW_DeleteGateway_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## レスポンス要素
<a name="API_BGW_DeleteGateway_ResponseElements"></a>

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

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

 ** [GatewayArn](#API_BGW_DeleteGateway_ResponseSyntax) **   <a name="Backup-BGW_DeleteGateway-response-GatewayArn"></a>
削除されるゲートウェイの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。最大長は 180 です。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## エラー
<a name="API_BGW_DeleteGateway_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ResourceNotFoundException **   
アクションに必要なリソースが見つかりませんでした。    
 ** ErrorCode **   
見つからないリソースの説明。
HTTP ステータスコード: 400

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_DeleteGateway_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/DeleteGateway) 

# DeleteHypervisor
<a name="API_BGW_DeleteHypervisor"></a>

ハイパーバイザーを削除します。

## リクエストの構文
<a name="API_BGW_DeleteHypervisor_RequestSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

## リクエストパラメーター
<a name="API_BGW_DeleteHypervisor_RequestParameters"></a>

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

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

 ** [HypervisorArn](#API_BGW_DeleteHypervisor_RequestSyntax) **   <a name="Backup-BGW_DeleteHypervisor-request-HypervisorArn"></a>
削除するハイパーバイザーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。500 の最大長。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
必須: はい

## レスポンスの構文
<a name="API_BGW_DeleteHypervisor_ResponseSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

## レスポンス要素
<a name="API_BGW_DeleteHypervisor_ResponseElements"></a>

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

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

 ** [HypervisorArn](#API_BGW_DeleteHypervisor_ResponseSyntax) **   <a name="Backup-BGW_DeleteHypervisor-response-HypervisorArn"></a>
削除したハイパーバイザーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。500 の最大長。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## エラー
<a name="API_BGW_DeleteHypervisor_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** AccessDeniedException **   
権限が不足しているため、操作を続行できません。    
 ** ErrorCode **   
アクセス許可が不十分である理由の説明。
HTTP ステータスコード: 400

 ** ConflictException **   
サポートされていないため、操作を続行できません。    
 ** ErrorCode **   
操作がサポートされていない理由の説明。
HTTP ステータスコード: 400

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ResourceNotFoundException **   
アクションに必要なリソースが見つかりませんでした。    
 ** ErrorCode **   
見つからないリソースの説明。
HTTP ステータスコード: 400

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_DeleteHypervisor_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/DeleteHypervisor) 

# DisassociateGatewayFromServer
<a name="API_BGW_DisassociateGatewayFromServer"></a>

指定されたサーバーからバックアップゲートウェイの関連付けを解除します。関連付け解除プロセスが終了すると、ゲートウェイはサーバー上の仮想マシンにアクセスできなくなります。

## リクエストの構文
<a name="API_BGW_DisassociateGatewayFromServer_RequestSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## リクエストパラメーター
<a name="API_BGW_DisassociateGatewayFromServer_RequestParameters"></a>

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

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

 ** [GatewayArn](#API_BGW_DisassociateGatewayFromServer_RequestSyntax) **   <a name="Backup-BGW_DisassociateGatewayFromServer-request-GatewayArn"></a>
関連付けを解除するゲートウェイの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。最大長は 180 です。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
必須: はい

## レスポンスの構文
<a name="API_BGW_DisassociateGatewayFromServer_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## レスポンス要素
<a name="API_BGW_DisassociateGatewayFromServer_ResponseElements"></a>

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

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

 ** [GatewayArn](#API_BGW_DisassociateGatewayFromServer_ResponseSyntax) **   <a name="Backup-BGW_DisassociateGatewayFromServer-response-GatewayArn"></a>
関連付けを解除したゲートウェイの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。最大長は 180 です。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## エラー
<a name="API_BGW_DisassociateGatewayFromServer_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** ConflictException **   
サポートされていないため、操作を続行できません。    
 ** ErrorCode **   
操作がサポートされていない理由の説明。
HTTP ステータスコード: 400

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ResourceNotFoundException **   
アクションに必要なリソースが見つかりませんでした。    
 ** ErrorCode **   
見つからないリソースの説明。
HTTP ステータスコード: 400

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_DisassociateGatewayFromServer_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 

# GetBandwidthRateLimitSchedule
<a name="API_BGW_GetBandwidthRateLimitSchedule"></a>

指定されたゲートウェイの帯域幅レート制限スケジュールを取得します。デフォルトでは、ゲートウェイには帯域幅レート制限スケジュールがありません。つまり、帯域幅レート制限は適用されていません。これを使用して、ゲートウェイの帯域幅レート制限スケジュールを取得します。

## リクエストの構文
<a name="API_BGW_GetBandwidthRateLimitSchedule_RequestSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## リクエストパラメーター
<a name="API_BGW_GetBandwidthRateLimitSchedule_RequestParameters"></a>

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

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

 ** [GatewayArn](#API_BGW_GetBandwidthRateLimitSchedule_RequestSyntax) **   <a name="Backup-BGW_GetBandwidthRateLimitSchedule-request-GatewayArn"></a>
ゲートウェイの Amazon リソースネーム (ARN) [https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html) オペレーションを使用して、アカウントのゲートウェイと のリストを返します AWS リージョン。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。最大長は 180 です。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
必須: はい

## レスポンスの構文
<a name="API_BGW_GetBandwidthRateLimitSchedule_ResponseSyntax"></a>

```
{
   "BandwidthRateLimitIntervals": [ 
      { 
         "AverageUploadRateLimitInBitsPerSec": number,
         "DaysOfWeek": [ number ],
         "EndHourOfDay": number,
         "EndMinuteOfHour": number,
         "StartHourOfDay": number,
         "StartMinuteOfHour": number
      }
   ],
   "GatewayArn": "string"
}
```

## レスポンス要素
<a name="API_BGW_GetBandwidthRateLimitSchedule_ResponseElements"></a>

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

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

 ** [BandwidthRateLimitIntervals](#API_BGW_GetBandwidthRateLimitSchedule_ResponseSyntax) **   <a name="Backup-BGW_GetBandwidthRateLimitSchedule-response-BandwidthRateLimitIntervals"></a>
ゲートウェイの帯域幅レート制限スケジュールの間隔を含む配列。帯域幅レート制限の間隔がスケジュールされていない場合、配列は空になります。  
型: [BandwidthRateLimitInterval](API_BGW_BandwidthRateLimitInterval.md) オブジェクトの配列  
配列メンバー: 最小数は 0 項目です。最大数は 20 項目です。

 ** [GatewayArn](#API_BGW_GetBandwidthRateLimitSchedule_ResponseSyntax) **   <a name="Backup-BGW_GetBandwidthRateLimitSchedule-response-GatewayArn"></a>
ゲートウェイの Amazon リソースネーム (ARN)。[https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html) オペレーションを使用して、アカウントのゲートウェイと のリストを返します AWS リージョン。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。最大長は 180 です。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## エラー
<a name="API_BGW_GetBandwidthRateLimitSchedule_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ResourceNotFoundException **   
アクションに必要なリソースが見つかりませんでした。    
 ** ErrorCode **   
見つからないリソースの説明。
HTTP ステータスコード: 400

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_GetBandwidthRateLimitSchedule_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 

# GetGateway
<a name="API_BGW_GetGateway"></a>

ARN (Amazon リソースネーム) を指定することで、この API はゲートウェイを返します。

## リクエストの構文
<a name="API_BGW_GetGateway_RequestSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## リクエストパラメーター
<a name="API_BGW_GetGateway_RequestParameters"></a>

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

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

 ** [GatewayArn](#API_BGW_GetGateway_RequestSyntax) **   <a name="Backup-BGW_GetGateway-request-GatewayArn"></a>
ゲートウェイの Amazon リソースネーム (ARN)  
タイプ: 文字列  
長さの制限: 最小長は 50 です。最大長は 180 です。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
必須: はい

## レスポンスの構文
<a name="API_BGW_GetGateway_ResponseSyntax"></a>

```
{
   "Gateway": { 
      "DeprecationDate": number,
      "GatewayArn": "string",
      "GatewayDisplayName": "string",
      "GatewayType": "string",
      "HypervisorId": "string",
      "LastSeenTime": number,
      "MaintenanceStartTime": { 
         "DayOfMonth": number,
         "DayOfWeek": number,
         "HourOfDay": number,
         "MinuteOfHour": number
      },
      "NextUpdateAvailabilityTime": number,
      "SoftwareVersion": "string",
      "VpcEndpoint": "string"
   }
}
```

## レスポンス要素
<a name="API_BGW_GetGateway_ResponseElements"></a>

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

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

 ** [Gateway](#API_BGW_GetGateway_ResponseSyntax) **   <a name="Backup-BGW_GetGateway-response-Gateway"></a>
ARN (Amazon リソースネーム) を指定することで、この API はゲートウェイを返します。  
型: [GatewayDetails](API_BGW_GatewayDetails.md) オブジェクト

## エラー
<a name="API_BGW_GetGateway_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ResourceNotFoundException **   
アクションに必要なリソースが見つかりませんでした。    
 ** ErrorCode **   
見つからないリソースの説明。
HTTP ステータスコード: 400

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_GetGateway_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/GetGateway) 

# GetHypervisor
<a name="API_BGW_GetHypervisor"></a>

このアクションは、ゲートウェイが接続する指定されたハイパーバイザーに関する情報をリクエストします。ハイパーバイザーは、仮想マシンを作成および管理し、それらにリソースを割り当てるハードウェア、ソフトウェア、またはファームウェアです。

## リクエストの構文
<a name="API_BGW_GetHypervisor_RequestSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

## リクエストパラメーター
<a name="API_BGW_GetHypervisor_RequestParameters"></a>

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

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

 ** [HypervisorArn](#API_BGW_GetHypervisor_RequestSyntax) **   <a name="Backup-BGW_GetHypervisor-request-HypervisorArn"></a>
ハイパーバイザーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。500 の最大長。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
必須: はい

## レスポンスの構文
<a name="API_BGW_GetHypervisor_ResponseSyntax"></a>

```
{
   "Hypervisor": { 
      "Host": "string",
      "HypervisorArn": "string",
      "KmsKeyArn": "string",
      "LastSuccessfulMetadataSyncTime": number,
      "LatestMetadataSyncStatus": "string",
      "LatestMetadataSyncStatusMessage": "string",
      "LogGroupArn": "string",
      "Name": "string",
      "State": "string"
   }
}
```

## レスポンス要素
<a name="API_BGW_GetHypervisor_ResponseElements"></a>

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

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

 ** [Hypervisor](#API_BGW_GetHypervisor_ResponseSyntax) **   <a name="Backup-BGW_GetHypervisor-response-Hypervisor"></a>
リクエストされたハイパーバイザーに関する詳細。  
型: [HypervisorDetails](API_BGW_HypervisorDetails.md) オブジェクト

## エラー
<a name="API_BGW_GetHypervisor_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ResourceNotFoundException **   
アクションに必要なリソースが見つかりませんでした。    
 ** ErrorCode **   
見つからないリソースの説明。
HTTP ステータスコード: 400

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_GetHypervisor_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/GetHypervisor) 

# GetHypervisorPropertyMappings
<a name="API_BGW_GetHypervisorPropertyMappings"></a>

このアクションは、指定されたハイパーバイザーのプロパティマッピングを取得します。ハイパーバイザープロパティマッピングは、ハイパーバイザーから利用可能なエンティティプロパティと、 で利用可能なプロパティの関係を表示します AWS。

## リクエストの構文
<a name="API_BGW_GetHypervisorPropertyMappings_RequestSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

## リクエストパラメーター
<a name="API_BGW_GetHypervisorPropertyMappings_RequestParameters"></a>

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

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

 ** [HypervisorArn](#API_BGW_GetHypervisorPropertyMappings_RequestSyntax) **   <a name="Backup-BGW_GetHypervisorPropertyMappings-request-HypervisorArn"></a>
ハイパーバイザーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。500 の最大長。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
必須: はい

## レスポンスの構文
<a name="API_BGW_GetHypervisorPropertyMappings_ResponseSyntax"></a>

```
{
   "HypervisorArn": "string",
   "IamRoleArn": "string",
   "VmwareToAwsTagMappings": [ 
      { 
         "AwsTagKey": "string",
         "AwsTagValue": "string",
         "VmwareCategory": "string",
         "VmwareTagName": "string"
      }
   ]
}
```

## レスポンス要素
<a name="API_BGW_GetHypervisorPropertyMappings_ResponseElements"></a>

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

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

 ** [HypervisorArn](#API_BGW_GetHypervisorPropertyMappings_ResponseSyntax) **   <a name="Backup-BGW_GetHypervisorPropertyMappings-response-HypervisorArn"></a>
ハイパーバイザーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。500 の最大長。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

 ** [IamRoleArn](#API_BGW_GetHypervisorPropertyMappings_ResponseSyntax) **   <a name="Backup-BGW_GetHypervisorPropertyMappings-response-IamRoleArn"></a>
IAM ロールの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 20 です。最大長は 2,048 です。  
パターン: `arn:(aws|aws-cn|aws-us-gov):iam::([0-9]+):role/(\S+)` 

 ** [VmwareToAwsTagMappings](#API_BGW_GetHypervisorPropertyMappings_ResponseSyntax) **   <a name="Backup-BGW_GetHypervisorPropertyMappings-response-VmwareToAwsTagMappings"></a>
これは VMware タグと AWS タグとのマッピングの表示です。  
型: [VmwareToAwsTagMapping](API_BGW_VmwareToAwsTagMapping.md) オブジェクトの配列

## エラー
<a name="API_BGW_GetHypervisorPropertyMappings_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ResourceNotFoundException **   
アクションに必要なリソースが見つかりませんでした。    
 ** ErrorCode **   
見つからないリソースの説明。
HTTP ステータスコード: 400

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_GetHypervisorPropertyMappings_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 

# GetVirtualMachine
<a name="API_BGW_GetVirtualMachine"></a>

ARN (Amazon リソースネーム) を指定することで、この API は仮想マシンを返します。

## リクエストの構文
<a name="API_BGW_GetVirtualMachine_RequestSyntax"></a>

```
{
   "ResourceArn": "string"
}
```

## リクエストパラメーター
<a name="API_BGW_GetVirtualMachine_RequestParameters"></a>

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

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

 ** [ResourceArn](#API_BGW_GetVirtualMachine_RequestSyntax) **   <a name="Backup-BGW_GetVirtualMachine-request-ResourceArn"></a>
仮想マシンの Amazon リソースネーム (ARN)です。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。500 の最大長。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
必須: はい

## レスポンスの構文
<a name="API_BGW_GetVirtualMachine_ResponseSyntax"></a>

```
{
   "VirtualMachine": { 
      "HostName": "string",
      "HypervisorId": "string",
      "LastBackupDate": number,
      "Name": "string",
      "Path": "string",
      "ResourceArn": "string",
      "VmwareTags": [ 
         { 
            "VmwareCategory": "string",
            "VmwareTagDescription": "string",
            "VmwareTagName": "string"
         }
      ]
   }
}
```

## レスポンス要素
<a name="API_BGW_GetVirtualMachine_ResponseElements"></a>

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

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

 ** [VirtualMachine](#API_BGW_GetVirtualMachine_ResponseSyntax) **   <a name="Backup-BGW_GetVirtualMachine-response-VirtualMachine"></a>
このオブジェクトには、`GetVirtualMachine` の出力に含まれる `VirtualMachine` の基本属性が含まれています。  
型: [VirtualMachineDetails](API_BGW_VirtualMachineDetails.md) オブジェクト

## エラー
<a name="API_BGW_GetVirtualMachine_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ResourceNotFoundException **   
アクションに必要なリソースが見つかりませんでした。    
 ** ErrorCode **   
見つからないリソースの説明。
HTTP ステータスコード: 400

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_GetVirtualMachine_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/GetVirtualMachine) 

# ImportHypervisorConfiguration
<a name="API_BGW_ImportHypervisorConfiguration"></a>

ハイパーバイザーの設定をインポートして、ハイパーバイザーに接続します。

## リクエストの構文
<a name="API_BGW_ImportHypervisorConfiguration_RequestSyntax"></a>

```
{
   "Host": "string",
   "KmsKeyArn": "string",
   "Name": "string",
   "Password": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Username": "string"
}
```

## リクエストパラメーター
<a name="API_BGW_ImportHypervisorConfiguration_RequestParameters"></a>

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

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

 ** [Host](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Host"></a>
ハイパーバイザーのサーバーホスト。これは、IP アドレスまたは完全修飾ドメイン名 (FQDN) のいずれかです。  
タイプ: 文字列  
長さの制約: 最小長は 3 です。最大長は 128 です。  
パターン: `.+`   
必須: はい

 ** [KmsKeyArn](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-KmsKeyArn"></a>
ハイパーバイザー AWS Key Management Service の 。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。500 の最大長。  
パターン: `(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`   
必須: いいえ

 ** [Name](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Name"></a>
ハイパーバイザーの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 100 です。  
パターン: `[a-zA-Z0-9-]*`   
必須: はい

 ** [Password](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Password"></a>
ハイパーバイザーのパスワード。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 100 です。  
パターン: `[ -~]+`   
必須: いいえ

 ** [Tags](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Tags"></a>
インポートするハイパーバイザー設定のタグ。  
タイプ: [Tag](API_BGW_Tag.md) オブジェクトの配列  
必須: いいえ

 ** [Username](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Username"></a>
ハイパーバイザーのユーザー名。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 100 です。  
パターン: `[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*`   
必須: いいえ

## レスポンスの構文
<a name="API_BGW_ImportHypervisorConfiguration_ResponseSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

## レスポンス要素
<a name="API_BGW_ImportHypervisorConfiguration_ResponseElements"></a>

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

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

 ** [HypervisorArn](#API_BGW_ImportHypervisorConfiguration_ResponseSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-response-HypervisorArn"></a>
関連付けを解除したハイパーバイザーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。500 の最大長。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## エラー
<a name="API_BGW_ImportHypervisorConfiguration_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** AccessDeniedException **   
権限が不足しているため、操作を続行できません。    
 ** ErrorCode **   
アクセス許可が不十分である理由の説明。
HTTP ステータスコード: 400

 ** ConflictException **   
サポートされていないため、操作を続行できません。    
 ** ErrorCode **   
操作がサポートされていない理由の説明。
HTTP ステータスコード: 400

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_ImportHypervisorConfiguration_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 

# ListGateways
<a name="API_BGW_ListGateways"></a>

 AWS アカウント の が所有するバックアップゲートウェイを一覧表示します AWS リージョン。返されるリストは、ゲートウェイ Amazon リソース名 (ARN) によって順序付けられます。

## リクエストの構文
<a name="API_BGW_ListGateways_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

## リクエストパラメーター
<a name="API_BGW_ListGateways_RequestParameters"></a>

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

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

 ** [MaxResults](#API_BGW_ListGateways_RequestSyntax) **   <a name="Backup-BGW_ListGateways-request-MaxResults"></a>
リストするゲートウェイの最大数。  
タイプ: 整数  
有効な範囲: 最小値 は 1 です。  
必須: いいえ

 ** [NextToken](#API_BGW_ListGateways_RequestSyntax) **   <a name="Backup-BGW_ListGateways-request-NextToken"></a>
返されるリソースの一部リストに続く次のアイテム。例えば、`MaxResults` の数のリソースを返すようにリクエストが行われた場合、`NextToken` を使用すると、このトークンが指す場所から開始してさらにリストの項目を返すことができます。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 1,000 です。  
パターン: `.+`   
必須: いいえ

## レスポンスの構文
<a name="API_BGW_ListGateways_ResponseSyntax"></a>

```
{
   "Gateways": [ 
      { 
         "GatewayArn": "string",
         "GatewayDisplayName": "string",
         "GatewayType": "string",
         "HypervisorId": "string",
         "LastSeenTime": number
      }
   ],
   "NextToken": "string"
}
```

## レスポンス要素
<a name="API_BGW_ListGateways_ResponseElements"></a>

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

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

 ** [Gateways](#API_BGW_ListGateways_ResponseSyntax) **   <a name="Backup-BGW_ListGateways-response-Gateways"></a>
ゲートウェイのリスト。  
型: [Gateway](API_BGW_Gateway.md) オブジェクトの配列

 ** [NextToken](#API_BGW_ListGateways_ResponseSyntax) **   <a name="Backup-BGW_ListGateways-response-NextToken"></a>
返されるリソースの部分的リストに続く次の項目です。例えば、`maxResults` の数のリソースを返すようにリクエストが行われた場合、`NextToken` を使用すると、このトークンが指す場所から開始してさらにリストの項目を返すことができます。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 1,000 です。  
パターン: `.+` 

## エラー
<a name="API_BGW_ListGateways_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_ListGateways_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/ListGateways) 

# ListHypervisors
<a name="API_BGW_ListHypervisors"></a>

ハイパーバイザーを一覧表示します。

## リクエストの構文
<a name="API_BGW_ListHypervisors_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

## リクエストパラメーター
<a name="API_BGW_ListHypervisors_RequestParameters"></a>

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

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

 ** [MaxResults](#API_BGW_ListHypervisors_RequestSyntax) **   <a name="Backup-BGW_ListHypervisors-request-MaxResults"></a>
リストするハイパーバイザーの最大数。  
タイプ: 整数  
有効な範囲: 最小値 は 1 です。  
必須: いいえ

 ** [NextToken](#API_BGW_ListHypervisors_RequestSyntax) **   <a name="Backup-BGW_ListHypervisors-request-NextToken"></a>
返されるリソースの一部リストに続く次のアイテム。例えば、`maxResults` の数のリソースを返すようにリクエストが行われた場合、`NextToken` を使用すると、このトークンが指す場所から開始してさらにリストの項目を返すことができます。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 1,000 です。  
パターン: `.+`   
必須: いいえ

## レスポンスの構文
<a name="API_BGW_ListHypervisors_ResponseSyntax"></a>

```
{
   "Hypervisors": [ 
      { 
         "Host": "string",
         "HypervisorArn": "string",
         "KmsKeyArn": "string",
         "Name": "string",
         "State": "string"
      }
   ],
   "NextToken": "string"
}
```

## レスポンス要素
<a name="API_BGW_ListHypervisors_ResponseElements"></a>

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

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

 ** [Hypervisors](#API_BGW_ListHypervisors_ResponseSyntax) **   <a name="Backup-BGW_ListHypervisors-response-Hypervisors"></a>
リスト `Hypervisor` Amazon リソースネーム (ARN) の順序が付けられたオブジェクト。  
型: [Hypervisor](API_BGW_Hypervisor.md) オブジェクトの配列

 ** [NextToken](#API_BGW_ListHypervisors_ResponseSyntax) **   <a name="Backup-BGW_ListHypervisors-response-NextToken"></a>
返されるリソースの部分的リストに続く次の項目です。例えば、`maxResults` の数のリソースを返すようにリクエストが行われた場合、`NextToken` を使用すると、このトークンが指す場所から開始してさらにリストの項目を返すことができます。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 1,000 です。  
パターン: `.+` 

## エラー
<a name="API_BGW_ListHypervisors_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_ListHypervisors_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/ListHypervisors) 

# ListTagsForResource
<a name="API_BGW_ListTagsForResource"></a>

リソースの Amazon リソースネーム (ARN) によって識別されるリソースに適用されるタグを一覧表示します。

## リクエストの構文
<a name="API_BGW_ListTagsForResource_RequestSyntax"></a>

```
{
   "ResourceArn": "string"
}
```

## リクエストパラメーター
<a name="API_BGW_ListTagsForResource_RequestParameters"></a>

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

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

 ** [ResourceArn](#API_BGW_ListTagsForResource_RequestSyntax) **   <a name="Backup-BGW_ListTagsForResource-request-ResourceArn"></a>
一覧表示するリソースのタグの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。500 の最大長。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
必須: はい

## レスポンスの構文
<a name="API_BGW_ListTagsForResource_ResponseSyntax"></a>

```
{
   "ResourceArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## レスポンス要素
<a name="API_BGW_ListTagsForResource_ResponseElements"></a>

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

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

 ** [ResourceArn](#API_BGW_ListTagsForResource_ResponseSyntax) **   <a name="Backup-BGW_ListTagsForResource-response-ResourceArn"></a>
一覧表示したリソースのタグの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。500 の最大長。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

 ** [Tags](#API_BGW_ListTagsForResource_ResponseSyntax) **   <a name="Backup-BGW_ListTagsForResource-response-Tags"></a>
リソースのタグの一覧表示。  
型: [Tag](API_BGW_Tag.md) オブジェクトの配列

## エラー
<a name="API_BGW_ListTagsForResource_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ResourceNotFoundException **   
アクションに必要なリソースが見つかりませんでした。    
 ** ErrorCode **   
見つからないリソースの説明。
HTTP ステータスコード: 400

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_ListTagsForResource_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/ListTagsForResource) 

# ListVirtualMachines
<a name="API_BGW_ListVirtualMachines"></a>

仮想マシンを一覧表示します。

## リクエストの構文
<a name="API_BGW_ListVirtualMachines_RequestSyntax"></a>

```
{
   "HypervisorArn": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## リクエストパラメーター
<a name="API_BGW_ListVirtualMachines_RequestParameters"></a>

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

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

 ** [HypervisorArn](#API_BGW_ListVirtualMachines_RequestSyntax) **   <a name="Backup-BGW_ListVirtualMachines-request-HypervisorArn"></a>
仮想マシンに接続されたハイパーバイザーの Amazon リソースネーム (ARN)です。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。500 の最大長。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
必須: いいえ

 ** [MaxResults](#API_BGW_ListVirtualMachines_RequestSyntax) **   <a name="Backup-BGW_ListVirtualMachines-request-MaxResults"></a>
一覧表示する仮想マシンの最大数。  
タイプ: 整数  
有効な範囲: 最小値 は 1 です。  
必須: いいえ

 ** [NextToken](#API_BGW_ListVirtualMachines_RequestSyntax) **   <a name="Backup-BGW_ListVirtualMachines-request-NextToken"></a>
返されるリソースの一部リストに続く次のアイテム。例えば、`maxResults` の数のリソースを返すようにリクエストが行われた場合、`NextToken` を使用すると、このトークンが指す場所から開始してさらにリストの項目を返すことができます。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 1,000 です。  
パターン: `.+`   
必須: いいえ

## レスポンスの構文
<a name="API_BGW_ListVirtualMachines_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "VirtualMachines": [ 
      { 
         "HostName": "string",
         "HypervisorId": "string",
         "LastBackupDate": number,
         "Name": "string",
         "Path": "string",
         "ResourceArn": "string"
      }
   ]
}
```

## レスポンス要素
<a name="API_BGW_ListVirtualMachines_ResponseElements"></a>

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

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

 ** [NextToken](#API_BGW_ListVirtualMachines_ResponseSyntax) **   <a name="Backup-BGW_ListVirtualMachines-response-NextToken"></a>
返されるリソースの一部リストに続く次のアイテム。例えば、`maxResults` の数のリソースを返すようにリクエストが行われた場合、`NextToken` を使用すると、このトークンが指す場所から開始してさらにリストの項目を返すことができます。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 1,000 です。  
パターン: `.+` 

 ** [VirtualMachines](#API_BGW_ListVirtualMachines_ResponseSyntax) **   <a name="Backup-BGW_ListVirtualMachines-response-VirtualMachines"></a>
あなたのリスト`VirtualMachine` Amazon リソースネーム (ARN) の順序が付けられたオブジェクト。  
型: [VirtualMachine](API_BGW_VirtualMachine.md) オブジェクトの配列

## エラー
<a name="API_BGW_ListVirtualMachines_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_ListVirtualMachines_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/ListVirtualMachines) 

# PutBandwidthRateLimitSchedule
<a name="API_BGW_PutBandwidthRateLimitSchedule"></a>

このアクションは、指定されたゲートウェイの帯域幅レート制限スケジュールを設定します。デフォルトでは、ゲートウェイには帯域幅レート制限スケジュールがありません。つまり、帯域幅レート制限は適用されません。これを使用して、ゲートウェイの帯域幅レート制限スケジュールを開始します。

## リクエストの構文
<a name="API_BGW_PutBandwidthRateLimitSchedule_RequestSyntax"></a>

```
{
   "BandwidthRateLimitIntervals": [ 
      { 
         "AverageUploadRateLimitInBitsPerSec": number,
         "DaysOfWeek": [ number ],
         "EndHourOfDay": number,
         "EndMinuteOfHour": number,
         "StartHourOfDay": number,
         "StartMinuteOfHour": number
      }
   ],
   "GatewayArn": "string"
}
```

## リクエストパラメーター
<a name="API_BGW_PutBandwidthRateLimitSchedule_RequestParameters"></a>

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

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

 ** [BandwidthRateLimitIntervals](#API_BGW_PutBandwidthRateLimitSchedule_RequestSyntax) **   <a name="Backup-BGW_PutBandwidthRateLimitSchedule-request-BandwidthRateLimitIntervals"></a>
ゲートウェイの帯域幅レート制限スケジュールの間隔を含む配列。帯域幅レート制限の間隔がスケジュールされていない場合、配列は空になります。  
型: [BandwidthRateLimitInterval](API_BGW_BandwidthRateLimitInterval.md) オブジェクトの配列  
配列メンバー: 最小数は 0 項目です。最大数は 20 項目です。  
必須: はい

 ** [GatewayArn](#API_BGW_PutBandwidthRateLimitSchedule_RequestSyntax) **   <a name="Backup-BGW_PutBandwidthRateLimitSchedule-request-GatewayArn"></a>
ゲートウェイの Amazon リソースネーム (ARN)。[https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html) オペレーションを使用して、アカウントのゲートウェイと のリストを返します AWS リージョン。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。最大長は 180 です。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
必須: はい

## レスポンスの構文
<a name="API_BGW_PutBandwidthRateLimitSchedule_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## レスポンス要素
<a name="API_BGW_PutBandwidthRateLimitSchedule_ResponseElements"></a>

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

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

 ** [GatewayArn](#API_BGW_PutBandwidthRateLimitSchedule_ResponseSyntax) **   <a name="Backup-BGW_PutBandwidthRateLimitSchedule-response-GatewayArn"></a>
ゲートウェイの Amazon リソースネーム (ARN)。[https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html) オペレーションを使用して、アカウントのゲートウェイと のリストを返します AWS リージョン。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。最大長は 180 です。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## エラー
<a name="API_BGW_PutBandwidthRateLimitSchedule_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ResourceNotFoundException **   
アクションに必要なリソースが見つかりませんでした。    
 ** ErrorCode **   
見つからないリソースの説明。
HTTP ステータスコード: 400

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_PutBandwidthRateLimitSchedule_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 

# PutHypervisorPropertyMappings
<a name="API_BGW_PutHypervisorPropertyMappings"></a>

このアクションは、指定されたハイパーバイザーのプロパティマッピングを設定します。ハイパーバイザープロパティマッピングは、ハイパーバイザーから利用可能なエンティティプロパティと、 で利用可能なプロパティの関係を表示します AWS。

## リクエストの構文
<a name="API_BGW_PutHypervisorPropertyMappings_RequestSyntax"></a>

```
{
   "HypervisorArn": "string",
   "IamRoleArn": "string",
   "VmwareToAwsTagMappings": [ 
      { 
         "AwsTagKey": "string",
         "AwsTagValue": "string",
         "VmwareCategory": "string",
         "VmwareTagName": "string"
      }
   ]
}
```

## リクエストパラメーター
<a name="API_BGW_PutHypervisorPropertyMappings_RequestParameters"></a>

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

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

 ** [HypervisorArn](#API_BGW_PutHypervisorPropertyMappings_RequestSyntax) **   <a name="Backup-BGW_PutHypervisorPropertyMappings-request-HypervisorArn"></a>
ハイパーバイザーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。500 の最大長。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
必須: はい

 ** [IamRoleArn](#API_BGW_PutHypervisorPropertyMappings_RequestSyntax) **   <a name="Backup-BGW_PutHypervisorPropertyMappings-request-IamRoleArn"></a>
IAM ロールの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 20 です。最大長は 2,048 です。  
パターン: `arn:(aws|aws-cn|aws-us-gov):iam::([0-9]+):role/(\S+)`   
必須: はい

 ** [VmwareToAwsTagMappings](#API_BGW_PutHypervisorPropertyMappings_RequestSyntax) **   <a name="Backup-BGW_PutHypervisorPropertyMappings-request-VmwareToAwsTagMappings"></a>
このアクションは VMware タグと AWS タグとのマッピングをリクエストします。  
型: [VmwareToAwsTagMapping](API_BGW_VmwareToAwsTagMapping.md) オブジェクトの配列  
必須: はい

## レスポンスの構文
<a name="API_BGW_PutHypervisorPropertyMappings_ResponseSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

## レスポンス要素
<a name="API_BGW_PutHypervisorPropertyMappings_ResponseElements"></a>

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

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

 ** [HypervisorArn](#API_BGW_PutHypervisorPropertyMappings_ResponseSyntax) **   <a name="Backup-BGW_PutHypervisorPropertyMappings-response-HypervisorArn"></a>
ハイパーバイザーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。500 の最大長。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## エラー
<a name="API_BGW_PutHypervisorPropertyMappings_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** AccessDeniedException **   
権限が不足しているため、操作を続行できません。    
 ** ErrorCode **   
アクセス許可が不十分である理由の説明。
HTTP ステータスコード: 400

 ** ConflictException **   
サポートされていないため、操作を続行できません。    
 ** ErrorCode **   
操作がサポートされていない理由の説明。
HTTP ステータスコード: 400

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ResourceNotFoundException **   
アクションに必要なリソースが見つかりませんでした。    
 ** ErrorCode **   
見つからないリソースの説明。
HTTP ステータスコード: 400

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_PutHypervisorPropertyMappings_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 

# PutMaintenanceStartTime
<a name="API_BGW_PutMaintenanceStartTime"></a>

ゲートウェイのメンテナンス開始時間を設定します。

## リクエストの構文
<a name="API_BGW_PutMaintenanceStartTime_RequestSyntax"></a>

```
{
   "DayOfMonth": number,
   "DayOfWeek": number,
   "GatewayArn": "string",
   "HourOfDay": number,
   "MinuteOfHour": number
}
```

## リクエストパラメーター
<a name="API_BGW_PutMaintenanceStartTime_RequestParameters"></a>

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

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

 ** [DayOfMonth](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-DayOfMonth"></a>
ゲートウェイでメンテナンスを開始する月の日。  
有効な値の範囲は `Sunday`～`Saturday` です。  
タイプ: 整数  
有効な範囲: 最小値 は 1 です。最大値は 31 です。  
必須: いいえ

 ** [DayOfWeek](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-DayOfWeek"></a>
ゲートウェイのメンテナンスを開始する曜日。  
タイプ: 整数  
有効な範囲: 最小値 は 0 です。最大値は 6 です。  
必須: いいえ

 ** [GatewayArn](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-GatewayArn"></a>
メンテナンス開始時刻を指定するために使用するゲートウェイの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。最大長は 180 です。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
必須: はい

 ** [HourOfDay](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-HourOfDay"></a>
ゲートウェイでメンテナンスを開始する時間。  
タイプ: 整数  
有効な範囲: 最小値 は 0 です。最大値は 23 です。  
必須: はい

 ** [MinuteOfHour](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-MinuteOfHour"></a>
ゲートウェイでメンテナンスを開始する時間の分。  
タイプ: 整数  
有効な範囲: 最小値 は 0 です。最大値は 59 です。  
必須: はい

## レスポンスの構文
<a name="API_BGW_PutMaintenanceStartTime_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## レスポンス要素
<a name="API_BGW_PutMaintenanceStartTime_ResponseElements"></a>

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

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

 ** [GatewayArn](#API_BGW_PutMaintenanceStartTime_ResponseSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-response-GatewayArn"></a>
メンテナンス開始時間を設定したゲートウェイの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。最大長は 180 です。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## エラー
<a name="API_BGW_PutMaintenanceStartTime_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** ConflictException **   
サポートされていないため、操作を続行できません。    
 ** ErrorCode **   
操作がサポートされていない理由の説明。
HTTP ステータスコード: 400

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ResourceNotFoundException **   
アクションに必要なリソースが見つかりませんでした。    
 ** ErrorCode **   
見つからないリソースの説明。
HTTP ステータスコード: 400

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_PutMaintenanceStartTime_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/PutMaintenanceStartTime) 

# StartVirtualMachinesMetadataSync
<a name="API_BGW_StartVirtualMachinesMetadataSync"></a>

このアクションは、指定された仮想マシン間でメタデータを同期するリクエストを送信します。

## リクエストの構文
<a name="API_BGW_StartVirtualMachinesMetadataSync_RequestSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

## リクエストパラメーター
<a name="API_BGW_StartVirtualMachinesMetadataSync_RequestParameters"></a>

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

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

 ** [HypervisorArn](#API_BGW_StartVirtualMachinesMetadataSync_RequestSyntax) **   <a name="Backup-BGW_StartVirtualMachinesMetadataSync-request-HypervisorArn"></a>
ハイパーバイザーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。500 の最大長。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
必須: はい

## レスポンスの構文
<a name="API_BGW_StartVirtualMachinesMetadataSync_ResponseSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

## レスポンス要素
<a name="API_BGW_StartVirtualMachinesMetadataSync_ResponseElements"></a>

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

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

 ** [HypervisorArn](#API_BGW_StartVirtualMachinesMetadataSync_ResponseSyntax) **   <a name="Backup-BGW_StartVirtualMachinesMetadataSync-response-HypervisorArn"></a>
ハイパーバイザーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。500 の最大長。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## エラー
<a name="API_BGW_StartVirtualMachinesMetadataSync_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** AccessDeniedException **   
権限が不足しているため、操作を続行できません。    
 ** ErrorCode **   
アクセス許可が不十分である理由の説明。
HTTP ステータスコード: 400

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ResourceNotFoundException **   
アクションに必要なリソースが見つかりませんでした。    
 ** ErrorCode **   
見つからないリソースの説明。
HTTP ステータスコード: 400

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_StartVirtualMachinesMetadataSync_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 

# TagResource
<a name="API_BGW_TagResource"></a>

リソースをタグ付け。

## リクエストの構文
<a name="API_BGW_TagResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## リクエストパラメーター
<a name="API_BGW_TagResource_RequestParameters"></a>

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

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

 ** [ResourceARN](#API_BGW_TagResource_RequestSyntax) **   <a name="Backup-BGW_TagResource-request-ResourceARN"></a>
タグに対するのリソースの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。500 の最大長。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
必須: はい

 ** [Tags](#API_BGW_TagResource_RequestSyntax) **   <a name="Backup-BGW_TagResource-request-Tags"></a>
リソースに割り当てるタグのリスト。  
型: [Tag](API_BGW_Tag.md) オブジェクトの配列  
必須: はい

## レスポンスの構文
<a name="API_BGW_TagResource_ResponseSyntax"></a>

```
{
   "ResourceARN": "string"
}
```

## レスポンス要素
<a name="API_BGW_TagResource_ResponseElements"></a>

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

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

 ** [ResourceARN](#API_BGW_TagResource_ResponseSyntax) **   <a name="Backup-BGW_TagResource-response-ResourceARN"></a>
タグ付けした リソースの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。500 の最大長。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## エラー
<a name="API_BGW_TagResource_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ResourceNotFoundException **   
アクションに必要なリソースが見つかりませんでした。    
 ** ErrorCode **   
見つからないリソースの説明。
HTTP ステータスコード: 400

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_TagResource_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/TagResource) 

# TestHypervisorConfiguration
<a name="API_BGW_TestHypervisorConfiguration"></a>

ハイパーバイザー構成をテストして、バックアップゲートウェイがハイパーバイザーとそのリソースに接続できることを確認します。

## リクエストの構文
<a name="API_BGW_TestHypervisorConfiguration_RequestSyntax"></a>

```
{
   "GatewayArn": "string",
   "Host": "string",
   "Password": "string",
   "Username": "string"
}
```

## リクエストパラメーター
<a name="API_BGW_TestHypervisorConfiguration_RequestParameters"></a>

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

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

 ** [GatewayArn](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_TestHypervisorConfiguration-request-GatewayArn"></a>
テストするハイパーバイザーへのゲートウェイの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。最大長は 180 です。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
必須: はい

 ** [Host](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_TestHypervisorConfiguration-request-Host"></a>
ハイパーバイザーのサーバーホスト。これは、IP アドレスまたは完全修飾ドメイン名 (FQDN) のいずれかです。  
タイプ: 文字列  
長さの制約: 最小長は 3 です。最大長は 128 です。  
パターン: `.+`   
必須: はい

 ** [Password](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_TestHypervisorConfiguration-request-Password"></a>
ハイパーバイザーのパスワード。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 100 です。  
パターン: `[ -~]+`   
必須: いいえ

 ** [Username](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_TestHypervisorConfiguration-request-Username"></a>
ハイパーバイザーのユーザー名。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 100 です。  
パターン: `[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*`   
必須: いいえ

## レスポンス要素
<a name="API_BGW_TestHypervisorConfiguration_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

## エラー
<a name="API_BGW_TestHypervisorConfiguration_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** ConflictException **   
サポートされていないため、操作を続行できません。    
 ** ErrorCode **   
操作がサポートされていない理由の説明。
HTTP ステータスコード: 400

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ResourceNotFoundException **   
アクションに必要なリソースが見つかりませんでした。    
 ** ErrorCode **   
見つからないリソースの説明。
HTTP ステータスコード: 400

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_TestHypervisorConfiguration_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/TestHypervisorConfiguration) 

# UntagResource
<a name="API_BGW_UntagResource"></a>

リソースからタグを削除します。

## リクエストの構文
<a name="API_BGW_UntagResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string",
   "TagKeys": [ "string" ]
}
```

## リクエストパラメーター
<a name="API_BGW_UntagResource_RequestParameters"></a>

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

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

 ** [ResourceARN](#API_BGW_UntagResource_RequestSyntax) **   <a name="Backup-BGW_UntagResource-request-ResourceARN"></a>
タグを削除するリソースの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。500 の最大長。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
必須: はい

 ** [TagKeys](#API_BGW_UntagResource_RequestSyntax) **   <a name="Backup-BGW_UntagResource-request-TagKeys"></a>
削除するタグを指定するタグキーのリスト。  
型: 文字列の配列  
長さの制限：最小長 1、最大長は 128 です。  
パターン: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`   
必須: はい

## レスポンスの構文
<a name="API_BGW_UntagResource_ResponseSyntax"></a>

```
{
   "ResourceARN": "string"
}
```

## レスポンス要素
<a name="API_BGW_UntagResource_ResponseElements"></a>

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

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

 ** [ResourceARN](#API_BGW_UntagResource_ResponseSyntax) **   <a name="Backup-BGW_UntagResource-response-ResourceARN"></a>
タグを削除するリソースの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。500 の最大長。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## エラー
<a name="API_BGW_UntagResource_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ResourceNotFoundException **   
アクションに必要なリソースが見つかりませんでした。    
 ** ErrorCode **   
見つからないリソースの説明。
HTTP ステータスコード: 400

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_UntagResource_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/UntagResource) 

# UpdateGatewayInformation
<a name="API_BGW_UpdateGatewayInformation"></a>

ゲートウェイの名前を更新します。リクエストのゲートウェイの Amazon リソースネーム (ARN) を使用して、更新するゲートウェイを指定します。

## リクエストの構文
<a name="API_BGW_UpdateGatewayInformation_RequestSyntax"></a>

```
{
   "GatewayArn": "string",
   "GatewayDisplayName": "string"
}
```

## リクエストパラメーター
<a name="API_BGW_UpdateGatewayInformation_RequestParameters"></a>

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

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

 ** [GatewayArn](#API_BGW_UpdateGatewayInformation_RequestSyntax) **   <a name="Backup-BGW_UpdateGatewayInformation-request-GatewayArn"></a>
更新するゲートウェイの Amazon リソースネーム (ARN)  
タイプ: 文字列  
長さの制限: 最小長は 50 です。最大長は 180 です。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
必須: はい

 ** [GatewayDisplayName](#API_BGW_UpdateGatewayInformation_RequestSyntax) **   <a name="Backup-BGW_UpdateGatewayInformation-request-GatewayDisplayName"></a>
ゲートウェイの更新された表示名。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 100 です。  
パターン: `[a-zA-Z0-9-]*`   
必須: いいえ

## レスポンスの構文
<a name="API_BGW_UpdateGatewayInformation_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## レスポンス要素
<a name="API_BGW_UpdateGatewayInformation_ResponseElements"></a>

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

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

 ** [GatewayArn](#API_BGW_UpdateGatewayInformation_ResponseSyntax) **   <a name="Backup-BGW_UpdateGatewayInformation-response-GatewayArn"></a>
更新したゲートウェイの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。最大長は 180 です。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## エラー
<a name="API_BGW_UpdateGatewayInformation_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** ConflictException **   
サポートされていないため、操作を続行できません。    
 ** ErrorCode **   
操作がサポートされていない理由の説明。
HTTP ステータスコード: 400

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ResourceNotFoundException **   
アクションに必要なリソースが見つかりませんでした。    
 ** ErrorCode **   
見つからないリソースの説明。
HTTP ステータスコード: 400

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_UpdateGatewayInformation_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/UpdateGatewayInformation) 

# UpdateGatewaySoftwareNow
<a name="API_BGW_UpdateGatewaySoftwareNow"></a>

ゲートウェイ仮想マシン (VM) ソフトウェアを更新します。リクエストはただちにソフトウェアの更新をトリガーします。

**注記**  
このリクエストを行うと、すぐに `200 OK` 成功のレスポンスが返されます。ただし、更新が完了するまでにしばらくかかります。

## リクエストの構文
<a name="API_BGW_UpdateGatewaySoftwareNow_RequestSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## リクエストパラメーター
<a name="API_BGW_UpdateGatewaySoftwareNow_RequestParameters"></a>

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

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

 ** [GatewayArn](#API_BGW_UpdateGatewaySoftwareNow_RequestSyntax) **   <a name="Backup-BGW_UpdateGatewaySoftwareNow-request-GatewayArn"></a>
更新するゲートウェイの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。最大長は 180 です。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
必須: はい

## レスポンスの構文
<a name="API_BGW_UpdateGatewaySoftwareNow_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## レスポンス要素
<a name="API_BGW_UpdateGatewaySoftwareNow_ResponseElements"></a>

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

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

 ** [GatewayArn](#API_BGW_UpdateGatewaySoftwareNow_ResponseSyntax) **   <a name="Backup-BGW_UpdateGatewaySoftwareNow-response-GatewayArn"></a>
更新したゲートウェイの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。最大長は 180 です。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## エラー
<a name="API_BGW_UpdateGatewaySoftwareNow_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ResourceNotFoundException **   
アクションに必要なリソースが見つかりませんでした。    
 ** ErrorCode **   
見つからないリソースの説明。
HTTP ステータスコード: 400

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_UpdateGatewaySoftwareNow_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 

# UpdateHypervisor
<a name="API_BGW_UpdateHypervisor"></a>

ホスト、ユーザー名、パスワードなどのハイパーバイザーメタデータを更新します。リクエストのハイパーバイザーの Amazon リソースネーム (ARN) を使用して、更新するハイパーバイザーを指定します。

## リクエストの構文
<a name="API_BGW_UpdateHypervisor_RequestSyntax"></a>

```
{
   "Host": "string",
   "HypervisorArn": "string",
   "LogGroupArn": "string",
   "Name": "string",
   "Password": "string",
   "Username": "string"
}
```

## リクエストパラメーター
<a name="API_BGW_UpdateHypervisor_RequestParameters"></a>

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

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

 ** [Host](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-Host"></a>
ハイパーバイザーの更新されたホスト。これは、IP アドレスまたは完全修飾ドメイン名 (FQDN) のいずれかです。  
タイプ: 文字列  
長さの制約: 最小長は 3 です。最大長は 128 です。  
パターン: `.+`   
必須: いいえ

 ** [HypervisorArn](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-HypervisorArn"></a>
更新するハイパーバイザーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。500 の最大長。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
必須: はい

 ** [LogGroupArn](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-LogGroupArn"></a>
リクエストされたログ内のゲートウェイグループの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最小長は 0 です。最大長は 2,048 です。  
パターン: `$|^arn:(aws|aws-cn|aws-us-gov):logs:([a-zA-Z0-9-]+):([0-9]+):log-group:[a-zA-Z0-9_\-\/\.]+:\*`   
必須: いいえ

 ** [Name](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-Name"></a>
ハイパーバイザーの更新された名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 100 です。  
パターン: `[a-zA-Z0-9-]*`   
必須: いいえ

 ** [Password](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-Password"></a>
ハイパーバイザーの更新されたパスワード。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 100 です。  
パターン: `[ -~]+`   
必須: いいえ

 ** [Username](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-Username"></a>
ハイパーバイザーの更新されたユーザー名。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 100 です。  
パターン: `[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*`   
必須: いいえ

## レスポンスの構文
<a name="API_BGW_UpdateHypervisor_ResponseSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

## レスポンス要素
<a name="API_BGW_UpdateHypervisor_ResponseElements"></a>

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

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

 ** [HypervisorArn](#API_BGW_UpdateHypervisor_ResponseSyntax) **   <a name="Backup-BGW_UpdateHypervisor-response-HypervisorArn"></a>
更新したハイパーバイザーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 50 です。500 の最大長。  
パターン: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## エラー
<a name="API_BGW_UpdateHypervisor_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** AccessDeniedException **   
権限が不足しているため、操作を続行できません。    
 ** ErrorCode **   
アクセス許可が不十分である理由の説明。
HTTP ステータスコード: 400

 ** ConflictException **   
サポートされていないため、操作を続行できません。    
 ** ErrorCode **   
操作がサポートされていない理由の説明。
HTTP ステータスコード: 400

 ** InternalServerException **   
内部エラーが発生したために操作は成功しませんでした。後でもう一度お試しください。    
 ** ErrorCode **   
発生した内部エラーの説明。
HTTP ステータスコード: 500

 ** ResourceNotFoundException **   
アクションに必要なリソースが見つかりませんでした。    
 ** ErrorCode **   
見つからないリソースの説明。
HTTP ステータスコード: 400

 ** ThrottlingException **   
TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。    
 ** ErrorCode **   
エラー: TPS は、意図的なまたは意図的でない、大量のリクエストを防ぐために制限されています。
HTTP ステータスコード: 400

 ** ValidationException **   
検証エラーが発生したため、操作は成功しませんでした。    
 ** ErrorCode **   
検証エラーの原因の説明。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_BGW_UpdateHypervisor_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/UpdateHypervisor) 