CodeCatalyst / Client / list_dev_environment_sessions

list_dev_environment_sessions#

CodeCatalyst.Client.list_dev_environment_sessions(**kwargs)#

Retrieves a list of active sessions for a Dev Environment in a project.

See also: AWS API Documentation

Request Syntax

response = client.list_dev_environment_sessions(
    spaceName='string',
    projectName='string',
    devEnvironmentId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • spaceName (string) –

    [REQUIRED]

    The name of the space.

  • projectName (string) –

    [REQUIRED]

    The name of the project in the space.

  • devEnvironmentId (string) –

    [REQUIRED]

    The system-generated unique ID of the Dev Environment.

  • nextToken (string) – A token returned from a call to this API to indicate the next batch of results to return, if any.

  • maxResults (integer) – The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'spaceName': 'string',
            'projectName': 'string',
            'devEnvironmentId': 'string',
            'startedTime': datetime(2015, 1, 1),
            'id': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      Information about each session retrieved in the list.

      • (dict) –

        Information about active sessions for a Dev Environment.

        • spaceName (string) –

          The name of the space.

        • projectName (string) –

          The name of the project in the space.

        • devEnvironmentId (string) –

          The system-generated unique ID of the Dev Environment.

        • startedTime (datetime) –

          The date and time the session started, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

        • id (string) –

          The system-generated unique ID of the Dev Environment session.

    • nextToken (string) –

      A token returned from a call to this API to indicate the next batch of results to return, if any.

Exceptions

  • CodeCatalyst.Client.exceptions.ThrottlingException

  • CodeCatalyst.Client.exceptions.ConflictException

  • CodeCatalyst.Client.exceptions.ValidationException

  • CodeCatalyst.Client.exceptions.ServiceQuotaExceededException

  • CodeCatalyst.Client.exceptions.ResourceNotFoundException

  • CodeCatalyst.Client.exceptions.AccessDeniedException