The #X Amz Target=AWSMigrationHub.NotifyMigrationTaskState API from Amazon Migration Hub — 1 operation(s) for #x amz target=awsmigrationhub.notifymigrationtaskstate.
openapi: 3.0.0
info:
version: 2017-05-31
x-release: v4
title: 'AWS Migration Hub #X Amz Target=AWSMigrationHub.AssociateCreatedArtifact #X Amz Target=AWSMigrationHub.AssociateCreatedArtifact #X Amz Target=AWSMigrationHub.NotifyMigrationTaskState API'
description: <p>The AWS Migration Hub API methods help to obtain server and application migration status and integrate your resource-specific migration tool by providing a programmatic interface to Migration Hub.</p> <p>Remember that you must set your AWS Migration Hub home region before you call any of these APIs, or a <code>HomeRegionNotSetException</code> error will be returned. Also, you must make the API calls while in your home region.</p>
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: AWSMigrationHub
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/AWSMigrationHub-2017-05-31.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://mgh.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS Migration Hub multi-region endpoint
- url: https://mgh.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS Migration Hub multi-region endpoint
- url: http://mgh.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS Migration Hub endpoint for China (Beijing) and China (Ningxia)
- url: https://mgh.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS Migration Hub endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=AWSMigrationHub.NotifyMigrationTaskState'
paths:
/#X-Amz-Target=AWSMigrationHub.NotifyMigrationTaskState:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: NotifyMigrationTaskState
description: <p>Notifies Migration Hub of the current status, progress, or other detail regarding a migration task. This API has the following traits:</p> <ul> <li> <p>Migration tools will call the <code>NotifyMigrationTaskState</code> API to share the latest progress and status.</p> </li> <li> <p> <code>MigrationTaskName</code> is used for addressing updates to the correct target.</p> </li> <li> <p> <code>ProgressUpdateStream</code> is used for access control and to provide a namespace for each migration tool.</p> </li> </ul>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/NotifyMigrationTaskStateResult'
examples:
NotifyMigrationTaskState200Example:
summary: Default NotifyMigrationTaskState 200 response
x-microcks-default: true
value: {}
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
NotifyMigrationTaskState480Example:
summary: Default NotifyMigrationTaskState 480 response
x-microcks-default: true
value: {}
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
NotifyMigrationTaskState481Example:
summary: Default NotifyMigrationTaskState 481 response
x-microcks-default: true
value: {}
'482':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
examples:
NotifyMigrationTaskState482Example:
summary: Default NotifyMigrationTaskState 482 response
x-microcks-default: true
value: {}
'483':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
examples:
NotifyMigrationTaskState483Example:
summary: Default NotifyMigrationTaskState 483 response
x-microcks-default: true
value: {}
'484':
description: DryRunOperation
content:
application/json:
schema:
$ref: '#/components/schemas/DryRunOperation'
examples:
NotifyMigrationTaskState484Example:
summary: Default NotifyMigrationTaskState 484 response
x-microcks-default: true
value: {}
'485':
description: UnauthorizedOperation
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedOperation'
examples:
NotifyMigrationTaskState485Example:
summary: Default NotifyMigrationTaskState 485 response
x-microcks-default: true
value: {}
'486':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
NotifyMigrationTaskState486Example:
summary: Default NotifyMigrationTaskState 486 response
x-microcks-default: true
value: {}
'487':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
NotifyMigrationTaskState487Example:
summary: Default NotifyMigrationTaskState 487 response
x-microcks-default: true
value: {}
'488':
description: HomeRegionNotSetException
content:
application/json:
schema:
$ref: '#/components/schemas/HomeRegionNotSetException'
examples:
NotifyMigrationTaskState488Example:
summary: Default NotifyMigrationTaskState 488 response
x-microcks-default: true
value: {}
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NotifyMigrationTaskStateRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSMigrationHub.NotifyMigrationTaskState
summary: Amazon Migration Hub Notify Migration Task State
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=AWSMigrationHub.NotifyMigrationTaskState'
components:
parameters:
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
schemas:
MigrationTaskName:
type: string
pattern: '[^:|]+'
minLength: 1
maxLength: 256
InvalidInputException: {}
UpdateDateTime:
type: string
format: date-time
AccessDeniedException: {}
ServiceUnavailableException: {}
ProgressPercent:
type: integer
minimum: 0
maximum: 100
InternalServerError: {}
DryRunOperation: {}
ThrottlingException: {}
NextUpdateSeconds:
type: integer
minimum: 0
UnauthorizedOperation: {}
Status:
type: string
enum:
- NOT_STARTED
- IN_PROGRESS
- FAILED
- COMPLETED
ProgressUpdateStream:
type: string
pattern: '[^/:|\000-\037]+'
minLength: 1
maxLength: 50
HomeRegionNotSetException: {}
Task:
type: object
required:
- Status
properties:
Status:
allOf:
- $ref: '#/components/schemas/Status'
- description: Status of the task - Not Started, In-Progress, Complete.
StatusDetail:
allOf:
- $ref: '#/components/schemas/StatusDetail'
- description: Details of task status as notified by a migration tool. A tool might use this field to provide clarifying information about the status that is unique to that tool or that explains an error state.
ProgressPercent:
allOf:
- $ref: '#/components/schemas/ProgressPercent'
- description: Indication of the percentage completion of the task.
description: Task object encapsulating task information.
DryRun:
type: boolean
NotifyMigrationTaskStateResult:
type: object
properties: {}
NotifyMigrationTaskStateRequest:
type: object
required:
- ProgressUpdateStream
- MigrationTaskName
- Task
- UpdateDateTime
- NextUpdateSeconds
title: NotifyMigrationTaskStateRequest
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> '
Task:
allOf:
- $ref: '#/components/schemas/Task'
- description: Information about the task's progress and status.
UpdateDateTime:
allOf:
- $ref: '#/components/schemas/UpdateDateTime'
- description: The timestamp when the task was gathered.
NextUpdateSeconds:
allOf:
- $ref: '#/components/schemas/NextUpdateSeconds'
- description: Number of seconds after the UpdateDateTime within which the Migration Hub can expect an update. If Migration Hub does not receive an update within the specified interval, then the migration task will be considered stale.
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.
ResourceNotFoundException: {}
StatusDetail:
type: string
pattern: ^.{0,500}$
minLength: 0
maxLength: 500
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/mgh/
x-hasEquivalentPaths: true