client.scripts.patch_containers

A method of the Scripts endpoint.

patch_containers(id: int, *, name: str = None, parent_id: int = None, user_context: str = None, params: List[dict] = None, arguments: dict = None, schedule: dict = None, notifications: dict = None, required_resources: dict = None, repo_http_uri: str = None, repo_ref: str = None, remote_host_credential_id: int = None, git_credential_id: int = None, docker_command: str = None, docker_image_name: str = None, docker_image_tag: str = None, instance_type: str = None, cancel_timeout: int = None, time_zone: str = None, partition_label: str = None, target_project_id: int = None, running_as_id: int = None) → Response

Update a container

API URL: PATCH /scripts/containers/{id}

import civis
client = civis.APIClient()
response = client.scripts.patch_containers(...)

Parameters:

idint

The ID for the script.

namestr, optional

The name of the container.

parent_idint, optional

The ID of the parent job that will trigger this script

user_contextstr, optional

“runner” or “author”, who to execute the script as when run as a template.

paramsList[dict], optional

A definition of the parameters this script accepts in the arguments field.

• namestr

  The variable’s name as used within your code.

• labelstr

  The label to present to users when asking them for the value.

• descriptionstr

  A short sentence or fragment describing this parameter to the end user.

• typestr

  The type of parameter. Valid options: string, multi_line_string, integer, float, bool, file, table, database, credential_aws, credential_redshift, or credential_custom

• requiredbool

  Whether this param is required.

• valueobject

  The value you would like to set this param to. Setting this value makes this parameter a fixed param.

• defaultstr

  If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool’s or false, False, f, n, no, or 0 for false bool’s. Cannot be used for parameters that are required or a credential type.

• allowed_valuesList[dict]

  The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: {label: ‘Import’, ‘value’: ‘import’}

argumentsdict, optional

Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.

scheduledict, optional

• scheduledbool

  If the item is scheduled.

• scheduled_daysList[int]

  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth

• scheduled_hoursList[int]

  Hours of the day it is scheduled on.

• scheduled_minutesList[int]

  Minutes of the day it is scheduled on.

• scheduled_runs_per_hourint

  Deprecated in favor of scheduled minutes.

• scheduled_days_of_monthList[int]

  Days of the month it is scheduled on, mutually exclusive with scheduledDays.

notificationsdict, optional

• urlsList[str]

  URLs to receive a POST request at job completion

• success_email_subjectstr

  Custom subject line for success e-mail.

• success_email_bodystr

  Custom body text for success e-mail, written in Markdown.

• success_email_addressesList[str]

  Addresses to notify by e-mail when the job completes successfully.

• success_email_from_namestr

  Name from which success emails are sent; defaults to “Civis.”

• success_email_reply_tostr

  Address for replies to success emails; defaults to the author of the job.

• failure_email_addressesList[str]

  Addresses to notify by e-mail when the job fails.

• stall_warning_minutesint

  Stall warning emails will be sent after this amount of minutes.

• success_onbool

  If success email notifications are on. Defaults to user’s preferences.

• failure_onbool

  If failure email notifications are on. Defaults to user’s preferences.

required_resourcesdict, optional

• cpuint

  The number of CPU shares to allocate for the container. Each core has 1000 shares. Must be at least 2 shares.

• memoryint

  The amount of RAM to allocate for the container (in MB). Must be at least 4 MB.

• disk_spacefloat (float)

  The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported.

repo_http_uristr, optional

The location of a github repo to clone into the container, e.g. github.com/my-user/my-repo.git.

repo_refstr, optional

The tag or branch of the github repo to clone into the container.

remote_host_credential_idint, optional

The id of the database credentials to pass into the environment of the container.

git_credential_idint, optional

The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you’ve submitted will be used. Unnecessary if no git repo is specified or the git repo is public.

docker_commandstr, optional

The command to run on the container. Will be run via sh as: [“sh”, “-c”, dockerCommand]. Defaults to the Docker image’s ENTRYPOINT/CMD.

docker_image_namestr, optional

The name of the docker image to pull from DockerHub.

docker_image_tagstr, optional

The tag of the docker image to pull from DockerHub.

instance_typestr, optional

The EC2 instance type to deploy to. Only available for jobs running on kubernetes.

cancel_timeoutint, optional

The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.

time_zonestr, optional

The time zone of this script.

partition_labelstr, optional

The partition label used to run this object.

target_project_idint, optional

Target project to which script outputs will be added.

running_as_idint, optional

The ID of the runner of this script.

Returns:

civis.Response

• idint

  The ID for the script.

• from_template_aliasesList[civis.Response]

  An array of the aliases of the template script.

  • idint

    The id of the Alias object.

  • object_idint

    The id of the object

  • aliasstr

    The alias of the object

• namestr

  The name of the container.

• typestr

  The type of the script (e.g Container)

• created_atstr (time)

  The time this script was created.

• updated_atstr (time)

  The time the script was last updated.

• authorcivis.Response

  • idint

    The ID of this user.

  • namestr

    This user’s name.

  • usernamestr

    This user’s username.

  • initialsstr

    This user’s initials.

  • onlinebool

    Whether this user is online.

