get_backend_job

AmplifyBackend.Client.get_backend_job(**kwargs)

Returns information about a specific job.

See also: AWS API Documentation

Request Syntax

response = client.get_backend_job(
    AppId='string',
    BackendEnvironmentName='string',
    JobId='string'
)
Parameters
  • AppId (string) --

    [REQUIRED]

    The app ID.

  • BackendEnvironmentName (string) --

    [REQUIRED]

    The name of the backend environment.

  • JobId (string) --

    [REQUIRED]

    The ID for the job.

Return type

dict

Returns

Response Syntax

{
    'AppId': 'string',
    'BackendEnvironmentName': 'string',
    'CreateTime': 'string',
    'Error': 'string',
    'JobId': 'string',
    'Operation': 'string',
    'Status': 'string',
    'UpdateTime': 'string'
}

Response Structure

  • (dict) --

    200 response

    • 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.

Exceptions

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