ListApplications
Lists all the AWS Migration Hub Refactor Spaces applications within an environment.
Request Syntax
GET /environments/EnvironmentIdentifier
/applications?maxResults=MaxResults
&nextToken=NextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- EnvironmentIdentifier
-
The ID of the environment.
Length Constraints: Fixed length of 14.
Pattern:
^env-[0-9A-Za-z]{10}$
Required: Yes
- MaxResults
-
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned
nextToken
value.Valid Range: Minimum value of 1. Maximum value of 100.
- NextToken
-
The token for the next page of results.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^[a-zA-Z0-9/\+\=]{0,2048}$
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ApplicationSummaryList": [
{
"ApiGatewayProxy": {
"ApiGatewayId": "string",
"EndpointType": "string",
"NlbArn": "string",
"NlbName": "string",
"ProxyUrl": "string",
"StageName": "string",
"VpcLinkId": "string"
},
"ApplicationId": "string",
"Arn": "string",
"CreatedByAccountId": "string",
"CreatedTime": number,
"EnvironmentId": "string",
"Error": {
"AccountId": "string",
"AdditionalDetails": {
"string" : "string"
},
"Code": "string",
"Message": "string",
"ResourceIdentifier": "string",
"ResourceType": "string"
},
"LastUpdatedTime": number,
"Name": "string",
"OwnerAccountId": "string",
"ProxyType": "string",
"State": "string",
"Tags": {
"string" : "string"
},
"VpcId": "string"
}
],
"NextToken": "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.
- ApplicationSummaryList
-
The list of
ApplicationSummary
objects.Type: Array of ApplicationSummary objects
- NextToken
-
The token for the next page of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^[a-zA-Z0-9/\+\=]{0,2048}$
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The user does not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
Updating or deleting a resource can cause an inconsistent state.
HTTP Status Code: 409
- InternalServerException
-
An unexpected error occurred while processing the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The request references a resource that does not exist.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
The request would cause a service quota to be exceeded.
HTTP Status Code: 402
- ThrottlingException
-
Request was denied because the request was throttled.
HTTP Status Code: 429
- ValidationException
-
The input does not satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: