Backend appId Job backendEnvironmentName jobId - AWS Amplify Admin UI

Backend appId Job backendEnvironmentName jobId

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

This resource is associated with the GetBackendJob and the UpdateBackendJob operations.

URI

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

HTTP methods

GET

Operation ID: GetBackendJob

Returns information about a specific job.

Path parameters
Name Type Required Description
appId String True

The app ID.

backendEnvironmentName String True

The name of the backend environment.

jobId String True

The ID for the job.

Responses
Status code Response model Description
200 BackendJobRespObj

200 response

400 BadRequestException

400 response

404 NotFoundException

404 response

429 LimitExceededException

429 response

504 InternalServiceException

504 response

POST

Operation ID: UpdateBackendJob

Updates a specific job.

Path parameters
Name Type Required Description
appId String True

The app ID.

backendEnvironmentName String True

The name of the backend environment.

jobId String True

The ID for the job.

Responses
Status code Response model Description
200 BackendJobRespObj

200 response

400 BadRequestException

400 response

404 NotFoundException

404 response

429 LimitExceededException

429 response

504 InternalServiceException

504 response

OPTIONS

Enables CORS by returning the correct headers.

Path parameters
Name Type Required Description
appId String True

The app ID.

backendEnvironmentName String True

The name of the backend environment.

jobId String True

The ID for the job.

Responses
Status code Response model Description
200 None

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.

Property Type Required Description
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.

Property Type Required Description
jobId

string

False

The ID for the job.

createTime

string

False

The time when the job was created.

appId

string

True

The app ID.

updateTime

string

False

The time when the job was last updated.

error

string

False

If the request failed, this is the returned error.

operation

string

False

The name of the operation.

backendEnvironmentName

string

True

The name of the backend environment.

status

string

False

The current status of the request.

BadRequestException

An error returned if a request is not formed properly.

Property Type Required Description
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.

Property Type Required Description
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 is exceeded.

Property Type Required Description
message

string

False

An error message to inform that the request failed.

limitType

string

False

The type of limit that was exceeded.

NotFoundException

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

Property Type Required Description
message

string

False

An error message to inform that the request failed.

resourceType

string

False

The type of resource that wasn't 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