Backend appId Job backendEnvironmentName jobId - Amplify Admin UI

Backend appId Job backendEnvironmentName jobId

Jobs perform backend API actions on your behalf based on your choices in the Amplify Admin UI. The actions that the jobs perform depend on the underlying API request sent from the Amplify Admin UI.

This resource is associated with the GetBackendJob and UpdateBackendJob operations.

URI

/prod/backend/appId/job/backendEnvironmentName/jobId

HTTP methods

GET

Operation ID: GetBackendJob

Returns information about a specific job.

Path parameters
NameTypeRequiredDescription
appIdStringTrue

The app ID.

backendEnvironmentNameStringTrue

The name of the backend environment.

jobIdStringTrue

The ID for the job.

Responses
Status codeResponse modelDescription
200BackendJobRespObj

200 response

400BadRequestException

400 response

404NotFoundException

404 response

429LimitExceededException

429 response

504InternalServiceException

504 response

POST

Operation ID: UpdateBackendJob

Updates a specific job.

Path parameters
NameTypeRequiredDescription
appIdStringTrue

The app ID.

backendEnvironmentNameStringTrue

The name of the backend environment.

jobIdStringTrue

The ID for the job.

Responses
Status codeResponse modelDescription
200BackendJobRespObj

200 response

400BadRequestException

400 response

404NotFoundException

404 response

429LimitExceededException

429 response

504InternalServiceException

504 response

OPTIONS

Enables CORS by returning the correct headers.

Path parameters
NameTypeRequiredDescription
appIdStringTrue

The app ID.

backendEnvironmentNameStringTrue

The name of the backend environment.

jobIdStringTrue

The ID for the job.

Responses
Status codeResponse modelDescription
200None

200 response

Schemas

Request bodies

{ "operation": "string", "status": "string" }

Response bodies

{ "jobId": "string", "createTime": "string", "appId": "string", "updateTime": "string", "error": "string", "operation": "string", "backendEnvironmentName": "string", "status": "string" }
{ "message": "string" }
{ "message": "string", "resourceType": "string" }
{ "message": "string", "limitType": "string" }
{ "message": "string" }

Properties

BackendJobReqObj

The request object for this operation.

PropertyTypeRequiredDescription
operation

string

False

Filters the list of response objects to include only those with the specified operation name.

status

string

False

Filters the list of response objects to include only those with the specified status.

BackendJobRespObj

The response object for this operation.

PropertyTypeRequiredDescription
appId

string

True

The app ID.

backendEnvironmentName

string

True

The name of the backend environment.

createTime

string

False

The time when the job was created.

error

string

False

If the request fails, this error is returned.

jobId

string

False

The ID for the job.

operation

string

False

The name of the operation.

status

string

False

The current status of the request.

updateTime

string

False

The time when the job was last updated.

BadRequestException

An error returned if a request is not formed properly.

PropertyTypeRequiredDescription
message

string

False

An error message to inform that the request failed.

InternalServiceException

An error returned if there's a temporary issue with the service.

PropertyTypeRequiredDescription
message

string

False

An error message to inform that the request failed.

LimitExceededException

An error that is returned when a limit of a specific type has been exceeded.

PropertyTypeRequiredDescription
limitType

string

False

The type of limit that was exceeded.

message

string

False

An error message to inform that the request has failed.

NotFoundException

An error returned when a specific resource type is not found.

PropertyTypeRequiredDescription
message

string

False

An error message to inform that the request has failed.

resourceType

string

False

The type of resource that is not found.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

GetBackendJob

UpdateBackendJob