DeadlineCloud / Client / assume_queue_role_for_user

assume_queue_role_for_user#

DeadlineCloud.Client.assume_queue_role_for_user(**kwargs)#

Allows a user to assume a role for a queue.

See also: AWS API Documentation

Request Syntax

response = client.assume_queue_role_for_user(
    farmId='string',
    queueId='string'
)
Parameters:

  • farmId (string) –

    [REQUIRED]

    The farm ID of the queue that the user assumes the role for.

  • queueId (string) –

    [REQUIRED]

    The queue ID of the queue that the user assumes the role for.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • credentials (dict) –

      The credentials for the queue role that a user has access to.

      • 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