View Source aws_glue (aws v1.0.4)
Glue
Defines the public endpoint for the Glue service.Summary
Functions
Deletes multiple tables at once.
Returns a list of resource metadata for a given list of crawler names.
Returns a list of resource metadata for a given list of development endpoint names.
Returns a list of resource metadata for a given list of job names.
Returns a list of resource metadata for a given list of trigger names.
Returns a list of resource metadata for a given list of workflow names.
Cancels (stops) a task run.
Validates the supplied schema.
Creates a classifier in the user's account.
Creates a connection definition in the Data Catalog.
Creates a new crawler with specified targets, role, configuration, and optional schedule.
Creates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.
Creates a data quality ruleset with DQDL rules applied to a specified Glue table.
Creates an Glue machine learning transform.
Creates a new schema set and registers the schema definition.
Creates a new security configuration.
Creates a new table optimizer for a specific function.
Delete the partition column statistics of a column.
Retrieves table statistics of columns.
RUNNING.Removes a specified database from a Data Catalog.
Deletes a specified job definition.
Deletes an Glue machine learning transform.
Delete the entire registry including schema and all of its versions.
Deletes the entire schema set, including the schema set and all of its versions.
Remove versions from the specified schema.
Removes a table definition from the Data Catalog.
Deletes an optimizer and all associated metadata for a table.
Deletes a specified trigger.
Retrieves partition statistics of columns.
Retrieves table statistics of columns.
Retrieves information about a specified development endpoint.
Retrieves all the development endpoints in this Amazon Web Services account.
Returns information on a job bookmark entry.
Gets details for a specific task run on a machine learning transform.
Gets a list of runs for a machine learning transform.
Gets an Glue machine learning transform artifact and all its corresponding metadata.
Gets a sortable, filterable list of existing Glue machine learning transforms.
Retrieves the resource policies set on individual resources by Resource Access Manager during cross-account permission grants.
Retrieves a schema by the SchemaDefinition.
Get the specified schema by its unique ID assigned when a version of the schema is created or registered.
Fetches the schema version difference in the specified difference type between two stored schema versions in the Schema Registry.
Table definition in a Data Catalog for a specified table.Database.Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.
Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.
Retrieves table metadata from the Data Catalog that contains unfiltered metadata.
Retrieves the names of all crawler resources in this Amazon Web Services account, or the resources with the specified tag.
Returns all the crawls of a specified crawler.
Retrieves the names of all DevEndpoint resources in this Amazon Web Services account, or the resources with the specified tag.
Retrieves the names of all job resources in this Amazon Web Services account, or the resources with the specified tag.
Retrieves a sortable, filterable list of existing Glue machine learning transforms in this Amazon Web Services account, or the resources with the specified tag.
Returns a list of registries that you have created, with minimal registry information.
Returns a list of schema versions that you have created, with minimal information.
Returns a list of schemas with minimal details.
Retrieves the names of all trigger resources in this Amazon Web Services account, or the resources with the specified tag.
Sets the security configuration for a specified catalog.
Puts the metadata key value pair for a specified schema version ID.
Puts the specified workflow run properties for the given workflow run.
Adds a new version to the existing schema.
Resets a bookmark entry.
Restarts selected nodes of a previous partially completed workflow run and resumes the workflow run.
Searches a set of tables based on properties in the table metadata as well as on the parent database.
Starts a crawl using the specified crawler, regardless of what is scheduled.
SCHEDULED, unless the crawler is already running or the schedule state is already SCHEDULED.Starts a recommendation run that is used to generate rules when you don't know what rules to write.
Once you have a ruleset definition (either recommended or your own), you call this operation to evaluate the ruleset against a data source (Glue table).
Begins an asynchronous task to export all labeled data for a particular transform.
Enables you to provide additional labels (examples of truth) to be used to teach the machine learning transform and improve its quality.
Starts a task to estimate the quality of the transform.
Starts the active learning workflow for your machine learning transform to improve the transform's quality by generating label sets and adding labels.
Starts an existing trigger.
NOT_SCHEDULED, but does not stop the crawler if it is already running.Adds tags to a resource.
GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field is present).Creates or updates partition statistics of columns.
Creates or updates table statistics of columns.
Updates a crawler.
cron expression.Updates an existing job definition.
Synchronizes a job from the source control repository.
Updates an existing machine learning transform.
Updates an existing registry which is used to hold a collection of schemas.
Updates the description, compatibility setting, or version checkpoint for a schema set.
Synchronizes a job to the source control repository.
Functions
Deletes multiple tables at once.
After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources, before callingBatchDeleteTable, use DeleteTableVersion or BatchDeleteTableVersion, and DeletePartition or BatchDeletePartition, to delete any resources that belong to the table.
Returns a list of resource metadata for a given list of crawler names.
After calling theListCrawlers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Returns a list of resource metadata for a given list of development endpoint names.
After calling theListDevEndpoints operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Returns a list of resource metadata for a given list of job names.
After calling theListJobs operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Returns a list of resource metadata for a given list of trigger names.
After calling theListTriggers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Returns a list of resource metadata for a given list of workflow names.
After calling theListWorkflows operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
cancel_data_quality_rule_recommendation_run(Client, Input, Options)
View Sourcecancel_data_quality_ruleset_evaluation_run(Client, Input, Options)
View SourceCancels (stops) a task run.
Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can cancel a machine learning task run at any time by callingCancelMLTaskRun with a task run's parent transform's TransformID and the task run's TaskRunId.
Validates the supplied schema.
This call has no side effects, it simply validates using the supplied schema usingDataFormat as the format. Since it does not take a schema set name, no compatibility checks are performed.
Creates a classifier in the user's account.
This can be aGrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field of the request is present.
Creates a connection definition in the Data Catalog.
Connections used for creating federated resources require the IAMglue:PassConnection permission.
Creates a new crawler with specified targets, role, configuration, and optional schedule.
At least one crawl target must be specified, in thes3Targets field, the jdbcTargets field, or the DynamoDBTargets field.
Creates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.
Each custom pattern you create specifies a regular expression and an optional list of context words. If no context words are passed only a regular expression is checked.Creates a data quality ruleset with DQDL rules applied to a specified Glue table.
You create the ruleset using the Data Quality Definition Language (DQDL). For more information, see the Glue developer guide.Creates an Glue machine learning transform.
This operation creates the transform and all the necessary parameters to train it.
Call this operation as the first step in the process of using a machine learning transform (such as the FindMatches transform) for deduplicating data. You can provide an optional Description, in addition to the parameters that you want to use for your algorithm.
Role, and optionally, AllocatedCapacity, Timeout, and MaxRetries. For more information, see Jobs: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html.
Creates a new schema set and registers the schema definition.
Returns an error if the schema set already exists without actually registering the version.
When the schema set is created, a version checkpoint will be set to the first version. Compatibility mode "DISABLED" restricts any additional schema versions from being added after the first schema version. For all other compatibility modes, validation of compatibility settings will be applied only from the second version onwards when the RegisterSchemaVersion API is used.
RegistryId, this will create an entry for a "default-registry" in the registry database tables, if it is not already present.
Creates a new security configuration.
A security configuration is a set of security properties that can be used by Glue. You can use a security configuration to encrypt data at rest. For information about using security configurations in Glue, see Encrypting Data Written by Crawlers, Jobs, and Development Endpoints: https://docs.aws.amazon.com/glue/latest/dg/encryption-security-configuration.html.Creates a new table optimizer for a specific function.
compaction is the only currently supported optimizer type.
Delete the partition column statistics of a column.
The Identity and Access Management (IAM) permission required for this operation isDeletePartition.
Retrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation isDeleteTable.
RUNNING.
Removes a specified database from a Data Catalog.
After completing this operation, you no longer have access to the tables (and all table versions and partitions that might belong to the tables) and the user-defined functions in the deleted database. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources, before callingDeleteDatabase, use DeleteTableVersion or BatchDeleteTableVersion, DeletePartition or BatchDeletePartition, DeleteUserDefinedFunction, and DeleteTable or BatchDeleteTable, to delete any resources that belong to the database.
Deletes a specified job definition.
If the job definition is not found, no exception is thrown.Deletes an Glue machine learning transform.
Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue. If you no longer need a transform, you can delete it by callingDeleteMLTransforms. However, any Glue jobs that still reference the deleted transform will no longer succeed.
Delete the entire registry including schema and all of its versions.
To get the status of the delete operation, you can call theGetRegistry API after the asynchronous call. Deleting a registry will deactivate all online operations for the registry such as the UpdateRegistry, CreateSchema, UpdateSchema, and RegisterSchemaVersion APIs.
Deletes the entire schema set, including the schema set and all of its versions.
To get the status of the delete operation, you can callGetSchema API after the asynchronous call. Deleting a registry will deactivate all online operations for the schema, such as the GetSchemaByDefinition, and RegisterSchemaVersion APIs.
Remove versions from the specified schema.
A version number or range may be supplied. If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned. Calling the GetSchemaVersions API after this call will list the status of the deleted versions.
When the range of version numbers contain check pointed version, the API will return a 409 conflict and will not proceed with the deletion. You have to remove the checkpoint first using the DeleteSchemaCheckpoint API before using this API.
You cannot use the DeleteSchemaVersions API to delete the first schema version in the schema set. The first schema version can only be deleted by the DeleteSchema API. This operation will also delete the attached SchemaVersionMetadata under the schema versions. Hard deletes will be enforced on the database.
Removes a table definition from the Data Catalog.
After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources, before callingDeleteTable, use DeleteTableVersion or BatchDeleteTableVersion, and DeletePartition or BatchDeletePartition, to delete any resources that belong to the table.
Deletes an optimizer and all associated metadata for a table.
The optimization will no longer be performed on the table.Deletes a specified trigger.
If the trigger is not found, no exception is thrown.Retrieves partition statistics of columns.
The Identity and Access Management (IAM) permission required for this operation isGetPartition.
Retrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation isGetTable.
Retrieves information about a specified development endpoint.
When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address, and the public IP address field is not populated. When you create a non-VPC development endpoint, Glue returns only a public IP address.Retrieves all the development endpoints in this Amazon Web Services account.
When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address and the public IP address field is not populated. When you create a non-VPC development endpoint, Glue returns only a public IP address.Returns information on a job bookmark entry.
For more information about enabling and using job bookmarks, see:
Tracking processed data using job bookmarks: https://docs.aws.amazon.com/glue/latest/dg/monitor-continuations.html
Job parameters used by Glue: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
Job structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job
Gets details for a specific task run on a machine learning transform.
Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can check the stats of any task run by callingGetMLTaskRun with the TaskRunID and its parent transform's TransformID.
Gets a list of runs for a machine learning transform.
Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can get a sortable, filterable list of machine learning task runs by calling GetMLTaskRuns with their parent transform's TransformID and other optional parameters as documented in this section.
Gets an Glue machine learning transform artifact and all its corresponding metadata.
Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue. You can retrieve their metadata by callingGetMLTransform.
Gets a sortable, filterable list of existing Glue machine learning transforms.
Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue, and you can retrieve their metadata by callingGetMLTransforms.
Retrieves the resource policies set on individual resources by Resource Access Manager during cross-account permission grants.
Also retrieves the Data Catalog resource policy.
If you enabled metadata encryption in Data Catalog settings, and you do not have permission on the KMS key, the operation can't return the Data Catalog resource policy.Retrieves a schema by the SchemaDefinition.
SchemaName or ARN (or the default registry, if none is supplied), that schema’s metadata is returned. Otherwise, a 404 or NotFound error is returned. Schema versions in Deleted statuses will not be included in the results.
Get the specified schema by its unique ID assigned when a version of the schema is created or registered.
Schema versions in Deleted status will not be included in the results.Fetches the schema version difference in the specified difference type between two stored schema versions in the Schema Registry.
This API allows you to compare two schema versions between two schema definitions under the same schema.Table definition in a Data Catalog for a specified table.
Database.
Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API isglue:GetPartition.
Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API isglue:GetPartitions.
Retrieves table metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API isglue:GetTable.
Retrieves the names of all crawler resources in this Amazon Web Services account, or the resources with the specified tag.
This operation allows you to see which resources are available in your account, and their names.
This operation takes the optionalTags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Returns all the crawls of a specified crawler.
Returns only the crawls that have occurred since the launch date of the crawler history feature, and only retains up to 12 months of crawls. Older crawls will not be returned.
You may use this API to:
Retrive all the crawls of a specified crawler.
Retrieve all the crawls of a specified crawler within a limited count.
Retrieve all the crawls of a specified crawler in a specific time range.
Retrieve all the crawls of a specified crawler with a particular state, crawl ID, or DPU hour value.
list_data_quality_rule_recommendation_runs(Client, Input, Options)
View SourceRetrieves the names of all DevEndpoint resources in this Amazon Web Services account, or the resources with the specified tag.
This operation allows you to see which resources are available in your account, and their names.
This operation takes the optionalTags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Retrieves the names of all job resources in this Amazon Web Services account, or the resources with the specified tag.
This operation allows you to see which resources are available in your account, and their names.
This operation takes the optionalTags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Retrieves a sortable, filterable list of existing Glue machine learning transforms in this Amazon Web Services account, or the resources with the specified tag.
This operation takes the optionalTags field, which you can use as a filter of the responses so that tagged resources can be retrieved as a group. If you choose to use tag filtering, only resources with the tags are retrieved.
Returns a list of registries that you have created, with minimal registry information.
Registries in theDeleting status will not be included in the results. Empty results will be returned if there are no registries available.
Returns a list of schema versions that you have created, with minimal information.
Schema versions in Deleted status will not be included in the results. Empty results will be returned if there are no schema versions available.Returns a list of schemas with minimal details.
Schemas in Deleting status will not be included in the results. Empty results will be returned if there are no schemas available.
When theRegistryId is not provided, all the schemas across registries will be part of the API response.
Retrieves the names of all trigger resources in this Amazon Web Services account, or the resources with the specified tag.
This operation allows you to see which resources are available in your account, and their names.
This operation takes the optionalTags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Sets the security configuration for a specified catalog.
After the configuration has been set, the specified encryption is applied to every catalog write thereafter.Puts the metadata key value pair for a specified schema version ID.
A maximum of 10 key value pairs will be allowed per schema version. They can be added over one or more calls.Puts the specified workflow run properties for the given workflow run.
If a property already exists for the specified run, then it overrides the value otherwise adds the property to existing properties.Adds a new version to the existing schema.
Returns an error if new version of schema does not meet the compatibility requirements of the schema set. This API will not create a new schema set and will return a 404 error if the schema set is not already present in the Schema Registry.
If this is the first schema definition to be registered in the Schema Registry, this API will store the schema version and return immediately. Otherwise, this call has the potential to run longer than other operations due to compatibility modes. You can call the GetSchemaVersion API with the SchemaVersionId to check compatibility modes.
Resets a bookmark entry.
For more information about enabling and using job bookmarks, see:
Tracking processed data using job bookmarks: https://docs.aws.amazon.com/glue/latest/dg/monitor-continuations.html
Job parameters used by Glue: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
Job structure: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job
Restarts selected nodes of a previous partially completed workflow run and resumes the workflow run.
The selected nodes and all nodes that are downstream from the selected nodes are run.Searches a set of tables based on properties in the table metadata as well as on the parent database.
You can search against text or filter conditions.
You can only get tables that you have access to based on the security policies defined in Lake Formation. You need at least a read-only access to the table for it to be returned. If you do not have access to all the columns in the table, these columns will not be searched against when returning the list of tables back to you. If you have access to the columns but not the data in the columns, those columns and the associated metadata for those columns will be included in the search.Starts a crawl using the specified crawler, regardless of what is scheduled.
If the crawler is already running, returns a CrawlerRunningException: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-exceptions.html#aws-glue-api-exceptions-CrawlerRunningException.SCHEDULED, unless the crawler is already running or the schedule state is already SCHEDULED.
Starts a recommendation run that is used to generate rules when you don't know what rules to write.
Glue Data Quality analyzes the data and comes up with recommendations for a potential ruleset. You can then triage the ruleset and modify the generated ruleset to your liking.
Recommendation runs are automatically deleted after 90 days.start_data_quality_rule_recommendation_run(Client, Input, Options)
View SourceOnce you have a ruleset definition (either recommended or your own), you call this operation to evaluate the ruleset against a data source (Glue table).
The evaluation computes results which you can retrieve with theGetDataQualityResult API.
Begins an asynchronous task to export all labeled data for a particular transform.
This task is the only label-related API call that is not part of the typical active learning workflow. You typically useStartExportLabelsTaskRun when you want to work with all of your existing labels at the same time, such as when you want to remove or change labels that were previously submitted as truth. This API operation accepts the TransformId whose labels you want to export and an Amazon Simple Storage Service (Amazon S3) path to export the labels to. The operation returns a TaskRunId. You can check on the status of your task run by calling the GetMLTaskRun API.
Enables you to provide additional labels (examples of truth) to be used to teach the machine learning transform and improve its quality.
This API operation is generally used as part of the active learning workflow that starts with the StartMLLabelingSetGenerationTaskRun call and that ultimately results in improving the quality of your machine learning transform.
After the StartMLLabelingSetGenerationTaskRun finishes, Glue machine learning will have generated a series of questions for humans to answer. (Answering these questions is often called 'labeling' in the machine learning workflows). In the case of the FindMatches transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?” After the labeling process is finished, users upload their answers/labels with a call to StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes, all future runs of the machine learning transform use the new and improved labels and perform a higher-quality transformation.
By default, StartMLLabelingSetGenerationTaskRun continually learns from and combines all labels that you upload unless you set Replace to true. If you set Replace to true, StartImportLabelsTaskRun deletes and forgets all previously uploaded labels and learns only from the exact set that you upload. Replacing labels can be helpful if you realize that you previously uploaded incorrect labels, and you believe that they are having a negative effect on your transform quality.
GetMLTaskRun operation.
Starts a task to estimate the quality of the transform.
When you provide label sets as examples of truth, Glue machine learning uses some of those examples to learn from them. The rest of the labels are used as a test to estimate quality.
Returns a unique identifier for the run. You can callGetMLTaskRun to get more information about the stats of the EvaluationTaskRun.
Starts the active learning workflow for your machine learning transform to improve the transform's quality by generating label sets and adding labels.
When the StartMLLabelingSetGenerationTaskRun finishes, Glue will have generated a "labeling set" or a set of questions for humans to answer.
In the case of the FindMatches transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?”
StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes, all future runs of the machine learning transform will use the new and improved labels and perform a higher-quality transformation.
Starts an existing trigger.
See Triggering Jobs: https://docs.aws.amazon.com/glue/latest/dg/trigger-job.html for information about how different types of trigger are started.NOT_SCHEDULED, but does not stop the crawler if it is already running.
Adds tags to a resource.
A tag is a label you can assign to an Amazon Web Services resource. In Glue, you can tag only certain resources. For information about what resources you can tag, see Amazon Web Services Tags in Glue: https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html.GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field is present).
Creates or updates partition statistics of columns.
The Identity and Access Management (IAM) permission required for this operation isUpdatePartition.
Creates or updates table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation isUpdateTable.
Updates a crawler.
If a crawler is running, you must stop it usingStopCrawler before updating it.
cron expression.
Updates an existing job definition.
The previous job definition is completely overwritten by this information.Synchronizes a job from the source control repository.
This operation takes the job artifacts that are located in the remote repository and updates the Glue internal stores with these artifacts.
This API supports optional parameters which take in the repository information.Updates an existing machine learning transform.
Call this operation to tune the algorithm parameters to achieve better results.
After calling this operation, you can call theStartMLEvaluationTaskRun operation to assess how well your new parameters achieved your goals (such as improving the quality of your machine learning transform, or making it more cost-effective).
Updates an existing registry which is used to hold a collection of schemas.
The updated properties relate to the registry, and do not modify any of the schemas within the registry.Updates the description, compatibility setting, or version checkpoint for a schema set.
For updating the compatibility setting, the call will not validate compatibility for the entire set of schema versions with the new compatibility setting. If the value for Compatibility is provided, the VersionNumber (a checkpoint) is also required. The API will validate the checkpoint version number for consistency.
If the value for the VersionNumber (checkpoint) is provided, Compatibility is optional and this can be used to set/reset a checkpoint for the schema.
Synchronizes a job to the source control repository.
This operation takes the job artifacts from the 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.