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

GetEnvironment

Returns information for an environment.

Request Syntax


GET /environments/id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

id

The ID of the environment for which to return information.

Pattern: [a-z0-9]{9}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "environment": { 
      "activationCode": "string",
      "arn": "string",
      "createdAt": number,
      "desiredSoftwareSetId": "string",
      "desktopArn": "string",
      "desktopEndpoint": "string",
      "desktopType": "string",
      "deviceCreationTags": { 
         "string" : "string" 
      },
      "id": "string",
      "kmsKeyArn": "string",
      "maintenanceWindow": { 
         "applyTimeOf": "string",
         "daysOfTheWeek": [ "string" ],
         "endTimeHour": number,
         "endTimeMinute": number,
         "startTimeHour": number,
         "startTimeMinute": number,
         "type": "string"
      },
      "name": "string",
      "pendingSoftwareSetId": "string",
      "pendingSoftwareSetVersion": "string",
      "registeredDevicesCount": number,
      "softwareSetComplianceStatus": "string",
      "softwareSetUpdateMode": "string",
      "softwareSetUpdateSchedule": "string",
      "tags": { 
         "string" : "string" 
      },
      "updatedAt": number
   }
}

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.

environment

Describes an environment.

Type: Environment object

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.

retryAfterSeconds: The number of seconds to wait before retrying the next request.

HTTP Status Code: 500

ResourceNotFoundException

The resource specified in the request was not found.

resourceId: The ID of the resource associated with the request.
resourceType: The type of the resource associated with the request.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

quotaCode: The code for the quota in Service Quotas.
retryAfterSeconds: The number of seconds to wait before retrying the next request.
serviceCode: The code for the service in Service Quotas.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the specified constraints.

fieldList: A list of fields that didn't validate.
reason: The reason for the exception.

HTTP Status Code: 400