ListBackendJobs

class AmplifyBackend.Paginator.ListBackendJobs
paginator = client.get_paginator('list_backend_jobs')
paginate(**kwargs)

Creates an iterator that will paginate through responses from AmplifyBackend.Client.list_backend_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AppId='string',
    BackendEnvironmentName='string',
    JobId='string',
    Operation='string',
    Status='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • AppId (string) --

    [REQUIRED]

    The app ID.

  • BackendEnvironmentName (string) --

    [REQUIRED]

    The name of the backend environment.

  • JobId (string) -- The ID for the job.
  • Operation (string) -- Filters the list of response objects to include only those with the specified operation name.
  • Status (string) -- Filters the list of response objects to include only those with the specified status.
  • 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': [
        {
            'AppId': 'string',
            'BackendEnvironmentName': 'string',
            'CreateTime': 'string',
            'Error': 'string',
            'JobId': 'string',
            'Operation': 'string',
            'Status': 'string',
            'UpdateTime': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    200 response

    • Jobs (list) --

      An array of jobs and their properties.

      • (dict) --

        The response object for this operation.

        • AppId (string) --

          The app ID.

        • BackendEnvironmentName (string) --

          The name of the backend environment.

        • CreateTime (string) --

          The time when the job was created.

        • Error (string) --

          If the request fails, this error is returned.

        • JobId (string) --

          The ID for the job.

        • Operation (string) --

          The name of the operation.

        • Status (string) --

          The current status of the request.

        • UpdateTime (string) --

          The time when the job was last updated.