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.ListApplicationStates API' description:
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.
Remember that you must set your AWS Migration Hub home region before you call any of these APIs, or a HomeRegionNotSetException error will be returned. Also, you must make the API calls while in your home region.
ApplicationIds parameter, only the migration statuses for those applications will be returned.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListApplicationStatesResult'
examples:
ListApplicationStates200Example:
summary: Default ListApplicationStates 200 response
x-microcks-default: true
value:
ApplicationStateList: example-value
NextToken: example-value
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
ListApplicationStates480Example:
summary: Default ListApplicationStates 480 response
x-microcks-default: true
value: {}
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
ListApplicationStates481Example:
summary: Default ListApplicationStates 481 response
x-microcks-default: true
value: {}
'482':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
examples:
ListApplicationStates482Example:
summary: Default ListApplicationStates 482 response
x-microcks-default: true
value: {}
'483':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
examples:
ListApplicationStates483Example:
summary: Default ListApplicationStates 483 response
x-microcks-default: true
value: {}
'484':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
ListApplicationStates484Example:
summary: Default ListApplicationStates 484 response
x-microcks-default: true
value: {}
'485':
description: HomeRegionNotSetException
content:
application/json:
schema:
$ref: '#/components/schemas/HomeRegionNotSetException'
examples:
ListApplicationStates485Example:
summary: Default ListApplicationStates 485 response
x-microcks-default: true
value: {}
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListApplicationStatesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSMigrationHub.ListApplicationStates
summary: Amazon Migration Hub List Application States
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=AWSMigrationHub.ListApplicationStates'
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:
InvalidInputException: {}
UpdateDateTime:
type: string
format: date-time
AccessDeniedException: {}
ServiceUnavailableException: {}
ApplicationState:
type: object
properties:
ApplicationId:
allOf:
- $ref: '#/components/schemas/ApplicationId'
- description: The configurationId from the Application Discovery Service that uniquely identifies an application.
ApplicationStatus:
allOf:
- $ref: '#/components/schemas/ApplicationStatus'
- description: The current status of an application.
LastUpdatedTime:
allOf:
- $ref: '#/components/schemas/UpdateDateTime'
- description: The timestamp when the application status was last updated.
description: The state of an application discovered through Migration Hub import, the AWS Agentless Discovery Connector, or the AWS Application Discovery Agent.
InternalServerError: {}
ThrottlingException: {}
ApplicationIds:
type: array
items:
$ref: '#/components/schemas/ApplicationId'
minItems: 1
maxItems: 100
HomeRegionNotSetException: {}
ApplicationStatus:
type: string
enum:
- NOT_STARTED
- IN_PROGRESS
- COMPLETED
ApplicationId:
type: string
pattern: ^.{1,1600}$
minLength: 1
maxLength: 1600
MaxResults:
type: integer
minimum: 1
maximum: 100
Token:
type: string
pattern: ^[a-zA-Z0-9\/\+\=]{0,2048}$
minLength: 0
maxLength: 2048
ListApplicationStatesRequest:
type: object
title: ListApplicationStatesRequest
properties:
ApplicationIds:
allOf:
- $ref: '#/components/schemas/ApplicationIds'
- description: The configurationIds from the Application Discovery Service that uniquely identifies your applications.
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: Maximum number of results to be returned per page.
ApplicationStateList:
type: array
items:
$ref: '#/components/schemas/ApplicationState'
minItems: 0
maxItems: 1000
ListApplicationStatesResult:
type: object
properties:
ApplicationStateList:
allOf:
- $ref: '#/components/schemas/ApplicationStateList'
- description: A list of Applications that exist in Application Discovery Service.
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.
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