Python client for Taskcluster

These details have not been verified by PyPI

Project links

Homepage

Project description

Taskcluster Client for Python

This is a library used to interact with Taskcluster within Python programs. It presents the entire REST API to consumers as well as being able to generate URLs Signed by Hawk credentials. It can also generate routing keys for listening to pulse messages from Taskcluster.

The library builds the REST API methods from the Taskcluster API definitions provided in the Taskcluster repository.

Generating Temporary Credentials

If you have non-temporary taskcluster credentials you can generate a set of temporary credentials as follows. Notice that the credentials cannot last more than 31 days, and you can only revoke them by revoking the credentials that was used to issue them (this takes up to one hour).

It is not the responsibility of the caller to apply any clock drift adjustment to the start or expiry time - this is handled by the auth service directly.

import datetime

start = datetime.datetime.now()
expiry = start + datetime.timedelta(0,60)
scopes = ['ScopeA', 'ScopeB']
name = 'foo'

credentials = taskcluster.createTemporaryCredentials(
    # issuing clientId
    clientId,
    # issuing accessToken
    accessToken,
    # Validity of temporary credentials starts here, in timestamp
    start,
    # Expiration of temporary credentials, in timestamp
    expiry,
    # Scopes to grant the temporary credentials
    scopes,
    # credential name (optional)
    name
)

You cannot use temporary credentials to issue new temporary credentials. You must have auth:create-client:<name> to create a named temporary credential, but unnamed temporary credentials can be created regardless of your scopes.

API Documentation

The REST API methods are documented in the reference docs.

Query-String arguments

Query string arguments are now supported. In order to use them, you can call a method like this:

queue.listTaskGroup('JzTGxwxhQ76_Tt1dxkaG5g', query={'continuationToken': outcome.get('continuationToken')})

These query-string arguments are only supported using this calling convention

Sync vs Async

The objects under taskcluster (e.g., taskcluster.Queue) are python2-compatible and operate synchronously.

The objects under taskcluster.aio (e.g., taskcluster.aio.Queue) require python>=3.6. The async objects use asyncio coroutines for concurrency; this allows us to put I/O operations in the background, so operations that require the cpu can happen sooner. Given dozens of operations that can run concurrently (e.g., cancelling a medium-to-large task graph), this can result in significant performance improvements. The code would look something like

#!/usr/bin/env python
import aiohttp
import asyncio
from taskcluster.aio import Auth

async def do_ping():
    with aiohttp.ClientSession() as session:
        a = Auth(session=session)
        print(await a.ping())

loop = asyncio.get_event_loop()
loop.run_until_complete(do_ping())

Other async code examples are available here.

Here's a slide deck for an introduction to async python.

Usage

Here's a simple command:

import taskcluster
index = taskcluster.Index({
  'rootUrl': 'https://tc.example.com',
  'credentials': {'clientId': 'id', 'accessToken': 'accessToken'},
})
index.ping()

There are four calling conventions for methods:

client.method(v1, v1, payload)
client.method(payload, k1=v1, k2=v2)
client.method(payload=payload, query=query, params={k1: v1, k2: v2})
client.method(v1, v2, payload=payload, query=query)

Options for the topic exchange methods can be in the form of either a single dictionary argument or keyword arguments. Only one form is allowed

from taskcluster import client
qEvt = client.QueueEvents({rootUrl: 'https://tc.example.com'})
# The following calls are equivalent
qEvt.taskCompleted({'taskId': 'atask'})
qEvt.taskCompleted(taskId='atask')

Generating URLs

It is often necessary to generate the URL for an API method without actually calling the method. To do so, use buildUrl or, for an API method that requires authentication, buildSignedUrl.

import taskcluster

index = taskcluster.Index(taskcluster.optionsFromEnvironment())
print(index.buildUrl('findTask', 'builds.v1.latest'))
secrets = taskcluster.Secrets(taskcluster.optionsFromEnvironment())
print(secret.buildSignedUrl('get', 'my-secret'))

Note that signed URLs are time-limited; the expiration can be set with the signedUrlExpiration option to the client constructor, or with the expiration keyword arguement to buildSignedUrl, both given in seconds.

Root URL

This client requires a rootUrl argument to identify the Taskcluster deployment to talk to. As of this writing, the production cluster has rootUrl https://taskcluster.net.

Environment Variables

As of version 6.0.0, the client does not read the standard TASKCLUSTER_… environment variables automatically. To fetch their values explicitly, use taskcluster.optionsFromEnvironment():

auth = taskcluster.Auth(taskcluster.optionsFromEnvironment())

Pagination

There are two ways to accomplish pagination easily with the python client. The first is to implement pagination in your code:

import taskcluster
queue = taskcluster.Queue({'rootUrl': 'https://tc.example.com'})
i = 0
tasks = 0
outcome = queue.listTaskGroup('JzTGxwxhQ76_Tt1dxkaG5g')
while outcome.get('continuationToken'):
    print('Response %d gave us %d more tasks' % (i, len(outcome['tasks'])))
    if outcome.get('continuationToken'):
        outcome = queue.listTaskGroup('JzTGxwxhQ76_Tt1dxkaG5g', query={'continuationToken': outcome.get('continuationToken')})
    i += 1
    tasks += len(outcome.get('tasks', []))
print('Task Group %s has %d tasks' % (outcome['taskGroupId'], tasks))

There's also an experimental feature to support built in automatic pagination in the sync client. This feature allows passing a callback as the 'paginationHandler' keyword-argument. This function will be passed the response body of the API method as its sole positional arugment.

This example of the built in pagination shows how a list of tasks could be built and then counted:

import taskcluster
queue = taskcluster.Queue({'rootUrl': 'https://tc.example.com'})

responses = []

def handle_page(y):
    print("%d tasks fetched" % len(y.get('tasks', [])))
    responses.append(y)

queue.listTaskGroup('JzTGxwxhQ76_Tt1dxkaG5g', paginationHandler=handle_page)

tasks = 0
for response in responses:
    tasks += len(response.get('tasks', []))

print("%d requests fetch %d tasks" % (len(responses), tasks))

Logging

Logging is set up in taskcluster/__init__.py. If the special DEBUG_TASKCLUSTER_CLIENT environment variable is set, the __init__.py module will set the logging module's level for its logger to logging.DEBUG and if there are no existing handlers, add a logging.StreamHandler() instance. This is meant to assist those who do not wish to bother figuring out how to configure the python logging module but do want debug messages

SlugIDs

