Skip to content

Commit

Permalink
feat(client-glue): This release allows the creation of Custom Visual …
Browse files Browse the repository at this point in the history
…Transforms (Dynamic Transforms) to be created via AWS Glue CLI/SDK.
  • Loading branch information
awstools committed Nov 29, 2022
1 parent e6868fe commit 23a99e8
Show file tree
Hide file tree
Showing 35 changed files with 958 additions and 762 deletions.
74 changes: 22 additions & 52 deletions clients/client-glue/src/Glue.ts

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,7 @@ export interface CreateCustomEntityTypeCommandOutput extends CreateCustomEntityT

/**
* <p>Creates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.</p>
*
* <p>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.</p>
* <p>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.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
4 changes: 1 addition & 3 deletions clients/client-glue/src/commands/CreateMLTransformCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,10 @@ export interface CreateMLTransformCommandOutput extends CreateMLTransformRespons
/**
* <p>Creates an Glue machine learning transform. This operation creates the transform and
* all the necessary parameters to train it.</p>
*
* <p>Call this operation as the first step in the process of using a machine learning transform
* <p>Call this operation as the first step in the process of using a machine learning transform
* (such as the <code>FindMatches</code> transform) for deduplicating data. You can provide an
* optional <code>Description</code>, in addition to the parameters that you want to use for your
* algorithm.</p>
*
* <p>You must also specify certain parameters for the tasks that Glue runs on your
* behalf as part of learning from your data and creating a high-quality machine learning
* transform. These parameters include <code>Role</code>, and optionally,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import {
CreateUserDefinedFunctionRequestFilterSensitiveLog,
CreateUserDefinedFunctionResponse,
CreateUserDefinedFunctionResponseFilterSensitiveLog,
} from "../models/models_0";
} from "../models/models_1";
import {
deserializeAws_json1_1CreateUserDefinedFunctionCommand,
serializeAws_json1_1CreateUserDefinedFunctionCommand,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,7 @@ export interface DeleteColumnStatisticsForPartitionCommandOutput

/**
* <p>Delete the partition column statistics of a column.</p>
*
* <p>The Identity and Access Management (IAM) permission required for this operation is <code>DeletePartition</code>.</p>
* <p>The Identity and Access Management (IAM) permission required for this operation is <code>DeletePartition</code>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,7 @@ export interface DeleteColumnStatisticsForTableCommandOutput

/**
* <p>Retrieves table statistics of columns.</p>
*
* <p>The Identity and Access Management (IAM) permission required for this operation is <code>DeleteTable</code>.</p>
* <p>The Identity and Access Management (IAM) permission required for this operation is <code>DeleteTable</code>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,7 @@ export interface GetColumnStatisticsForPartitionCommandOutput

/**
* <p>Retrieves partition statistics of columns.</p>
*
* <p>The Identity and Access Management (IAM) permission required for this operation is <code>GetPartition</code>.</p>
* <p>The Identity and Access Management (IAM) permission required for this operation is <code>GetPartition</code>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ export interface GetColumnStatisticsForTableCommandOutput

/**
* <p>Retrieves table statistics of columns.</p>
*
* <p>The Identity and Access Management (IAM) permission required for this operation is <code>GetTable</code>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
6 changes: 2 additions & 4 deletions clients/client-glue/src/commands/GetJobBookmarkCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,8 @@ export interface GetJobBookmarkCommandOutput extends GetJobBookmarkResponse, __M

/**
* <p>Returns information on a job bookmark entry.</p>
*
* <p>For more information about enabling and using job bookmarks, see:</p>
*
* <ul>
* <p>For more information about enabling and using job bookmarks, see:</p>
* <ul>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/glue/latest/dg/monitor-continuations.html">Tracking processed data using job bookmarks</a>
Expand Down
3 changes: 1 addition & 2 deletions clients/client-glue/src/commands/GetMLTaskRunsCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,7 @@ export interface GetMLTaskRunsCommandOutput extends GetMLTaskRunsResponse, __Met
* workflows. You can get a sortable, filterable list of machine learning task runs by calling
* <code>GetMLTaskRuns</code> with their parent transform's <code>TransformID</code> and other
* optional parameters as documented in this section.</p>
*
* <p>This operation returns a list of historic runs and must be paginated.</p>
* <p>This operation returns a list of historic runs and must be paginated.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
1 change: 0 additions & 1 deletion clients/client-glue/src/commands/ListCrawlersCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ export interface ListCrawlersCommandOutput extends ListCrawlersResponse, __Metad
* <p>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.</p>
*
* <p>This operation takes the optional <code>Tags</code> 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.</p>
Expand Down
5 changes: 2 additions & 3 deletions clients/client-glue/src/commands/ListCrawlsCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,8 @@ export interface ListCrawlsCommandOutput extends ListCrawlsResponse, __MetadataB

/**
* <p>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.</p>
*
* <p>You may use this API to:</p>
* <ul>
* <p>You may use this API to:</p>
* <ul>
* <li>
* <p>Retrive all the crawls of a specified crawler.</p>
* </li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ export interface ListDevEndpointsCommandOutput extends ListDevEndpointsResponse,
* <p>Retrieves the names of all <code>DevEndpoint</code> 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.</p>
*
* <p>This operation takes the optional <code>Tags</code> 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.</p>
Expand Down
3 changes: 1 addition & 2 deletions clients/client-glue/src/commands/ListJobsCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ export interface ListJobsCommandOutput extends ListJobsResponse, __MetadataBeare

/**
* <p>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.</p>
*
* <p>This operation takes the optional <code>Tags</code> field, which you can use as a filter on
* <p>This operation takes the optional <code>Tags</code> 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.</p>
* @example
Expand Down
1 change: 0 additions & 1 deletion clients/client-glue/src/commands/ListTriggersCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ export interface ListTriggersCommandOutput extends ListTriggersResponse, __Metad

/**
* <p>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.</p>
*
* <p>This operation takes the optional <code>Tags</code> 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.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import {
PutSchemaVersionMetadataInputFilterSensitiveLog,
PutSchemaVersionMetadataResponse,
PutSchemaVersionMetadataResponseFilterSensitiveLog,
} from "../models/models_1";
} from "../models/models_2";
import {
deserializeAws_json1_1PutSchemaVersionMetadataCommand,
serializeAws_json1_1PutSchemaVersionMetadataCommand,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@ import {
} from "@aws-sdk/types";

import { GlueClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GlueClient";
import { PutWorkflowRunPropertiesRequest, PutWorkflowRunPropertiesRequestFilterSensitiveLog } from "../models/models_1";
import {
PutWorkflowRunPropertiesRequest,
PutWorkflowRunPropertiesRequestFilterSensitiveLog,
PutWorkflowRunPropertiesResponse,
PutWorkflowRunPropertiesResponseFilterSensitiveLog,
} from "../models/models_2";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export interface RegisterSchemaVersionCommandOutput extends RegisterSchemaVersio
/**
* <p>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.</p>
* <p>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 <code>GetSchemaVersion</code> API with the <code>SchemaVersionId</code> to check compatibility modes.</p>
* <p>If the same schema definition is already stored in Schema Registry as a version, the schema ID of the existing schema is returned to the caller.</p>
* <p>If the same schema definition is already stored in Schema Registry as a version, the schema ID of the existing schema is returned to the caller.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
6 changes: 2 additions & 4 deletions clients/client-glue/src/commands/ResetJobBookmarkCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,8 @@ export interface ResetJobBookmarkCommandOutput extends ResetJobBookmarkResponse,

/**
* <p>Resets a bookmark entry.</p>
*
* <p>For more information about enabling and using job bookmarks, see:</p>
*
* <ul>
* <p>For more information about enabling and using job bookmarks, see:</p>
* <ul>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/glue/latest/dg/monitor-continuations.html">Tracking processed data using job bookmarks</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ export interface StartImportLabelsTaskRunCommandOutput extends StartImportLabels
* part of the active learning workflow that starts with the
* <code>StartMLLabelingSetGenerationTaskRun</code> call and that ultimately results in
* improving the quality of your machine learning transform. </p>
*
* <p>After the <code>StartMLLabelingSetGenerationTaskRun</code> 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
Expand All @@ -44,14 +43,12 @@ export interface StartImportLabelsTaskRunCommandOutput extends StartImportLabels
* <code>StartImportLabelsTaskRun</code>. After <code>StartImportLabelsTaskRun</code> finishes,
* all future runs of the machine learning transform use the new and improved labels and perform
* a higher-quality transformation.</p>
*
* <p>By default, <code>StartMLLabelingSetGenerationTaskRun</code> continually learns from and
* combines all labels that you upload unless you set <code>Replace</code> to true. If you set
* <code>Replace</code> to true, <code>StartImportLabelsTaskRun</code> 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.</p>
*
* <p>You can check on the status of your task run by calling the <code>GetMLTaskRun</code>
* operation. </p>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,10 @@ export interface StartMLEvaluationTaskRunCommandOutput extends StartMLEvaluation

/**
* <p>Starts a task to estimate the quality of the transform. </p>
*
* <p>When you provide label sets as examples of truth, Glue machine learning uses some of
* <p>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.</p>
*
* <p>Returns a unique identifier for the run. You can call <code>GetMLTaskRun</code> to get more
* <p>Returns a unique identifier for the run. You can call <code>GetMLTaskRun</code> to get more
* information about the stats of the <code>EvaluationTaskRun</code>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,11 @@ export interface StartMLLabelingSetGenerationTaskRunCommandOutput
/**
* <p>Starts the active learning workflow for your machine learning transform to improve the
* transform's quality by generating label sets and adding labels.</p>
*
* <p>When the <code>StartMLLabelingSetGenerationTaskRun</code> finishes, Glue will have
* <p>When the <code>StartMLLabelingSetGenerationTaskRun</code> finishes, Glue will have
* generated a "labeling set" or a set of questions for humans to answer.</p>
*
* <p>In the case of the <code>FindMatches</code> transform, these questions are of the form,
* “What is the correct way to group these rows together into groups composed entirely of
* matching records?” </p>
*
* <p>After the labeling process is finished, you can upload your labels with a call to
* <code>StartImportLabelsTaskRun</code>. After <code>StartImportLabelsTaskRun</code> finishes,
* all future runs of the machine learning transform will use the new and improved labels and
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ export interface UpdateColumnStatisticsForPartitionCommandOutput

/**
* <p>Creates or updates partition statistics of columns.</p>
*
* <p>The Identity and Access Management (IAM) permission required for this operation is <code>UpdatePartition</code>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,7 @@ export interface UpdateColumnStatisticsForTableCommandOutput

/**
* <p>Creates or updates table statistics of columns.</p>
*
* <p>The Identity and Access Management (IAM) permission required for this operation is <code>UpdateTable</code>.</p>
* <p>The Identity and Access Management (IAM) permission required for this operation is <code>UpdateTable</code>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,7 @@ export interface UpdateJobFromSourceControlCommandOutput extends UpdateJobFromSo

/**
* <p>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.</p>
*
* <p>This API supports optional parameters which take in the repository information.</p>
* <p>This API supports optional parameters which take in the repository information.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ export interface UpdateMLTransformCommandOutput extends UpdateMLTransformRespons

/**
* <p>Updates an existing machine learning transform. Call this operation to tune the algorithm parameters to achieve better results.</p>
*
* <p>After calling this operation, you can call the <code>StartMLEvaluationTaskRun</code>
* 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).</p>
Expand Down
4 changes: 2 additions & 2 deletions clients/client-glue/src/commands/UpdateSchemaCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ export interface UpdateSchemaCommandOutput extends UpdateSchemaResponse, __Metad

/**
* <p>Updates the description, compatibility setting, or version checkpoint for a schema set.</p>
* <p>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 <code>Compatibility</code> is provided, the <code>VersionNumber</code> (a checkpoint) is also required. The API will validate the checkpoint version number for consistency.</p>
* <p>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 <code>Compatibility</code> is provided, the <code>VersionNumber</code> (a checkpoint) is also required. The API will validate the checkpoint version number for consistency.</p>
* <p>If the value for the <code>VersionNumber</code> (checkpoint) is provided, <code>Compatibility</code> is optional and this can be used to set/reset a checkpoint for the schema.</p>
* <p>This update will happen only if the schema is in the AVAILABLE state.</p>
* <p>This update will happen only if the schema is in the AVAILABLE state.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,7 @@ export interface UpdateSourceControlFromJobCommandOutput extends UpdateSourceCon

/**
* <p>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.</p>
*
* <p>This API supports optional parameters which take in the repository information.</p>
* <p>This API supports optional parameters which take in the repository information.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
2 changes: 1 addition & 1 deletion clients/client-glue/src/endpoint/EndpointParameters.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export const resolveClientEndpointParameters = <T>(
};

export interface EndpointParameters extends __EndpointParameters {
Region?: string;
Region: string;
UseDualStack?: boolean;
UseFIPS?: boolean;
Endpoint?: string;
Expand Down
2 changes: 1 addition & 1 deletion clients/client-glue/src/endpoint/ruleset.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export const ruleSet: RuleSetObject = {
parameters: {
Region: {
builtIn: "AWS::Region",
required: false,
required: true,
documentation: "The AWS region used to dispatch the request.",
type: "String",
},
Expand Down
Loading

0 comments on commit 23a99e8

Please sign in to comment.