docs(client-glue): This release adds documentation for the APIs to create, read, delete, list, and batch read of AWS Glue custom patterns, and for Lake Formation configuration settings in the AWS Glue crawler.

Author: awstools

clients/client-glue/src/Glue.ts

@@ -1032,6 +1032,9 @@ export class Glue extends GlueClient {
     }
   }
 
+  /**
+   * <p>Retrieves the details for the custom patterns specified by a list of names.</p>
+   */
   public batchGetCustomEntityTypes(
     args: BatchGetCustomEntityTypesCommandInput,
     options?: __HttpHandlerOptions
@@ -1516,6 +1519,11 @@ export class Glue extends GlueClient {
     }
   }
 
+  /**
+   * <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>
+   */
   public createCustomEntityType(
     args: CreateCustomEntityTypeCommandInput,
     options?: __HttpHandlerOptions
@@ -2218,6 +2226,9 @@ export class Glue extends GlueClient {
     }
   }
 
+  /**
+   * <p>Deletes a custom pattern by specifying its name.</p>
+   */
   public deleteCustomEntityType(
     args: DeleteCustomEntityTypeCommandInput,
     options?: __HttpHandlerOptions
@@ -3214,6 +3225,9 @@ export class Glue extends GlueClient {
     }
   }
 
+  /**
+   * <p>Retrieves the details of a custom pattern by specifying its name.</p>
+   */
   public getCustomEntityType(
     args: GetCustomEntityTypeCommandInput,
     options?: __HttpHandlerOptions
@@ -4766,6 +4780,9 @@ export class Glue extends GlueClient {
     }
   }
 
