AWS Glue

2019/01/18 - AWS Glue - 7 updated api methods

Changes  Update glue client to latest version

CreateJob (updated) Link ¶
Changes (request)
{'MaxCapacity': 'double'}

Creates a new job definition.

See also: AWS API Documentation

Request Syntax

client.create_job(
    Name='string',
    Description='string',
    LogUri='string',
    Role='string',
    ExecutionProperty={
        'MaxConcurrentRuns': 123
    },
    Command={
        'Name': 'string',
        'ScriptLocation': 'string'
    },
    DefaultArguments={
        'string': 'string'
    },
    Connections={
        'Connections': [
            'string',
        ]
    },
    MaxRetries=123,
    AllocatedCapacity=123,
    Timeout=123,
    MaxCapacity=123.0,
    NotificationProperty={
        'NotifyDelayAfter': 123
    },
    SecurityConfiguration='string'
)
type Name

string

param Name

[REQUIRED]

The name you assign to this job definition. It must be unique in your account.

type Description

string

param Description

Description of the job being defined.

type LogUri

string

param LogUri

This field is reserved for future use.

type Role

string

param Role

[REQUIRED]

The name or ARN of the IAM role associated with this job.

type ExecutionProperty

dict

param ExecutionProperty

An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

  • MaxConcurrentRuns (integer) --

    The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.

type Command

dict

param Command

[REQUIRED]

The JobCommand that executes this job.

  • Name (string) --

    The name of the job command: this must be glueetl , for an Apache Spark ETL job, or pythonshell , for a Python shell job.

  • ScriptLocation (string) --

    Specifies the S3 path to a script that executes a job (required).

type DefaultArguments

dict

param DefaultArguments

The default arguments for this job.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

  • (string) --

    • (string) --

type Connections

dict

param Connections

The connections used for this job.

  • Connections (list) --

    A list of connections used by the job.

    • (string) --

type MaxRetries

integer

param MaxRetries

The maximum number of times to retry this job if it fails.

type AllocatedCapacity

integer

param AllocatedCapacity

This parameter is deprecated. Use MaxCapacity instead.

The number of AWS Glue data processing units (DPUs) to allocate to this Job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

type Timeout

integer

param Timeout

The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

type MaxCapacity

float

param MaxCapacity

AWS Glue supports running jobs on a JobCommand.Name ="pythonshell" with allocated processing as low as 0.0625 DPU, which can be specified using MaxCapacity . Glue ETL jobs running in any other way cannot have fractional DPU allocations.

type NotificationProperty

dict

param NotificationProperty

Specifies configuration properties of a job notification.

  • NotifyDelayAfter (integer) --

    After a job run starts, the number of minutes to wait before sending a job run delay notification.

type SecurityConfiguration

string

param SecurityConfiguration

The name of the SecurityConfiguration structure to be used with this job.

rtype

dict

returns

Response Syntax

{
    'Name': 'string'
}

Response Structure

  • (dict) --

    • Name (string) --

      The unique name that was provided for this job definition.

GetJob (updated) Link ¶
Changes (response)
{'Job': {'MaxCapacity': 'double'}}

Retrieves an existing job definition.

See also: AWS API Documentation

Request Syntax

client.get_job(
    JobName='string'
)
type JobName

string

param JobName

[REQUIRED]

The name of the job definition to retrieve.

rtype

dict

returns

Response Syntax

{
    'Job': {
        'Name': 'string',
        'Description': 'string',
        'LogUri': 'string',
        'Role': 'string',
        'CreatedOn': datetime(2015, 1, 1),
        'LastModifiedOn': datetime(2015, 1, 1),
        'ExecutionProperty': {
            'MaxConcurrentRuns': 123
        },
        'Command': {
            'Name': 'string',
            'ScriptLocation': 'string'
        },
        'DefaultArguments': {
            'string': 'string'
        },
        'Connections': {
            'Connections': [
                'string',
            ]
        },
        'MaxRetries': 123,
        'AllocatedCapacity': 123,
        'Timeout': 123,
        'MaxCapacity': 123.0,
        'NotificationProperty': {
            'NotifyDelayAfter': 123
        },
        'SecurityConfiguration': 'string'
    }
}

