AWS Glue

2019/07/26 - AWS Glue - 2 new 1 updated api methods

Changes  This release provides GetJobBookmark and GetJobBookmarks APIs. These APIs enable users to look at specific versions or all versions of the JobBookmark for a specific job. This release also enables resetting the job bookmark to a specific run via an enhancement of the ResetJobBookmark API.

GetJobBookmarks (new) Link ¶

Returns information on the job bookmark entries. The list is ordered on decreasing version numbers.

See also: AWS API Documentation

Request Syntax

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

string

param JobName

[REQUIRED]

The name of the job in question.

type MaxResults

integer

param MaxResults

The maximum size of the response.

type NextToken

integer

param NextToken

A continuation token, if this is a continuation call.

rtype

dict

returns

Response Syntax

{
    'JobBookmarkEntries': [
        {
            'JobName': 'string',
            'Version': 123,
            'Run': 123,
            'Attempt': 123,
            'PreviousRunId': 'string',
            'RunId': 'string',
            'JobBookmark': 'string'
        },
    ],
    'NextToken': 123
}

Response Structure

  • (dict) --

    • JobBookmarkEntries (list) --

      A list of job bookmark entries that defines a point that a job can resume processing.

      • (dict) --

        Defines a point that a job can resume processing.

        • JobName (string) --

          The name of the job in question.

        • Version (integer) --

          The version of the job.

        • Run (integer) --

          The run ID number.

        • Attempt (integer) --

          The attempt ID number.

        • PreviousRunId (string) --

          The unique run identifier associated with the previous job run..

        • RunId (string) --

          The unique run identifier associated with this job run.

        • JobBookmark (string) --

          The bookmark itself.

    • NextToken (integer) --

      A continuation token, which has a value of 1 if all the entries are returned, or > 1 if not all requested job runs have been returned.

GetJobBookmark (new) Link ¶

Returns information on a job bookmark entry.

See also: AWS API Documentation

Request Syntax

client.get_job_bookmark(
    JobName='string',
    RunId='string'
)
type JobName

string

param JobName

[REQUIRED]

The name of the job in question.

type RunId

string

param RunId

The unique run identifier associated with this job run.

rtype

dict

returns

Response Syntax

{
    'JobBookmarkEntry': {
        'JobName': 'string',
        'Version': 123,
        'Run': 123,
        'Attempt': 123,
        'PreviousRunId': 'string',
        'RunId': 'string',
        'JobBookmark': 'string'
    }
}

Response Structure

  • (dict) --

    • JobBookmarkEntry (dict) --

      A structure that defines a point that a job can resume processing.

      • JobName (string) --

        The name of the job in question.

      • Version (integer) --

        The version of the job.

      • Run (integer) --

        The run ID number.

      • Attempt (integer) --

        The attempt ID number.

      • PreviousRunId (string) --

        The unique run identifier associated with the previous job run..

      • RunId (string) --

        The unique run identifier associated with this job run.

      • JobBookmark (string) --

        The bookmark itself.

ResetJobBookmark (updated) Link ¶
Changes (request, response)
Request
{'RunId': 'string'}
Response
{'JobBookmarkEntry': {'PreviousRunId': 'string', 'RunId': 'string'}}

Resets a bookmark entry.

See also: AWS API Documentation

Request Syntax

client.reset_job_bookmark(
    JobName='string',
    RunId='string'
)
type JobName

string

param JobName

[REQUIRED]

The name of the job in question.

type RunId

string

param RunId

The unique run identifier associated with this job run.

rtype

dict

returns

Response Syntax

{
    'JobBookmarkEntry': {
        'JobName': 'string',
        'Version': 123,
        'Run': 123,
        'Attempt': 123,
        'PreviousRunId': 'string',
        'RunId': 'string',
        'JobBookmark': 'string'
    }
}

Response Structure

  • (dict) --

    • JobBookmarkEntry (dict) --

      The reset bookmark entry.

      • JobName (string) --

        The name of the job in question.

      • Version (integer) --

        The version of the job.

      • Run (integer) --

        The run ID number.

      • Attempt (integer) --

        The attempt ID number.

      • PreviousRunId (string) --

        The unique run identifier associated with the previous job run..

      • RunId (string) --

        The unique run identifier associated with this job run.

      • JobBookmark (string) --

        The bookmark itself.