To generate slugIds (Taskcluster's client-generated unique IDs), use taskcluster.slugId(), which will return a unique slugId on each call.

In some cases it is useful to be able to create a mapping from names to slugIds, with the ability to generate the same slugId multiple times. The taskcluster.stableSlugId() function returns a callable that does just this.

gen = taskcluster.stableSlugId()
sometask = gen('sometask')
assert gen('sometask') == sometask  # same input generates same output
assert gen('sometask') != gen('othertask')

gen2 = taskcluster.stableSlugId()
sometask2 = gen('sometask')
assert sometask2 != sometask  # but different slugId generators produce
                              # different output

Scopes

The scopeMatch(assumedScopes, requiredScopeSets) function determines whether one or more of a set of required scopes are satisfied by the assumed scopes, taking *-expansion into account. This is useful for making local decisions on scope satisfaction, but note that assumed_scopes must be the expanded scopes, as this function cannot perform expansion.

It takes a list of a assumed scopes, and a list of required scope sets on disjunctive normal form, and checks if any of the required scope sets are satisfied.

Example:

    requiredScopeSets = [
        ["scopeA", "scopeB"],
        ["scopeC:*"]
    ]
    assert scopesMatch(['scopeA', 'scopeB'], requiredScopeSets)
    assert scopesMatch(['scopeC:xyz'], requiredScopeSets)
    assert not scopesMatch(['scopeA'], requiredScopeSets)
    assert not scopesMatch(['scopeC'], requiredScopeSets)

Relative Date-time Utilities

A lot of taskcluster APIs requires ISO 8601 time stamps offset into the future as way of providing expiration, deadlines, etc. These can be easily created using datetime.datetime.isoformat(), however, it can be rather error prone and tedious to offset datetime.datetime objects into the future. Therefore this library comes with two utility functions for this purposes.

dateObject = taskcluster.fromNow("2 days 3 hours 1 minute")
# datetime.datetime(2017, 1, 21, 17, 8, 1, 607929)
dateString = taskcluster.fromNowJSON("2 days 3 hours 1 minute")
# '2017-01-21T17:09:23.240178Z'

By default it will offset the date time into the future, if the offset strings are prefixed minus (-) the date object will be offset into the past. This is useful in some corner cases.

dateObject = taskcluster.fromNow("- 1 year 2 months 3 weeks 5 seconds");
# datetime.datetime(2015, 10, 30, 18, 16, 50, 931161)

The offset string is ignorant of whitespace and case insensitive. It may also optionally be prefixed plus + (if not prefixed minus), any + prefix will be ignored. However, entries in the offset string must be given in order from high to low, ie. 2 years 1 day. Additionally, various shorthands may be employed, as illustrated below.

  years,    year,   yr,   y
  months,   month,  mo
  weeks,    week,         w
  days,     day,          d
  hours,    hour,         h
  minutes,  minute, min
  seconds,  second, sec,  s

The fromNow method may also be given a date to be relative to as a second argument. This is useful if offset the task expiration relative to the the task deadline or doing something similar. This argument can also be passed as the kwarg dateObj

dateObject1 = taskcluster.fromNow("2 days 3 hours");
dateObject2 = taskcluster.fromNow("1 year", dateObject1);
taskcluster.fromNow("1 year", dateObj=dateObject1);
# datetime.datetime(2018, 1, 21, 17, 59, 0, 328934)

Library helpers to easily integrate Taskcluster in your project

The Python Taskcluster client has a module taskcluster.helper with utilities which allows you to easily share authentication options across multiple services in your project.

Generally a project using this library will face different use cases and authentication options:

No authentication for a new contributor without Taskcluster access,
Specific client credentials through environment variables on a developer's computer,
Taskcluster Proxy when running inside a task.

Shared authentication

The class taskcluster.helper.TaskclusterConfig is made to be instantiated once in your project, usually in a top level module. That singleton is then accessed by different parts of your projects, whenever a Taskcluster service is needed.

Here is a sample usage:

in project/__init__.py, no call to Taskcluster is made at that point:

from taskcluster.helper import Taskcluster config

tc = TaskclusterConfig('https://community-tc.services.mozilla.com')

in project/boot.py, we authenticate on Taskcuster with provided credentials, or environment variables, or taskcluster proxy (in that order):

from project import tc

tc.auth(client_id='XXX', access_token='YYY')

at that point, you can load any service using the authenticated wrapper from anywhere in your code:

from project import tc

# Synchronous service class
queue = tc.get_service('queue')

# Asynchronous service class
hooks = tc.get_service('hooks', use_async=True)

# You can then use these classes as documented below:
queue.ping()
await hooks.ping()

Supported environment variables are:

TASKCLUSTER_ROOT_URL to specify your Taskcluster instance base url. You can either use that variable or instanciate TaskclusterConfig with the base url.
TASKCLUSTER_CLIENT_ID & TASKCLUSTER_ACCESS_TOKEN to specify your client credentials instead of providing them to TaskclusterConfig.auth
TASKCLUSTER_PROXY_URL to specify the proxy address used to reach Taskcluster in a task. It defaults to http://taskcluster when not specified.

For more details on Taskcluster environment variables, here is the documentation.

Loading secrets across multiple authentications

Another available utility is taskcluster.helper.load_secrets which allows you to retrieve a secret using an authenticated taskcluster.Secrets instance (using TaskclusterConfig.get_service or the synchronous class directly).

This utility loads a secret, but allows you to:

share a secret across multiple projects, by using key prefixes inside the secret,
check that some required keys are present in the secret,
provide some default values,
provide a local secret source instead of using the Taskcluster service (useful for local development or sharing secrets with contributors)

Let's say you have a secret on a Taskcluster instance named project/foo/prod-config, which is needed by a backend and some tasks. Here is its content:

---
common:
  environment: production
  remote_log: https://log.xx.com/payload

backend:
  bugzilla_token: XXXX

task:
  backend_url: https://backend.foo.mozilla.com

In your backend, you would do:

from taskcluster import Secrets
from taskcluster.helper import load_secrets

prod_config = load_secrets(
  Secrets({...}),
  'project/foo/prod-config',

  # We only need the common & backend parts
  prefixes=['common', 'backend'],

  # We absolutely need a bugzilla token to run
  required=['bugzilla_token'],

  # Let's provide some default value for the environment
  existing={
    'environment': 'dev',
  }
)
# prod_config == {
#   "environment": "production"
#   "remote_log": "https://log.xx.com/payload",
#   "bugzilla_token": "XXXX",
# }

In your task, you could do the following using TaskclusterConfig mentionned above (the class has a shortcut to use an authenticated Secrets service automatically):

from project import tc

prod_config = tc.load_secrets(
  'project/foo/prod-config',

  # We only need the common & bot parts
  prefixes=['common', 'bot'],

  # Let's provide some default value for the environment and backend_url
  existing={
    'environment': 'dev',
    'backend_url': 'http://localhost:8000',
  }
)
# prod_config == {
#   "environment": "production"
#   "remote_log": "https://log.xx.com/payload",
#   "backend_url": "https://backend.foo.mozilla.com",
# }

To provide local secrets value, you first need to load these values as a dictionary (usually by reading a local file in your format of choice : YAML, JSON, ...) and providing the dictionary to load_secrets by using the local_secrets parameter:

import os
import yaml

from taskcluster import Secrets
from taskcluster.helper import load_secrets

local_path = 'path/to/file.yml'

prod_config = load_secrets(
  Secrets({...}),
  'project/foo/prod-config',

  # We support an optional local file to provide some configuration without reaching Taskcluster
  local_secrets=yaml.safe_load(open(local_path)) if os.path.exists(local_path) else None,
)

Methods contained in the client library

Methods in `taskcluster.Auth`

import asyncio # Only for async 
import taskcluster
import taskcluster.aio

# Create Auth client instance
auth = taskcluster.Auth(options)
# Below only for async instances, assume already in coroutine
loop = asyncio.get_event_loop()
session = taskcluster.aio.createSession(loop=loop)
asyncAuth = taskcluster.aio.Auth(options, session=session)

Authentication related API end-points for Taskcluster and related services. These API end-points are of interest if you wish to:

Authorize a request signed with Taskcluster credentials,
Manage clients and roles,
Inspect or audit clients and roles,
Gain access to various services guarded by this API.

Ping Server

Respond without doing anything. This endpoint is used to check that the service is up.

# Sync calls
auth.ping() # -> None
# Async call
await asyncAuth.ping() # -> None

List Clients

Get a list of all clients. With prefix, only clients for which it is a prefix of the clientId are returned.

By default this end-point will try to return up to 1000 clients in one request. But it may return less, even none. It may also return a continuationToken even though there are no more results. However, you can only be sure to have seen all results if you keep calling listClients with the last continuationToken until you get a result without a continuationToken.

Has required output schema

# Sync calls
auth.listClients() # -> result
# Async call
await asyncAuth.listClients() # -> result

Get Client

Get information about a single client.

Takes the following arguments:

clientId

Has required output schema

# Sync calls
auth.client(clientId) # -> result
auth.client(clientId='value') # -> result
# Async call
await asyncAuth.client(clientId) # -> result
await asyncAuth.client(clientId='value') # -> result

Create Client

Create a new client and get the accessToken for this client. You should store the accessToken from this API call as there is no other way to retrieve it.

If you loose the accessToken you can call resetAccessToken to reset it, and a new accessToken will be returned, but you cannot retrieve the current accessToken.

If a client with the same clientId already exists this operation will fail. Use updateClient if you wish to update an existing client.

The caller's scopes must satisfy scopes.

Takes the following arguments:

clientId

Has required input schema

Has required output schema

# Sync calls
auth.createClient(clientId, payload) # -> result
auth.createClient(payload, clientId='value') # -> result
# Async call
await asyncAuth.createClient(clientId, payload) # -> result
await asyncAuth.createClient(payload, clientId='value') # -> result

Reset `accessToken`

Reset a clients accessToken, this will revoke the existing accessToken, generate a new accessToken and return it from this call.

There is no way to retrieve an existing accessToken, so if you loose it you must reset the accessToken to acquire it again.

Takes the following arguments:

clientId

Has required output schema

# Sync calls
auth.resetAccessToken(clientId) # -> result
auth.resetAccessToken(clientId='value') # -> result
# Async call
await asyncAuth.resetAccessToken(clientId) # -> result
await asyncAuth.resetAccessToken(clientId='value') # -> result

Update Client

Update an exisiting client. The clientId and accessToken cannot be updated, but scopes can be modified. The caller's scopes must satisfy all scopes being added to the client in the update operation. If no scopes are given in the request, the client's scopes remain unchanged

Takes the following arguments:

clientId

Has required input schema

Has required output schema

# Sync calls
auth.updateClient(clientId, payload) # -> result
auth.updateClient(payload, clientId='value') # -> result
# Async call
await asyncAuth.updateClient(clientId, payload) # -> result
await asyncAuth.updateClient(payload, clientId='value') # -> result

Enable Client

Enable a client that was disabled with disableClient. If the client is already enabled, this does nothing.

This is typically used by identity providers to re-enable clients that had been disabled when the corresponding identity's scopes changed.

Takes the following arguments:

clientId

Has required output schema

# Sync calls
auth.enableClient(clientId) # -> result
auth.enableClient(clientId='value') # -> result
# Async call
await asyncAuth.enableClient(clientId) # -> result
await asyncAuth.enableClient(clientId='value') # -> result

Disable Client

Disable a client. If the client is already disabled, this does nothing.

This is typically used by identity providers to disable clients when the corresponding identity's scopes no longer satisfy the client's scopes.

Takes the following arguments:

clientId

Has required output schema

# Sync calls
auth.disableClient(clientId) # -> result
auth.disableClient(clientId='value') # -> result
# Async call
await asyncAuth.disableClient(clientId) # -> result
await asyncAuth.disableClient(clientId='value') # -> result

Delete Client

Delete a client, please note that any roles related to this client must be deleted independently.

Takes the following arguments:

clientId

# Sync calls
auth.deleteClient(clientId) # -> None
auth.deleteClient(clientId='value') # -> None
# Async call
await asyncAuth.deleteClient(clientId) # -> None
await asyncAuth.deleteClient(clientId='value') # -> None

List Roles (no pagination)

Get a list of all roles. Each role object also includes the list of scopes it expands to. This always returns all roles in a single HTTP request.

To get paginated results, use listRoles2.

Has required output schema

# Sync calls
auth.listRoles() # -> result
# Async call
await asyncAuth.listRoles() # -> result

List Roles

Get a list of all roles. Each role object also includes the list of scopes it expands to. This is similar to listRoles but differs in the format of the response.

If no limit is given, all roles are returned. Since this list may become long, callers can use the limit and continuationToken query arguments to page through the responses.

Has required output schema

# Sync calls
auth.listRoles2() # -> result
# Async call
await asyncAuth.listRoles2() # -> result

List Role IDs

Get a list of all role IDs.

If no limit is given, the roleIds of all roles are returned. Since this list may become long, callers can use the limit and continuationToken query arguments to page through the responses.

Has required output schema

# Sync calls
auth.listRoleIds() # -> result
# Async call
await asyncAuth.listRoleIds() # -> result

Get Role

Get information about a single role, including the set of scopes that the role expands to.

Takes the following arguments:

roleId

Has required output schema

# Sync calls
auth.role(roleId) # -> result
auth.role(roleId='value') # -> result
# Async call
await asyncAuth.role(roleId) # -> result
await asyncAuth.role(roleId='value') # -> result

Create Role

Create a new role.

The caller's scopes must satisfy the new role's scopes.

If there already exists a role with the same roleId this operation will fail. Use updateRole to modify an existing role.

Creation of a role that will generate an infinite expansion will result in an error response.

Takes the following arguments:

roleId

Has required input schema

Has required output schema

# Sync calls
auth.createRole(roleId, payload) # -> result
auth.createRole(payload, roleId='value') # -> result
# Async call
await asyncAuth.createRole(roleId, payload) # -> result
await asyncAuth.createRole(payload, roleId='value') # -> result

Update Role

Update an existing role.

The caller's scopes must satisfy all of the new scopes being added, but need not satisfy all of the role's existing scopes.

An update of a role that will generate an infinite expansion will result in an error response.

Takes the following arguments:

roleId

Has required input schema

Has required output schema

# Sync calls
auth.updateRole(roleId, payload) # -> result
auth.updateRole(payload, roleId='value') # -> result
# Async call
await asyncAuth.updateRole(roleId, payload) # -> result
await asyncAuth.updateRole(payload, roleId='value') # -> result

Delete Role

Delete a role. This operation will succeed regardless of whether or not the role exists.

Takes the following arguments:

roleId

# Sync calls
auth.deleteRole(roleId) # -> None
auth.deleteRole(roleId='value') # -> None
# Async call
await asyncAuth.deleteRole(roleId) # -> None
await asyncAuth.deleteRole(roleId='value') # -> None

Expand Scopes

Return an expanded copy of the given scopeset, with scopes implied by any roles included.

Has required input schema

Has required output schema

# Sync calls
auth.expandScopes(payload) # -> result
# Async call
await asyncAuth.expandScopes(payload) # -> result

Get Current Scopes

Return the expanded scopes available in the request, taking into account all sources of scopes and scope restrictions (temporary credentials, assumeScopes, client scopes, and roles).

Has required output schema

# Sync calls
auth.currentScopes() # -> result
# Async call
await asyncAuth.currentScopes() # -> result

Get Temporary Read/Write Credentials S3

Get temporary AWS credentials for read-write or read-only access to a given bucket and prefix within that bucket. The level parameter can be read-write or read-only and determines which type of credentials are returned. Please note that the level parameter is required in the scope guarding access. The bucket name must not contain ., as recommended by Amazon.

This method can only allow access to a whitelisted set of buckets, as configured in the Taskcluster deployment

The credentials are set to expire after an hour, but this behavior is subject to change. Hence, you should always read the expires property from the response, if you intend to maintain active credentials in your application.

Please note that your prefix may not start with slash /. Such a prefix is allowed on S3, but we forbid it here to discourage bad behavior.

Also note that if your prefix doesn't end in a slash /, the STS credentials may allow access to unexpected keys, as S3 does not treat slashes specially. For example, a prefix of my-folder will allow access to my-folder/file.txt as expected, but also to my-folder.txt, which may not be intended.

Finally, note that the PutObjectAcl call is not allowed. Passing a canned ACL other than private to PutObject is treated as a PutObjectAcl call, and will result in an access-denied error from AWS. This limitation is due to a security flaw in Amazon S3 which might otherwise allow indefinite access to uploaded objects.

EC2 metadata compatibility, if the querystring parameter ?format=iam-role-compat is given, the response will be compatible with the JSON exposed by the EC2 metadata service. This aims to ease compatibility for libraries and tools built to auto-refresh credentials. For details on the format returned by EC2 metadata service see: EC2 User Guide.

Takes the following arguments:

level
bucket
prefix

Has required output schema

# Sync calls
auth.awsS3Credentials(level, bucket, prefix) # -> result
auth.awsS3Credentials(level='value', bucket='value', prefix='value') # -> result
# Async call
await asyncAuth.awsS3Credentials(level, bucket, prefix) # -> result
await asyncAuth.awsS3Credentials(level='value', bucket='value', prefix='value') # -> result

List Accounts Managed by Auth

Retrieve a list of all Azure accounts managed by Taskcluster Auth.

Has required output schema

# Sync calls
auth.azureAccounts() # -> result
# Async call
await asyncAuth.azureAccounts() # -> result

List Tables in an Account Managed by Auth

Retrieve a list of all tables in an account.

Takes the following arguments:

account

Has required output schema

# Sync calls
auth.azureTables(account) # -> result
auth.azureTables(account='value') # -> result
# Async call
await asyncAuth.azureTables(account) # -> result
await asyncAuth.azureTables(account='value') # -> result

Get Shared-Access-Signature for Azure Table

Get a shared access signature (SAS) string for use with a specific Azure Table Storage table.

The level parameter can be read-write or read-only and determines which type of credentials are returned. If level is read-write, it will create the table if it doesn't already exist.

Takes the following arguments:

account
table
level

Has required output schema

# Sync calls
auth.azureTableSAS(account, table, level) # -> result
auth.azureTableSAS(account='value', table='value', level='value') # -> result
# Async call
await asyncAuth.azureTableSAS(account, table, level) # -> result
await asyncAuth.azureTableSAS(account='value', table='value', level='value') # -> result

List containers in an Account Managed by Auth

Retrieve a list of all containers in an account.

Takes the following arguments:

account

Has required output schema

# Sync calls
auth.azureContainers(account) # -> result
auth.azureContainers(account='value') # -> result
# Async call
await asyncAuth.azureContainers(account) # -> result
await asyncAuth.azureContainers(account='value') # -> result

Get Shared-Access-Signature for Azure Container

Get a shared access signature (SAS) string for use with a specific Azure Blob Storage container.

The level parameter can be read-write or read-only and determines which type of credentials are returned. If level is read-write, it will create the container if it doesn't already exist.

Takes the following arguments:

account
container
level

Has required output schema

# Sync calls
auth.azureContainerSAS(account, container, level) # -> result
auth.azureContainerSAS(account='value', container='value', level='value') # -> result
# Async call
await asyncAuth.azureContainerSAS(account, container, level) # -> result
await asyncAuth.azureContainerSAS(account='value', container='value', level='value') # -> result

Get DSN for Sentry Project

Get temporary DSN (access credentials) for a sentry project. The credentials returned can be used with any Sentry client for up to 24 hours, after which the credentials will be automatically disabled.

If the project doesn't exist it will be created, and assigned to the initial team configured for this component. Contact a Sentry admin to have the project transferred to a team you have access to if needed

Takes the following arguments:

project

Has required output schema

# Sync calls
auth.sentryDSN(project) # -> result
auth.sentryDSN(project='value') # -> result
# Async call
await asyncAuth.sentryDSN(project) # -> result
await asyncAuth.sentryDSN(project='value') # -> result

Get a client token for the Websocktunnel service

Get a temporary token suitable for use connecting to a websocktunnel server.

The resulting token will only be accepted by servers with a matching audience value. Reaching such a server is the callers responsibility. In general, a server URL or set of URLs should be provided to the caller as configuration along with the audience value.

The token is valid for a limited time (on the scale of hours). Callers should refresh it before expiration.

Takes the following arguments:

wstAudience
wstClient

Has required output schema

# Sync calls
auth.websocktunnelToken(wstAudience, wstClient) # -> result
auth.websocktunnelToken(wstAudience='value', wstClient='value') # -> result
# Async call
await asyncAuth.websocktunnelToken(wstAudience, wstClient) # -> result
await asyncAuth.websocktunnelToken(wstAudience='value', wstClient='value') # -> result

Get Temporary GCP Credentials

Get temporary GCP credentials for the given serviceAccount in the given project.

Only preconfigured projects and serviceAccounts are allowed, as defined in the deployment of the Taskcluster services.

Takes the following arguments:

projectId
serviceAccount

Has required output schema

# Sync calls
auth.gcpCredentials(projectId, serviceAccount) # -> result
auth.gcpCredentials(projectId='value', serviceAccount='value') # -> result
# Async call
await asyncAuth.gcpCredentials(projectId, serviceAccount) # -> result
await asyncAuth.gcpCredentials(projectId='value', serviceAccount='value') # -> result

Authenticate Hawk Request

Validate the request signature given on input and return list of scopes that the authenticating client has.

This method is used by other services that wish rely on Taskcluster credentials for authentication. This way we can use Hawk without having the secret credentials leave this service.

Has required input schema

Has required output schema

# Sync calls
auth.authenticateHawk(payload) # -> result
# Async call
await asyncAuth.authenticateHawk(payload) # -> result

Test Authentication

Utility method to test client implementations of Taskcluster authentication.

Rather than using real credentials, this endpoint accepts requests with clientId tester and accessToken no-secret. That client's scopes are based on clientScopes in the request body.

The request is validated, with any certificate, authorizedScopes, etc. applied, and the resulting scopes are checked against requiredScopes from the request body. On success, the response contains the clientId and scopes as seen by the API method.

Has required input schema

Has required output schema

# Sync calls
auth.testAuthenticate(payload) # -> result
# Async call
await asyncAuth.testAuthenticate(payload) # -> result

Test Authentication (GET)

Utility method similar to testAuthenticate, but with the GET method, so it can be used with signed URLs (bewits).

Rather than using real credentials, this endpoint accepts requests with clientId tester and accessToken no-secret. That client's scopes are ['test:*', 'auth:create-client:test:*']. The call fails if the test:authenticate-get scope is not available.

The request is validated, with any certificate, authorizedScopes, etc. applied, and the resulting scopes are checked, just like any API call. On success, the response contains the clientId and scopes as seen by the API method.

This method may later be extended to allow specification of client and required scopes via query arguments.

Has required output schema

# Sync calls
auth.testAuthenticateGet() # -> result
# Async call
await asyncAuth.testAuthenticateGet() # -> result

Exchanges in `taskcluster.AuthEvents`

import taskcluster

# Create AuthEvents client instance
authEvents = taskcluster.AuthEvents(options)

The auth service is responsible for storing credentials, managing assignment of scopes, and validation of request signatures from other services.

These exchanges provides notifications when credentials or roles are updated. This is mostly so that multiple instances of the auth service can purge their caches and synchronize state. But you are of course welcome to use these for other purposes, monitoring changes for example.

Client Created Messages

authEvents.clientCreated(routingKeyPattern) -> routingKey
- reserved Description: Space reserved for future routing-key entries, you should always match this entry with #. As automatically done by our tooling, if not specified.

Client Updated Messages

authEvents.clientUpdated(routingKeyPattern) -> routingKey
- reserved Description: Space reserved for future routing-key entries, you should always match this entry with #. As automatically done by our tooling, if not specified.

Client Deleted Messages

authEvents.clientDeleted(routingKeyPattern) -> routingKey
- reserved Description: Space reserved for future routing-key entries, you should always match this entry with #. As automatically done by our tooling, if not specified.

Role Created Messages

authEvents.roleCreated(routingKeyPattern) -> routingKey
- reserved Description: Space reserved for future routing-key entries, you should always match this entry with #. As automatically done by our tooling, if not specified.

Role Updated Messages

authEvents.roleUpdated(routingKeyPattern) -> routingKey
- reserved Description: Space reserved for future routing-key entries, you should always match this entry with #. As automatically done by our tooling, if not specified.

Role Deleted Messages

authEvents.roleDeleted(routingKeyPattern) -> routingKey
- reserved Description: Space reserved for future routing-key entries, you should always match this entry with #. As automatically done by our tooling, if not specified.

Methods in `taskcluster.Github`

import asyncio # Only for async 
import taskcluster
import taskcluster.aio

# Create Github client instance
github = taskcluster.Github(options)
# Below only for async instances, assume already in coroutine
loop = asyncio.get_event_loop()
session = taskcluster.aio.createSession(loop=loop)
asyncGithub = taskcluster.aio.Github(options, session=session)

The github service is responsible for creating tasks in reposnse to GitHub events, and posting results to the GitHub UI.

This document describes the API end-point for consuming GitHub web hooks, as well as some useful consumer APIs.

When Github forbids an action, this service returns an HTTP 403 with code ForbiddenByGithub.

Ping Server

Respond without doing anything. This endpoint is used to check that the service is up.

# Sync calls
github.ping() # -> None
# Async call
await asyncGithub.ping() # -> None

Consume GitHub WebHook

Capture a GitHub event and publish it via pulse, if it's a push, release or pull request.

# Sync calls
github.githubWebHookConsumer() # -> None
# Async call
await asyncGithub.githubWebHookConsumer() # -> None

List of Builds

A paginated list of builds that have been run in Taskcluster. Can be filtered on various git-specific fields.

Has required output schema

# Sync calls
github.builds() # -> result
# Async call
await asyncGithub.builds() # -> result

Latest Build Status Badge

Checks the status of the latest build of a given branch and returns corresponding badge svg.

Takes the following arguments:

owner
repo
branch

# Sync calls
github.badge(owner, repo, branch) # -> None
github.badge(owner='value', repo='value', branch='value') # -> None
# Async call
await asyncGithub.badge(owner, repo, branch) # -> None
await asyncGithub.badge(owner='value', repo='value', branch='value') # -> None

Get Repository Info

Returns any repository metadata that is useful within Taskcluster related services.

Takes the following arguments:

owner
repo

Has required output schema

# Sync calls
github.repository(owner, repo) # -> result
github.repository(owner='value', repo='value') # -> result
# Async call
await asyncGithub.repository(owner, repo) # -> result
await asyncGithub.repository(owner='value', repo='value') # -> result

Latest Status for Branch

For a given branch of a repository, this will always point to a status page for the most recent task triggered by that branch.

Note: This is a redirect rather than a direct link.

Takes the following arguments:

owner
repo
branch

# Sync calls
github.latest(owner, repo, branch) # -> None
github.latest(owner='value', repo='value', branch='value') # -> None
# Async call
await asyncGithub.latest(owner, repo, branch) # -> None
await asyncGithub.latest(owner='value', repo='value', branch='value') # -> None

Post a status against a given changeset

For a given changeset (SHA) of a repository, this will attach a "commit status" on github. These statuses are links displayed next to each revision. The status is either OK (green check) or FAILURE (red cross), made of a custom title and link.

Takes the following arguments:

owner
repo
sha

Has required input schema

# Sync calls
github.createStatus(owner, repo, sha, payload) # -> None
github.createStatus(payload, owner='value', repo='value', sha='value') # -> None
# Async call
await asyncGithub.createStatus(owner, repo, sha, payload) # -> None
await asyncGithub.createStatus(payload, owner='value', repo='value', sha='value') # -> None

Exchanges in `taskcluster.GithubEvents`

import taskcluster

# Create GithubEvents client instance
githubEvents = taskcluster.GithubEvents(options)

The github service publishes a pulse message for supported github events, translating Github webhook events into pulse messages.

This document describes the exchange offered by the taskcluster github service

GitHub Pull Request Event

githubEvents.pullRequest(routingKeyPattern) -> routingKey
- routingKeyKind is constant of primary is required Description: Identifier for the routing-key kind. This is always "primary" for the formalized routing key.
- organization is required Description: The GitHub organization which had an event. All periods have been replaced by % - such that foo.bar becomes foo%bar - and all other special characters aside from - and _ have been stripped.
- repository is required Description: The GitHub repository which had an event.All periods have been replaced by % - such that foo.bar becomes foo%bar - and all other special characters aside from - and _ have been stripped.
- action is required Description: The GitHub action which triggered an event. See for possible values see the payload actions property.

GitHub push Event

githubEvents.push(routingKeyPattern) -> routingKey
- routingKeyKind is constant of primary is required Description: Identifier for the routing-key kind. This is always "primary" for the formalized routing key.
- organization is required Description: The GitHub organization which had an event. All periods have been replaced by % - such that foo.bar becomes foo%bar - and all other special characters aside from - and _ have been stripped.
- repository is required Description: The GitHub repository which had an event.All periods have been replaced by % - such that foo.bar becomes foo%bar - and all other special characters aside from - and _ have been stripped.

GitHub release Event

githubEvents.release(routingKeyPattern) -> routingKey
- routingKeyKind is constant of primary is required Description: Identifier for the routing-key kind. This is always "primary" for the formalized routing key.
- organization is required Description: The GitHub organization which had an event. All periods have been replaced by % - such that foo.bar becomes foo%bar - and all other special characters aside from - and _ have been stripped.
- repository is required Description: The GitHub repository which had an event.All periods have been replaced by % - such that foo.bar becomes foo%bar - and all other special characters aside from - and _ have been stripped.

tc-gh requested the Queue service to create all the tasks in a group

githubEvents.taskGroupCreationRequested(routingKeyPattern) -> routingKey
- routingKeyKind is constant of primary is required Description: Identifier for the routing-key kind. This is always "primary" for the formalized routing key.
- organization is required Description: The GitHub organization which had an event. All periods have been replaced by % - such that foo.bar becomes foo%bar - and all other special characters aside from - and _ have been stripped.
- repository is required Description: The GitHub repository which had an event.All periods have been replaced by % - such that foo.bar becomes foo%bar - and all other special characters aside from - and _ have been stripped.

Methods in `taskcluster.Hooks`

import asyncio # Only for async 
import taskcluster
import taskcluster.aio

# Create Hooks client instance
hooks = taskcluster.Hooks(options)
# Below only for async instances, assume already in coroutine
loop = asyncio.get_event_loop()
session = taskcluster.aio.createSession(loop=loop)
asyncHooks = taskcluster.aio.Hooks(options, session=session)

The hooks service provides a mechanism for creating tasks in response to events.

Ping Server

Respond without doing anything. This endpoint is used to check that the service is up.

# Sync calls
hooks.ping() # -> None
# Async call
await asyncHooks.ping() # -> None

List hook groups

This endpoint will return a list of all hook groups with at least one hook.

Has required output schema

# Sync calls
hooks.listHookGroups() # -> result
# Async call
await asyncHooks.listHookGroups() # -> result

List hooks in a given group

This endpoint will return a list of all the hook definitions within a given hook group.

Takes the following arguments:

hookGroupId

Has required output schema

# Sync calls
hooks.listHooks(hookGroupId) # -> result
hooks.listHooks(hookGroupId='value') # -> result
# Async call
await asyncHooks.listHooks(hookGroupId) # -> result
await asyncHooks.listHooks(hookGroupId='value') # -> result

Get hook definition

This endpoint will return the hook definition for the given hookGroupId and hookId.

Takes the following arguments:

hookGroupId
hookId

Has required output schema

# Sync calls
hooks.hook(hookGroupId, hookId) # -> result
hooks.hook(hookGroupId='value', hookId='value') # -> result
# Async call
await asyncHooks.hook(hookGroupId, hookId) # -> result
await asyncHooks.hook(hookGroupId='value', hookId='value') # -> result

Get hook status

This endpoint will return the current status of the hook. This represents a snapshot in time and may vary from one call to the next.

This method is deprecated in favor of listLastFires.

Takes the following arguments:

hookGroupId
hookId

Has required output schema

# Sync calls
hooks.getHookStatus(hookGroupId, hookId) # -> result
hooks.getHookStatus(hookGroupId='value', hookId='value') # -> result
# Async call
await asyncHooks.getHookStatus(hookGroupId, hookId) # -> result
await asyncHooks.getHookStatus(hookGroupId='value', hookId='value') # -> result

Create a hook

This endpoint will create a new hook.

The caller's credentials must include the role that will be used to create the task. That role must satisfy task.scopes as well as the necessary scopes to add the task to the queue.

Takes the following arguments:

hookGroupId
hookId

Has required input schema

Has required output schema

# Sync calls
hooks.createHook(hookGroupId, hookId, payload) # -> result
hooks.createHook(payload, hookGroupId='value', hookId='value') # -> result
# Async call
await asyncHooks.createHook(hookGroupId, hookId, payload) # -> result
await asyncHooks.createHook(payload, hookGroupId='value', hookId='value') # -> result

Update a hook

This endpoint will update an existing hook. All fields except hookGroupId and hookId can be modified.

Takes the following arguments:

hookGroupId
hookId

Has required input schema

Has required output schema

# Sync calls
hooks.updateHook(hookGroupId, hookId, payload) # -> result
hooks.updateHook(payload, hookGroupId='value', hookId='value') # -> result
# Async call
await asyncHooks.updateHook(hookGroupId, hookId, payload) # -> result
await asyncHooks.updateHook(payload, hookGroupId='value', hookId='value') # -> result

Delete a hook

This endpoint will remove a hook definition.

Takes the following arguments:

hookGroupId
hookId

# Sync calls
hooks.removeHook(hookGroupId, hookId) # -> None
hooks.removeHook(hookGroupId='value', hookId='value') # -> None
# Async call
await asyncHooks.removeHook(hookGroupId, hookId) # -> None
await asyncHooks.removeHook(hookGroupId='value', hookId='value') # -> None

Trigger a hook

This endpoint will trigger the creation of a task from a hook definition.

The HTTP payload must match the hooks triggerSchema. If it does, it is provided as the payload property of the JSON-e context used to render the task template.

Takes the following arguments:

hookGroupId
hookId

Has required input schema

Has required output schema

# Sync calls
hooks.triggerHook(hookGroupId, hookId, payload) # -> result
hooks.triggerHook(payload, hookGroupId='value', hookId='value') # -> result
# Async call
await asyncHooks.triggerHook(hookGroupId, hookId, payload) # -> result
await asyncHooks.triggerHook(payload, hookGroupId='value', hookId='value') # -> result

Get a trigger token

Retrieve a unique secret token for triggering the specified hook. This token can be deactivated with resetTriggerToken.

Takes the following arguments:

hookGroupId
hookId

Has required output schema

# Sync calls
hooks.getTriggerToken(hookGroupId, hookId) # -> result
hooks.getTriggerToken(hookGroupId='value', hookId='value') # -> result
# Async call
await asyncHooks.getTriggerToken(hookGroupId, hookId) # -> result
await asyncHooks.getTriggerToken(hookGroupId='value', hookId='value') # -> result

Reset a trigger token

Reset the token for triggering a given hook. This invalidates token that may have been issued via getTriggerToken with a new token.

Takes the following arguments:

hookGroupId
hookId

Has required output schema

# Sync calls
hooks.resetTriggerToken(hookGroupId, hookId) # -> result
hooks.resetTriggerToken(hookGroupId='value', hookId='value') # -> result
# Async call
await asyncHooks.resetTriggerToken(hookGroupId, hookId) # -> result
await asyncHooks.resetTriggerToken(hookGroupId='value', hookId='value') # -> result

Trigger a hook with a token

This endpoint triggers a defined hook with a valid token.

The HTTP payload must match the hooks triggerSchema. If it does, it is provided as the payload property of the JSON-e context used to render the task template.

Takes the following arguments:

hookGroupId
hookId
token

Has required input schema

Has required output schema

# Sync calls
hooks.triggerHookWithToken(hookGroupId, hookId, token, payload) # -> result
hooks.triggerHookWithToken(payload, hookGroupId='value', hookId='value', token='value') # -> result
# Async call
await asyncHooks.triggerHookWithToken(hookGroupId, hookId, token, payload) # -> result
await asyncHooks.triggerHookWithToken(payload, hookGroupId='value', hookId='value', token='value') # -> result

Get information about recent hook fires

This endpoint will return information about the the last few times this hook has been fired, including whether the hook was fired successfully or not

Takes the following arguments:

hookGroupId
hookId

Has required output schema

# Sync calls
hooks.listLastFires(hookGroupId, hookId) # -> result
hooks.listLastFires(hookGroupId='value', hookId='value') # -> result
# Async call
await asyncHooks.listLastFires(hookGroupId, hookId) # -> result
await asyncHooks.listLastFires(hookGroupId='value', hookId='value') # -> result

Exchanges in `taskcluster.HooksEvents`

import taskcluster

# Create HooksEvents client instance
hooksEvents = taskcluster.HooksEvents(options)

The hooks service is responsible for creating tasks at specific times orin . response to webhooks and API calls.Using this exchange allows us tomake hooks which repsond to particular pulse messagesThese exchanges provide notifications when a hook is created, updatedor deleted. This is so that the listener running in a different hooks process at the other end can direct another listener specified byhookGroupId and hookId to synchronize its bindings. But you are ofcourse welcome to use these for other purposes, monitoring changes for example.

Hook Created Messages

hooksEvents.hookCreated(routingKeyPattern) -> routingKey
- reserved Description: Space reserved for future routing-key entries, you should always match this entry with #. As automatically done by our tooling, if not specified.

Hook Updated Messages

hooksEvents.hookUpdated(routingKeyPattern) -> routingKey
- reserved Description: Space reserved for future routing-key entries, you should always match this entry with #. As automatically done by our tooling, if not specified.

Hook Deleted Messages

hooksEvents.hookDeleted(routingKeyPattern) -> routingKey
- reserved Description: Space reserved for future routing-key entries, you should always match this entry with #. As automatically done by our tooling, if not specified.

Methods in `taskcluster.Index`

import asyncio # Only for async 
import taskcluster
import taskcluster.aio

# Create Index client instance
index = taskcluster.Index(options)
# Below only for async instances, assume already in coroutine
loop = asyncio.get_event_loop()
session = taskcluster.aio.createSession(loop=loop)
asyncIndex = taskcluster.aio.Index(options, session=session)

The index service is responsible for indexing tasks. The service ensures that tasks can be located by user-defined names.

As described in the service documentation, tasks are typically indexed via Pulse messages, so the most common use of API methods is to read from the index.

Ping Server

Respond without doing anything. This endpoint is used to check that the service is up.

# Sync calls
index.ping() # -> None
# Async call
await asyncIndex.ping() # -> None

Find Indexed Task

Find a task by index path, returning the highest-rank task with that path. If no task exists for the given path, this API end-point will respond with a 404 status.

Takes the following arguments:

indexPath

Has required output schema

# Sync calls
index.findTask(indexPath) # -> result
index.findTask(indexPath='value') # -> result
# Async call
await asyncIndex.findTask(indexPath) # -> result
await asyncIndex.findTask(indexPath='value') # -> result

List Namespaces

List the namespaces immediately under a given namespace.

This endpoint lists up to 1000 namespaces. If more namespaces are present, a continuationToken will be returned, which can be given in the next request. For the initial request, the payload should be an empty JSON object.

Takes the following arguments:

namespace

Has required output schema

# Sync calls
index.listNamespaces(namespace) # -> result
index.listNamespaces(namespace='value') # -> result
# Async call
await asyncIndex.listNamespaces(namespace) # -> result
await asyncIndex.listNamespaces(namespace='value') # -> result

List Tasks

List the tasks immediately under a given namespace.

This endpoint lists up to 1000 tasks. If more tasks are present, a continuationToken will be returned, which can be given in the next request. For the initial request, the payload should be an empty JSON object.

Remark, this end-point is designed for humans browsing for tasks, not services, as that makes little sense.

Takes the following arguments:

namespace

Has required output schema

# Sync calls
index.listTasks(namespace) # -> result
index.listTasks(namespace='value') # -> result
# Async call
await asyncIndex.listTasks(namespace) # -> result
await asyncIndex.listTasks(namespace='value') # -> result

Insert Task into Index

Insert a task into the index. If the new rank is less than the existing rank at the given index path, the task is not indexed but the response is still 200 OK.

Please see the introduction above for information about indexing successfully completed tasks automatically using custom routes.

Takes the following arguments:

namespace

Has required input schema

Has required output schema

# Sync calls
index.insertTask(namespace, payload) # -> result
index.insertTask(payload, namespace='value') # -> result
# Async call
await asyncIndex.insertTask(namespace, payload) # -> result
await asyncIndex.insertTask(payload, namespace='value') # -> result

Get Artifact From Indexed Task

Find a task by index path and redirect to the artifact on the most recent run with the given name.

Note that multiple calls to this endpoint may return artifacts from differen tasks if a new task is inserted into the index between calls. Avoid using this method as a stable link to multiple, connected files if the index path does not contain a unique identifier. For example, the following two links may return unrelated files:

This problem be remedied by including the revision in the index path or by bundling both installer and debug symbols into a single artifact.

If no task exists for the given index path, this API end-point responds with 404.

Takes the following arguments:

indexPath
name

# Sync calls
index.findArtifactFromTask(indexPath, name) # -> None
index.findArtifactFromTask(indexPath='value', name='value') # -> None
# Async call
await asyncIndex.findArtifactFromTask(indexPath, name) # -> None
await asyncIndex.findArtifactFromTask(indexPath='value', name='value') # -> None

Methods in `taskcluster.Notify`

import asyncio # Only for async 
import taskcluster
import taskcluster.aio

# Create Notify client instance
notify = taskcluster.Notify(options)
# Below only for async instances, assume already in coroutine
loop = asyncio.get_event_loop()
session = taskcluster.aio.createSession(loop=loop)
asyncNotify = taskcluster.aio.Notify(options, session=session)

The notification service listens for tasks with associated notifications and handles requests to send emails and post pulse messages.

Ping Server

Respond without doing anything. This endpoint is used to check that the service is up.

# Sync calls
notify.ping() # -> None
# Async call
await asyncNotify.ping() # -> None

Send an Email

Send an email to address. The content is markdown and will be rendered to HTML, but both the HTML and raw markdown text will be sent in the email. If a link is included, it will be rendered to a nice button in the HTML version of the email

Has required input schema

# Sync calls
notify.email(payload) # -> None
# Async call
await asyncNotify.email(payload) # -> None

Publish a Pulse Message

Publish a message on pulse with the given routingKey.

Has required input schema

# Sync calls
notify.pulse(payload) # -> None
# Async call
await asyncNotify.pulse(payload) # -> None

Post IRC Message

Post a message on IRC to a specific channel or user, or a specific user on a specific channel.

Success of this API method does not imply the message was successfully posted. This API method merely inserts the IRC message into a queue that will be processed by a background process. This allows us to re-send the message in face of connection issues.

However, if the user isn't online the message will be dropped without error. We maybe improve this behavior in the future. For now just keep in mind that IRC is a best-effort service.

Has required input schema

# Sync calls
notify.irc(payload) # -> None
# Async call
await asyncNotify.irc(payload) # -> None

Denylist Given Address

Add the given address to the notification denylist. The address can be of either of the three supported address type namely pulse, email or IRC(user or channel). Addresses in the denylist will be ignored by the notification service.

Has required input schema

# Sync calls
notify.addDenylistAddress(payload) # -> None
# Async call
await asyncNotify.addDenylistAddress(payload) # -> None

Delete Denylisted Address

Delete the specified address from the notification denylist.

Has required input schema

# Sync calls
notify.deleteDenylistAddress(payload) # -> None
# Async call
await asyncNotify.deleteDenylistAddress(payload) # -> None

List Denylisted Notifications

Lists all the denylisted addresses.

By default this end-point will try to return up to 1000 addresses in one request. But it may return less, even if more tasks are available. It may also return a continuationToken even though there are no more results. However, you can only be sure to have seen all results if you keep calling list with the last continuationToken until you get a result without a continuationToken.

If you are not interested in listing all the members at once, you may use the query-string option limit to return fewer.

Has required output schema

# Sync calls
notify.listDenylist() # -> result
# Async call
await asyncNotify.listDenylist() # -> result

Exchanges in `taskcluster.NotifyEvents`

import taskcluster

# Create NotifyEvents client instance
notifyEvents = taskcluster.NotifyEvents(options)

This pretty much only contains the simple free-form message that can be published from this service from a request by anybody with the proper scopes.

Notification Messages

notifyEvents.notify(routingKeyPattern) -> routingKey
- routingKeyKind is constant of primary is required Description: Identifier for the routing-key kind. This is always 'primary' for the formalized routing key.
- reserved Description: Space reserved for future routing-key entries, you should always match this entry with #. As automatically done by our tooling, if not specified.

Request for irc notification

notifyEvents.ircRequest(routingKeyPattern) -> routingKey
- routingKeyKind is constant of primary is required Description: Identifier for the routing-key kind. This is always 'primary' for the formalized routing key.
- reserved Description: Space reserved for future routing-key entries, you should always match this entry with #. As automatically done by our tooling, if not specified.

Methods in `taskcluster.PurgeCache`

import asyncio # Only for async 
import taskcluster
import taskcluster.aio

# Create PurgeCache client instance
purgeCache = taskcluster.PurgeCache(options)
# Below only for async instances, assume already in coroutine
loop = asyncio.get_event_loop()
session = taskcluster.aio.createSession(loop=loop)
asyncPurgeCache = taskcluster.aio.PurgeCache(options, session=session)

The purge-cache service is responsible for tracking cache-purge requests.

User create purge requests for specific caches on specific workers, and these requests are timestamped. Workers consult the service before starting a new task, and purge any caches older than the timestamp.

Ping Server

Respond without doing anything. This endpoint is used to check that the service is up.

# Sync calls
purgeCache.ping() # -> None
# Async call
await asyncPurgeCache.ping() # -> None

Purge Worker Cache

Publish a request to purge caches named cacheName with on provisionerId/workerType workers.

If such a request already exists, its before timestamp is updated to the current time.

Takes the following arguments:

provisionerId
workerType

Has required input schema

# Sync calls
purgeCache.purgeCache(provisionerId, workerType, payload) # -> None
purgeCache.purgeCache(payload, provisionerId='value', workerType='value') # -> None
# Async call
await asyncPurgeCache.purgeCache(provisionerId, workerType, payload) # -> None
await asyncPurgeCache.purgeCache(payload, provisionerId='value', workerType='value') # -> None

All Open Purge Requests

View all active purge requests.

This is useful mostly for administors to view the set of open purge requests. It should not be used by workers. They should use the purgeRequests endpoint that is specific to their workerType and provisionerId.

Has required output schema

# Sync calls
purgeCache.allPurgeRequests() # -> result
# Async call
await asyncPurgeCache.allPurgeRequests() # -> result

Open Purge Requests for a provisionerId/workerType pair

List the caches for this provisionerId/workerType that should to be purged if they are from before the time given in the response.

This is intended to be used by workers to determine which caches to purge.

Takes the following arguments:

provisionerId
workerType

Has required output schema

# Sync calls
purgeCache.purgeRequests(provisionerId, workerType) # -> result
purgeCache.purgeRequests(provisionerId='value', workerType='value') # -> result
# Async call
await asyncPurgeCache.purgeRequests(provisionerId, workerType) # -> result
await asyncPurgeCache.purgeRequests(provisionerId='value', workerType='value') # -> result

Methods in `taskcluster.Queue`

import asyncio # Only for async 
import taskcluster
import taskcluster.aio

# Create Queue client instance
queue = taskcluster.Queue(options)
# Below only for async instances, assume already in coroutine
loop = asyncio.get_event_loop()
session = taskcluster.aio.createSession(loop=loop)
asyncQueue = taskcluster.aio.Queue(options, session=session)

The queue service is responsible for accepting tasks and track their state as they are executed by workers. In order ensure they are eventually resolved.

This document describes the API end-points offered by the queue. These end-points targets the following audience:

Schedulers, who create tasks to be executed,
Workers, who execute tasks, and
Tools, that wants to inspect the state of a task.

Ping Server

Respond without doing anything. This endpoint is used to check that the service is up.

# Sync calls
queue.ping() # -> None
# Async call
await asyncQueue.ping() # -> None

Get Task Definition

This end-point will return the task-definition. Notice that the task definition may have been modified by queue, if an optional property is not specified the queue may provide a default value.

Takes the following arguments:

taskId

Has required output schema

# Sync calls
queue.task(taskId) # -> result
queue.task(taskId='value') # -> result
# Async call
await asyncQueue.task(taskId) # -> result
await asyncQueue.task(taskId='value') # -> result

Get task status

Get task status structure from taskId

Takes the following arguments:

taskId

Has required output schema

# Sync calls
queue.status(taskId) # -> result
queue.status(taskId='value') # -> result
# Async call
await asyncQueue.status(taskId) # -> result
await asyncQueue.status(taskId='value') # -> result

List Task Group

List tasks sharing the same taskGroupId.

As a task-group may contain an unbounded number of tasks, this end-point may return a continuationToken. To continue listing tasks you must call the listTaskGroup again with the continuationToken as the query-string option continuationToken.

By default this end-point will try to return up to 1000 members in one request. But it may return less, even if more tasks are available. It may also return a continuationToken even though there are no more results. However, you can only be sure to have seen all results if you keep calling listTaskGroup with the last continuationToken until you get a result without a continuationToken.

If you are not interested in listing all the members at once, you may use the query-string option limit to return fewer.

Takes the following arguments:

taskGroupId

Has required output schema

# Sync calls
queue.listTaskGroup(taskGroupId) # -> result
queue.listTaskGroup(taskGroupId='value') # -> result
# Async call
await asyncQueue.listTaskGroup(taskGroupId) # -> result
await asyncQueue.listTaskGroup(taskGroupId='value') # -> result

List Dependent Tasks

List tasks that depend on the given taskId.

As many tasks from different task-groups may dependent on a single tasks, this end-point may return a continuationToken. To continue listing tasks you must call listDependentTasks again with the continuationToken as the query-string option continuationToken.

By default this end-point will try to return up to 1000 tasks in one request. But it may return less, even if more tasks are available. It may also return a continuationToken even though there are no more results. However, you can only be sure to have seen all results if you keep calling listDependentTasks with the last continuationToken until you get a result without a continuationToken.

If you are not interested in listing all the tasks at once, you may use the query-string option limit to return fewer.

Takes the following arguments:

taskId

Has required output schema

# Sync calls
queue.listDependentTasks(taskId) # -> result
queue.listDependentTasks(taskId='value') # -> result
# Async call
await asyncQueue.listDependentTasks(taskId) # -> result
await asyncQueue.listDependentTasks(taskId='value') # -> result

Create New Task

Create a new task, this is an idempotent operation, so repeat it if you get an internal server error or network connection is dropped.

Task deadline: the deadline property can be no more than 5 days into the future. This is to limit the amount of pending tasks not being taken care of. Ideally, you should use a much shorter deadline.

Task expiration: the expires property must be greater than the task deadline. If not provided it will default to deadline + one year. Notice, that artifacts created by task must expire before the task.

Task specific routing-keys: using the task.routes property you may define task specific routing-keys. If a task has a task specific routing-key: <route>, then when the AMQP message about the task is published, the message will be CC'ed with the routing-key: route.<route>. This is useful if you want another component to listen for completed tasks you have posted. The caller must have scope queue:route:<route> for each route.

Dependencies: any tasks referenced in task.dependencies must have already been created at the time of this call.

Scopes: Note that the scopes required to complete this API call depend on the content of the scopes, routes, schedulerId, priority, provisionerId, and workerType properties of the task definition.

Legacy Scopes: The queue:create-task:.. scope without a priority and the queue:define-task:.. and queue:task-group-id:.. scopes are considered legacy and should not be used. Note that the new, non-legacy scopes require a queue:scheduler-id:.. scope as well as scopes for the proper priority.

Takes the following arguments:

taskId

Has required input schema

Has required output schema

# Sync calls
queue.createTask(taskId, payload) # -> result
queue.createTask(payload, taskId='value') # -> result
# Async call
await asyncQueue.createTask(taskId, payload) # -> result
await asyncQueue.createTask(payload, taskId='value') # -> result

Define Task

Deprecated, this is the same as createTask with a self-dependency. This is only present for legacy.

Takes the following arguments:

taskId

Has required input schema

Has required output schema

# Sync calls
queue.defineTask(taskId, payload) # -> result
queue.defineTask(payload, taskId='value') # -> result
# Async call
await asyncQueue.defineTask(taskId, payload) # -> result
await asyncQueue.defineTask(payload, taskId='value') # -> result

Schedule Defined Task

scheduleTask will schedule a task to be executed, even if it has unresolved dependencies. A task would otherwise only be scheduled if its dependencies were resolved.

This is useful if you have defined a task that depends on itself or on some other task that has not been resolved, but you wish the task to be scheduled immediately.

This will announce the task as pending and workers will be allowed to claim it and resolve the task.

Note this operation is idempotent and will not fail or complain if called with a taskId that is already scheduled, or even resolved. To reschedule a task previously resolved, use rerunTask.

Takes the following arguments:

taskId

Has required output schema

# Sync calls
queue.scheduleTask(taskId) # -> result
queue.scheduleTask(taskId='value') # -> result
# Async call
await asyncQueue.scheduleTask(taskId) # -> result
await asyncQueue.scheduleTask(taskId='value') # -> result

Rerun a Resolved Task

This method reruns a previously resolved task, even if it was completed. This is useful if your task completes unsuccessfully, and you just want to run it from scratch again. This will also reset the number of retries allowed.

This method is deprecated in favour of creating a new task with the same task definition (but with a new taskId).

Remember that retries in the task status counts the number of runs that the queue have started because the worker stopped responding, for example because a spot node died.

Remark this operation is idempotent, if you try to rerun a task that is not either failed or completed, this operation will just return the current task status.

Takes the following arguments:

taskId

Has required output schema

# Sync calls
queue.rerunTask(taskId) # -> result
queue.rerunTask(taskId='value') # -> result
# Async call
await asyncQueue.rerunTask(taskId) # -> result
await asyncQueue.rerunTask(taskId='value') # -> result

Cancel Task

This method will cancel a task that is either unscheduled, pending or running. It will resolve the current run as exception with reasonResolved set to canceled. If the task isn't scheduled yet, ie. it doesn't have any runs, an initial run will be added and resolved as described above. Hence, after canceling a task, it cannot be scheduled with queue.scheduleTask, but a new run can be created with queue.rerun. These semantics is equivalent to calling queue.scheduleTask immediately followed by queue.cancelTask.

Remark this operation is idempotent, if you try to cancel a task that isn't unscheduled, pending or running, this operation will just return the current task status.

Takes the following arguments:

taskId

Has required output schema

# Sync calls
queue.cancelTask(taskId) # -> result
queue.cancelTask(taskId='value') # -> result
# Async call
await asyncQueue.cancelTask(taskId) # -> result
await asyncQueue.cancelTask(taskId='value') # -> result

Claim Work

Claim pending task(s) for the given provisionerId/workerType queue.

If any work is available (even if fewer than the requested number of tasks, this will return immediately. Otherwise, it will block for tens of seconds waiting for work. If no work appears, it will return an emtpy list of tasks. Callers should sleep a short while (to avoid denial of service in an error condition) and call the endpoint again. This is a simple implementation of "long polling".

Takes the following arguments:

provisionerId
workerType

Has required input schema

Has required output schema

# Sync calls
queue.claimWork(provisionerId, workerType, payload) # -> result
queue.claimWork(payload, provisionerId='value', workerType='value') # -> result
# Async call
await asyncQueue.claimWork(provisionerId, workerType, payload) # -> result
await asyncQueue.claimWork(payload, provisionerId='value', workerType='value') # -> result

Claim Task

claim a task - never documented

Takes the following arguments:

taskId
runId

Has required input schema

Has required output schema

# Sync calls
queue.claimTask(taskId, runId, payload) # -> result
queue.claimTask(payload, taskId='value', runId='value') # -> result
# Async call
await asyncQueue.claimTask(taskId, runId, payload) # -> result
await asyncQueue.claimTask(payload, taskId='value', runId='value') # -> result

Reclaim task

Refresh the claim for a specific runId for given taskId. This updates the takenUntil property and returns a new set of temporary credentials for performing requests on behalf of the task. These credentials should be used in-place of the credentials returned by claimWork.

The reclaimTask requests serves to:

Postpone takenUntil preventing the queue from resolving claim-expired,
Refresh temporary credentials used for processing the task, and
Abort execution if the task/run have been resolved.

If the takenUntil timestamp is exceeded the queue will resolve the run as exception with reason claim-expired, and proceeded to retry to the task. This ensures that tasks are retried, even if workers disappear without warning.

If the task is resolved, this end-point will return 409 reporting RequestConflict. This typically happens if the task have been canceled or the task.deadline have been exceeded. If reclaiming fails, workers should abort the task and forget about the given runId. There is no need to resolve the run or upload artifacts.

Takes the following arguments:

taskId
runId

Has required output schema

# Sync calls
queue.reclaimTask(taskId, runId) # -> result
queue.reclaimTask(taskId='value', runId='value') # -> result
# Async call
await asyncQueue.reclaimTask(taskId, runId) # -> result
await asyncQueue.reclaimTask(taskId='value', runId='value') # -> result

Report Run Completed

Report a task completed, resolving the run as completed.

Takes the following arguments:

taskId
runId

Has required output schema

# Sync calls
queue.reportCompleted(taskId, runId) # -> result
queue.reportCompleted(taskId='value', runId='value') # -> result
# Async call
await asyncQueue.reportCompleted(taskId, runId) # -> result
await asyncQueue.reportCompleted(taskId='value', runId='value') # -> result

Report Run Failed

Report a run failed, resolving the run as failed. Use this to resolve a run that failed because the task specific code behaved unexpectedly. For example the task exited non-zero, or didn't produce expected output.

Do not use this if the task couldn't be run because if malformed payload, or other unexpected condition. In these cases we have a task exception, which should be reported with reportException.

Takes the following arguments:

taskId
runId

Has required output schema

# Sync calls
queue.reportFailed(taskId, runId) # -> result
queue.reportFailed(taskId='value', runId='value') # -> result
# Async call
await asyncQueue.reportFailed(taskId, runId) # -> result
await asyncQueue.reportFailed(taskId='value', runId='value') # -> result

Report Task Exception

Resolve a run as exception. Generally, you will want to report tasks as failed instead of exception. You should reportException if,

The task.payload is invalid,
Non-existent resources are referenced,
Declared actions cannot be executed due to unavailable resources,
The worker had to shutdown prematurely,
The worker experienced an unknown error, or,
The task explicitly requested a retry.

Do not use this to signal that some user-specified code crashed for any reason specific to this code. If user-specific code hits a resource that is temporarily unavailable worker should report task failed.

Takes the following arguments:

taskId
runId

Has required input schema

Has required output schema

# Sync calls
queue.reportException(taskId, runId, payload) # -> result
queue.reportException(payload, taskId='value', runId='value') # -> result
# Async call
await asyncQueue.reportException(taskId, runId, payload) # -> result
await asyncQueue.reportException(payload, taskId='value', runId='value') # -> result

Create Artifact

This API end-point creates an artifact for a specific run of a task. This should only be used by a worker currently operating on this task, or from a process running within the task (ie. on the worker).

All artifacts must specify when they expires, the queue will automatically take care of deleting artifacts past their expiration point. This features makes it feasible to upload large intermediate artifacts from data processing applications, as the artifacts can be set to expire a few days later.

We currently support "S3 Artifacts" officially, with remaining support for two deprecated types. Do not use these deprecated types.

S3 artifacts, is useful for static files which will be stored on S3. When creating an S3 artifact the queue will return a pre-signed URL to which you can do a PUT request to upload your artifact. Note that PUT request must specify the content-length header and must give the content-type header the same value as in the request to createArtifact.

Reference artifacts, only consists of meta-data which the queue will store for you. These artifacts really only have a url property and when the artifact is requested the client will be redirect the URL provided with a 303 (See Other) redirect. Please note that we cannot delete artifacts you upload to other service, we can only delete the reference to the artifact, when it expires.

Error artifacts, only consists of meta-data which the queue will store for you. These artifacts are only meant to indicate that you the worker or the task failed to generate a specific artifact, that you would otherwise have uploaded. For example docker-worker will upload an error artifact, if the file it was supposed to upload doesn't exists or turns out to be a directory. Clients requesting an error artifact will get a 424 (Failed Dependency) response. This is mainly designed to ensure that dependent tasks can distinguish between artifacts that were suppose to be generated and artifacts for which the name is misspelled.

Artifact immutability, generally speaking you cannot overwrite an artifact when created. But if you repeat the request with the same properties the request will succeed as the operation is idempotent. This is useful if you need to refresh a signed URL while uploading. Do not abuse this to overwrite artifacts created by another entity! Such as worker-host overwriting artifact created by worker-code.

As a special case the url property on reference artifacts can be updated. You should only use this to update the url property for reference artifacts your process has created.

Takes the following arguments:

taskId
runId
name

Has required input schema

Has required output schema

# Sync calls
queue.createArtifact(taskId, runId, name, payload) # -> result
queue.createArtifact(payload, taskId='value', runId='value', name='value') # -> result
# Async call
await asyncQueue.createArtifact(taskId, runId, name, payload) # -> result
await asyncQueue.createArtifact(payload, taskId='value', runId='value', name='value') # -> result

Get Artifact from Run

Get artifact by <name> from a specific run.

Public Artifacts, in-order to get an artifact you need the scope queue:get-artifact:<name>, where <name> is the name of the artifact. But if the artifact name starts with public/, authentication and authorization is not necessary to fetch the artifact.

API Clients, this method will redirect you to the artifact, if it is stored externally. Either way, the response may not be JSON. So API client users might want to generate a signed URL for this end-point and use that URL with an HTTP client that can handle responses correctly.

Downloading artifacts There are some special considerations for those http clients which download artifacts. This api endpoint is designed to be compatible with an HTTP 1.1 compliant client, but has extra features to ensure the download is valid. It is strongly recommend that consumers use either taskcluster-lib-artifact (JS), taskcluster-lib-artifact-go (Go) or the CLI written in Go to interact with artifacts.

In order to download an artifact the following must be done:

Obtain queue url. Building a signed url with a taskcluster client is recommended
Make a GET request which does not follow redirects
In all cases, if specified, the x-taskcluster-location-{content,transfer}-{sha256,length} values must be validated to be equal to the Content-Length and Sha256 checksum of the final artifact downloaded. as well as any intermediate redirects
If this response is a 500-series error, retry using an exponential backoff. No more than 5 retries should be attempted
If this response is a 400-series error, treat it appropriately for your context. This might be an error in responding to this request or an Error storage type body. This request should not be retried.
If this response is a 200-series response, the response body is the artifact. If the x-taskcluster-location-{content,transfer}-{sha256,length} and x-taskcluster-location-content-encoding are specified, they should match this response body
If the response type is a 300-series redirect, the artifact will be at the location specified by the Location header. There are multiple artifact storage types which use a 300-series redirect.
For all redirects followed, the user must verify that the content-sha256, content-length, transfer-sha256, transfer-length and content-encoding match every further request. The final artifact must also be validated against the values specified in the original queue response
Caching of requests with an x-taskcluster-artifact-storage-type value of reference must not occur

Headers The following important headers are set on the response to this method:

location: the url of the artifact if a redirect is to be performed
x-taskcluster-artifact-storage-type: the storage type. Example: s3

The following important headers are set on responses to this method for Blob artifacts

x-taskcluster-location-content-sha256: the SHA256 of the artifact after any content-encoding is undone. Sha256 is hex encoded (e.g. [0-9A-Fa-f]{64})
x-taskcluster-location-content-length: the number of bytes after any content-encoding is undone
x-taskcluster-location-transfer-sha256: the SHA256 of the artifact before any content-encoding is undone. This is the SHA256 of what is sent over the wire. Sha256 is hex encoded (e.g. [0-9A-Fa-f]{64})
x-taskcluster-location-transfer-length: the number of bytes after any content-encoding is undone
x-taskcluster-location-content-encoding: the content-encoding used. It will either be gzip or identity right now. This is hardcoded to a value set when the artifact was created and no content-negotiation occurs
x-taskcluster-location-content-type: the content-type of the artifact

Caching, artifacts may be cached in data centers closer to the workers in-order to reduce bandwidth costs. This can lead to longer response times. Caching can be skipped by setting the header x-taskcluster-skip-cache: true, this should only be used for resources where request volume is known to be low, and caching not useful. (This feature may be disabled in the future, use is sparingly!)

Takes the following arguments:

taskId
runId
name

# Sync calls
queue.getArtifact(taskId, runId, name) # -> None
queue.getArtifact(taskId='value', runId='value', name='value') # -> None
# Async call
await asyncQueue.getArtifact(taskId, runId, name) # -> None
await asyncQueue.getArtifact(taskId='value', runId='value', name='value') # -> None

Get Artifact from Latest Run

Get artifact by <name> from the last run of a task.

Remark, this end-point is slightly slower than queue.getArtifact, so consider that if you already know the runId of the latest run. Otherwise, just us the most convenient API end-point.

Takes the following arguments:

taskId
name

# Sync calls
queue.getLatestArtifact(taskId, name) # -> None
queue.getLatestArtifact(taskId='value', name='value') # -> None
# Async call
await asyncQueue.getLatestArtifact(taskId, name) # -> None
await asyncQueue.getLatestArtifact(taskId='value', name='value') # -> None

Get Artifacts from Run

Returns a list of artifacts and associated meta-data for a given run.

As a task may have many artifacts paging may be necessary. If this end-point returns a continuationToken, you should call the end-point again with the continuationToken as the query-string option: continuationToken.

By default this end-point will list up-to 1000 artifacts in a single page you may limit this with the query-string parameter limit.

Takes the following arguments:

taskId
runId

Has required output schema

# Sync calls
queue.listArtifacts(taskId, runId) # -> result
queue.listArtifacts(taskId='value', runId='value') # -> result
# Async call
await asyncQueue.listArtifacts(taskId, runId) # -> result
await asyncQueue.listArtifacts(taskId='value', runId='value') # -> result

Get Artifacts from Latest Run

Returns a list of artifacts and associated meta-data for the latest run from the given task.

By default this end-point will list up-to 1000 artifacts in a single page you may limit this with the query-string parameter limit.

Takes the following arguments:

taskId

Has required output schema

# Sync calls
queue.listLatestArtifacts(taskId) # -> result
queue.listLatestArtifacts(taskId='value') # -> result
# Async call
await asyncQueue.listLatestArtifacts(taskId) # -> result
await asyncQueue.listLatestArtifacts(taskId='value') # -> result

Get a list of all active provisioners

Get all active provisioners.

The term "provisioner" is taken broadly to mean anything with a provisionerId. This does not necessarily mean there is an associated service performing any provisioning activity.

The response is paged. If this end-point returns a continuationToken, you should call the end-point again with the continuationToken as a query-string option. By default this end-point will list up to 1000 provisioners in a single page. You may limit this with the query-string parameter limit.

Has required output schema

# Sync calls
queue.listProvisioners() # -> result
# Async call
await asyncQueue.listProvisioners() # -> result

Get an active provisioner

Get an active provisioner.

The term "provisioner" is taken broadly to mean anything with a provisionerId. This does not necessarily mean there is an associated service performing any provisioning activity.

Takes the following arguments:

provisionerId

Has required output schema

# Sync calls
queue.getProvisioner(provisionerId) # -> result
queue.getProvisioner(provisionerId='value') # -> result
# Async call
await asyncQueue.getProvisioner(provisionerId) # -> result
await asyncQueue.getProvisioner(provisionerId='value') # -> result

Update a provisioner

Declare a provisioner, supplying some details about it.

declareProvisioner allows updating one or more properties of a provisioner as long as the required scopes are possessed. For example, a request to update the my-provisioner provisioner with a body {description: 'This provisioner is great'} would require you to have the scope queue:declare-provisioner:my-provisioner#description.

The term "provisioner" is taken broadly to mean anything with a provisionerId. This does not necessarily mean there is an associated service performing any provisioning activity.

Takes the following arguments:

provisionerId

Has required input schema

Has required output schema

# Sync calls
queue.declareProvisioner(provisionerId, payload) # -> result
queue.declareProvisioner(payload, provisionerId='value') # -> result
# Async call
await asyncQueue.declareProvisioner(provisionerId, payload) # -> result
await asyncQueue.declareProvisioner(payload, provisionerId='value') # -> result

Get Number of Pending Tasks

Get an approximate number of pending tasks for the given provisionerId and workerType.

The underlying Azure Storage Queues only promises to give us an estimate. Furthermore, we cache the result in memory for 20 seconds. So consumers should be no means expect this to be an accurate number. It is, however, a solid estimate of the number of pending tasks.

Takes the following arguments:

provisionerId
workerType

Has required output schema

# Sync calls
queue.pendingTasks(provisionerId, workerType) # -> result
queue.pendingTasks(provisionerId='value', workerType='value') # -> result
# Async call
await asyncQueue.pendingTasks(provisionerId, workerType) # -> result
await asyncQueue.pendingTasks(provisionerId='value', workerType='value') # -> result

Get a list of all active worker-types

Get all active worker-types for the given provisioner.

The response is paged. If this end-point returns a continuationToken, you should call the end-point again with the continuationToken as a query-string option. By default this end-point will list up to 1000 worker-types in a single page. You may limit this with the query-string parameter limit.

Takes the following arguments:

provisionerId

Has required output schema

# Sync calls
queue.listWorkerTypes(provisionerId) # -> result
queue.listWorkerTypes(provisionerId='value') # -> result
# Async call
await asyncQueue.listWorkerTypes(provisionerId) # -> result
await asyncQueue.listWorkerTypes(provisionerId='value') # -> result

Get a worker-type

Get a worker-type from a provisioner.

Takes the following arguments:

provisionerId
workerType

Has required output schema

# Sync calls
queue.getWorkerType(provisionerId, workerType) # -> result
queue.getWorkerType(provisionerId='value', workerType='value') # -> result
# Async call
await asyncQueue.getWorkerType(provisionerId, workerType) # -> result
await asyncQueue.getWorkerType(provisionerId='value', workerType='value') # -> result

Update a worker-type

Declare a workerType, supplying some details about it.

declareWorkerType allows updating one or more properties of a worker-type as long as the required scopes are possessed. For example, a request to update the highmem worker-type within the my-provisioner provisioner with a body {description: 'This worker type is great'} would require you to have the scope queue:declare-worker-type:my-provisioner/highmem#description.

Takes the following arguments:

provisionerId
workerType

Has required input schema

Has required output schema

# Sync calls
queue.declareWorkerType(provisionerId, workerType, payload) # -> result
queue.declareWorkerType(payload, provisionerId='value', workerType='value') # -> result
# Async call
await asyncQueue.declareWorkerType(provisionerId, workerType, payload) # -> result
await asyncQueue.declareWorkerType(payload, provisionerId='value', workerType='value') # -> result

Get a list of all active workers of a workerType

Get a list of all active workers of a workerType.

listWorkers allows a response to be filtered by quarantined and non quarantined workers. To filter the query, you should call the end-point with quarantined as a query-string option with a true or false value.

The response is paged. If this end-point returns a continuationToken, you should call the end-point again with the continuationToken as a query-string option. By default this end-point will list up to 1000 workers in a single page. You may limit this with the query-string parameter limit.

Takes the following arguments:

provisionerId
workerType

Has required output schema

# Sync calls
queue.listWorkers(provisionerId, workerType) # -> result
queue.listWorkers(provisionerId='value', workerType='value') # -> result
# Async call
await asyncQueue.listWorkers(provisionerId, workerType) # -> result
await asyncQueue.listWorkers(provisionerId='value', workerType='value') # -> result

Get a worker-type

Get a worker from a worker-type.

Takes the following arguments:

provisionerId
workerType
workerGroup
workerId

Has required output schema

# Sync calls
queue.getWorker(provisionerId, workerType, workerGroup, workerId) # -> result
queue.getWorker(provisionerId='value', workerType='value', workerGroup='value', workerId='value') # -> result
# Async call
await asyncQueue.getWorker(provisionerId, workerType, workerGroup, workerId) # -> result
await asyncQueue.getWorker(provisionerId='value', workerType='value', workerGroup='value', workerId='value') # -> result

Quarantine a worker

Takes the following arguments:

provisionerId
workerType
workerGroup
workerId

Has required input schema

Has required output schema

# Sync calls
queue.quarantineWorker(provisionerId, workerType, workerGroup, workerId, payload) # -> result
queue.quarantineWorker(payload, provisionerId='value', workerType='value', workerGroup='value', workerId='value') # -> result
# Async call
await asyncQueue.quarantineWorker(provisionerId, workerType, workerGroup, workerId, payload) # -> result
await asyncQueue.quarantineWorker(payload, provisionerId='value', workerType='value', workerGroup='value', workerId='value') # -> result

Declare a worker

Declare a worker, supplying some details about it.

declareWorker allows updating one or more properties of a worker as long as the required scopes are possessed.

Takes the following arguments:

provisionerId
workerType
workerGroup
workerId

Has required input schema

Has required output schema

# Sync calls
queue.declareWorker(provisionerId, workerType, workerGroup, workerId, payload) # -> result
queue.declareWorker(payload, provisionerId='value', workerType='value', workerGroup='value', workerId='value') # -> result
# Async call
await asyncQueue.declareWorker(provisionerId, workerType, workerGroup, workerId, payload) # -> result
await asyncQueue.declareWorker(payload, provisionerId='value', workerType='value', workerGroup='value', workerId='value') # -> result

Exchanges in `taskcluster.QueueEvents`

import taskcluster

# Create QueueEvents client instance
queueEvents = taskcluster.QueueEvents(options)

The queue service is responsible for accepting tasks and track their state as they are executed by workers. In order ensure they are eventually resolved.

This document describes AMQP exchanges offered by the queue, which allows third-party listeners to monitor tasks as they progress to resolution. These exchanges targets the following audience:

Schedulers, who takes action after tasks are completed,
Workers, who wants to listen for new or canceled tasks (optional),
Tools, that wants to update their view as task progress.

You'll notice that all the exchanges in the document shares the same routing key pattern. This makes it very easy to bind to all messages about a certain kind tasks.

Task specific routes, a task can define a task specific route using the task.routes property. See task creation documentation for details on permissions required to provide task specific routes. If a task has the entry 'notify.by-email' in as task specific route defined in task.routes all messages about this task will be CC'ed with the routing-key 'route.notify.by-email'.

These routes will always be prefixed route., so that cannot interfere with the primary routing key as documented here. Notice that the primary routing key is always prefixed primary.. This is ensured in the routing key reference, so API clients will do this automatically.

Please, note that the way RabbitMQ works, the message will only arrive in your queue once, even though you may have bound to the exchange with multiple routing key patterns that matches more of the CC'ed routing routing keys.

Delivery guarantees, most operations on the queue are idempotent, which means that if repeated with the same arguments then the requests will ensure completion of the operation and return the same response. This is useful if the server crashes or the TCP connection breaks, but when re-executing an idempotent operation, the queue will also resend any related AMQP messages. Hence, messages may be repeated.

This shouldn't be much of a problem, as the best you can achieve using confirm messages with AMQP is at-least-once delivery semantics. Hence, this only prevents you from obtaining at-most-once delivery semantics.

Remark, some message generated by timeouts maybe dropped if the server crashes at wrong time. Ideally, we'll address this in the future. For now we suggest you ignore this corner case, and notify us if this corner case is of concern to you.

Task Defined Messages

queueEvents.taskDefined(routingKeyPattern) -> routingKey
- routingKeyKind is constant of primary is required Description: Identifier for the routing-key kind. This is always 'primary' for the formalized routing key.
- taskId is required Description: taskId for the task this message concerns
- runId Description: runId of latest run for the task, _ if no run is exists for the task.
- workerGroup Description: workerGroup of latest run for the task, _ if no run is exists for the task.
- workerId Description: workerId of latest run for the task, _ if no run is exists for the task.
- provisionerId is required Description: provisionerId this task is targeted at.
- workerType is required Description: workerType this task must run on.
- schedulerId is required Description: schedulerId this task was created by.
- taskGroupId is required Description: taskGroupId this task was created in.
- reserved Description: Space reserved for future routing-key entries, you should always match this entry with #. As automatically done by our tooling, if not specified.

Task Pending Messages

queueEvents.taskPending(routingKeyPattern) -> routingKey
- routingKeyKind is constant of primary is required Description: Identifier for the routing-key kind. This is always 'primary' for the formalized routing key.
- taskId is required Description: taskId for the task this message concerns
- runId is required Description: runId of latest run for the task, _ if no run is exists for the task.
- workerGroup Description: workerGroup of latest run for the task, _ if no run is exists for the task.
- workerId Description: workerId of latest run for the task, _ if no run is exists for the task.
- provisionerId is required Description: provisionerId this task is targeted at.
- workerType is required Description: workerType this task must run on.
- schedulerId is required Description: schedulerId this task was created by.
- taskGroupId is required Description: taskGroupId this task was created in.
- reserved Description: Space reserved for future routing-key entries, you should always match this entry with #. As automatically done by our tooling, if not specified.

Task Running Messages

queueEvents.taskRunning(routingKeyPattern) -> routingKey
- routingKeyKind is constant of primary is required Description: Identifier for the routing-key kind. This is always 'primary' for the formalized routing key.
- taskId is required Description: taskId for the task this message concerns
- runId is required Description: runId of latest run for the task, _ if no run is exists for the task.
- workerGroup is required Description: workerGroup of latest run for the task, _ if no run is exists for the task.
- workerId is required Description: workerId of latest run for the task, _ if no run is exists for the task.
- provisionerId is required Description: provisionerId this task is targeted at.
- workerType is required Description: workerType this task must run on.
- schedulerId is required Description: schedulerId this task was created by.
- taskGroupId is required Description: taskGroupId this task was created in.
- reserved Description: Space reserved for future routing-key entries, you should always match this entry with #. As automatically done by our tooling, if not specified.

Artifact Creation Messages

queueEvents.artifactCreated(routingKeyPattern) -> routingKey
- routingKeyKind is constant of primary is required Description: Identifier for the routing-key kind. This is always 'primary' for the formalized routing key.
- taskId is required Description: taskId for the task this message concerns
- runId is required Description: runId of latest run for the task, _ if no run is exists for the task.
- workerGroup is required Description: workerGroup of latest run for the task, _ if no run is exists for the task.
- workerId is required Description: workerId of latest run for the task, _ if no run is exists for the task.
- provisionerId is required Description: provisionerId this task is targeted at.
- workerType is required Description: workerType this task must run on.
- schedulerId is required Description: schedulerId this task was created by.
- taskGroupId is required Description: taskGroupId this task was created in.
- reserved Description: Space reserved for future routing-key entries, you should always match this entry with #. As automatically done by our tooling, if not specified.

Task Completed Messages

queueEvents.taskCompleted(routingKeyPattern) -> routingKey
- routingKeyKind is constant of primary is required Description: Identifier for the routing-key kind. This is always 'primary' for the formalized routing key.
- taskId is required Description: taskId for the task this message concerns
- runId is required Description: runId of latest run for the task, _ if no run is exists for the task.
- workerGroup is required Description: workerGroup of latest run for the task, _ if no run is exists for the task.
- workerId is required Description: workerId of latest run for the task, _ if no run is exists for the task.
- provisionerId is required Description: provisionerId this task is targeted at.
- workerType is required Description: workerType this task must run on.
- schedulerId is required Description: schedulerId this task was created by.
- taskGroupId is required Description: taskGroupId this task was created in.
- reserved Description: Space reserved for future routing-key entries, you should always match this entry with #. As automatically done by our tooling, if not specified.

Task Failed Messages

queueEvents.taskFailed(routingKeyPattern) -> routingKey
- routingKeyKind is constant of primary is required Description: Identifier for the routing-key kind. This is always 'primary' for the formalized routing key.
- taskId is required Description: taskId for the task this message concerns
- runId Description: runId of latest run for the task, _ if no run is exists for the task.
- workerGroup Description: workerGroup of latest run for the task, _ if no run is exists for the task.
- workerId Description: workerId of latest run for the task, _ if no run is exists for the task.
- provisionerId is required Description: provisionerId this task is targeted at.
- workerType is required Description: workerType this task must run on.
- schedulerId is required Description: schedulerId this task was created by.
- taskGroupId is required Description: taskGroupId this task was created in.
- reserved Description: Space reserved for future routing-key entries, you should always match this entry with #. As automatically done by our tooling, if not specified.

Task Exception Messages

queueEvents.taskException(routingKeyPattern) -> routingKey
- routingKeyKind is constant of primary is required Description: Identifier for the routing-key kind. This is always 'primary' for the formalized routing key.
- taskId is required Description: taskId for the task this message concerns
- runId Description: runId of latest run for the task, _ if no run is exists for the task.
- workerGroup Description: workerGroup of latest run for the task, _ if no run is exists for the task.
- workerId Description: workerId of latest run for the task, _ if no run is exists for the task.
- provisionerId is required Description: provisionerId this task is targeted at.
- workerType is required Description: workerType this task must run on.
- schedulerId is required Description: schedulerId this task was created by.
- taskGroupId is required Description: taskGroupId this task was created in.
- reserved Description: Space reserved for future routing-key entries, you should always match this entry with #. As automatically done by our tooling, if not specified.

Task Group Resolved Messages

queueEvents.taskGroupResolved(routingKeyPattern) -> routingKey
- routingKeyKind is constant of primary is required Description: Identifier for the routing-key kind. This is always 'primary' for the formalized routing key.
- taskGroupId is required Description: taskGroupId for the task-group this message concerns
- schedulerId is required Description: schedulerId for the task-group this message concerns
- reserved Description: Space reserved for future routing-key entries, you should always match this entry with #. As automatically done by our tooling, if not specified.

Methods in `taskcluster.Secrets`

import asyncio # Only for async 
import taskcluster
import taskcluster.aio

# Create Secrets client instance
secrets = taskcluster.Secrets(options)
# Below only for async instances, assume already in coroutine
loop = asyncio.get_event_loop()
session = taskcluster.aio.createSession(loop=loop)
asyncSecrets = taskcluster.aio.Secrets(options, session=session)

The secrets service provides a simple key/value store for small bits of secret data. Access is limited by scopes, so values can be considered secret from those who do not have the relevant scopes.

Secrets also have an expiration date, and once a secret has expired it can no longer be read. This is useful for short-term secrets such as a temporary service credential or a one-time signing key.

Ping Server

Respond without doing anything. This endpoint is used to check that the service is up.

# Sync calls
secrets.ping() # -> None
# Async call
await asyncSecrets.ping() # -> None

Set Secret

Set the secret associated with some key. If the secret already exists, it is updated instead.

Takes the following arguments:

name

Has required input schema

# Sync calls
secrets.set(name, payload) # -> None
secrets.set(payload, name='value') # -> None
# Async call
await asyncSecrets.set(name, payload) # -> None
await asyncSecrets.set(payload, name='value') # -> None

Delete Secret

Delete the secret associated with some key.

Takes the following arguments:

name

# Sync calls
secrets.remove(name) # -> None
secrets.remove(name='value') # -> None
# Async call
await asyncSecrets.remove(name) # -> None
await asyncSecrets.remove(name='value') # -> None

Read Secret

Read the secret associated with some key. If the secret has recently expired, the response code 410 is returned. If the caller lacks the scope necessary to get the secret, the call will fail with a 403 code regardless of whether the secret exists.

Takes the following arguments:

name

Has required output schema

# Sync calls
secrets.get(name) # -> result
secrets.get(name='value') # -> result
# Async call
await asyncSecrets.get(name) # -> result
await asyncSecrets.get(name='value') # -> result

List Secrets

List the names of all secrets.

By default this end-point will try to return up to 1000 secret names in one request. But it may return less, even if more tasks are available. It may also return a continuationToken even though there are no more results. However, you can only be sure to have seen all results if you keep calling listTaskGroup with the last continuationToken until you get a result without a continuationToken.

If you are not interested in listing all the members at once, you may use the query-string option limit to return fewer.

Has required output schema

# Sync calls
secrets.list() # -> result
# Async call
await asyncSecrets.list() # -> result

Methods in `taskcluster.WorkerManager`

import asyncio # Only for async 
import taskcluster
import taskcluster.aio

# Create WorkerManager client instance
workerManager = taskcluster.WorkerManager(options)
# Below only for async instances, assume already in coroutine
loop = asyncio.get_event_loop()
session = taskcluster.aio.createSession(loop=loop)
asyncWorkerManager = taskcluster.aio.WorkerManager(options, session=session)

This service manages workers, including provisioning for dynamic worker pools.

Ping Server

Respond without doing anything. This endpoint is used to check that the service is up.

# Sync calls
workerManager.ping() # -> None
# Async call
await asyncWorkerManager.ping() # -> None

List Providers

Retrieve a list of providers that are available for worker pools.

Has required output schema

# Sync calls
workerManager.listProviders() # -> result
# Async call
await asyncWorkerManager.listProviders() # -> result

Create Worker Pool

Create a new worker pool. If the worker pool already exists, this will throw an error.

Takes the following arguments:

workerPoolId

Has required input schema

Has required output schema

# Sync calls
workerManager.createWorkerPool(workerPoolId, payload) # -> result
workerManager.createWorkerPool(payload, workerPoolId='value') # -> result
# Async call
await asyncWorkerManager.createWorkerPool(workerPoolId, payload) # -> result
await asyncWorkerManager.createWorkerPool(payload, workerPoolId='value') # -> result

Update Worker Pool

Given an existing worker pool definition, this will modify it and return the new definition.

To delete a worker pool, set its providerId to "null-provider". After any existing workers have exited, a cleanup job will remove the worker pool. During that time, the worker pool can be updated again, such as to set its providerId to a real provider.

Takes the following arguments:

workerPoolId

Has required input schema

Has required output schema

# Sync calls
workerManager.updateWorkerPool(workerPoolId, payload) # -> result
workerManager.updateWorkerPool(payload, workerPoolId='value') # -> result
# Async call
await asyncWorkerManager.updateWorkerPool(workerPoolId, payload) # -> result
await asyncWorkerManager.updateWorkerPool(payload, workerPoolId='value') # -> result

Delete Worker Pool

Mark a worker pool for deletion. This is the same as updating the pool to set its providerId to "null-provider", but does not require scope worker-manager:provider:null-provider.

Takes the following arguments:

workerPoolId

Has required output schema

# Sync calls
workerManager.deleteWorkerPool(workerPoolId) # -> result
workerManager.deleteWorkerPool(workerPoolId='value') # -> result
# Async call
await asyncWorkerManager.deleteWorkerPool(workerPoolId) # -> result
await asyncWorkerManager.deleteWorkerPool(workerPoolId='value') # -> result

Get Worker Pool

Fetch an existing worker pool defition.

Takes the following arguments:

workerPoolId

Has required output schema

# Sync calls
workerManager.workerPool(workerPoolId) # -> result
workerManager.workerPool(workerPoolId='value') # -> result
# Async call
await asyncWorkerManager.workerPool(workerPoolId) # -> result
await asyncWorkerManager.workerPool(workerPoolId='value') # -> result

List All Worker Pools

Get the list of all the existing worker pools.

Has required output schema

# Sync calls
workerManager.listWorkerPools() # -> result
# Async call
await asyncWorkerManager.listWorkerPools() # -> result

Report an error from a worker

Report an error that occurred on a worker. This error will be included with the other errors in listWorkerPoolErrors(workerPoolId).

Workers can use this endpoint to report startup or configuration errors that might be associated with the worker pool configuration and thus of interest to a worker-pool administrator.

NOTE: errors are publicly visible. Ensure that none of the content contains secrets or other sensitive information.

Takes the following arguments:

workerPoolId

Has required input schema

Has required output schema

# Sync calls
workerManager.reportWorkerError(workerPoolId, payload) # -> result
workerManager.reportWorkerError(payload, workerPoolId='value') # -> result
# Async call
await asyncWorkerManager.reportWorkerError(workerPoolId, payload) # -> result
await asyncWorkerManager.reportWorkerError(payload, workerPoolId='value') # -> result

List Worker Pool Errors

Get the list of worker pool errors.

Takes the following arguments:

workerPoolId

Has required output schema

# Sync calls
workerManager.listWorkerPoolErrors(workerPoolId) # -> result
workerManager.listWorkerPoolErrors(workerPoolId='value') # -> result
# Async call
await asyncWorkerManager.listWorkerPoolErrors(workerPoolId) # -> result
await asyncWorkerManager.listWorkerPoolErrors(workerPoolId='value') # -> result

Workers in a specific Worker Group in a Worker Pool

Get the list of all the existing workers in a given group in a given worker pool.

Takes the following arguments:

workerPoolId
workerGroup

Has required output schema

# Sync calls
workerManager.listWorkersForWorkerGroup(workerPoolId, workerGroup) # -> result
workerManager.listWorkersForWorkerGroup(workerPoolId='value', workerGroup='value') # -> result
# Async call
await asyncWorkerManager.listWorkersForWorkerGroup(workerPoolId, workerGroup) # -> result
await asyncWorkerManager.listWorkersForWorkerGroup(workerPoolId='value', workerGroup='value') # -> result

Get a Worker

Get a single worker.

Takes the following arguments:

workerPoolId
workerGroup
workerId

Has required output schema

# Sync calls
workerManager.worker(workerPoolId, workerGroup, workerId) # -> result
workerManager.worker(workerPoolId='value', workerGroup='value', workerId='value') # -> result
# Async call
await asyncWorkerManager.worker(workerPoolId, workerGroup, workerId) # -> result
await asyncWorkerManager.worker(workerPoolId='value', workerGroup='value', workerId='value') # -> result

Create a Worker

Create a new worker. The precise behavior of this method depends on the provider implementing the given worker pool. Some providers do not support creating workers at all, and will return a 400 error.

Takes the following arguments:

workerPoolId
workerGroup
workerId

Has required input schema

Has required output schema

# Sync calls
workerManager.createWorker(workerPoolId, workerGroup, workerId, payload) # -> result
workerManager.createWorker(payload, workerPoolId='value', workerGroup='value', workerId='value') # -> result
# Async call
await asyncWorkerManager.createWorker(workerPoolId, workerGroup, workerId, payload) # -> result
await asyncWorkerManager.createWorker(payload, workerPoolId='value', workerGroup='value', workerId='value') # -> result

Remove a Worker

Remove an existing worker. The precise behavior of this method depends on the provider implementing the given worker. Some providers do not support removing workers at all, and will return a 400 error. Others may begin removing the worker, but it may remain available via the API (perhaps even in state RUNNING) afterward.

Takes the following arguments:

workerPoolId
workerGroup
workerId

# Sync calls
workerManager.removeWorker(workerPoolId, workerGroup, workerId) # -> None
workerManager.removeWorker(workerPoolId='value', workerGroup='value', workerId='value') # -> None
# Async call
await asyncWorkerManager.removeWorker(workerPoolId, workerGroup, workerId) # -> None
await asyncWorkerManager.removeWorker(workerPoolId='value', workerGroup='value', workerId='value') # -> None

Workers in a Worker Pool

Get the list of all the existing workers in a given worker pool.

Takes the following arguments:

workerPoolId

Has required output schema

# Sync calls
workerManager.listWorkersForWorkerPool(workerPoolId) # -> result
workerManager.listWorkersForWorkerPool(workerPoolId='value') # -> result
# Async call
await asyncWorkerManager.listWorkersForWorkerPool(workerPoolId) # -> result
await asyncWorkerManager.listWorkersForWorkerPool(workerPoolId='value') # -> result

Register a running worker

This call both marks the worker as running and returns the credentials the worker will require to perform its work. The worker must provide some proof of its identity, and that proof varies by provider type.

Has required input schema

Has required output schema

# Sync calls
workerManager.registerWorker(payload) # -> result
# Async call
await asyncWorkerManager.registerWorker(payload) # -> result

Exchanges in `taskcluster.WorkerManagerEvents`

import taskcluster

# Create WorkerManagerEvents client instance
workerManagerEvents = taskcluster.WorkerManagerEvents(options)

These exchanges provide notifications when a worker pool is created or updated.This is so that the provisioner running in a differentprocess at the other end can synchronize to the changes. But you are ofcourse welcome to use these for other purposes, monitoring changes for example.

Worker Pool Created Messages

workerManagerEvents.workerPoolCreated(routingKeyPattern) -> routingKey
- routingKeyKind is constant of primary is required Description: Identifier for the routing-key kind. This is always 'primary' for the formalized routing key.
- reserved Description: Space reserved for future routing-key entries, you should always match this entry with #. As automatically done by our tooling, if not specified.

Worker Pool Updated Messages

workerManagerEvents.workerPoolUpdated(routingKeyPattern) -> routingKey
- routingKeyKind is constant of primary is required Description: Identifier for the routing-key kind. This is always 'primary' for the formalized routing key.
- reserved Description: Space reserved for future routing-key entries, you should always match this entry with #. As automatically done by our tooling, if not specified.

Project details

These details have not been verified by PyPI

Project links

Homepage

Release history Release notifications | RSS feed

74.0.0

Oct 30, 2024

73.0.0

Oct 15, 2024

72.1.1

Oct 14, 2024

72.1.0

Oct 8, 2024

72.0.1

Oct 1, 2024

72.0.0

Sep 30, 2024

71.0.0

Sep 26, 2024

70.0.0

Sep 24, 2024

69.0.1

Sep 18, 2024

69.0.0

Sep 18, 2024

68.0.4

Sep 5, 2024

68.0.3

Aug 30, 2024

68.0.2

Aug 28, 2024

68.0.1

Aug 26, 2024

68.0.0

Aug 21, 2024

67.1.0

Jul 11, 2024

67.0.1

Jul 9, 2024

67.0.0

Jul 9, 2024

66.0.0

Jun 27, 2024

65.4.0

Jun 27, 2024

65.3.0

Jun 25, 2024

65.2.0

Jun 20, 2024

65.1.0

May 22, 2024

65.0.2

May 21, 2024

65.0.1

May 16, 2024

65.0.0

May 16, 2024

64.3.0

May 15, 2024

64.2.8

May 2, 2024

64.2.7

Apr 29, 2024

64.2.6

Apr 22, 2024

64.2.5

Apr 16, 2024

64.2.4

Apr 8, 2024

64.2.3

Apr 4, 2024

64.2.2

Apr 4, 2024

64.2.1

Apr 1, 2024

64.2.0

Mar 26, 2024

64.1.2

Mar 25, 2024

64.1.1

Mar 25, 2024

64.0.0

Mar 20, 2024

62.0.0

Mar 14, 2024

61.0.0

Mar 13, 2024

60.4.2

Mar 1, 2024

60.4.1

Feb 29, 2024

60.4.0

Feb 22, 2024

60.3.5

Feb 16, 2024

60.3.4

Feb 7, 2024

60.3.3

Feb 1, 2024

60.3.2

Jan 30, 2024

60.3.1

Jan 24, 2024

60.3.0

Jan 23, 2024

60.2.0

Jan 22, 2024

60.1.3

Jan 18, 2024

60.1.2

Jan 18, 2024

60.1.0

Jan 18, 2024

60.0.1

Jan 11, 2024

60.0.0

Jan 8, 2024

59.2.0

Dec 20, 2023

59.1.3

Dec 14, 2023

59.1.1

Dec 7, 2023

59.1.0

Dec 6, 2023

59.0.1

Dec 4, 2023

59.0.0

Dec 4, 2023

58.0.2

Nov 22, 2023

58.0.1

Nov 21, 2023

58.0.0

Nov 17, 2023

57.1.0

Nov 2, 2023

57.0.1

Oct 31, 2023

57.0.0

Oct 30, 2023

56.0.3

Oct 18, 2023

56.0.2

Oct 12, 2023

56.0.1

Oct 11, 2023

56.0.0

Oct 11, 2023

55.3.4

Oct 4, 2023

55.3.3

Oct 2, 2023

55.3.2

Sep 28, 2023

55.3.0

Sep 18, 2023

55.2.1

Sep 14, 2023

55.1.1

Sep 7, 2023

55.1.0

Sep 7, 2023

55.0.1

Sep 5, 2023

55.0.0

Sep 1, 2023

54.5.0

Aug 30, 2023

54.4.2

Aug 15, 2023

54.4.1

Jul 25, 2023

54.4.0

Jul 19, 2023

54.3.1

Jul 17, 2023

54.3.0

Jul 17, 2023

54.2.0

Jul 14, 2023

54.1.4

Jul 11, 2023

54.1.3

Jul 11, 2023

54.1.2

Jun 30, 2023

54.1.1

Jun 30, 2023

54.0.0

Jun 28, 2023

53.2.1

Jun 27, 2023

53.2.0

Jun 26, 2023

53.1.0

Jun 21, 2023

53.0.0

Jun 12, 2023

52.0.0

Jun 2, 2023

51.1.0

May 30, 2023

51.0.0

May 23, 2023

50.1.3

May 17, 2023

50.1.2

May 17, 2023

50.1.1

May 12, 2023

50.1.0

May 11, 2023

50.0.0

May 9, 2023

49.2.0

May 4, 2023

49.1.3

May 2, 2023

49.1.2

Apr 27, 2023

49.1.1

Apr 18, 2023

49.1.0

Apr 14, 2023

49.0.0

Apr 3, 2023

48.3.0

Mar 29, 2023

48.2.1

Mar 27, 2023

48.2.0

Mar 27, 2023

48.1.0

Mar 21, 2023

48.0.0

Mar 7, 2023

47.1.2

Feb 23, 2023

47.1.0

Feb 7, 2023

47.0.3

Jan 24, 2023

47.0.2

Jan 11, 2023

47.0.0

Jan 10, 2023

46.1.1

Dec 16, 2022

46.1.0

Dec 14, 2022

46.0.0

Dec 9, 2022

45.0.1

Dec 2, 2022

45.0.0

Nov 30, 2022

44.23.4

Nov 15, 2022

44.23.3

Nov 3, 2022

44.23.2

Oct 31, 2022

44.23.1

Oct 31, 2022

44.23.0

Oct 25, 2022

44.22.1

Oct 18, 2022

44.22.0

Oct 12, 2022

44.21.0

Sep 19, 2022

44.20.4

Sep 6, 2022

44.20.2

Sep 2, 2022

44.20.0

Sep 2, 2022

44.19.1

Aug 24, 2022

44.18.0

Aug 3, 2022

44.17.2

Jul 27, 2022

44.17.1

Jul 12, 2022

44.17.0

Jun 29, 2022

44.16.4

Jun 24, 2022

44.16.3

Jun 15, 2022

44.16.2

Jun 14, 2022

44.16.1

Jun 10, 2022

44.16.0

Jun 10, 2022

44.15.5

Jun 3, 2022

44.15.4

Jun 2, 2022

44.15.3

Jun 2, 2022

44.15.2

Jun 1, 2022

44.15.1

Jun 1, 2022

44.15.0

Jun 1, 2022

44.14.0

May 31, 2022

44.13.7

May 17, 2022

44.13.6

May 9, 2022

44.13.5

May 4, 2022

44.13.4

May 3, 2022

44.13.3

May 3, 2022

44.13.2

May 3, 2022

44.13.0

Apr 29, 2022

44.12.3

Apr 25, 2022

44.12.2

Apr 25, 2022

44.12.1

Apr 22, 2022

44.11.2

Apr 19, 2022

44.11.1

Apr 12, 2022

44.11.0

Apr 12, 2022

44.10.0

Apr 11, 2022

44.9.2

Apr 4, 2022

44.9.1

Apr 4, 2022

44.9.0

Apr 4, 2022

44.8.5

Mar 25, 2022

44.8.4

Mar 17, 2022

44.8.3

Mar 10, 2022

44.8.2

Mar 4, 2022

44.8.1

Mar 1, 2022

44.8.0

Feb 25, 2022

44.7.2

Feb 25, 2022

44.7.1

Feb 17, 2022

44.7.0

Feb 17, 2022

44.6.1

Feb 16, 2022

44.5.0

Feb 3, 2022

44.4.0

Jan 19, 2022

44.2.2

Aug 18, 2021

44.1.0

Jul 27, 2021

44.0.0

Jun 1, 2021

43.2.0

Apr 28, 2021

43.1.0

Apr 15, 2021

43.0.0

Apr 8, 2021

42.1.1

Mar 10, 2021

42.1.0

Mar 9, 2021

41.1.0

Feb 24, 2021

41.0.2

Feb 17, 2021

41.0.1

Feb 16, 2021

41.0.0

Feb 10, 2021

40.0.3

Jan 11, 2021

40.0.0

Jan 6, 2021

39.2.0

Dec 18, 2020

39.1.2

Dec 15, 2020

39.1.1

Dec 14, 2020

39.1.0

Dec 10, 2020

39.0.0

Dec 2, 2020

38.0.6

Nov 13, 2020

38.0.5

Nov 12, 2020

38.0.4

Nov 6, 2020

38.0.3

Nov 4, 2020

38.0.1

Oct 29, 2020

37.5.1

Oct 20, 2020

37.4.0

Oct 19, 2020

37.3.0

Oct 2, 2020

37.2.0

Sep 17, 2020

37.1.0

Sep 10, 2020

37.0.0

Aug 18, 2020

36.0.0

Aug 3, 2020

35.0.0

Jul 24, 2020

34.0.1

Jul 9, 2020

32.0.0

Jul 6, 2020

31.0.0

Jun 18, 2020

30.1.1

Jun 9, 2020

30.1.0

Jun 6, 2020

30.0.5

Jun 5, 2020

30.0.2

May 27, 2020

30.0.1

May 21, 2020

30.0.0

May 21, 2020

29.6.0

May 14, 2020

29.5.2

May 13, 2020

29.4.1

May 8, 2020

29.4.0

May 7, 2020

29.3.0

May 4, 2020

29.2.0

Apr 28, 2020

29.1.3

Apr 24, 2020

29.1.2

Apr 23, 2020

29.0.1

Apr 10, 2020

29.0.0

Apr 9, 2020

28.2.3

Apr 9, 2020

28.2.2

Apr 6, 2020

28.2.1

Apr 3, 2020

28.2.0

Apr 1, 2020

28.1.0

Mar 23, 2020

28.0.0

Mar 12, 2020

27.2.0

Mar 11, 2020

27.1.0

Mar 11, 2020

27.0.0

Mar 10, 2020

26.0.1

Mar 9, 2020

25.4.0

Feb 26, 2020

25.3.0

Feb 20, 2020

25.2.0

Feb 17, 2020

25.1.1

Feb 14, 2020

24.3.1

Feb 10, 2020

24.3.0

Feb 7, 2020

24.2.0

Jan 14, 2020

24.1.10

Jan 10, 2020

24.1.9

Jan 4, 2020

24.1.2

Dec 18, 2019

24.1.1

Dec 11, 2019

24.1.0

Dec 11, 2019

24.0.2

Dec 10, 2019

24.0.1

Dec 4, 2019

This version

24.0.0

Dec 2, 2019

23.0.0

Nov 18, 2019

22.1.1

Nov 9, 2019

22.1.0

Nov 8, 2019

22.0.0

Nov 4, 2019

21.3.0

Oct 31, 2019

21.2.0

Oct 24, 2019

21.0.0

Oct 17, 2019

20.0.0

Oct 15, 2019

19.0.0

Oct 7, 2019

18.0.3

Oct 3, 2019

18.0.2

Oct 3, 2019

18.0.1

Oct 2, 2019

16.2.0

Aug 21, 2019

16.1.0

Aug 16, 2019

16.0.0

Aug 2, 2019

15.0.0

Jul 24, 2019

14.3.1

Jul 18, 2019

14.3.0

Jul 17, 2019

7.0.1

Mar 21, 2019

7.0.0

Mar 8, 2019

6.0.0

Dec 5, 2018

5.0.0

Oct 4, 2018

4.0.1

Aug 2, 2018

4.0.0

Jul 25, 2018

3.0.2

Jul 2, 2018

3.0.1

May 10, 2018

3.0.0

Apr 4, 2018

2.1.3

Nov 24, 2017

2.1.2

Nov 24, 2017

2.1.1

Nov 24, 2017

2.1.0

Nov 24, 2017

2.0.0

Oct 31, 2017

1.3.5

Aug 28, 2017

1.3.4

Jul 19, 2017

1.3.3

Jun 6, 2017

1.3.2

May 16, 2017

1.3.1

May 15, 2017

1.3.0

May 11, 2017

1.2.0

Feb 22, 2017

1.0.2

Jan 31, 2017

1.0.1

Jan 30, 2017

1.0.0

Jan 30, 2017

0.3.4

Jun 22, 2016

0.3.3

Apr 27, 2016

0.3.2

Apr 27, 2016

0.3.1

Apr 27, 2016

0.3.0

Apr 19, 2016

0.2.1

Apr 18, 2016

0.2.0

Feb 29, 2016

0.1.0

Feb 17, 2016

0.0.32

Dec 21, 2015

0.0.31

Nov 10, 2015

0.0.29

Oct 16, 2015

0.0.28

Oct 8, 2015

0.0.27

Oct 1, 2015

0.0.26

Sep 9, 2015

0.0.25

Sep 3, 2015

0.0.24

Aug 4, 2015

0.0.23

Aug 4, 2015

0.0.22

Jul 16, 2015

0.0.21

Jul 15, 2015

0.0.20

Jul 14, 2015

0.0.19

Jul 3, 2015

0.0.18

Jul 2, 2015

0.0.17

Jul 2, 2015

0.0.16

Apr 8, 2015

0.0.15

Mar 26, 2015

0.0.14

Mar 9, 2015

0.0.13

Mar 9, 2015

0.0.11

Mar 9, 2015

0.0.10

Mar 9, 2015

0.0.9

Feb 23, 2015

0.0.8

Feb 16, 2015

0.0.7

Jan 16, 2015

0.0.6

Nov 20, 2014

0.0.4

Nov 11, 2014

0.0.1

Apr 27, 2016

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

taskcluster-24.0.0.tar.gz (162.6 kB view hashes)

Uploaded Dec 2, 2019 Source

Built Distributions

taskcluster-24.0.0-py3-none-any.whl (138.9 kB view hashes)

Uploaded Dec 2, 2019 Python 3

taskcluster-24.0.0-py2-none-any.whl (138.9 kB view hashes)

Uploaded Dec 2, 2019 Python 2

Hashes for taskcluster-24.0.0.tar.gz

Hashes for taskcluster-24.0.0.tar.gz
Algorithm	Hash digest
SHA256	`971e4b645785fa6786fae1f6b79a8c2a239f4a3b375347365275a5e28cc59689`
MD5	`18cb31e2bd14a1476ce29206c8091531`
BLAKE2b-256	`071948e5d79eb92754ab767a766998a25787a36b860290253452549bc2b44285`

Hashes for taskcluster-24.0.0-py3-none-any.whl

Hashes for taskcluster-24.0.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`dca87517e1b15a5ce82de8dec3e1804f35d7f87f3ac622d4bc8e7a4d46c77282`
MD5	`952c39c6436f836889512e245b82fe44`
BLAKE2b-256	`cde12dc9fc105f2e167cb7891dd6960c670b00e7351bfd3ff41916e9645b23a4`

Hashes for taskcluster-24.0.0-py2-none-any.whl

Hashes for taskcluster-24.0.0-py2-none-any.whl
Algorithm	Hash digest
SHA256	`9f86ed1381f2d591263c709a1fdcdec8a94dbac1e16bc8164b19884bb943f0de`
MD5	`42f8a36598dc0eed22c253748bece31b`
BLAKE2b-256	`c4e93484d255b14a43a5dfbe10a64b50271e2a225e16ac2ad934084fc09e4af5`

taskcluster 24.0.0

Navigation

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Project description

Taskcluster Client for Python

Generating Temporary Credentials

API Documentation

Query-String arguments

Sync vs Async

Usage

Generating URLs

Root URL

Environment Variables

Pagination

Logging

SlugIDs

Scopes

Relative Date-time Utilities

Library helpers to easily integrate Taskcluster in your project

Shared authentication

Loading secrets across multiple authentications

Methods contained in the client library

Methods in taskcluster.Auth

Ping Server

List Clients

Get Client

Create Client

Reset accessToken

Update Client

Enable Client

Disable Client

Delete Client

List Roles (no pagination)

List Roles

List Role IDs

Get Role

Create Role

Update Role

Delete Role

Expand Scopes

Get Current Scopes

Get Temporary Read/Write Credentials S3

List Accounts Managed by Auth

List Tables in an Account Managed by Auth

Get Shared-Access-Signature for Azure Table

List containers in an Account Managed by Auth

Get Shared-Access-Signature for Azure Container

Get DSN for Sentry Project

Get a client token for the Websocktunnel service

Get Temporary GCP Credentials

Authenticate Hawk Request

Test Authentication

Test Authentication (GET)

Exchanges in taskcluster.AuthEvents

Client Created Messages

Client Updated Messages

Client Deleted Messages

Role Created Messages

Role Updated Messages

Role Deleted Messages

Methods in taskcluster.Github

Ping Server

Consume GitHub WebHook

List of Builds

Latest Build Status Badge

Get Repository Info

Latest Status for Branch

Post a status against a given changeset

Post a comment on a given GitHub Issue or Pull Request

Exchanges in taskcluster.GithubEvents

GitHub Pull Request Event

GitHub push Event

GitHub release Event

tc-gh requested the Queue service to create all the tasks in a group

Methods in taskcluster.Hooks

Methods in `taskcluster.Auth`

Reset `accessToken`

Exchanges in `taskcluster.AuthEvents`

Methods in `taskcluster.Github`

Exchanges in `taskcluster.GithubEvents`

Methods in `taskcluster.Hooks`

Exchanges in `taskcluster.HooksEvents`

Methods in `taskcluster.Index`

Methods in `taskcluster.Notify`

Exchanges in `taskcluster.NotifyEvents`

Methods in `taskcluster.PurgeCache`

Methods in `taskcluster.Queue`