Response Structure

  • (dict) --

    • Job (dict) --

      The requested job definition.

      • Name (string) --

        The name you assign to this job definition.

      • Description (string) --

        Description of the job being defined.

      • LogUri (string) --

        This field is reserved for future use.

      • Role (string) --

        The name or ARN of the IAM role associated with this job.

      • CreatedOn (datetime) --

        The time and date that this job definition was created.

      • LastModifiedOn (datetime) --

        The last point in time when this job definition was modified.

      • ExecutionProperty (dict) --

        An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

        • MaxConcurrentRuns (integer) --

          The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.

      • Command (dict) --

        The JobCommand that executes this job.

        • Name (string) --

          The name of the job command: this must be glueetl , for an Apache Spark ETL job, or pythonshell , for a Python shell job.

        • ScriptLocation (string) --

          Specifies the S3 path to a script that executes a job (required).

      • DefaultArguments (dict) --

        The default arguments for this job, specified as name-value pairs.

        You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

        For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

        For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

        • (string) --

          • (string) --

      • Connections (dict) --

        The connections used for this job.

        • Connections (list) --

          A list of connections used by the job.

          • (string) --

      • MaxRetries (integer) --

        The maximum number of times to retry this job after a JobRun fails.

      • AllocatedCapacity (integer) --

        This field is deprecated, use MaxCapacity instead.

        The number of AWS Glue data processing units (DPUs) allocated to runs of this job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

      • Timeout (integer) --

        The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

      • MaxCapacity (float) --

        AWS Glue supports running jobs on a JobCommand.Name ="pythonshell" with allocated processing as low as 0.0625 DPU, which can be specified using MaxCapacity . Glue ETL jobs running in any other way cannot have fractional DPU allocations.

      • NotificationProperty (dict) --

        Specifies configuration properties of a job notification.

        • NotifyDelayAfter (integer) --

          After a job run starts, the number of minutes to wait before sending a job run delay notification.

      • SecurityConfiguration (string) --

        The name of the SecurityConfiguration structure to be used with this job.

GetJobRun (updated) Link ¶
Changes (response)
{'JobRun': {'MaxCapacity': 'double'}}

Retrieves the metadata for a given job run.

See also: AWS API Documentation

Request Syntax

client.get_job_run(
    JobName='string',
    RunId='string',
    PredecessorsIncluded=True|False
)
type JobName

string

param JobName

[REQUIRED]

Name of the job definition being run.

type RunId

string

param RunId

[REQUIRED]

The ID of the job run.

type PredecessorsIncluded

boolean

param PredecessorsIncluded

True if a list of predecessor runs should be returned.

rtype

dict

returns

Response Syntax

{
    'JobRun': {
        'Id': 'string',
        'Attempt': 123,
        'PreviousRunId': 'string',
        'TriggerName': 'string',
        'JobName': 'string',
        'StartedOn': datetime(2015, 1, 1),
        'LastModifiedOn': datetime(2015, 1, 1),
        'CompletedOn': datetime(2015, 1, 1),
        'JobRunState': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
        'Arguments': {
            'string': 'string'
        },
        'ErrorMessage': 'string',
        'PredecessorRuns': [
            {
                'JobName': 'string',
                'RunId': 'string'
            },
        ],
        'AllocatedCapacity': 123,
        'ExecutionTime': 123,
        'Timeout': 123,
        'MaxCapacity': 123.0,
        'NotificationProperty': {
            'NotifyDelayAfter': 123
        },
        'SecurityConfiguration': 'string',
        'LogGroupName': 'string'
    }
}

