Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateSourceControlFromJob

Synchronizes a job to the source control repository. This operation takes the job artifacts from the AWS Glue internal stores and makes a commit to the remote repository that is configured on the job.

This API supports optional parameters which take in the repository information.

Request Syntax


{
   "AuthStrategy": "string",
   "AuthToken": "string",
   "BranchName": "string",
   "CommitId": "string",
   "Folder": "string",
   "JobName": "string",
   "Provider": "string",
   "RepositoryName": "string",
   "RepositoryOwner": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AuthStrategy

The type of authentication, which can be an authentication token stored in AWS Secrets Manager, or a personal access token.

Type: String

Valid Values: PERSONAL_ACCESS_TOKEN | AWS_SECRETS_MANAGER

Required: No

AuthToken

The value of the authorization token.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: No

BranchName

An optional branch in the remote repository.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: No

CommitId

A commit ID for a commit in the remote repository.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 40.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: No

Folder

An optional folder in the remote repository.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: No

JobName

The name of the AWS Glue job to be synchronized to or from the remote repository.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: No

Provider

The provider for the remote repository. Possible values: GITHUB, AWS_CODE_COMMIT, GITLAB, BITBUCKET.

Type: String

Valid Values: GITHUB | GITLAB | BITBUCKET | AWS_CODE_COMMIT

Required: No

RepositoryName

The name of the remote repository that contains the job artifacts. For BitBucket providers, RepositoryName should include WorkspaceName. Use the format <WorkspaceName>/<RepositoryName>.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: No

RepositoryOwner

The owner of the remote repository that contains the job artifacts.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: No

Response Syntax


{
   "JobName": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

JobName

The name of the AWS Glue job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access to a resource was denied.

Message: A message describing the problem.

HTTP Status Code: 400

AlreadyExistsException

A resource to be created or added already exists.

Message: A message describing the problem.

HTTP Status Code: 400

EntityNotFoundException

A specified entity does not exist

FromFederationSource: Indicates whether or not the exception relates to a federated source.
Message: A message describing the problem.

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

Message: A message describing the problem.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

FromFederationSource: Indicates whether or not the exception relates to a federated source.
Message: A message describing the problem.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

Message: A message describing the problem.

HTTP Status Code: 400

ValidationException

A value could not be validated.

Message: A message describing the problem.

HTTP Status Code: 400