PutHypervisorPropertyMappings
This action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the hypervisor to the properties available in AWS.
Request Syntax
{
"HypervisorArn": "string",
"IamRoleArn": "string",
"VmwareToAwsTagMappings": [
{
"AwsTagKey": "string",
"AwsTagValue": "string",
"VmwareCategory": "string",
"VmwareTagName": "string"
}
]
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- HypervisorArn
-
The Amazon Resource Name (ARN) of the hypervisor.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern:
^arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+$Required: Yes
- IamRoleArn
-
The Amazon Resource Name (ARN) of the IAM role.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:(aws|aws-cn|aws-us-gov):iam::([0-9]+):role/(\S+)$Required: Yes
- VmwareToAwsTagMappings
-
This action requests the mappings of VMware tags to the AWS tags.
Type: Array of VmwareToAwsTagMapping objects
Required: Yes
Response Syntax
{
"HypervisorArn": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- HypervisorArn
-
The Amazon Resource Name (ARN) of the hypervisor.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern:
^arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+$
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The operation cannot proceed because you have insufficient permissions.
HTTP Status Code: 400
- ConflictException
-
The operation cannot proceed because it is not supported.
HTTP Status Code: 400
- InternalServerException
-
The operation did not succeed because an internal error occurred. Try again later.
HTTP Status Code: 500
- ResourceNotFoundException
-
A resource that is required for the action wasn't found.
HTTP Status Code: 400
- ThrottlingException
-
TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
- ValidationException
-
The operation did not succeed because a validation error occurred.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