Response Structure

  • (dict) --

    • JobRun (dict) --

      The requested job-run metadata.

      • Id (string) --

        The ID of this job run.

      • Attempt (integer) --

        The number of the attempt to run this job.

      • PreviousRunId (string) --

        The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.

      • TriggerName (string) --

        The name of the trigger that started this job run.

      • JobName (string) --

        The name of the job definition being used in this run.

      • StartedOn (datetime) --

        The date and time at which this job run was started.

      • LastModifiedOn (datetime) --

        The last time this job run was modified.

      • CompletedOn (datetime) --

        The date and time this job run completed.

      • JobRunState (string) --

        The current state of the job run.

      • Arguments (dict) --

        The job arguments associated with this run. These override equivalent default arguments set for the job.

        You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

        For information about how to specify and consume your own job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

        For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

        • (string) --

          • (string) --

      • ErrorMessage (string) --

        An error message associated with this job run.

      • PredecessorRuns (list) --

        A list of predecessors to this job run.

        • (dict) --

          A job run that was used in the predicate of a conditional trigger that triggered this job run.

          • JobName (string) --

            The name of the job definition used by the predecessor job run.

          • RunId (string) --

            The job-run ID of the predecessor job run.

      • AllocatedCapacity (integer) --

        This field is deprecated, use MaxCapacity instead.

        The number of AWS Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

      • ExecutionTime (integer) --

        The amount of time (in seconds) that the job run consumed resources.

      • Timeout (integer) --

        The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

      • MaxCapacity (float) --

        AWS Glue supports running jobs on a JobCommand.Name ="pythonshell" with allocated processing as low as 0.0625 DPU, which can be specified using MaxCapacity . Glue ETL jobs running in any other way cannot have fractional DPU allocations.

      • NotificationProperty (dict) --

        Specifies configuration properties of a job run notification.

        • NotifyDelayAfter (integer) --

          After a job run starts, the number of minutes to wait before sending a job run delay notification.

      • SecurityConfiguration (string) --

        The name of the SecurityConfiguration structure to be used with this job run.

      • LogGroupName (string) --

        The name of the log group for secure logging, that can be server-side encrypted in CloudWatch using KMS. This name can be /aws-glue/jobs/ , in which case the default encryption is NONE . If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/ ), then that security configuration will be used to encrypt the log group.

GetJobRuns (updated) Link ¶
Changes (response)
{'JobRuns': {'MaxCapacity': 'double'}}

Retrieves metadata for all runs of a given job definition.

See also: AWS API Documentation

Request Syntax

client.get_job_runs(
    JobName='string',
    NextToken='string',
    MaxResults=123
)
type JobName

string

param JobName

[REQUIRED]

The name of the job definition for which to retrieve all job runs.

type NextToken

string

param NextToken

A continuation token, if this is a continuation call.

type MaxResults

integer

param MaxResults

The maximum size of the response.

rtype

dict

returns

Response Syntax

