Amazon Migration Hub · Schema
PutResourceAttributesRequest
PutResourceAttributesRequest schema from Amazon Migration Hub API
BroadcastingMedia ProcessingMedia
Properties
| Name | Type | Description |
|---|---|---|
| ProgressUpdateStream | object | |
| MigrationTaskName | object | |
| ResourceAttributeList | object | |
| DryRun | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-migration-hub/refs/heads/main/json-schema/migration-hub-api-put-resource-attributes-request-schema.json",
"title": "PutResourceAttributesRequest",
"description": "PutResourceAttributesRequest schema from Amazon Migration Hub API",
"type": "object",
"properties": {
"ProgressUpdateStream": {
"allOf": [
{
"$ref": "#/components/schemas/ProgressUpdateStream"
},
{
"description": "The name of the ProgressUpdateStream. "
}
]
},
"MigrationTaskName": {
"allOf": [
{
"$ref": "#/components/schemas/MigrationTaskName"
},
{
"description": "Unique identifier that references the migration task. <i>Do not store personal data in this field.</i> "
}
]
},
"ResourceAttributeList": {
"allOf": [
{
"$ref": "#/components/schemas/ResourceAttributeList"
},
{
"description": "<p>Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service repository.</p> <note> <p>Takes the object array of <code>ResourceAttribute</code> where the <code>Type</code> field is reserved for the following values: <code>IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER</code> where the identifying value can be a string up to 256 characters.</p> </note> <important> <ul> <li> <p>If any \"VM\" related value is set for a <code>ResourceAttribute</code> object, it is required that <code>VM_MANAGER_ID</code>, as a minimum, is always set. If <code>VM_MANAGER_ID</code> is not set, then all \"VM\" fields will be discarded and \"VM\" fields will not be used for matching the migration task to a server in Application Discovery Service repository. See the <a href=\"https://docs.aws.amazon.com/migrationhub/latest/ug/API_PutResourceAttributes.html#API_PutResourceAttributes_Examples\">Example</a> section below for a use case of specifying \"VM\" related values.</p> </li> <li> <p> If a server you are trying to match has multiple IP or MAC addresses, you should provide as many as you know in separate type/value pairs passed to the <code>ResourceAttributeList</code> parameter to maximize the chances of matching.</p> </li> </ul> </important>"
}
]
},
"DryRun": {
"allOf": [
{
"$ref": "#/components/schemas/DryRun"
},
{
"description": "Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call."
}
]
}
},
"required": [
"ProgressUpdateStream",
"MigrationTaskName",
"ResourceAttributeList"
]
}