WorkSpacesThinClient / Client / list_environments

list_environments#

WorkSpacesThinClient.Client.list_environments(**kwargs)#

Returns a list of environments.

See also: AWS API Documentation

Request Syntax

response = client.list_environments(
    nextToken='string',
    maxResults=123
)
Parameters:

  • nextToken (string) – 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.

  • maxResults (integer) –

    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.

Return type:

dict

Returns:

Response Syntax

{
    'environments': [
        {
            'id': 'string',
            'name': 'string',
            'desktopArn': 'string',
            'desktopEndpoint': 'string',
            'desktopType': 'workspaces'|'appstream'|'workspaces-web',
            'activationCode': 'string',
            'softwareSetUpdateSchedule': 'USE_MAINTENANCE_WINDOW'|'APPLY_IMMEDIATELY',
            'maintenanceWindow': {
                'type': 'SYSTEM'|'CUSTOM',
                'startTimeHour': 123,
                'startTimeMinute': 123,
                'endTimeHour': 123,
                'endTimeMinute': 123,
                'daysOfTheWeek': [
                    'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
                ],
                'applyTimeOf': 'UTC'|'DEVICE'
            },
            'softwareSetUpdateMode': 'USE_LATEST'|'USE_DESIRED',
            'desiredSoftwareSetId': 'string',
            'pendingSoftwareSetId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'arn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • environments (list) –

      Describes environments.

      • (dict) –

        Describes an environment.

        • id (string) –

          The ID of the environment.

        • name (string) –

          The name of the environment.

        • desktopArn (string) –

          The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.

        • desktopEndpoint (string) –

          The URL for the identity provider login (only for environments that use AppStream 2.0).

        • desktopType (string) –

          The type of streaming desktop for the environment.

        • activationCode (string) –

          The activation code to register a device to the environment.

        • softwareSetUpdateSchedule (string) –

          An option to define if software updates should be applied within a maintenance window.

        • maintenanceWindow (dict) –

          A specification for a time window to apply software updates.

          • type (string) –

            An option to select the default or custom maintenance window.

          • startTimeHour (integer) –

            The hour for the maintenance window start ( 00- 23).

          • startTimeMinute (integer) –

            The minutes past the hour for the maintenance window start ( 00- 59).

          • endTimeHour (integer) –

            The hour for the maintenance window end ( 00- 23).

          • endTimeMinute (integer) –

            The minutes for the maintenance window end ( 00- 59).

          • daysOfTheWeek (list) –

            The days of the week during which the maintenance window is open.

            • (string) –

          • applyTimeOf (string) –

            The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).

        • softwareSetUpdateMode (string) –

          An option to define which software updates to apply.

        • desiredSoftwareSetId (string) –

          The ID of the software set to apply.

        • pendingSoftwareSetId (string) –

          The ID of the software set that is pending to be installed.

        • createdAt (datetime) –

          The timestamp of when the environment was created.

        • updatedAt (datetime) –

          The timestamp of when the device was updated.

        • arn (string) –

          The Amazon Resource Name (ARN) of the environment.

    • nextToken (string) –

      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.

Exceptions