GlueDataBrew / Paginator / ListSchedules

ListSchedules#

class GlueDataBrew.Paginator.ListSchedules#
paginator = client.get_paginator('list_schedules')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from GlueDataBrew.Client.list_schedules().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    JobName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • JobName (string) – The name of the job that these schedules apply to.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Schedules': [
        {
            'AccountId': 'string',
            'CreatedBy': 'string',
            'CreateDate': datetime(2015, 1, 1),
            'JobNames': [
                'string',
            ],
            'LastModifiedBy': 'string',
            'LastModifiedDate': datetime(2015, 1, 1),
            'ResourceArn': 'string',
            'CronExpression': 'string',
            'Tags': {
                'string': 'string'
            },
            'Name': 'string'
        },
    ],

}

Response Structure

  • (dict) –

    • Schedules (list) –

      A list of schedules that are defined.

      • (dict) –

        Represents one or more dates and times when a job is to run.

        • AccountId (string) –

          The ID of the Amazon Web Services account that owns the schedule.

        • CreatedBy (string) –

          The Amazon Resource Name (ARN) of the user who created the schedule.

        • CreateDate (datetime) –

          The date and time that the schedule was created.

        • JobNames (list) –

          A list of jobs to be run, according to the schedule.

          • (string) –

        • LastModifiedBy (string) –

          The Amazon Resource Name (ARN) of the user who last modified the schedule.

        • LastModifiedDate (datetime) –

          The date and time when the schedule was last modified.

        • ResourceArn (string) –

          The Amazon Resource Name (ARN) of the schedule.

        • CronExpression (string) –

          The dates and times when the job is to run. For more information, see Cron expressions in the Glue DataBrew Developer Guide.

        • Tags (dict) –

          Metadata tags that have been applied to the schedule.

          • (string) –

            • (string) –

        • Name (string) –

          The name of the schedule.