DeadlineCloud / Client / get_queue_environment

get_queue_environment

DeadlineCloud.Client.get_queue_environment(**kwargs)

Gets a queue environment.

See also: AWS API Documentation

Request Syntax

response = client.get_queue_environment(
    farmId='string',
    queueId='string',
    queueEnvironmentId='string'
)

Parameters:

• farmId (string) –

  [REQUIRED]

  The farm ID for the queue environment.

• queueId (string) –

  [REQUIRED]

  The queue ID for the queue environment.

• queueEnvironmentId (string) –

  [REQUIRED]

  The queue environment ID.

Return type:

dict

Returns:

Response Syntax

{
    'queueEnvironmentId': 'string',
    'name': 'string',
    'priority': 123,
    'templateType': 'JSON'|'YAML',
    'template': 'string',
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string'
}

Response Structure

• (dict) –

  • queueEnvironmentId (string) –

    The queue environment ID.

  • name (string) –

    The name of the queue environment.

  • priority (integer) –

    The priority of the queue environment.

  • templateType (string) –

    The type of template for the queue environment.

  • template (string) –

    The template for the queue environment.

  • createdAt (datetime) –

    The date and time the resource was created.

  • createdBy (string) –

    The user or system that created this resource.>

  • updatedAt (datetime) –

    The date and time the resource was updated.

  • updatedBy (string) –

    The user or system that updated this resource.

Exceptions

• DeadlineCloud.Client.exceptions.AccessDeniedException

• DeadlineCloud.Client.exceptions.InternalServerErrorException

• DeadlineCloud.Client.exceptions.ResourceNotFoundException

• DeadlineCloud.Client.exceptions.ThrottlingException

• DeadlineCloud.Client.exceptions.ValidationException