{
    'JobRuns': [
        {
            'Id': 'string',
            'Attempt': 123,
            'PreviousRunId': 'string',
            'TriggerName': 'string',
            'JobName': 'string',
            'StartedOn': datetime(2015, 1, 1),
            'LastModifiedOn': datetime(2015, 1, 1),
            'CompletedOn': datetime(2015, 1, 1),
            'JobRunState': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
            'Arguments': {
                'string': 'string'
            },
            'ErrorMessage': 'string',
            'PredecessorRuns': [
                {
                    'JobName': 'string',
                    'RunId': 'string'
                },
            ],
            'AllocatedCapacity': 123,
            'ExecutionTime': 123,
            'Timeout': 123,
            'MaxCapacity': 123.0,
            'NotificationProperty': {
                'NotifyDelayAfter': 123
            },
            'SecurityConfiguration': 'string',
            'LogGroupName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • JobRuns (list) --

      A list of job-run metatdata objects.

      • (dict) --

        Contains information about a job run.

        • Id (string) --

          The ID of this job run.

        • Attempt (integer) --

          The number of the attempt to run this job.

        • PreviousRunId (string) --

          The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.

        • TriggerName (string) --

          The name of the trigger that started this job run.

        • JobName (string) --

          The name of the job definition being used in this run.

        • StartedOn (datetime) --

          The date and time at which this job run was started.

        • LastModifiedOn (datetime) --

          The last time this job run was modified.

        • CompletedOn (datetime) --

          The date and time this job run completed.

        • JobRunState (string) --

          The current state of the job run.

        • Arguments (dict) --

          The job arguments associated with this run. These override equivalent default arguments set for the job.

          You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

          For information about how to specify and consume your own job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

          For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

          • (string) --

            • (string) --

        • ErrorMessage (string) --

          An error message associated with this job run.

        • PredecessorRuns (list) --

          A list of predecessors to this job run.

          • (dict) --

            A job run that was used in the predicate of a conditional trigger that triggered this job run.

            • JobName (string) --

              The name of the job definition used by the predecessor job run.

            • RunId (string) --

              The job-run ID of the predecessor job run.

        • AllocatedCapacity (integer) --

          This field is deprecated, use MaxCapacity instead.

          The number of AWS Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

        • ExecutionTime (integer) --

          The amount of time (in seconds) that the job run consumed resources.

        • Timeout (integer) --

          The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

        • MaxCapacity (float) --

          AWS Glue supports running jobs on a JobCommand.Name ="pythonshell" with allocated processing as low as 0.0625 DPU, which can be specified using MaxCapacity . Glue ETL jobs running in any other way cannot have fractional DPU allocations.

        • NotificationProperty (dict) --

          Specifies configuration properties of a job run notification.

          • NotifyDelayAfter (integer) --

            After a job run starts, the number of minutes to wait before sending a job run delay notification.

        • SecurityConfiguration (string) --

          The name of the SecurityConfiguration structure to be used with this job run.

        • LogGroupName (string) --

          The name of the log group for secure logging, that can be server-side encrypted in CloudWatch using KMS. This name can be /aws-glue/jobs/ , in which case the default encryption is NONE . If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/ ), then that security configuration will be used to encrypt the log group.

    • NextToken (string) --

      A continuation token, if not all reequested job runs have been returned.

GetJobs (updated) Link ¶
Changes (response)
{'Jobs': {'MaxCapacity': 'double'}}

Retrieves all current job definitions.

See also: AWS API Documentation

Request Syntax

client.get_jobs(
    NextToken='string',
    MaxResults=123
)
type NextToken

string

param NextToken

A continuation token, if this is a continuation call.

type MaxResults

integer

param MaxResults

The maximum size of the response.

rtype

dict

returns

Response Syntax

{
    'Jobs': [
        {
            'Name': 'string',
            'Description': 'string',
            'LogUri': 'string',
            'Role': 'string',
            'CreatedOn': datetime(2015, 1, 1),
            'LastModifiedOn': datetime(2015, 1, 1),
            'ExecutionProperty': {
                'MaxConcurrentRuns': 123
            },
            'Command': {
                'Name': 'string',
                'ScriptLocation': 'string'
            },
            'DefaultArguments': {
                'string': 'string'
            },
            'Connections': {
                'Connections': [
                    'string',
                ]
            },
            'MaxRetries': 123,
            'AllocatedCapacity': 123,
            'Timeout': 123,
            'MaxCapacity': 123.0,
            'NotificationProperty': {
                'NotifyDelayAfter': 123
            },
            'SecurityConfiguration': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Jobs (list) --

      A list of job definitions.

      • (dict) --

        Specifies a job definition.

        • Name (string) --

          The name you assign to this job definition.

        • Description (string) --

          Description of the job being defined.

        • LogUri (string) --

          This field is reserved for future use.

        • Role (string) --

          The name or ARN of the IAM role associated with this job.

        • CreatedOn (datetime) --

          The time and date that this job definition was created.

        • LastModifiedOn (datetime) --

          The last point in time when this job definition was modified.

        • ExecutionProperty (dict) --

          An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

          • MaxConcurrentRuns (integer) --

            The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.

        • Command (dict) --

          The JobCommand that executes this job.

          • Name (string) --

            The name of the job command: this must be glueetl , for an Apache Spark ETL job, or pythonshell , for a Python shell job.

          • ScriptLocation (string) --

            Specifies the S3 path to a script that executes a job (required).

        • DefaultArguments (dict) --

          The default arguments for this job, specified as name-value pairs.

          You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

          For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

          For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

          • (string) --

            • (string) --

        • Connections (dict) --

          The connections used for this job.

          • Connections (list) --

            A list of connections used by the job.

            • (string) --

        • MaxRetries (integer) --

          The maximum number of times to retry this job after a JobRun fails.

        • AllocatedCapacity (integer) --

          This field is deprecated, use MaxCapacity instead.

          The number of AWS Glue data processing units (DPUs) allocated to runs of this job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

        • Timeout (integer) --

          The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

        • MaxCapacity (float) --

          AWS Glue supports running jobs on a JobCommand.Name ="pythonshell" with allocated processing as low as 0.0625 DPU, which can be specified using MaxCapacity . Glue ETL jobs running in any other way cannot have fractional DPU allocations.

        • NotificationProperty (dict) --

          Specifies configuration properties of a job notification.

          • NotifyDelayAfter (integer) --

            After a job run starts, the number of minutes to wait before sending a job run delay notification.

        • SecurityConfiguration (string) --

          The name of the SecurityConfiguration structure to be used with this job.

    • NextToken (string) --

      A continuation token, if not all job definitions have yet been returned.

StartJobRun (updated) Link ¶
Changes (request)
{'MaxCapacity': 'double'}

Starts a job run using a job definition.

See also: AWS API Documentation

Request Syntax

client.start_job_run(
    JobName='string',
    JobRunId='string',
    Arguments={
        'string': 'string'
    },
    AllocatedCapacity=123,
    Timeout=123,
    MaxCapacity=123.0,
    NotificationProperty={
        'NotifyDelayAfter': 123
    },
    SecurityConfiguration='string'
)
type JobName

string

param JobName

[REQUIRED]

The name of the job definition to use.

type JobRunId

string

param JobRunId

The ID of a previous JobRun to retry.

type Arguments

dict

param Arguments

The job arguments specifically for this run. They override the equivalent default arguments set for in the job definition itself.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

  • (string) --

    • (string) --

type AllocatedCapacity

integer

param AllocatedCapacity

This field is deprecated, use MaxCapacity instead.

The number of AWS Glue data processing units (DPUs) to allocate to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

type Timeout

integer

param Timeout

The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

type MaxCapacity

float

param MaxCapacity

AWS Glue supports running jobs on a JobCommand.Name ="pythonshell" with allocated processing as low as 0.0625 DPU, which can be specified using MaxCapacity . Glue ETL jobs running in any other way cannot have fractional DPU allocations.

type NotificationProperty

dict

param NotificationProperty

Specifies configuration properties of a job run notification.

  • NotifyDelayAfter (integer) --

    After a job run starts, the number of minutes to wait before sending a job run delay notification.

type SecurityConfiguration

string

param SecurityConfiguration

The name of the SecurityConfiguration structure to be used with this job run.

rtype

dict

returns

Response Syntax

{
    'JobRunId': 'string'
}

Response Structure

  • (dict) --

    • JobRunId (string) --

      The ID assigned to this job run.

UpdateJob (updated) Link ¶
Changes (request)
{'JobUpdate': {'MaxCapacity': 'double'}}

Updates an existing job definition.

See also: AWS API Documentation

Request Syntax

client.update_job(
    JobName='string',
    JobUpdate={
        'Description': 'string',
        'LogUri': 'string',
        'Role': 'string',
        'ExecutionProperty': {
            'MaxConcurrentRuns': 123
        },
        'Command': {
            'Name': 'string',
            'ScriptLocation': 'string'
        },
        'DefaultArguments': {
            'string': 'string'
        },
        'Connections': {
            'Connections': [
                'string',
            ]
        },
        'MaxRetries': 123,
        'AllocatedCapacity': 123,
        'Timeout': 123,
        'MaxCapacity': 123.0,
        'NotificationProperty': {
            'NotifyDelayAfter': 123
        },
        'SecurityConfiguration': 'string'
    }
)
type JobName

string

param JobName

[REQUIRED]

Name of the job definition to update.

type JobUpdate

dict

param JobUpdate

[REQUIRED]

Specifies the values with which to update the job definition.

  • Description (string) --

    Description of the job being defined.

  • LogUri (string) --

    This field is reserved for future use.

  • Role (string) --

    The name or ARN of the IAM role associated with this job (required).

  • ExecutionProperty (dict) --

    An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

    • MaxConcurrentRuns (integer) --

      The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.

  • Command (dict) --

    The JobCommand that executes this job (required).

    • Name (string) --

      The name of the job command: this must be glueetl , for an Apache Spark ETL job, or pythonshell , for a Python shell job.

    • ScriptLocation (string) --

      Specifies the S3 path to a script that executes a job (required).

  • DefaultArguments (dict) --

    The default arguments for this job.

    You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

    For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

    For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

    • (string) --

      • (string) --

  • Connections (dict) --

    The connections used for this job.

    • Connections (list) --

      A list of connections used by the job.

      • (string) --

  • MaxRetries (integer) --

    The maximum number of times to retry this job if it fails.

  • AllocatedCapacity (integer) --

    This field is deprecated. Use MaxCapacity instead.

    The number of AWS Glue data processing units (DPUs) to allocate to this Job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

  • Timeout (integer) --

    The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

  • MaxCapacity (float) --

    AWS Glue supports running jobs on a JobCommand.Name ="pythonshell" with allocated processing as low as 0.0625 DPU, which can be specified using MaxCapacity . Glue ETL jobs running in any other way cannot have fractional DPU allocations.

  • NotificationProperty (dict) --

    Specifies configuration properties of a job notification.

    • NotifyDelayAfter (integer) --

      After a job run starts, the number of minutes to wait before sending a job run delay notification.

  • SecurityConfiguration (string) --

    The name of the SecurityConfiguration structure to be used with this job.

rtype

dict

returns

Response Syntax

{
    'JobName': 'string'
}

Response Structure

  • (dict) --

    • JobName (string) --

      Returns the name of the updated job definition.