The #X Amz Target=AWSMigrationHub.ListApplicationStates API from Amazon Migration Hub — 1 operation(s) for #x amz target=awsmigrationhub.listapplicationstates.
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: <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.ListApplicationStates'
paths:
/#X-Amz-Target=AWSMigrationHub.ListApplicationStates:
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: ListApplicationStates
description: Lists all the migration statuses for your applications. If you use the optional <code>ApplicationIds</code> 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 <code>NextToken</code> 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 <code>NextToken</code>.
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 <code>NextToken</code> 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 <code>NextToken</code>.
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