DeadlineCloud / Client / assume_queue_role_for_worker

assume_queue_role_for_worker

DeadlineCloud.Client.assume_queue_role_for_worker(**kwargs)

Allows a worker to assume a queue role.

See also: AWS API Documentation

Request Syntax

response = client.assume_queue_role_for_worker(
    farmId='string',
    fleetId='string',
    workerId='string',
    queueId='string'
)

Parameters:

• farmId (string) –

  [REQUIRED]

  The farm ID of the worker assuming the queue role.

• fleetId (string) –

  [REQUIRED]

  The fleet ID of the worker assuming the queue role.

• workerId (string) –

  [REQUIRED]

  The worker ID of the worker assuming the queue role.

• queueId (string) –

  [REQUIRED]

  The queue ID of the worker assuming the queue role.

Return type:

dict

Returns:

Response Syntax

{
    'credentials': {
        'accessKeyId': 'string',
        'secretAccessKey': 'string',
        'sessionToken': 'string',
        'expiration': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) –

  • credentials (dict) –

    The Amazon Web Services credentials for the role that the worker is assuming.

    • accessKeyId (string) –

      The IAM access key ID.

    • secretAccessKey (string) –

      The IAM secret access key.

    • sessionToken (string) –

      The IAM session token

    • expiration (datetime) –

      The expiration date and time of the IAM credentials.

Exceptions

• DeadlineCloud.Client.exceptions.AccessDeniedException

• DeadlineCloud.Client.exceptions.InternalServerErrorException

• DeadlineCloud.Client.exceptions.ResourceNotFoundException

• DeadlineCloud.Client.exceptions.ThrottlingException

• DeadlineCloud.Client.exceptions.ConflictException

• DeadlineCloud.Client.exceptions.ValidationException