• statestr

  The status of the script’s last run.

• finished_atstr (time)

  The time that the script’s last run finished.

• categorystr

  The category of the script.

• projectsList[civis.Response]

  A list of projects containing the script.

  • idint

    The ID for the project.

  • namestr

    The name of the project.

• parent_idint

  The ID of the parent job that will trigger this script

• user_contextstr

  “runner” or “author”, who to execute the script as when run as a template.

• paramsList[civis.Response]

  A definition of the parameters this script accepts in the arguments field.

  • namestr

    The variable’s name as used within your code.

  • labelstr

    The label to present to users when asking them for the value.

  • descriptionstr

    A short sentence or fragment describing this parameter to the end user.

  • typestr

    The type of parameter. Valid options: string, multi_line_string, integer, float, bool, file, table, database, credential_aws, credential_redshift, or credential_custom

  • requiredbool

    Whether this param is required.

  • valueobject

    The value you would like to set this param to. Setting this value makes this parameter a fixed param.

  • defaultstr

    If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool’s or false, False, f, n, no, or 0 for false bool’s. Cannot be used for parameters that are required or a credential type.

  • allowed_valuesList[civis.Response]

    The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: {label: ‘Import’, ‘value’: ‘import’}

• argumentscivis.Response

  Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.

• is_templatebool

  Whether others scripts use this one as a template.

• template_dependents_countint

  How many other scripts use this one as a template.

• published_as_template_idint

  The ID of the template that this script is backing.

• from_template_idint

  The ID of the template script.

• template_script_namestr

  The name of the template script.

• linkscivis.Response

  • detailsstr

    The details link to get more information about the script.

  • runsstr

    The runs link to get the run information list for this script.

• schedulecivis.Response

  • scheduledbool

    If the item is scheduled.

  • scheduled_daysList[int]

    Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth

  • scheduled_hoursList[int]

    Hours of the day it is scheduled on.

  • scheduled_minutesList[int]

    Minutes of the day it is scheduled on.

  • scheduled_runs_per_hourint

    Deprecated in favor of scheduled minutes.

  • scheduled_days_of_monthList[int]

    Days of the month it is scheduled on, mutually exclusive with scheduledDays.

• notificationscivis.Response

  • urlsList[str]

    URLs to receive a POST request at job completion

  • success_email_subjectstr

    Custom subject line for success e-mail.

  • success_email_bodystr

    Custom body text for success e-mail, written in Markdown.

  • success_email_addressesList[str]

    Addresses to notify by e-mail when the job completes successfully.

  • success_email_from_namestr

    Name from which success emails are sent; defaults to “Civis.”

  • success_email_reply_tostr

    Address for replies to success emails; defaults to the author of the job.

  • failure_email_addressesList[str]

    Addresses to notify by e-mail when the job fails.

  • stall_warning_minutesint

    Stall warning emails will be sent after this amount of minutes.

  • success_onbool

    If success email notifications are on. Defaults to user’s preferences.

  • failure_onbool

    If failure email notifications are on. Defaults to user’s preferences.

• running_ascivis.Response

  • idint

    The ID of this user.

  • namestr

    This user’s name.

  • usernamestr

    This user’s username.

  • initialsstr

    This user’s initials.

  • onlinebool

    Whether this user is online.

• required_resourcescivis.Response

  • cpuint

    The number of CPU shares to allocate for the container. Each core has 1000 shares. Must be at least 2 shares.

  • memoryint

    The amount of RAM to allocate for the container (in MB). Must be at least 4 MB.

  • disk_spacefloat (float)

    The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported.

• repo_http_uristr

  The location of a github repo to clone into the container, e.g. github.com/my-user/my-repo.git.

• repo_refstr

  The tag or branch of the github repo to clone into the container.

• remote_host_credential_idint

  The id of the database credentials to pass into the environment of the container.

• git_credential_idint

  The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you’ve submitted will be used. Unnecessary if no git repo is specified or the git repo is public.

• docker_commandstr

  The command to run on the container. Will be run via sh as: [“sh”, “-c”, dockerCommand]. Defaults to the Docker image’s ENTRYPOINT/CMD.

• docker_image_namestr

  The name of the docker image to pull from DockerHub.

• docker_image_tagstr

  The tag of the docker image to pull from DockerHub.

• instance_typestr

  The EC2 instance type to deploy to. Only available for jobs running on kubernetes.

• cancel_timeoutint

  The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.

• last_runcivis.Response

  • id : int

  • statestr

    The state of the run. One of queued, running, succeeded, failed or cancelled.

  • created_atstr (time)

    The time that the run was queued.

  • started_atstr (time)

    The time that the run started.

  • finished_atstr (time)

    The time that the run completed.

  • errorstr

    The error message for this run, if present.

• time_zonestr

  The time zone of this script.

• partition_labelstr

  The partition label used to run this object.

• my_permission_levelstr

  Your permission level on the object. One of “read”, “write”, or “manage”.

• hiddenbool

  The hidden status of the item.

• archivedbool

  The archival status of the requested item(s).

• target_project_idint

  Target project to which script outputs will be added.

• running_as_idint

  The ID of the runner of this script.