list_backend_jobs

AmplifyBackend.Client.list_backend_jobs(**kwargs)

Lists the jobs for the backend of an Amplify app.

See also: AWS API Documentation

Request Syntax

response = client.list_backend_jobs(
    AppId='string',
    BackendEnvironmentName='string',
    JobId='string',
    MaxResults=123,
    NextToken='string',
    Operation='string',
    Status='string'
)

Parameters

• AppId (string) --

  [REQUIRED]

  The app ID.

• BackendEnvironmentName (string) --

  [REQUIRED]

  The name of the backend environment.

• JobId (string) -- The ID for the job.
• MaxResults (integer) -- The maximum number of results that you want in the response.
• NextToken (string) -- The token for the next set of results.
• 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.

Return type

dict

Returns

Response Syntax

{
    'Jobs': [
        {
            'AppId': 'string',
            'BackendEnvironmentName': 'string',
            'CreateTime': 'string',
            'Error': 'string',
            'JobId': 'string',
            'Operation': 'string',
            'Status': 'string',
            'UpdateTime': 'string'
        },
    ],
    'NextToken': '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.

  • NextToken (string) --

    The token for the next set of results.

Exceptions

• AmplifyBackend.Client.exceptions.NotFoundException
• AmplifyBackend.Client.exceptions.GatewayTimeoutException
• AmplifyBackend.Client.exceptions.TooManyRequestsException
• AmplifyBackend.Client.exceptions.BadRequestException