Specifies configuration properties for a Find Matches task run.
* @public */ export interface FindMatchesTaskRunProperties { /** *The job ID for the Find Matches task run.
* @public */ JobId?: string | undefined; /** *The name assigned to the job for the Find Matches task run.
* @public */ JobName?: string | undefined; /** *The job run ID for the Find Matches task run.
* @public */ JobRunId?: string | undefined; } /** *Specifies configuration properties for an importing labels task run.
* @public */ export interface ImportLabelsTaskRunProperties { /** *The Amazon Simple Storage Service (Amazon S3) path from where you will import the * labels.
* @public */ InputS3Path?: string | undefined; /** *Indicates whether to overwrite your existing labels.
* @public */ Replace?: boolean | undefined; } /** *Specifies configuration properties for a labeling set generation task run.
* @public */ export interface LabelingSetGenerationTaskRunProperties { /** *The Amazon Simple Storage Service (Amazon S3) path where you will generate the labeling * set.
* @public */ OutputS3Path?: string | undefined; } /** *The configuration properties for the task run.
* @public */ export interface TaskRunProperties { /** *The type of task run.
* @public */ TaskType?: TaskType | undefined; /** *The configuration properties for an importing labels task run.
* @public */ ImportLabelsTaskRunProperties?: ImportLabelsTaskRunProperties | undefined; /** *The configuration properties for an exporting labels task run.
* @public */ ExportLabelsTaskRunProperties?: ExportLabelsTaskRunProperties | undefined; /** *The configuration properties for a labeling set generation task run.
* @public */ LabelingSetGenerationTaskRunProperties?: LabelingSetGenerationTaskRunProperties | undefined; /** *The configuration properties for a find matches task run.
* @public */ FindMatchesTaskRunProperties?: FindMatchesTaskRunProperties | undefined; } /** * @public */ export interface GetMLTaskRunResponse { /** *The unique identifier of the task run.
* @public */ TransformId?: string | undefined; /** *The unique run identifier associated with this run.
* @public */ TaskRunId?: string | undefined; /** *The status for this task run.
* @public */ Status?: TaskStatusType | undefined; /** *The names of the log groups that are associated with the task run.
* @public */ LogGroupName?: string | undefined; /** *The list of properties that are associated with the task run.
* @public */ Properties?: TaskRunProperties | undefined; /** *The error strings that are associated with the task run.
* @public */ ErrorString?: string | undefined; /** *The date and time when this task run started.
* @public */ StartedOn?: Date | undefined; /** *The date and time when this task run was last modified.
* @public */ LastModifiedOn?: Date | undefined; /** *The date and time when this task run was completed.
* @public */ CompletedOn?: Date | undefined; /** *The amount of time (in seconds) that the task run consumed resources.
* @public */ ExecutionTime?: number | undefined; } /** *The criteria that are used to filter the task runs for the machine learning * transform.
* @public */ export interface TaskRunFilterCriteria { /** *The type of task run.
* @public */ TaskRunType?: TaskType | undefined; /** *The current status of the task run.
* @public */ Status?: TaskStatusType | undefined; /** *Filter on task runs started before this date.
* @public */ StartedBefore?: Date | undefined; /** *Filter on task runs started after this date.
* @public */ StartedAfter?: Date | undefined; } /** *The sorting criteria that are used to sort the list of task runs for the machine learning * transform.
* @public */ export interface TaskRunSortCriteria { /** *The column to be used to sort the list of task runs for the machine learning * transform.
* @public */ Column: TaskRunSortColumnType | undefined; /** *The sort direction to be used to sort the list of task runs for the machine learning * transform.
* @public */ SortDirection: SortDirectionType | undefined; } /** * @public */ export interface GetMLTaskRunsRequest { /** *The unique identifier of the machine learning transform.
* @public */ TransformId: string | undefined; /** *A token for pagination of the results. The default is empty.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return.
* @public */ MaxResults?: number | undefined; /** *The filter criteria, in the TaskRunFilterCriteria structure, for the task run.
The sorting criteria, in the TaskRunSortCriteria structure, for the task run.
The sampling parameters that are associated with the machine learning transform.
* @public */ export interface TaskRun { /** *The unique identifier for the transform.
* @public */ TransformId?: string | undefined; /** *The unique identifier for this task run.
* @public */ TaskRunId?: string | undefined; /** *The current status of the requested task run.
* @public */ Status?: TaskStatusType | undefined; /** *The names of the log group for secure logging, associated with this task run.
* @public */ LogGroupName?: string | undefined; /** *Specifies configuration properties associated with this task run.
* @public */ Properties?: TaskRunProperties | undefined; /** *The list of error strings associated with this task run.
* @public */ ErrorString?: string | undefined; /** *The date and time that this task run started.
* @public */ StartedOn?: Date | undefined; /** *The last point in time that the requested task run was updated.
* @public */ LastModifiedOn?: Date | undefined; /** *The last point in time that the requested task run was completed.
* @public */ CompletedOn?: Date | undefined; /** *The amount of time (in seconds) that the task run consumed resources.
* @public */ ExecutionTime?: number | undefined; } /** * @public */ export interface GetMLTaskRunsResponse { /** *A list of task runs that are associated with the transform.
* @public */ TaskRuns?: TaskRun[] | undefined; /** *A pagination token, if more results are available.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface GetMLTransformRequest { /** *The unique identifier of the transform, generated at the time that the transform was * created.
* @public */ TransformId: string | undefined; } /** *A structure containing the column name and column importance score for a column.
*Column importance helps you understand how columns contribute to your model, by identifying which columns in your records are more important than others.
* @public */ export interface ColumnImportance { /** *The name of a column.
* @public */ ColumnName?: string | undefined; /** *The column importance score for the column, as a decimal.
* @public */ Importance?: number | undefined; } /** *The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.
*For more information, see Confusion matrix in Wikipedia.
* @public */ export interface ConfusionMatrix { /** *The number of matches in the data that the transform correctly found, in the confusion matrix for your transform.
* @public */ NumTruePositives?: number | undefined; /** *The number of nonmatches in the data that the transform incorrectly classified as a match, * in the confusion matrix for your transform.
* @public */ NumFalsePositives?: number | undefined; /** *The number of nonmatches in the data that the transform correctly rejected, in the * confusion matrix for your transform.
* @public */ NumTrueNegatives?: number | undefined; /** *The number of matches in the data that the transform didn't find, in the confusion matrix for your transform.
* @public */ NumFalseNegatives?: number | undefined; } /** *The evaluation metrics for the find matches algorithm. The quality of your machine * learning transform is measured by getting your transform to predict some matches and comparing * the results to known matches from the same dataset. The quality metrics are based on a subset * of your data, so they are not precise.
* @public */ export interface FindMatchesMetrics { /** *The area under the precision/recall curve (AUPRC) is a single number measuring the overall * quality of the transform, that is independent of the choice made for precision vs. recall. * Higher values indicate that you have a more attractive precision vs. recall tradeoff.
*For more information, see Precision and recall in Wikipedia.
* @public */ AreaUnderPRCurve?: number | undefined; /** *The precision metric indicates when often your transform is correct when it predicts a match. Specifically, it measures how well the transform finds true positives from the total true positives possible.
*For more information, see Precision and recall in Wikipedia.
* @public */ Precision?: number | undefined; /** *The recall metric indicates that for an actual match, how often your transform predicts * the match. Specifically, it measures how well the transform finds true positives from the * total records in the source data.
*For more information, see Precision and recall in Wikipedia.
* @public */ Recall?: number | undefined; /** *The maximum F1 metric indicates the transform's accuracy between 0 and 1, where 1 is the best accuracy.
*For more information, see F1 score in Wikipedia.
* @public */ F1?: number | undefined; /** *The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.
*For more information, see Confusion matrix in Wikipedia.
* @public */ ConfusionMatrix?: ConfusionMatrix | undefined; /** *A list of ColumnImportance structures containing column importance metrics, sorted in order of descending importance.
Evaluation metrics provide an estimate of the quality of your machine learning transform.
* @public */ export interface EvaluationMetrics { /** *The type of machine learning transform.
* @public */ TransformType: TransformType | undefined; /** *The evaluation metrics for the find matches algorithm.
* @public */ FindMatchesMetrics?: FindMatchesMetrics | undefined; } /** *A key-value pair representing a column and data type that this transform can
* run against. The Schema parameter of the MLTransform may contain up to 100 of these structures.
The name of the column.
* @public */ Name?: string | undefined; /** *The type of data in the column.
* @public */ DataType?: string | undefined; } /** * @public */ export interface GetMLTransformResponse { /** *The unique identifier of the transform, generated at the time that the transform was * created.
* @public */ TransformId?: string | undefined; /** *The unique name given to the transform when it was created.
* @public */ Name?: string | undefined; /** *A description of the transform.
* @public */ Description?: string | undefined; /** *The last known status of the transform (to indicate whether it can be used or not). One of "NOT_READY", "READY", or "DELETING".
* @public */ Status?: TransformStatusType | undefined; /** *The date and time when the transform was created.
* @public */ CreatedOn?: Date | undefined; /** *The date and time when the transform was last modified.
* @public */ LastModifiedOn?: Date | undefined; /** *A list of Glue table definitions used by the transform.
* @public */ InputRecordTables?: GlueTable[] | undefined; /** *The configuration parameters that are specific to the algorithm used.
* @public */ Parameters?: TransformParameters | undefined; /** *The latest evaluation metrics.
* @public */ EvaluationMetrics?: EvaluationMetrics | undefined; /** *The number of labels available for this transform.
* @public */ LabelCount?: number | undefined; /** *The Map object that represents the schema that this
* transform accepts. Has an upper bound of 100 columns.
The name or Amazon Resource Name (ARN) of the IAM role with the required * permissions.
* @public */ Role?: string | undefined; /** *This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
* @public */ GlueVersion?: string | undefined; /** *The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of * processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more * information, see the Glue pricing * page.
*When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.
The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
*For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
The number of workers of a defined workerType that are allocated when this task runs.
The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
The maximum number of times to retry a task for this transform after a task run fails.
* @public */ MaxRetries?: number | undefined; /** *The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
* @public */ TransformEncryption?: TransformEncryption | undefined; } /** *The criteria used to filter the machine learning transforms.
* @public */ export interface TransformFilterCriteria { /** *A unique transform name that is used to filter the machine learning transforms.
* @public */ Name?: string | undefined; /** *The type of machine learning transform that is used to filter the machine learning * transforms.
* @public */ TransformType?: TransformType | undefined; /** *Filters the list of machine learning transforms by the last known status of the transforms (to indicate whether a transform can be used or not). One of "NOT_READY", "READY", or "DELETING".
* @public */ Status?: TransformStatusType | undefined; /** *This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
* @public */ GlueVersion?: string | undefined; /** *The time and date before which the transforms were created.
* @public */ CreatedBefore?: Date | undefined; /** *The time and date after which the transforms were created.
* @public */ CreatedAfter?: Date | undefined; /** *Filter on transforms last modified before this date.
* @public */ LastModifiedBefore?: Date | undefined; /** *Filter on transforms last modified after this date.
* @public */ LastModifiedAfter?: Date | undefined; /** *Filters on datasets with a specific schema. The Map
* object is an array of key-value pairs representing the schema this transform accepts, where
* Column is the name of a column, and Type is the type of the data
* such as an integer or string. Has an upper bound of 100 columns.
The sorting criteria that are associated with the machine learning transform.
* @public */ export interface TransformSortCriteria { /** *The column to be used in the sorting criteria that are associated with the machine * learning transform.
* @public */ Column: TransformSortColumnType | undefined; /** *The sort direction to be used in the sorting criteria that are associated with the machine * learning transform.
* @public */ SortDirection: SortDirectionType | undefined; } /** * @public */ export interface GetMLTransformsRequest { /** *A paginated token to offset the results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return.
* @public */ MaxResults?: number | undefined; /** *The filter transformation criteria.
* @public */ Filter?: TransformFilterCriteria | undefined; /** *The sorting criteria.
* @public */ Sort?: TransformSortCriteria | undefined; } /** *A structure for a machine learning transform.
* @public */ export interface MLTransform { /** *The unique transform ID that is generated for the machine learning transform. The ID is * guaranteed to be unique and does not change.
* @public */ TransformId?: string | undefined; /** *A user-defined name for the machine learning transform. Names are not guaranteed unique * and can be changed at any time.
* @public */ Name?: string | undefined; /** *A user-defined, long-form description text for the machine learning transform. * Descriptions are not guaranteed to be unique and can be changed at any time.
* @public */ Description?: string | undefined; /** *The current status of the machine learning transform.
* @public */ Status?: TransformStatusType | undefined; /** *A timestamp. The time and date that this machine learning transform was created.
* @public */ CreatedOn?: Date | undefined; /** *A timestamp. The last point in time when this machine learning transform was modified.
* @public */ LastModifiedOn?: Date | undefined; /** *A list of Glue table definitions used by the transform.
* @public */ InputRecordTables?: GlueTable[] | undefined; /** *A TransformParameters object. You can use parameters to tune (customize) the
* behavior of the machine learning transform by specifying what data it learns from and your
* preference on various tradeoffs (such as precious vs. recall, or accuracy vs. cost).
An EvaluationMetrics object. Evaluation metrics provide an estimate of the quality of your machine learning transform.
A count identifier for the labeling files generated by Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling file.
* @public */ LabelCount?: number | undefined; /** *A map of key-value pairs representing the columns and data types that this transform can * run against. Has an upper bound of 100 columns.
* @public */ Schema?: SchemaColumn[] | undefined; /** *The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.
*This role needs Glue service role permissions to allow access to resources in Glue. See Attach a Policy to IAM Users That Access Glue.
*This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.
*This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
* @public */ GlueVersion?: string | undefined; /** *The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of * processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more * information, see the Glue pricing * page.
*
* MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.
If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.
If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.
If WorkerType is set, then NumberOfWorkers is required (and vice versa).
* MaxCapacity and NumberOfWorkers must both be at least 1.
When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.
The type of predefined worker that is allocated when a task of this transform runs. Accepts a value of Standard, G.1X, or G.2X.
*For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
* MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.
If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.
If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.
If WorkerType is set, then NumberOfWorkers is required (and vice versa).
* MaxCapacity and NumberOfWorkers must both be at least 1.
The number of workers of a defined workerType that are allocated when a task of the transform runs.
If WorkerType is set, then NumberOfWorkers is required (and vice versa).
The timeout in minutes of the machine learning transform.
* @public */ Timeout?: number | undefined; /** *The maximum number of times to retry after an MLTaskRun of the machine
* learning transform fails.
The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
* @public */ TransformEncryption?: TransformEncryption | undefined; } /** * @public */ export interface GetMLTransformsResponse { /** *A list of machine learning transforms.
* @public */ Transforms: MLTransform[] | undefined; /** *A pagination token, if more results are available.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface GetPartitionRequest { /** *The ID of the Data Catalog where the partition in question resides. If none is provided, * the Amazon Web Services account ID is used by default.
* @public */ CatalogId?: string | undefined; /** *The name of the catalog database where the partition resides.
* @public */ DatabaseName: string | undefined; /** *The name of the partition's table.
* @public */ TableName: string | undefined; /** *The values that define the partition.
* @public */ PartitionValues: string[] | undefined; /** *A structure containing the Lake Formation audit context.
* @public */ AuditContext?: AuditContext | undefined; } /** * @public */ export interface GetPartitionResponse { /** *The requested information, in the form of a Partition
* object.
The catalog ID where the table resides.
* @public */ CatalogId?: string | undefined; /** *Specifies the name of a database from which you want to retrieve partition indexes.
* @public */ DatabaseName: string | undefined; /** *Specifies the name of a table for which you want to retrieve the partition indexes.
* @public */ TableName: string | undefined; /** *A continuation token, included if this is a continuation call.
* @public */ NextToken?: string | undefined; } /** *A list of errors that can occur when registering partition indexes for an existing table.
*These errors give the details about why an index registration failed and provide a limited number of partitions in the response, so that you can fix the partitions at fault and try registering the index again. The most common set of errors that can occur are categorized as follows:
*EncryptedPartitionError: The partitions are encrypted.
*InvalidPartitionTypeDataError: The partition value doesn't match the data type for that partition column.
*MissingPartitionValueError: The partitions are encrypted.
*UnsupportedPartitionCharacterError: Characters inside the partition value are not supported. For example: U+0000 , U+0001, U+0002.
*InternalError: Any error which does not belong to other error codes.
*The error code for an error that occurred when registering partition indexes for an existing table.
* @public */ Code?: BackfillErrorCode | undefined; /** *A list of a limited number of partitions in the response.
* @public */ Partitions?: PartitionValueList[] | undefined; } /** *A partition key pair consisting of a name and a type.
* @public */ export interface KeySchemaElement { /** *The name of a partition key.
* @public */ Name: string | undefined; /** *The type of a partition key.
* @public */ Type: string | undefined; } /** *A descriptor for a partition index in a table.
* @public */ export interface PartitionIndexDescriptor { /** *The name of the partition index.
* @public */ IndexName: string | undefined; /** *A list of one or more keys, as KeySchemaElement structures, for the partition index.
The status of the partition index.
*The possible statuses are:
*CREATING: The index is being created. When an index is in a CREATING state, the index or its table cannot be deleted.
*ACTIVE: The index creation succeeds.
*FAILED: The index creation fails.
*DELETING: The index is deleted from the list of indexes.
*A list of errors that can occur when registering partition indexes for an existing table.
* @public */ BackfillErrors?: BackfillError[] | undefined; } /** * @public */ export interface GetPartitionIndexesResponse { /** *A list of index descriptors.
* @public */ PartitionIndexDescriptorList?: PartitionIndexDescriptor[] | undefined; /** *A continuation token, present if the current list segment is not the last.
* @public */ NextToken?: string | undefined; } /** *Defines a non-overlapping region of a table's partitions, allowing * multiple requests to be run in parallel.
* @public */ export interface Segment { /** *The zero-based index number of the segment. For example, if the total number of segments
* is 4, SegmentNumber values range from 0 through 3.
The total number of segments.
* @public */ TotalSegments: number | undefined; } /** * @public */ export interface GetPartitionsRequest { /** *The ID of the Data Catalog where the partitions in question reside. If none is provided, * the Amazon Web Services account ID is used by default.
* @public */ CatalogId?: string | undefined; /** *The name of the catalog database where the partitions reside.
* @public */ DatabaseName: string | undefined; /** *The name of the partitions' table.
* @public */ TableName: string | undefined; /** *An expression that filters the partitions to be returned.
*The expression uses SQL syntax similar to the SQL WHERE filter clause. The
* SQL statement parser JSQLParser parses the expression.
* Operators: The following are the operators that you can use in the
* Expression API call:
Checks whether the values of the two operands are equal; if yes, then the condition becomes * true.
*Example: Assume 'variable a' holds 10 and 'variable b' holds 20.
*(a = b) is not true.
*Checks whether the values of two operands are equal; if the values are not equal, * then the condition becomes true.
*Example: (a < > b) is true.
*Checks whether the value of the left operand is greater than the value of the right * operand; if yes, then the condition becomes true.
*Example: (a > b) is not true.
*Checks whether the value of the left operand is less than the value of the right * operand; if yes, then the condition becomes true.
*Example: (a < b) is true.
*Checks whether the value of the left operand is greater than or equal to the value * of the right operand; if yes, then the condition becomes true.
*Example: (a >= b) is not true.
*Checks whether the value of the left operand is less than or equal to the value of * the right operand; if yes, then the condition becomes true.
*Example: (a <= b) is true.
*Logical operators.
** Supported Partition Key Types: The following are the supported * partition keys.
*
* string
*
* date
*
* timestamp
*
* int
*
* bigint
*
* long
*
* tinyint
*
* smallint
*
* decimal
*
If an type is encountered that is not valid, an exception is thrown.
*The following list shows the valid operators on each type. When you define a crawler, the
* partitionKey type is created as a STRING, to be compatible with the catalog
* partitions.
* Sample API Call:
* @public */ Expression?: string | undefined; /** *A continuation token, if this is not the first call to retrieve * these partitions.
* @public */ NextToken?: string | undefined; /** *The segment of the table's partitions to scan in this request.
* @public */ Segment?: Segment | undefined; /** *The maximum number of partitions to return in a single response.
* @public */ MaxResults?: number | undefined; /** *When true, specifies not returning the partition column schema. Useful when you are interested only in other partition attributes such as partition values or location. This approach avoids the problem of a large response by not returning duplicate data.
* @public */ ExcludeColumnSchema?: boolean | undefined; /** *The transaction ID at which to read the partition contents.
* @public */ TransactionId?: string | undefined; /** *The time as of when to read the partition contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.
A structure containing the Lake Formation audit context.
* @public */ AuditContext?: AuditContext | undefined; } /** * @public */ export interface GetPartitionsResponse { /** *A list of requested partitions.
* @public */ Partitions?: Partition[] | undefined; /** *A continuation token, if the returned list of partitions does not include the last * one.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface GetPlanRequest { /** *The list of mappings from a source table to target tables.
* @public */ Mapping: MappingEntry[] | undefined; /** *The source table.
* @public */ Source: CatalogEntry | undefined; /** *The target tables.
* @public */ Sinks?: CatalogEntry[] | undefined; /** *The parameters for the mapping.
* @public */ Location?: Location | undefined; /** *The programming language of the code to perform the mapping.
* @public */ Language?: Language | undefined; /** *A map to hold additional optional key-value parameters.
*Currently, these key-value pairs are supported:
*
* inferSchema — Specifies whether to set inferSchema to true or false for the default script generated by an Glue job. For example, to set inferSchema to true, pass the following key value pair:
* --additional-plan-options-map '\{"inferSchema":"true"\}'
*
A Python script to perform the mapping.
* @public */ PythonScript?: string | undefined; /** *The Scala code to perform the mapping.
* @public */ ScalaCode?: string | undefined; } /** * @public */ export interface GetRegistryInput { /** *This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
* @public */ RegistryId: RegistryId | undefined; } /** * @public */ export interface GetRegistryResponse { /** *The name of the registry.
* @public */ RegistryName?: string | undefined; /** *The Amazon Resource Name (ARN) of the registry.
* @public */ RegistryArn?: string | undefined; /** *A description of the registry.
* @public */ Description?: string | undefined; /** *The status of the registry.
* @public */ Status?: RegistryStatus | undefined; /** *The date and time the registry was created.
* @public */ CreatedTime?: string | undefined; /** *The date and time the registry was updated.
* @public */ UpdatedTime?: string | undefined; } /** * @public */ export interface GetResourcePoliciesRequest { /** *A continuation token, if this is a continuation request.
* @public */ NextToken?: string | undefined; /** *The maximum size of a list to return.
* @public */ MaxResults?: number | undefined; } /** *A structure for returning a resource policy.
* @public */ export interface GluePolicy { /** *Contains the requested policy document, in JSON format.
* @public */ PolicyInJson?: string | undefined; /** *Contains the hash value associated with this policy.
* @public */ PolicyHash?: string | undefined; /** *The date and time at which the policy was created.
* @public */ CreateTime?: Date | undefined; /** *The date and time at which the policy was last updated.
* @public */ UpdateTime?: Date | undefined; } /** * @public */ export interface GetResourcePoliciesResponse { /** *A list of the individual resource policies and the account-level resource policy.
* @public */ GetResourcePoliciesResponseList?: GluePolicy[] | undefined; /** *A continuation token, if the returned list does not contain the last resource policy available.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface GetResourcePolicyRequest { /** *The ARN of the Glue resource for which to retrieve the resource policy. If not
* supplied, the Data Catalog resource policy is returned. Use GetResourcePolicies
* to view all existing resource policies. For more information see Specifying Glue Resource ARNs.
*
Contains the requested policy document, in JSON format.
* @public */ PolicyInJson?: string | undefined; /** *Contains the hash value associated with this policy.
* @public */ PolicyHash?: string | undefined; /** *The date and time at which the policy was created.
* @public */ CreateTime?: Date | undefined; /** *The date and time at which the policy was last updated.
* @public */ UpdateTime?: Date | undefined; } /** * @public */ export interface GetSchemaInput { /** *This is a wrapper structure to contain schema identity fields. The structure contains:
*SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
The name of the registry.
* @public */ RegistryName?: string | undefined; /** *The Amazon Resource Name (ARN) of the registry.
* @public */ RegistryArn?: string | undefined; /** *The name of the schema.
* @public */ SchemaName?: string | undefined; /** *The Amazon Resource Name (ARN) of the schema.
* @public */ SchemaArn?: string | undefined; /** *A description of schema if specified when created
* @public */ Description?: string | undefined; /** *The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
The compatibility mode of the schema.
* @public */ Compatibility?: Compatibility | undefined; /** *The version number of the checkpoint (the last time the compatibility mode was changed).
* @public */ SchemaCheckpoint?: number | undefined; /** *The latest version of the schema associated with the returned schema definition.
* @public */ LatestSchemaVersion?: number | undefined; /** *The next version of the schema associated with the returned schema definition.
* @public */ NextSchemaVersion?: number | undefined; /** *The status of the schema.
* @public */ SchemaStatus?: SchemaStatus | undefined; /** *The date and time the schema was created.
* @public */ CreatedTime?: string | undefined; /** *The date and time the schema was updated.
* @public */ UpdatedTime?: string | undefined; } /** * @public */ export interface GetSchemaByDefinitionInput { /** *This is a wrapper structure to contain schema identity fields. The structure contains:
*SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaId$SchemaName: The name of the schema. One of SchemaArn or SchemaName has to be provided.
The definition of the schema for which schema details are required.
* @public */ SchemaDefinition: string | undefined; } /** * @public */ export interface GetSchemaByDefinitionResponse { /** *The schema ID of the schema version.
* @public */ SchemaVersionId?: string | undefined; /** *The Amazon Resource Name (ARN) of the schema.
* @public */ SchemaArn?: string | undefined; /** *The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
The status of the schema version.
* @public */ Status?: SchemaVersionStatus | undefined; /** *The date and time the schema was created.
* @public */ CreatedTime?: string | undefined; } /** *A structure containing the schema version information.
* @public */ export interface SchemaVersionNumber { /** *The latest version available for the schema.
* @public */ LatestVersion?: boolean | undefined; /** *The version number of the schema.
* @public */ VersionNumber?: number | undefined; } /** * @public */ export interface GetSchemaVersionInput { /** *This is a wrapper structure to contain schema identity fields. The structure contains:
*SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
The SchemaVersionId of the schema version. This field is required for fetching by schema ID. Either this or the SchemaId wrapper has to be provided.
The version number of the schema.
* @public */ SchemaVersionNumber?: SchemaVersionNumber | undefined; } /** * @public */ export interface GetSchemaVersionResponse { /** *The SchemaVersionId of the schema version.
The schema definition for the schema ID.
* @public */ SchemaDefinition?: string | undefined; /** *The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
The Amazon Resource Name (ARN) of the schema.
* @public */ SchemaArn?: string | undefined; /** *The version number of the schema.
* @public */ VersionNumber?: number | undefined; /** *The status of the schema version.
* @public */ Status?: SchemaVersionStatus | undefined; /** *The date and time the schema version was created.
* @public */ CreatedTime?: string | undefined; } /** * @public */ export interface GetSchemaVersionsDiffInput { /** *This is a wrapper structure to contain schema identity fields. The structure contains:
*SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaId$SchemaName: The name of the schema. One of SchemaArn or SchemaName has to be provided.
The first of the two schema versions to be compared.
* @public */ FirstSchemaVersionNumber: SchemaVersionNumber | undefined; /** *The second of the two schema versions to be compared.
* @public */ SecondSchemaVersionNumber: SchemaVersionNumber | undefined; /** *Refers to SYNTAX_DIFF, which is the currently supported diff type.
The difference between schemas as a string in JsonPatch format.
* @public */ Diff?: string | undefined; } /** * @public */ export interface GetSecurityConfigurationRequest { /** *The name of the security configuration to retrieve.
* @public */ Name: string | undefined; } /** *Specifies a security configuration.
* @public */ export interface SecurityConfiguration { /** *The name of the security configuration.
* @public */ Name?: string | undefined; /** *The time at which this security configuration was created.
* @public */ CreatedTimeStamp?: Date | undefined; /** *The encryption configuration associated with this security configuration.
* @public */ EncryptionConfiguration?: EncryptionConfiguration | undefined; } /** * @public */ export interface GetSecurityConfigurationResponse { /** *The requested security configuration.
* @public */ SecurityConfiguration?: SecurityConfiguration | undefined; } /** * @public */ export interface GetSecurityConfigurationsRequest { /** *The maximum number of results to return.
* @public */ MaxResults?: number | undefined; /** *A continuation token, if this is a continuation call.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface GetSecurityConfigurationsResponse { /** *A list of security configurations.
* @public */ SecurityConfigurations?: SecurityConfiguration[] | undefined; /** *A continuation token, if there are more security * configurations to return.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface GetSessionRequest { /** *The ID of the session.
* @public */ Id: string | undefined; /** *The origin of the request.
* @public */ RequestOrigin?: string | undefined; } /** * @public */ export interface GetSessionResponse { /** *The session object is returned in the response.
* @public */ Session?: Session | undefined; } /** * @public */ export interface GetStatementRequest { /** *The Session ID of the statement.
* @public */ SessionId: string | undefined; /** *The Id of the statement.
* @public */ Id: number | undefined; /** *The origin of the request.
* @public */ RequestOrigin?: string | undefined; } /** *The code execution output in JSON format.
* @public */ export interface StatementOutputData { /** *The code execution output in text format.
* @public */ TextPlain?: string | undefined; } /** *The code execution output in JSON format.
* @public */ export interface StatementOutput { /** *The code execution output.
* @public */ Data?: StatementOutputData | undefined; /** *The execution count of the output.
* @public */ ExecutionCount?: number | undefined; /** *The status of the code execution output.
* @public */ Status?: StatementState | undefined; /** *The name of the error in the output.
* @public */ ErrorName?: string | undefined; /** *The error value of the output.
* @public */ ErrorValue?: string | undefined; /** *The traceback of the output.
* @public */ Traceback?: string[] | undefined; } /** *The statement or request for a particular action to occur in a session.
* @public */ export interface Statement { /** *The ID of the statement.
* @public */ Id?: number | undefined; /** *The execution code of the statement.
* @public */ Code?: string | undefined; /** *The state while request is actioned.
* @public */ State?: StatementState | undefined; /** *The output in JSON.
* @public */ Output?: StatementOutput | undefined; /** *The code execution progress.
* @public */ Progress?: number | undefined; /** *The unix time and date that the job definition was started.
* @public */ StartedOn?: number | undefined; /** *The unix time and date that the job definition was completed.
* @public */ CompletedOn?: number | undefined; } /** * @public */ export interface GetStatementResponse { /** *Returns the statement.
* @public */ Statement?: Statement | undefined; } /** * @public */ export interface GetTableRequest { /** *The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account * ID is used by default.
* @public */ CatalogId?: string | undefined; /** *The name of the database in the catalog in which the table resides. * For Hive compatibility, this name is entirely lowercase.
* @public */ DatabaseName: string | undefined; /** *The name of the table for which to retrieve the definition. For Hive * compatibility, this name is entirely lowercase.
* @public */ Name: string | undefined; /** *The transaction ID at which to read the table contents.
* @public */ TransactionId?: string | undefined; /** *The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.
A structure containing the Lake Formation audit context.
* @public */ AuditContext?: AuditContext | undefined; /** *Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.
* @public */ IncludeStatusDetails?: boolean | undefined; } /** *A table that points to an entity outside the Glue Data Catalog.
* @public */ export interface FederatedTable { /** *A unique identifier for the federated table.
* @public */ Identifier?: string | undefined; /** *A unique identifier for the federated database.
* @public */ DatabaseIdentifier?: string | undefined; /** *The name of the connection to the external metastore.
* @public */ ConnectionName?: string | undefined; /** *The type of connection used to access the federated table, specifying the protocol or method for connecting to the external data source.
* @public */ ConnectionType?: string | undefined; } /** *A structure that contains information for an analytical engine to validate a view, prior to persisting the view metadata. Used in the case of direct UpdateTable or CreateTable API calls.
The dialect of the query engine.
* @public */ Dialect?: ViewDialect | undefined; /** *The version of the dialect of the query engine. For example, 3.0.0.
* @public */ DialectVersion?: string | undefined; /** *The SELECT query that defines the view, as provided by the customer.
The time of the last update.
* @public */ UpdateTime?: Date | undefined; /** *The state of the validation.
* @public */ State?: ResourceState | undefined; /** *An error associated with the validation.
* @public */ Error?: ErrorDetail | undefined; } /** *A structure that contains the dialect of the view, and the query that defines the view.
* @public */ export interface ViewRepresentation { /** *The dialect of the query engine.
* @public */ Dialect?: ViewDialect | undefined; /** *The version of the dialect of the query engine. For example, 3.0.0.
* @public */ DialectVersion?: string | undefined; /** *The SELECT query provided by the customer during CREATE VIEW DDL. This SQL is not used during a query on a view (ViewExpandedText is used instead). ViewOriginalText is used for cases like SHOW CREATE VIEW where users want to see the original DDL command that created the view.
The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform ViewOriginalText to ViewExpandedText. For example:
Fully qualified identifiers: SELECT * from table1 -> SELECT * from db1.table1
*
The name of the connection to be used to validate the specific representation of the view.
* @public */ ValidationConnection?: string | undefined; /** *Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.
* @public */ IsStale?: boolean | undefined; } /** *A structure containing details for representations.
* @public */ export interface ViewDefinition { /** *You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.
* @public */ IsProtected?: boolean | undefined; /** *The definer of a view in SQL.
* @public */ Definer?: string | undefined; /** *The ID value that identifies this view's version. For materialized views, the version ID is the Apache Iceberg table's snapshot ID.
* @public */ ViewVersionId?: number | undefined; /** *The version ID of the Apache Iceberg table.
* @public */ ViewVersionToken?: string | undefined; /** *Auto refresh interval in seconds for the materialized view. If not specified, the view will * not automatically refresh.
* @public */ RefreshSeconds?: number | undefined; /** *Sets the method used for the most recent refresh.
* @public */ LastRefreshType?: LastRefreshType | undefined; /** *A list of table Amazon Resource Names (ARNs).
* @public */ SubObjects?: string[] | undefined; /** *List of the Apache Iceberg table versions referenced by the materialized view.
* @public */ SubObjectVersionIds?: number[] | undefined; /** *A list of representations.
* @public */ Representations?: ViewRepresentation[] | undefined; } /** * @public */ export interface GetTableOptimizerRequest { /** *The Catalog ID of the table.
* @public */ CatalogId: string | undefined; /** *The name of the database in the catalog in which the table resides.
* @public */ DatabaseName: string | undefined; /** *The name of the table.
* @public */ TableName: string | undefined; /** *The type of table optimizer.
* @public */ Type: TableOptimizerType | undefined; } /** * @public */ export interface GetTableOptimizerResponse { /** *The Catalog ID of the table.
* @public */ CatalogId?: string | undefined; /** *The name of the database in the catalog in which the table resides.
* @public */ DatabaseName?: string | undefined; /** *The name of the table.
* @public */ TableName?: string | undefined; /** *The optimizer associated with the specified table.
* @public */ TableOptimizer?: TableOptimizer | undefined; } /** * @public */ export interface GetTablesRequest { /** *The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account * ID is used by default.
* @public */ CatalogId?: string | undefined; /** *The database in the catalog whose tables to list. For Hive * compatibility, this name is entirely lowercase.
* @public */ DatabaseName: string | undefined; /** *A regular expression pattern. If present, only those tables * whose names match the pattern are returned.
* @public */ Expression?: string | undefined; /** *A continuation token, included if this is a continuation call.
* @public */ NextToken?: string | undefined; /** *The maximum number of tables to return in a single response.
* @public */ MaxResults?: number | undefined; /** *The transaction ID at which to read the table contents.
* @public */ TransactionId?: string | undefined; /** *The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.
A structure containing the Lake Formation audit context.
* @public */ AuditContext?: AuditContext | undefined; /** *Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.
* @public */ IncludeStatusDetails?: boolean | undefined; /** * Specifies the table fields returned by the GetTables call. This parameter doesn’t accept an empty list. The request must include NAME.
The following are the valid combinations of values:
*
* NAME - Names of all tables in the database.
* NAME, TABLE_TYPE - Names of all tables and the table types.
The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account * ID is used by default.
* @public */ CatalogId?: string | undefined; /** *The database in the catalog in which the table resides. For Hive * compatibility, this name is entirely lowercase.
* @public */ DatabaseName: string | undefined; /** *The name of the table. For Hive compatibility, * this name is entirely lowercase.
* @public */ TableName: string | undefined; /** *The ID value of the table version to be retrieved. A VersionID is a string representation of an integer. Each version is incremented by 1.
A structure containing the Lake Formation audit context.
* @public */ AuditContext?: AuditContext | undefined; } /** * @public */ export interface GetTableVersionsRequest { /** *The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account * ID is used by default.
* @public */ CatalogId?: string | undefined; /** *The database in the catalog in which the table resides. For Hive * compatibility, this name is entirely lowercase.
* @public */ DatabaseName: string | undefined; /** *The name of the table. For Hive * compatibility, this name is entirely lowercase.
* @public */ TableName: string | undefined; /** *A continuation token, if this is not the first call.
* @public */ NextToken?: string | undefined; /** *The maximum number of table versions to return in one response.
* @public */ MaxResults?: number | undefined; /** *A structure containing the Lake Formation audit context.
* @public */ AuditContext?: AuditContext | undefined; } /** * @public */ export interface GetTagsRequest { /** *The Amazon Resource Name (ARN) of the resource for which to retrieve tags.
* @public */ ResourceArn: string | undefined; } /** * @public */ export interface GetTagsResponse { /** *The requested tags.
* @public */ Tags?: RecordThe name of the trigger to retrieve.
* @public */ Name: string | undefined; } /** * @public */ export interface GetTriggerResponse { /** *The requested trigger definition.
* @public */ Trigger?: Trigger | undefined; } /** * @public */ export interface GetTriggersRequest { /** *A continuation token, if this is a continuation call.
* @public */ NextToken?: string | undefined; /** *The name of the job to retrieve triggers for. The trigger that can start this job is * returned, and if there is no such trigger, all triggers are returned.
* @public */ DependentJobName?: string | undefined; /** *The maximum size of the response.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface GetTriggersResponse { /** *A list of triggers for the specified job.
* @public */ Triggers?: Trigger[] | undefined; /** *A continuation token, if not all the requested triggers * have yet been returned.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface GetUnfilteredPartitionMetadataRequest { /** *Specified only if the base tables belong to a different Amazon Web Services Region.
* @public */ Region?: string | undefined; /** *The catalog ID where the partition resides.
* @public */ CatalogId: string | undefined; /** *(Required) Specifies the name of a database that contains the partition.
* @public */ DatabaseName: string | undefined; /** *(Required) Specifies the name of a table that contains the partition.
* @public */ TableName: string | undefined; /** *(Required) A list of partition key values.
* @public */ PartitionValues: string[] | undefined; /** *A structure containing Lake Formation audit context information.
* @public */ AuditContext?: AuditContext | undefined; /** *(Required) A list of supported permission types.
* @public */ SupportedPermissionTypes: PermissionType[] | undefined; /** *A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.
* @public */ QuerySessionContext?: QuerySessionContext | undefined; } /** * @public */ export interface GetUnfilteredPartitionMetadataResponse { /** *A Partition object containing the partition metadata.
* @public */ Partition?: Partition | undefined; /** *A list of column names that the user has been granted access to.
* @public */ AuthorizedColumns?: string[] | undefined; /** *A Boolean value that indicates whether the partition location is registered * with Lake Formation.
* @public */ IsRegisteredWithLakeFormation?: boolean | undefined; } /** * @public */ export interface GetUnfilteredPartitionsMetadataRequest { /** *Specified only if the base tables belong to a different Amazon Web Services Region.
* @public */ Region?: string | undefined; /** *The ID of the Data Catalog where the partitions in question reside. If none is provided, * the AWS account ID is used by default.
* @public */ CatalogId: string | undefined; /** *The name of the catalog database where the partitions reside.
* @public */ DatabaseName: string | undefined; /** *The name of the table that contains the partition.
* @public */ TableName: string | undefined; /** *An expression that filters the partitions to be returned.
*The expression uses SQL syntax similar to the SQL WHERE filter clause. The
* SQL statement parser JSQLParser parses the expression.
* Operators: The following are the operators that you can use in the
* Expression API call:
Checks whether the values of the two operands are equal; if yes, then the condition becomes * true.
*Example: Assume 'variable a' holds 10 and 'variable b' holds 20.
*(a = b) is not true.
*Checks whether the values of two operands are equal; if the values are not equal, * then the condition becomes true.
*Example: (a < > b) is true.
*Checks whether the value of the left operand is greater than the value of the right * operand; if yes, then the condition becomes true.
*Example: (a > b) is not true.
*Checks whether the value of the left operand is less than the value of the right * operand; if yes, then the condition becomes true.
*Example: (a < b) is true.
*Checks whether the value of the left operand is greater than or equal to the value * of the right operand; if yes, then the condition becomes true.
*Example: (a >= b) is not true.
*Checks whether the value of the left operand is less than or equal to the value of * the right operand; if yes, then the condition becomes true.
*Example: (a <= b) is true.
*Logical operators.
** Supported Partition Key Types: The following are the supported * partition keys.
*
* string
*
* date
*
* timestamp
*
* int
*
* bigint
*
* long
*
* tinyint
*
* smallint
*
* decimal
*
If an type is encountered that is not valid, an exception is thrown.
* @public */ Expression?: string | undefined; /** *A structure containing Lake Formation audit context information.
* @public */ AuditContext?: AuditContext | undefined; /** *A list of supported permission types.
* @public */ SupportedPermissionTypes: PermissionType[] | undefined; /** *A continuation token, if this is not the first call to retrieve * these partitions.
* @public */ NextToken?: string | undefined; /** *The segment of the table's partitions to scan in this request.
* @public */ Segment?: Segment | undefined; /** *The maximum number of partitions to return in a single response.
* @public */ MaxResults?: number | undefined; /** *A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.
* @public */ QuerySessionContext?: QuerySessionContext | undefined; } /** *A partition that contains unfiltered metadata.
* @public */ export interface UnfilteredPartition { /** *The partition object.
* @public */ Partition?: Partition | undefined; /** *The list of columns the user has permissions to access.
* @public */ AuthorizedColumns?: string[] | undefined; /** *A Boolean value indicating that the partition location is registered with Lake Formation.
* @public */ IsRegisteredWithLakeFormation?: boolean | undefined; } /** * @public */ export interface GetUnfilteredPartitionsMetadataResponse { /** *A list of requested partitions.
* @public */ UnfilteredPartitions?: UnfilteredPartition[] | undefined; /** *A continuation token, if the returned list of partitions does not include the last * one.
* @public */ NextToken?: string | undefined; } /** *A structure specifying the dialect and dialect version used by the query engine.
* @public */ export interface SupportedDialect { /** *The dialect of the query engine.
* @public */ Dialect?: ViewDialect | undefined; /** *The version of the dialect of the query engine. For example, 3.0.0.
* @public */ DialectVersion?: string | undefined; } /** * @public */ export interface GetUnfilteredTableMetadataRequest { /** *Specified only if the base tables belong to a different Amazon Web Services Region.
* @public */ Region?: string | undefined; /** *The catalog ID where the table resides.
* @public */ CatalogId: string | undefined; /** *(Required) Specifies the name of a database that contains the table.
* @public */ DatabaseName: string | undefined; /** *(Required) Specifies the name of a table for which you are requesting metadata.
* @public */ Name: string | undefined; /** *A structure containing Lake Formation audit context information.
* @public */ AuditContext?: AuditContext | undefined; /** *Indicates the level of filtering a third-party analytical engine is capable of enforcing when calling the GetUnfilteredTableMetadata API operation. Accepted values are:
* COLUMN_PERMISSION - Column permissions ensure that users can access only specific columns in the table. If there are particular columns contain sensitive data, data lake administrators can define column filters that exclude access to specific columns.
* CELL_FILTER_PERMISSION - Cell-level filtering combines column filtering (include or exclude columns) and row filter expressions to restrict access to individual elements in the table.
* NESTED_PERMISSION - Nested permissions combines cell-level filtering and nested column filtering to restrict access to columns and/or nested columns in specific rows based on row filter expressions.
* NESTED_CELL_PERMISSION - Nested cell permissions combines nested permission with nested cell-level filtering. This allows different subsets of nested columns to be restricted based on an array of row filter expressions.
Note: Each of these permission types follows a hierarchical order where each subsequent permission type includes all permission of the previous type.
*Important: If you provide a supported permission type that doesn't match the user's level of permissions on the table, then Lake Formation raises an exception. For example, if the third-party engine calling the GetUnfilteredTableMetadata operation can enforce only column-level filtering, and the user has nested cell filtering applied on the table, Lake Formation throws an exception, and will not return unfiltered table metadata and data access credentials.
The resource ARN of the view.
* @public */ ParentResourceArn?: string | undefined; /** *The resource ARN of the root view in a chain of nested views.
* @public */ RootResourceArn?: string | undefined; /** *A structure specifying the dialect and dialect version used by the query engine.
* @public */ SupportedDialect?: SupportedDialect | undefined; /** *The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.
* @public */ Permissions?: Permission[] | undefined; /** *A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.
* @public */ QuerySessionContext?: QuerySessionContext | undefined; } /** *A filter that uses both column-level and row-level filtering.
* @public */ export interface ColumnRowFilter { /** *A string containing the name of the column.
* @public */ ColumnName?: string | undefined; /** *A string containing the row-level filter expression.
* @public */ RowFilterExpression?: string | undefined; } /** * @public */ export interface GetUsageProfileRequest { /** *The name of the usage profile to retrieve.
* @public */ Name: string | undefined; } /** * @public */ export interface GetUsageProfileResponse { /** *The name of the usage profile.
* @public */ Name?: string | undefined; /** *A description of the usage profile.
* @public */ Description?: string | undefined; /** *A ProfileConfiguration object specifying the job and session values for the profile.
The date and time when the usage profile was created.
* @public */ CreatedOn?: Date | undefined; /** *The date and time when the usage profile was last modified.
* @public */ LastModifiedOn?: Date | undefined; } /** * @public */ export interface GetUserDefinedFunctionRequest { /** *The ID of the Data Catalog where the function to be retrieved is located. If none is * provided, the Amazon Web Services account ID is used by default.
* @public */ CatalogId?: string | undefined; /** *The name of the catalog database where the function is located.
* @public */ DatabaseName: string | undefined; /** *The name of the function.
* @public */ FunctionName: string | undefined; } /** *Represents the equivalent of a Hive user-defined function
* (UDF) definition.
The name of the function.
* @public */ FunctionName?: string | undefined; /** *The name of the catalog database that contains the function.
* @public */ DatabaseName?: string | undefined; /** *The Java class that contains the function code.
* @public */ ClassName?: string | undefined; /** *The owner of the function.
* @public */ OwnerName?: string | undefined; /** *The type of the function.
* @public */ FunctionType?: FunctionType | undefined; /** *The owner type.
* @public */ OwnerType?: PrincipalType | undefined; /** *The time at which the function was created.
* @public */ CreateTime?: Date | undefined; /** *The resource URIs for the function.
* @public */ ResourceUris?: ResourceUri[] | undefined; /** *The ID of the Data Catalog in which the function resides.
* @public */ CatalogId?: string | undefined; } /** * @public */ export interface GetUserDefinedFunctionResponse { /** *The requested function definition.
* @public */ UserDefinedFunction?: UserDefinedFunction | undefined; } /** * @public */ export interface GetUserDefinedFunctionsRequest { /** *The ID of the Data Catalog where the functions to be retrieved are located. If none is * provided, the Amazon Web Services account ID is used by default.
* @public */ CatalogId?: string | undefined; /** *The name of the catalog database where the functions are located. If none is provided, functions from all the * databases across the catalog will be returned.
* @public */ DatabaseName?: string | undefined; /** *An optional function-name pattern string that filters the function * definitions returned.
* @public */ Pattern: string | undefined; /** *An optional function-type pattern string that filters the function * definitions returned from Amazon Redshift Federated Permissions Catalog.
*Specify a value of REGULAR_FUNCTION or STORED_PROCEDURE.
* The STORED_PROCEDURE function type is only compatible with
* Amazon Redshift Federated Permissions Catalog.
*
A continuation token, if this is a continuation call.
* @public */ NextToken?: string | undefined; /** *The maximum number of functions to return in one response.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface GetUserDefinedFunctionsResponse { /** *A list of requested function definitions.
* @public */ UserDefinedFunctions?: UserDefinedFunction[] | undefined; /** *A continuation token, if the list of functions returned does * not include the last requested function.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface GetWorkflowRequest { /** *The name of the workflow to retrieve.
* @public */ Name: string | undefined; /** *Specifies whether to include a graph when returning the workflow resource metadata.
* @public */ IncludeGraph?: boolean | undefined; } /** * @public */ export interface GetWorkflowResponse { /** *The resource metadata for the workflow.
* @public */ Workflow?: Workflow | undefined; } /** * @public */ export interface GetWorkflowRunRequest { /** *Name of the workflow being run.
* @public */ Name: string | undefined; /** *The ID of the workflow run.
* @public */ RunId: string | undefined; /** *Specifies whether to include the workflow graph in response or not.
* @public */ IncludeGraph?: boolean | undefined; } /** * @public */ export interface GetWorkflowRunResponse { /** *The requested workflow run metadata.
* @public */ Run?: WorkflowRun | undefined; } /** * @public */ export interface GetWorkflowRunPropertiesRequest { /** *Name of the workflow which was run.
* @public */ Name: string | undefined; /** *The ID of the workflow run whose run properties should be returned.
* @public */ RunId: string | undefined; } /** * @public */ export interface GetWorkflowRunPropertiesResponse { /** *The workflow run properties which were set during the specified run.
* @public */ RunProperties?: RecordName of the workflow whose metadata of runs should be returned.
* @public */ Name: string | undefined; /** *Specifies whether to include the workflow graph in response or not.
* @public */ IncludeGraph?: boolean | undefined; /** *The maximum size of the response.
* @public */ NextToken?: string | undefined; /** *The maximum number of workflow runs to be included in the response.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface GetWorkflowRunsResponse { /** *A list of workflow run metadata objects.
* @public */ Runs?: WorkflowRun[] | undefined; /** *A continuation token, if not all requested workflow runs have been returned.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ImportCatalogToGlueRequest { /** *The ID of the catalog to import. Currently, this should be the Amazon Web Services account ID.
* @public */ CatalogId?: string | undefined; } /** * @public */ export interface ImportCatalogToGlueResponse { } /** * @public */ export interface ListBlueprintsRequest { /** *A continuation token, if this is a continuation request.
* @public */ NextToken?: string | undefined; /** *The maximum size of a list to return.
* @public */ MaxResults?: number | undefined; /** *Filters the list by an Amazon Web Services resource tag.
* @public */ Tags?: RecordList of names of blueprints in the account.
* @public */ Blueprints?: string[] | undefined; /** *A continuation token, if not all blueprint names have been returned.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListColumnStatisticsTaskRunsRequest { /** *The maximum size of the response.
* @public */ MaxResults?: number | undefined; /** *A continuation token, if this is a continuation call.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListColumnStatisticsTaskRunsResponse { /** *A list of column statistics task run IDs.
* @public */ ColumnStatisticsTaskRunIds?: string[] | undefined; /** *A continuation token, if not all task run IDs have yet been returned.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListConnectionTypesRequest { /** *The maximum number of results to return.
* @public */ MaxResults?: number | undefined; /** *A continuation token, if this is a continuation call.
* @public */ NextToken?: string | undefined; } /** *Represents a variant of a connection type in Glue. Connection type variants provide specific configurations and behaviors * for different implementations of the same general connection type.
* @public */ export interface ConnectionTypeVariant { /** *The unique identifier for the connection type variant. This name is used internally to identify the specific variant of a connection type. *
* @public */ ConnectionTypeVariantName?: string | undefined; /** *The human-readable name for the connection type variant that is displayed in the Glue console.
* @public */ DisplayName?: string | undefined; /** *A detailed description of the connection type variant, including its purpose, use cases, and any specific configuration requirements.
* @public */ Description?: string | undefined; /** *The URL of the logo associated with a connection type variant.
* @public */ LogoUrl?: string | undefined; } /** *Brief information about a supported connection type returned by the ListConnectionTypes API.
The name of the connection type.
* @public */ ConnectionType?: ConnectionType | undefined; /** *The human-readable name for the connection type that is displayed in the Glue console.
* @public */ DisplayName?: string | undefined; /** *The name of the vendor or provider that created or maintains this connection type.
* @public */ Vendor?: string | undefined; /** *A description of the connection type.
* @public */ Description?: string | undefined; /** *A list of categories that this connection type belongs to. Categories help users filter and find appropriate connection types based on their * use cases.
* @public */ Categories?: string[] | undefined; /** *The supported authentication types, data interface types (compute environments), and data operations of the connector.
* @public */ Capabilities?: Capabilities | undefined; /** *The URL of the logo associated with a connection type.
* @public */ LogoUrl?: string | undefined; /** *A list of variants available for this connection type. Different variants may provide specialized configurations for specific use cases or * implementations of the same general connection type.
* @public */ ConnectionTypeVariants?: ConnectionTypeVariant[] | undefined; } /** * @public */ export interface ListConnectionTypesResponse { /** *A list of ConnectionTypeBrief objects containing brief information about the supported connection types.
A continuation token, if the current list segment is not the last.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListCrawlersRequest { /** *The maximum size of a list to return.
* @public */ MaxResults?: number | undefined; /** *A continuation token, if this is a continuation request.
* @public */ NextToken?: string | undefined; /** *Specifies to return only these tagged resources.
* @public */ Tags?: RecordThe names of all crawlers in the account, or the crawlers with the specified tags.
* @public */ CrawlerNames?: string[] | undefined; /** *A continuation token, if the returned list does not contain the * last metric available.
* @public */ NextToken?: string | undefined; } /** *A list of fields, comparators and value that you can use to filter the crawler runs for a specified crawler.
* @public */ export interface CrawlsFilter { /** *A key used to filter the crawler runs for a specified crawler. Valid values for each of the field names are:
*
* CRAWL_ID: A string representing the UUID identifier for a crawl.
* STATE: A string representing the state of the crawl.
* START_TIME and END_TIME: The epoch timestamp in milliseconds.
* DPU_HOUR: The number of data processing unit (DPU) hours used for the crawl.
A defined comparator that operates on the value. The available operators are:
*
* GT: Greater than.
* GE: Greater than or equal to.
* LT: Less than.
* LE: Less than or equal to.
* EQ: Equal to.
* NE: Not equal to.
The value provided for comparison on the crawl field.
* @public */ FieldValue?: string | undefined; } /** * @public */ export interface ListCrawlsRequest { /** *The name of the crawler whose runs you want to retrieve.
* @public */ CrawlerName: string | undefined; /** *The maximum number of results to return. The default is 20, and maximum is 100.
* @public */ MaxResults?: number | undefined; /** *Filters the crawls by the criteria you specify in a list of CrawlsFilter objects.
A continuation token, if this is a continuation call.
* @public */ NextToken?: string | undefined; } /** *Contains the information for a run of a crawler.
* @public */ export interface CrawlerHistory { /** *A UUID identifier for each crawl.
* @public */ CrawlId?: string | undefined; /** *The state of the crawl.
* @public */ State?: CrawlerHistoryState | undefined; /** *The date and time on which the crawl started.
* @public */ StartTime?: Date | undefined; /** *The date and time on which the crawl ended.
* @public */ EndTime?: Date | undefined; /** *A run summary for the specific crawl in JSON. Contains the catalog tables and partitions that were added, updated, or deleted.
* @public */ Summary?: string | undefined; /** *If an error occurred, the error message associated with the crawl.
* @public */ ErrorMessage?: string | undefined; /** *The log group associated with the crawl.
* @public */ LogGroup?: string | undefined; /** *The log stream associated with the crawl.
* @public */ LogStream?: string | undefined; /** *The prefix for a CloudWatch message about this crawl.
* @public */ MessagePrefix?: string | undefined; /** *The number of data processing units (DPU) used in hours for the crawl.
* @public */ DPUHour?: number | undefined; } /** * @public */ export interface ListCrawlsResponse { /** *A list of CrawlerHistory objects representing the crawl runs that meet your criteria.
A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListCustomEntityTypesRequest { /** *A paginated token to offset the results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return.
* @public */ MaxResults?: number | undefined; /** *A list of key-value pair tags.
* @public */ Tags?: RecordA list of CustomEntityType objects representing custom patterns.
A pagination token, if more results are available.
* @public */ NextToken?: string | undefined; } /** *Criteria used to return data quality results.
* @public */ export interface DataQualityResultFilterCriteria { /** *Filter results by the specified data source. For example, retrieving all results for an Glue table.
* @public */ DataSource?: DataSource | undefined; /** *Filter results by the specified job name.
* @public */ JobName?: string | undefined; /** *Filter results by the specified job run ID.
* @public */ JobRunId?: string | undefined; /** *Filter results by runs that started after this time.
* @public */ StartedAfter?: Date | undefined; /** *Filter results by runs that started before this time.
* @public */ StartedBefore?: Date | undefined; } /** * @public */ export interface ListDataQualityResultsRequest { /** *The filter criteria.
* @public */ Filter?: DataQualityResultFilterCriteria | undefined; /** *A paginated token to offset the results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return.
* @public */ MaxResults?: number | undefined; } /** *Describes a data quality result.
* @public */ export interface DataQualityResultDescription { /** *The unique result ID for this data quality result.
* @public */ ResultId?: string | undefined; /** *The table name associated with the data quality result.
* @public */ DataSource?: DataSource | undefined; /** *The job name associated with the data quality result.
* @public */ JobName?: string | undefined; /** *The job run ID associated with the data quality result.
* @public */ JobRunId?: string | undefined; /** *The time that the run started for this data quality result.
* @public */ StartedOn?: Date | undefined; } /** * @public */ export interface ListDataQualityResultsResponse { /** *A list of DataQualityResultDescription objects.
A pagination token, if more results are available.
* @public */ NextToken?: string | undefined; } /** *A filter for listing data quality recommendation runs.
* @public */ export interface DataQualityRuleRecommendationRunFilter { /** *Filter based on a specified data source (Glue table).
* @public */ DataSource: DataSource | undefined; /** *Filter based on time for results started before provided time.
* @public */ StartedBefore?: Date | undefined; /** *Filter based on time for results started after provided time.
* @public */ StartedAfter?: Date | undefined; } /** * @public */ export interface ListDataQualityRuleRecommendationRunsRequest { /** *The filter criteria.
* @public */ Filter?: DataQualityRuleRecommendationRunFilter | undefined; /** *A paginated token to offset the results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return.
* @public */ MaxResults?: number | undefined; } /** *Describes the result of a data quality rule recommendation run.
* @public */ export interface DataQualityRuleRecommendationRunDescription { /** *The unique run identifier associated with this run.
* @public */ RunId?: string | undefined; /** *The status for this run.
* @public */ Status?: TaskStatusType | undefined; /** *The date and time when this run started.
* @public */ StartedOn?: Date | undefined; /** *The data source (Glue table) associated with the recommendation run.
* @public */ DataSource?: DataSource | undefined; } /** * @public */ export interface ListDataQualityRuleRecommendationRunsResponse { /** *A list of DataQualityRuleRecommendationRunDescription objects.
A pagination token, if more results are available.
* @public */ NextToken?: string | undefined; } /** *The filter criteria.
* @public */ export interface DataQualityRulesetEvaluationRunFilter { /** *Filter based on a data source (an Glue table) associated with the run.
* @public */ DataSource: DataSource | undefined; /** *Filter results by runs that started before this time.
* @public */ StartedBefore?: Date | undefined; /** *Filter results by runs that started after this time.
* @public */ StartedAfter?: Date | undefined; /** *Filter results by the name of the ruleset.
* @public */ RulesetName?: string | undefined; } /** * @public */ export interface ListDataQualityRulesetEvaluationRunsRequest { /** *The filter criteria.
* @public */ Filter?: DataQualityRulesetEvaluationRunFilter | undefined; /** *A paginated token to offset the results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return.
* @public */ MaxResults?: number | undefined; } /** *Describes the result of a data quality ruleset evaluation run.
* @public */ export interface DataQualityRulesetEvaluationRunDescription { /** *The unique run identifier associated with this run.
* @public */ RunId?: string | undefined; /** *The status for this run.
* @public */ Status?: TaskStatusType | undefined; /** *The date and time when the run started.
* @public */ StartedOn?: Date | undefined; /** *The data source (an Glue table) associated with the run.
* @public */ DataSource?: DataSource | undefined; } /** * @public */ export interface ListDataQualityRulesetEvaluationRunsResponse { /** *A list of DataQualityRulesetEvaluationRunDescription objects representing data quality ruleset runs.
A pagination token, if more results are available.
* @public */ NextToken?: string | undefined; } /** *The criteria used to filter data quality rulesets.
* @public */ export interface DataQualityRulesetFilterCriteria { /** *The name of the ruleset filter criteria.
* @public */ Name?: string | undefined; /** *The description of the ruleset filter criteria.
* @public */ Description?: string | undefined; /** *Filter on rulesets created before this date.
* @public */ CreatedBefore?: Date | undefined; /** *Filter on rulesets created after this date.
* @public */ CreatedAfter?: Date | undefined; /** *Filter on rulesets last modified before this date.
* @public */ LastModifiedBefore?: Date | undefined; /** *Filter on rulesets last modified after this date.
* @public */ LastModifiedAfter?: Date | undefined; /** *The name and database name of the target table.
* @public */ TargetTable?: DataQualityTargetTable | undefined; } /** * @public */ export interface ListDataQualityRulesetsRequest { /** *A paginated token to offset the results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return.
* @public */ MaxResults?: number | undefined; /** *The filter criteria.
* @public */ Filter?: DataQualityRulesetFilterCriteria | undefined; /** *A list of key-value pair tags.
* @public */ Tags?: RecordDescribes a data quality ruleset returned by GetDataQualityRuleset.
The name of the data quality ruleset.
* @public */ Name?: string | undefined; /** *A description of the data quality ruleset.
* @public */ Description?: string | undefined; /** *The date and time the data quality ruleset was created.
* @public */ CreatedOn?: Date | undefined; /** *The date and time the data quality ruleset was last modified.
* @public */ LastModifiedOn?: Date | undefined; /** *An object representing an Glue table.
* @public */ TargetTable?: DataQualityTargetTable | undefined; /** *When a ruleset was created from a recommendation run, this run ID is generated to link the two together.
* @public */ RecommendationRunId?: string | undefined; /** *The number of rules in the ruleset.
* @public */ RuleCount?: number | undefined; } /** * @public */ export interface ListDataQualityRulesetsResponse { /** *A paginated list of rulesets for the specified list of Glue tables.
* @public */ Rulesets?: DataQualityRulesetListDetails[] | undefined; /** *A pagination token, if more results are available.
* @public */ NextToken?: string | undefined; } /** *A timestamp filter.
* @public */ export interface TimestampFilter { /** *The timestamp before which statistics should be included in the results.
* @public */ RecordedBefore?: Date | undefined; /** *The timestamp after which statistics should be included in the results.
* @public */ RecordedAfter?: Date | undefined; } /** * @public */ export interface ListDataQualityStatisticAnnotationsRequest { /** *The Statistic ID.
* @public */ StatisticId?: string | undefined; /** *The Profile ID.
* @public */ ProfileId?: string | undefined; /** *A timestamp filter.
* @public */ TimestampFilter?: TimestampFilter | undefined; /** *The maximum number of results to return in this request.
* @public */ MaxResults?: number | undefined; /** *A pagination token to retrieve the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListDataQualityStatisticAnnotationsResponse { /** *A list of StatisticAnnotation applied to the Statistic
A pagination token to retrieve the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListDataQualityStatisticsRequest { /** *The Statistic ID.
* @public */ StatisticId?: string | undefined; /** *The Profile ID.
* @public */ ProfileId?: string | undefined; /** *A timestamp filter.
* @public */ TimestampFilter?: TimestampFilter | undefined; /** *The maximum number of results to return in this request.
* @public */ MaxResults?: number | undefined; /** *A pagination token to request the next page of results.
* @public */ NextToken?: string | undefined; } /** *A run identifier.
* @public */ export interface RunIdentifier { /** *The Run ID.
* @public */ RunId?: string | undefined; /** *The Job Run ID.
* @public */ JobRunId?: string | undefined; } /** *Summary information about a statistic.
* @public */ export interface StatisticSummary { /** *The Statistic ID.
* @public */ StatisticId?: string | undefined; /** *The Profile ID.
* @public */ ProfileId?: string | undefined; /** *The Run Identifier
* @public */ RunIdentifier?: RunIdentifier | undefined; /** *The name of the statistic.
* @public */ StatisticName?: string | undefined; /** *The value of the statistic.
* @public */ DoubleValue?: number | undefined; /** *The evaluation level of the statistic. Possible values: Dataset, Column, Multicolumn.
The list of columns referenced by the statistic.
* @public */ ColumnsReferenced?: string[] | undefined; /** *The list of datasets referenced by the statistic.
* @public */ ReferencedDatasets?: string[] | undefined; /** *A StatisticPropertiesMap, which contains a NameString and DescriptionString
*
The timestamp when the statistic was recorded.
* @public */ RecordedOn?: Date | undefined; /** *The inclusion annotation for the statistic.
* @public */ InclusionAnnotation?: TimestampedInclusionAnnotation | undefined; } /** * @public */ export interface ListDataQualityStatisticsResponse { /** *A StatisticSummaryList.
A pagination token to request the next page of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListDevEndpointsRequest { /** *A continuation token, if this is a continuation request.
* @public */ NextToken?: string | undefined; /** *The maximum size of a list to return.
* @public */ MaxResults?: number | undefined; /** *Specifies to return only these tagged resources.
* @public */ Tags?: RecordThe names of all the DevEndpoints in the account, or the
* DevEndpoints with the specified tags.
A continuation token, if the returned list does not contain the * last metric available.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListEntitiesRequest { /** *A name for the connection that has required credentials to query any connection type.
* @public */ ConnectionName?: string | undefined; /** *The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.
* @public */ CatalogId?: string | undefined; /** *Name of the parent entity for which you want to list the children. This parameter takes a fully-qualified path of the entity in order to list the child entities.
* @public */ ParentEntityName?: string | undefined; /** *A continuation token, included if this is a continuation call.
* @public */ NextToken?: string | undefined; /** *The API version of the SaaS connector.
* @public */ DataStoreApiVersion?: string | undefined; } /** *An entity supported by a given ConnectionType.
The name of the entity.
* @public */ EntityName?: string | undefined; /** *Label used for the entity.
* @public */ Label?: string | undefined; /** *A Boolean value which helps to determine whether there are sub objects that can be listed.
* @public */ IsParentEntity?: boolean | undefined; /** *A description of the entity.
* @public */ Description?: string | undefined; /** *The type of entities that are present in the response. This value depends on the source connection. For example this is SObjects for Salesforce and databases or schemas or tables for sources like Amazon Redshift.
An optional map of keys which may be returned for an entity by a connector.
* @public */ CustomProperties?: RecordA list of Entity objects.
A continuation token, present if the current segment is not the last.
* @public */ NextToken?: string | undefined; } /** *A filter for integration resource properties.
* @public */ export interface IntegrationResourcePropertyFilter { /** *The name of the filter. Supported filter keys are SourceArn and TargetArn.
A list of filter values.
* @public */ Values?: string[] | undefined; } /** * @public */ export interface ListIntegrationResourcePropertiesRequest { /** *This is the pagination token for next page, initial value is null.
A list of filters, supported filter Key is SourceArn and TargetArn.
This is total number of items to be evaluated.
* @public */ MaxRecords?: number | undefined; } /** *A structure representing an integration resource property.
* @public */ export interface IntegrationResourceProperty { /** *The connection ARN of the source, or the database ARN of the target.
* @public */ ResourceArn: string | undefined; /** *The resource ARN created through this create API. The format is something like arn:aws:glue:
The resource properties associated with the integration source.
* @public */ SourceProcessingProperties?: SourceProcessingProperties | undefined; /** *The resource properties associated with the integration target.
* @public */ TargetProcessingProperties?: TargetProcessingProperties | undefined; } /** * @public */ export interface ListIntegrationResourcePropertiesResponse { /** *A list of integration resource property meeting the filter criteria.
* @public */ IntegrationResourcePropertyList?: IntegrationResourceProperty[] | undefined; /** *This is the pagination token for the next page.
* @public */ Marker?: string | undefined; } /** * @public */ export interface ListJobsRequest { /** *A continuation token, if this is a continuation request.
* @public */ NextToken?: string | undefined; /** *The maximum size of a list to return.
* @public */ MaxResults?: number | undefined; /** *Specifies to return only these tagged resources.
* @public */ Tags?: RecordThe names of all jobs in the account, or the jobs with the specified tags.
* @public */ JobNames?: string[] | undefined; /** *A continuation token, if the returned list does not contain the * last metric available.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListMaterializedViewRefreshTaskRunsRequest { /** *The ID of the Data Catalog where the table resides. If none is supplied, the account ID is used by default.
* @public */ CatalogId: string | undefined; /** *The database where the table resides.
* @public */ DatabaseName?: string | undefined; /** *The name of the table for which statistics is generated.
* @public */ TableName?: string | undefined; /** *The maximum size of the response.
* @public */ MaxResults?: number | undefined; /** *A continuation token, if this is a continuation call.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListMaterializedViewRefreshTaskRunsResponse { /** *The results of the ListMaterializedViewRefreshTaskRuns action.
* @public */ MaterializedViewRefreshTaskRuns?: MaterializedViewRefreshTaskRun[] | undefined; /** *A continuation token, if not all task run IDs have yet been returned.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListMLTransformsRequest { /** *A continuation token, if this is a continuation request.
* @public */ NextToken?: string | undefined; /** *The maximum size of a list to return.
* @public */ MaxResults?: number | undefined; /** *A TransformFilterCriteria used to filter the machine learning transforms.
A TransformSortCriteria used to sort the machine learning transforms.
Specifies to return only these tagged resources.
* @public */ Tags?: RecordThe identifiers of all the machine learning transforms in the account, or the * machine learning transforms with the specified tags.
* @public */ TransformIds: string[] | undefined; /** *A continuation token, if the returned list does not contain the * last metric available.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListRegistriesInput { /** *Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
* @public */ MaxResults?: number | undefined; /** *A continuation token, if this is a continuation call.
* @public */ NextToken?: string | undefined; } /** *A structure containing the details for a registry.
* @public */ export interface RegistryListItem { /** *The name of the registry.
* @public */ RegistryName?: string | undefined; /** *The Amazon Resource Name (ARN) of the registry.
* @public */ RegistryArn?: string | undefined; /** *A description of the registry.
* @public */ Description?: string | undefined; /** *The status of the registry.
* @public */ Status?: RegistryStatus | undefined; /** *The data the registry was created.
* @public */ CreatedTime?: string | undefined; /** *The date the registry was updated.
* @public */ UpdatedTime?: string | undefined; } /** * @public */ export interface ListRegistriesResponse { /** *An array of RegistryDetailedListItem objects containing minimal details of each registry.
A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListSchemasInput { /** *A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
* @public */ RegistryId?: RegistryId | undefined; /** *Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
* @public */ MaxResults?: number | undefined; /** *A continuation token, if this is a continuation call.
* @public */ NextToken?: string | undefined; } /** *An object that contains minimal details for a schema.
* @public */ export interface SchemaListItem { /** *the name of the registry where the schema resides.
* @public */ RegistryName?: string | undefined; /** *The name of the schema.
* @public */ SchemaName?: string | undefined; /** *The Amazon Resource Name (ARN) for the schema.
* @public */ SchemaArn?: string | undefined; /** *A description for the schema.
* @public */ Description?: string | undefined; /** *The status of the schema.
* @public */ SchemaStatus?: SchemaStatus | undefined; /** *The date and time that a schema was created.
* @public */ CreatedTime?: string | undefined; /** *The date and time that a schema was updated.
* @public */ UpdatedTime?: string | undefined; } /** * @public */ export interface ListSchemasResponse { /** *An array of SchemaListItem objects containing details of each schema.
A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListSchemaVersionsInput { /** *This is a wrapper structure to contain schema identity fields. The structure contains:
*SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
* @public */ MaxResults?: number | undefined; /** *A continuation token, if this is a continuation call.
* @public */ NextToken?: string | undefined; } /** *An object containing the details about a schema version.
* @public */ export interface SchemaVersionListItem { /** *The Amazon Resource Name (ARN) of the schema.
* @public */ SchemaArn?: string | undefined; /** *The unique identifier of the schema version.
* @public */ SchemaVersionId?: string | undefined; /** *The version number of the schema.
* @public */ VersionNumber?: number | undefined; /** *The status of the schema version.
* @public */ Status?: SchemaVersionStatus | undefined; /** *The date and time the schema version was created.
* @public */ CreatedTime?: string | undefined; } /** * @public */ export interface ListSchemaVersionsResponse { /** *An array of SchemaVersionList objects containing details of each schema version.
A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListSessionsRequest { /** *The token for the next set of results, or null if there are no more result.
* @public */ NextToken?: string | undefined; /** *The maximum number of results.
* @public */ MaxResults?: number | undefined; /** *Tags belonging to the session.
* @public */ Tags?: RecordThe origin of the request.
* @public */ RequestOrigin?: string | undefined; } /** * @public */ export interface ListSessionsResponse { /** *Returns the ID of the session.
* @public */ Ids?: string[] | undefined; /** *Returns the session object.
* @public */ Sessions?: Session[] | undefined; /** *The token for the next set of results, or null if there are no more result.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListStatementsRequest { /** *The Session ID of the statements.
* @public */ SessionId: string | undefined; /** *The origin of the request to list statements.
* @public */ RequestOrigin?: string | undefined; /** *A continuation token, if this is a continuation call.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListStatementsResponse { /** *Returns the list of statements.
* @public */ Statements?: Statement[] | undefined; /** *A continuation token, if not all statements have yet been returned.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListTableOptimizerRunsRequest { /** *The Catalog ID of the table.
* @public */ CatalogId: string | undefined; /** *The name of the database in the catalog in which the table resides.
* @public */ DatabaseName: string | undefined; /** *The name of the table.
* @public */ TableName: string | undefined; /** *The type of table optimizer.
* @public */ Type: TableOptimizerType | undefined; /** *The maximum number of optimizer runs to return on each call.
* @public */ MaxResults?: number | undefined; /** *A continuation token, if this is a continuation call.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListTableOptimizerRunsResponse { /** *The Catalog ID of the table.
* @public */ CatalogId?: string | undefined; /** *The name of the database in the catalog in which the table resides.
* @public */ DatabaseName?: string | undefined; /** *The name of the table.
* @public */ TableName?: string | undefined; /** *A continuation token for paginating the returned list of optimizer runs, returned if the current segment of the list is not the last.
* @public */ NextToken?: string | undefined; /** *A list of the optimizer runs associated with a table.
* @public */ TableOptimizerRuns?: TableOptimizerRun[] | undefined; } /** * @public */ export interface ListTriggersRequest { /** *A continuation token, if this is a continuation request.
* @public */ NextToken?: string | undefined; /** *The name of the job for which to retrieve triggers. The trigger that can start this job * is returned. If there is no such trigger, all triggers are returned.
* @public */ DependentJobName?: string | undefined; /** *The maximum size of a list to return.
* @public */ MaxResults?: number | undefined; /** *Specifies to return only these tagged resources.
* @public */ Tags?: RecordThe names of all triggers in the account, or the triggers with the specified tags.
* @public */ TriggerNames?: string[] | undefined; /** *A continuation token, if the returned list does not contain the * last metric available.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListUsageProfilesRequest { /** *A continuation token, included if this is a continuation call.
* @public */ NextToken?: string | undefined; /** *The maximum number of usage profiles to return in a single response.
* @public */ MaxResults?: number | undefined; } /** *Describes an Glue usage profile.
* @public */ export interface UsageProfileDefinition { /** *The name of the usage profile.
* @public */ Name?: string | undefined; /** *A description of the usage profile.
* @public */ Description?: string | undefined; /** *The date and time when the usage profile was created.
* @public */ CreatedOn?: Date | undefined; /** *The date and time when the usage profile was last modified.
* @public */ LastModifiedOn?: Date | undefined; } /** * @public */ export interface ListUsageProfilesResponse { /** *A list of usage profile (UsageProfileDefinition) objects.
A continuation token, present if the current list segment is not the last.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListWorkflowsRequest { /** *A continuation token, if this is a continuation request.
* @public */ NextToken?: string | undefined; /** *The maximum size of a list to return.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListWorkflowsResponse { /** *List of names of workflows in the account.
* @public */ Workflows?: string[] | undefined; /** *A continuation token, if not all workflow names have been returned.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ModifyIntegrationRequest { /** *The Amazon Resource Name (ARN) for the integration.
* @public */ IntegrationIdentifier: string | undefined; /** *A description of the integration.
* @public */ Description?: string | undefined; /** *Selects source tables for the integration using Maxwell filter syntax.
* @public */ DataFilter?: string | undefined; /** *The configuration settings for the integration. Currently, only the RefreshInterval can be modified.
* @public */ IntegrationConfig?: IntegrationConfig | undefined; /** *A unique name for an integration in Glue.
* @public */ IntegrationName?: string | undefined; } /** * @public */ export interface ModifyIntegrationResponse { /** *The ARN of the source for the integration.
* @public */ SourceArn: string | undefined; /** *The ARN of the target for the integration.
* @public */ TargetArn: string | undefined; /** *A unique name for an integration in Glue.
* @public */ IntegrationName: string | undefined; /** *A description of the integration.
* @public */ Description?: string | undefined; /** *The Amazon Resource Name (ARN) for the integration.
* @public */ IntegrationArn: string | undefined; /** *The ARN of a KMS key used for encrypting the channel.
* @public */ KmsKeyId?: string | undefined; /** *An optional set of non-secret key–value pairs that contains additional contextual information for encryption.
* @public */ AdditionalEncryptionContext?: RecordMetadata assigned to the resource consisting of a list of key-value pairs.
* @public */ Tags?: Tag[] | undefined; /** *The status of the integration being modified.
*The possible statuses are:
*CREATING: The integration is being created.
*ACTIVE: The integration creation succeeds.
*MODIFYING: The integration is being modified.
*FAILED: The integration creation fails.
*DELETING: The integration is deleted.
*SYNCING: The integration is synchronizing.
*NEEDS_ATTENTION: The integration needs attention, such as synchronization.
*The time when the integration was created, in UTC.
* @public */ CreateTime: Date | undefined; /** *A list of errors associated with the integration modification.
* @public */ Errors?: IntegrationError[] | undefined; /** *Selects source tables for the integration using Maxwell filter syntax.
* @public */ DataFilter?: string | undefined; /** *The updated configuration settings for the integration.
* @public */ IntegrationConfig?: IntegrationConfig | undefined; } /** * @public */ export interface PutDataCatalogEncryptionSettingsRequest { /** *The ID of the Data Catalog to set the security configuration for. If none is provided, the * Amazon Web Services account ID is used by default.
* @public */ CatalogId?: string | undefined; /** *The security configuration to set.
* @public */ DataCatalogEncryptionSettings: DataCatalogEncryptionSettings | undefined; } /** * @public */ export interface PutDataCatalogEncryptionSettingsResponse { } /** * @public */ export interface PutDataQualityProfileAnnotationRequest { /** *The ID of the data quality monitoring profile to annotate.
* @public */ ProfileId: string | undefined; /** *The inclusion annotation value to apply to the profile.
* @public */ InclusionAnnotation: InclusionAnnotationValue | undefined; } /** *Left blank.
* @public */ export interface PutDataQualityProfileAnnotationResponse { } /** * @public */ export interface PutResourcePolicyRequest { /** *Contains the policy document to set, in JSON format.
* @public */ PolicyInJson: string | undefined; /** *Do not use. For internal use only.
* @public */ ResourceArn?: string | undefined; /** *The hash value returned when the previous policy was set using
* PutResourcePolicy. Its purpose is to prevent concurrent modifications of a
* policy. Do not use this parameter if no previous policy has been set.
A value of MUST_EXIST is used to update a policy. A value of
* NOT_EXIST is used to create a new policy. If a value of NONE or a
* null value is used, the call does not depend on the existence of a policy.
If 'TRUE', indicates that you are using both methods to grant cross-account
* access to Data Catalog resources:
By directly updating the resource policy with PutResourePolicy
*
By using the Grant permissions command on the Amazon Web Services Management Console.
*Must be set to 'TRUE' if you have already used the Management Console to
* grant cross-account access, otherwise the call fails. Default is 'FALSE'.
A hash of the policy that has just been set. This must * be included in a subsequent call that overwrites or updates * this policy.
* @public */ PolicyHash?: string | undefined; } /** *A structure containing a key value pair for metadata.
* @public */ export interface MetadataKeyValuePair { /** *A metadata key.
* @public */ MetadataKey?: string | undefined; /** *A metadata key’s corresponding value.
* @public */ MetadataValue?: string | undefined; } /** * @public */ export interface PutSchemaVersionMetadataInput { /** *The unique ID for the schema.
* @public */ SchemaId?: SchemaId | undefined; /** *The version number of the schema.
* @public */ SchemaVersionNumber?: SchemaVersionNumber | undefined; /** *The unique version ID of the schema version.
* @public */ SchemaVersionId?: string | undefined; /** *The metadata key's corresponding value.
* @public */ MetadataKeyValue: MetadataKeyValuePair | undefined; } /** * @public */ export interface PutSchemaVersionMetadataResponse { /** *The Amazon Resource Name (ARN) for the schema.
* @public */ SchemaArn?: string | undefined; /** *The name for the schema.
* @public */ SchemaName?: string | undefined; /** *The name for the registry.
* @public */ RegistryName?: string | undefined; /** *The latest version of the schema.
* @public */ LatestVersion?: boolean | undefined; /** *The version number of the schema.
* @public */ VersionNumber?: number | undefined; /** *The unique version ID of the schema version.
* @public */ SchemaVersionId?: string | undefined; /** *The metadata key.
* @public */ MetadataKey?: string | undefined; /** *The value of the metadata key.
* @public */ MetadataValue?: string | undefined; } /** * @public */ export interface PutWorkflowRunPropertiesRequest { /** *Name of the workflow which was run.
* @public */ Name: string | undefined; /** *The ID of the workflow run for which the run properties should be updated.
* @public */ RunId: string | undefined; /** *The properties to put for the specified run.
*Run properties may be logged. Do not pass plaintext secrets as properties. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to use them within the workflow run.
* @public */ RunProperties: RecordA wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
* @public */ SchemaId?: SchemaId | undefined; /** *The version number of the schema.
* @public */ SchemaVersionNumber?: SchemaVersionNumber | undefined; /** *The unique version ID of the schema version.
* @public */ SchemaVersionId?: string | undefined; /** *Search key-value pairs for metadata, if they are not provided all the metadata information will be fetched.
* @public */ MetadataList?: MetadataKeyValuePair[] | undefined; /** *Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
* @public */ MaxResults?: number | undefined; /** *A continuation token, if this is a continuation call.
* @public */ NextToken?: string | undefined; } /** *A structure containing other metadata for a schema version belonging to the same metadata key.
* @public */ export interface OtherMetadataValueListItem { /** *The metadata key’s corresponding value for the other metadata belonging to the same metadata key.
* @public */ MetadataValue?: string | undefined; /** *The time at which the entry was created.
* @public */ CreatedTime?: string | undefined; } /** *A structure containing metadata information for a schema version.
* @public */ export interface MetadataInfo { /** *The metadata key’s corresponding value.
* @public */ MetadataValue?: string | undefined; /** *The time at which the entry was created.
* @public */ CreatedTime?: string | undefined; /** *Other metadata belonging to the same metadata key.
* @public */ OtherMetadataValueList?: OtherMetadataValueListItem[] | undefined; } /** * @public */ export interface QuerySchemaVersionMetadataResponse { /** *A map of a metadata key and associated values.
* @public */ MetadataInfoMap?: RecordThe unique version ID of the schema version.
* @public */ SchemaVersionId?: string | undefined; /** *A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
* @public */ NextToken?: string | undefined; } /** *Configuration that defines the base URL and additional request parameters needed during connection creation.
* @public */ export interface ConnectionPropertiesConfiguration { /** *The base instance URL for the endpoint that this connection type will connect to.
* @public */ Url?: ConnectorProperty | undefined; /** *Key-value pairs of additional request parameters that may be needed during connection creation, such as API versions or service-specific configuration options.
* @public */ AdditionalRequestParameters?: ConnectorProperty[] | undefined; } /** *Basic authentication configuration that defines the username and password properties for HTTP Basic authentication.
* @public */ export interface BasicAuthenticationProperties { /** *The username property name to use for Basic authentication credentials.
* @public */ Username?: ConnectorProperty | undefined; /** *The password property name to use for Basic authentication credentials.
* @public */ Password?: ConnectorProperty | undefined; } /** *Custom authentication configuration that allows for flexible authentication mechanisms beyond standard Basic and OAuth2 flows.
* @public */ export interface CustomAuthenticationProperties { /** *A map of custom authentication parameters that define the specific authentication mechanism and required properties.
* @public */ AuthenticationParameters: ConnectorProperty[] | undefined; } /** *OAuth2 authorization code configuration that defines the properties needed for the Authorization Code grant type flow.
* @public */ export interface ConnectorAuthorizationCodeProperties { /** *The authorization endpoint URL where users will be redirected to grant authorization.
* @public */ AuthorizationCodeUrl?: ConnectorProperty | undefined; /** *The authorization code received from the authorization server after user consent.
* @public */ AuthorizationCode?: ConnectorProperty | undefined; /** *The redirect URI that must match the URI registered with the authorization server.
* @public */ RedirectUri?: ConnectorProperty | undefined; /** *The token endpoint URL where the authorization code will be exchanged for an access token.
* @public */ TokenUrl?: ConnectorProperty | undefined; /** *The HTTP method to use when making token exchange requests, typically POST.
* @public */ RequestMethod?: HTTPMethod | undefined; /** *The content type to use for token exchange requests, such as application/x-www-form-urlencoded or application/json.
* @public */ ContentType?: ContentType | undefined; /** *The OAuth2 client identifier provided by the authorization server.
* @public */ ClientId?: ConnectorProperty | undefined; /** *The OAuth2 client secret provided by the authorization server.
* @public */ ClientSecret?: ConnectorProperty | undefined; /** *The OAuth2 scope that defines the level of access requested for the authorization code flow.
* @public */ Scope?: ConnectorProperty | undefined; /** *The OAuth2 prompt parameter that controls the authorization server's behavior during user authentication.
* @public */ Prompt?: ConnectorProperty | undefined; /** *Additional parameters to include in token URL requests as key-value pairs.
* @public */ TokenUrlParameters?: ConnectorProperty[] | undefined; } /** *OAuth2 client credentials configuration that defines the properties needed for the Client Credentials grant type flow.
* @public */ export interface ClientCredentialsProperties { /** *The token endpoint URL where the client will request access tokens using client credentials.
* @public */ TokenUrl?: ConnectorProperty | undefined; /** *The HTTP method to use when making token requests, typically POST.
* @public */ RequestMethod?: HTTPMethod | undefined; /** *The content type to use for token requests, such as application/x-www-form-urlencoded or application/json.
* @public */ ContentType?: ContentType | undefined; /** *The OAuth2 client identifier provided by the authorization server.
* @public */ ClientId?: ConnectorProperty | undefined; /** *The OAuth2 client secret provided by the authorization server.
* @public */ ClientSecret?: ConnectorProperty | undefined; /** *The OAuth2 scope that defines the level of access requested for the client credentials flow.
* @public */ Scope?: ConnectorProperty | undefined; /** *Additional parameters to include in token URL requests as key-value pairs.
* @public */ TokenUrlParameters?: ConnectorProperty[] | undefined; } /** *JWT bearer token configuration that defines the properties needed for the JWT Bearer grant type flow.
* @public */ export interface JWTBearerProperties { /** *The token endpoint URL where the JWT bearer token will be exchanged for an access token.
* @public */ TokenUrl?: ConnectorProperty | undefined; /** *The HTTP method to use when making JWT bearer token requests, typically POST.
* @public */ RequestMethod?: HTTPMethod | undefined; /** *The content type to use for JWT bearer token requests, such as application/x-www-form-urlencoded or application/json.
* @public */ ContentType?: ContentType | undefined; /** *The JWT token to be used in the bearer token grant flow for authentication.
* @public */ JwtToken?: ConnectorProperty | undefined; /** *Additional parameters to include in token URL requests as key-value pairs.
* @public */ TokenUrlParameters?: ConnectorProperty[] | undefined; } /** *OAuth2 configuration container that defines the authentication properties and flow-specific configurations for OAuth2-based connections.
* @public */ export interface ConnectorOAuth2Properties { /** *The OAuth2 grant type to use for authentication, such as CLIENT_CREDENTIALS, JWT_BEARER, or AUTHORIZATION_CODE.
* @public */ OAuth2GrantType: ConnectorOAuth2GrantType | undefined; /** *Configuration properties specific to the OAuth2 Client Credentials grant type flow.
* @public */ ClientCredentialsProperties?: ClientCredentialsProperties | undefined; /** *Configuration properties specific to the OAuth2 JWT Bearer grant type flow.
* @public */ JWTBearerProperties?: JWTBearerProperties | undefined; /** *Configuration properties specific to the OAuth2 Authorization Code grant type flow.
* @public */ AuthorizationCodeProperties?: ConnectorAuthorizationCodeProperties | undefined; } /** *Configuration that defines the supported authentication types and required properties for the connection type.
* @public */ export interface ConnectorAuthenticationConfiguration { /** *A list of authentication types supported by this connection type, such as Basic, OAuth2, or Custom authentication methods.
* @public */ AuthenticationTypes: AuthenticationType[] | undefined; /** *OAuth2 configuration container that defines the authentication properties and flow-specific configurations for OAuth2-based connections.
* @public */ OAuth2Properties?: ConnectorOAuth2Properties | undefined; /** *Basic authentication configuration that defines the username and password properties for HTTP Basic authentication.
* @public */ BasicAuthenticationProperties?: BasicAuthenticationProperties | undefined; /** *Custom authentication configuration that allows for flexible authentication mechanisms beyond standard Basic and OAuth2 flows.
* @public */ CustomAuthenticationProperties?: CustomAuthenticationProperties | undefined; } /** * @public */ export interface RegisterConnectionTypeRequest { /** *The name of the connection type. Must be between 1 and 255 characters and must be prefixed with "REST-" to indicate it is a REST-based connector.
* @public */ ConnectionType: string | undefined; /** *The integration type for the connection. Currently only "REST" protocol is supported.
* @public */ IntegrationType: IntegrationType | undefined; /** *A description of the connection type. Can be up to 2048 characters and provides details about the purpose and functionality of the connection type.
* @public */ Description?: string | undefined; /** *Defines the base URL and additional request parameters needed during connection creation for this connection type.
* @public */ ConnectionProperties: ConnectionPropertiesConfiguration | undefined; /** *Defines the supported authentication types and required properties for this connection type, including Basic, OAuth2, and Custom authentication methods.
* @public */ ConnectorAuthenticationConfiguration: ConnectorAuthenticationConfiguration | undefined; /** *Defines the HTTP request and response configuration, validation endpoint, and entity configurations for REST API interactions.
* @public */ RestConfiguration: RestConfiguration | undefined; /** *The tags you assign to the connection type.
* @public */ Tags?: RecordContains the Amazon Resource Name (ARN) of the newly registered connection type.
* @public */ export interface RegisterConnectionTypeResponse { /** *The Amazon Resource Name (ARN) of the registered connection type. This unique identifier can be used to reference the connection type in other Glue operations.
* @public */ ConnectionTypeArn?: string | undefined; } /** * @public */ export interface RegisterSchemaVersionInput { /** *This is a wrapper structure to contain schema identity fields. The structure contains:
*SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
The schema definition using the DataFormat setting for the SchemaName.
The unique ID that represents the version of this schema.
* @public */ SchemaVersionId?: string | undefined; /** *The version of this schema (for sync flow only, in case this is the first version).
* @public */ VersionNumber?: number | undefined; /** *The status of the schema version.
* @public */ Status?: SchemaVersionStatus | undefined; } /** * @public */ export interface RemoveSchemaVersionMetadataInput { /** *A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
* @public */ SchemaId?: SchemaId | undefined; /** *The version number of the schema.
* @public */ SchemaVersionNumber?: SchemaVersionNumber | undefined; /** *The unique version ID of the schema version.
* @public */ SchemaVersionId?: string | undefined; /** *The value of the metadata key.
* @public */ MetadataKeyValue: MetadataKeyValuePair | undefined; } /** * @public */ export interface RemoveSchemaVersionMetadataResponse { /** *The Amazon Resource Name (ARN) of the schema.
* @public */ SchemaArn?: string | undefined; /** *The name of the schema.
* @public */ SchemaName?: string | undefined; /** *The name of the registry.
* @public */ RegistryName?: string | undefined; /** *The latest version of the schema.
* @public */ LatestVersion?: boolean | undefined; /** *The version number of the schema.
* @public */ VersionNumber?: number | undefined; /** *The version ID for the schema version.
* @public */ SchemaVersionId?: string | undefined; /** *The metadata key.
* @public */ MetadataKey?: string | undefined; /** *The value of the metadata key.
* @public */ MetadataValue?: string | undefined; } /** * @public */ export interface ResetJobBookmarkRequest { /** *The name of the job in question.
* @public */ JobName: string | undefined; /** *The unique run identifier associated with this job run.
* @public */ RunId?: string | undefined; } /** * @public */ export interface ResetJobBookmarkResponse { /** *The reset bookmark entry.
* @public */ JobBookmarkEntry?: JobBookmarkEntry | undefined; } /** * @public */ export interface ResumeWorkflowRunRequest { /** *The name of the workflow to resume.
* @public */ Name: string | undefined; /** *The ID of the workflow run to resume.
* @public */ RunId: string | undefined; /** *A list of the node IDs for the nodes you want to restart. The nodes that are to be restarted must have a run attempt in the original run.
* @public */ NodeIds: string[] | undefined; } /** * @public */ export interface ResumeWorkflowRunResponse { /** *The new ID assigned to the resumed workflow run. Each resume of a workflow run will have a new run ID.
* @public */ RunId?: string | undefined; /** *A list of the node IDs for the nodes that were actually restarted.
* @public */ NodeIds?: string[] | undefined; } /** * @public */ export interface RunStatementRequest { /** *The Session Id of the statement to be run.
* @public */ SessionId: string | undefined; /** *The statement code to be run.
* @public */ Code: string | undefined; /** *The origin of the request.
* @public */ RequestOrigin?: string | undefined; } /** * @public */ export interface RunStatementResponse { /** *Returns the Id of the statement that was run.
* @public */ Id?: number | undefined; } /** *Defines a property predicate.
* @public */ export interface PropertyPredicate { /** *The key of the property.
* @public */ Key?: string | undefined; /** *The value of the property.
* @public */ Value?: string | undefined; /** *The comparator used to compare this property to others.
* @public */ Comparator?: Comparator | undefined; } /** *Specifies a field to sort by and a sort order.
* @public */ export interface SortCriterion { /** *The name of the field on which to sort.
* @public */ FieldName?: string | undefined; /** *An ascending or descending sort.
* @public */ Sort?: Sort | undefined; } /** * @public */ export interface SearchTablesRequest { /** *A unique identifier, consisting of
* account_id
* .
A continuation token, included if this is a continuation call.
* @public */ NextToken?: string | undefined; /** *A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.
*The Comparator member of the PropertyPredicate struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name, a fuzzy match algorithm is used. The Key field (for example, the value of the Name field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the Value member of PropertyPredicate. For example, if Key=Name and Value=link, tables named customer-link and xx-link-yy are returned, but xxlinkyy is not returned.
A string used for a text search.
*Specifying a value in quotes filters based on an exact match to the value.
* @public */ SearchText?: string | undefined; /** *A list of criteria for sorting the results by a field name, in an ascending or descending order.
* @public */ SortCriteria?: SortCriterion[] | undefined; /** *The maximum number of tables to return in a single response.
* @public */ MaxResults?: number | undefined; /** *Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN or ALL.
If set to FOREIGN, will search the tables shared with your account.
If set to ALL, will search the tables shared with your account, as well as the tables in yor local account.
Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.
* @public */ IncludeStatusDetails?: boolean | undefined; } /** * @public */ export interface StartBlueprintRunRequest { /** *The name of the blueprint.
* @public */ BlueprintName: string | undefined; /** *Specifies the parameters as a BlueprintParameters object.
Specifies the IAM role used to create the workflow.
* @public */ RoleArn: string | undefined; } /** * @public */ export interface StartBlueprintRunResponse { /** *The run ID for this blueprint run.
* @public */ RunId?: string | undefined; } /** * @public */ export interface StartColumnStatisticsTaskRunRequest { /** *The name of the database where the table resides.
* @public */ DatabaseName: string | undefined; /** *The name of the table to generate statistics.
* @public */ TableName: string | undefined; /** *A list of the column names to generate statistics. If none is supplied, all column names for the table will be used by default.
* @public */ ColumnNameList?: string[] | undefined; /** *The IAM role that the service assumes to generate statistics.
* @public */ Role: string | undefined; /** *The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
* @public */ SampleSize?: number | undefined; /** *The ID of the Data Catalog where the table reside. If none is supplied, the Amazon Web Services account ID is used by default.
* @public */ CatalogID?: string | undefined; /** *Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
* @public */ SecurityConfiguration?: string | undefined; } /** * @public */ export interface StartColumnStatisticsTaskRunResponse { /** *The identifier for the column statistics task run.
* @public */ ColumnStatisticsTaskRunId?: string | undefined; } /** * @public */ export interface StartColumnStatisticsTaskRunScheduleRequest { /** *The name of the database where the table resides.
* @public */ DatabaseName: string | undefined; /** *The name of the table for which to start a column statistic task run schedule.
* @public */ TableName: string | undefined; } /** * @public */ export interface StartColumnStatisticsTaskRunScheduleResponse { } /** * @public */ export interface StartCrawlerRequest { /** *Name of the crawler to start.
* @public */ Name: string | undefined; } /** * @public */ export interface StartCrawlerResponse { } /** * @public */ export interface StartCrawlerScheduleRequest { /** *Name of the crawler to schedule.
* @public */ CrawlerName: string | undefined; } /** * @public */ export interface StartCrawlerScheduleResponse { } /** *The request of the Data Quality rule recommendation request.
* @public */ export interface StartDataQualityRuleRecommendationRunRequest { /** *The data source (Glue table) associated with this run.
* @public */ DataSource: DataSource | undefined; /** *An IAM role supplied to encrypt the results of the run.
* @public */ Role: string | undefined; /** *The number of G.1X workers to be used in the run. The default is 5.
The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
A name for the ruleset.
* @public */ CreatedRulesetName?: string | undefined; /** *The name of the security configuration created with the data quality encryption option.
* @public */ DataQualitySecurityConfiguration?: string | undefined; /** *Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
* @public */ ClientToken?: string | undefined; } /** * @public */ export interface StartDataQualityRuleRecommendationRunResponse { /** *The unique run identifier associated with this run.
* @public */ RunId?: string | undefined; } /** * @public */ export interface StartDataQualityRulesetEvaluationRunRequest { /** *The data source (Glue table) associated with this run.
* @public */ DataSource: DataSource | undefined; /** *An IAM role supplied to encrypt the results of the run.
* @public */ Role: string | undefined; /** *The number of G.1X workers to be used in the run. The default is 5.
The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
* @public */ ClientToken?: string | undefined; /** *Additional run options you can specify for an evaluation run.
* @public */ AdditionalRunOptions?: DataQualityEvaluationRunAdditionalRunOptions | undefined; /** *A list of ruleset names.
* @public */ RulesetNames: string[] | undefined; /** *A map of reference strings to additional data sources you can specify for an evaluation run.
* @public */ AdditionalDataSources?: RecordThe unique run identifier associated with this run.
* @public */ RunId?: string | undefined; } /** * @public */ export interface StartExportLabelsTaskRunRequest { /** *The unique identifier of the machine learning transform.
* @public */ TransformId: string | undefined; /** *The Amazon S3 path where you export the labels.
* @public */ OutputS3Path: string | undefined; } /** * @public */ export interface StartExportLabelsTaskRunResponse { /** *The unique identifier for the task run.
* @public */ TaskRunId?: string | undefined; } /** * @public */ export interface StartImportLabelsTaskRunRequest { /** *The unique identifier of the machine learning transform.
* @public */ TransformId: string | undefined; /** *The Amazon Simple Storage Service (Amazon S3) path from where you import the * labels.
* @public */ InputS3Path: string | undefined; /** *Indicates whether to overwrite your existing labels.
* @public */ ReplaceAllLabels?: boolean | undefined; } /** * @public */ export interface StartImportLabelsTaskRunResponse { /** *The unique identifier for the task run.
* @public */ TaskRunId?: string | undefined; } /** * @public */ export interface StartJobRunRequest { /** *The name of the job definition to use.
* @public */ JobName: string | undefined; /** *Specifies whether job run queuing is enabled for the job run.
*A value of true means job run queuing is enabled for the job run. If false or not populated, the job run will not be considered for queueing.
* @public */ JobRunQueuingEnabled?: boolean | undefined; /** *The ID of a previous JobRun to retry.
The job arguments associated with this run. For this job run, they replace the default * arguments set in the job definition itself.
*You can specify arguments here that your own job-execution script * consumes, as well as arguments that Glue itself consumes.
*Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets * from a Glue Connection, Secrets Manager or other secret management * mechanism if you intend to keep them within the Job.
*For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
*For information about the arguments you can provide to this field when configuring Spark jobs, * see the Special Parameters Used by Glue topic in the developer guide.
*For information about the arguments you can provide to this field when configuring Ray * jobs, see Using * job parameters in Ray jobs in the developer guide.
* @public */ Arguments?: RecordThis field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) to allocate to this JobRun. * You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure * of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. * For more information, see the Glue * pricing page.
* * @deprecated This property is deprecated, use MaxCapacity instead. * @public */ AllocatedCapacity?: number | undefined; /** *The JobRun timeout in minutes. This is the maximum time that a job run can
* consume resources before it is terminated and enters TIMEOUT status. This value overrides the timeout value set in the parent job.
Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.
*When the value is left blank, the timeout is defaulted to 2,880 minutes for Glue version 4.0 and earlier, or 480 minutes for Glue version 5.0 and later.
*Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.
*For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.
* @public */ Timeout?: number | undefined; /** *For Glue version 1.0 or earlier jobs, using the standard worker type, the number of * Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is * a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB * of memory. For more information, see the * Glue pricing page.
*For Glue version 2.0+ jobs, you cannot specify a Maximum capacity.
* Instead, you should specify a Worker type and the Number of workers.
Do not set MaxCapacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are
* running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL
* job:
When you specify a Python shell job (JobCommand.Name="pythonshell"), you can
* allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name="glueetl") or Apache
* Spark streaming ETL job (JobCommand.Name="gluestreaming"), you can allocate from 2 to 100 DPUs.
* The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
The name of the SecurityConfiguration structure to be used with this job
* run.
Specifies configuration properties of a job run notification.
* @public */ NotificationProperty?: NotificationProperty | undefined; /** *The type of predefined worker that is allocated when a job runs. Accepts a value of * G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
*For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X worker type.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk, and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 or later streaming jobs.
For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.
The number of workers of a defined workerType that are allocated when a job runs.
Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
*The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
*Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.
This inline session policy to the StartJobRun API allows you to dynamically restrict the permissions of the specified * execution role for the scope of the job, without requiring the creation of additional IAM roles.
* @public */ ExecutionRoleSessionPolicy?: string | undefined; } /** * @public */ export interface StartJobRunResponse { /** *The ID assigned to this job run.
* @public */ JobRunId?: string | undefined; } /** * @public */ export interface StartMaterializedViewRefreshTaskRunRequest { /** *The ID of the Data Catalog where the table reside. If none is supplied, the account ID is used by default.
* @public */ CatalogId: string | undefined; /** *The name of the database where the table resides.
* @public */ DatabaseName: string | undefined; /** *The name of the table to generate run the materialized view refresh task.
* @public */ TableName: string | undefined; /** *Specifies whether this is a full refresh of the task run.
* @public */ FullRefresh?: boolean | undefined; } /** * @public */ export interface StartMaterializedViewRefreshTaskRunResponse { /** *The identifier for the materialized view refresh task run.
* @public */ MaterializedViewRefreshTaskRunId?: string | undefined; } /** * @public */ export interface StartMLEvaluationTaskRunRequest { /** *The unique identifier of the machine learning transform.
* @public */ TransformId: string | undefined; } /** * @public */ export interface StartMLEvaluationTaskRunResponse { /** *The unique identifier associated with this run.
* @public */ TaskRunId?: string | undefined; } /** * @public */ export interface StartMLLabelingSetGenerationTaskRunRequest { /** *The unique identifier of the machine learning transform.
* @public */ TransformId: string | undefined; /** *The Amazon Simple Storage Service (Amazon S3) path where you generate the labeling * set.
* @public */ OutputS3Path: string | undefined; } /** * @public */ export interface StartMLLabelingSetGenerationTaskRunResponse { /** *The unique run identifier that is associated with this task run.
* @public */ TaskRunId?: string | undefined; } /** * @public */ export interface StartTriggerRequest { /** *The name of the trigger to start.
* @public */ Name: string | undefined; } /** * @public */ export interface StartTriggerResponse { /** *The name of the trigger that was started.
* @public */ Name?: string | undefined; } /** * @public */ export interface StartWorkflowRunRequest { /** *The name of the workflow to start.
* @public */ Name: string | undefined; /** *The workflow run properties for the new workflow run.
*Run properties may be logged. Do not pass plaintext secrets as properties. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to use them within the workflow run.
* @public */ RunProperties?: RecordAn Id for the new run.
* @public */ RunId?: string | undefined; } /** * @public */ export interface StopColumnStatisticsTaskRunRequest { /** *The name of the database where the table resides.
* @public */ DatabaseName: string | undefined; /** *The name of the table.
* @public */ TableName: string | undefined; } /** * @public */ export interface StopColumnStatisticsTaskRunResponse { } /** * @public */ export interface StopColumnStatisticsTaskRunScheduleRequest { /** *The name of the database where the table resides.
* @public */ DatabaseName: string | undefined; /** *The name of the table for which to stop a column statistic task run schedule.
* @public */ TableName: string | undefined; } /** * @public */ export interface StopColumnStatisticsTaskRunScheduleResponse { } /** * @public */ export interface StopCrawlerRequest { /** *Name of the crawler to stop.
* @public */ Name: string | undefined; } /** * @public */ export interface StopCrawlerResponse { } /** * @public */ export interface StopCrawlerScheduleRequest { /** *Name of the crawler whose schedule state to set.
* @public */ CrawlerName: string | undefined; } /** * @public */ export interface StopCrawlerScheduleResponse { } /** * @public */ export interface StopMaterializedViewRefreshTaskRunRequest { /** *The ID of the Data Catalog where the table reside. If none is supplied, the account ID is used by default.
* @public */ CatalogId: string | undefined; /** *The name of the database where the table resides.
* @public */ DatabaseName: string | undefined; /** *The name of the table to generate statistics.
* @public */ TableName: string | undefined; } /** * @public */ export interface StopMaterializedViewRefreshTaskRunResponse { } /** * @public */ export interface StopSessionRequest { /** *The ID of the session to be stopped.
* @public */ Id: string | undefined; /** *The origin of the request.
* @public */ RequestOrigin?: string | undefined; } /** * @public */ export interface StopSessionResponse { /** *Returns the Id of the stopped session.
* @public */ Id?: string | undefined; } /** * @public */ export interface StopTriggerRequest { /** *The name of the trigger to stop.
* @public */ Name: string | undefined; } /** * @public */ export interface StopTriggerResponse { /** *The name of the trigger that was stopped.
* @public */ Name?: string | undefined; } /** * @public */ export interface StopWorkflowRunRequest { /** *The name of the workflow to stop.
* @public */ Name: string | undefined; /** *The ID of the workflow run to stop.
* @public */ RunId: string | undefined; } /** * @public */ export interface StopWorkflowRunResponse { } /** * @public */ export interface TagResourceRequest { /** *The ARN of the Glue resource to which to add the tags. For more * information about Glue resource ARNs, see the Glue ARN string pattern.
* @public */ ResourceArn: string | undefined; /** *Tags to add to this resource.
* @public */ TagsToAdd: RecordA structure that is used to specify testing a connection to a service.
* @public */ export interface TestConnectionInput { /** *The type of connection to test. This operation is only available for the JDBC or SALESFORCE connection types.
The key-value pairs that define parameters for the connection.
*JDBC connections use the following connection properties:
*Required: All of (HOST, PORT, JDBC_ENGINE) or JDBC_CONNECTION_URL.
Required: All of (USERNAME, PASSWORD) or SECRET_ID.
Optional: JDBC_ENFORCE_SSL, CUSTOM_JDBC_CERT, CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are used to configure SSL with JDBC.
SALESFORCE connections require the AuthenticationConfiguration member to be configured.
A structure containing the authentication configuration in the TestConnection request. Required for a connection to Salesforce using OAuth authentication.
* @public */ AuthenticationConfiguration?: AuthenticationConfigurationInput | undefined; } /** * @public */ export interface TestConnectionRequest { /** *Optional. The name of the connection to test. If only name is provided, the operation will get the connection and use that for testing.
* @public */ ConnectionName?: string | undefined; /** *The catalog ID where the connection resides.
* @public */ CatalogId?: string | undefined; /** *A structure that is used to specify testing a connection to a service.
* @public */ TestConnectionInput?: TestConnectionInput | undefined; } /** * @public */ export interface TestConnectionResponse { } /** * @public */ export interface UntagResourceRequest { /** *The Amazon Resource Name (ARN) of the resource from which to remove the tags.
* @public */ ResourceArn: string | undefined; /** *Tags to remove from this resource.
* @public */ TagsToRemove: string[] | undefined; } /** * @public */ export interface UntagResourceResponse { } /** * @public */ export interface UpdateBlueprintRequest { /** *The name of the blueprint.
* @public */ Name: string | undefined; /** *A description of the blueprint.
* @public */ Description?: string | undefined; /** *Specifies a path in Amazon S3 where the blueprint is published.
* @public */ BlueprintLocation: string | undefined; } /** * @public */ export interface UpdateBlueprintResponse { /** *Returns the name of the blueprint that was updated.
* @public */ Name?: string | undefined; } /** * @public */ export interface UpdateCatalogRequest { /** *The ID of the catalog.
* @public */ CatalogId: string | undefined; /** *A CatalogInput object specifying the new properties of an existing catalog.
Specifies a custom CSV classifier to be updated.
* @public */ export interface UpdateCsvClassifierRequest { /** *The name of the classifier.
* @public */ Name: string | undefined; /** *A custom symbol to denote what separates each column entry in the row.
* @public */ Delimiter?: string | undefined; /** *A custom symbol to denote what combines content into a single column value. It must be * different from the column delimiter.
* @public */ QuoteSymbol?: string | undefined; /** *Indicates whether the CSV file contains a header.
* @public */ ContainsHeader?: CsvHeaderOption | undefined; /** *A list of strings representing column names.
* @public */ Header?: string[] | undefined; /** *Specifies not to trim values before identifying the type of column values. The default value is true.
* @public */ DisableValueTrimming?: boolean | undefined; /** *Enables the processing of files that contain only one column.
* @public */ AllowSingleColumn?: boolean | undefined; /** *Specifies the configuration of custom datatypes.
* @public */ CustomDatatypeConfigured?: boolean | undefined; /** *Specifies a list of supported custom datatypes.
* @public */ CustomDatatypes?: string[] | undefined; /** *Sets the SerDe for processing CSV in the classifier, which will be applied in the Data Catalog. Valid values are OpenCSVSerDe, LazySimpleSerDe, and None. You can specify the None value when you want the crawler to do the detection.
Specifies a grok classifier to update when passed to
* UpdateClassifier.
The name of the GrokClassifier.
An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, * Amazon CloudWatch Logs, and so on.
* @public */ Classification?: string | undefined; /** *The grok pattern used by this classifier.
* @public */ GrokPattern?: string | undefined; /** *Optional custom grok patterns used by this classifier.
* @public */ CustomPatterns?: string | undefined; } /** *Specifies a JSON classifier to be updated.
* @public */ export interface UpdateJsonClassifierRequest { /** *The name of the classifier.
* @public */ Name: string | undefined; /** *A JsonPath string defining the JSON data for the classifier to classify.
* Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.
Specifies an XML classifier to be updated.
* @public */ export interface UpdateXMLClassifierRequest { /** *The name of the classifier.
* @public */ Name: string | undefined; /** *An identifier of the data format that the classifier matches.
* @public */ Classification?: string | undefined; /** *The XML tag designating the element that contains each record in an XML document being
* parsed. This cannot identify a self-closing element (closed by />). An empty
* row element that contains only attributes can be parsed as long as it ends with a closing tag
* (for example,
A GrokClassifier object with updated fields.
An XMLClassifier object with updated fields.
A JsonClassifier object with updated fields.
A CsvClassifier object with updated fields.
The ID of the Data Catalog where the partitions in question reside. * If none is supplied, the Amazon Web Services account ID is used by default.
* @public */ CatalogId?: string | undefined; /** *The name of the catalog database where the partitions reside.
* @public */ DatabaseName: string | undefined; /** *The name of the partitions' table.
* @public */ TableName: string | undefined; /** *A list of partition values identifying the partition.
* @public */ PartitionValues: string[] | undefined; /** *A list of the column statistics.
* @public */ ColumnStatisticsList: ColumnStatistics[] | undefined; } /** *Encapsulates a ColumnStatistics object that failed and the reason for failure.
The ColumnStatistics of the column.
An error message with the reason for the failure of an operation.
* @public */ Error?: ErrorDetail | undefined; } /** * @public */ export interface UpdateColumnStatisticsForPartitionResponse { /** *Error occurred during updating column statistics data.
* @public */ Errors?: ColumnStatisticsError[] | undefined; } /** * @public */ export interface UpdateColumnStatisticsForTableRequest { /** *The ID of the Data Catalog where the partitions in question reside. * If none is supplied, the Amazon Web Services account ID is used by default.
* @public */ CatalogId?: string | undefined; /** *The name of the catalog database where the partitions reside.
* @public */ DatabaseName: string | undefined; /** *The name of the partitions' table.
* @public */ TableName: string | undefined; /** *A list of the column statistics.
* @public */ ColumnStatisticsList: ColumnStatistics[] | undefined; } /** * @public */ export interface UpdateColumnStatisticsForTableResponse { /** *List of ColumnStatisticsErrors.
* @public */ Errors?: ColumnStatisticsError[] | undefined; } /** * @public */ export interface UpdateColumnStatisticsTaskSettingsRequest { /** *The name of the database where the table resides.
* @public */ DatabaseName: string | undefined; /** *The name of the table for which to generate column statistics.
* @public */ TableName: string | undefined; /** *The role used for running the column statistics.
* @public */ Role?: string | undefined; /** *A schedule for running the column statistics, specified in CRON syntax.
* @public */ Schedule?: string | undefined; /** *A list of column names for which to run statistics.
* @public */ ColumnNameList?: string[] | undefined; /** *The percentage of data to sample.
* @public */ SampleSize?: number | undefined; /** *The ID of the Data Catalog in which the database resides.
* @public */ CatalogID?: string | undefined; /** *Name of the security configuration that is used to encrypt CloudWatch logs.
* @public */ SecurityConfiguration?: string | undefined; } /** * @public */ export interface UpdateColumnStatisticsTaskSettingsResponse { } /** * @public */ export interface UpdateConnectionRequest { /** *The ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services * account ID is used by default.
* @public */ CatalogId?: string | undefined; /** *The name of the connection definition to update.
* @public */ Name: string | undefined; /** *A ConnectionInput object that redefines the connection
* in question.
Name of the new crawler.
* @public */ Name: string | undefined; /** *The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the new crawler * to access customer resources.
* @public */ Role?: string | undefined; /** *The Glue database where results are stored, such as:
* arn:aws:daylight:us-east-1::database/sometable/*.
A description of the new crawler.
* @public */ Description?: string | undefined; /** *A list of targets to crawl.
* @public */ Targets?: CrawlerTargets | undefined; /** *A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run
* something every day at 12:15 UTC, you would specify:
* cron(15 12 * * ? *).
A list of custom classifiers that the user * has registered. By default, all built-in classifiers are included in a crawl, * but these custom classifiers always override the default classifiers * for a given classification.
* @public */ Classifiers?: string[] | undefined; /** *The table prefix used for catalog tables that are created.
* @public */ TablePrefix?: string | undefined; /** *The policy for the crawler's update and deletion behavior.
* @public */ SchemaChangePolicy?: SchemaChangePolicy | undefined; /** *A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
* @public */ RecrawlPolicy?: RecrawlPolicy | undefined; /** *Specifies data lineage configuration settings for the crawler.
* @public */ LineageConfiguration?: LineageConfiguration | undefined; /** *Specifies Lake Formation configuration settings for the crawler.
* @public */ LakeFormationConfiguration?: LakeFormationConfiguration | undefined; /** *Crawler configuration information. This versioned JSON string allows users * to specify aspects of a crawler's behavior. * For more information, see Setting crawler configuration options.
* @public */ Configuration?: string | undefined; /** *The name of the SecurityConfiguration structure to be used by this
* crawler.
The name of the crawler whose schedule to update.
* @public */ CrawlerName: string | undefined; /** *The updated cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run
* something every day at 12:15 UTC, you would specify:
* cron(15 12 * * ? *).
The ID of the Data Catalog in which the metadata database resides. If none is provided, * the Amazon Web Services account ID is used by default.
* @public */ CatalogId?: string | undefined; /** *The name of the database to update in the catalog. For Hive * compatibility, this is folded to lowercase.
* @public */ Name: string | undefined; /** *A DatabaseInput object specifying the new definition
* of the metadata database in the catalog.
The name of the data quality ruleset.
* @public */ Name: string | undefined; /** *A description of the ruleset.
* @public */ Description?: string | undefined; /** *A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
* @public */ Ruleset?: string | undefined; } /** * @public */ export interface UpdateDataQualityRulesetResponse { /** *The name of the data quality ruleset.
* @public */ Name?: string | undefined; /** *A description of the ruleset.
* @public */ Description?: string | undefined; /** *A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
* @public */ Ruleset?: string | undefined; } /** *Custom libraries to be loaded into a development endpoint.
* @public */ export interface DevEndpointCustomLibraries { /** *The paths to one or more Python libraries in an Amazon Simple Storage Service (Amazon S3)
* bucket that should be loaded in your DevEndpoint. Multiple values must be
* complete paths separated by a comma.
You can only use pure Python libraries with a DevEndpoint. Libraries that rely on
* C extensions, such as the pandas Python data
* analysis library, are not currently supported.
The path to one or more Java .jar files in an S3 bucket that should be loaded
* in your DevEndpoint.
You can only use pure Java/Scala libraries with a DevEndpoint.