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

ListEnvironments

Returns a list of environments.

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 that are returned per call. You can use nextToken to obtain further pages of results.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

Valid Range: Minimum value of 1. Maximum value of 50.

nextToken

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: \S*

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "environments": [ 
      { 
         "activationCode": "string",
         "arn": "string",
         "createdAt": number,
         "desiredSoftwareSetId": "string",
         "desktopArn": "string",
         "desktopEndpoint": "string",
         "desktopType": "string",
         "id": "string",
         "maintenanceWindow": { 
            "applyTimeOf": "string",
            "daysOfTheWeek": [ "string" ],
            "endTimeHour": number,
            "endTimeMinute": number,
            "startTimeHour": number,
            "startTimeMinute": number,
            "type": "string"
         },
         "name": "string",
         "pendingSoftwareSetId": "string",
         "softwareSetUpdateMode": "string",
         "softwareSetUpdateSchedule": "string",
         "updatedAt": number
      }
   ],
   "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.

environments

Describes environments.

Type: Array of EnvironmentSummary objects

nextToken

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: \S*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The server encountered an internal error and is unable to complete the request.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the specified constraints.

HTTP Status Code: 400