Batch / Paginator / ListJobsByConsumableResource

ListJobsByConsumableResource

class Batch.Paginator.ListJobsByConsumableResource

paginator = client.get_paginator('list_jobs_by_consumable_resource')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Batch.Client.list_jobs_by_consumable_resource().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    consumableResource='string',
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• consumableResource (string) –

  [REQUIRED]

  The name or ARN of the consumable resource.

• filters (list) –

  The filters to apply to the job list query. If used, only those jobs requiring the specified consumable resource ( consumableResource) and that match the value of the filters are listed. The filter names and values can be:

  • name: JOB_STATUS values: SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED

  • name: JOB_NAME The values are case-insensitive matches for the job name. If a filter value ends with an asterisk (*), it matches any job name that begins with the string before the ‘*’.

  • (dict) –

    A filter name and value pair that’s used to return a more specific list of results from a ListJobs or ListJobsByConsumableResource API operation.

    • name (string) –

      The name of the filter. Filter names are case sensitive.

    • values (list) –

      The filter values.

      • (string) –

• 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

{
    'jobs': [
        {
            'jobArn': 'string',
            'jobQueueArn': 'string',
            'jobName': 'string',
            'jobDefinitionArn': 'string',
            'shareIdentifier': 'string',
            'jobStatus': 'string',
            'quantity': 123,
            'statusReason': 'string',
            'startedAt': 123,
            'createdAt': 123,
            'consumableResourceProperties': {
                'consumableResourceList': [
                    {
                        'consumableResource': 'string',
                        'quantity': 123
                    },
                ]
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • jobs (list) –

    The list of jobs that require the specified consumable resources.

    • (dict) –

      Current information about a consumable resource required by a job.

      • jobArn (string) –

        The Amazon Resource Name (ARN) of the job.

      • jobQueueArn (string) –

        The Amazon Resource Name (ARN) of the job queue.

      • jobName (string) –

        The name of the job.

      • jobDefinitionArn (string) –

        The Amazon Resource Name (ARN) of the job definition.

      • shareIdentifier (string) –

        The fair-share scheduling policy identifier for the job.

      • jobStatus (string) –

        The status of the job. Can be one of:

        • SUBMITTED

        • PENDING

        • RUNNABLE

        • STARTING

        • RUNNING

        • SUCCEEDED

        • FAILED

      • quantity (integer) –

        The total amount of the consumable resource that is available.

      • statusReason (string) –

        A short, human-readable string to provide more details for the current status of the job.

      • startedAt (integer) –

        The Unix timestamp for when the job was started. More specifically, it’s when the job transitioned from the STARTING state to the RUNNING state.

      • createdAt (integer) –

        The Unix timestamp (in milliseconds) for when the consumable resource was created.

      • consumableResourceProperties (dict) –

        Contains a list of consumable resources required by the job.

        • consumableResourceList (list) –

          The list of consumable resources required by a job.

          • (dict) –

            Information about a consumable resource required to run a job.

            • consumableResource (string) –

              The name or ARN of the consumable resource.

            • quantity (integer) –

              The quantity of the consumable resource that is needed.

  • NextToken (string) –

    A token to resume pagination.