Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListEnvironments

Lists AWS Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account.

Request Syntax


GET /environments?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

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

{
   "EnvironmentSummaryList": [ 
      { 
         "Arn": "string",
         "CreatedTime": number,
         "Description": "string",
         "EnvironmentId": "string",
         "Error": { 
            "AccountId": "string",
            "AdditionalDetails": { 
               "string" : "string" 
            },
            "Code": "string",
            "Message": "string",
            "ResourceIdentifier": "string",
            "ResourceType": "string"
         },
         "LastUpdatedTime": number,
         "Name": "string",
         "NetworkFabricType": "string",
         "OwnerAccountId": "string",
         "State": "string",
         "Tags": { 
            "string" : "string" 
         },
         "TransitGatewayId": "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.

EnvironmentSummaryList

The list of EnvironmentSummary objects.

Type: Array of EnvironmentSummary 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

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

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