+  /**
+   * <p>Lists all the custom patterns that have been created.</p>
+   */
   public listCustomEntityTypes(
     args: ListCustomEntityTypesCommandInput,
     options?: __HttpHandlerOptions

clients/client-glue/src/commands/BatchGetCustomEntityTypesCommand.ts

@@ -21,6 +21,23 @@ import {
 export interface BatchGetCustomEntityTypesCommandInput extends BatchGetCustomEntityTypesRequest {}
 export interface BatchGetCustomEntityTypesCommandOutput extends BatchGetCustomEntityTypesResponse, __MetadataBearer {}
 
+/**
+ * <p>Retrieves the details for the custom patterns specified by a list of names.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { GlueClient, BatchGetCustomEntityTypesCommand } from "@aws-sdk/client-glue"; // ES Modules import
+ * // const { GlueClient, BatchGetCustomEntityTypesCommand } = require("@aws-sdk/client-glue"); // CommonJS import
+ * const client = new GlueClient(config);
+ * const command = new BatchGetCustomEntityTypesCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link BatchGetCustomEntityTypesCommandInput} for command's `input` shape.
+ * @see {@link BatchGetCustomEntityTypesCommandOutput} for command's `response` shape.
+ * @see {@link GlueClientResolvedConfig | config} for GlueClient's `config` shape.
+ *
+ */
 export class BatchGetCustomEntityTypesCommand extends $Command<
   BatchGetCustomEntityTypesCommandInput,
   BatchGetCustomEntityTypesCommandOutput,

clients/client-glue/src/commands/CreateCustomEntityTypeCommand.ts

@@ -21,6 +21,25 @@ import {
 export interface CreateCustomEntityTypeCommandInput extends CreateCustomEntityTypeRequest {}
 export interface CreateCustomEntityTypeCommandOutput extends CreateCustomEntityTypeResponse, __MetadataBearer {}
 
+/**
+ * <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>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { GlueClient, CreateCustomEntityTypeCommand } from "@aws-sdk/client-glue"; // ES Modules import
+ * // const { GlueClient, CreateCustomEntityTypeCommand } = require("@aws-sdk/client-glue"); // CommonJS import
+ * const client = new GlueClient(config);
+ * const command = new CreateCustomEntityTypeCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link CreateCustomEntityTypeCommandInput} for command's `input` shape.
+ * @see {@link CreateCustomEntityTypeCommandOutput} for command's `response` shape.
+ * @see {@link GlueClientResolvedConfig | config} for GlueClient's `config` shape.
+ *
+ */
 export class CreateCustomEntityTypeCommand extends $Command<
   CreateCustomEntityTypeCommandInput,
   CreateCustomEntityTypeCommandOutput,

clients/client-glue/src/commands/DeleteCustomEntityTypeCommand.ts

@@ -21,6 +21,23 @@ import {
 export interface DeleteCustomEntityTypeCommandInput extends DeleteCustomEntityTypeRequest {}
 export interface DeleteCustomEntityTypeCommandOutput extends DeleteCustomEntityTypeResponse, __MetadataBearer {}
 
+/**
+ * <p>Deletes a custom pattern by specifying its name.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { GlueClient, DeleteCustomEntityTypeCommand } from "@aws-sdk/client-glue"; // ES Modules import
+ * // const { GlueClient, DeleteCustomEntityTypeCommand } = require("@aws-sdk/client-glue"); // CommonJS import
+ * const client = new GlueClient(config);
+ * const command = new DeleteCustomEntityTypeCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link DeleteCustomEntityTypeCommandInput} for command's `input` shape.
+ * @see {@link DeleteCustomEntityTypeCommandOutput} for command's `response` shape.
+ * @see {@link GlueClientResolvedConfig | config} for GlueClient's `config` shape.
+ *
+ */
 export class DeleteCustomEntityTypeCommand extends $Command<
   DeleteCustomEntityTypeCommandInput,
   DeleteCustomEntityTypeCommandOutput,

clients/client-glue/src/commands/GetCustomEntityTypeCommand.ts

@@ -21,6 +21,23 @@ import {
 export interface GetCustomEntityTypeCommandInput extends GetCustomEntityTypeRequest {}
 export interface GetCustomEntityTypeCommandOutput extends GetCustomEntityTypeResponse, __MetadataBearer {}
 
+/**
+ * <p>Retrieves the details of a custom pattern by specifying its name.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { GlueClient, GetCustomEntityTypeCommand } from "@aws-sdk/client-glue"; // ES Modules import
+ * // const { GlueClient, GetCustomEntityTypeCommand } = require("@aws-sdk/client-glue"); // CommonJS import
+ * const client = new GlueClient(config);
+ * const command = new GetCustomEntityTypeCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link GetCustomEntityTypeCommandInput} for command's `input` shape.
+ * @see {@link GetCustomEntityTypeCommandOutput} for command's `response` shape.
+ * @see {@link GlueClientResolvedConfig | config} for GlueClient's `config` shape.
+ *
+ */
 export class GetCustomEntityTypeCommand extends $Command<
   GetCustomEntityTypeCommandInput,
   GetCustomEntityTypeCommandOutput,

clients/client-glue/src/commands/ListCustomEntityTypesCommand.ts

@@ -21,6 +21,23 @@ import {
 export interface ListCustomEntityTypesCommandInput extends ListCustomEntityTypesRequest {}
 export interface ListCustomEntityTypesCommandOutput extends ListCustomEntityTypesResponse, __MetadataBearer {}
 
+/**
+ * <p>Lists all the custom patterns that have been created.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { GlueClient, ListCustomEntityTypesCommand } from "@aws-sdk/client-glue"; // ES Modules import
+ * // const { GlueClient, ListCustomEntityTypesCommand } = require("@aws-sdk/client-glue"); // CommonJS import
+ * const client = new GlueClient(config);
+ * const command = new ListCustomEntityTypesCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link ListCustomEntityTypesCommandInput} for command's `input` shape.
+ * @see {@link ListCustomEntityTypesCommandOutput} for command's `response` shape.
+ * @see {@link GlueClientResolvedConfig | config} for GlueClient's `config` shape.
+ *
+ */
 export class ListCustomEntityTypesCommand extends $Command<
   ListCustomEntityTypesCommandInput,
   ListCustomEntityTypesCommandOutput,

clients/client-glue/src/models/models_0.ts

@@ -1185,8 +1185,18 @@ export namespace BatchGetCrawlersRequest {
   });
 }
 
+/**
+ * <p>Specifies AWS Lake Formation configuration settings for the crawler.</p>
+ */
 export interface LakeFormationConfiguration {
+  /**
+   * <p>Specifies whether to use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.</p>
+   */
   UseLakeFormationCredentials?: boolean;
+
+  /**
+   * <p>Required for cross account crawls. For same account crawls as the target data, this can be left as null.</p>
+   */
   AccountId?: string;
 }
 
@@ -1735,6 +1745,9 @@ export interface Crawler {
    */
   CrawlerSecurityConfiguration?: string;
 
+  /**
+   * <p>Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.</p>
+   */
   LakeFormationConfiguration?: LakeFormationConfiguration;
 }
 
@@ -1769,6 +1782,9 @@ export namespace BatchGetCrawlersResponse {
 }
 
 export interface BatchGetCustomEntityTypesRequest {
+  /**
+   * <p>A list of names of the custom patterns that you want to retrieve.</p>
+   */
   Names: string[] | undefined;
 }
 
@@ -1781,9 +1797,25 @@ export namespace BatchGetCustomEntityTypesRequest {
   });
 }
 
+/**
+ * <p>An object representing a custom pattern for detecting sensitive data across the columns and rows of your structured data.</p>
+ */
 export interface CustomEntityType {
+  /**
+   * <p>A name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per Amazon Web Services account.</p>
+   */
   Name: string | undefined;
+
+  /**
+   * <p>A regular expression string that is used for detecting sensitive data in a custom pattern.</p>
+   */
   RegexString: string | undefined;
+
+  /**
+   * <p>A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.</p>
+   *
+   * 	        <p>If no context words are passed only a regular expression is checked.</p>
+   */
   ContextWords?: string[];
 }
 
@@ -1797,7 +1829,14 @@ export namespace CustomEntityType {
 }
 
 export interface BatchGetCustomEntityTypesResponse {
+  /**
+   * <p>A list of <code>CustomEntityType</code> objects representing the custom patterns that have been created.</p>
+   */
   CustomEntityTypes?: CustomEntityType[];
+
+  /**
+   * <p>A list of the names of custom patterns that were not found.</p>
+   */
   CustomEntityTypesNotFound?: string[];
 }
 
@@ -4248,7 +4287,11 @@ export interface CreateCrawlerRequest {
    */
   LineageConfiguration?: LineageConfiguration;
 
+  /**
+   * <p>Specifies AWS Lake Formation configuration settings for the crawler.</p>
+   */
   LakeFormationConfiguration?: LakeFormationConfiguration;
+
   /**
    * <p>Crawler configuration information. This versioned JSON
    *       string allows users to specify aspects of a crawler's behavior.
@@ -4291,8 +4334,21 @@ export namespace CreateCrawlerResponse {
 }
 
 export interface CreateCustomEntityTypeRequest {
+  /**
+   * <p>A name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per Amazon Web Services account.</p>
+   */
   Name: string | undefined;
+
+  /**
+   * <p>A regular expression string that is used for detecting sensitive data in a custom pattern.</p>
+   */
   RegexString: string | undefined;
+
+  /**
+   * <p>A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.</p>
+   *
+   * 	        <p>If no context words are passed only a regular expression is checked.</p>
+   */
   ContextWords?: string[];
 }
 
@@ -4306,6 +4362,9 @@ export namespace CreateCustomEntityTypeRequest {
 }
 
 export interface CreateCustomEntityTypeResponse {
+  /**
+   * <p>The name of the custom pattern you created.</p>
+   */
   Name?: string;
 }
 
@@ -6894,6 +6953,9 @@ export class SchedulerTransitioningException extends __BaseException {
 }
 
 export interface DeleteCustomEntityTypeRequest {
+  /**
+   * <p>The name of the custom pattern that you want to delete.</p>
+   */
   Name: string | undefined;
 }
 
@@ -6907,6 +6969,9 @@ export namespace DeleteCustomEntityTypeRequest {
 }
 
 export interface DeleteCustomEntityTypeResponse {
+  /**
+   * <p>The name of the custom pattern you deleted.</p>
+   */
   Name?: string;
 }
 

clients/client-glue/src/models/models_1.ts

@@ -765,6 +765,9 @@ export namespace GetCrawlersResponse {
 }
 
 export interface GetCustomEntityTypeRequest {
+  /**
+   * <p>The name of the custom pattern that you want to retrieve.</p>
+   */
   Name: string | undefined;
 }
 
@@ -778,8 +781,19 @@ export namespace GetCustomEntityTypeRequest {
 }
 
 export interface GetCustomEntityTypeResponse {
+  /**
+   * <p>The name of the custom pattern that you retrieved.</p>
+   */
   Name?: string;
+
+  /**
+   * <p>A regular expression string that is used for detecting sensitive data in a custom pattern.</p>
+   */
   RegexString?: string;
+
+  /**
+   * <p>A list of context words if specified when you created the custom pattern. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.</p>
+   */
   ContextWords?: string[];
 }
 
@@ -5117,7 +5131,14 @@ export namespace ListCrawlersResponse {
 }
 
 export interface ListCustomEntityTypesRequest {
+  /**
+   * <p>A paginated token to offset the results.</p>
+   */
   NextToken?: string;
+
+  /**
+   * <p>The maximum number of results to return.</p>
+   */
   MaxResults?: number;
 }
 
@@ -5131,7 +5152,14 @@ export namespace ListCustomEntityTypesRequest {
 }
 
 export interface ListCustomEntityTypesResponse {
+  /**
+   * <p>A list of <code>CustomEntityType</code> objects representing custom patterns.</p>
+   */
   CustomEntityTypes?: CustomEntityType[];
+
+  /**
+   * <p>A pagination token, if more results are available.</p>
+   */
   NextToken?: string;
 }
 
@@ -7903,7 +7931,11 @@ export interface UpdateCrawlerRequest {
    */
   LineageConfiguration?: LineageConfiguration;
 
+  /**
+   * <p>Specifies AWS Lake Formation configuration settings for the crawler.</p>
+   */
   LakeFormationConfiguration?: LakeFormationConfiguration;
+
   /**
    * <p>Crawler configuration information. This versioned JSON string allows users
    *         to specify aspects of a crawler's behavior.