get_job

Amplify.Client.get_job(**kwargs)

Returns a job for a branch of an Amplify app.

See also: AWS API Documentation

Request Syntax

response = client.get_job(
    appId='string',
    branchName='string',
    jobId='string'
)

Parameters

• appId (string) --

  [REQUIRED]

  The unique ID for an Amplify app.

• branchName (string) --

  [REQUIRED]

  The branch name for the job.

• jobId (string) --

  [REQUIRED]

  The unique ID for the job.

Return type

dict

Returns

Response Syntax

{
    'job': {
        'summary': {
            'jobArn': 'string',
            'jobId': 'string',
            'commitId': 'string',
            'commitMessage': 'string',
            'commitTime': datetime(2015, 1, 1),
            'startTime': datetime(2015, 1, 1),
            'status': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
            'endTime': datetime(2015, 1, 1),
            'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK'
        },
        'steps': [
            {
                'stepName': 'string',
                'startTime': datetime(2015, 1, 1),
                'status': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
                'endTime': datetime(2015, 1, 1),
                'logUrl': 'string',
                'artifactsUrl': 'string',
                'testArtifactsUrl': 'string',
                'testConfigUrl': 'string',
                'screenshots': {
                    'string': 'string'
                },
                'statusReason': 'string',
                'context': 'string'
            },
        ]
    }
}

Response Structure

• (dict) --

  • job (dict) --

    Describes an execution job for an Amplify app.

    • summary (dict) --

      Describes the summary for an execution job for an Amplify app.

      • jobArn (string) --

        The Amazon Resource Name (ARN) for the job.

      • jobId (string) --

        The unique ID for the job.

      • commitId (string) --

        The commit ID from a third-party repository provider for the job.

      • commitMessage (string) --

        The commit message from a third-party repository provider for the job.

      • commitTime (datetime) --

        The commit date and time for the job.

      • startTime (datetime) --

        The start date and time for the job.

      • status (string) --

        The current status for the job.

      • endTime (datetime) --

        The end date and time for the job.

      • jobType (string) --

        The type for the job. If the value is RELEASE , the job was manually released from its source by using the StartJob API. If the value is RETRY , the job was manually retried using the StartJob API. If the value is WEB_HOOK , the job was automatically triggered by webhooks.

    • steps (list) --

      The execution steps for an execution job, for an Amplify app.

      • (dict) --

        Describes an execution step, for an execution job, for an Amplify app.

        • stepName (string) --

          The name of the execution step.

        • startTime (datetime) --

          The start date and time of the execution step.

        • status (string) --

          The status of the execution step.

        • endTime (datetime) --

          The end date and time of the execution step.

        • logUrl (string) --

          The URL to the logs for the execution step.

        • artifactsUrl (string) --

          The URL to the artifact for the execution step.

        • testArtifactsUrl (string) --

          The URL to the test artifact for the execution step.

        • testConfigUrl (string) --

          The URL to the test configuration for the execution step.

        • screenshots (dict) --

          The list of screenshot URLs for the execution step, if relevant.

          • (string) --
            • (string) --

        • statusReason (string) --

          The reason for the current step status.

        • context (string) --

          The context for the current step. Includes a build image if the step is build.

Exceptions

• Amplify.Client.exceptions.BadRequestException
• Amplify.Client.exceptions.UnauthorizedException
• Amplify.Client.exceptions.InternalFailureException
• Amplify.Client.exceptions.NotFoundException
• Amplify.Client.exceptions.LimitExceededException