From 9c425d59553f40ad25b30eff64a5715eb29be1c4 Mon Sep 17 00:00:00 2001
From: awstools Creates a new catalog in the Glue Data Catalog. Access to a resource was denied. A resource to be created or added already exists. Two processes are trying to modify a resource simultaneously. A specified entity does not exist A federated resource already exists. A federation source failed. An encryption operation failed. An internal service error occurred. The input provided was not valid. The operation timed out. A resource numerical limit was exceeded. Base exception class for all service exceptions from Glue service. A federated resource already exists. A federation source failed. A federation source failed, but the operation may be retried. An encryption operation failed. Creates a Zero-ETL integration in the caller's account between two resources with Amazon Resource Names (ARNs): the Access to a resource was denied. The A specified entity does not exist The requested operation conflicts with another operation. The data processed through your integration exceeded your quota. An internal server error occurred. An internal service error occurred. The input provided was not valid. The KMS key specified is not accessible. The resource could not be found. A resource numerical limit was exceeded. A value could not be validated. Base exception class for all service exceptions from Glue service. This API can be used for setting up the Access to a resource was denied. The A specified entity does not exist An internal server error occurred. An internal service error occurred. The input provided was not valid. The resource could not be found. A value could not be validated. Base exception class for all service exceptions from Glue service. This API is used to provide optional override properties for the the tables that need to be replicated. These properties can include properties for filtering and partitioning for the source and target tables. To set both source and target properties the same API need to be invoked with the Glue connection ARN as Access to a resource was denied. A specified entity does not exist An internal server error occurred. An internal service error occurred. The input provided was not valid. The resource could not be found. A value could not be validated. Base exception class for all service exceptions from Glue service. A specified entity does not exist A federation source failed. A federation source failed, but the operation may be retried. An encryption operation failed. Removes the specified catalog from the Glue Data Catalog. After completing this operation, you no longer have access to the databases, tables (and all table versions and partitions that might belong to the tables) and the user-defined functions in the deleted catalog. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service. To ensure the immediate deletion of all related resources before calling the Access to a resource was denied. Two processes are trying to modify a resource simultaneously. A specified entity does not exist A federation source failed. An encryption operation failed. An internal service error occurred. The input provided was not valid. The operation timed out. Base exception class for all service exceptions from Glue service. A specified entity does not exist A federation source failed. A federation source failed, but the operation may be retried. An internal service error occurred. Deletes the specified Zero-ETL integration. Access to a resource was denied. The A specified entity does not exist The requested operation conflicts with another operation. The specified integration could not be found. An internal server error occurred. An internal service error occurred. The input provided was not valid. The integration is in an invalid state. An error that indicates your data is in an invalid state. A value could not be validated. Base exception class for all service exceptions from Glue service. Deletes the table properties that have been created for the tables that need to be replicated. Access to a resource was denied. A specified entity does not exist An internal server error occurred. An internal service error occurred. The input provided was not valid. The resource could not be found. A value could not be validated. Base exception class for all service exceptions from Glue service. A specified entity does not exist A federation source failed. A federation source failed, but the operation may be retried. An internal service error occurred. The Access to a resource was denied. An internal service error occurred. The input provided was not valid. A value could not be validated. Base exception class for all service exceptions from Glue service. Provides details regarding the entity used with the connection type, with a description of the data model for each field in the selected entity. The response includes all the fields which make up the entity. Access to a resource was denied. A specified entity does not exist A federation source failed. An encryption operation failed. The input provided was not valid. The operation timed out. A value could not be validated. Base exception class for all service exceptions from Glue service. Returns a list of inbound integrations for the specified integration. Access to a resource was denied. A specified entity does not exist The specified integration could not be found. An internal server error occurred. An internal service error occurred. The input provided was not valid. The operation is not available in the region. The target resource could not be found. A value could not be validated. Base exception class for all service exceptions from Glue service. The API is used to retrieve a list of integrations. Access to a resource was denied. A specified entity does not exist The specified integration could not be found. An internal server error occurred. An internal service error occurred. The input provided was not valid. A value could not be validated. Base exception class for all service exceptions from Glue service. The name of the Catalog to retrieve. This should be all lowercase. Access to a resource was denied. A specified entity does not exist A federation source failed. A federation source failed, but the operation may be retried. An encryption operation failed. An internal service error occurred. The input provided was not valid. The operation timed out. Base exception class for all service exceptions from Glue service. Retrieves all catalogs defined in a catalog in the Glue Data Catalog. For a Redshift-federated catalog use case, this operation returns the list of catalogs mapped to Redshift databases in the Redshift namespace catalog. Access to a resource was denied. A specified entity does not exist A federation source failed. A federation source failed, but the operation may be retried. An encryption operation failed. An internal service error occurred. The input provided was not valid. The operation timed out. Base exception class for all service exceptions from Glue service. A federation source failed. A federation source failed, but the operation may be retried. An encryption operation failed. A specified entity does not exist A federation source failed. A federation source failed, but the operation may be retried. An encryption operation failed. This API is used to query preview data from a given connection type or from a native Amazon S3 based Glue Data Catalog. Returns records as an array of JSON blobs. Each record is formatted using Jackson JsonNode based on the field type defined by the Spark connectors generate schemas according to the same data type mapping as in the Access to a resource was denied. A specified entity does not exist A federation source failed. An encryption operation failed. The input provided was not valid. The operation timed out. A value could not be validated. Base exception class for all service exceptions from Glue service. This API is used for fetching the Access to a resource was denied. A specified entity does not exist An internal server error occurred. An internal service error occurred. The input provided was not valid. The resource could not be found. A value could not be validated. Base exception class for all service exceptions from Glue service. This API is used to retrieve optional override properties for the tables that need to be replicated. These properties can include properties for filtering and partition for source and target tables. Access to a resource was denied. A specified entity does not exist An internal server error occurred. An internal service error occurred. The input provided was not valid. The resource could not be found. A value could not be validated. Base exception class for all service exceptions from Glue service. The Access to a resource was denied. An internal service error occurred. Base exception class for all service exceptions from Glue service. Returns the available entities supported by the connection type. Access to a resource was denied. A specified entity does not exist A federation source failed. An encryption operation failed. The input provided was not valid. The operation timed out. A value could not be validated. Base exception class for all service exceptions from Glue service. Modifies a Zero-ETL integration in the caller's account. Access to a resource was denied. The A specified entity does not exist The requested operation conflicts with another operation. The specified integration could not be found. An internal server error occurred. An internal service error occurred. The input provided was not valid. The integration is in an invalid state. An error that indicates your data is in an invalid state. A value could not be validated. Base exception class for all service exceptions from Glue service. Updates an existing catalog's properties in the Glue Data Catalog. Access to a resource was denied. Two processes are trying to modify a resource simultaneously. A specified entity does not exist A federation source failed. An encryption operation failed. An internal service error occurred. The input provided was not valid. The operation timed out. Base exception class for all service exceptions from Glue service. A resource to be created or added already exists. Two processes are trying to modify a resource simultaneously. A specified entity does not exist A federation source failed. A federation source failed, but the operation may be retried. An encryption operation failed. This API can be used for updating the Access to a resource was denied. A specified entity does not exist An internal server error occurred. An internal service error occurred. The input provided was not valid. The resource could not be found. A value could not be validated. Base exception class for all service exceptions from Glue service. This API is used to provide optional override properties for the tables that need to be replicated. These properties can include properties for filtering and partitioning for the source and target tables. To set both source and target properties the same API need to be invoked with the Glue connection ARN as The override will be reflected across all the integrations using same Access to a resource was denied. A specified entity does not exist An internal server error occurred. An internal service error occurred. The input provided was not valid. The resource could not be found. A value could not be validated. Base exception class for all service exceptions from Glue service. A resource to be created or added already exists. Two processes are trying to modify a resource simultaneously. A specified entity does not exist A federation source failed. A federation source failed, but the operation may be retried. An encryption operation failed. An object representing a value allowed for a property. A description of the allowed value. The value allowed for the property. A resource to be created or added already exists. An object that defines a connection type for a compute environment. The name of the property. A description of the property. Indicates whether the property is required. The default value for the property. Describes the type of property. A list of Indicates which data operations are applicable to the property. The authentication configuration for a connection returned by the The type of authentication for a connection. The Amazon Resource Name (ARN) for the Secrets Manager. A map of key-value pairs for the OAuth2 properties. Each value is a a A map of key-value pairs for the OAuth2 properties. Each value is a a A map of key-value pairs for the custom authentication properties. Each value is a a For supplying basic auth credentials when not providing a The username to connect to the data source. The password to connect to the data source. The set of properties required for the the OAuth2 The credentials used when the authentication type is OAuth2 authentication. The client application client secret if the client application is user managed. The access token used when the authentication type is OAuth2. The refresh token used when the authentication type is OAuth2. The JSON Web Token (JWT) used when the authentication type is OAuth2. A structure containing properties for OAuth2 in the CreateConnection request. The credentials used when the authentication type is OAuth2 authentication. The ARN of the KMS key used to encrypt the connection. Only taken an as input in the request and stored in the Secret Manager. The credentials used when the authentication type is basic authentication. The credentials used when the authentication type is custom authentication. Records a successful request to stop a specified The name of the job definition used in the job run that was stopped. The A list of the JobRuns that were successfully submitted for stopping. A list of the errors that were encountered in trying to stop A structure that contains the values and structure used to update a partition. A list of values defining the partitions. The structure used to update a partition. The ID of the catalog in which the partition is to be updated. Currently, this should be
- * the Amazon Web Services account ID. The name of the metadata database in which the partition is
- * to be updated. The name of the metadata table in which the partition is to be updated. A list of up to 100 Contains information about a batch update partition error. A list of values defining the partitions. The details about the batch update partition error. The errors encountered when trying to update the requested partitions. A list of The unique run identifier associated with this run. Records a successful request to stop a specified The name of the job definition used in the job run that was stopped. The A list of the JobRuns that were successfully submitted for stopping. A list of the errors that were encountered in trying to stop A structure that contains the values and structure used to update a partition. A list of values defining the partitions. The structure used to update a partition. The ID of the catalog in which the partition is to be updated. Currently, this should be
+ * the Amazon Web Services account ID. The name of the metadata database in which the partition is
+ * to be updated. The name of the metadata table in which the partition is to be updated. A list of up to 100 Contains information about a batch update partition error. A list of values defining the partitions. The details about the batch update partition error. The errors encountered when trying to update the requested partitions. A list of The unique run identifier associated with this run. Two processes are trying to modify a resource simultaneously. A message describing the problem. Input properties to configure data lake access for your catalog resource in the Glue Data Catalog. Turns on or off data lake access for Apache Spark applications that access Amazon Redshift databases in the Data Catalog from any non-Redshift engine, such as Amazon Athena, Amazon EMR, or Glue ETL. A role that will be assumed by Glue for transferring data into/out of the staging bucket during a query. An encryption key that will be used for the staging bucket that will be created along with the catalog. Specifies a federated catalog type for the native catalog resource. The currently supported type is A structure that specifies data lake access properties and other custom properties. A Additional key-value properties for the catalog, such as column statistics optimizations. Specifies a custom CSV classifier for The Lake Formation principal. The name of the classifier. A custom symbol to denote what separates each column entry in the row. An identifier for the Lake Formation principal. Permissions granted to a principal. A custom symbol to denote what combines content into a single column value. Must be different from the column delimiter. The principal who is granted permissions. Indicates whether the CSV file contains a header. The permissions that are granted to the principal. A catalog that points to an entity outside the Glue Data Catalog. A list of strings representing column names. A unique identifier for the federated catalog. Specifies not to trim values before identifying the type of column values. The default value is true. The name of the connection to an external data source, for example a Redshift-federated catalog. A structure that describes a target catalog for resource linking. Enables the processing of files that contain only one column. The Amazon Resource Name (ARN) of the catalog resource. A structure that describes catalog properties. Enables the configuration of custom datatypes. Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern. A description of the catalog. Creates a list of supported custom datatypes. A Sets the SerDe for processing CSV in the classifier, which will be applied in the Data Catalog. Valid values are A map array of key-value pairs that define the parameters and properties of the catalog. Specifies a An identifier of the data format that the classifier matches,
- * such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on. A The name of the new classifier. A The grok pattern used by this classifier. An array of Optional custom grok patterns used by this classifier. An array of Specifies a JSON classifier for The name of the classifier. The name of the catalog to create. A A Specifies an XML classifier for An identifier of the data format that the classifier matches. A map array of key-value pairs, not more than 50 pairs. Each key is a UTF-8 string, not less than 1 or more than 128 bytes long. Each value is a UTF-8 string, not more than 256 bytes long. The tags you assign to the catalog. A federated resource already exists. The message describing the problem. The associated Glue resource already exists. Specifies a custom CSV classifier for The name of the classifier. A custom symbol to denote what separates each column entry in the row. A custom symbol to denote what combines content into a single column value. Must be different from the column delimiter. Indicates whether the CSV file contains a header. A list of strings representing column names. Specifies not to trim values before identifying the type of column values. The default value is true. Enables the processing of files that contain only one column. Enables the configuration of custom datatypes. Creates a list of supported custom datatypes. Sets the SerDe for processing CSV in the classifier, which will be applied in the Data Catalog. Valid values are Specifies a An identifier of the data format that the classifier matches,
+ * such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on. The name of the new classifier. The grok pattern used by this classifier. Optional custom grok patterns used by this classifier. Specifies a JSON classifier for The name of the classifier. A Specifies an XML classifier for An identifier of the data format that the classifier matches. The name of the classifier. A structure that is used to specify a connection to create or update.
- * Requires the
*
+CreateCatalog
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/CreateCatalogCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/CreateCatalogCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/CreateCatalogCommandOutput/)
+
@@ -460,6 +468,30 @@ CreateDevEndpoint
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/CreateDevEndpointCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/CreateDevEndpointCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/CreateDevEndpointCommandOutput/)
+
+CreateIntegration
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/CreateIntegrationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/CreateIntegrationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/CreateIntegrationCommandOutput/)
+
+
+CreateIntegrationResourceProperty
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/CreateIntegrationResourcePropertyCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/CreateIntegrationResourcePropertyCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/CreateIntegrationResourcePropertyCommandOutput/)
+
+
+CreateIntegrationTableProperties
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/CreateIntegrationTablePropertiesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/CreateIntegrationTablePropertiesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/CreateIntegrationTablePropertiesCommandOutput/)
+
@@ -588,6 +620,14 @@ DeleteBlueprint
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/DeleteBlueprintCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/DeleteBlueprintCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/DeleteBlueprintCommandOutput/)
+
+DeleteCatalog
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/DeleteCatalogCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/DeleteCatalogCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/DeleteCatalogCommandOutput/)
+
@@ -668,6 +708,22 @@ DeleteDevEndpoint
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/DeleteDevEndpointCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/DeleteDevEndpointCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/DeleteDevEndpointCommandOutput/)
+
+DeleteIntegration
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/DeleteIntegrationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/DeleteIntegrationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/DeleteIntegrationCommandOutput/)
+
+
+DeleteIntegrationTableProperties
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/DeleteIntegrationTablePropertiesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/DeleteIntegrationTablePropertiesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/DeleteIntegrationTablePropertiesCommandOutput/)
+
@@ -804,6 +860,38 @@ DeleteWorkflow
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/DeleteWorkflowCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/DeleteWorkflowCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/DeleteWorkflowCommandOutput/)
+
+DescribeConnectionType
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/DescribeConnectionTypeCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/DescribeConnectionTypeCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/DescribeConnectionTypeCommandOutput/)
+
+
+DescribeEntity
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/DescribeEntityCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/DescribeEntityCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/DescribeEntityCommandOutput/)
+
+
+DescribeInboundIntegrations
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/DescribeInboundIntegrationsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/DescribeInboundIntegrationsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/DescribeInboundIntegrationsCommandOutput/)
+
+
+DescribeIntegrations
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/DescribeIntegrationsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/DescribeIntegrationsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/DescribeIntegrationsCommandOutput/)
+
@@ -828,6 +916,14 @@ GetBlueprintRuns
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/GetBlueprintRunsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/GetBlueprintRunsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/GetBlueprintRunsCommandOutput/)
+
+GetCatalog
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/GetCatalogCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/GetCatalogCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/GetCatalogCommandOutput/)
+
@@ -836,6 +932,14 @@ GetCatalogImportStatus
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/GetCatalogImportStatusCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/GetCatalogImportStatusCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/GetCatalogImportStatusCommandOutput/)
+
+GetCatalogs
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/GetCatalogsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/GetCatalogsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/GetCatalogsCommandOutput/)
+
@@ -1036,6 +1140,30 @@ GetDevEndpoints
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/GetDevEndpointsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/GetDevEndpointsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/GetDevEndpointsCommandOutput/)
+
+GetEntityRecords
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/GetEntityRecordsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/GetEntityRecordsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/GetEntityRecordsCommandOutput/)
+
+
+GetIntegrationResourceProperty
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/GetIntegrationResourcePropertyCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/GetIntegrationResourcePropertyCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/GetIntegrationResourcePropertyCommandOutput/)
+
+
+GetIntegrationTableProperties
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/GetIntegrationTablePropertiesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/GetIntegrationTablePropertiesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/GetIntegrationTablePropertiesCommandOutput/)
+
@@ -1404,6 +1532,14 @@ ListColumnStatisticsTaskRuns
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/ListColumnStatisticsTaskRunsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/ListColumnStatisticsTaskRunsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/ListColumnStatisticsTaskRunsCommandOutput/)
+
+ListConnectionTypes
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/ListConnectionTypesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/ListConnectionTypesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/ListConnectionTypesCommandOutput/)
+
@@ -1484,6 +1620,14 @@ ListDevEndpoints
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/ListDevEndpointsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/ListDevEndpointsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/ListDevEndpointsCommandOutput/)
+
+ListEntities
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/ListEntitiesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/ListEntitiesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/ListEntitiesCommandOutput/)
+
@@ -1572,6 +1716,14 @@ ListWorkflows
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/ListWorkflowsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/ListWorkflowsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/ListWorkflowsCommandOutput/)
+
+ModifyIntegration
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/ModifyIntegrationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/ModifyIntegrationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/ModifyIntegrationCommandOutput/)
+
@@ -1868,6 +2020,14 @@ UpdateBlueprint
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/UpdateBlueprintCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/UpdateBlueprintCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/UpdateBlueprintCommandOutput/)
+
+UpdateCatalog
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/UpdateCatalogCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/UpdateCatalogCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/UpdateCatalogCommandOutput/)
+
@@ -1948,6 +2108,22 @@ UpdateDevEndpoint
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/UpdateDevEndpointCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/UpdateDevEndpointCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/UpdateDevEndpointCommandOutput/)
+
+UpdateIntegrationResourceProperty
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/UpdateIntegrationResourcePropertyCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/UpdateIntegrationResourcePropertyCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/UpdateIntegrationResourcePropertyCommandOutput/)
+
+
+UpdateIntegrationTableProperties
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/glue/command/UpdateIntegrationTablePropertiesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/UpdateIntegrationTablePropertiesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-glue/Interface/UpdateIntegrationTablePropertiesCommandOutput/)
+
diff --git a/clients/client-glue/src/Glue.ts b/clients/client-glue/src/Glue.ts
index 9ed7de860492..6c99203d4552 100644
--- a/clients/client-glue/src/Glue.ts
+++ b/clients/client-glue/src/Glue.ts
@@ -122,6 +122,11 @@ import {
CreateBlueprintCommandInput,
CreateBlueprintCommandOutput,
} from "./commands/CreateBlueprintCommand";
+import {
+ CreateCatalogCommand,
+ CreateCatalogCommandInput,
+ CreateCatalogCommandOutput,
+} from "./commands/CreateCatalogCommand";
import {
CreateClassifierCommand,
CreateClassifierCommandInput,
@@ -162,6 +167,21 @@ import {
CreateDevEndpointCommandInput,
CreateDevEndpointCommandOutput,
} from "./commands/CreateDevEndpointCommand";
+import {
+ CreateIntegrationCommand,
+ CreateIntegrationCommandInput,
+ CreateIntegrationCommandOutput,
+} from "./commands/CreateIntegrationCommand";
+import {
+ CreateIntegrationResourcePropertyCommand,
+ CreateIntegrationResourcePropertyCommandInput,
+ CreateIntegrationResourcePropertyCommandOutput,
+} from "./commands/CreateIntegrationResourcePropertyCommand";
+import {
+ CreateIntegrationTablePropertiesCommand,
+ CreateIntegrationTablePropertiesCommandInput,
+ CreateIntegrationTablePropertiesCommandOutput,
+} from "./commands/CreateIntegrationTablePropertiesCommand";
import { CreateJobCommand, CreateJobCommandInput, CreateJobCommandOutput } from "./commands/CreateJobCommand";
import {
CreateMLTransformCommand,
@@ -234,6 +254,11 @@ import {
DeleteBlueprintCommandInput,
DeleteBlueprintCommandOutput,
} from "./commands/DeleteBlueprintCommand";
+import {
+ DeleteCatalogCommand,
+ DeleteCatalogCommandInput,
+ DeleteCatalogCommandOutput,
+} from "./commands/DeleteCatalogCommand";
import {
DeleteClassifierCommand,
DeleteClassifierCommandInput,
@@ -284,6 +309,16 @@ import {
DeleteDevEndpointCommandInput,
DeleteDevEndpointCommandOutput,
} from "./commands/DeleteDevEndpointCommand";
+import {
+ DeleteIntegrationCommand,
+ DeleteIntegrationCommandInput,
+ DeleteIntegrationCommandOutput,
+} from "./commands/DeleteIntegrationCommand";
+import {
+ DeleteIntegrationTablePropertiesCommand,
+ DeleteIntegrationTablePropertiesCommandInput,
+ DeleteIntegrationTablePropertiesCommandOutput,
+} from "./commands/DeleteIntegrationTablePropertiesCommand";
import { DeleteJobCommand, DeleteJobCommandInput, DeleteJobCommandOutput } from "./commands/DeleteJobCommand";
import {
DeleteMLTransformCommand,
@@ -361,6 +396,26 @@ import {
DeleteWorkflowCommandInput,
DeleteWorkflowCommandOutput,
} from "./commands/DeleteWorkflowCommand";
+import {
+ DescribeConnectionTypeCommand,
+ DescribeConnectionTypeCommandInput,
+ DescribeConnectionTypeCommandOutput,
+} from "./commands/DescribeConnectionTypeCommand";
+import {
+ DescribeEntityCommand,
+ DescribeEntityCommandInput,
+ DescribeEntityCommandOutput,
+} from "./commands/DescribeEntityCommand";
+import {
+ DescribeInboundIntegrationsCommand,
+ DescribeInboundIntegrationsCommandInput,
+ DescribeInboundIntegrationsCommandOutput,
+} from "./commands/DescribeInboundIntegrationsCommand";
+import {
+ DescribeIntegrationsCommand,
+ DescribeIntegrationsCommandInput,
+ DescribeIntegrationsCommandOutput,
+} from "./commands/DescribeIntegrationsCommand";
import {
GetBlueprintCommand,
GetBlueprintCommandInput,
@@ -376,11 +431,13 @@ import {
GetBlueprintRunsCommandInput,
GetBlueprintRunsCommandOutput,
} from "./commands/GetBlueprintRunsCommand";
+import { GetCatalogCommand, GetCatalogCommandInput, GetCatalogCommandOutput } from "./commands/GetCatalogCommand";
import {
GetCatalogImportStatusCommand,
GetCatalogImportStatusCommandInput,
GetCatalogImportStatusCommandOutput,
} from "./commands/GetCatalogImportStatusCommand";
+import { GetCatalogsCommand, GetCatalogsCommandInput, GetCatalogsCommandOutput } from "./commands/GetCatalogsCommand";
import {
GetClassifierCommand,
GetClassifierCommandInput,
@@ -494,6 +551,21 @@ import {
GetDevEndpointsCommandInput,
GetDevEndpointsCommandOutput,
} from "./commands/GetDevEndpointsCommand";
+import {
+ GetEntityRecordsCommand,
+ GetEntityRecordsCommandInput,
+ GetEntityRecordsCommandOutput,
+} from "./commands/GetEntityRecordsCommand";
+import {
+ GetIntegrationResourcePropertyCommand,
+ GetIntegrationResourcePropertyCommandInput,
+ GetIntegrationResourcePropertyCommandOutput,
+} from "./commands/GetIntegrationResourcePropertyCommand";
+import {
+ GetIntegrationTablePropertiesCommand,
+ GetIntegrationTablePropertiesCommandInput,
+ GetIntegrationTablePropertiesCommandOutput,
+} from "./commands/GetIntegrationTablePropertiesCommand";
import {
GetJobBookmarkCommand,
GetJobBookmarkCommandInput,
@@ -664,6 +736,11 @@ import {
ListColumnStatisticsTaskRunsCommandInput,
ListColumnStatisticsTaskRunsCommandOutput,
} from "./commands/ListColumnStatisticsTaskRunsCommand";
+import {
+ ListConnectionTypesCommand,
+ ListConnectionTypesCommandInput,
+ ListConnectionTypesCommandOutput,
+} from "./commands/ListConnectionTypesCommand";
import {
ListCrawlersCommand,
ListCrawlersCommandInput,
@@ -710,6 +787,11 @@ import {
ListDevEndpointsCommandInput,
ListDevEndpointsCommandOutput,
} from "./commands/ListDevEndpointsCommand";
+import {
+ ListEntitiesCommand,
+ ListEntitiesCommandInput,
+ ListEntitiesCommandOutput,
+} from "./commands/ListEntitiesCommand";
import { ListJobsCommand, ListJobsCommandInput, ListJobsCommandOutput } from "./commands/ListJobsCommand";
import {
ListMLTransformsCommand,
@@ -757,6 +839,11 @@ import {
ListWorkflowsCommandInput,
ListWorkflowsCommandOutput,
} from "./commands/ListWorkflowsCommand";
+import {
+ ModifyIntegrationCommand,
+ ModifyIntegrationCommandInput,
+ ModifyIntegrationCommandOutput,
+} from "./commands/ModifyIntegrationCommand";
import {
PutDataCatalogEncryptionSettingsCommand,
PutDataCatalogEncryptionSettingsCommandInput,
@@ -922,6 +1009,11 @@ import {
UpdateBlueprintCommandInput,
UpdateBlueprintCommandOutput,
} from "./commands/UpdateBlueprintCommand";
+import {
+ UpdateCatalogCommand,
+ UpdateCatalogCommandInput,
+ UpdateCatalogCommandOutput,
+} from "./commands/UpdateCatalogCommand";
import {
UpdateClassifierCommand,
UpdateClassifierCommandInput,
@@ -972,6 +1064,16 @@ import {
UpdateDevEndpointCommandInput,
UpdateDevEndpointCommandOutput,
} from "./commands/UpdateDevEndpointCommand";
+import {
+ UpdateIntegrationResourcePropertyCommand,
+ UpdateIntegrationResourcePropertyCommandInput,
+ UpdateIntegrationResourcePropertyCommandOutput,
+} from "./commands/UpdateIntegrationResourcePropertyCommand";
+import {
+ UpdateIntegrationTablePropertiesCommand,
+ UpdateIntegrationTablePropertiesCommandInput,
+ UpdateIntegrationTablePropertiesCommandOutput,
+} from "./commands/UpdateIntegrationTablePropertiesCommand";
import { UpdateJobCommand, UpdateJobCommandInput, UpdateJobCommandOutput } from "./commands/UpdateJobCommand";
import {
UpdateJobFromSourceControlCommand,
@@ -1056,6 +1158,7 @@ const commands = {
CancelStatementCommand,
CheckSchemaVersionValidityCommand,
CreateBlueprintCommand,
+ CreateCatalogCommand,
CreateClassifierCommand,
CreateColumnStatisticsTaskSettingsCommand,
CreateConnectionCommand,
@@ -1064,6 +1167,9 @@ const commands = {
CreateDatabaseCommand,
CreateDataQualityRulesetCommand,
CreateDevEndpointCommand,
+ CreateIntegrationCommand,
+ CreateIntegrationResourcePropertyCommand,
+ CreateIntegrationTablePropertiesCommand,
CreateJobCommand,
CreateMLTransformCommand,
CreatePartitionCommand,
@@ -1080,6 +1186,7 @@ const commands = {
CreateUserDefinedFunctionCommand,
CreateWorkflowCommand,
DeleteBlueprintCommand,
+ DeleteCatalogCommand,
DeleteClassifierCommand,
DeleteColumnStatisticsForPartitionCommand,
DeleteColumnStatisticsForTableCommand,
@@ -1090,6 +1197,8 @@ const commands = {
DeleteDatabaseCommand,
DeleteDataQualityRulesetCommand,
DeleteDevEndpointCommand,
+ DeleteIntegrationCommand,
+ DeleteIntegrationTablePropertiesCommand,
DeleteJobCommand,
DeleteMLTransformCommand,
DeletePartitionCommand,
@@ -1107,10 +1216,16 @@ const commands = {
DeleteUsageProfileCommand,
DeleteUserDefinedFunctionCommand,
DeleteWorkflowCommand,
+ DescribeConnectionTypeCommand,
+ DescribeEntityCommand,
+ DescribeInboundIntegrationsCommand,
+ DescribeIntegrationsCommand,
GetBlueprintCommand,
GetBlueprintRunCommand,
GetBlueprintRunsCommand,
+ GetCatalogCommand,
GetCatalogImportStatusCommand,
+ GetCatalogsCommand,
GetClassifierCommand,
GetClassifiersCommand,
GetColumnStatisticsForPartitionCommand,
@@ -1136,6 +1251,9 @@ const commands = {
GetDataQualityRulesetEvaluationRunCommand,
GetDevEndpointCommand,
GetDevEndpointsCommand,
+ GetEntityRecordsCommand,
+ GetIntegrationResourcePropertyCommand,
+ GetIntegrationTablePropertiesCommand,
GetJobCommand,
GetJobBookmarkCommand,
GetJobRunCommand,
@@ -1182,6 +1300,7 @@ const commands = {
ImportCatalogToGlueCommand,
ListBlueprintsCommand,
ListColumnStatisticsTaskRunsCommand,
+ ListConnectionTypesCommand,
ListCrawlersCommand,
ListCrawlsCommand,
ListCustomEntityTypesCommand,
@@ -1192,6 +1311,7 @@ const commands = {
ListDataQualityStatisticAnnotationsCommand,
ListDataQualityStatisticsCommand,
ListDevEndpointsCommand,
+ ListEntitiesCommand,
ListJobsCommand,
ListMLTransformsCommand,
ListRegistriesCommand,
@@ -1203,6 +1323,7 @@ const commands = {
ListTriggersCommand,
ListUsageProfilesCommand,
ListWorkflowsCommand,
+ ModifyIntegrationCommand,
PutDataCatalogEncryptionSettingsCommand,
PutDataQualityProfileAnnotationCommand,
PutResourcePolicyCommand,
@@ -1240,6 +1361,7 @@ const commands = {
TestConnectionCommand,
UntagResourceCommand,
UpdateBlueprintCommand,
+ UpdateCatalogCommand,
UpdateClassifierCommand,
UpdateColumnStatisticsForPartitionCommand,
UpdateColumnStatisticsForTableCommand,
@@ -1250,6 +1372,8 @@ const commands = {
UpdateDatabaseCommand,
UpdateDataQualityRulesetCommand,
UpdateDevEndpointCommand,
+ UpdateIntegrationResourcePropertyCommand,
+ UpdateIntegrationTablePropertiesCommand,
UpdateJobCommand,
UpdateJobFromSourceControlCommand,
UpdateMLTransformCommand,
@@ -1656,6 +1780,17 @@ export interface Glue {
cb: (err: any, data?: CreateBlueprintCommandOutput) => void
): void;
+ /**
+ * @see {@link CreateCatalogCommand}
+ */
+ createCatalog(args: CreateCatalogCommandInput, options?: __HttpHandlerOptions): Promise
SourceArn
and TargetArn
.CreatePartitions
API was called on a table that has indexes enabled. ResourceProperty
of the Glue connection (for the source) or Glue database ARN (for the target). These properties can include the role to access the connection or database. To set both source and target properties the same API needs to be invoked with the Glue connection ARN as ResourceArn
with SourceProcessingProperties
and the Glue database ARN as ResourceArn
with TargetProcessingProperties
respectively.CreatePartitions
API was called on a table that has indexes enabled. ResourceArn
with SourceTableConfig
, and the Glue database ARN as ResourceArn
with TargetTableConfig
respectively.DeleteCatalog
operation, use DeleteTableVersion
(or BatchDeleteTableVersion
), DeletePartition
(or BatchDeletePartition
), DeleteTable
(or BatchDeleteTable
), DeleteUserDefinedFunction
and DeleteDatabase
to delete any resources that belong to the catalog.CreatePartitions
API was called on a table that has indexes enabled. DescribeConnectionType
API provides full details of the supported options for a given connection type in Glue.DescribeEntity
API.DescribeEntity
API. Spark connectors convert data to the appropriate data types matching the schema when returning rows.ResourceProperty
of the Glue connection (for the source) or Glue database ARN (for the target)ListConnectionTypes
API provides a discovery mechanism to learn available connection types in Glue. The response contains a list of connection types with high-level details of what is supported for each connection type. The connection types listed are the set of supported options for the ConnectionType
value in the CreateConnection
API.CreatePartitions
API was called on a table that has indexes enabled. ResourceProperty
of the Glue connection (for the source) or Glue database ARN (for the target). These properties can include the role to access the connection or database. Since the same resource can be used across multiple integrations, updating resource properties will impact all the integrations using it.ResourceArn
with SourceTableConfig
, and the Glue database ARN as ResourceArn
with TargetTableConfig
respectively.ResourceArn
and source table.AllowedValue
objects representing the values allowed for the property.DescribeConnectionType
API.Property
object.Property
object.Property
object.SecretArn
value.AUTHORIZATION_CODE
grant type workflow.JobRun
.JobRunId
of the job run that was stopped.JobRuns
,
- * including the JobRunId
for which each error was encountered and details about the
- * error.BatchUpdatePartitionRequestEntry
objects to update.BatchUpdatePartitionFailureEntry
objects.JobRun
.JobRunId
of the job run that was stopped.JobRuns
,
+ * including the JobRunId
for which each error was encountered and details about the
+ * error.BatchUpdatePartitionRequestEntry
objects to update.BatchUpdatePartitionFailureEntry
objects.aws:redshift
.DataLakeAccessProperties
object that specifies properties to configure data lake access for your catalog resource in the Glue Data Catalog.CreateClassifier
to create.FederatedCatalog
object. A FederatedCatalog
structure that references an entity outside the Glue Data Catalog, for example a Redshift database.OpenCSVSerDe
, LazySimpleSerDe
, and None
. You can specify the None
value when you want the crawler to do the detection.grok
classifier for CreateClassifier
- * to create.TargetRedshiftCatalog
object that describes a target catalog for resource linking.CatalogProperties
object that specifies data lake access properties and other custom properties.PrincipalPermissions
objects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Typically should be explicitly set as an empty list.PrincipalPermissions
objects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Typically should be explicitly set as an empty list.CreateClassifier
to create.JsonPath
string defining the JSON data for the classifier to classify.
- * Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.CatalogInput
object that defines the metadata for the catalog.CreateClassifier
to create.CreateClassifier
to create.OpenCSVSerDe
, LazySimpleSerDe
, and None
. You can specify the None
value when you want the crawler to do the detection.grok
classifier for CreateClassifier
+ * to create.CreateClassifier
to create.JsonPath
string defining the JSON data for the classifier to classify.
+ * Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.CreateClassifier
to create.SALESFORCE
- Designates a connection to Salesforce using OAuth authencation.
- *
- * AuthenticationConfiguration
member to be configured.VIEW_VALIDATION_REDSHIFT
- Designates a connection used for view validation by Amazon Redshift.CUSTOM
- Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.
- * SFTP
is not supported.
For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.
- *For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.
- * @public - */ - ConnectionType: ConnectionType | undefined; - - /** - *A list of criteria that can be used in selecting this connection.
- * @public - */ - MatchCriteria?: string[] | undefined; - - /** - *These key-value pairs define parameters for the connection.
- * @public - */ - ConnectionProperties: PartialThis field is not currently used.
- * @public - */ - AthenaProperties?: RecordThe physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup
, that are needed to successfully make this connection.
The authentication properties of the connection. Used for a Salesforce connection.
- * @public - */ - AuthenticationConfiguration?: AuthenticationConfigurationInput | undefined; - - /** - *A flag to validate the credentials during create connection. Used for a Salesforce connection. Default is true.
- * @public - */ - ValidateCredentials?: boolean | undefined; + *Additionally, a ConnectionType
for the following SaaS connectors is supported:
+ * FACEBOOKADS
- Designates a connection to Facebook Ads.
+ * GOOGLEADS
- Designates a connection to Google Ads.
+ * GOOGLESHEETS
- Designates a connection to Google Sheets.
+ * GOOGLEANALYTICS4
- Designates a connection to Google Analytics 4.
+ * HUBSPOT
- Designates a connection to HubSpot.
+ * INSTAGRAMADS
- Designates a connection to Instagram Ads.
+ * INTERCOM
- Designates a connection to Intercom.
+ * JIRACLOUD
- Designates a connection to Jira Cloud.
+ * MARKETO
- Designates a connection to Adobe Marketo Engage.
+ * NETSUITEERP
- Designates a connection to Oracle NetSuite.
+ * SALESFORCE
- Designates a connection to Salesforce using OAuth authentication.
+ * SALESFORCEMARKETINGCLOUD
- Designates a connection to Salesforce Marketing Cloud.
+ * SALESFORCEPARDOT
- Designates a connection to Salesforce Marketing Cloud Account Engagement (MCAE).
+ * SAPODATA
- Designates a connection to SAP OData.
+ * SERVICENOW
- Designates a connection to ServiceNow.
+ * SLACK
- Designates a connection to Slack.
+ * SNAPCHATADS
- Designates a connection to Snapchat Ads.
+ * STRIPE
- Designates a connection to Stripe.
+ * ZENDESK
- Designates a connection to Zendesk.
+ * ZOHOCRM
- Designates a connection to Zoho CRM.
For more information on the connection parameters needed for a particular connector, see the documentation for the connector in Adding an Glue connectionin the Glue User Guide.
+ *
+ * SFTP
is not supported.
For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.
+ *For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.
+ * @public + */ + ConnectionType: ConnectionType | undefined; + + /** + *A list of criteria that can be used in selecting this connection.
+ * @public + */ + MatchCriteria?: string[] | undefined; + + /** + *These key-value pairs define parameters for the connection.
+ * @public + */ + ConnectionProperties: PartialConnection properties specific to the Spark compute environment.
+ * @public + */ + SparkProperties?: RecordConnection properties specific to the Athena compute environment.
+ * @public + */ + AthenaProperties?: RecordConnection properties specific to the Python compute environment.
+ * @public + */ + PythonProperties?: RecordThe physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup
, that are needed to successfully make this connection.
The authentication properties of the connection.
+ * @public + */ + AuthenticationConfiguration?: AuthenticationConfigurationInput | undefined; + + /** + *A flag to validate the credentials during create connection. Default is true.
+ * @public + */ + ValidateCredentials?: boolean | undefined; + + /** + *The compute environments that the specified connection properties are validated against.
+ * @public + */ + ValidateForComputeEnvironments?: ComputeEnvironment[] | undefined; } /** @@ -1066,83 +1577,6 @@ export class IdempotentParameterMismatchException extends __BaseException { } } -/** - *Two processes are trying to modify a resource simultaneously.
- * @public - */ -export class ConcurrentModificationException extends __BaseException { - readonly name: "ConcurrentModificationException" = "ConcurrentModificationException"; - readonly $fault: "client" = "client"; - /** - *A message describing the problem.
- * @public - */ - Message?: string | undefined; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe Lake Formation principal.
- * @public - */ -export interface DataLakePrincipal { - /** - *An identifier for the Lake Formation principal.
- * @public - */ - DataLakePrincipalIdentifier?: string | undefined; -} - -/** - *Permissions granted to a principal.
- * @public - */ -export interface PrincipalPermissions { - /** - *The principal who is granted permissions.
- * @public - */ - Principal?: DataLakePrincipal | undefined; - - /** - *The permissions that are granted to the principal.
- * @public - */ - Permissions?: Permission[] | undefined; -} - /** *A database that points to an entity outside the Glue Data Catalog.
* @public @@ -1265,39 +1699,6 @@ export interface CreateDatabaseRequest { */ export interface CreateDatabaseResponse {} -/** - *A federated resource already exists.
- * @public - */ -export class FederatedResourceAlreadyExistsException extends __BaseException { - readonly name: "FederatedResourceAlreadyExistsException" = "FederatedResourceAlreadyExistsException"; - readonly $fault: "client" = "client"; - /** - *The message describing the problem.
- * @public - */ - Message?: string | undefined; - - /** - *The associated Glue resource already exists.
- * @public - */ - AssociatedGlueResource?: string | undefined; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeAn object representing an Glue table.
* @public @@ -1673,4732 +2074,4506 @@ export class ValidationException extends __BaseException { } /** + *The CreatePartitions
API was called on a table that has indexes enabled.
The unique name that was provided for this job definition.
+ *A message describing the problem.
* @public */ - Name?: string | undefined; + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe parameters to configure the find matches transform.
+ *The Tag
object represents a label that you can assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.
For more information about tags, and controlling access to resources in Glue, see + * Amazon Web Services Tags in Glue and Specifying Glue Resource + * ARNs in the developer guide.
* @public */ -export interface FindMatchesParameters { +export interface Tag { /** - *The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.
+ *The tag key. The key is required when you create a tag on an object. The key is case-sensitive, and must not contain the prefix aws.
* @public */ - PrimaryKeyColumnName?: string | undefined; + key?: string | undefined; /** - *The value selected when tuning your transform for a balance between precision and recall. - * A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a - * value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0 - * means very low recall, and choosing values close to 0.0 results in very low precision.
- *The precision metric indicates how often your model is correct when it predicts a match.
- *The recall metric indicates that for an actual match, how often your model predicts the - * match.
+ *The tag value. The value is optional when you create a tag on an object. The value is case-sensitive, and must not contain the prefix aws.
* @public */ - PrecisionRecallTradeoff?: number | undefined; + value?: string | undefined; +} +/** + * @public + */ +export interface CreateIntegrationRequest { /** - *The value that is selected when tuning your transform for a balance between accuracy and
- * cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0
- * means a bias purely for accuracy, which typically results in a higher cost, sometimes
- * substantially higher. A value of 0.0 means a bias purely for cost, which results in a less
- * accurate FindMatches
transform, sometimes with unacceptable accuracy.
Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.
- *Cost measures how many compute resources, and thus money, are consumed to run the - * transform.
+ *A unique name for an integration in Glue.
* @public */ - AccuracyCostTradeoff?: number | undefined; + IntegrationName: string | undefined; /** - *The value to switch on or off to force the output to match the provided labels from users. If the value is True
, the find matches
transform forces the output to match the provided labels. The results override the normal conflation results. If the value is False
, the find matches
transform does not ensure all the labels provided are respected, and the results rely on the trained model.
Note that setting this value to true may increase the conflation execution time.
+ *The ARN of the source resource for the integration.
* @public */ - EnforceProvidedLabels?: boolean | undefined; -} - -/** - * @public - * @enum - */ -export const TransformType = { - FIND_MATCHES: "FIND_MATCHES", -} as const; - -/** - * @public - */ -export type TransformType = (typeof TransformType)[keyof typeof TransformType]; + SourceArn: string | undefined; -/** - *The algorithm-specific parameters that are associated with the machine learning - * transform.
- * @public - */ -export interface TransformParameters { /** - *The type of machine learning transform.
- *For information about the types of machine learning transforms, see Creating Machine Learning Transforms.
+ *The ARN of the target resource for the integration.
* @public */ - TransformType: TransformType | undefined; + TargetArn: string | undefined; /** - *The parameters for the find matches algorithm.
+ *A description of the integration.
* @public */ - FindMatchesParameters?: FindMatchesParameters | undefined; -} + Description?: string | undefined; -/** - * @public - * @enum - */ -export const MLUserDataEncryptionModeString = { - DISABLED: "DISABLED", - SSEKMS: "SSE-KMS", -} as const; + /** + *Selects source tables for the integration using Maxwell filter syntax.
+ * @public + */ + DataFilter?: string | undefined; -/** - * @public - */ -export type MLUserDataEncryptionModeString = - (typeof MLUserDataEncryptionModeString)[keyof typeof MLUserDataEncryptionModeString]; + /** + *The ARN of a KMS key used for encrypting the channel.
+ * @public + */ + KmsKeyId?: string | undefined; -/** - *The encryption-at-rest settings of the transform that apply to accessing user data.
- * @public - */ -export interface MLUserDataEncryption { /** - *The encryption mode applied to user data. Valid values are:
- *DISABLED: encryption is disabled
- *SSEKMS: use of server-side encryption with Key Management Service (SSE-KMS) for user data stored in Amazon S3.
- *An optional set of non-secret key–value pairs that contains additional contextual information for encryption. This can only be provided if KMSKeyId
is provided.
The ID for the customer-provided KMS key.
+ *Metadata assigned to the resource consisting of a list of key-value pairs.
* @public */ - KmsKeyId?: string | undefined; + Tags?: Tag[] | 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.
- *Additionally, imported labels and trained transforms can now be encrypted using a customer provided KMS key.
+ *An error associated with a zero-ETL integration.
* @public */ -export interface TransformEncryption { +export interface IntegrationError { /** - *An MLUserDataEncryption
object containing the encryption mode and customer-provided KMS key ID.
The code associated with this error.
* @public */ - MlUserDataEncryption?: MLUserDataEncryption | undefined; + ErrorCode?: string | undefined; /** - *The name of the security configuration.
+ *A message describing the error.
* @public */ - TaskRunSecurityConfigurationName?: string | undefined; + ErrorMessage?: string | undefined; } /** * @public + * @enum */ -export interface CreateMLTransformRequest { +export const IntegrationStatus = { + ACTIVE: "ACTIVE", + CREATING: "CREATING", + DELETING: "DELETING", + FAILED: "FAILED", + MODIFYING: "MODIFYING", + NEEDS_ATTENTION: "NEEDS_ATTENTION", + SYNCING: "SYNCING", +} as const; + +/** + * @public + */ +export type IntegrationStatus = (typeof IntegrationStatus)[keyof typeof IntegrationStatus]; + +/** + * @public + */ +export interface CreateIntegrationResponse { /** - *The unique name that you give the transform when you create it.
+ *The ARN of the source resource for the integration.
* @public */ - Name: string | undefined; + SourceArn: string | undefined; /** - *A description of the machine learning transform that is being defined. The default is an - * empty string.
+ *The ARN of the target resource for the integration.
* @public */ - Description?: string | undefined; + TargetArn: string | undefined; /** - *A list of Glue table definitions used by the transform.
+ *A unique name for an integration in Glue.
* @public */ - InputRecordTables: GlueTable[] | undefined; + IntegrationName: string | undefined; /** - *The algorithmic parameters that are specific to the transform type used. Conditionally - * dependent on the transform type.
+ *A description of the integration.
* @public */ - Parameters: TransformParameters | undefined; + Description?: string | 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.
- *The Amazon Resource Name (ARN) for the created integration.
* @public */ - Role: string | undefined; + IntegrationArn: 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.
+ *The ARN of a KMS key used for encrypting the channel.
* @public */ - GlueVersion?: string | undefined; + KmsKeyId?: 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.
When the WorkerType
field is set to a value other than Standard
, the MaxCapacity
field is set automatically and becomes read-only.
An optional set of non-secret key–value pairs that contains additional contextual information for encryption.
* @public */ - MaxCapacity?: number | undefined; + AdditionalEncryptionContext?: RecordThe type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
+ *Metadata assigned to the resource consisting of a list of key-value pairs.
+ * @public + */ + Tags?: Tag[] | undefined; + + /** + *The status of the integration being created.
+ *The possible statuses are:
*For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
CREATING: The integration is being created.
*For the G.1X
worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
ACTIVE: The integration creation succeeds.
*For the G.2X
worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
MODIFYING: The integration is being modified.
*
- * MaxCapacity
is a mutually exclusive option with NumberOfWorkers
and WorkerType
.
If either NumberOfWorkers
or WorkerType
is set, then MaxCapacity
cannot be set.
FAILED: The integration creation fails.
*If MaxCapacity
is set then neither NumberOfWorkers
or WorkerType
can be set.
DELETING: The integration is deleted.
*If WorkerType
is set, then NumberOfWorkers
is required (and vice versa).
SYNCING: The integration is synchronizing.
*
- * MaxCapacity
and NumberOfWorkers
must both be at least 1.
NEEDS_ATTENTION: The integration needs attention, such as synchronization.
*The number of workers of a defined workerType
that are allocated when this task runs.
If WorkerType
is set, then NumberOfWorkers
is required (and vice versa).
The time when the integration was created, in UTC.
* @public */ - NumberOfWorkers?: number | undefined; + CreateTime: Date | undefined; /** - *The timeout of the 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).
A list of errors associated with the integration creation.
* @public */ - Timeout?: number | undefined; + Errors?: IntegrationError[] | undefined; /** - *The maximum number of times to retry a task for this transform after a task run fails.
+ *Selects source tables for the integration using Maxwell filter syntax.
* @public */ - MaxRetries?: number | undefined; + DataFilter?: string | undefined; +} +/** + *The requested operation conflicts with another operation.
+ * @public + */ +export class IntegrationConflictOperationFault extends __BaseException { + readonly name: "IntegrationConflictOperationFault" = "IntegrationConflictOperationFault"; + readonly $fault: "client" = "client"; /** - *The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
+ *A message describing the problem.
* @public */ - Tags?: RecordThe 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 + * @internal */ - TransformEncryption?: TransformEncryption | undefined; + constructor(opts: __ExceptionOptionTypeThe data processed through your integration exceeded your quota.
* @public */ -export interface CreateMLTransformResponse { +export class IntegrationQuotaExceededFault extends __BaseException { + readonly name: "IntegrationQuotaExceededFault" = "IntegrationQuotaExceededFault"; + readonly $fault: "client" = "client"; /** - *A unique identifier that is generated for the transform.
+ *A message describing the problem.
* @public */ - TransformId?: string | undefined; + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeAn internal server error occurred.
* @public */ -export interface CreatePartitionRequest { +export class InternalServerException extends __BaseException { + readonly name: "InternalServerException" = "InternalServerException"; + readonly $fault: "server" = "server"; /** - *The Amazon Web Services account ID of the catalog in which the partition is to be created.
+ *A message describing the problem.
* @public */ - CatalogId?: string | undefined; - + Message?: string | undefined; /** - *The name of the metadata database in which the partition is - * to be created.
- * @public + * @internal */ - DatabaseName: string | undefined; + constructor(opts: __ExceptionOptionTypeThe KMS key specified is not accessible.
+ * @public + */ +export class KMSKeyNotAccessibleFault extends __BaseException { + readonly name: "KMSKeyNotAccessibleFault" = "KMSKeyNotAccessibleFault"; + readonly $fault: "client" = "client"; /** - *The name of the metadata table in which the partition is to be created.
+ *A message describing the problem.
* @public */ - TableName: string | undefined; - + Message?: string | undefined; /** - *A PartitionInput
structure defining the partition
- * to be created.
The resource could not be found.
* @public */ -export interface CreatePartitionResponse {} - -/** - *A structure for a partition index.
- * @public - */ -export interface PartitionIndex { +export class ResourceNotFoundException extends __BaseException { + readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; + readonly $fault: "client" = "client"; /** - *The keys for the partition index.
+ *A message describing the problem.
* @public */ - Keys: string[] | undefined; + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe resource properties associated with the integration source.
+ * @public + */ +export interface SourceProcessingProperties { /** - *The name of the partition index.
+ *The IAM role to access the Glue connection.
* @public */ - IndexName: string | undefined; + RoleArn?: string | undefined; } /** + *The resource properties associated with the integration target.
* @public */ -export interface CreatePartitionIndexRequest { +export interface TargetProcessingProperties { /** - *The catalog ID where the table resides.
+ *The IAM role to access the Glue database.
* @public */ - CatalogId?: string | undefined; + RoleArn?: string | undefined; /** - *Specifies the name of a database in which you want to create a partition index.
+ *The ARN of the KMS key used for encryption.
* @public */ - DatabaseName: string | undefined; + KmsArn?: string | undefined; /** - *Specifies the name of a table in which you want to create a partition index.
+ *The Glue network connection to configure the Glue job running in the customer VPC.
* @public */ - TableName: string | undefined; + ConnectionName?: string | undefined; /** - *Specifies a PartitionIndex
structure to create a partition index in an existing table.
The ARN of an Eventbridge event bus to receive the integration status notification.
* @public */ - PartitionIndex: PartitionIndex | undefined; + EventBusArn?: string | undefined; } /** * @public */ -export interface CreatePartitionIndexResponse {} +export interface CreateIntegrationResourcePropertyRequest { + /** + *The connection ARN of the source, or the database ARN of the target.
+ * @public + */ + ResourceArn: string | undefined; + + /** + *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 CreateRegistryInput { +export interface CreateIntegrationResourcePropertyResponse { /** - *Name of the registry to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
+ *The connection ARN of the source, or the database ARN of the target.
* @public */ - RegistryName: string | undefined; + ResourceArn: string | undefined; /** - *A description of the registry. If description is not provided, there will not be any default value for this.
+ *The resource properties associated with the integration source.
* @public */ - Description?: string | undefined; + SourceProcessingProperties?: SourceProcessingProperties | undefined; /** - *Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API.
+ *The resource properties associated with the integration target.
* @public */ - Tags?: RecordProperties used by the source leg to process data from the source.
* @public */ -export interface CreateRegistryResponse { +export interface SourceTableConfig { /** - *The Amazon Resource Name (ARN) of the newly created registry.
+ *A list of fields used for column-level filtering.
* @public */ - RegistryArn?: string | undefined; + Fields?: string[] | undefined; /** - *The name of the registry.
+ *A condition clause used for row-level filtering.
* @public */ - RegistryName?: string | undefined; + FilterPredicate?: string | undefined; /** - *A description of the registry.
+ *Unique identifier of a record.
* @public */ - Description?: string | undefined; + PrimaryKey?: string[] | undefined; /** - *The tags for the registry.
+ *Incremental pull timestamp-based field.
* @public */ - Tags?: RecordA structure that describes how data is partitioned on the target.
+ * @public + */ +export interface IntegrationPartition { + /** + *The field name used to partition data on the target.
+ * @public + */ + FieldName?: string | undefined; + + /** + *Specifies a function used to partition data on the target.
+ * @public + */ + FunctionSpec?: string | undefined; } /** * @public * @enum */ -export const Compatibility = { - BACKWARD: "BACKWARD", - BACKWARD_ALL: "BACKWARD_ALL", - DISABLED: "DISABLED", - FORWARD: "FORWARD", - FORWARD_ALL: "FORWARD_ALL", +export const UnnestSpec = { FULL: "FULL", - FULL_ALL: "FULL_ALL", - NONE: "NONE", + NOUNNEST: "NOUNNEST", + TOPLEVEL: "TOPLEVEL", } as const; /** * @public */ -export type Compatibility = (typeof Compatibility)[keyof typeof Compatibility]; +export type UnnestSpec = (typeof UnnestSpec)[keyof typeof UnnestSpec]; /** - *A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
+ *Properties used by the target leg to partition the data on the target.
* @public */ -export interface RegistryId { +export interface TargetTableConfig { /** - *Name of the registry. Used only for lookup. One of RegistryArn
or RegistryName
has to be provided.
Specifies how nested objects are flattened to top-level elements. Valid values are: "TOPLEVEL", "FULL", or "NOUNNEST".
* @public */ - RegistryName?: string | undefined; + UnnestSpec?: UnnestSpec | undefined; /** - *Arn of the registry to be updated. One of RegistryArn
or RegistryName
has to be provided.
Determines the file layout on the target.
* @public */ - RegistryArn?: string | undefined; + PartitionSpec?: IntegrationPartition[] | undefined; + + /** + *The optional name of a target table.
+ * @public + */ + TargetTableName?: string | undefined; } /** * @public */ -export interface CreateSchemaInput { +export interface CreateIntegrationTablePropertiesRequest { /** - * This is a wrapper shape to contain the registry identity fields. If this is not provided, the default registry will be used. The ARN format for the same will be: arn:aws:glue:us-east-2:
.
The connection ARN of the source, or the database ARN of the target.
* @public */ - RegistryId?: RegistryId | undefined; + ResourceArn: string | undefined; /** - *Name of the schema to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
+ *The name of the table to be replicated.
* @public */ - SchemaName: string | undefined; + TableName: string | undefined; /** - *The data format of the schema definition. Currently AVRO
, JSON
and PROTOBUF
are supported.
A structure for the source table configuration.
* @public */ - DataFormat: DataFormat | undefined; + SourceTableConfig?: SourceTableConfig | undefined; /** - *The compatibility mode of the schema. The possible values are:
- *- * NONE: No compatibility mode applies. You can use this choice in development scenarios or if you do not know the compatibility mode that you want to apply to schemas. Any new version added will be accepted without undergoing a compatibility check.
- *- * DISABLED: This compatibility choice prevents versioning for a particular schema. You can use this choice to prevent future versioning of a schema.
- *- * BACKWARD: This compatibility choice is recommended as it allows data receivers to read both the current and one previous schema version. This means that for instance, a new schema version cannot drop data fields or change the type of these fields, so they can't be read by readers using the previous version.
- *- * BACKWARD_ALL: This compatibility choice allows data receivers to read both the current and all previous schema versions. You can use this choice when you need to delete fields or add optional fields, and check compatibility against all previous schema versions.
- *- * FORWARD: This compatibility choice allows data receivers to read both the current and one next schema version, but not necessarily later versions. You can use this choice when you need to add fields or delete optional fields, but only check compatibility against the last schema version.
- *- * FORWARD_ALL: This compatibility choice allows data receivers to read written by producers of any new registered schema. You can use this choice when you need to add fields or delete optional fields, and check compatibility against all previous schema versions.
- *- * FULL: This compatibility choice allows data receivers to read data written by producers using the previous or next version of the schema, but not necessarily earlier or later versions. You can use this choice when you need to add or remove optional fields, but only check compatibility against the last schema version.
- *- * FULL_ALL: This compatibility choice allows data receivers to read data written by producers using all previous schema versions. You can use this choice when you need to add or remove optional fields, and check compatibility against all previous schema versions.
- *A structure for the target table configuration.
* @public */ - Compatibility?: Compatibility | undefined; + TargetTableConfig?: TargetTableConfig | undefined; +} + +/** + * @public + */ +export interface CreateIntegrationTablePropertiesResponse {} +/** + * @public + */ +export interface CreateJobResponse { /** - *An optional description of the schema. If description is not provided, there will not be any automatic default value for this.
+ *The unique name that was provided for this job definition.
* @public */ - Description?: string | undefined; + Name?: string | undefined; +} +/** + *The parameters to configure the find matches transform.
+ * @public + */ +export interface FindMatchesParameters { /** - *Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API. If specified, follows the Amazon Web Services tags-on-create pattern.
+ *The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.
* @public */ - Tags?: RecordThe schema definition using the DataFormat
setting for SchemaName
.
The value selected when tuning your transform for a balance between precision and recall. + * A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a + * value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0 + * means very low recall, and choosing values close to 0.0 results in very low precision.
+ *The precision metric indicates how often your model is correct when it predicts a match.
+ *The recall metric indicates that for an actual match, how often your model predicts the + * match.
* @public */ - SchemaDefinition?: string | undefined; + PrecisionRecallTradeoff?: number | undefined; + + /** + *The value that is selected when tuning your transform for a balance between accuracy and
+ * cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0
+ * means a bias purely for accuracy, which typically results in a higher cost, sometimes
+ * substantially higher. A value of 0.0 means a bias purely for cost, which results in a less
+ * accurate FindMatches
transform, sometimes with unacceptable accuracy.
Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.
+ *Cost measures how many compute resources, and thus money, are consumed to run the + * transform.
+ * @public + */ + AccuracyCostTradeoff?: number | undefined; + + /** + *The value to switch on or off to force the output to match the provided labels from users. If the value is True
, the find matches
transform forces the output to match the provided labels. The results override the normal conflation results. If the value is False
, the find matches
transform does not ensure all the labels provided are respected, and the results rely on the trained model.
Note that setting this value to true may increase the conflation execution time.
+ * @public + */ + EnforceProvidedLabels?: boolean | undefined; } /** * @public * @enum */ -export const SchemaStatus = { - AVAILABLE: "AVAILABLE", - DELETING: "DELETING", - PENDING: "PENDING", +export const TransformType = { + FIND_MATCHES: "FIND_MATCHES", } as const; /** * @public */ -export type SchemaStatus = (typeof SchemaStatus)[keyof typeof SchemaStatus]; +export type TransformType = (typeof TransformType)[keyof typeof TransformType]; + +/** + *The algorithm-specific parameters that are associated with the machine learning + * transform.
+ * @public + */ +export interface TransformParameters { + /** + *The type of machine learning transform.
+ *For information about the types of machine learning transforms, see Creating Machine Learning Transforms.
+ * @public + */ + TransformType: TransformType | undefined; + + /** + *The parameters for the find matches algorithm.
+ * @public + */ + FindMatchesParameters?: FindMatchesParameters | undefined; +} /** * @public * @enum */ -export const SchemaVersionStatus = { - AVAILABLE: "AVAILABLE", - DELETING: "DELETING", - FAILURE: "FAILURE", - PENDING: "PENDING", +export const MLUserDataEncryptionModeString = { + DISABLED: "DISABLED", + SSEKMS: "SSE-KMS", } as const; /** * @public */ -export type SchemaVersionStatus = (typeof SchemaVersionStatus)[keyof typeof SchemaVersionStatus]; +export type MLUserDataEncryptionModeString = + (typeof MLUserDataEncryptionModeString)[keyof typeof MLUserDataEncryptionModeString]; /** + *The encryption-at-rest settings of the transform that apply to accessing user data.
* @public */ -export interface CreateSchemaResponse { +export interface MLUserDataEncryption { /** - *The name of the registry.
+ *The encryption mode applied to user data. Valid values are:
+ *DISABLED: encryption is disabled
+ *SSEKMS: use of server-side encryption with Key Management Service (SSE-KMS) for user data stored in Amazon S3.
+ *The Amazon Resource Name (ARN) of the registry.
+ *The ID for the customer-provided KMS key.
* @public */ - RegistryArn?: string | undefined; + KmsKeyId?: string | 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.
+ *Additionally, imported labels and trained transforms can now be encrypted using a customer provided KMS key.
+ * @public + */ +export interface TransformEncryption { /** - *The name of the schema.
+ *An MLUserDataEncryption
object containing the encryption mode and customer-provided KMS key ID.
The Amazon Resource Name (ARN) of the schema.
+ *The name of the security configuration.
* @public */ - SchemaArn?: string | undefined; + TaskRunSecurityConfigurationName?: string | undefined; +} +/** + * @public + */ +export interface CreateMLTransformRequest { /** - *A description of the schema if specified when created.
+ *The unique name that you give the transform when you create it.
* @public */ - Description?: string | undefined; + Name: string | undefined; /** - *The data format of the schema definition. Currently AVRO
, JSON
and PROTOBUF
are supported.
A description of the machine learning transform that is being defined. The default is an + * empty string.
* @public */ - DataFormat?: DataFormat | undefined; + Description?: string | undefined; /** - *The schema compatibility mode.
+ *A list of Glue table definitions used by the transform.
* @public */ - Compatibility?: Compatibility | undefined; + InputRecordTables: GlueTable[] | undefined; /** - *The version number of the checkpoint (the last time the compatibility mode was changed).
+ *The algorithmic parameters that are specific to the transform type used. Conditionally + * dependent on the transform type.
* @public */ - SchemaCheckpoint?: number | undefined; + Parameters: TransformParameters | undefined; /** - *The latest version of the schema associated with the returned schema definition.
+ *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.
+ *The next version of the schema associated with the returned schema definition.
+ *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 */ - NextSchemaVersion?: number | undefined; + GlueVersion?: string | undefined; /** - *The status of the schema.
+ *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.
When the WorkerType
field is set to a value other than Standard
, the MaxCapacity
field is set automatically and becomes read-only.
The tags for the schema.
+ *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.
+ * 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 unique identifier of the first schema version.
+ *The number of workers of a defined workerType
that are allocated when this task runs.
If WorkerType
is set, then NumberOfWorkers
is required (and vice versa).
The status of the first schema version created.
+ *The timeout of the 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).
Represents a directional edge in a directed acyclic graph (DAG).
- * @public - */ -export interface CodeGenEdge { /** - *The ID of the node at which the edge starts.
+ *The maximum number of times to retry a task for this transform after a task run fails.
* @public */ - Source: string | undefined; + MaxRetries?: number | undefined; /** - *The ID of the node at which the edge ends.
+ *The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
* @public */ - Target: string | undefined; + Tags?: RecordThe target of the edge.
+ *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 */ - TargetParameter?: string | undefined; + TransformEncryption?: TransformEncryption | undefined; } /** - *An argument or property of a node.
* @public */ -export interface CodeGenNodeArg { - /** - *The name of the argument or property.
- * @public - */ - Name: string | undefined; - - /** - *The value of the argument or property.
- * @public - */ - Value: string | undefined; - +export interface CreateMLTransformResponse { /** - *True if the value is used as a parameter.
+ *A unique identifier that is generated for the transform.
* @public */ - Param?: boolean | undefined; + TransformId?: string | undefined; } /** - *Represents a node in a directed acyclic graph (DAG)
* @public */ -export interface CodeGenNode { +export interface CreatePartitionRequest { /** - *A node identifier that is unique within the node's graph.
+ *The Amazon Web Services account ID of the catalog in which the partition is to be created.
* @public */ - Id: string | undefined; + CatalogId?: string | undefined; /** - *The type of node that this is.
+ *The name of the metadata database in which the partition is + * to be created.
* @public */ - NodeType: string | undefined; + DatabaseName: string | undefined; /** - *Properties of the node, in the form of name-value pairs.
+ *The name of the metadata table in which the partition is to be created.
* @public */ - Args: CodeGenNodeArg[] | undefined; + TableName: string | undefined; /** - *The line number of the node.
+ *A PartitionInput
structure defining the partition
+ * to be created.
A structure for a partition index.
* @public */ -export interface CreateScriptRequest { - /** - *A list of the nodes in the DAG.
- * @public - */ - DagNodes?: CodeGenNode[] | undefined; - +export interface PartitionIndex { /** - *A list of the edges in the DAG.
+ *The keys for the partition index.
* @public */ - DagEdges?: CodeGenEdge[] | undefined; + Keys: string[] | undefined; /** - *The programming language of the resulting code from the DAG.
+ *The name of the partition index.
* @public */ - Language?: Language | undefined; + IndexName: string | undefined; } /** * @public */ -export interface CreateScriptResponse { +export interface CreatePartitionIndexRequest { /** - *The Python script generated from the DAG.
+ *The catalog ID where the table resides.
* @public */ - PythonScript?: string | undefined; + CatalogId?: string | undefined; /** - *The Scala code generated from the DAG.
+ *Specifies the name of a database in which you want to create a partition index.
* @public */ - ScalaCode?: string | undefined; -} - -/** - * @public - * @enum - */ -export const CloudWatchEncryptionMode = { - DISABLED: "DISABLED", - SSEKMS: "SSE-KMS", -} as const; - -/** - * @public - */ -export type CloudWatchEncryptionMode = (typeof CloudWatchEncryptionMode)[keyof typeof CloudWatchEncryptionMode]; + DatabaseName: string | undefined; -/** - *Specifies how Amazon CloudWatch data should be encrypted.
- * @public - */ -export interface CloudWatchEncryption { /** - *The encryption mode to use for CloudWatch data.
+ *Specifies the name of a table in which you want to create a partition index.
* @public */ - CloudWatchEncryptionMode?: CloudWatchEncryptionMode | undefined; + TableName: string | undefined; /** - *The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
+ *Specifies a PartitionIndex
structure to create a partition index in an existing table.
Specifies how job bookmark data should be encrypted.
* @public */ -export interface JobBookmarksEncryption { +export interface CreateRegistryInput { /** - *The encryption mode to use for job bookmarks data.
+ *Name of the registry to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
* @public */ - JobBookmarksEncryptionMode?: JobBookmarksEncryptionMode | undefined; + RegistryName: string | undefined; /** - *The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
- * @public - */ - KmsKeyArn?: string | undefined; -} - -/** - * @public - * @enum - */ -export const S3EncryptionMode = { - DISABLED: "DISABLED", - SSEKMS: "SSE-KMS", - SSES3: "SSE-S3", -} as const; - -/** - * @public - */ -export type S3EncryptionMode = (typeof S3EncryptionMode)[keyof typeof S3EncryptionMode]; - -/** - *Specifies how Amazon Simple Storage Service (Amazon S3) data should be encrypted.
- * @public - */ -export interface S3Encryption { - /** - *The encryption mode to use for Amazon S3 data.
- * @public - */ - S3EncryptionMode?: S3EncryptionMode | undefined; - - /** - *The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
- * @public - */ - KmsKeyArn?: string | undefined; -} - -/** - *Specifies an encryption configuration.
- * @public - */ -export interface EncryptionConfiguration { - /** - *The encryption configuration for Amazon Simple Storage Service (Amazon S3) data.
- * @public - */ - S3Encryption?: S3Encryption[] | undefined; - - /** - *The encryption configuration for Amazon CloudWatch.
- * @public - */ - CloudWatchEncryption?: CloudWatchEncryption | undefined; - - /** - *The encryption configuration for job bookmarks.
- * @public - */ - JobBookmarksEncryption?: JobBookmarksEncryption | undefined; -} - -/** - * @public - */ -export interface CreateSecurityConfigurationRequest { - /** - *The name for the new security configuration.
- * @public - */ - Name: string | undefined; - - /** - *The encryption configuration for the new security configuration.
- * @public - */ - EncryptionConfiguration: EncryptionConfiguration | undefined; -} - -/** - * @public - */ -export interface CreateSecurityConfigurationResponse { - /** - *The name assigned to the new security configuration.
- * @public - */ - Name?: string | undefined; - - /** - *The time at which the new security configuration was created.
- * @public - */ - CreatedTimestamp?: Date | undefined; -} - -/** - *The SessionCommand
that runs the job.
Specifies the name of the SessionCommand. Can be 'glueetl' or 'gluestreaming'.
- * @public - */ - Name?: string | undefined; - - /** - *Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.
- * @public - */ - PythonVersion?: string | undefined; -} - -/** - *Request to create a new session.
- * @public - */ -export interface CreateSessionRequest { - /** - *The ID of the session request.
- * @public - */ - Id: string | undefined; - - /** - *The description of the session.
+ *A description of the registry. If description is not provided, there will not be any default value for this.
* @public */ Description?: string | undefined; /** - *The IAM Role ARN
- * @public - */ - Role: string | undefined; - - /** - *The SessionCommand
that runs the job.
- * The number of minutes before session times out. Default for Spark ETL - * jobs is 48 hours (2880 minutes), the maximum session lifetime for this job type. - * Consult the documentation for other job types. - *
- * @public - */ - Timeout?: number | undefined; - - /** - *- * The number of minutes when idle before session times out. Default for - * Spark ETL jobs is value of Timeout. Consult the documentation - * for other job types. - *
- * @public - */ - IdleTimeout?: number | undefined; - - /** - *A map array of key-value pairs. Max is 75 pairs.
- * @public - */ - DefaultArguments?: RecordThe number of connections to use for the session.
- * @public - */ - Connections?: ConnectionsList | undefined; - - /** - *The number of Glue data processing units (DPUs) that can be allocated when the job runs. - * A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
- * @public - */ - MaxCapacity?: number | undefined; - - /** - *The number of workers of a defined WorkerType
to use for the session.
The type of predefined worker that is allocated when a job runs. Accepts a value of - * G.1X, G.2X, G.4X, or G.8X for Spark jobs. Accepts the value Z.2X for Ray notebooks.
- *For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), 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 128GB disk (approximately 77GB free), 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 (approximately 235GB free), 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 (approximately 487GB free), 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 Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The name of the SecurityConfiguration structure to be used with the session
- * @public - */ - SecurityConfiguration?: string | undefined; - - /** - *The Glue version determines the versions of Apache Spark and Python that Glue supports. - * The GlueVersion must be greater than 2.0.
- * @public - */ - GlueVersion?: string | undefined; - - /** - *The map of key value pairs (tags) belonging to the session.
+ *Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API.
* @public */ Tags?: RecordThe origin of the request.
- * @public - */ - RequestOrigin?: string | undefined; } /** - * @public - * @enum - */ -export const SessionStatus = { - FAILED: "FAILED", - PROVISIONING: "PROVISIONING", - READY: "READY", - STOPPED: "STOPPED", - STOPPING: "STOPPING", - TIMEOUT: "TIMEOUT", -} as const; - -/** - * @public - */ -export type SessionStatus = (typeof SessionStatus)[keyof typeof SessionStatus]; - -/** - *The period in which a remote Spark runtime environment is running.
- * @public - */ -export interface Session { - /** - *The ID of the session.
- * @public - */ - Id?: string | undefined; - - /** - *The time and date when the session was created.
- * @public - */ - CreatedOn?: Date | undefined; - - /** - *The session status.
- * @public - */ - Status?: SessionStatus | undefined; - - /** - *The error message displayed during the session.
- * @public - */ - ErrorMessage?: string | undefined; - - /** - *The description of the session.
- * @public - */ - Description?: string | undefined; - - /** - *The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.
- * @public - */ - Role?: string | undefined; - - /** - *The command object.See SessionCommand.
- * @public - */ - Command?: SessionCommand | undefined; - - /** - *A map array of key-value pairs. Max is 75 pairs.
- * @public - */ - DefaultArguments?: RecordThe number of connections used for the session.
- * @public - */ - Connections?: ConnectionsList | undefined; - - /** - *The code execution progress of the session.
- * @public - */ - Progress?: number | undefined; - - /** - *The number of Glue data processing units (DPUs) that can be allocated when the job runs. - * A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
- * @public - */ - MaxCapacity?: number | undefined; - - /** - *The name of the SecurityConfiguration structure to be used with the session.
- * @public - */ - SecurityConfiguration?: string | undefined; - - /** - *The Glue version determines the versions of Apache Spark and Python that Glue supports. - * The GlueVersion must be greater than 2.0.
- * @public - */ - GlueVersion?: string | undefined; - - /** - *The number of workers of a defined WorkerType
to use for the session.
The type of predefined worker that is allocated when a session runs. Accepts a value of G.1X
, G.2X
, G.4X
, or G.8X
for Spark sessions. Accepts the value Z.2X
for Ray sessions.
The date and time that this session is completed.
- * @public - */ - CompletedOn?: Date | undefined; - - /** - *The total time the session ran for.
- * @public - */ - ExecutionTime?: number | undefined; - + * @public + */ +export interface CreateRegistryResponse { /** - *The DPUs consumed by the session (formula: ExecutionTime * MaxCapacity).
+ *The Amazon Resource Name (ARN) of the newly created registry.
* @public */ - DPUSeconds?: number | undefined; + RegistryArn?: string | undefined; /** - *The number of minutes when idle before the session times out.
+ *The name of the registry.
* @public */ - IdleTimeout?: number | undefined; + RegistryName?: string | undefined; /** - *The name of an Glue usage profile associated with the session.
+ *A description of the registry.
* @public */ - ProfileName?: string | undefined; -} + Description?: string | undefined; -/** - * @public - */ -export interface CreateSessionResponse { /** - *Returns the session object in the response.
+ *The tags for the registry.
* @public */ - Session?: Session | undefined; + Tags?: RecordA structure that defines an Apache Iceberg metadata table to create in the catalog.
+ *A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
* @public */ -export interface IcebergInput { +export interface RegistryId { /** - *A required metadata operation. Can only be set to CREATE
.
Name of the registry. Used only for lookup. One of RegistryArn
or RegistryName
has to be provided.
The table version for the Iceberg table. Defaults to 2.
+ *Arn of the registry to be updated. One of RegistryArn
or RegistryName
has to be provided.
A structure representing an open format table.
* @public */ -export interface OpenTableFormatInput { +export interface CreateSchemaInput { /** - *Specifies an IcebergInput
structure that defines an Apache Iceberg metadata table.
This is a wrapper shape to contain the registry identity fields. If this is not provided, the default registry will be used. The ARN format for the same will be: arn:aws:glue:us-east-2:
.
A structure that describes a target table for resource linking.
- * @public - */ -export interface TableIdentifier { /** - *The ID of the Data Catalog in which the table resides.
+ *Name of the schema to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
* @public */ - CatalogId?: string | undefined; + SchemaName: string | undefined; /** - *The name of the catalog database that contains the target table.
+ *The data format of the schema definition. Currently AVRO
, JSON
and PROTOBUF
are supported.
The name of the target table.
+ *The compatibility mode of the schema. The possible values are:
+ *+ * NONE: No compatibility mode applies. You can use this choice in development scenarios or if you do not know the compatibility mode that you want to apply to schemas. Any new version added will be accepted without undergoing a compatibility check.
+ *+ * DISABLED: This compatibility choice prevents versioning for a particular schema. You can use this choice to prevent future versioning of a schema.
+ *+ * BACKWARD: This compatibility choice is recommended as it allows data receivers to read both the current and one previous schema version. This means that for instance, a new schema version cannot drop data fields or change the type of these fields, so they can't be read by readers using the previous version.
+ *+ * BACKWARD_ALL: This compatibility choice allows data receivers to read both the current and all previous schema versions. You can use this choice when you need to delete fields or add optional fields, and check compatibility against all previous schema versions.
+ *+ * FORWARD: This compatibility choice allows data receivers to read both the current and one next schema version, but not necessarily later versions. You can use this choice when you need to add fields or delete optional fields, but only check compatibility against the last schema version.
+ *+ * FORWARD_ALL: This compatibility choice allows data receivers to read written by producers of any new registered schema. You can use this choice when you need to add fields or delete optional fields, and check compatibility against all previous schema versions.
+ *+ * FULL: This compatibility choice allows data receivers to read data written by producers using the previous or next version of the schema, but not necessarily earlier or later versions. You can use this choice when you need to add or remove optional fields, but only check compatibility against the last schema version.
+ *+ * FULL_ALL: This compatibility choice allows data receivers to read data written by producers using all previous schema versions. You can use this choice when you need to add or remove optional fields, and check compatibility against all previous schema versions.
+ *Region of the target table.
+ *An optional description of the schema. If description is not provided, there will not be any automatic default value for this.
* @public */ - Region?: string | undefined; + Description?: string | undefined; + + /** + *Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API. If specified, follows the Amazon Web Services tags-on-create pattern.
+ * @public + */ + Tags?: RecordThe schema definition using the DataFormat
setting for SchemaName
.
A structure containing details of a representation to update or create a Lake Formation view.
* @public + * @enum */ -export interface ViewRepresentationInput { +export const SchemaVersionStatus = { + AVAILABLE: "AVAILABLE", + DELETING: "DELETING", + FAILURE: "FAILURE", + PENDING: "PENDING", +} as const; + +/** + * @public + */ +export type SchemaVersionStatus = (typeof SchemaVersionStatus)[keyof typeof SchemaVersionStatus]; + +/** + * @public + */ +export interface CreateSchemaResponse { /** - *A parameter that specifies the engine type of a specific representation.
+ *The name of the registry.
* @public */ - Dialect?: ViewDialect | undefined; + RegistryName?: string | undefined; /** - *A parameter that specifies the version of the engine of a specific representation.
+ *The Amazon Resource Name (ARN) of the registry.
* @public */ - DialectVersion?: string | undefined; + RegistryArn?: string | undefined; /** - *A string that represents the original SQL query that describes the view.
+ *The name of the schema.
* @public */ - ViewOriginalText?: string | undefined; + SchemaName?: string | undefined; /** - *The name of the connection to be used to validate the specific representation of the view.
+ *The Amazon Resource Name (ARN) of the schema.
* @public */ - ValidationConnection?: string | undefined; + SchemaArn?: string | undefined; /** - *A string that represents the SQL query that describes the view with expanded resource ARNs
+ *A description of the schema if specified when created.
* @public */ - ViewExpandedText?: string | undefined; -} + Description?: string | undefined; -/** - *A structure containing details for creating or updating an Glue view.
- * @public - */ -export interface ViewDefinitionInput { /** - *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.
+ *The data format of the schema definition. Currently AVRO
, JSON
and PROTOBUF
are supported.
The definer of a view in SQL.
+ *The schema compatibility mode.
* @public */ - Definer?: string | undefined; + Compatibility?: Compatibility | undefined; /** - *A list of structures that contains the dialect of the view, and the query that defines the view.
+ *The version number of the checkpoint (the last time the compatibility mode was changed).
* @public */ - Representations?: ViewRepresentationInput[] | undefined; + SchemaCheckpoint?: number | undefined; /** - *A list of base table ARNs that make up the view.
+ *The latest version of the schema associated with the returned schema definition.
* @public */ - SubObjects?: string[] | undefined; -} + LatestSchemaVersion?: number | undefined; -/** - *A structure used to define a table.
- * @public - */ -export interface TableInput { /** - *The table name. For Hive compatibility, this is folded to - * lowercase when it is stored.
+ *The next version of the schema associated with the returned schema definition.
* @public */ - Name: string | undefined; + NextSchemaVersion?: number | undefined; /** - *A description of the table.
+ *The status of the schema.
* @public */ - Description?: string | undefined; + SchemaStatus?: SchemaStatus | undefined; /** - *The table owner. Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
+ *The tags for the schema.
* @public */ - Owner?: string | undefined; + Tags?: RecordThe last time that the table was accessed.
+ *The unique identifier of the first schema version.
* @public */ - LastAccessTime?: Date | undefined; + SchemaVersionId?: string | undefined; /** - *The last time that column statistics were computed for this table.
+ *The status of the first schema version created.
* @public */ - LastAnalyzedTime?: Date | undefined; + SchemaVersionStatus?: SchemaVersionStatus | undefined; +} +/** + *Represents a directional edge in a directed acyclic graph (DAG).
+ * @public + */ +export interface CodeGenEdge { /** - *The retention time for this table.
+ *The ID of the node at which the edge starts.
* @public */ - Retention?: number | undefined; + Source: string | undefined; /** - *A storage descriptor containing information about the physical storage - * of this table.
+ *The ID of the node at which the edge ends.
* @public */ - StorageDescriptor?: StorageDescriptor | undefined; + Target: string | undefined; /** - *A list of columns by which the table is partitioned. Only primitive - * types are supported as partition keys.
- *When you create a table used by Amazon Athena, and you do not specify any
- * partitionKeys
, you must at least set the value of partitionKeys
to
- * an empty list. For example:
- * "PartitionKeys": []
- *
The target of the edge.
+ * @public + */ + TargetParameter?: string | undefined; +} + +/** + *An argument or property of a node.
+ * @public + */ +export interface CodeGenNodeArg { + /** + *The name of the argument or property.
* @public */ - PartitionKeys?: Column[] | undefined; + Name: string | undefined; /** - *Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
- * If the table is a VIRTUAL_VIEW
, certain Athena configuration encoded in base64.
The value of the argument or property.
* @public */ - ViewOriginalText?: string | undefined; + Value: string | undefined; /** - *Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
+ *True if the value is used as a parameter.
* @public */ - ViewExpandedText?: string | undefined; + Param?: boolean | undefined; +} +/** + *Represents a node in a directed acyclic graph (DAG)
+ * @public + */ +export interface CodeGenNode { /** - *The type of this table.
- * Glue will create tables with the EXTERNAL_TABLE
type.
- * Other services, such as Athena, may create tables with additional table types.
- *
Glue related table types:
- *Hive compatible attribute - indicates a non-Hive managed table.
- *Used by Lake Formation.
- * The Glue Data Catalog understands GOVERNED
.
A node identifier that is unique within the node's graph.
* @public */ - TableType?: string | undefined; + Id: string | undefined; /** - *These key-value pairs define properties associated with the table.
+ *The type of node that this is.
* @public */ - Parameters?: RecordA TableIdentifier
structure that describes a target table for resource linking.
Properties of the node, in the form of name-value pairs.
* @public */ - TargetTable?: TableIdentifier | undefined; + Args: CodeGenNodeArg[] | undefined; /** - *A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
+ *The line number of the node.
* @public */ - ViewDefinition?: ViewDefinitionInput | undefined; + LineNumber?: number | undefined; } /** * @public + * @enum */ -export interface CreateTableRequest { - /** - *The ID of the Data Catalog in which to create the Table
.
- * If none is supplied, the Amazon Web Services account ID is used by default.
The catalog database in which to create the new table. For Hive - * compatibility, this name is entirely lowercase.
+ *A list of the nodes in the DAG.
* @public */ - DatabaseName: string | undefined; + DagNodes?: CodeGenNode[] | undefined; /** - *The TableInput
object that defines the metadata table
- * to create in the catalog.
A list of the edges in the DAG.
* @public */ - TableInput: TableInput | undefined; + DagEdges?: CodeGenEdge[] | undefined; /** - *A list of partition indexes, PartitionIndex
structures, to create in the table.
The programming language of the resulting code from the DAG.
* @public */ - PartitionIndexes?: PartitionIndex[] | undefined; + Language?: Language | undefined; +} +/** + * @public + */ +export interface CreateScriptResponse { /** - *The ID of the transaction.
+ *The Python script generated from the DAG.
* @public */ - TransactionId?: string | undefined; + PythonScript?: string | undefined; /** - *Specifies an OpenTableFormatInput
structure when creating an open format table.
The Scala code generated from the DAG.
* @public */ - OpenTableFormatInput?: OpenTableFormatInput | undefined; + ScalaCode?: string | undefined; } /** * @public + * @enum */ -export interface CreateTableResponse {} +export const CloudWatchEncryptionMode = { + DISABLED: "DISABLED", + SSEKMS: "SSE-KMS", +} as const; /** * @public */ -export interface CreateTableOptimizerRequest { - /** - *The Catalog ID of the table.
- * @public - */ - CatalogId: string | undefined; +export type CloudWatchEncryptionMode = (typeof CloudWatchEncryptionMode)[keyof typeof CloudWatchEncryptionMode]; +/** + *Specifies how Amazon CloudWatch data should be encrypted.
+ * @public + */ +export interface CloudWatchEncryption { /** - *The name of the database in the catalog in which the table resides.
+ *The encryption mode to use for CloudWatch data.
* @public */ - DatabaseName: string | undefined; + CloudWatchEncryptionMode?: CloudWatchEncryptionMode | undefined; /** - *The name of the table.
+ *The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
* @public */ - TableName: string | undefined; + KmsKeyArn?: string | undefined; +} + +/** + * @public + * @enum + */ +export const JobBookmarksEncryptionMode = { + CSEKMS: "CSE-KMS", + DISABLED: "DISABLED", +} as const; + +/** + * @public + */ +export type JobBookmarksEncryptionMode = (typeof JobBookmarksEncryptionMode)[keyof typeof JobBookmarksEncryptionMode]; +/** + *Specifies how job bookmark data should be encrypted.
+ * @public + */ +export interface JobBookmarksEncryption { /** - *The type of table optimizer.
+ *The encryption mode to use for job bookmarks data.
* @public */ - Type: TableOptimizerType | undefined; + JobBookmarksEncryptionMode?: JobBookmarksEncryptionMode | undefined; /** - *A TableOptimizerConfiguration
object representing the configuration of a table optimizer.
The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
* @public */ - TableOptimizerConfiguration: TableOptimizerConfiguration | undefined; + KmsKeyArn?: string | undefined; } /** * @public + * @enum */ -export interface CreateTableOptimizerResponse {} +export const S3EncryptionMode = { + DISABLED: "DISABLED", + SSEKMS: "SSE-KMS", + SSES3: "SSE-S3", +} as const; /** * @public */ -export interface CreateTriggerRequest { +export type S3EncryptionMode = (typeof S3EncryptionMode)[keyof typeof S3EncryptionMode]; + +/** + *Specifies how Amazon Simple Storage Service (Amazon S3) data should be encrypted.
+ * @public + */ +export interface S3Encryption { /** - *The name of the trigger.
+ *The encryption mode to use for Amazon S3 data.
* @public */ - Name: string | undefined; + S3EncryptionMode?: S3EncryptionMode | undefined; /** - *The name of the workflow associated with the trigger.
+ *The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
* @public */ - WorkflowName?: string | undefined; + KmsKeyArn?: string | undefined; +} +/** + *Specifies an encryption configuration.
+ * @public + */ +export interface EncryptionConfiguration { /** - *The type of the new trigger.
+ *The encryption configuration for Amazon Simple Storage Service (Amazon S3) data.
* @public */ - Type: TriggerType | undefined; + S3Encryption?: S3Encryption[] | 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 * * ? *)
.
This field is required when the trigger type is SCHEDULED.
+ *The encryption configuration for Amazon CloudWatch.
* @public */ - Schedule?: string | undefined; + CloudWatchEncryption?: CloudWatchEncryption | undefined; /** - *A predicate to specify when the new trigger should fire.
- *This field is required when the trigger type is CONDITIONAL
.
The encryption configuration for job bookmarks.
* @public */ - Predicate?: Predicate | undefined; + JobBookmarksEncryption?: JobBookmarksEncryption | undefined; +} +/** + * @public + */ +export interface CreateSecurityConfigurationRequest { /** - *The actions initiated by this trigger when it fires.
+ *The name for the new security configuration.
* @public */ - Actions: Action[] | undefined; + Name: string | undefined; /** - *A description of the new trigger.
+ *The encryption configuration for the new security configuration.
* @public */ - Description?: string | undefined; + EncryptionConfiguration: EncryptionConfiguration | undefined; +} +/** + * @public + */ +export interface CreateSecurityConfigurationResponse { /** - *Set to true
to start SCHEDULED
and CONDITIONAL
- * triggers when created. True is not supported for ON_DEMAND
triggers.
The name assigned to the new security configuration.
* @public */ - StartOnCreation?: boolean | undefined; + Name?: string | undefined; /** - *The tags to use with this trigger. You may use tags to limit access to the trigger. - * For more information about tags in Glue, see - * Amazon Web Services Tags in Glue in the developer guide.
+ *The time at which the new security configuration was created.
* @public */ - Tags?: RecordThe SessionCommand
that runs the job.
Batch condition that must be met (specified number of events received or batch time window expired) - * before EventBridge event trigger fires.
+ *Specifies the name of the SessionCommand. Can be 'glueetl' or 'gluestreaming'.
* @public */ - EventBatchingCondition?: EventBatchingCondition | undefined; + Name?: string | undefined; + + /** + *Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.
+ * @public + */ + PythonVersion?: string | undefined; } /** + *Request to create a new session.
* @public */ -export interface CreateTriggerResponse { +export interface CreateSessionRequest { /** - *The name of the trigger.
+ *The ID of the session request.
* @public */ - Name?: string | undefined; -} + Id: string | undefined; + + /** + *The description of the session.
+ * @public + */ + Description?: string | undefined; -/** - *Specifies the values that an admin sets for each job or session parameter configured in a Glue usage profile.
- * @public - */ -export interface ConfigurationObject { /** - *A default value for the parameter.
+ *The IAM Role ARN
* @public */ - DefaultValue?: string | undefined; + Role: string | undefined; /** - *A list of allowed values for the parameter.
+ *The SessionCommand
that runs the job.
A minimum allowed value for the parameter.
+ *+ * The number of minutes before session times out. Default for Spark ETL + * jobs is 48 hours (2880 minutes), the maximum session lifetime for this job type. + * Consult the documentation for other job types. + *
* @public */ - MinValue?: string | undefined; + Timeout?: number | undefined; /** - *A maximum allowed value for the parameter.
+ *+ * The number of minutes when idle before session times out. Default for + * Spark ETL jobs is value of Timeout. Consult the documentation + * for other job types. + *
* @public */ - MaxValue?: string | undefined; -} + IdleTimeout?: number | undefined; -/** - *Specifies the job and session values that an admin configures in an Glue usage profile.
- * @public - */ -export interface ProfileConfiguration { /** - *A key-value map of configuration parameters for Glue sessions.
+ *A map array of key-value pairs. Max is 75 pairs.
* @public */ - SessionConfiguration?: RecordA key-value map of configuration parameters for Glue jobs.
+ *The number of connections to use for the session.
* @public */ - JobConfiguration?: RecordThe name of the usage profile.
+ *The number of Glue data processing units (DPUs) that can be allocated when the job runs. + * A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
* @public */ - Name: string | undefined; + MaxCapacity?: number | undefined; /** - *A description of the usage profile.
+ *The number of workers of a defined WorkerType
to use for the session.
A ProfileConfiguration
object specifying the job and session values for the profile.
The type of predefined worker that is allocated when a job runs. Accepts a value of + * G.1X, G.2X, G.4X, or G.8X for Spark jobs. Accepts the value Z.2X for Ray notebooks.
+ *For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), 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 128GB disk (approximately 77GB free), 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 (approximately 235GB free), 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 (approximately 487GB free), 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 Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
A list of tags applied to the usage profile.
+ *The name of the SecurityConfiguration structure to be used with the session
* @public */ - Tags?: RecordThe name of the usage profile that was created.
+ *The Glue version determines the versions of Apache Spark and Python that Glue supports. + * The GlueVersion must be greater than 2.0.
* @public */ - Name?: string | undefined; -} + GlueVersion?: string | undefined; -/** - *The operation is not available in the region.
- * @public - */ -export class OperationNotSupportedException extends __BaseException { - readonly name: "OperationNotSupportedException" = "OperationNotSupportedException"; - readonly $fault: "client" = "client"; /** - *A message describing the problem.
+ *The map of key value pairs (tags) belonging to the session.
* @public */ - Message?: string | undefined; + Tags?: RecordThe origin of the request.
+ * @public */ - constructor(opts: __ExceptionOptionTypeThe period in which a remote Spark runtime environment is running.
* @public - * @enum */ -export const ResourceType = { - ARCHIVE: "ARCHIVE", - FILE: "FILE", - JAR: "JAR", -} as const; +export interface Session { + /** + *The ID of the session.
+ * @public + */ + Id?: string | undefined; -/** - * @public - */ -export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType]; + /** + *The time and date when the session was created.
+ * @public + */ + CreatedOn?: Date | undefined; -/** - *The URIs for function resources.
- * @public - */ -export interface ResourceUri { /** - *The type of the resource.
+ *The session status.
* @public */ - ResourceType?: ResourceType | undefined; + Status?: SessionStatus | undefined; /** - *The URI for accessing the resource.
+ *The error message displayed during the session.
* @public */ - Uri?: string | undefined; -} + ErrorMessage?: string | undefined; -/** - *A structure used to create or update a user-defined function.
- * @public - */ -export interface UserDefinedFunctionInput { /** - *The name of the function.
+ *The description of the session.
* @public */ - FunctionName?: string | undefined; + Description?: string | undefined; /** - *The Java class that contains the function code.
+ *The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.
* @public */ - ClassName?: string | undefined; + Role?: string | undefined; /** - *The owner of the function.
+ *The command object.See SessionCommand.
* @public */ - OwnerName?: string | undefined; + Command?: SessionCommand | undefined; /** - *The owner type.
+ *A map array of key-value pairs. Max is 75 pairs.
* @public */ - OwnerType?: PrincipalType | undefined; + DefaultArguments?: RecordThe resource URIs for the function.
+ *The number of connections used for the session.
* @public */ - ResourceUris?: ResourceUri[] | undefined; -} + Connections?: ConnectionsList | undefined; -/** - * @public - */ -export interface CreateUserDefinedFunctionRequest { /** - *The ID of the Data Catalog in which to create the function. If none is provided, the Amazon Web Services - * account ID is used by default.
+ *The code execution progress of the session.
* @public */ - CatalogId?: string | undefined; + Progress?: number | undefined; /** - *The name of the catalog database in which to create the function.
+ *The number of Glue data processing units (DPUs) that can be allocated when the job runs. + * A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
* @public */ - DatabaseName: string | undefined; + MaxCapacity?: number | undefined; /** - *A FunctionInput
object that defines the function
- * to create in the Data Catalog.
The name of the SecurityConfiguration structure to be used with the session.
* @public */ - FunctionInput: UserDefinedFunctionInput | undefined; -} + SecurityConfiguration?: string | undefined; -/** - * @public - */ -export interface CreateUserDefinedFunctionResponse {} + /** + *The Glue version determines the versions of Apache Spark and Python that Glue supports. + * The GlueVersion must be greater than 2.0.
+ * @public + */ + GlueVersion?: string | undefined; -/** - * @public - */ -export interface CreateWorkflowRequest { /** - *The name to be assigned to the workflow. It should be unique within your account.
+ *The number of workers of a defined WorkerType
to use for the session.
A description of the workflow.
+ *The type of predefined worker that is allocated when a session runs. Accepts a value of G.1X
, G.2X
, G.4X
, or G.8X
for Spark sessions. Accepts the value Z.2X
for Ray sessions.
A collection of properties to be used as part of each execution of the workflow.
+ *The date and time that this session is completed.
* @public */ - DefaultRunProperties?: RecordThe tags to be used with this workflow.
+ *The total time the session ran for.
* @public */ - Tags?: RecordThe DPUs consumed by the session (formula: ExecutionTime * MaxCapacity).
+ * @public + */ + DPUSeconds?: number | undefined; + + /** + *The number of minutes when idle before the session times out.
+ * @public + */ + IdleTimeout?: number | undefined; /** - *You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
+ *The name of an Glue usage profile associated with the session.
* @public */ - MaxConcurrentRuns?: number | undefined; + ProfileName?: string | undefined; } /** * @public */ -export interface CreateWorkflowResponse { +export interface CreateSessionResponse { /** - *The name of the workflow which was provided as part of the request.
+ *Returns the session object in the response.
* @public */ - Name?: string | undefined; + Session?: Session | undefined; } /** * @public + * @enum */ -export interface DeleteBlueprintRequest { - /** - *The name of the blueprint to delete.
- * @public - */ - Name: string | undefined; -} +export const MetadataOperation = { + CREATE: "CREATE", +} as const; /** * @public */ -export interface DeleteBlueprintResponse { - /** - *Returns the name of the blueprint that was deleted.
- * @public - */ - Name?: string | undefined; -} +export type MetadataOperation = (typeof MetadataOperation)[keyof typeof MetadataOperation]; /** + *A structure that defines an Apache Iceberg metadata table to create in the catalog.
* @public */ -export interface DeleteClassifierRequest { +export interface IcebergInput { /** - *Name of the classifier to remove.
+ *A required metadata operation. Can only be set to CREATE
.
The table version for the Iceberg table. Defaults to 2.
+ * @public + */ + Version?: string | undefined; } /** + *A structure representing an open format table.
* @public */ -export interface DeleteClassifierResponse {} +export interface OpenTableFormatInput { + /** + *Specifies an IcebergInput
structure that defines an Apache Iceberg metadata table.
A structure that describes a target table for resource linking.
* @public */ -export interface DeleteColumnStatisticsForPartitionRequest { +export interface TableIdentifier { /** - *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.
+ *The ID of the Data Catalog in which the table resides.
* @public */ CatalogId?: string | undefined; /** - *The name of the catalog database where the partitions reside.
- * @public - */ - DatabaseName: string | undefined; - - /** - *The name of the partitions' table.
+ *The name of the catalog database that contains the target table.
* @public */ - TableName: string | undefined; + DatabaseName?: string | undefined; /** - *A list of partition values identifying the partition.
+ *The name of the target table.
* @public */ - PartitionValues: string[] | undefined; + Name?: string | undefined; /** - *Name of the column.
+ *Region of the target table.
* @public */ - ColumnName: string | undefined; + Region?: string | undefined; } /** * @public + * @enum */ -export interface DeleteColumnStatisticsForPartitionResponse {} +export const ViewDialect = { + ATHENA: "ATHENA", + REDSHIFT: "REDSHIFT", + SPARK: "SPARK", +} as const; /** * @public */ -export interface DeleteColumnStatisticsForTableRequest { - /** - *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; +export type ViewDialect = (typeof ViewDialect)[keyof typeof ViewDialect]; +/** + *A structure containing details of a representation to update or create a Lake Formation view.
+ * @public + */ +export interface ViewRepresentationInput { /** - *The name of the catalog database where the partitions reside.
+ *A parameter that specifies the engine type of a specific representation.
* @public */ - DatabaseName: string | undefined; + Dialect?: ViewDialect | undefined; /** - *The name of the partitions' table.
+ *A parameter that specifies the version of the engine of a specific representation.
* @public */ - TableName: string | undefined; + DialectVersion?: string | undefined; /** - *The name of the column.
+ *A string that represents the original SQL query that describes the view.
* @public */ - ColumnName: string | undefined; -} - -/** - * @public - */ -export interface DeleteColumnStatisticsForTableResponse {} + ViewOriginalText?: string | undefined; -/** - * @public - */ -export interface DeleteColumnStatisticsTaskSettingsRequest { /** - *The name of the database where the table resides.
+ *The name of the connection to be used to validate the specific representation of the view.
* @public */ - DatabaseName: string | undefined; + ValidationConnection?: string | undefined; /** - *The name of the table for which to delete column statistics.
+ *A string that represents the SQL query that describes the view with expanded resource ARNs
* @public */ - TableName: string | undefined; + ViewExpandedText?: string | undefined; } /** + *A structure containing details for creating or updating an Glue view.
* @public */ -export interface DeleteColumnStatisticsTaskSettingsResponse {} - -/** - * @public - */ -export interface DeleteConnectionRequest { +export interface ViewDefinitionInput { /** - *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.
+ *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 */ - CatalogId?: string | undefined; + IsProtected?: boolean | undefined; /** - *The name of the connection to delete.
+ *The definer of a view in SQL.
* @public */ - ConnectionName: string | undefined; -} - -/** - * @public - */ -export interface DeleteConnectionResponse {} + Definer?: string | undefined; -/** - *The operation cannot be performed because the crawler is already running.
- * @public - */ -export class CrawlerRunningException extends __BaseException { - readonly name: "CrawlerRunningException" = "CrawlerRunningException"; - readonly $fault: "client" = "client"; /** - *A message describing the problem.
+ *A list of structures that contains the dialect of the view, and the query that defines the view.
* @public */ - Message?: string | undefined; + Representations?: ViewRepresentationInput[] | undefined; + /** - * @internal + *A list of base table ARNs that make up the view.
+ * @public */ - constructor(opts: __ExceptionOptionTypeA structure used to define a table.
* @public */ -export interface DeleteCrawlerRequest { +export interface TableInput { /** - *The name of the crawler to remove.
+ *The table name. For Hive compatibility, this is folded to + * lowercase when it is stored.
* @public */ Name: string | undefined; -} - -/** - * @public - */ -export interface DeleteCrawlerResponse {} -/** - *The specified scheduler is transitioning.
- * @public - */ -export class SchedulerTransitioningException extends __BaseException { - readonly name: "SchedulerTransitioningException" = "SchedulerTransitioningException"; - readonly $fault: "client" = "client"; /** - *A message describing the problem.
+ *A description of the table.
* @public */ - Message?: string | undefined; + Description?: string | undefined; + /** - * @internal + *The table owner. Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
+ * @public */ - constructor(opts: __ExceptionOptionTypeThe name of the custom pattern that you want to delete.
+ *The last time that the table was accessed.
* @public */ - Name: string | undefined; -} + LastAccessTime?: Date | undefined; -/** - * @public - */ -export interface DeleteCustomEntityTypeResponse { /** - *The name of the custom pattern you deleted.
+ *The last time that column statistics were computed for this table.
* @public */ - Name?: string | undefined; -} + LastAnalyzedTime?: Date | undefined; -/** - * @public - */ -export interface DeleteDatabaseRequest { /** - *The ID of the Data Catalog in which the database resides. If none is provided, the Amazon Web Services - * account ID is used by default.
+ *The retention time for this table.
* @public */ - CatalogId?: string | undefined; + Retention?: number | undefined; /** - *The name of the database to delete. For Hive compatibility, this must be all - * lowercase.
+ *A storage descriptor containing information about the physical storage + * of this table.
* @public */ - Name: string | undefined; -} + StorageDescriptor?: StorageDescriptor | undefined; -/** - * @public - */ -export interface DeleteDatabaseResponse {} + /** + *A list of columns by which the table is partitioned. Only primitive + * types are supported as partition keys.
+ *When you create a table used by Amazon Athena, and you do not specify any
+ * partitionKeys
, you must at least set the value of partitionKeys
to
+ * an empty list. For example:
+ * "PartitionKeys": []
+ *
A name for the data quality ruleset.
+ *Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
+ * If the table is a VIRTUAL_VIEW
, certain Athena configuration encoded in base64.
The name of the DevEndpoint
.
Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
* @public */ - EndpointName: string | undefined; -} - -/** - * @public - */ -export interface DeleteDevEndpointResponse {} + ViewExpandedText?: string | undefined; -/** - * @public - */ -export interface DeleteJobRequest { /** - *The name of the job definition to delete.
+ *The type of this table.
+ * Glue will create tables with the EXTERNAL_TABLE
type.
+ * Other services, such as Athena, may create tables with additional table types.
+ *
Glue related table types:
+ *Hive compatible attribute - indicates a non-Hive managed table.
+ *Used by Lake Formation.
+ * The Glue Data Catalog understands GOVERNED
.
The name of the job definition that was deleted.
+ *These key-value pairs define properties associated with the table.
* @public */ - JobName?: string | undefined; -} + Parameters?: RecordThe unique identifier of the transform to delete.
+ *A TableIdentifier
structure that describes a target table for resource linking.
The unique identifier of the transform that was deleted.
+ *A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
* @public */ - TransformId?: string | undefined; + ViewDefinition?: ViewDefinitionInput | undefined; } /** * @public */ -export interface DeletePartitionRequest { +export interface CreateTableRequest { /** - *The ID of the Data Catalog where the partition to be deleted resides. If none is provided, - * the Amazon Web Services account ID is used by default.
+ *The ID of the Data Catalog in which to create the Table
.
+ * If none is supplied, the Amazon Web Services account ID is used by default.
The name of the catalog database in which the table in question - * resides.
+ *The catalog database in which to create the new table. For Hive + * compatibility, this name is entirely lowercase.
* @public */ DatabaseName: string | undefined; /** - *The name of the table that contains the partition to be deleted.
+ *The TableInput
object that defines the metadata table
+ * to create in the catalog.
The values that define the partition.
+ *A list of partition indexes, PartitionIndex
structures, to create in the table.
The CreatePartitions
API was called on a table that has indexes enabled.
A message describing the problem.
+ *The ID of the transaction.
* @public */ - Message?: string | undefined; + TransactionId?: string | undefined; + /** - * @internal + *Specifies an OpenTableFormatInput
structure when creating an open format table.
The catalog ID where the table resides.
+ *The Catalog ID of the table.
* @public */ - CatalogId?: string | undefined; + CatalogId: string | undefined; /** - *Specifies the name of a database from which you want to delete a partition index.
+ *The name of the database in the catalog in which the table resides.
* @public */ DatabaseName: string | undefined; /** - *Specifies the name of a table from which you want to delete a partition index.
+ *The name of the table.
* @public */ TableName: string | undefined; /** - *The name of the partition index to be deleted.
+ *The type of table optimizer.
* @public */ - IndexName: string | undefined; -} - -/** - * @public - */ -export interface DeletePartitionIndexResponse {} + Type: TableOptimizerType | undefined; -/** - * @public - */ -export interface DeleteRegistryInput { /** - *This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
+ *A TableOptimizerConfiguration
object representing the configuration of a table optimizer.
The name of the registry being deleted.
+ *The name of the trigger.
* @public */ - RegistryName?: string | undefined; + Name: string | undefined; /** - *The Amazon Resource Name (ARN) of the registry being deleted.
+ *The name of the workflow associated with the trigger.
* @public */ - RegistryArn?: string | undefined; + WorkflowName?: string | undefined; /** - *The status of the registry. A successful operation will return the Deleting
status.
The type of the new trigger.
* @public */ - Status?: RegistryStatus | undefined; -} + Type: TriggerType | undefined; -/** - *A specified condition was not satisfied.
- * @public - */ -export class ConditionCheckFailureException extends __BaseException { - readonly name: "ConditionCheckFailureException" = "ConditionCheckFailureException"; - readonly $fault: "client" = "client"; /** - *A message describing the problem.
+ *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 * * ? *)
.
This field is required when the trigger type is SCHEDULED.
* @public */ - Message?: string | undefined; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe hash value returned when this policy was set.
+ *A predicate to specify when the new trigger should fire.
+ *This field is required when the trigger type is CONDITIONAL
.
The ARN of the Glue resource for the resource policy to be deleted.
+ *The actions initiated by this trigger when it fires.
* @public */ - ResourceArn?: string | undefined; -} - -/** - * @public - */ -export interface DeleteResourcePolicyResponse {} + Actions: Action[] | undefined; -/** - * @public - */ -export interface DeleteSchemaInput { /** - *This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
+ *A description of the new trigger.
* @public */ - SchemaId: SchemaId | undefined; -} + Description?: string | undefined; -/** - * @public - */ -export interface DeleteSchemaResponse { /** - *The Amazon Resource Name (ARN) of the schema being deleted.
+ *Set to true
to start SCHEDULED
and CONDITIONAL
+ * triggers when created. True is not supported for ON_DEMAND
triggers.
The name of the schema being deleted.
+ *The tags to use with this trigger. You may use tags to limit access to the trigger. + * For more information about tags in Glue, see + * Amazon Web Services Tags in Glue in the developer guide.
* @public */ - SchemaName?: string | undefined; + Tags?: RecordThe status of the schema.
+ *Batch condition that must be met (specified number of events received or batch time window expired) + * before EventBridge event trigger fires.
* @public */ - Status?: SchemaStatus | undefined; + EventBatchingCondition?: EventBatchingCondition | undefined; } /** * @public */ -export interface DeleteSchemaVersionsInput { - /** - *This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
- * @public - */ - SchemaId: SchemaId | undefined; - +export interface CreateTriggerResponse { /** - *A version range may be supplied which may be of the format:
- *a single version number, 5
- *a range, 5-8 : deletes versions 5, 6, 7, 8
- *The name of the trigger.
* @public */ - Versions: string | undefined; + Name?: string | undefined; } /** - *An object containing error details.
+ *Specifies the values that an admin sets for each job or session parameter configured in a Glue usage profile.
* @public */ -export interface ErrorDetails { +export interface ConfigurationObject { /** - *The error code for an error.
+ *A default value for the parameter.
* @public */ - ErrorCode?: string | undefined; + DefaultValue?: string | undefined; /** - *The error message for an error.
+ *A list of allowed values for the parameter.
* @public */ - ErrorMessage?: string | undefined; -} + AllowedValues?: string[] | undefined; -/** - *An object that contains the error details for an operation on a schema version.
- * @public - */ -export interface SchemaVersionErrorItem { /** - *The version number of the schema.
+ *A minimum allowed value for the parameter.
* @public */ - VersionNumber?: number | undefined; + MinValue?: string | undefined; /** - *The details of the error for the schema version.
+ *A maximum allowed value for the parameter.
* @public */ - ErrorDetails?: ErrorDetails | undefined; + MaxValue?: string | undefined; } /** + *Specifies the job and session values that an admin configures in an Glue usage profile.
* @public */ -export interface DeleteSchemaVersionsResponse { +export interface ProfileConfiguration { /** - *A list of SchemaVersionErrorItem
objects, each containing an error and schema version.
A key-value map of configuration parameters for Glue sessions.
* @public */ - SchemaVersionErrors?: SchemaVersionErrorItem[] | undefined; + SessionConfiguration?: RecordA key-value map of configuration parameters for Glue jobs.
+ * @public + */ + JobConfiguration?: RecordThe name of the security configuration to delete.
+ *The name of the usage profile.
* @public */ Name: string | undefined; -} -/** - * @public - */ -export interface DeleteSecurityConfigurationResponse {} + /** + *A description of the usage profile.
+ * @public + */ + Description?: string | undefined; -/** - * @public - */ -export interface DeleteSessionRequest { /** - *The ID of the session to be deleted.
+ *A ProfileConfiguration
object specifying the job and session values for the profile.
The name of the origin of the delete session request.
+ *A list of tags applied to the usage profile.
* @public */ - RequestOrigin?: string | undefined; + Tags?: RecordReturns the ID of the deleted session.
+ *The name of the usage profile that was created.
* @public */ - Id?: string | undefined; + Name?: string | undefined; } /** + *The operation is not available in the region.
* @public */ -export interface DeleteTableRequest { - /** - *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 catalog database in which the table resides. For Hive - * compatibility, this name is entirely lowercase.
- * @public - */ - DatabaseName: string | undefined; - +export class OperationNotSupportedException extends __BaseException { + readonly name: "OperationNotSupportedException" = "OperationNotSupportedException"; + readonly $fault: "client" = "client"; /** - *The name of the table to be deleted. For Hive - * compatibility, this name is entirely lowercase.
+ *A message describing the problem.
* @public */ - Name: string | undefined; - + Message?: string | undefined; /** - *The transaction ID at which to delete the table contents.
- * @public + * @internal */ - TransactionId?: string | undefined; + constructor(opts: __ExceptionOptionTypeThe 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; +export type PrincipalType = (typeof PrincipalType)[keyof typeof PrincipalType]; - /** - *The type of table optimizer.
- * @public - */ - Type: TableOptimizerType | undefined; -} +/** + * @public + * @enum + */ +export const ResourceType = { + ARCHIVE: "ARCHIVE", + FILE: "FILE", + JAR: "JAR", +} as const; /** * @public */ -export interface DeleteTableOptimizerResponse {} +export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType]; /** + *The URIs for function resources.
* @public */ -export interface DeleteTableVersionRequest { +export interface ResourceUri { /** - *The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account - * ID is used by default.
+ *The type of the resource.
* @public */ - CatalogId?: string | undefined; + ResourceType?: ResourceType | undefined; /** - *The database in the catalog in which the table resides. For Hive - * compatibility, this name is entirely lowercase.
+ *The URI for accessing the resource.
* @public */ - DatabaseName: string | undefined; + Uri?: string | undefined; +} +/** + *A structure used to create or update a user-defined function.
+ * @public + */ +export interface UserDefinedFunctionInput { /** - *The name of the table. For Hive compatibility, - * this name is entirely lowercase.
+ *The name of the function.
* @public */ - TableName: string | undefined; + FunctionName?: string | undefined; /** - *The ID of the table version to be deleted. A VersionID
is a string representation of an integer. Each version is incremented by 1.
The Java class that contains the function code.
* @public */ - VersionId: string | undefined; -} - -/** - * @public - */ -export interface DeleteTableVersionResponse {} + ClassName?: string | undefined; -/** - * @public - */ -export interface DeleteTriggerRequest { /** - *The name of the trigger to delete.
+ *The owner of the function.
* @public */ - Name: string | undefined; -} + OwnerName?: string | undefined; -/** - * @public - */ -export interface DeleteTriggerResponse { /** - *The name of the trigger that was deleted.
+ *The owner type.
* @public */ - Name?: string | undefined; -} + OwnerType?: PrincipalType | undefined; -/** - * @public - */ -export interface DeleteUsageProfileRequest { /** - *The name of the usage profile to delete.
+ *The resource URIs for the function.
* @public */ - Name: string | undefined; + ResourceUris?: ResourceUri[] | undefined; } /** * @public */ -export interface DeleteUsageProfileResponse {} - -/** - * @public - */ -export interface DeleteUserDefinedFunctionRequest { +export interface CreateUserDefinedFunctionRequest { /** - *The ID of the Data Catalog where the function to be deleted is - * located. If none is supplied, the Amazon Web Services account ID is used by default.
+ *The ID of the Data Catalog in which to create the function. 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.
+ *The name of the catalog database in which to create the function.
* @public */ DatabaseName: string | undefined; /** - *The name of the function definition to be deleted.
+ *A FunctionInput
object that defines the function
+ * to create in the Data Catalog.
Name of the workflow to be deleted.
+ *The name to be assigned to the workflow. It should be unique within your account.
* @public */ Name: string | undefined; -} -/** - * @public - */ -export interface DeleteWorkflowResponse { /** - *Name of the workflow specified in input.
+ *A description of the workflow.
* @public */ - Name?: string | undefined; -} + Description?: string | undefined; -/** - * @public - */ -export interface GetBlueprintRequest { /** - *The name of the blueprint.
+ *A collection of properties to be used as part of each execution of the workflow.
* @public */ - Name: string | undefined; + DefaultRunProperties?: RecordSpecifies whether or not to include the blueprint in the response.
+ *The tags to be used with this workflow.
* @public */ - IncludeBlueprint?: boolean | undefined; + Tags?: RecordSpecifies whether or not to include the parameter specification.
+ *You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
* @public */ - IncludeParameterSpec?: boolean | undefined; + MaxConcurrentRuns?: number | undefined; } /** * @public */ -export interface GetBlueprintResponse { +export interface CreateWorkflowResponse { /** - *Returns a Blueprint
object.
The name of the workflow which was provided as part of the request.
* @public */ - Blueprint?: Blueprint | undefined; + Name?: string | undefined; } /** * @public */ -export interface GetBlueprintRunRequest { +export interface DeleteBlueprintRequest { /** - *The name of the blueprint.
+ *The name of the blueprint to delete.
* @public */ - BlueprintName: string | undefined; + Name: string | undefined; +} +/** + * @public + */ +export interface DeleteBlueprintResponse { /** - *The run ID for the blueprint run you want to retrieve.
+ *Returns the name of the blueprint that was deleted.
* @public */ - RunId: string | undefined; + Name?: string | undefined; } /** * @public - * @enum */ -export const BlueprintRunState = { - FAILED: "FAILED", - ROLLING_BACK: "ROLLING_BACK", - RUNNING: "RUNNING", - SUCCEEDED: "SUCCEEDED", -} as const; +export interface DeleteCatalogRequest { + /** + *The ID of the catalog.
+ * @public + */ + CatalogId: string | undefined; +} /** * @public */ -export type BlueprintRunState = (typeof BlueprintRunState)[keyof typeof BlueprintRunState]; +export interface DeleteCatalogResponse {} /** - *The details of a blueprint run.
* @public */ -export interface BlueprintRun { +export interface DeleteClassifierRequest { /** - *The name of the blueprint.
+ *Name of the classifier to remove.
* @public */ - BlueprintName?: string | undefined; + Name: string | undefined; +} + +/** + * @public + */ +export interface DeleteClassifierResponse {} +/** + * @public + */ +export interface DeleteColumnStatisticsForPartitionRequest { /** - *The run ID for this blueprint run.
+ *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 */ - RunId?: string | undefined; + CatalogId?: string | undefined; /** - *The name of a workflow that is created as a result of a successful blueprint run. If a blueprint run has an error, there will not be a workflow created.
+ *The name of the catalog database where the partitions reside.
* @public */ - WorkflowName?: string | undefined; + DatabaseName: string | undefined; /** - *The state of the blueprint run. Possible values are:
- *Running — The blueprint run is in progress.
- *Succeeded — The blueprint run completed successfully.
- *Failed — The blueprint run failed and rollback is complete.
- *Rolling Back — The blueprint run failed and rollback is in progress.
- *The name of the partitions' table.
* @public */ - State?: BlueprintRunState | undefined; + TableName: string | undefined; /** - *The date and time that the blueprint run started.
+ *A list of partition values identifying the partition.
* @public */ - StartedOn?: Date | undefined; + PartitionValues: string[] | undefined; /** - *The date and time that the blueprint run completed.
+ *Name of the column.
* @public */ - CompletedOn?: Date | undefined; + ColumnName: string | undefined; +} + +/** + * @public + */ +export interface DeleteColumnStatisticsForPartitionResponse {} +/** + * @public + */ +export interface DeleteColumnStatisticsForTableRequest { /** - *Indicates any errors that are seen while running the blueprint.
+ *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 */ - ErrorMessage?: string | undefined; + CatalogId?: string | undefined; /** - *If there are any errors while creating the entities of a workflow, we try to roll back the created entities until that point and delete them. This attribute indicates the errors seen while trying to delete the entities that are created.
+ *The name of the catalog database where the partitions reside.
* @public */ - RollbackErrorMessage?: string | undefined; + DatabaseName: string | undefined; /** - *The blueprint parameters as a string. You will have to provide a value for each key that is required from the parameter spec that is defined in the Blueprint$ParameterSpec
.
The name of the partitions' table.
* @public */ - Parameters?: string | undefined; + TableName: string | undefined; /** - *The role ARN. This role will be assumed by the Glue service and will be used to create the workflow and other entities of a workflow.
+ *The name of the column.
* @public */ - RoleArn?: string | undefined; + ColumnName: string | undefined; } /** * @public */ -export interface GetBlueprintRunResponse { - /** - *Returns a BlueprintRun
object.
The name of the blueprint.
- * @public - */ - BlueprintName: string | undefined; - +export interface DeleteColumnStatisticsTaskSettingsRequest { /** - *A continuation token, if this is a continuation request.
+ *The name of the database where the table resides.
* @public */ - NextToken?: string | undefined; + DatabaseName: string | undefined; /** - *The maximum size of a list to return.
+ *The name of the table for which to delete column statistics.
* @public */ - MaxResults?: number | undefined; + TableName: string | undefined; } /** * @public */ -export interface GetBlueprintRunsResponse { +export interface DeleteColumnStatisticsTaskSettingsResponse {} + +/** + * @public + */ +export interface DeleteConnectionRequest { /** - *Returns a list of BlueprintRun
objects.
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 */ - BlueprintRuns?: BlueprintRun[] | undefined; + CatalogId?: string | undefined; /** - *A continuation token, if not all blueprint runs have been returned.
+ *The name of the connection to delete.
* @public */ - NextToken?: string | undefined; + ConnectionName: string | undefined; } /** * @public */ -export interface GetCatalogImportStatusRequest { - /** - *The ID of the catalog to migrate. Currently, this should be the Amazon Web Services account ID.
- * @public - */ - CatalogId?: string | undefined; -} +export interface DeleteConnectionResponse {} /** - *A structure containing migration status information.
+ *The operation cannot be performed because the crawler is already running.
* @public */ -export interface CatalogImportStatus { +export class CrawlerRunningException extends __BaseException { + readonly name: "CrawlerRunningException" = "CrawlerRunningException"; + readonly $fault: "client" = "client"; /** - *
- * True
if the migration has completed, or False
otherwise.
A message describing the problem.
* @public */ - ImportCompleted?: boolean | undefined; - + Message?: string | undefined; /** - *The time that the migration was started.
- * @public + * @internal */ - ImportTime?: Date | undefined; + constructor(opts: __ExceptionOptionTypeThe name of the person who initiated the migration.
+ *The name of the crawler to remove.
* @public */ - ImportedBy?: string | undefined; + Name: string | undefined; } /** * @public */ -export interface GetCatalogImportStatusResponse { +export interface DeleteCrawlerResponse {} + +/** + *The specified scheduler is transitioning.
+ * @public + */ +export class SchedulerTransitioningException extends __BaseException { + readonly name: "SchedulerTransitioningException" = "SchedulerTransitioningException"; + readonly $fault: "client" = "client"; /** - *The status of the specified catalog migration.
+ *A message describing the problem.
* @public */ - ImportStatus?: CatalogImportStatus | undefined; + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeName of the classifier to retrieve.
+ *The name of the custom pattern that you want to delete.
* @public */ Name: string | undefined; } /** - *A classifier for custom CSV
content.
The name of the classifier.
- * @public - */ - Name: string | undefined; - - /** - *The time that this classifier was registered.
- * @public - */ - CreationTime?: Date | undefined; - - /** - *The time that this classifier was last updated.
- * @public - */ - LastUpdated?: Date | undefined; - - /** - *The version of this classifier.
- * @public - */ - Version?: number | undefined; - +export interface DeleteCustomEntityTypeResponse { /** - *A custom symbol to denote what separates each column entry in the row.
+ *The name of the custom pattern you deleted.
* @public */ - Delimiter?: string | undefined; + Name?: string | undefined; +} +/** + * @public + */ +export interface DeleteDatabaseRequest { /** - *A custom symbol to denote what combines content into a single column value. It must be - * different from the column delimiter.
+ *The ID of the Data Catalog in which the database resides. If none is provided, the Amazon Web Services + * account ID is used by default.
* @public */ - QuoteSymbol?: string | undefined; + CatalogId?: string | undefined; /** - *Indicates whether the CSV file contains a header.
+ *The name of the database to delete. For Hive compatibility, this must be all + * lowercase.
* @public */ - ContainsHeader?: CsvHeaderOption | undefined; + Name: string | undefined; +} - /** - *A list of strings representing column names.
- * @public - */ - Header?: string[] | undefined; +/** + * @public + */ +export interface DeleteDatabaseResponse {} +/** + * @public + */ +export interface DeleteDataQualityRulesetRequest { /** - *Specifies not to trim values before identifying the type of column values. The default
- * value is true
.
A name for the data quality ruleset.
* @public */ - DisableValueTrimming?: boolean | undefined; + Name: string | undefined; +} - /** - *Enables the processing of files that contain only one column.
- * @public - */ - AllowSingleColumn?: boolean | undefined; +/** + * @public + */ +export interface DeleteDataQualityRulesetResponse {} +/** + * @public + */ +export interface DeleteDevEndpointRequest { /** - *Enables the custom datatype to be configured.
+ *The name of the DevEndpoint
.
A list of custom datatypes including "BINARY", "BOOLEAN", "DATE", "DECIMAL", "DOUBLE", "FLOAT", "INT", "LONG", "SHORT", "STRING", "TIMESTAMP".
- * @public - */ - CustomDatatypes?: string[] | undefined; +/** + * @public + */ +export interface DeleteDevEndpointResponse {} +/** + * @public + */ +export interface DeleteIntegrationRequest { /** - *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.
The Amazon Resource Name (ARN) for the integration.
* @public */ - Serde?: CsvSerdeOption | undefined; + IntegrationIdentifier: string | undefined; } /** - *A classifier that uses grok
patterns.
The name of the classifier.
+ *The ARN of the source for the integration.
* @public */ - Name: string | undefined; + SourceArn: string | undefined; /** - *An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and - * so on.
+ *The ARN of the target for the integration.
* @public */ - Classification: string | undefined; + TargetArn: string | undefined; /** - *The time that this classifier was registered.
+ *A unique name for an integration in Glue.
* @public */ - CreationTime?: Date | undefined; + IntegrationName: string | undefined; /** - *The time that this classifier was last updated.
+ *A description of the integration.
* @public */ - LastUpdated?: Date | undefined; + Description?: string | undefined; /** - *The version of this classifier.
+ *The Amazon Resource Name (ARN) for the integration.
* @public */ - Version?: number | undefined; + IntegrationArn: string | undefined; /** - *The grok pattern applied to a data store by this classifier. - * For more information, see built-in patterns in Writing Custom Classifiers.
+ *The ARN of a KMS key used for encrypting the channel.
* @public */ - GrokPattern: string | undefined; + KmsKeyId?: string | undefined; /** - *Optional custom grok patterns defined by this classifier. - * For more information, see custom patterns in Writing Custom Classifiers.
+ *An optional set of non-secret key–value pairs that contains additional contextual information for encryption.
* @public */ - CustomPatterns?: string | undefined; -} + AdditionalEncryptionContext?: RecordA classifier for JSON
content.
The name of the classifier.
+ *Metadata assigned to the resource consisting of a list of key-value pairs.
* @public */ - Name: string | undefined; + Tags?: Tag[] | undefined; /** - *The time that this classifier was registered.
+ *The status of the integration being deleted.
+ *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 that this classifier was last updated.
+ *The time when the integration was created, in UTC.
* @public */ - LastUpdated?: Date | undefined; + CreateTime: Date | undefined; /** - *The version of this classifier.
+ *A list of errors associated with the integration.
* @public */ - Version?: number | undefined; + Errors?: IntegrationError[] | 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.
Selects source tables for the integration using Maxwell filter syntax.
* @public */ - JsonPath: string | undefined; + DataFilter?: string | undefined; } /** - *A classifier for XML
content.
The specified integration could not be found.
* @public */ -export interface XMLClassifier { +export class IntegrationNotFoundFault extends __BaseException { + readonly name: "IntegrationNotFoundFault" = "IntegrationNotFoundFault"; + readonly $fault: "client" = "client"; /** - *The name of the classifier.
+ *A message describing the problem.
* @public */ - Name: string | undefined; - + Message?: string | undefined; /** - *An identifier of the data format that the classifier matches.
- * @public + * @internal */ - Classification: string | undefined; + constructor(opts: __ExceptionOptionTypeThe integration is in an invalid state.
+ * @public + */ +export class InvalidIntegrationStateFault extends __BaseException { + readonly name: "InvalidIntegrationStateFault" = "InvalidIntegrationStateFault"; + readonly $fault: "client" = "client"; /** - *The time that this classifier was registered.
+ *A message describing the problem.
* @public */ - CreationTime?: Date | undefined; - + Message?: string | undefined; /** - *The time that this classifier was last updated.
- * @public + * @internal */ - LastUpdated?: Date | undefined; + constructor(opts: __ExceptionOptionTypeThe version of this classifier.
+ *The connection ARN of the source, or the database ARN of the target.
* @public */ - Version?: number | undefined; + ResourceArn: string | undefined; /** - *The XML tag designating the element that contains each record in an XML document being
- * parsed. This can't 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,
is okay, but
- *
is not).
The name of the table to be replicated.
* @public */ - RowTag?: string | undefined; + TableName: string | undefined; } /** - *Classifiers are triggered during a crawl task. A classifier checks whether a given file is
- * in a format it can handle. If it is, the classifier creates a schema in the form of a
- * StructType
object that matches that data format.
You can use the standard classifiers that Glue provides, or you can write your own
- * classifiers to best categorize your data sources and specify the appropriate schemas to use
- * for them. A classifier can be a grok
classifier, an XML
classifier,
- * a JSON
classifier, or a custom CSV
classifier, as specified in one
- * of the fields in the Classifier
object.
A classifier that uses grok
.
A classifier for XML content.
+ *The name of the job definition to delete.
* @public */ - XMLClassifier?: XMLClassifier | undefined; + JobName: string | undefined; +} +/** + * @public + */ +export interface DeleteJobResponse { /** - *A classifier for JSON content.
+ *The name of the job definition that was deleted.
* @public */ - JsonClassifier?: JsonClassifier | undefined; + JobName?: string | undefined; +} +/** + * @public + */ +export interface DeleteMLTransformRequest { /** - *A classifier for comma-separated values (CSV).
+ *The unique identifier of the transform to delete.
* @public */ - CsvClassifier?: CsvClassifier | undefined; + TransformId: string | undefined; } /** * @public */ -export interface GetClassifierResponse { +export interface DeleteMLTransformResponse { /** - *The requested classifier.
+ *The unique identifier of the transform that was deleted.
* @public */ - Classifier?: Classifier | undefined; + TransformId?: string | undefined; } /** * @public */ -export interface GetClassifiersRequest { +export interface DeletePartitionRequest { /** - *The size of the list to return (optional).
+ *The ID of the Data Catalog where the partition to be deleted resides. If none is provided, + * the Amazon Web Services account ID is used by default.
* @public */ - MaxResults?: number | undefined; + CatalogId?: string | undefined; /** - *An optional continuation token.
+ *The name of the catalog database in which the table in question + * resides.
* @public */ - NextToken?: string | undefined; -} + DatabaseName: string | undefined; -/** - * @public - */ -export interface GetClassifiersResponse { /** - *The requested list of classifier - * objects.
+ *The name of the table that contains the partition to be deleted.
* @public */ - Classifiers?: Classifier[] | undefined; + TableName: string | undefined; /** - *A continuation token.
+ *The values that define the partition.
* @public */ - NextToken?: string | undefined; + PartitionValues: string[] | undefined; } /** * @public */ -export interface GetColumnStatisticsForPartitionRequest { +export interface DeletePartitionResponse {} + +/** + * @public + */ +export interface DeletePartitionIndexRequest { /** - *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.
+ *The catalog ID where the table resides.
* @public */ CatalogId?: string | undefined; /** - *The name of the catalog database where the partitions reside.
+ *Specifies the name of a database from which you want to delete a partition index.
* @public */ DatabaseName: string | undefined; /** - *The name of the partitions' table.
+ *Specifies the name of a table from which you want to delete a partition index.
* @public */ TableName: string | undefined; /** - *A list of partition values identifying the partition.
+ *The name of the partition index to be deleted.
* @public */ - PartitionValues: string[] | undefined; + IndexName: string | undefined; +} + +/** + * @public + */ +export interface DeletePartitionIndexResponse {} +/** + * @public + */ +export interface DeleteRegistryInput { /** - *A list of the column names.
+ *This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
* @public */ - ColumnNames: string[] | undefined; + RegistryId: RegistryId | undefined; } /** - *Defines column statistics supported for bit sequence data values.
* @public + * @enum */ -export interface BinaryColumnStatisticsData { +export const RegistryStatus = { + AVAILABLE: "AVAILABLE", + DELETING: "DELETING", +} as const; + +/** + * @public + */ +export type RegistryStatus = (typeof RegistryStatus)[keyof typeof RegistryStatus]; + +/** + * @public + */ +export interface DeleteRegistryResponse { /** - *The size of the longest bit sequence in the column.
+ *The name of the registry being deleted.
* @public */ - MaximumLength: number | undefined; + RegistryName?: string | undefined; /** - *The average bit sequence length in the column.
+ *The Amazon Resource Name (ARN) of the registry being deleted.
* @public */ - AverageLength: number | undefined; + RegistryArn?: string | undefined; /** - *The number of null values in the column.
+ *The status of the registry. A successful operation will return the Deleting
status.
Defines column statistics supported for Boolean data columns.
+ *A specified condition was not satisfied.
* @public */ -export interface BooleanColumnStatisticsData { +export class ConditionCheckFailureException extends __BaseException { + readonly name: "ConditionCheckFailureException" = "ConditionCheckFailureException"; + readonly $fault: "client" = "client"; /** - *The number of true values in the column.
+ *A message describing the problem.
* @public */ - NumberOfTrues: number | undefined; + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe number of false values in the column.
+ *The hash value returned when this policy was set.
* @public */ - NumberOfFalses: number | undefined; + PolicyHashCondition?: string | undefined; /** - *The number of null values in the column.
+ *The ARN of the Glue resource for the resource policy to be deleted.
* @public */ - NumberOfNulls: number | undefined; + ResourceArn?: string | undefined; } /** - *Defines column statistics supported for timestamp data columns.
* @public */ -export interface DateColumnStatisticsData { +export interface DeleteResourcePolicyResponse {} + +/** + * @public + */ +export interface DeleteSchemaInput { /** - *The lowest value in the column.
+ *This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
* @public */ - MinimumValue?: Date | undefined; + SchemaId: SchemaId | undefined; +} +/** + * @public + */ +export interface DeleteSchemaResponse { /** - *The highest value in the column.
+ *The Amazon Resource Name (ARN) of the schema being deleted.
* @public */ - MaximumValue?: Date | undefined; + SchemaArn?: string | undefined; /** - *The number of null values in the column.
+ *The name of the schema being deleted.
* @public */ - NumberOfNulls: number | undefined; + SchemaName?: string | undefined; /** - *The number of distinct values in a column.
+ *The status of the schema.
* @public */ - NumberOfDistinctValues: number | undefined; + Status?: SchemaStatus | undefined; } /** - *Contains a numeric value in decimal format.
* @public */ -export interface DecimalNumber { +export interface DeleteSchemaVersionsInput { /** - *The unscaled numeric value.
+ *This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
* @public */ - UnscaledValue: Uint8Array | undefined; + SchemaId: SchemaId | undefined; /** - *The scale that determines where the decimal point falls in the - * unscaled value.
+ *A version range may be supplied which may be of the format:
+ *a single version number, 5
+ *a range, 5-8 : deletes versions 5, 6, 7, 8
+ *Defines column statistics supported for fixed-point number data columns.
+ *An object containing error details.
* @public */ -export interface DecimalColumnStatisticsData { +export interface ErrorDetails { /** - *The lowest value in the column.
+ *The error code for an error.
* @public */ - MinimumValue?: DecimalNumber | undefined; + ErrorCode?: string | undefined; /** - *The highest value in the column.
+ *The error message for an error.
* @public */ - MaximumValue?: DecimalNumber | undefined; + ErrorMessage?: string | undefined; +} +/** + *An object that contains the error details for an operation on a schema version.
+ * @public + */ +export interface SchemaVersionErrorItem { /** - *The number of null values in the column.
+ *The version number of the schema.
* @public */ - NumberOfNulls: number | undefined; + VersionNumber?: number | undefined; /** - *The number of distinct values in a column.
+ *The details of the error for the schema version.
* @public */ - NumberOfDistinctValues: number | undefined; + ErrorDetails?: ErrorDetails | undefined; } /** - *Defines column statistics supported for floating-point number data columns.
* @public */ -export interface DoubleColumnStatisticsData { +export interface DeleteSchemaVersionsResponse { /** - *The lowest value in the column.
+ *A list of SchemaVersionErrorItem
objects, each containing an error and schema version.
The highest value in the column.
+ *The name of the security configuration to delete.
* @public */ - MaximumValue?: number | undefined; + Name: string | undefined; +} + +/** + * @public + */ +export interface DeleteSecurityConfigurationResponse {} + +/** + * @public + */ +export interface DeleteSessionRequest { + /** + *The ID of the session to be deleted.
+ * @public + */ + Id: string | undefined; /** - *The number of null values in the column.
+ *The name of the origin of the delete session request.
* @public */ - NumberOfNulls: number | undefined; + RequestOrigin?: string | undefined; +} +/** + * @public + */ +export interface DeleteSessionResponse { /** - *The number of distinct values in a column.
+ *Returns the ID of the deleted session.
* @public */ - NumberOfDistinctValues: number | undefined; + Id?: string | undefined; } /** - *Defines column statistics supported for integer data columns.
* @public */ -export interface LongColumnStatisticsData { +export interface DeleteTableRequest { /** - *The lowest value in the column.
+ *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 */ - MinimumValue?: number | undefined; + CatalogId?: string | undefined; /** - *The highest value in the column.
+ *The name of the catalog database in which the table resides. For Hive + * compatibility, this name is entirely lowercase.
* @public */ - MaximumValue?: number | undefined; + DatabaseName: string | undefined; /** - *The number of null values in the column.
+ *The name of the table to be deleted. For Hive + * compatibility, this name is entirely lowercase.
* @public */ - NumberOfNulls: number | undefined; + Name: string | undefined; /** - *The number of distinct values in a column.
+ *The transaction ID at which to delete the table contents.
* @public */ - NumberOfDistinctValues: number | undefined; + TransactionId?: string | undefined; } /** - *Defines column statistics supported for character sequence data values.
* @public */ -export interface StringColumnStatisticsData { +export interface DeleteTableResponse {} + +/** + * @public + */ +export interface DeleteTableOptimizerRequest { /** - *The size of the longest string in the column.
+ *The Catalog ID of the table.
* @public */ - MaximumLength: number | undefined; + CatalogId: string | undefined; /** - *The average string length in the column.
+ *The name of the database in the catalog in which the table resides.
* @public */ - AverageLength: number | undefined; + DatabaseName: string | undefined; /** - *The number of null values in the column.
+ *The name of the table.
* @public */ - NumberOfNulls: number | undefined; + TableName: string | undefined; /** - *The number of distinct values in a column.
+ *The type of table optimizer.
* @public */ - NumberOfDistinctValues: number | undefined; + Type: TableOptimizerType | undefined; } -/** - * @public - * @enum - */ -export const ColumnStatisticsType = { - BINARY: "BINARY", - BOOLEAN: "BOOLEAN", - DATE: "DATE", - DECIMAL: "DECIMAL", - DOUBLE: "DOUBLE", - LONG: "LONG", - STRING: "STRING", -} as const; - /** * @public */ -export type ColumnStatisticsType = (typeof ColumnStatisticsType)[keyof typeof ColumnStatisticsType]; +export interface DeleteTableOptimizerResponse {} /** - *Contains the individual types of column statistics data. Only one data object should be set and indicated by the Type
attribute.
The type of column statistics data.
+ *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 */ - Type: ColumnStatisticsType | undefined; + CatalogId?: string | undefined; /** - *Boolean column statistics data.
+ *The database in the catalog in which the table resides. For Hive + * compatibility, this name is entirely lowercase.
* @public */ - BooleanColumnStatisticsData?: BooleanColumnStatisticsData | undefined; + DatabaseName: string | undefined; /** - *Date column statistics data.
+ *The name of the table. For Hive compatibility, + * this name is entirely lowercase.
* @public */ - DateColumnStatisticsData?: DateColumnStatisticsData | undefined; + TableName: string | undefined; /** - *- * Decimal column statistics data. UnscaledValues within are Base64-encoded - * binary objects storing big-endian, two's complement representations of - * the decimal's unscaled value. - *
+ *The ID of the table version to be deleted. A VersionID
is a string representation of an integer. Each version is incremented by 1.
Double column statistics data.
- * @public - */ - DoubleColumnStatisticsData?: DoubleColumnStatisticsData | undefined; +/** + * @public + */ +export interface DeleteTableVersionResponse {} +/** + * @public + */ +export interface DeleteTriggerRequest { /** - *Long column statistics data.
+ *The name of the trigger to delete.
* @public */ - LongColumnStatisticsData?: LongColumnStatisticsData | undefined; + Name: string | undefined; +} +/** + * @public + */ +export interface DeleteTriggerResponse { /** - *String column statistics data.
+ *The name of the trigger that was deleted.
* @public */ - StringColumnStatisticsData?: StringColumnStatisticsData | undefined; + Name?: string | undefined; +} +/** + * @public + */ +export interface DeleteUsageProfileRequest { /** - *Binary column statistics data.
+ *The name of the usage profile to delete.
* @public */ - BinaryColumnStatisticsData?: BinaryColumnStatisticsData | undefined; + Name: string | undefined; } /** - *Represents the generated column-level statistics for a table or partition.
* @public */ -export interface ColumnStatistics { - /** - *Name of column which statistics belong to.
- * @public - */ - ColumnName: string | undefined; +export interface DeleteUsageProfileResponse {} +/** + * @public + */ +export interface DeleteUserDefinedFunctionRequest { /** - *The data type of the column.
+ *The ID of the Data Catalog where the function to be deleted is + * located. If none is supplied, the Amazon Web Services account ID is used by default.
* @public */ - ColumnType: string | undefined; + CatalogId?: string | undefined; /** - *The timestamp of when column statistics were generated.
+ *The name of the catalog database where the function is located.
* @public */ - AnalyzedTime: Date | undefined; + DatabaseName: string | undefined; /** - *A ColumnStatisticData
object that contains the statistics data values.
The name of the function definition to be deleted.
* @public */ - StatisticsData: ColumnStatisticsData | undefined; + FunctionName: string | undefined; } /** - *Encapsulates a column name that failed and the reason for failure.
* @public */ -export interface ColumnError { - /** - *The name of the column that failed.
- * @public - */ - ColumnName?: string | undefined; +export interface DeleteUserDefinedFunctionResponse {} +/** + * @public + */ +export interface DeleteWorkflowRequest { /** - *An error message with the reason for the failure of an operation.
+ *Name of the workflow to be deleted.
* @public */ - Error?: ErrorDetail | undefined; + Name: string | undefined; } /** * @public */ -export interface GetColumnStatisticsForPartitionResponse { - /** - *List of ColumnStatistics that failed to be retrieved.
- * @public - */ - ColumnStatisticsList?: ColumnStatistics[] | undefined; - +export interface DeleteWorkflowResponse { /** - *Error occurred during retrieving column statistics data.
+ *Name of the workflow specified in input.
* @public */ - Errors?: ColumnError[] | undefined; + Name?: string | undefined; } /** * @public */ -export interface GetColumnStatisticsForTableRequest { +export interface DescribeConnectionTypeRequest { /** - *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.
+ *The name of the connection type to be described.
* @public */ - CatalogId?: string | undefined; + ConnectionType: string | undefined; +} +/** + *Specifies the supported authentication types returned by the DescribeConnectionType
API.
The name of the catalog database where the partitions reside.
+ *A list of supported authentication types.
* @public */ - DatabaseName: string | undefined; + SupportedAuthenticationTypes: AuthenticationType[] | undefined; /** - *The name of the partitions' table.
+ *A list of supported data operations.
* @public */ - TableName: string | undefined; + SupportedDataOperations: DataOperation[] | undefined; /** - *A list of the column names.
+ *A list of supported compute environments.
* @public */ - ColumnNames: string[] | undefined; + SupportedComputeEnvironments: ComputeEnvironment[] | undefined; } /** + *An object containing configuration for a compute environment (such as Spark, Python or Athena) returned by the DescribeConnectionType
API.
List of ColumnStatistics.
+ *A name for the compute environment configuration.
* @public */ - ColumnStatisticsList?: ColumnStatistics[] | undefined; + Name: string | undefined; /** - *List of ColumnStatistics that failed to be retrieved.
+ *A description of the compute environment.
* @public */ - Errors?: ColumnError[] | undefined; -} + Description: string | undefined; -/** - * @public - */ -export interface GetColumnStatisticsTaskRunRequest { /** - *The identifier for the particular column statistics task run.
+ *The type of compute environment.
* @public */ - ColumnStatisticsTaskRunId: string | undefined; -} - -/** - * @public - * @enum - */ -export const ComputationType = { - FULL: "FULL", - INCREMENTAL: "INCREMENTAL", -} as const; + ComputeEnvironment: ComputeEnvironment | undefined; -/** - * @public - */ -export type ComputationType = (typeof ComputationType)[keyof typeof ComputationType]; + /** + *The supported authentication types for the compute environment.
+ * @public + */ + SupportedAuthenticationTypes: AuthenticationType[] | undefined; -/** - * @public - * @enum - */ -export const ColumnStatisticsState = { - FAILED: "FAILED", - RUNNING: "RUNNING", - STARTING: "STARTING", - STOPPED: "STOPPED", - SUCCEEDED: "SUCCEEDED", -} as const; + /** + *The parameters used as connection options for the compute environment.
+ * @public + */ + ConnectionOptions: RecordThe connection property name overrides for the compute environment.
+ * @public + */ + ConnectionPropertyNameOverrides: RecordThe object that shows the details of the column stats run.
- * @public - */ -export interface ColumnStatisticsTaskRun { /** - *The Amazon Web Services account ID.
+ *The connection option name overrides for the compute environment.
* @public */ - CustomerId?: string | undefined; + ConnectionOptionNameOverrides: RecordThe identifier for the particular column statistics task run.
+ *The connection properties that are required as overrides for the compute environment.
* @public */ - ColumnStatisticsTaskRunId?: string | undefined; + ConnectionPropertiesRequiredOverrides: string[] | undefined; /** - *The database where the table resides.
+ *Indicates whether PhysicalConnectionProperties
are required for the compute environment.
The name of the table for which column statistics is generated.
+ *The name of the connection type.
* @public */ - TableName?: string | undefined; + ConnectionType?: string | undefined; /** - *A list of the column names. If none is supplied, all column names for the table will be used by default.
+ *A description of the connection type.
* @public */ - ColumnNameList?: string[] | undefined; + Description?: string | undefined; /** - *The ID of the Data Catalog where the table resides. If none is supplied, the Amazon Web Services account ID is used by default.
+ *The supported authentication types, data interface types (compute environments), and data operations of the connector.
* @public */ - CatalogID?: string | undefined; + Capabilities?: Capabilities | undefined; /** - *The IAM role that the service assumes to generate statistics.
+ *Connection properties which are common across compute environments.
* @public */ - Role?: string | undefined; + ConnectionProperties?: RecordThe percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
+ *Returns properties that can be set when creating a connection in the ConnectionInput.ConnectionProperties
. ConnectionOptions
defines parameters that can be set in a Spark ETL script in the connection options map passed to a dataframe.
Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
+ *The type of authentication used for the connection.
* @public */ - SecurityConfiguration?: string | undefined; + AuthenticationConfiguration?: AuthConfiguration | undefined; /** - *The number of workers used to generate column statistics. The job is preconfigured to autoscale up to 25 instances.
+ *The compute environments that are supported by the connection.
* @public */ - NumberOfWorkers?: number | undefined; + ComputeEnvironmentConfigurations?: RecordThe type of workers being used for generating stats. The default is g.1x
.
Physical requirements for a connection, such as VPC, Subnet and Security Group specifications.
* @public */ - WorkerType?: string | undefined; + PhysicalConnectionRequirements?: RecordThe type of column statistics computation.
+ *Connection properties specific to the Athena compute environment.
* @public */ - ComputationType?: ComputationType | undefined; + AthenaConnectionProperties?: RecordThe status of the task run.
+ *Connection properties specific to the Python compute environment.
* @public */ - Status?: ColumnStatisticsState | undefined; + PythonConnectionProperties?: RecordThe time that this task was created.
+ *Connection properties specific to the Spark compute environment.
* @public */ - CreationTime?: Date | undefined; + SparkConnectionProperties?: RecordThe last point in time when this task was modified.
+ *The name of the connection that contains the connection type credentials.
* @public */ - LastUpdated?: Date | undefined; + ConnectionName: string | undefined; /** - *The start time of the task.
+ *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 */ - StartTime?: Date | undefined; + CatalogId?: string | undefined; /** - *The end time of the task.
+ *The name of the entity that you want to describe from the connection type.
* @public */ - EndTime?: Date | undefined; + EntityName: string | undefined; /** - *The error message for the job.
+ *A continuation token, included if this is a continuation call.
* @public */ - ErrorMessage?: string | undefined; + NextToken?: string | undefined; /** - *The calculated DPU usage in seconds for all autoscaled workers.
+ *The version of the API used for the data store.
* @public */ - DPUSeconds?: number | undefined; + DataStoreApiVersion?: string | undefined; } /** * @public + * @enum */ -export interface GetColumnStatisticsTaskRunResponse { - /** - *A ColumnStatisticsTaskRun
object representing the details of the column stats run.
The Field
object has information about the different properties associated with a field in the connector.
The name of the database where the table resides.
+ *A unique identifier for the field.
* @public */ - DatabaseName: string | undefined; + FieldName?: string | undefined; /** - *The name of the table.
+ *A readable label used for the field.
* @public */ - TableName: string | undefined; + Label?: string | undefined; /** - *The maximum size of the response.
+ *A description of the field.
* @public */ - MaxResults?: number | undefined; + Description?: string | undefined; /** - *A continuation token, if this is a continuation call.
+ *The type of data in the field.
* @public */ - NextToken?: string | undefined; -} + FieldType?: FieldDataType | undefined; -/** - * @public - */ -export interface GetColumnStatisticsTaskRunsResponse { /** - *A list of column statistics task runs.
+ *Indicates whether this field can used as a primary key for the given entity.
* @public */ - ColumnStatisticsTaskRuns?: ColumnStatisticsTaskRun[] | undefined; + IsPrimaryKey?: boolean | undefined; /** - *A continuation token, if not all task runs have yet been returned.
+ *Indicates whether this field can be nullable or not.
* @public */ - NextToken?: string | undefined; -} + IsNullable?: boolean | undefined; -/** - * @public - */ -export interface GetColumnStatisticsTaskSettingsRequest { /** - *The name of the database where the table resides.
+ *Indicates whether this field can be added in Select clause of SQL query or whether it is retrievable or not.
* @public */ - DatabaseName: string | undefined; + IsRetrievable?: boolean | undefined; /** - *The name of the table for which to retrieve column statistics.
+ * Indicates whether this field can used in a filter clause (WHERE
clause) of a SQL statement when querying data.
The settings for a column statistics task.
- * @public - */ -export interface ColumnStatisticsTaskSettings { /** - *The name of the database where the table resides.
+ *Indicates whether a given field can be used in partitioning the query made to SaaS.
* @public */ - DatabaseName?: string | undefined; + IsPartitionable?: boolean | undefined; /** - *The name of the table for which to generate column statistics.
+ *Indicates whether this field can be created as part of a destination write.
* @public */ - TableName?: string | undefined; + IsCreateable?: boolean | undefined; /** - *A schedule for running the column statistics, specified in CRON syntax.
+ *Indicates whether this field can be updated as part of a destination write.
* @public */ - Schedule?: Schedule | undefined; + IsUpdateable?: boolean | undefined; /** - *A list of column names for which to run statistics.
+ *Indicates whether this field can be upserted as part of a destination write.
* @public */ - ColumnNameList?: string[] | undefined; + IsUpsertable?: boolean | undefined; /** - *The ID of the Data Catalog in which the database resides.
+ *Indicates whether this field is populated automatically when the object is created, such as a created at timestamp.
* @public */ - CatalogID?: string | undefined; + IsDefaultOnCreate?: boolean | undefined; /** - *The role used for running the column statistics.
+ *A list of supported values for the field.
* @public */ - Role?: string | undefined; + SupportedValues?: string[] | undefined; /** - *The percentage of data to sample.
+ *Indicates the support filter operators for this field.
* @public */ - SampleSize?: number | undefined; + SupportedFilterOperators?: FieldFilterOperator[] | undefined; /** - *Name of the security configuration that is used to encrypt CloudWatch logs.
+ *A parent field name for a nested field.
* @public */ - SecurityConfiguration?: string | undefined; + ParentField?: string | undefined; + + /** + *The data type returned by the SaaS API, such as “picklist” or “textarea” from Salesforce.
+ * @public + */ + NativeDataType?: string | undefined; + + /** + *Optional map of keys which may be returned.
+ * @public + */ + CustomProperties?: RecordDescribes the fields for that connector entity. This is the list of Field
objects. Field
is very similar to column in a database. The Field
object has information about different properties associated with fields in the connector.
A ColumnStatisticsTaskSettings
object representing the settings for the column statistics task.
A continuation token, present if the current segment is not the last.
* @public */ - ColumnStatisticsTaskSettings?: ColumnStatisticsTaskSettings | undefined; + NextToken?: string | undefined; } /** * @public */ -export interface GetConnectionRequest { +export interface DescribeInboundIntegrationsRequest { /** - *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.
+ *The Amazon Resource Name (ARN) of the integration.
* @public */ - CatalogId?: string | undefined; + IntegrationArn?: string | undefined; /** - *The name of the connection definition to retrieve.
+ *A token to specify where to start paginating. This is the marker from a previously truncated response.
* @public */ - Name: string | undefined; + Marker?: string | undefined; /** - *Allows you to retrieve the connection metadata without returning the password. For - * instance, the Glue console uses this flag to retrieve the connection, and does not display - * the password. Set this parameter when the caller might not have permission to use the KMS - * key to decrypt the password, but it does have permission to access the rest of the connection - * properties.
+ *The total number of items to return in the output.
* @public */ - HidePassword?: boolean | undefined; -} + MaxRecords?: number | undefined; -/** - *Defines a connection to a data source.
- * @public - */ -export interface Connection { /** - *The name of the connection definition.
+ *The Amazon Resource Name (ARN) of the target resource in the integration.
* @public */ - Name?: string | undefined; + TargetArn?: string | undefined; +} +/** + *A structure for an integration that writes data into a resource.
+ * @public + */ +export interface InboundIntegration { /** - *The description of the connection.
+ *The ARN of the source resource for the integration.
* @public */ - Description?: string | undefined; + SourceArn: string | undefined; /** - *The type of the connection. Currently, SFTP is not supported.
+ *The ARN of the target resource for the integration.
* @public */ - ConnectionType?: ConnectionType | undefined; + TargetArn: string | undefined; /** - *A list of criteria that can be used in selecting this connection.
+ *The ARN of the zero-ETL integration.
* @public */ - MatchCriteria?: string[] | undefined; + IntegrationArn: string | undefined; /** - *These key-value pairs define parameters for the connection:
+ *The possible statuses are:
*
- * HOST
- The host URI: either the
- * fully qualified domain name (FQDN) or the IPv4 address of
- * the database host.
- * PORT
- The port number, between
- * 1024 and 65535, of the port on which the database host is
- * listening for database connections.
- * USER_NAME
- The name under which
- * to log in to the database. The value string for USER_NAME
is "USERNAME
".
- * PASSWORD
- A password,
- * if one is used, for the user name.
- * ENCRYPTED_PASSWORD
- When you enable connection password protection by setting ConnectionPasswordEncryption
in the Data Catalog encryption settings, this field stores the encrypted password.
- * JDBC_DRIVER_JAR_URI
- The Amazon Simple Storage Service (Amazon S3) path of the
- * JAR file that contains the JDBC driver to use.
- * JDBC_DRIVER_CLASS_NAME
- The class name of the JDBC driver to use.
- * JDBC_ENGINE
- The name of the JDBC engine to use.
- * JDBC_ENGINE_VERSION
- The version of the JDBC engine to use.
- * CONFIG_FILES
- (Reserved for future use.)
- * INSTANCE_ID
- The instance ID to use.
- * JDBC_CONNECTION_URL
- The URL for connecting to a JDBC data source.
- * JDBC_ENFORCE_SSL
- A Boolean string (true, false) specifying whether Secure
- * Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the
- * client. The default is false.
- * CUSTOM_JDBC_CERT
- An Amazon S3 location specifying the customer's root certificate. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.
- * SKIP_CUSTOM_JDBC_CERT_VALIDATION
- By default, this is false
. Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true
to skip Glue’s validation of the customer certificate.
- * CUSTOM_JDBC_CERT_STRING
- A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN
; in Microsoft SQL Server, this is used as the hostNameInCertificate
.
- * CONNECTION_URL
- The URL for connecting to a general (non-JDBC) data source.
- * SECRET_ID
- The secret ID used for the secret manager of credentials.
- * CONNECTOR_URL
- The connector URL for a MARKETPLACE or CUSTOM connection.
- * CONNECTOR_TYPE
- The connector type for a MARKETPLACE or CUSTOM connection.
- * CONNECTOR_CLASS_NAME
- The connector class name for a MARKETPLACE or CUSTOM connection.
- * KAFKA_BOOTSTRAP_SERVERS
- A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.
- * KAFKA_SSL_ENABLED
- Whether to enable or disable SSL on an Apache Kafka connection. Default value is "true".
- * KAFKA_CUSTOM_CERT
- The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string.
- * KAFKA_SKIP_CUSTOM_CERT_VALIDATION
- Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is "false".
- * KAFKA_CLIENT_KEYSTORE
- The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional).
- * KAFKA_CLIENT_KEYSTORE_PASSWORD
- The password to access the provided keystore (Optional).
- * KAFKA_CLIENT_KEY_PASSWORD
- A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional).
- * ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
- The encrypted version of the Kafka client keystore password (if the user has the Glue encrypt passwords setting selected).
- * ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
- The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).
- * KAFKA_SASL_MECHANISM
- "SCRAM-SHA-512"
, "GSSAPI"
, "AWS_MSK_IAM"
, or "PLAIN"
. These are the supported SASL Mechanisms.
- * KAFKA_SASL_PLAIN_USERNAME
- A plaintext username used to authenticate with the "PLAIN" mechanism.
- * KAFKA_SASL_PLAIN_PASSWORD
- A plaintext password used to authenticate with the "PLAIN" mechanism.
- * ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD
- The encrypted version of the Kafka SASL PLAIN password (if the user has the Glue encrypt passwords setting selected).
- * KAFKA_SASL_SCRAM_USERNAME
- A plaintext username used to authenticate with the "SCRAM-SHA-512" mechanism.
- * KAFKA_SASL_SCRAM_PASSWORD
- A plaintext password used to authenticate with the "SCRAM-SHA-512" mechanism.
- * ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
- The encrypted version of the Kafka SASL SCRAM password (if the user has the Glue encrypt passwords setting selected).
- * KAFKA_SASL_SCRAM_SECRETS_ARN
- The Amazon Resource Name of a secret in Amazon Web Services Secrets Manager.
- * KAFKA_SASL_GSSAPI_KEYTAB
- The S3 location of a Kerberos keytab
file. A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab.
- * KAFKA_SASL_GSSAPI_KRB5_CONF
- The S3 location of a Kerberos krb5.conf
file. A krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf.
- * KAFKA_SASL_GSSAPI_SERVICE
- The Kerberos service name, as set with sasl.kerberos.service.name
in your Kafka Configuration.
CREATING: The integration is being created.
*
- * KAFKA_SASL_GSSAPI_PRINCIPAL
- The name of the Kerberos princial used by Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers.
ACTIVE: The integration creation succeeds.
*
- * ROLE_ARN
- The role to be used for running queries.
MODIFYING: The integration is being modified.
*
- * REGION
- The Amazon Web Services Region where queries will be run.
FAILED: The integration creation fails.
*
- * WORKGROUP_NAME
- The name of an Amazon Redshift serverless workgroup or Amazon Athena workgroup in which queries will run.
DELETING: The integration is deleted.
*
- * CLUSTER_IDENTIFIER
- The cluster identifier of an Amazon Redshift cluster in which queries will run.
SYNCING: The integration is synchronizing.
*
- * DATABASE
- The Amazon Redshift database that you are connecting to.
NEEDS_ATTENTION: The integration needs attention, such as synchronization.
*This field is not currently used.
+ *The time that the integration was created, in UTC.
* @public */ - AthenaProperties?: RecordThe physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup
, that are needed to make this connection successfully.
A list of errors associated with the integration.
* @public */ - PhysicalConnectionRequirements?: PhysicalConnectionRequirements | undefined; + Errors?: IntegrationError[] | undefined; +} +/** + * @public + */ +export interface DescribeInboundIntegrationsResponse { /** - *The timestamp of the time that this connection definition was created.
+ *A list of inbound integrations.
* @public */ - CreationTime?: Date | undefined; + InboundIntegrations?: InboundIntegration[] | undefined; + + /** + *A value that indicates the starting point for the next set of response records in a subsequent request.
+ * @public + */ + Marker?: string | undefined; +} + +/** + *The target resource could not be found.
+ * @public + */ +export class TargetResourceNotFound extends __BaseException { + readonly name: "TargetResourceNotFound" = "TargetResourceNotFound"; + readonly $fault: "client" = "client"; + /** + *A message describing the problem.
+ * @public + */ + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeA filter that can be used when invoking a DescribeIntegrations
request.
The timestamp of the last time the connection definition was updated.
+ *The name of the filter.
* @public */ - LastUpdatedTime?: Date | undefined; + Name?: string | undefined; /** - *The user, group, or role that last updated this connection definition.
+ *A list of filter values.
* @public */ - LastUpdatedBy?: string | undefined; + Values?: string[] | undefined; +} +/** + * @public + */ +export interface DescribeIntegrationsRequest { /** - *The status of the connection. Can be one of: READY
, IN_PROGRESS
, or FAILED
.
The Amazon Resource Name (ARN) for the integration.
* @public */ - Status?: ConnectionStatus | undefined; + IntegrationIdentifier?: string | undefined; /** - *The reason for the connection status.
+ *A value that indicates the starting point for the next set of response records in a subsequent request.
* @public */ - StatusReason?: string | undefined; + Marker?: string | undefined; /** - *A timestamp of the time this connection was last validated.
+ *The total number of items to return in the output.
* @public */ - LastConnectionValidationTime?: Date | undefined; + MaxRecords?: number | undefined; /** - *The authentication properties of the connection.
+ *A list of key and values, to filter down the results. Supported keys are "Status", "IntegrationName", and "SourceArn". IntegrationName is limited to only one value.
* @public */ - AuthenticationConfiguration?: AuthenticationConfiguration | undefined; + Filters?: IntegrationFilter[] | undefined; } /** + *Describes a zero-ETL integration.
* @public */ -export interface GetConnectionResponse { +export interface Integration { /** - *The requested connection definition.
+ *The ARN for the source of the integration.
* @public */ - Connection?: Connection | undefined; -} + SourceArn: string | undefined; -/** - *Filters the connection definitions that are returned by the GetConnections
- * API operation.
A criteria string that must match the criteria recorded in the - * connection definition for that connection definition to be returned.
+ *The ARN for the target of the integration.
* @public */ - MatchCriteria?: string[] | undefined; + TargetArn: string | undefined; /** - *The type of connections to return. Currently, SFTP is not supported.
+ *A description for the integration.
* @public */ - ConnectionType?: ConnectionType | undefined; -} + Description?: string | undefined; -/** - * @public - */ -export interface GetConnectionsRequest { /** - *The ID of the Data Catalog in which the connections reside. If none is provided, the Amazon Web Services - * account ID is used by default.
+ *A unique name for the integration.
* @public */ - CatalogId?: string | undefined; + IntegrationName: string | undefined; /** - *A filter that controls which connections are returned.
+ *The Amazon Resource Name (ARN) for the integration.
* @public */ - Filter?: GetConnectionsFilter | undefined; + IntegrationArn: string | undefined; /** - *Allows you to retrieve the connection metadata without returning the password. For - * instance, the Glue console uses this flag to retrieve the connection, and does not display - * the password. Set this parameter when the caller might not have permission to use the KMS - * key to decrypt the password, but it does have permission to access the rest of the connection - * properties.
+ *The ARN of a KMS key used for encrypting the channel.
* @public */ - HidePassword?: boolean | undefined; + KmsKeyId?: string | undefined; /** - *A continuation token, if this is a continuation call.
+ *An optional set of non-secret key–value pairs that contains additional contextual information for encryption. This can only be provided if KMSKeyId
is provided.
The maximum number of connections to return in one response.
+ *Metadata assigned to the resource consisting of a list of key-value pairs.
* @public */ - MaxResults?: number | undefined; + Tags?: Tag[] | undefined; + + /** + *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 that the integration was created, in UTC.
+ * @public + */ + CreateTime: Date | undefined; + + /** + *A list of errors associated with the integration.
+ * @public + */ + Errors?: IntegrationError[] | undefined; + + /** + *Selects source tables for the integration using Maxwell filter syntax.
+ * @public + */ + DataFilter?: string | undefined; } /** * @public */ -export interface GetConnectionsResponse { +export interface DescribeIntegrationsResponse { /** - *A list of requested connection definitions.
+ *A list of zero-ETL integrations.
* @public */ - ConnectionList?: Connection[] | undefined; + Integrations?: Integration[] | undefined; /** - *A continuation token, if the list of connections returned does not - * include the last of the filtered connections.
+ *A value that indicates the starting point for the next set of response records in a subsequent request.
* @public */ - NextToken?: string | undefined; + Marker?: string | undefined; } /** * @public */ -export interface GetCrawlerRequest { +export interface GetBlueprintRequest { /** - *The name of the crawler to retrieve metadata for.
+ *The name of the blueprint.
* @public */ Name: string | undefined; -} -/** - * @public - */ -export interface GetCrawlerResponse { /** - *The metadata for the specified crawler.
+ *Specifies whether or not to include the blueprint in the response.
+ * @public + */ + IncludeBlueprint?: boolean | undefined; + + /** + *Specifies whether or not to include the parameter specification.
* @public */ - Crawler?: Crawler | undefined; + IncludeParameterSpec?: boolean | undefined; } /** * @public */ -export interface GetCrawlerMetricsRequest { +export interface GetBlueprintResponse { /** - *A list of the names of crawlers about which to retrieve metrics.
+ *Returns a Blueprint
object.
The maximum size of a list to return.
+ *The name of the blueprint.
* @public */ - MaxResults?: number | undefined; + BlueprintName: string | undefined; /** - *A continuation token, if this is a continuation call.
+ *The run ID for the blueprint run you want to retrieve.
* @public */ - NextToken?: string | undefined; + RunId: string | undefined; } /** - *Metrics for a specified crawler.
+ * @public + * @enum + */ +export const BlueprintRunState = { + FAILED: "FAILED", + ROLLING_BACK: "ROLLING_BACK", + RUNNING: "RUNNING", + SUCCEEDED: "SUCCEEDED", +} as const; + +/** + * @public + */ +export type BlueprintRunState = (typeof BlueprintRunState)[keyof typeof BlueprintRunState]; + +/** + *The details of a blueprint run.
* @public */ -export interface CrawlerMetrics { +export interface BlueprintRun { /** - *The name of the crawler.
+ *The name of the blueprint.
* @public */ - CrawlerName?: string | undefined; + BlueprintName?: string | undefined; /** - *The estimated time left to complete a running crawl.
+ *The run ID for this blueprint run.
* @public */ - TimeLeftSeconds?: number | undefined; + RunId?: string | undefined; /** - *True if the crawler is still estimating how long it will take to complete this run.
+ *The name of a workflow that is created as a result of a successful blueprint run. If a blueprint run has an error, there will not be a workflow created.
* @public */ - StillEstimating?: boolean | undefined; + WorkflowName?: string | undefined; /** - *The duration of the crawler's most recent run, in seconds.
+ *The state of the blueprint run. Possible values are:
+ *Running — The blueprint run is in progress.
+ *Succeeded — The blueprint run completed successfully.
+ *Failed — The blueprint run failed and rollback is complete.
+ *Rolling Back — The blueprint run failed and rollback is in progress.
+ *The median duration of this crawler's runs, in seconds.
+ *The date and time that the blueprint run started.
* @public */ - MedianRuntimeSeconds?: number | undefined; + StartedOn?: Date | undefined; /** - *The number of tables created by this crawler.
+ *The date and time that the blueprint run completed.
* @public */ - TablesCreated?: number | undefined; + CompletedOn?: Date | undefined; /** - *The number of tables updated by this crawler.
+ *Indicates any errors that are seen while running the blueprint.
* @public */ - TablesUpdated?: number | undefined; + ErrorMessage?: string | undefined; /** - *The number of tables deleted by this crawler.
+ *If there are any errors while creating the entities of a workflow, we try to roll back the created entities until that point and delete them. This attribute indicates the errors seen while trying to delete the entities that are created.
* @public */ - TablesDeleted?: number | undefined; -} + RollbackErrorMessage?: string | undefined; -/** - * @public - */ -export interface GetCrawlerMetricsResponse { /** - *A list of metrics for the specified crawler.
+ *The blueprint parameters as a string. You will have to provide a value for each key that is required from the parameter spec that is defined in the Blueprint$ParameterSpec
.
A continuation token, if the returned list does not contain the - * last metric available.
+ *The role ARN. This role will be assumed by the Glue service and will be used to create the workflow and other entities of a workflow.
* @public */ - NextToken?: string | undefined; + RoleArn?: string | undefined; } /** * @public */ -export interface GetCrawlersRequest { +export interface GetBlueprintRunResponse { /** - *The number of crawlers to return on each call.
+ *Returns a BlueprintRun
object.
The name of the blueprint.
+ * @public + */ + BlueprintName: string | undefined; /** *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 GetCrawlersResponse { +export interface GetBlueprintRunsResponse { /** - *A list of crawler metadata.
+ *Returns a list of BlueprintRun
objects.
A continuation token, if the returned list has not reached the end - * of those defined in this customer account.
+ *A continuation token, if not all blueprint runs have been returned.
* @public */ NextToken?: string | undefined; @@ -6407,168 +6582,231 @@ export interface GetCrawlersResponse { /** * @public */ -export interface GetCustomEntityTypeRequest { +export interface GetCatalogRequest { /** - *The name of the custom pattern that you want to retrieve.
+ *The ID of the parent catalog in which the catalog resides. If none is provided, the Amazon Web Services Account Number is used by default.
* @public */ - Name: string | undefined; + CatalogId: string | undefined; } /** + *The output properties of the data lake access configuration for your catalog resource in the Glue Data Catalog.
* @public */ -export interface GetCustomEntityTypeResponse { +export interface DataLakeAccessPropertiesOutput { /** - *The name of the custom pattern that you retrieved.
+ *Turns on or off data lake access for Apache Spark applications that access Amazon Redshift databases in the Data Catalog.
* @public */ - Name?: string | undefined; + DataLakeAccess?: boolean | undefined; /** - *A regular expression string that is used for detecting sensitive data in a custom pattern.
+ *A role that will be assumed by Glue for transferring data into/out of the staging bucket during a query.
* @public */ - RegexString?: string | undefined; + DataTransferRole?: string | undefined; /** - *A list of context words if specified when you created the custom pattern. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
+ *An encryption key that will be used for the staging bucket that will be created along with the catalog.
* @public */ - ContextWords?: string[] | undefined; + KmsKey?: string | undefined; + + /** + *The managed Redshift Serverless compute name that is created for your catalog resource.
+ * @public + */ + ManagedWorkgroupName?: string | undefined; + + /** + *The managed Redshift Serverless compute status.
+ * @public + */ + ManagedWorkgroupStatus?: string | undefined; + + /** + *The default Redshift database resource name in the managed compute.
+ * @public + */ + RedshiftDatabaseName?: string | undefined; + + /** + *A message that gives more detailed information about the managed workgroup status.
+ * @public + */ + StatusMessage?: string | undefined; + + /** + *Specifies a federated catalog type for the native catalog resource. The currently supported type is aws:redshift
.
Property attributes that include configuration properties for the catalog resource.
* @public */ -export interface GetDatabaseRequest { +export interface CatalogPropertiesOutput { /** - *The ID of the Data Catalog in which the database resides. If none is provided, the Amazon Web Services - * account ID is used by default.
+ *A DataLakeAccessProperties
object with input properties to configure data lake access for your catalog resource in the Glue Data Catalog.
The name of the database to retrieve. For Hive compatibility, this - * should be all lowercase.
+ *Additional key-value properties for the catalog, such as column statistics optimizations.
* @public */ - Name: string | undefined; + CustomProperties?: RecordThe Database
object represents a logical grouping of tables that might reside
- * in a Hive metastore or an RDBMS.
The catalog object represents a logical grouping of databases in the Glue Data Catalog or a federated source. You can now create a Redshift-federated catalog or a catalog containing resource links to Redshift databases in another account or region.
* @public */ -export interface Database { +export interface Catalog { /** - *The name of the database. For Hive compatibility, this is folded to lowercase when it is - * stored.
+ *The ID of the catalog. To grant access to the default catalog, this field should not be provided.
+ * @public + */ + CatalogId?: string | undefined; + + /** + *The name of the catalog. Cannot be the same as the account ID.
* @public */ Name: string | undefined; /** - *A description of the database.
+ *The Amazon Resource Name (ARN) assigned to the catalog resource.
+ * @public + */ + ResourceArn?: string | undefined; + + /** + *Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern. A description of the catalog.
* @public */ Description?: string | undefined; /** - *The location of the database (for example, an HDFS path).
+ *A map array of key-value pairs that define parameters and properties of the catalog.
* @public */ - LocationUri?: string | undefined; + Parameters?: RecordThe time at which the catalog was created.
+ * @public + */ + CreateTime?: Date | undefined; /** - *These key-value pairs define parameters and properties - * of the database.
+ *The time at which the catalog was last updated.
* @public */ - Parameters?: RecordThe time at which the metadata database was created in the catalog.
+ *A TargetRedshiftCatalog
object that describes a target catalog for database resource linking.
Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.
+ *A FederatedCatalog
object that points to an entity outside the Glue Data Catalog.
A DatabaseIdentifier
structure that describes a target database for resource linking.
A CatalogProperties
object that specifies data lake access properties and other custom properties.
The ID of the Data Catalog in which the database resides.
+ *An array of PrincipalPermissions
objects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.
A FederatedDatabase
structure that references an entity outside the Glue Data Catalog.
An array of PrincipalPermissions
objects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.
The definition of the specified database in the Data Catalog.
+ *A Catalog
object. The definition of the specified catalog in the Glue Data Catalog.
The ID of the catalog to migrate. Currently, this should be the Amazon Web Services account ID.
+ * @public + */ + CatalogId?: string | undefined; +} /** + *A structure containing migration status information.
* @public */ -export type DatabaseAttributes = (typeof DatabaseAttributes)[keyof typeof DatabaseAttributes]; +export interface CatalogImportStatus { + /** + *
+ * True
if the migration has completed, or False
otherwise.
The time that the migration was started.
+ * @public + */ + ImportTime?: Date | undefined; + + /** + *The name of the person who initiated the migration.
+ * @public + */ + ImportedBy?: string | undefined; +} /** * @public */ -export type ResourceShareType = (typeof ResourceShareType)[keyof typeof ResourceShareType]; +export interface GetCatalogImportStatusResponse { + /** + *The status of the specified catalog migration.
+ * @public + */ + ImportStatus?: CatalogImportStatus | undefined; +} /** * @public */ -export interface GetDatabasesRequest { +export interface GetCatalogsRequest { /** - *The ID of the Data Catalog from which to retrieve Databases
. If none is
- * provided, the Amazon Web Services account ID is used by default.
The ID of the parent catalog in which the catalog resides. If none is provided, the Amazon Web Services Account Number is used by default.
* @public */ - CatalogId?: string | undefined; + ParentCatalogId?: string | undefined; /** *A continuation token, if this is a continuation call.
@@ -6577,48 +6815,30 @@ export interface GetDatabasesRequest { NextToken?: string | undefined; /** - *The maximum number of databases to return in one response.
+ *The maximum number of catalogs to return in one response.
* @public */ MaxResults?: number | undefined; /** - *Allows you to specify that you want to list the databases shared with your account. The allowable values are FEDERATED
, FOREIGN
or ALL
.
If set to FEDERATED
, will list the federated databases (referencing an external entity) shared with your account.
If set to FOREIGN
, will list the databases shared with your account.
If set to ALL
, will list the databases shared with your account, as well as the databases in yor local account.
Specifies the database fields returned by the GetDatabases
call. This parameter doesn’t accept an empty list. The request must include the NAME
.
When specified as true, iterates through the account and returns all catalog resources (including top-level resources and child resources)
* @public */ - AttributesToGet?: DatabaseAttributes[] | undefined; + Recursive?: boolean | undefined; } /** * @public */ -export interface GetDatabasesResponse { +export interface GetCatalogsResponse { /** - *A list of Database
objects from the specified catalog.
An array of Catalog
objects. A list of Catalog
objects from the specified parent catalog.
A continuation token for paginating the returned list of tokens, - * returned if the current segment of the list is not the last.
+ *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; @@ -6627,1131 +6847,1066 @@ export interface GetDatabasesResponse { /** * @public */ -export interface GetDataCatalogEncryptionSettingsRequest { +export interface GetClassifierRequest { /** - *The ID of the Data Catalog to retrieve the security configuration for. If none is - * provided, the Amazon Web Services account ID is used by default.
+ *Name of the classifier to retrieve.
* @public */ - CatalogId?: string | undefined; + Name: string | undefined; } /** - *The data structure used by the Data Catalog to encrypt the password as part of
- * CreateConnection
or UpdateConnection
and store it in the
- * ENCRYPTED_PASSWORD
field in the connection properties. You can enable catalog
- * encryption or only password encryption.
When a CreationConnection
request arrives containing a password, the Data
- * Catalog first encrypts the password using your KMS key. It then encrypts the whole
- * connection object again if catalog encryption is also enabled.
This encryption requires that you set KMS key permissions to enable or restrict access - * on the password key according to your security requirements. For example, you might want only - * administrators to have decrypt permission on the password key.
+ *A classifier for custom CSV
content.
When the ReturnConnectionPasswordEncrypted
flag is set to "true", passwords remain encrypted in the responses of GetConnection
and GetConnections
. This encryption takes effect independently from catalog encryption.
The name of the classifier.
* @public */ - ReturnConnectionPasswordEncrypted: boolean | undefined; + Name: string | undefined; /** - *An KMS key that is used to encrypt the connection password.
- *If connection password protection is enabled, the caller of CreateConnection
- * and UpdateConnection
needs at least kms:Encrypt
permission on the
- * specified KMS key, to encrypt passwords before storing them in the Data Catalog.
You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.
+ *The time that this classifier was registered.
* @public */ - AwsKmsKeyId?: string | undefined; -} + CreationTime?: Date | undefined; -/** - * @public - * @enum - */ -export const CatalogEncryptionMode = { - DISABLED: "DISABLED", - SSEKMS: "SSE-KMS", - SSEKMSWITHSERVICEROLE: "SSE-KMS-WITH-SERVICE-ROLE", -} as const; + /** + *The time that this classifier was last updated.
+ * @public + */ + LastUpdated?: Date | undefined; -/** - * @public - */ -export type CatalogEncryptionMode = (typeof CatalogEncryptionMode)[keyof typeof CatalogEncryptionMode]; + /** + *The version of this classifier.
+ * @public + */ + Version?: number | undefined; -/** - *Specifies the encryption-at-rest configuration for the Data Catalog.
- * @public - */ -export interface EncryptionAtRest { /** - *The encryption-at-rest mode for encrypting Data Catalog data.
+ *A custom symbol to denote what separates each column entry in the row.
* @public */ - CatalogEncryptionMode: CatalogEncryptionMode | undefined; + Delimiter?: string | undefined; /** - *The ID of the KMS key to use for encryption at rest.
+ *A custom symbol to denote what combines content into a single column value. It must be + * different from the column delimiter.
* @public */ - SseAwsKmsKeyId?: string | undefined; + QuoteSymbol?: string | undefined; /** - *The role that Glue assumes to encrypt and decrypt the Data Catalog objects on the caller's behalf.
+ *Indicates whether the CSV file contains a header.
* @public */ - CatalogEncryptionServiceRole?: string | undefined; -} + ContainsHeader?: CsvHeaderOption | undefined; -/** - *Contains configuration information for maintaining Data Catalog security.
- * @public - */ -export interface DataCatalogEncryptionSettings { /** - *Specifies the encryption-at-rest configuration for the Data Catalog.
+ *A list of strings representing column names.
* @public */ - EncryptionAtRest?: EncryptionAtRest | undefined; + Header?: string[] | undefined; /** - *When connection password protection is enabled, the Data Catalog uses a customer-provided
- * key to encrypt the password as part of CreateConnection
or
- * UpdateConnection
and store it in the ENCRYPTED_PASSWORD
field in
- * the connection properties. You can enable catalog encryption or only password
- * encryption.
Specifies not to trim values before identifying the type of column values. The default
+ * value is true
.
The requested security configuration.
+ *Enables the processing of files that contain only one column.
* @public */ - DataCatalogEncryptionSettings?: DataCatalogEncryptionSettings | undefined; -} + AllowSingleColumn?: boolean | undefined; -/** - * @public - */ -export interface GetDataflowGraphRequest { /** - *The Python script to transform.
+ *Enables the custom datatype to be configured.
* @public */ - PythonScript?: string | undefined; -} + CustomDatatypeConfigured?: boolean | undefined; -/** - * @public - */ -export interface GetDataflowGraphResponse { /** - *A list of the nodes in the resulting DAG.
+ *A list of custom datatypes including "BINARY", "BOOLEAN", "DATE", "DECIMAL", "DOUBLE", "FLOAT", "INT", "LONG", "SHORT", "STRING", "TIMESTAMP".
* @public */ - DagNodes?: CodeGenNode[] | undefined; + CustomDatatypes?: string[] | undefined; /** - *A list of the edges in the resulting DAG.
+ *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.
A classifier that uses grok
patterns.
The Statistic ID.
+ *The name of the classifier.
* @public */ - StatisticId?: string | undefined; + Name: string | undefined; /** - *The Profile ID.
+ *An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and + * so on.
* @public */ - ProfileId: string | undefined; -} - -/** - * @public - * @enum - */ -export const DataQualityModelStatus = { - FAILED: "FAILED", - RUNNING: "RUNNING", - SUCCEEDED: "SUCCEEDED", -} as const; + Classification: string | undefined; -/** - * @public - */ -export type DataQualityModelStatus = (typeof DataQualityModelStatus)[keyof typeof DataQualityModelStatus]; + /** + *The time that this classifier was registered.
+ * @public + */ + CreationTime?: Date | undefined; -/** - * @public - */ -export interface GetDataQualityModelResponse { /** - *The training status of the data quality model.
+ *The time that this classifier was last updated.
* @public */ - Status?: DataQualityModelStatus | undefined; + LastUpdated?: Date | undefined; /** - *The timestamp when the data quality model training started.
+ *The version of this classifier.
* @public */ - StartedOn?: Date | undefined; + Version?: number | undefined; /** - *The timestamp when the data quality model training completed.
+ *The grok pattern applied to a data store by this classifier. + * For more information, see built-in patterns in Writing Custom Classifiers.
* @public */ - CompletedOn?: Date | undefined; + GrokPattern: string | undefined; /** - *The training failure reason.
+ *Optional custom grok patterns defined by this classifier. + * For more information, see custom patterns in Writing Custom Classifiers.
* @public */ - FailureReason?: string | undefined; + CustomPatterns?: string | undefined; } /** + *A classifier for JSON
content.
The name of the classifier.
+ * @public + */ + Name: string | undefined; + + /** + *The time that this classifier was registered.
+ * @public + */ + CreationTime?: Date | undefined; + + /** + *The time that this classifier was last updated.
+ * @public + */ + LastUpdated?: Date | undefined; + /** - *The Statistic ID.
+ *The version of this classifier.
* @public */ - StatisticId: string | undefined; + Version?: number | undefined; /** - *The Profile ID.
+ *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.
The statistic model result.
+ *A classifier for XML
content.
The lower bound.
+ *The name of the classifier.
* @public */ - LowerBound?: number | undefined; + Name: string | undefined; /** - *The upper bound.
+ *An identifier of the data format that the classifier matches.
* @public */ - UpperBound?: number | undefined; + Classification: string | undefined; /** - *The predicted value.
+ *The time that this classifier was registered.
* @public */ - PredictedValue?: number | undefined; + CreationTime?: Date | undefined; /** - *The actual value.
+ *The time that this classifier was last updated.
* @public */ - ActualValue?: number | undefined; + LastUpdated?: Date | undefined; /** - *The date.
+ *The version of this classifier.
* @public */ - Date?: Date | undefined; + Version?: number | undefined; /** - *The inclusion annotation.
+ *The XML tag designating the element that contains each record in an XML document being
+ * parsed. This can't 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,
is okay, but
+ *
is not).
Classifiers are triggered during a crawl task. A classifier checks whether a given file is
+ * in a format it can handle. If it is, the classifier creates a schema in the form of a
+ * StructType
object that matches that data format.
You can use the standard classifiers that Glue provides, or you can write your own
+ * classifiers to best categorize your data sources and specify the appropriate schemas to use
+ * for them. A classifier can be a grok
classifier, an XML
classifier,
+ * a JSON
classifier, or a custom CSV
classifier, as specified in one
+ * of the fields in the Classifier
object.
The timestamp when the data quality model training completed.
+ *A classifier that uses grok
.
A list of StatisticModelResult
- *
A classifier for XML content.
* @public */ - Model?: StatisticModelResult[] | undefined; + XMLClassifier?: XMLClassifier | undefined; + + /** + *A classifier for JSON content.
+ * @public + */ + JsonClassifier?: JsonClassifier | undefined; + + /** + *A classifier for comma-separated values (CSV).
+ * @public + */ + CsvClassifier?: CsvClassifier | undefined; } /** * @public */ -export interface GetDataQualityResultRequest { +export interface GetClassifierResponse { /** - *A unique result ID for the data quality result.
+ *The requested classifier.
* @public */ - ResultId: string | undefined; + Classifier?: Classifier | undefined; } /** * @public */ -export interface GetDataQualityResultResponse { +export interface GetClassifiersRequest { /** - *A unique result ID for the data quality result.
+ *The size of the list to return (optional).
* @public */ - ResultId?: string | undefined; + MaxResults?: number | undefined; /** - *The Profile ID for the data quality result.
+ *An optional continuation token.
* @public */ - ProfileId?: string | undefined; + NextToken?: string | undefined; +} +/** + * @public + */ +export interface GetClassifiersResponse { /** - *An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.
+ *The requested list of classifier + * objects.
* @public */ - Score?: number | undefined; + Classifiers?: Classifier[] | undefined; /** - *The table associated with the data quality result, if any.
+ *A continuation token.
* @public */ - DataSource?: DataSource | undefined; + NextToken?: string | undefined; +} +/** + * @public + */ +export interface GetColumnStatisticsForPartitionRequest { /** - *The name of the ruleset associated with the data quality result.
+ *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 */ - RulesetName?: string | undefined; + CatalogId?: string | undefined; /** - *In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data quality nodes will have names. In the case of multiple nodes, the evaluationContext
can differentiate the nodes.
The name of the catalog database where the partitions reside.
* @public */ - EvaluationContext?: string | undefined; + DatabaseName: string | undefined; /** - *The date and time when the run for this data quality result started.
+ *The name of the partitions' table.
* @public */ - StartedOn?: Date | undefined; + TableName: string | undefined; /** - *The date and time when the run for this data quality result was completed.
+ *A list of partition values identifying the partition.
* @public */ - CompletedOn?: Date | undefined; + PartitionValues: string[] | undefined; /** - *The job name associated with the data quality result, if any.
+ *A list of the column names.
* @public */ - JobName?: string | undefined; + ColumnNames: string[] | undefined; +} +/** + *Defines column statistics supported for bit sequence data values.
+ * @public + */ +export interface BinaryColumnStatisticsData { /** - *The job run ID associated with the data quality result, if any.
+ *The size of the longest bit sequence in the column.
* @public */ - JobRunId?: string | undefined; + MaximumLength: number | undefined; /** - *The unique run ID associated with the ruleset evaluation.
+ *The average bit sequence length in the column.
* @public */ - RulesetEvaluationRunId?: string | undefined; + AverageLength: number | undefined; /** - *A list of DataQualityRuleResult
objects representing the results for each rule.
The number of null values in the column.
* @public */ - RuleResults?: DataQualityRuleResult[] | undefined; + NumberOfNulls: number | undefined; +} +/** + *Defines column statistics supported for Boolean data columns.
+ * @public + */ +export interface BooleanColumnStatisticsData { /** - *A list of DataQualityAnalyzerResult
objects representing the results for each analyzer.
The number of true values in the column.
* @public */ - AnalyzerResults?: DataQualityAnalyzerResult[] | undefined; + NumberOfTrues: number | undefined; /** - *A list of DataQualityObservation
objects representing the observations generated after evaluating the rules and analyzers.
The number of false values in the column.
* @public */ - Observations?: DataQualityObservation[] | undefined; -} + NumberOfFalses: number | undefined; -/** - * @public - */ -export interface GetDataQualityRuleRecommendationRunRequest { /** - *The unique run identifier associated with this run.
+ *The number of null values in the column.
* @public */ - RunId: string | undefined; + NumberOfNulls: number | undefined; } /** + *Defines column statistics supported for timestamp data columns.
* @public */ -export interface GetDataQualityRuleRecommendationRunResponse { - /** - *The unique run identifier associated with this run.
- * @public - */ - RunId?: string | undefined; - +export interface DateColumnStatisticsData { /** - *The data source (an Glue table) associated with this run.
+ *The lowest value in the column.
* @public */ - DataSource?: DataSource | undefined; + MinimumValue?: Date | undefined; /** - *An IAM role supplied to encrypt the results of the run.
+ *The highest value in the column.
* @public */ - Role?: string | undefined; + MaximumValue?: Date | undefined; /** - *The number of G.1X
workers to be used in the run. The default is 5.
The number of null values in the column.
* @public */ - NumberOfWorkers?: number | undefined; + NumberOfNulls: number | undefined; /** - *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).
The number of distinct values in a column.
* @public */ - Timeout?: number | undefined; + NumberOfDistinctValues: number | undefined; +} +/** + *Contains a numeric value in decimal format.
+ * @public + */ +export interface DecimalNumber { /** - *The status for this run.
+ *The unscaled numeric value.
* @public */ - Status?: TaskStatusType | undefined; + UnscaledValue: Uint8Array | undefined; /** - *The error strings that are associated with the run.
+ *The scale that determines where the decimal point falls in the + * unscaled value.
* @public */ - ErrorString?: string | undefined; + Scale: number | undefined; +} +/** + *Defines column statistics supported for fixed-point number data columns.
+ * @public + */ +export interface DecimalColumnStatisticsData { /** - *The date and time when this run started.
+ *The lowest value in the column.
* @public */ - StartedOn?: Date | undefined; + MinimumValue?: DecimalNumber | undefined; /** - *A timestamp. The last point in time when this data quality rule recommendation run was modified.
+ *The highest value in the column.
* @public */ - LastModifiedOn?: Date | undefined; + MaximumValue?: DecimalNumber | undefined; /** - *The date and time when this run was completed.
+ *The number of null values in the column.
* @public */ - CompletedOn?: Date | undefined; + NumberOfNulls: number | undefined; /** - *The amount of time (in seconds) that the run consumed resources.
+ *The number of distinct values in a column.
* @public */ - ExecutionTime?: number | undefined; + NumberOfDistinctValues: number | undefined; +} +/** + *Defines column statistics supported for floating-point number data columns.
+ * @public + */ +export interface DoubleColumnStatisticsData { /** - *When a start rule recommendation run completes, it creates a recommended ruleset (a set of rules). This member has those rules in Data Quality Definition Language (DQDL) format.
+ *The lowest value in the column.
* @public */ - RecommendedRuleset?: string | undefined; + MinimumValue?: number | undefined; /** - *The name of the ruleset that was created by the run.
+ *The highest value in the column.
* @public */ - CreatedRulesetName?: string | undefined; + MaximumValue?: number | undefined; /** - *The name of the security configuration created with the data quality encryption option.
+ *The number of null values in the column.
* @public */ - DataQualitySecurityConfiguration?: string | undefined; -} + NumberOfNulls: number | undefined; -/** - * @public - */ -export interface GetDataQualityRulesetRequest { /** - *The name of the ruleset.
+ *The number of distinct values in a column.
* @public */ - Name: string | undefined; + NumberOfDistinctValues: number | undefined; } /** + *Defines column statistics supported for integer data columns.
* @public */ -export interface GetDataQualityRulesetResponse { - /** - *The name of the ruleset.
- * @public - */ - Name?: string | undefined; - +export interface LongColumnStatisticsData { /** - *A description of the ruleset.
+ *The lowest value in the column.
* @public */ - Description?: string | undefined; + MinimumValue?: number | undefined; /** - *A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
+ *The highest value in the column.
* @public */ - Ruleset?: string | undefined; + MaximumValue?: number | undefined; /** - *The name and database name of the target table.
+ *The number of null values in the column.
* @public */ - TargetTable?: DataQualityTargetTable | undefined; + NumberOfNulls: number | undefined; /** - *A timestamp. The time and date that this data quality ruleset was created.
+ *The number of distinct values in a column.
* @public */ - CreatedOn?: Date | undefined; + NumberOfDistinctValues: number | undefined; +} +/** + *Defines column statistics supported for character sequence data values.
+ * @public + */ +export interface StringColumnStatisticsData { /** - *A timestamp. The last point in time when this data quality ruleset was modified.
+ *The size of the longest string in the column.
* @public */ - LastModifiedOn?: Date | undefined; + MaximumLength: number | undefined; /** - *When a ruleset was created from a recommendation run, this run ID is generated to link the two together.
+ *The average string length in the column.
* @public */ - RecommendationRunId?: string | undefined; + AverageLength: number | undefined; /** - *The name of the security configuration created with the data quality encryption option.
+ *The number of null values in the column.
* @public */ - DataQualitySecurityConfiguration?: string | undefined; -} + NumberOfNulls: number | undefined; -/** - * @public - */ -export interface GetDataQualityRulesetEvaluationRunRequest { /** - *The unique run identifier associated with this run.
+ *The number of distinct values in a column.
* @public */ - RunId: string | undefined; + NumberOfDistinctValues: number | undefined; } /** * @public * @enum */ -export const DQCompositeRuleEvaluationMethod = { - COLUMN: "COLUMN", - ROW: "ROW", +export const ColumnStatisticsType = { + BINARY: "BINARY", + BOOLEAN: "BOOLEAN", + DATE: "DATE", + DECIMAL: "DECIMAL", + DOUBLE: "DOUBLE", + LONG: "LONG", + STRING: "STRING", } as const; /** * @public */ -export type DQCompositeRuleEvaluationMethod = - (typeof DQCompositeRuleEvaluationMethod)[keyof typeof DQCompositeRuleEvaluationMethod]; +export type ColumnStatisticsType = (typeof ColumnStatisticsType)[keyof typeof ColumnStatisticsType]; /** - *Additional run options you can specify for an evaluation run.
+ *Contains the individual types of column statistics data. Only one data object should be set and indicated by the Type
attribute.
Whether or not to enable CloudWatch metrics.
- * @public - */ - CloudWatchMetricsEnabled?: boolean | undefined; - - /** - *Prefix for Amazon S3 to store results.
- * @public - */ - ResultsS3Prefix?: string | undefined; - +export interface ColumnStatisticsData { /** - *Set the evaluation method for composite rules in the ruleset to ROW/COLUMN
+ *The type of column statistics data.
* @public */ - CompositeRuleEvaluationMethod?: DQCompositeRuleEvaluationMethod | undefined; -} + Type: ColumnStatisticsType | undefined; -/** - * @public - */ -export interface GetDataQualityRulesetEvaluationRunResponse { /** - *The unique run identifier associated with this run.
+ *Boolean column statistics data.
* @public */ - RunId?: string | undefined; + BooleanColumnStatisticsData?: BooleanColumnStatisticsData | undefined; /** - *The data source (an Glue table) associated with this evaluation run.
+ *Date column statistics data.
* @public */ - DataSource?: DataSource | undefined; + DateColumnStatisticsData?: DateColumnStatisticsData | undefined; /** - *An IAM role supplied to encrypt the results of the run.
+ *+ * Decimal column statistics data. UnscaledValues within are Base64-encoded + * binary objects storing big-endian, two's complement representations of + * the decimal's unscaled value. + *
* @public */ - Role?: string | undefined; + DecimalColumnStatisticsData?: DecimalColumnStatisticsData | undefined; /** - *The number of G.1X
workers to be used in the run. The default is 5.
Double column statistics data.
* @public */ - NumberOfWorkers?: number | undefined; + DoubleColumnStatisticsData?: DoubleColumnStatisticsData | undefined; /** - *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).
Long column statistics data.
* @public */ - Timeout?: number | undefined; + LongColumnStatisticsData?: LongColumnStatisticsData | undefined; /** - *Additional run options you can specify for an evaluation run.
+ *String column statistics data.
* @public */ - AdditionalRunOptions?: DataQualityEvaluationRunAdditionalRunOptions | undefined; + StringColumnStatisticsData?: StringColumnStatisticsData | undefined; /** - *The status for this run.
+ *Binary column statistics data.
* @public */ - Status?: TaskStatusType | undefined; + BinaryColumnStatisticsData?: BinaryColumnStatisticsData | undefined; +} +/** + *Represents the generated column-level statistics for a table or partition.
+ * @public + */ +export interface ColumnStatistics { /** - *The error strings that are associated with the run.
+ *Name of column which statistics belong to.
* @public */ - ErrorString?: string | undefined; + ColumnName: string | undefined; /** - *The date and time when this run started.
+ *The data type of the column.
* @public */ - StartedOn?: Date | undefined; + ColumnType: string | undefined; /** - *A timestamp. The last point in time when this data quality rule recommendation run was modified.
+ *The timestamp of when column statistics were generated.
* @public */ - LastModifiedOn?: Date | undefined; + AnalyzedTime: Date | undefined; /** - *The date and time when this run was completed.
+ *A ColumnStatisticData
object that contains the statistics data values.
Encapsulates a column name that failed and the reason for failure.
+ * @public + */ +export interface ColumnError { /** - *The amount of time (in seconds) that the run consumed resources.
+ *The name of the column that failed.
* @public */ - ExecutionTime?: number | undefined; + ColumnName?: string | undefined; /** - *A list of ruleset names for the run. Currently, this parameter takes only one Ruleset name.
+ *An error message with the reason for the failure of an operation.
* @public */ - RulesetNames?: string[] | undefined; + Error?: ErrorDetail | undefined; +} +/** + * @public + */ +export interface GetColumnStatisticsForPartitionResponse { /** - *A list of result IDs for the data quality results for the run.
+ *List of ColumnStatistics that failed to be retrieved.
* @public */ - ResultIds?: string[] | undefined; + ColumnStatisticsList?: ColumnStatistics[] | undefined; /** - *A map of reference strings to additional data sources you can specify for an evaluation run.
+ *Error occurred during retrieving column statistics data.
* @public */ - AdditionalDataSources?: RecordName of the DevEndpoint
to retrieve information for.
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 */ - EndpointName: string | undefined; -} + CatalogId?: string | undefined; -/** - * @public - */ -export interface GetDevEndpointResponse { /** - *A DevEndpoint
definition.
The name of the catalog database where the partitions reside.
* @public */ - DevEndpoint?: DevEndpoint | undefined; -} + DatabaseName: string | undefined; -/** - * @public - */ -export interface GetDevEndpointsRequest { /** - *The maximum size of information to return.
+ *The name of the partitions' table.
* @public */ - MaxResults?: number | undefined; + TableName: string | undefined; /** - *A continuation token, if this is a continuation call.
+ *A list of the column names.
* @public */ - NextToken?: string | undefined; + ColumnNames: string[] | undefined; } /** * @public */ -export interface GetDevEndpointsResponse { +export interface GetColumnStatisticsForTableResponse { /** - *A list of DevEndpoint
definitions.
List of ColumnStatistics.
* @public */ - DevEndpoints?: DevEndpoint[] | undefined; + ColumnStatisticsList?: ColumnStatistics[] | undefined; /** - *A continuation token, if not all DevEndpoint
definitions have yet been
- * returned.
List of ColumnStatistics that failed to be retrieved.
* @public */ - NextToken?: string | undefined; + Errors?: ColumnError[] | undefined; } /** * @public */ -export interface GetJobRequest { +export interface GetColumnStatisticsTaskRunRequest { /** - *The name of the job definition to retrieve.
+ *The identifier for the particular column statistics task run.
* @public */ - JobName: string | undefined; + ColumnStatisticsTaskRunId: string | undefined; } /** * @public + * @enum */ -export interface GetJobBookmarkRequest { - /** - *The name of the job in question.
- * @public - */ - JobName: string | undefined; +export const ComputationType = { + FULL: "FULL", + INCREMENTAL: "INCREMENTAL", +} as const; - /** - *The unique run identifier associated with this job run.
- * @public - */ - RunId?: string | undefined; -} +/** + * @public + */ +export type ComputationType = (typeof ComputationType)[keyof typeof ComputationType]; + +/** + * @public + * @enum + */ +export const ColumnStatisticsState = { + FAILED: "FAILED", + RUNNING: "RUNNING", + STARTING: "STARTING", + STOPPED: "STOPPED", + SUCCEEDED: "SUCCEEDED", +} as const; + +/** + * @public + */ +export type ColumnStatisticsState = (typeof ColumnStatisticsState)[keyof typeof ColumnStatisticsState]; /** - *Defines a point that a job can resume processing.
+ *The object that shows the details of the column stats run.
* @public */ -export interface JobBookmarkEntry { +export interface ColumnStatisticsTaskRun { /** - *The name of the job in question.
+ *The Amazon Web Services account ID.
* @public */ - JobName?: string | undefined; + CustomerId?: string | undefined; /** - *The version of the job.
+ *The identifier for the particular column statistics task run.
* @public */ - Version?: number | undefined; + ColumnStatisticsTaskRunId?: string | undefined; /** - *The run ID number.
+ *The database where the table resides.
* @public */ - Run?: number | undefined; + DatabaseName?: string | undefined; /** - *The attempt ID number.
+ *The name of the table for which column statistics is generated.
* @public */ - Attempt?: number | undefined; + TableName?: string | undefined; /** - *The unique run identifier associated with the previous job run.
+ *A list of the column names. If none is supplied, all column names for the table will be used by default.
* @public */ - PreviousRunId?: string | undefined; + ColumnNameList?: string[] | undefined; /** - *The run ID number.
+ *The ID of the Data Catalog where the table resides. If none is supplied, the Amazon Web Services account ID is used by default.
* @public */ - RunId?: string | undefined; + CatalogID?: string | undefined; /** - *The bookmark itself.
+ *The IAM role that the service assumes to generate statistics.
* @public */ - JobBookmark?: string | undefined; -} + Role?: string | undefined; -/** - * @public - */ -export interface GetJobBookmarkResponse { /** - *A structure that defines a point that a job can resume processing.
+ *The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
* @public */ - JobBookmarkEntry?: JobBookmarkEntry | undefined; -} + SampleSize?: number | undefined; -/** - * @public - */ -export interface GetJobRunRequest { /** - *Name of the job definition being run.
+ *Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
* @public */ - JobName: string | undefined; + SecurityConfiguration?: string | undefined; /** - *The ID of the job run.
+ *The number of workers used to generate column statistics. The job is preconfigured to autoscale up to 25 instances.
* @public */ - RunId: string | undefined; + NumberOfWorkers?: number | undefined; /** - *True if a list of predecessor runs should be returned.
+ *The type of workers being used for generating stats. The default is g.1x
.
The requested job-run metadata.
+ *The type of column statistics computation.
* @public */ - JobRun?: JobRun | undefined; -} + ComputationType?: ComputationType | undefined; -/** - * @public - */ -export interface GetJobRunsRequest { /** - *The name of the job definition for which to retrieve all job runs.
+ *The status of the task run.
* @public */ - JobName: string | undefined; + Status?: ColumnStatisticsState | undefined; /** - *A continuation token, if this is a continuation call.
+ *The time that this task was created.
* @public */ - NextToken?: string | undefined; + CreationTime?: Date | undefined; /** - *The maximum size of the response.
+ *The last point in time when this task was modified.
* @public */ - MaxResults?: number | undefined; -} + LastUpdated?: Date | undefined; -/** - * @public - */ -export interface GetJobRunsResponse { /** - *A list of job-run metadata objects.
+ *The start time of the task.
* @public */ - JobRuns?: JobRun[] | undefined; + StartTime?: Date | undefined; /** - *A continuation token, if not all requested job runs have been returned.
+ *The end time of the task.
* @public */ - NextToken?: string | undefined; -} + EndTime?: Date | undefined; -/** - * @public - */ -export interface GetJobsRequest { /** - *A continuation token, if this is a continuation call.
+ *The error message for the job.
* @public */ - NextToken?: string | undefined; + ErrorMessage?: string | undefined; /** - *The maximum size of the response.
+ *The calculated DPU usage in seconds for all autoscaled workers.
* @public */ - MaxResults?: number | undefined; + DPUSeconds?: number | undefined; } /** - *The location of resources.
* @public */ -export interface Location { - /** - *A JDBC location.
- * @public - */ - Jdbc?: CodeGenNodeArg[] | undefined; - - /** - *An Amazon Simple Storage Service (Amazon S3) location.
- * @public - */ - S3?: CodeGenNodeArg[] | undefined; - +export interface GetColumnStatisticsTaskRunResponse { /** - *An Amazon DynamoDB table location.
+ *A ColumnStatisticsTaskRun
object representing the details of the column stats run.
Specifies a table definition in the Glue Data Catalog.
* @public */ -export interface CatalogEntry { +export interface GetColumnStatisticsTaskRunsRequest { /** - *The database in which the table metadata resides.
+ *The name of the database where the table resides.
* @public */ DatabaseName: string | undefined; /** - *The name of the table in question.
+ *The name of the table.
* @public */ TableName: string | undefined; -} - -/** - * @public - */ -export interface GetMappingRequest { - /** - *Specifies the source table.
- * @public - */ - Source: CatalogEntry | undefined; /** - *A list of target tables.
+ *The maximum size of the response.
* @public */ - Sinks?: CatalogEntry[] | undefined; + MaxResults?: number | undefined; /** - *Parameters for the mapping.
+ *A continuation token, if this is a continuation call.
* @public */ - Location?: Location | undefined; + NextToken?: string | undefined; } /** - *Defines a mapping.
* @public */ -export interface MappingEntry { - /** - *The name of the source table.
- * @public - */ - SourceTable?: string | undefined; - - /** - *The source path.
- * @public - */ - SourcePath?: string | undefined; - +export interface GetColumnStatisticsTaskRunsResponse { /** - *The source type.
+ *A list of column statistics task runs.
* @public */ - SourceType?: string | undefined; + ColumnStatisticsTaskRuns?: ColumnStatisticsTaskRun[] | undefined; /** - *The target table.
+ *A continuation token, if not all task runs have yet been returned.
* @public */ - TargetTable?: string | undefined; + NextToken?: string | undefined; +} +/** + * @public + */ +export interface GetColumnStatisticsTaskSettingsRequest { /** - *The target path.
+ *The name of the database where the table resides.
* @public */ - TargetPath?: string | undefined; + DatabaseName: string | undefined; /** - *The target type.
+ *The name of the table for which to retrieve column statistics.
* @public */ - TargetType?: string | undefined; + TableName: string | undefined; } /** * @public + * @enum */ -export interface GetMappingResponse { - /** - *A list of mappings to the specified targets.
- * @public - */ - Mapping: MappingEntry[] | undefined; -} +export const ExecutionStatus = { + FAILED: "FAILED", + STARTED: "STARTED", +} as const; /** * @public */ -export interface GetMLTaskRunRequest { - /** - *The unique identifier of the machine learning transform.
- * @public - */ - TransformId: string | undefined; - - /** - *The unique identifier of the task run.
- * @public - */ - TaskRunId: string | undefined; -} +export type ExecutionStatus = (typeof ExecutionStatus)[keyof typeof ExecutionStatus]; /** - *Specifies configuration properties for an exporting labels task run.
+ *A run attempt for a column statistics task run.
* @public */ -export interface ExportLabelsTaskRunProperties { +export interface ExecutionAttempt { /** - *The Amazon Simple Storage Service (Amazon S3) path where you will export the - * labels.
+ *The status of the last column statistics task run.
* @public */ - OutputS3Path?: string | undefined; -} + Status?: ExecutionStatus | undefined; -/** - *Specifies configuration properties for a Find Matches task run.
- * @public - */ -export interface FindMatchesTaskRunProperties { /** - *The job ID for the Find Matches task run.
+ *A task run ID for the last column statistics task run.
* @public */ - JobId?: string | undefined; + ColumnStatisticsTaskRunId?: string | undefined; /** - *The name assigned to the job for the Find Matches task run.
+ *A timestamp when the last column statistics task run occurred.
* @public */ - JobName?: string | undefined; + ExecutionTimestamp?: Date | undefined; /** - *The job run ID for the Find Matches task run.
+ *An error message associated with the last column statistics task run.
* @public */ - JobRunId?: string | undefined; + ErrorMessage?: string | undefined; } /** - *Specifies configuration properties for an importing labels task run.
* @public + * @enum */ -export interface ImportLabelsTaskRunProperties { - /** - *The Amazon Simple Storage Service (Amazon S3) path from where you will import the - * labels.
- * @public - */ - InputS3Path?: string | undefined; +export const ScheduleType = { + AUTO: "AUTO", + CRON: "CRON", +} as const; - /** - *Indicates whether to overwrite your existing labels.
- * @public - */ - Replace?: boolean | undefined; -} +/** + * @public + */ +export type ScheduleType = (typeof ScheduleType)[keyof typeof ScheduleType]; /** - *Specifies configuration properties for a labeling set generation task run.
* @public + * @enum */ -export interface LabelingSetGenerationTaskRunProperties { - /** - *The Amazon Simple Storage Service (Amazon S3) path where you will generate the labeling - * set.
- * @public - */ - OutputS3Path?: string | undefined; -} +export const SettingSource = { + CATALOG: "CATALOG", + TABLE: "TABLE", +} as const; + +/** + * @public + */ +export type SettingSource = (typeof SettingSource)[keyof typeof SettingSource]; /** * @internal @@ -7770,17 +7925,3 @@ export const CreateConnectionRequestFilterSensitiveLog = (obj: CreateConnectionR ...obj, ...(obj.ConnectionInput && { ConnectionInput: ConnectionInputFilterSensitiveLog(obj.ConnectionInput) }), }); - -/** - * @internal - */ -export const GetDataQualityResultResponseFilterSensitiveLog = (obj: GetDataQualityResultResponse): any => ({ - ...obj, - ...(obj.RuleResults && { RuleResults: obj.RuleResults.map((item) => DataQualityRuleResultFilterSensitiveLog(item)) }), - ...(obj.AnalyzerResults && { - AnalyzerResults: obj.AnalyzerResults.map((item) => DataQualityAnalyzerResultFilterSensitiveLog(item)), - }), - ...(obj.Observations && { - Observations: obj.Observations.map((item) => DataQualityObservationFilterSensitiveLog(item)), - }), -}); diff --git a/clients/client-glue/src/models/models_2.ts b/clients/client-glue/src/models/models_2.ts index 19060d225373..d8b59f7f1db5 100644 --- a/clients/client-glue/src/models/models_2.ts +++ b/clients/client-glue/src/models/models_2.ts @@ -1,26 +1,30 @@ // smithy-typescript generated code import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@smithy/smithy-client"; +import { DocumentType as __DocumentType } from "@smithy/types"; + import { GlueServiceException as __BaseException } from "./GlueServiceException"; import { AuditContext, - AuthenticationConfigurationInput, - AuthenticationConfigurationInputFilterSensitiveLog, - CrawlerTargets, + AuthenticationConfiguration, + Crawler, CustomEntityType, + DataQualityAnalyzerResult, + DataQualityAnalyzerResultFilterSensitiveLog, + DataQualityObservation, + DataQualityObservationFilterSensitiveLog, + DataQualityRuleResult, + DataQualityRuleResultFilterSensitiveLog, DataSource, + DevEndpoint, ErrorDetail, - ExecutionClass, GlueTable, InclusionAnnotationValue, - LakeFormationConfiguration, - LineageConfiguration, - NotificationProperty, + JobRun, Partition, PartitionValueList, - RecrawlPolicy, - SchemaChangePolicy, + Schedule, SchemaId, StatisticAnnotation, TableOptimizer, @@ -34,39 +38,42 @@ import { } from "./models_0"; import { - CatalogEntry, - ColumnStatistics, + Capabilities, + CodeGenEdge, + CodeGenNode, + CodeGenNodeArg, Compatibility, - ConnectionInput, - ConnectionInputFilterSensitiveLog, + ComputeEnvironment, ConnectionPropertyKey, + ConnectionStatus, ConnectionType, - CsvHeaderOption, - CsvSerdeOption, - DatabaseInput, - DataCatalogEncryptionSettings, + DatabaseIdentifier, DataFormat, - DataQualityEvaluationRunAdditionalRunOptions, DataQualityTargetTable, EncryptionConfiguration, - ExportLabelsTaskRunProperties, - FindMatchesTaskRunProperties, - ImportLabelsTaskRunProperties, - JobBookmarkEntry, - LabelingSetGenerationTaskRunProperties, + ExecutionAttempt, + FederatedDatabase, + IntegrationError, + IntegrationStatus, Language, - Location, - MappingEntry, Permission, + PhysicalConnectionRequirements, + PrincipalPermissions, PrincipalType, ProfileConfiguration, RegistryId, RegistryStatus, - ResourceShareType, ResourceUri, + ScheduleType, SchemaStatus, SchemaVersionStatus, Session, + SettingSource, + SourceProcessingProperties, + SourceTableConfig, + Tag, + TargetProcessingProperties, + TargetTableConfig, TaskStatusType, TransformEncryption, TransformParameters, @@ -75,4996 +82,5591 @@ import { } from "./models_1"; /** - * @public - * @enum - */ -export const TaskType = { - EVALUATION: "EVALUATION", - EXPORT_LABELS: "EXPORT_LABELS", - FIND_MATCHES: "FIND_MATCHES", - IMPORT_LABELS: "IMPORT_LABELS", - LABELING_SET_GENERATION: "LABELING_SET_GENERATION", -} as const; - -/** - * @public - */ -export type TaskType = (typeof TaskType)[keyof typeof TaskType]; - -/** - *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; -} - -/** + *The settings for a column statistics task.
* @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; - +export interface ColumnStatisticsTaskSettings { /** - *The names of the log groups that are associated with the task run.
+ *The name of the database where the table resides.
* @public */ - LogGroupName?: string | undefined; + DatabaseName?: string | undefined; /** - *The list of properties that are associated with the task run.
+ *The name of the table for which to generate column statistics.
* @public */ - Properties?: TaskRunProperties | undefined; + TableName?: string | undefined; /** - *The error strings that are associated with the task run.
+ *A schedule for running the column statistics, specified in CRON syntax.
* @public */ - ErrorString?: string | undefined; + Schedule?: Schedule | undefined; /** - *The date and time when this task run started.
+ *A list of column names for which to run statistics.
* @public */ - StartedOn?: Date | undefined; + ColumnNameList?: string[] | undefined; /** - *The date and time when this task run was last modified.
+ *The ID of the Data Catalog in which the database resides.
* @public */ - LastModifiedOn?: Date | undefined; + CatalogID?: string | undefined; /** - *The date and time when this task run was completed.
+ *The role used for running the column statistics.
* @public */ - CompletedOn?: Date | undefined; + Role?: string | undefined; /** - *The amount of time (in seconds) that the task run consumed resources.
+ *The percentage of data to sample.
* @public */ - ExecutionTime?: number | undefined; -} + SampleSize?: 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.
+ *Name of the security configuration that is used to encrypt CloudWatch logs.
* @public */ - TaskRunType?: TaskType | undefined; + SecurityConfiguration?: string | undefined; /** - *The current status of the task run.
+ *The type of schedule for a column statistics task. Possible values may be CRON
or AUTO
.
Filter on task runs started before this date.
+ *The source of setting the column statistics task. Possible values may be CATALOG
or TABLE
.
Filter on task runs started after this date.
+ *The last ExecutionAttempt
for the column statistics task run.
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; - +export interface GetColumnStatisticsTaskSettingsResponse { /** - *The sort direction to be used to sort the list of task runs for the machine learning - * transform.
+ *A ColumnStatisticsTaskSettings
object representing the settings for the column statistics task.
The unique identifier of the machine learning transform.
- * @public - */ - TransformId: string | undefined; - - /** - *A token for pagination of the results. The default is empty.
+ *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 */ - NextToken?: string | undefined; + CatalogId?: string | undefined; /** - *The maximum number of results to return.
+ *The name of the connection definition to retrieve.
* @public */ - MaxResults?: number | undefined; + Name: string | undefined; /** - *The filter criteria, in the TaskRunFilterCriteria
structure, for the task run.
Allows you to retrieve the connection metadata without returning the password. For + * instance, the Glue console uses this flag to retrieve the connection, and does not display + * the password. Set this parameter when the caller might not have permission to use the KMS + * key to decrypt the password, but it does have permission to access the rest of the connection + * properties.
* @public */ - Filter?: TaskRunFilterCriteria | undefined; + HidePassword?: boolean | undefined; /** - *The sorting criteria, in the TaskRunSortCriteria
structure, for the task run.
For connections that may be used in multiple services, specifies returning properties for the specified compute environment.
* @public */ - Sort?: TaskRunSortCriteria | undefined; + ApplyOverrideForComputeEnvironment?: ComputeEnvironment | undefined; } /** - *The sampling parameters that are associated with the machine learning transform.
+ *Defines a connection to a data source.
* @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; - +export interface Connection { /** - *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.
+ *The name of the connection definition.
* @public */ - CompletedOn?: Date | undefined; + Name?: string | undefined; /** - *The amount of time (in seconds) that the task run consumed resources.
+ *The description of the connection.
* @public */ - ExecutionTime?: number | undefined; -} + Description?: string | undefined; -/** - * @public - */ -export interface GetMLTaskRunsResponse { /** - *A list of task runs that are associated with the transform.
+ *The type of the connection. Currently, SFTP is not supported.
* @public */ - TaskRuns?: TaskRun[] | undefined; + ConnectionType?: ConnectionType | undefined; /** - *A pagination token, if more results are available.
+ *A list of criteria that can be used in selecting this connection.
* @public */ - NextToken?: string | undefined; -} + MatchCriteria?: 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.
+ *These key-value pairs define parameters for the connection when using the version 1 Connection schema:
+ *
+ * HOST
- The host URI: either the
+ * fully qualified domain name (FQDN) or the IPv4 address of
+ * the database host.
+ * PORT
- The port number, between
+ * 1024 and 65535, of the port on which the database host is
+ * listening for database connections.
+ * USER_NAME
- The name under which
+ * to log in to the database. The value string for USER_NAME
is "USERNAME
".
+ * PASSWORD
- A password,
+ * if one is used, for the user name.
+ * ENCRYPTED_PASSWORD
- When you enable connection password protection by setting ConnectionPasswordEncryption
in the Data Catalog encryption settings, this field stores the encrypted password.
+ * JDBC_DRIVER_JAR_URI
- The Amazon Simple Storage Service (Amazon S3) path of the
+ * JAR file that contains the JDBC driver to use.
+ * JDBC_DRIVER_CLASS_NAME
- The class name of the JDBC driver to use.
+ * JDBC_ENGINE
- The name of the JDBC engine to use.
+ * JDBC_ENGINE_VERSION
- The version of the JDBC engine to use.
+ * CONFIG_FILES
- (Reserved for future use.)
+ * INSTANCE_ID
- The instance ID to use.
+ * JDBC_CONNECTION_URL
- The URL for connecting to a JDBC data source.
+ * JDBC_ENFORCE_SSL
- A Boolean string (true, false) specifying whether Secure
+ * Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the
+ * client. The default is false.
+ * CUSTOM_JDBC_CERT
- An Amazon S3 location specifying the customer's root certificate. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.
+ * SKIP_CUSTOM_JDBC_CERT_VALIDATION
- By default, this is false
. Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true
to skip Glue’s validation of the customer certificate.
+ * CUSTOM_JDBC_CERT_STRING
- A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN
; in Microsoft SQL Server, this is used as the hostNameInCertificate
.
+ * CONNECTION_URL
- The URL for connecting to a general (non-JDBC) data source.
+ * SECRET_ID
- The secret ID used for the secret manager of credentials.
+ * CONNECTOR_URL
- The connector URL for a MARKETPLACE or CUSTOM connection.
+ * CONNECTOR_TYPE
- The connector type for a MARKETPLACE or CUSTOM connection.
+ * CONNECTOR_CLASS_NAME
- The connector class name for a MARKETPLACE or CUSTOM connection.
+ * KAFKA_BOOTSTRAP_SERVERS
- A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.
+ * KAFKA_SSL_ENABLED
- Whether to enable or disable SSL on an Apache Kafka connection. Default value is "true".
+ * KAFKA_CUSTOM_CERT
- The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string.
+ * KAFKA_SKIP_CUSTOM_CERT_VALIDATION
- Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is "false".
+ * KAFKA_CLIENT_KEYSTORE
- The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional).
+ * KAFKA_CLIENT_KEYSTORE_PASSWORD
- The password to access the provided keystore (Optional).
+ * KAFKA_CLIENT_KEY_PASSWORD
- A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional).
+ * ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
- The encrypted version of the Kafka client keystore password (if the user has the Glue encrypt passwords setting selected).
+ * ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
- The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).
+ * KAFKA_SASL_MECHANISM
- "SCRAM-SHA-512"
, "GSSAPI"
, "AWS_MSK_IAM"
, or "PLAIN"
. These are the supported SASL Mechanisms.
+ * KAFKA_SASL_PLAIN_USERNAME
- A plaintext username used to authenticate with the "PLAIN" mechanism.
+ * KAFKA_SASL_PLAIN_PASSWORD
- A plaintext password used to authenticate with the "PLAIN" mechanism.
+ * ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD
- The encrypted version of the Kafka SASL PLAIN password (if the user has the Glue encrypt passwords setting selected).
+ * KAFKA_SASL_SCRAM_USERNAME
- A plaintext username used to authenticate with the "SCRAM-SHA-512" mechanism.
+ * KAFKA_SASL_SCRAM_PASSWORD
- A plaintext password used to authenticate with the "SCRAM-SHA-512" mechanism.
+ * ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
- The encrypted version of the Kafka SASL SCRAM password (if the user has the Glue encrypt passwords setting selected).
+ * KAFKA_SASL_SCRAM_SECRETS_ARN
- The Amazon Resource Name of a secret in Amazon Web Services Secrets Manager.
+ * KAFKA_SASL_GSSAPI_KEYTAB
- The S3 location of a Kerberos keytab
file. A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab.
+ * KAFKA_SASL_GSSAPI_KRB5_CONF
- The S3 location of a Kerberos krb5.conf
file. A krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf.
+ * KAFKA_SASL_GSSAPI_SERVICE
- The Kerberos service name, as set with sasl.kerberos.service.name
in your Kafka Configuration.
+ * KAFKA_SASL_GSSAPI_PRINCIPAL
- The name of the Kerberos princial used by Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers.
+ * ROLE_ARN
- The role to be used for running queries.
+ * REGION
- The Amazon Web Services Region where queries will be run.
+ * WORKGROUP_NAME
- The name of an Amazon Redshift serverless workgroup or Amazon Athena workgroup in which queries will run.
+ * CLUSTER_IDENTIFIER
- The cluster identifier of an Amazon Redshift cluster in which queries will run.
+ * DATABASE
- The Amazon Redshift database that you are connecting to.
The column importance score for the column, as a decimal.
+ *Connection properties specific to the Spark compute environment.
* @public */ - Importance?: number | undefined; -} + SparkProperties?: RecordThe 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.
+ *Connection properties specific to the Athena compute environment.
* @public */ - NumTruePositives?: number | undefined; + AthenaProperties?: RecordThe number of nonmatches in the data that the transform incorrectly classified as a match, - * in the confusion matrix for your transform.
+ *Connection properties specific to the Python compute environment.
* @public */ - NumFalsePositives?: number | undefined; + PythonProperties?: RecordThe number of nonmatches in the data that the transform correctly rejected, in the - * confusion matrix for your transform.
+ *The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup
, that are needed to make this connection successfully.
The number of matches in the data that the transform didn't find, in the confusion matrix for your transform.
+ *The timestamp of the time that this connection definition was created.
* @public */ - NumFalseNegatives?: number | undefined; -} + CreationTime?: Date | 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.
+ *The timestamp of the last time the connection definition was updated.
* @public */ - AreaUnderPRCurve?: number | undefined; + LastUpdatedTime?: Date | 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.
+ *The user, group, or role that last updated this connection definition.
* @public */ - Precision?: number | undefined; + LastUpdatedBy?: string | 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.
+ *The status of the connection. Can be one of: READY
, IN_PROGRESS
, or FAILED
.
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.
+ *The reason for the connection status.
* @public */ - F1?: number | undefined; + StatusReason?: string | 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.
+ *A timestamp of the time this connection was last validated.
* @public */ - ConfusionMatrix?: ConfusionMatrix | undefined; + LastConnectionValidationTime?: Date | undefined; /** - *A list of ColumnImportance
structures containing column importance metrics, sorted in order of descending importance.
The authentication properties of the connection.
* @public */ - ColumnImportances?: ColumnImportance[] | undefined; -} + AuthenticationConfiguration?: AuthenticationConfiguration | undefined; -/** - *Evaluation metrics provide an estimate of the quality of your machine learning transform.
- * @public - */ -export interface EvaluationMetrics { /** - *The type of machine learning transform.
+ *The version of the connection schema for this connection. Version 2 supports properties for specific compute environments.
* @public */ - TransformType: TransformType | undefined; + ConnectionSchemaVersion?: number | undefined; /** - *The evaluation metrics for the find matches algorithm.
+ *A list of compute environments compatible with the connection.
* @public */ - FindMatchesMetrics?: FindMatchesMetrics | undefined; + CompatibleComputeEnvironments?: ComputeEnvironment[] | 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; - +export interface GetConnectionResponse { /** - *The type of data in the column.
+ *The requested connection definition.
* @public */ - DataType?: string | undefined; + Connection?: Connection | undefined; } /** - * @public - * @enum - */ -export const TransformStatusType = { - DELETING: "DELETING", - NOT_READY: "NOT_READY", - READY: "READY", -} as const; - -/** - * @public - */ -export type TransformStatusType = (typeof TransformStatusType)[keyof typeof TransformStatusType]; - -/** + *Filters the connection definitions that are returned by the GetConnections
+ * API operation.
The unique identifier of the transform, generated at the time that the transform was - * created.
+ *A criteria string that must match the criteria recorded in the + * connection definition for that connection definition to be returned.
* @public */ - TransformId?: string | undefined; + MatchCriteria?: string[] | undefined; /** - *The unique name given to the transform when it was created.
+ *The type of connections to return. Currently, SFTP is not supported.
* @public */ - Name?: string | undefined; + ConnectionType?: ConnectionType | undefined; /** - *A description of the transform.
+ *Denotes if the connection was created with schema version 1 or 2.
* @public */ - Description?: string | undefined; + ConnectionSchemaVersion?: number | undefined; +} +/** + * @public + */ +export interface GetConnectionsRequest { /** - *The last known status of the transform (to indicate whether it can be used or not). One of "NOT_READY", "READY", or "DELETING".
+ *The ID of the Data Catalog in which the connections reside. If none is provided, the Amazon Web Services + * account ID is used by default.
* @public */ - Status?: TransformStatusType | undefined; + CatalogId?: string | undefined; /** - *The date and time when the transform was created.
+ *A filter that controls which connections are returned.
* @public */ - CreatedOn?: Date | undefined; + Filter?: GetConnectionsFilter | undefined; /** - *The date and time when the transform was last modified.
+ *Allows you to retrieve the connection metadata without returning the password. For + * instance, the Glue console uses this flag to retrieve the connection, and does not display + * the password. Set this parameter when the caller might not have permission to use the KMS + * key to decrypt the password, but it does have permission to access the rest of the connection + * properties.
* @public */ - LastModifiedOn?: Date | undefined; + HidePassword?: boolean | undefined; /** - *A list of Glue table definitions used by the transform.
+ *A continuation token, if this is a continuation call.
* @public */ - InputRecordTables?: GlueTable[] | undefined; + NextToken?: string | undefined; /** - *The configuration parameters that are specific to the algorithm used.
+ *The maximum number of connections to return in one response.
* @public */ - Parameters?: TransformParameters | undefined; + MaxResults?: number | undefined; +} +/** + * @public + */ +export interface GetConnectionsResponse { /** - *The latest evaluation metrics.
+ *A list of requested connection definitions.
* @public */ - EvaluationMetrics?: EvaluationMetrics | undefined; + ConnectionList?: Connection[] | undefined; /** - *The number of labels available for this transform.
+ *A continuation token, if the list of connections returned does not + * include the last of the filtered connections.
* @public */ - LabelCount?: number | undefined; + NextToken?: string | undefined; +} +/** + * @public + */ +export interface GetCrawlerRequest { /** - *The Map
object that represents the schema that this
- * transform accepts. Has an upper bound of 100 columns.
The name of the crawler to retrieve metadata for.
* @public */ - Schema?: SchemaColumn[] | undefined; + Name: string | undefined; +} +/** + * @public + */ +export interface GetCrawlerResponse { /** - *The name or Amazon Resource Name (ARN) of the IAM role with the required - * permissions.
+ *The metadata for the specified crawler.
* @public */ - Role?: string | undefined; + Crawler?: Crawler | undefined; +} +/** + * @public + */ +export interface GetCrawlerMetricsRequest { /** - *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.
+ *A list of the names of crawlers about which to retrieve metrics.
* @public */ - GlueVersion?: string | undefined; + CrawlerNameList?: 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 maximum size of a list to return.
* @public */ - MaxCapacity?: number | undefined; + MaxResults?: number | undefined; /** - *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.
A continuation token, if this is a continuation call.
* @public */ - WorkerType?: WorkerType | undefined; + NextToken?: string | undefined; +} + +/** + *Metrics for a specified crawler.
+ * @public + */ +export interface CrawlerMetrics { + /** + *The name of the crawler.
+ * @public + */ + CrawlerName?: string | undefined; /** - *The number of workers of a defined workerType
that are allocated when this task runs.
The estimated time left to complete a running crawl.
* @public */ - NumberOfWorkers?: number | undefined; + TimeLeftSeconds?: number | undefined; /** - *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).
True if the crawler is still estimating how long it will take to complete this run.
* @public */ - Timeout?: number | undefined; + StillEstimating?: boolean | undefined; /** - *The maximum number of times to retry a task for this transform after a task run fails.
+ *The duration of the crawler's most recent run, in seconds.
* @public */ - MaxRetries?: number | undefined; + LastRuntimeSeconds?: 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.
+ *The median duration of this crawler's runs, in seconds.
* @public */ - TransformEncryption?: TransformEncryption | undefined; -} + MedianRuntimeSeconds?: number | 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.
+ *The number of tables created by this crawler.
* @public */ - Name?: string | undefined; + TablesCreated?: number | undefined; /** - *The type of machine learning transform that is used to filter the machine learning - * transforms.
+ *The number of tables updated by this crawler.
* @public */ - TransformType?: TransformType | undefined; + TablesUpdated?: number | 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".
+ *The number of tables deleted by this crawler.
* @public */ - Status?: TransformStatusType | undefined; + TablesDeleted?: number | undefined; +} +/** + * @public + */ +export interface GetCrawlerMetricsResponse { /** - *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.
+ *A list of metrics for the specified crawler.
* @public */ - GlueVersion?: string | undefined; + CrawlerMetricsList?: CrawlerMetrics[] | undefined; /** - *The time and date before which the transforms were created.
+ *A continuation token, if the returned list does not contain the + * last metric available.
* @public */ - CreatedBefore?: Date | undefined; + NextToken?: string | undefined; +} +/** + * @public + */ +export interface GetCrawlersRequest { /** - *The time and date after which the transforms were created.
+ *The number of crawlers to return on each call.
* @public */ - CreatedAfter?: Date | undefined; + MaxResults?: number | undefined; /** - *Filter on transforms last modified before this date.
+ *A continuation token, if this is a continuation request.
* @public */ - LastModifiedBefore?: Date | undefined; + NextToken?: string | undefined; +} +/** + * @public + */ +export interface GetCrawlersResponse { /** - *Filter on transforms last modified after this date.
+ *A list of crawler metadata.
* @public */ - LastModifiedAfter?: Date | undefined; + Crawlers?: Crawler[] | 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.
A continuation token, if the returned list has not reached the end + * of those defined in this customer account.
* @public */ - Schema?: SchemaColumn[] | undefined; + NextToken?: string | undefined; } /** * @public - * @enum */ -export const TransformSortColumnType = { - CREATED: "CREATED", - LAST_MODIFIED: "LAST_MODIFIED", - NAME: "NAME", - STATUS: "STATUS", - TRANSFORM_TYPE: "TRANSFORM_TYPE", -} as const; +export interface GetCustomEntityTypeRequest { + /** + *The name of the custom pattern that you want to retrieve.
+ * @public + */ + Name: string | undefined; +} /** * @public */ -export type TransformSortColumnType = (typeof TransformSortColumnType)[keyof typeof TransformSortColumnType]; +export interface GetCustomEntityTypeResponse { + /** + *The name of the custom pattern that you retrieved.
+ * @public + */ + Name?: string | undefined; -/** - *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.
+ *A regular expression string that is used for detecting sensitive data in a custom pattern.
* @public */ - Column: TransformSortColumnType | undefined; + RegexString?: string | undefined; /** - *The sort direction to be used in the sorting criteria that are associated with the machine - * learning transform.
+ *A list of context words if specified when you created the custom pattern. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
* @public */ - SortDirection: SortDirectionType | undefined; + ContextWords?: string[] | undefined; } /** * @public */ -export interface GetMLTransformsRequest { +export interface GetDatabaseRequest { /** - *A paginated token to offset the results.
+ *The ID of the Data Catalog in which the database resides. If none is provided, the Amazon Web Services + * account ID is used by default.
* @public */ - NextToken?: string | undefined; + CatalogId?: string | undefined; /** - *The maximum number of results to return.
+ *The name of the database to retrieve. For Hive compatibility, this + * should be all lowercase.
* @public */ - MaxResults?: number | undefined; + Name: string | undefined; +} +/** + *The Database
object represents a logical grouping of tables that might reside
+ * in a Hive metastore or an RDBMS.
The filter transformation criteria.
+ *The name of the database. For Hive compatibility, this is folded to lowercase when it is + * stored.
* @public */ - Filter?: TransformFilterCriteria | undefined; + Name: string | undefined; /** - *The sorting criteria.
+ *A description of the database.
* @public */ - Sort?: TransformSortCriteria | undefined; -} + Description?: string | 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.
+ *The location of the database (for example, an HDFS path).
* @public */ - TransformId?: string | undefined; + LocationUri?: string | undefined; /** - *A user-defined name for the machine learning transform. Names are not guaranteed unique - * and can be changed at any time.
+ *These key-value pairs define parameters and properties + * of the database.
* @public */ - Name?: string | undefined; + Parameters?: RecordA 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.
+ *The time at which the metadata database was created in the catalog.
* @public */ - Description?: string | undefined; + CreateTime?: Date | undefined; /** - *The current status of the machine learning transform.
+ *Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.
* @public */ - Status?: TransformStatusType | undefined; + CreateTableDefaultPermissions?: PrincipalPermissions[] | undefined; /** - *A timestamp. The time and date that this machine learning transform was created.
+ *A DatabaseIdentifier
structure that describes a target database for resource linking.
A timestamp. The last point in time when this machine learning transform was modified.
+ *The ID of the Data Catalog in which the database resides.
* @public */ - LastModifiedOn?: Date | undefined; + CatalogId?: string | undefined; /** - *A list of Glue table definitions used by the transform.
+ *A FederatedDatabase
structure that references an entity outside the Glue Data Catalog.
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).
The definition of the specified database in the Data Catalog.
* @public */ - Parameters?: TransformParameters | undefined; + Database?: Database | undefined; +} + +/** + * @public + * @enum + */ +export const DatabaseAttributes = { + NAME: "NAME", +} as const; + +/** + * @public + */ +export type DatabaseAttributes = (typeof DatabaseAttributes)[keyof typeof DatabaseAttributes]; + +/** + * @public + * @enum + */ +export const ResourceShareType = { + ALL: "ALL", + FEDERATED: "FEDERATED", + FOREIGN: "FOREIGN", +} as const; + +/** + * @public + */ +export type ResourceShareType = (typeof ResourceShareType)[keyof typeof ResourceShareType]; +/** + * @public + */ +export interface GetDatabasesRequest { /** - *An EvaluationMetrics
object. Evaluation metrics provide an estimate of the quality of your machine learning transform.
The ID of the Data Catalog from which to retrieve Databases
. If none is
+ * provided, the Amazon Web Services account ID is used by default.
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.
+ *A continuation token, if this is a continuation call.
* @public */ - LabelCount?: number | undefined; + NextToken?: string | 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.
+ *The maximum number of databases to return in one response.
* @public */ - Schema?: SchemaColumn[] | undefined; + MaxResults?: number | 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.
+ *Allows you to specify that you want to list the databases shared with your account. The allowable values are FEDERATED
, FOREIGN
or ALL
.
This role needs Glue service role permissions to allow access to resources in Glue. See Attach a Policy to IAM Users That Access Glue.
+ *If set to FEDERATED
, will list the federated databases (referencing an external entity) shared with your account.
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.
+ *If set to FOREIGN
, will list the databases shared with your account.
If set to ALL
, will list the databases shared with your account, as well as the databases in yor local account.
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.
+ *Specifies the database fields returned by the GetDatabases
call. This parameter doesn’t accept an empty list. The request must include the NAME
.
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.
A list of Database
objects from the specified catalog.
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).
A continuation token for paginating the returned list of tokens, + * returned if the current segment of the list is not the last.
* @public */ - NumberOfWorkers?: number | undefined; + NextToken?: string | undefined; +} +/** + * @public + */ +export interface GetDataCatalogEncryptionSettingsRequest { /** - *The timeout in minutes of the machine learning transform.
+ *The ID of the Data Catalog to retrieve the security configuration for. If none is + * provided, the Amazon Web Services account ID is used by default.
* @public */ - Timeout?: number | undefined; + CatalogId?: string | undefined; +} +/** + *The data structure used by the Data Catalog to encrypt the password as part of
+ * CreateConnection
or UpdateConnection
and store it in the
+ * ENCRYPTED_PASSWORD
field in the connection properties. You can enable catalog
+ * encryption or only password encryption.
When a CreationConnection
request arrives containing a password, the Data
+ * Catalog first encrypts the password using your KMS key. It then encrypts the whole
+ * connection object again if catalog encryption is also enabled.
This encryption requires that you set KMS key permissions to enable or restrict access + * on the password key according to your security requirements. For example, you might want only + * administrators to have decrypt permission on the password key.
+ * @public + */ +export interface ConnectionPasswordEncryption { /** - *The maximum number of times to retry after an MLTaskRun
of the machine
- * learning transform fails.
When the ReturnConnectionPasswordEncrypted
flag is set to "true", passwords remain encrypted in the responses of GetConnection
and GetConnections
. This encryption takes effect independently from catalog encryption.
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.
+ *An KMS key that is used to encrypt the connection password.
+ *If connection password protection is enabled, the caller of CreateConnection
+ * and UpdateConnection
needs at least kms:Encrypt
permission on the
+ * specified KMS key, to encrypt passwords before storing them in the Data Catalog.
You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.
* @public */ - TransformEncryption?: TransformEncryption | undefined; + AwsKmsKeyId?: string | undefined; } /** * @public + * @enum */ -export interface GetMLTransformsResponse { +export const CatalogEncryptionMode = { + DISABLED: "DISABLED", + SSEKMS: "SSE-KMS", + SSEKMSWITHSERVICEROLE: "SSE-KMS-WITH-SERVICE-ROLE", +} as const; + +/** + * @public + */ +export type CatalogEncryptionMode = (typeof CatalogEncryptionMode)[keyof typeof CatalogEncryptionMode]; + +/** + *Specifies the encryption-at-rest configuration for the Data Catalog.
+ * @public + */ +export interface EncryptionAtRest { /** - *A list of machine learning transforms.
+ *The encryption-at-rest mode for encrypting Data Catalog data.
* @public */ - Transforms: MLTransform[] | undefined; + CatalogEncryptionMode: CatalogEncryptionMode | undefined; /** - *A pagination token, if more results are available.
+ *The ID of the KMS key to use for encryption at rest.
* @public */ - NextToken?: string | undefined; -} + SseAwsKmsKeyId?: 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.
+ *The role that Glue assumes to encrypt and decrypt the Data Catalog objects on the caller's behalf.
* @public */ - CatalogId?: string | undefined; + CatalogEncryptionServiceRole?: string | undefined; +} +/** + *Contains configuration information for maintaining Data Catalog security.
+ * @public + */ +export interface DataCatalogEncryptionSettings { /** - *The name of the catalog database where the partition resides.
+ *Specifies the encryption-at-rest configuration for the Data Catalog.
* @public */ - DatabaseName: string | undefined; + EncryptionAtRest?: EncryptionAtRest | undefined; /** - *The name of the partition's table.
+ *When connection password protection is enabled, the Data Catalog uses a customer-provided
+ * key to encrypt the password as part of CreateConnection
or
+ * UpdateConnection
and store it in the ENCRYPTED_PASSWORD
field in
+ * the connection properties. You can enable catalog encryption or only password
+ * encryption.
The values that define the partition.
+ *The requested security configuration.
* @public */ - PartitionValues: string[] | undefined; + DataCatalogEncryptionSettings?: DataCatalogEncryptionSettings | undefined; } /** * @public */ -export interface GetPartitionResponse { +export interface GetDataflowGraphRequest { /** - *The requested information, in the form of a Partition
- * object.
The Python script to transform.
* @public */ - Partition?: Partition | undefined; + PythonScript?: string | undefined; } /** * @public */ -export interface GetPartitionIndexesRequest { +export interface GetDataflowGraphResponse { /** - *The catalog ID where the table resides.
+ *A list of the nodes in the resulting DAG.
* @public */ - CatalogId?: string | undefined; + DagNodes?: CodeGenNode[] | undefined; /** - *Specifies the name of a database from which you want to retrieve partition indexes.
+ *A list of the edges in the resulting DAG.
* @public */ - DatabaseName: string | undefined; + DagEdges?: CodeGenEdge[] | undefined; +} +/** + * @public + */ +export interface GetDataQualityModelRequest { /** - *Specifies the name of a table for which you want to retrieve the partition indexes.
+ *The Statistic ID.
* @public */ - TableName: string | undefined; + StatisticId?: string | undefined; /** - *A continuation token, included if this is a continuation call.
+ *The Profile ID.
* @public */ - NextToken?: string | undefined; + ProfileId: string | undefined; } /** * @public * @enum */ -export const BackfillErrorCode = { - ENCRYPTED_PARTITION_ERROR: "ENCRYPTED_PARTITION_ERROR", - INTERNAL_ERROR: "INTERNAL_ERROR", - INVALID_PARTITION_TYPE_DATA_ERROR: "INVALID_PARTITION_TYPE_DATA_ERROR", - MISSING_PARTITION_VALUE_ERROR: "MISSING_PARTITION_VALUE_ERROR", - UNSUPPORTED_PARTITION_CHARACTER_ERROR: "UNSUPPORTED_PARTITION_CHARACTER_ERROR", +export const DataQualityModelStatus = { + FAILED: "FAILED", + RUNNING: "RUNNING", + SUCCEEDED: "SUCCEEDED", } as const; /** * @public */ -export type BackfillErrorCode = (typeof BackfillErrorCode)[keyof typeof BackfillErrorCode]; +export type DataQualityModelStatus = (typeof DataQualityModelStatus)[keyof typeof DataQualityModelStatus]; /** - *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.
+ *The training status of the data quality model.
* @public */ - Code?: BackfillErrorCode | undefined; + Status?: DataQualityModelStatus | undefined; /** - *A list of a limited number of partitions in the response.
+ *The timestamp when the data quality model training started.
* @public */ - Partitions?: PartitionValueList[] | undefined; -} + StartedOn?: Date | undefined; -/** - * @public - * @enum - */ -export const PartitionIndexStatus = { - ACTIVE: "ACTIVE", - CREATING: "CREATING", - DELETING: "DELETING", - FAILED: "FAILED", -} as const; + /** + *The timestamp when the data quality model training completed.
+ * @public + */ + CompletedOn?: Date | undefined; -/** - * @public - */ -export type PartitionIndexStatus = (typeof PartitionIndexStatus)[keyof typeof PartitionIndexStatus]; + /** + *The training failure reason.
+ * @public + */ + FailureReason?: string | undefined; +} /** - *A partition key pair consisting of a name and a type.
* @public */ -export interface KeySchemaElement { +export interface GetDataQualityModelResultRequest { /** - *The name of a partition key.
+ *The Statistic ID.
* @public */ - Name: string | undefined; + StatisticId: string | undefined; /** - *The type of a partition key.
+ *The Profile ID.
* @public */ - Type: string | undefined; + ProfileId: string | undefined; } /** - *A descriptor for a partition index in a table.
+ *The statistic model result.
* @public */ -export interface PartitionIndexDescriptor { +export interface StatisticModelResult { /** - *The name of the partition index.
+ *The lower bound.
* @public */ - IndexName: string | undefined; + LowerBound?: number | undefined; /** - *A list of one or more keys, as KeySchemaElement
structures, for the partition index.
The upper bound.
* @public */ - Keys: KeySchemaElement[] | undefined; + UpperBound?: number | undefined; /** - *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.
- *The predicted value.
* @public */ - IndexStatus: PartitionIndexStatus | undefined; + PredictedValue?: number | undefined; /** - *A list of errors that can occur when registering partition indexes for an existing table.
+ *The actual value.
* @public */ - BackfillErrors?: BackfillError[] | undefined; -} + ActualValue?: number | undefined; -/** - * @public - */ -export interface GetPartitionIndexesResponse { /** - *A list of index descriptors.
+ *The date.
* @public */ - PartitionIndexDescriptorList?: PartitionIndexDescriptor[] | undefined; + Date?: Date | undefined; /** - *A continuation token, present if the current list segment is not the last.
+ *The inclusion annotation.
* @public */ - NextToken?: string | undefined; + InclusionAnnotation?: InclusionAnnotationValue | undefined; } /** - *Defines a non-overlapping region of a table's partitions, allowing - * multiple requests to be run in parallel.
* @public */ -export interface Segment { +export interface GetDataQualityModelResultResponse { /** - *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 timestamp when the data quality model training completed.
* @public */ - SegmentNumber: number | undefined; + CompletedOn?: Date | undefined; /** - *The total number of segments.
+ *A list of StatisticModelResult
+ *
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.
+ *A unique result ID for the data quality result.
* @public */ - CatalogId?: string | undefined; + ResultId: string | undefined; +} +/** + * @public + */ +export interface GetDataQualityResultResponse { /** - *The name of the catalog database where the partitions reside.
+ *A unique result ID for the data quality result.
* @public */ - DatabaseName: string | undefined; + ResultId?: string | undefined; /** - *The name of the partitions' table.
+ *The Profile ID for the data quality result.
* @public */ - TableName: string | undefined; + ProfileId?: 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:
+ *An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.
* @public */ - Expression?: string | undefined; + Score?: number | undefined; /** - *A continuation token, if this is not the first call to retrieve - * these partitions.
+ *The table associated with the data quality result, if any.
* @public */ - NextToken?: string | undefined; + DataSource?: DataSource | undefined; /** - *The segment of the table's partitions to scan in this request.
+ *The name of the ruleset associated with the data quality result.
* @public */ - Segment?: Segment | undefined; + RulesetName?: string | undefined; /** - *The maximum number of partitions to return in a single response.
+ *In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data quality nodes will have names. In the case of multiple nodes, the evaluationContext
can differentiate the nodes.
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.
+ *The date and time when the run for this data quality result started.
* @public */ - ExcludeColumnSchema?: boolean | undefined; + StartedOn?: Date | undefined; /** - *The transaction ID at which to read the partition contents.
+ *The date and time when the run for this data quality result was completed.
* @public */ - TransactionId?: string | undefined; + CompletedOn?: Date | 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
.
The job name associated with the data quality result, if any.
* @public */ - QueryAsOfTime?: Date | undefined; -} + JobName?: string | undefined; -/** - * @public - */ -export interface GetPartitionsResponse { /** - *A list of requested partitions.
+ *The job run ID associated with the data quality result, if any.
* @public */ - Partitions?: Partition[] | undefined; + JobRunId?: string | undefined; /** - *A continuation token, if the returned list of partitions does not include the last - * one.
+ *The unique run ID associated with the ruleset evaluation.
* @public */ - NextToken?: string | undefined; + RulesetEvaluationRunId?: string | undefined; + + /** + *A list of DataQualityRuleResult
objects representing the results for each rule.
A list of DataQualityAnalyzerResult
objects representing the results for each analyzer.
A list of DataQualityObservation
objects representing the observations generated after evaluating the rules and analyzers.
The list of mappings from a source table to target tables.
+ *The unique run identifier associated with this run.
* @public */ - Mapping: MappingEntry[] | undefined; + RunId: string | undefined; +} +/** + * @public + */ +export interface GetDataQualityRuleRecommendationRunResponse { /** - *The source table.
+ *The unique run identifier associated with this run.
* @public */ - Source: CatalogEntry | undefined; + RunId?: string | undefined; /** - *The target tables.
+ *The data source (an Glue table) associated with this run.
* @public */ - Sinks?: CatalogEntry[] | undefined; + DataSource?: DataSource | undefined; /** - *The parameters for the mapping.
+ *An IAM role supplied to encrypt the results of the run.
* @public */ - Location?: Location | undefined; + Role?: string | undefined; /** - *The programming language of the code to perform the mapping.
+ *The number of G.1X
workers to be used in the run. The default is 5.
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"\}'
- *
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 Python script to perform the mapping.
+ *The status for this run.
* @public */ - PythonScript?: string | undefined; + Status?: TaskStatusType | undefined; /** - *The Scala code to perform the mapping.
+ *The error strings that are associated with the run.
* @public */ - ScalaCode?: string | undefined; -} + ErrorString?: string | undefined; -/** - * @public - */ -export interface GetRegistryInput { /** - *This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
+ *The date and time when this run started.
* @public */ - RegistryId: RegistryId | undefined; -} + StartedOn?: Date | undefined; -/** - * @public - */ -export interface GetRegistryResponse { /** - *The name of the registry.
+ *A timestamp. The last point in time when this data quality rule recommendation run was modified.
* @public */ - RegistryName?: string | undefined; + LastModifiedOn?: Date | undefined; /** - *The Amazon Resource Name (ARN) of the registry.
+ *The date and time when this run was completed.
* @public */ - RegistryArn?: string | undefined; + CompletedOn?: Date | undefined; /** - *A description of the registry.
+ *The amount of time (in seconds) that the run consumed resources.
* @public */ - Description?: string | undefined; + ExecutionTime?: number | undefined; /** - *The status of the registry.
+ *When a start rule recommendation run completes, it creates a recommended ruleset (a set of rules). This member has those rules in Data Quality Definition Language (DQDL) format.
* @public */ - Status?: RegistryStatus | undefined; + RecommendedRuleset?: string | undefined; /** - *The date and time the registry was created.
+ *The name of the ruleset that was created by the run.
* @public */ - CreatedTime?: string | undefined; + CreatedRulesetName?: string | undefined; /** - *The date and time the registry was updated.
+ *The name of the security configuration created with the data quality encryption option.
* @public */ - UpdatedTime?: string | undefined; + DataQualitySecurityConfiguration?: string | undefined; } /** * @public */ -export interface GetResourcePoliciesRequest { - /** - *A continuation token, if this is a continuation request.
- * @public - */ - NextToken?: string | undefined; - +export interface GetDataQualityRulesetRequest { /** - *The maximum size of a list to return.
+ *The name of the ruleset.
* @public */ - MaxResults?: number | undefined; + Name: string | undefined; } /** - *A structure for returning a resource policy.
* @public */ -export interface GluePolicy { +export interface GetDataQualityRulesetResponse { /** - *Contains the requested policy document, in JSON format.
+ *The name of the ruleset.
* @public */ - PolicyInJson?: string | undefined; + Name?: string | undefined; /** - *Contains the hash value associated with this policy.
+ *A description of the ruleset.
* @public */ - PolicyHash?: string | undefined; + Description?: string | undefined; /** - *The date and time at which the policy was created.
+ *A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
* @public */ - CreateTime?: Date | undefined; + Ruleset?: string | undefined; /** - *The date and time at which the policy was last updated.
+ *The name and database name of the target table.
* @public */ - UpdateTime?: Date | undefined; -} + TargetTable?: DataQualityTargetTable | undefined; -/** - * @public - */ -export interface GetResourcePoliciesResponse { /** - *A list of the individual resource policies and the account-level resource policy.
+ *A timestamp. The time and date that this data quality ruleset was created.
* @public */ - GetResourcePoliciesResponseList?: GluePolicy[] | undefined; + CreatedOn?: Date | undefined; /** - *A continuation token, if the returned list does not contain the last resource policy available.
+ *A timestamp. The last point in time when this data quality ruleset was modified.
* @public */ - NextToken?: string | undefined; + LastModifiedOn?: Date | 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 name of the security configuration created with the data quality encryption option.
+ * @public + */ + DataQualitySecurityConfiguration?: string | undefined; } /** * @public */ -export interface GetResourcePolicyRequest { +export interface GetDataQualityRulesetEvaluationRunRequest { /** - *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.
- *
The unique run identifier associated with this run.
* @public */ - ResourceArn?: string | undefined; + RunId: string | undefined; } /** * @public + * @enum */ -export interface GetResourcePolicyResponse { - /** - *Contains the requested policy document, in JSON format.
- * @public - */ - PolicyInJson?: string | undefined; +export const DQCompositeRuleEvaluationMethod = { + COLUMN: "COLUMN", + ROW: "ROW", +} as const; - /** - *Contains the hash value associated with this policy.
- * @public - */ - PolicyHash?: string | undefined; +/** + * @public + */ +export type DQCompositeRuleEvaluationMethod = + (typeof DQCompositeRuleEvaluationMethod)[keyof typeof DQCompositeRuleEvaluationMethod]; +/** + *Additional run options you can specify for an evaluation run.
+ * @public + */ +export interface DataQualityEvaluationRunAdditionalRunOptions { /** - *The date and time at which the policy was created.
+ *Whether or not to enable CloudWatch metrics.
* @public */ - CreateTime?: Date | undefined; + CloudWatchMetricsEnabled?: boolean | undefined; /** - *The date and time at which the policy was last updated.
+ *Prefix for Amazon S3 to store results.
* @public */ - UpdateTime?: Date | undefined; -} + ResultsS3Prefix?: string | 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.
Set the evaluation method for composite rules in the ruleset to ROW/COLUMN
* @public */ - SchemaId: SchemaId | undefined; + CompositeRuleEvaluationMethod?: DQCompositeRuleEvaluationMethod | undefined; } /** * @public */ -export interface GetSchemaResponse { +export interface GetDataQualityRulesetEvaluationRunResponse { /** - *The name of the registry.
+ *The unique run identifier associated with this run.
* @public */ - RegistryName?: string | undefined; + RunId?: string | undefined; /** - *The Amazon Resource Name (ARN) of the registry.
+ *The data source (an Glue table) associated with this evaluation run.
* @public */ - RegistryArn?: string | undefined; + DataSource?: DataSource | undefined; /** - *The name of the schema.
+ *An IAM role supplied to encrypt the results of the run.
* @public */ - SchemaName?: string | undefined; + Role?: string | undefined; /** - *The Amazon Resource Name (ARN) of the schema.
+ *The number of G.1X
workers to be used in the run. The default is 5.
A description of schema if specified when created
+ *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).
The data format of the schema definition. Currently AVRO
, JSON
and PROTOBUF
are supported.
Additional run options you can specify for an evaluation run.
* @public */ - DataFormat?: DataFormat | undefined; + AdditionalRunOptions?: DataQualityEvaluationRunAdditionalRunOptions | undefined; /** - *The compatibility mode of the schema.
+ *The status for this run.
* @public */ - Compatibility?: Compatibility | undefined; + Status?: TaskStatusType | undefined; /** - *The version number of the checkpoint (the last time the compatibility mode was changed).
+ *The error strings that are associated with the run.
* @public */ - SchemaCheckpoint?: number | undefined; + ErrorString?: string | undefined; /** - *The latest version of the schema associated with the returned schema definition.
+ *The date and time when this run started.
* @public */ - LatestSchemaVersion?: number | undefined; + StartedOn?: Date | undefined; /** - *The next version of the schema associated with the returned schema definition.
+ *A timestamp. The last point in time when this data quality rule recommendation run was modified.
* @public */ - NextSchemaVersion?: number | undefined; + LastModifiedOn?: Date | undefined; /** - *The status of the schema.
+ *The date and time when this run was completed.
* @public */ - SchemaStatus?: SchemaStatus | undefined; + CompletedOn?: Date | undefined; /** - *The date and time the schema was created.
+ *The amount of time (in seconds) that the run consumed resources.
* @public */ - CreatedTime?: string | undefined; + ExecutionTime?: number | undefined; /** - *The date and time the schema was updated.
+ *A list of ruleset names for the run. Currently, this parameter takes only one Ruleset name.
* @public */ - UpdatedTime?: string | undefined; -} + RulesetNames?: 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.
A list of result IDs for the data quality results for the run.
* @public */ - SchemaId: SchemaId | undefined; + ResultIds?: string[] | undefined; /** - *The definition of the schema for which schema details are required.
+ *A map of reference strings to additional data sources you can specify for an evaluation run.
* @public */ - SchemaDefinition: string | undefined; + AdditionalDataSources?: RecordThe schema ID of the schema version.
- * @public - */ - SchemaVersionId?: string | undefined; - +export interface GetDevEndpointRequest { /** - *The Amazon Resource Name (ARN) of the schema.
+ *Name of the DevEndpoint
to retrieve information for.
The data format of the schema definition. Currently AVRO
, JSON
and PROTOBUF
are supported.
A DevEndpoint
definition.
The status of the schema version.
+ *The maximum size of information to return.
* @public */ - Status?: SchemaVersionStatus | undefined; + MaxResults?: number | undefined; /** - *The date and time the schema was created.
+ *A continuation token, if this is a continuation call.
* @public */ - CreatedTime?: string | undefined; + NextToken?: string | undefined; } /** - *A structure containing the schema version information.
* @public */ -export interface SchemaVersionNumber { +export interface GetDevEndpointsResponse { /** - *The latest version available for the schema.
+ *A list of DevEndpoint
definitions.
The version number of the schema.
+ *A continuation token, if not all DevEndpoint
definitions have yet been
+ * returned.
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 connection that contains the connection type credentials.
* @public */ - SchemaId?: SchemaId | undefined; + ConnectionName?: string | undefined; /** - *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 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 */ - SchemaVersionId?: string | undefined; + CatalogId?: string | undefined; /** - *The version number of the schema.
+ *Name of the entity that we want to query the preview data from the given connection type.
* @public */ - SchemaVersionNumber?: SchemaVersionNumber | undefined; -} + EntityName: string | undefined; -/** - * @public - */ -export interface GetSchemaVersionResponse { /** - *The SchemaVersionId
of the schema version.
A continuation token, included if this is a continuation call.
* @public */ - SchemaVersionId?: string | undefined; + NextToken?: string | undefined; /** - *The schema definition for the schema ID.
+ *The API version of the SaaS connector.
* @public */ - SchemaDefinition?: string | undefined; + DataStoreApiVersion?: string | undefined; /** - *The data format of the schema definition. Currently AVRO
, JSON
and PROTOBUF
are supported.
Connector options that are required to query the data.
* @public */ - DataFormat?: DataFormat | undefined; + ConnectionOptions?: RecordThe Amazon Resource Name (ARN) of the schema.
+ *A filter predicate that you can apply in the query request.
* @public */ - SchemaArn?: string | undefined; + FilterPredicate?: string | undefined; /** - *The version number of the schema.
+ *Limits the number of records fetched with the request.
* @public */ - VersionNumber?: number | undefined; + Limit: number | undefined; /** - *The status of the schema version.
+ *A parameter that orders the response preview data.
* @public */ - Status?: SchemaVersionStatus | undefined; + OrderBy?: string | undefined; /** - *The date and time the schema version was created.
+ *List of fields that we want to fetch as part of preview data.
* @public */ - CreatedTime?: string | undefined; + SelectedFields?: string[] | undefined; } /** * @public - * @enum */ -export const SchemaDiffType = { - SYNTAX_DIFF: "SYNTAX_DIFF", -} as const; +export interface GetEntityRecordsResponse { + /** + *A list of the requested objects.
+ * @public + */ + Records?: __DocumentType[] | undefined; -/** - * @public - */ -export type SchemaDiffType = (typeof SchemaDiffType)[keyof typeof SchemaDiffType]; + /** + *A continuation token, present if the current segment is not the last.
+ * @public + */ + NextToken?: string | undefined; +} /** * @public */ -export interface GetSchemaVersionsDiffInput { +export interface GetIntegrationResourcePropertyRequest { /** - *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 connection ARN of the source, or the database ARN of the target.
* @public */ - SchemaId: SchemaId | undefined; + ResourceArn: string | undefined; +} +/** + * @public + */ +export interface GetIntegrationResourcePropertyResponse { /** - *The first of the two schema versions to be compared.
+ *The connection ARN of the source, or the database ARN of the target.
* @public */ - FirstSchemaVersionNumber: SchemaVersionNumber | undefined; + ResourceArn?: string | undefined; /** - *The second of the two schema versions to be compared.
+ *The resource properties associated with the integration source.
* @public */ - SecondSchemaVersionNumber: SchemaVersionNumber | undefined; + SourceProcessingProperties?: SourceProcessingProperties | undefined; /** - *Refers to SYNTAX_DIFF
, which is the currently supported diff type.
The resource properties associated with the integration target.
* @public */ - SchemaDiffType: SchemaDiffType | undefined; + TargetProcessingProperties?: TargetProcessingProperties | undefined; } /** * @public */ -export interface GetSchemaVersionsDiffResponse { +export interface GetIntegrationTablePropertiesRequest { /** - *The difference between schemas as a string in JsonPatch format.
+ *The connection ARN of the source, or the database ARN of the target.
* @public */ - Diff?: string | undefined; + ResourceArn: string | undefined; + + /** + *The name of the table to be replicated.
+ * @public + */ + TableName: string | undefined; } /** * @public */ -export interface GetSecurityConfigurationRequest { +export interface GetIntegrationTablePropertiesResponse { /** - *The name of the security configuration to retrieve.
+ *The connection ARN of the source, or the database ARN of the target.
* @public */ - Name: string | undefined; -} + ResourceArn?: string | undefined; -/** - *Specifies a security configuration.
- * @public - */ -export interface SecurityConfiguration { /** - *The name of the security configuration.
+ *The name of the table to be replicated.
* @public */ - Name?: string | undefined; + TableName?: string | undefined; /** - *The time at which this security configuration was created.
+ *A structure for the source table configuration.
* @public */ - CreatedTimeStamp?: Date | undefined; + SourceTableConfig?: SourceTableConfig | undefined; /** - *The encryption configuration associated with this security configuration.
+ *A structure for the target table configuration.
* @public */ - EncryptionConfiguration?: EncryptionConfiguration | undefined; + TargetTableConfig?: TargetTableConfig | undefined; } /** * @public */ -export interface GetSecurityConfigurationResponse { +export interface GetJobRequest { /** - *The requested security configuration.
+ *The name of the job definition to retrieve.
* @public */ - SecurityConfiguration?: SecurityConfiguration | undefined; + JobName: string | undefined; } /** * @public */ -export interface GetSecurityConfigurationsRequest { +export interface GetJobBookmarkRequest { /** - *The maximum number of results to return.
+ *The name of the job in question.
* @public */ - MaxResults?: number | undefined; + JobName: string | undefined; /** - *A continuation token, if this is a continuation call.
+ *The unique run identifier associated with this job run.
* @public */ - NextToken?: string | undefined; + RunId?: string | undefined; } /** + *Defines a point that a job can resume processing.
* @public */ -export interface GetSecurityConfigurationsResponse { +export interface JobBookmarkEntry { /** - *A list of security configurations.
+ *The name of the job in question.
* @public */ - SecurityConfigurations?: SecurityConfiguration[] | undefined; + JobName?: string | undefined; /** - *A continuation token, if there are more security - * configurations to return.
+ *The version of the job.
* @public */ - NextToken?: string | undefined; -} + Version?: number | undefined; -/** - * @public - */ -export interface GetSessionRequest { /** - *The ID of the session.
+ *The run ID number.
* @public */ - Id: string | undefined; + Run?: number | undefined; /** - *The origin of the request.
+ *The attempt ID number.
* @public */ - RequestOrigin?: string | undefined; + Attempt?: number | undefined; + + /** + *The unique run identifier associated with the previous job run.
+ * @public + */ + PreviousRunId?: string | undefined; + + /** + *The run ID number.
+ * @public + */ + RunId?: string | undefined; + + /** + *The bookmark itself.
+ * @public + */ + JobBookmark?: string | undefined; } /** * @public */ -export interface GetSessionResponse { +export interface GetJobBookmarkResponse { /** - *The session object is returned in the response.
+ *A structure that defines a point that a job can resume processing.
* @public */ - Session?: Session | undefined; + JobBookmarkEntry?: JobBookmarkEntry | undefined; } /** * @public */ -export interface GetStatementRequest { +export interface GetJobRunRequest { /** - *The Session ID of the statement.
+ *Name of the job definition being run.
* @public */ - SessionId: string | undefined; + JobName: string | undefined; /** - *The Id of the statement.
+ *The ID of the job run.
* @public */ - Id: number | undefined; + RunId: string | undefined; /** - *The origin of the request.
+ *True if a list of predecessor runs should be returned.
* @public */ - RequestOrigin?: string | undefined; + PredecessorsIncluded?: boolean | undefined; } /** - *The code execution output in JSON format.
* @public */ -export interface StatementOutputData { +export interface GetJobRunResponse { /** - *The code execution output in text format.
+ *The requested job-run metadata.
* @public */ - TextPlain?: string | undefined; + JobRun?: JobRun | undefined; } -/** - * @public - * @enum - */ -export const StatementState = { - AVAILABLE: "AVAILABLE", - CANCELLED: "CANCELLED", - CANCELLING: "CANCELLING", - ERROR: "ERROR", - RUNNING: "RUNNING", - WAITING: "WAITING", -} as const; - /** * @public */ -export type StatementState = (typeof StatementState)[keyof typeof StatementState]; +export interface GetJobRunsRequest { + /** + *The name of the job definition for which to retrieve all job runs.
+ * @public + */ + JobName: string | undefined; -/** - *The code execution output in JSON format.
- * @public - */ -export interface StatementOutput { /** - *The code execution output.
+ *A continuation token, if this is a continuation call.
* @public */ - Data?: StatementOutputData | undefined; + NextToken?: string | undefined; /** - *The execution count of the output.
+ *The maximum size of the response.
* @public */ - ExecutionCount?: number | undefined; + MaxResults?: number | undefined; +} +/** + * @public + */ +export interface GetJobRunsResponse { /** - *The status of the code execution output.
+ *A list of job-run metadata objects.
* @public */ - Status?: StatementState | undefined; + JobRuns?: JobRun[] | undefined; /** - *The name of the error in the output.
+ *A continuation token, if not all requested job runs have been returned.
* @public */ - ErrorName?: string | undefined; + NextToken?: string | undefined; +} +/** + * @public + */ +export interface GetJobsRequest { /** - *The error value of the output.
+ *A continuation token, if this is a continuation call.
* @public */ - ErrorValue?: string | undefined; + NextToken?: string | undefined; /** - *The traceback of the output.
+ *The maximum size of the response.
* @public */ - Traceback?: string[] | undefined; + MaxResults?: number | undefined; } /** - *The statement or request for a particular action to occur in a session.
+ *The location of resources.
* @public */ -export interface Statement { +export interface Location { /** - *The ID of the statement.
+ *A JDBC location.
* @public */ - Id?: number | undefined; + Jdbc?: CodeGenNodeArg[] | undefined; /** - *The execution code of the statement.
+ *An Amazon Simple Storage Service (Amazon S3) location.
* @public */ - Code?: string | undefined; + S3?: CodeGenNodeArg[] | undefined; /** - *The state while request is actioned.
+ *An Amazon DynamoDB table location.
* @public */ - State?: StatementState | undefined; + DynamoDB?: CodeGenNodeArg[] | undefined; +} +/** + *Specifies a table definition in the Glue Data Catalog.
+ * @public + */ +export interface CatalogEntry { /** - *The output in JSON.
+ *The database in which the table metadata resides.
* @public */ - Output?: StatementOutput | undefined; + DatabaseName: string | undefined; /** - *The code execution progress.
+ *The name of the table in question.
* @public */ - Progress?: number | undefined; + TableName: string | undefined; +} +/** + * @public + */ +export interface GetMappingRequest { /** - *The unix time and date that the job definition was started.
+ *Specifies the source table.
* @public */ - StartedOn?: number | undefined; + Source: CatalogEntry | undefined; /** - *The unix time and date that the job definition was completed.
+ *A list of target tables.
* @public */ - CompletedOn?: number | undefined; -} + Sinks?: CatalogEntry[] | undefined; -/** - * @public - */ -export interface GetStatementResponse { /** - *Returns the statement.
+ *Parameters for the mapping.
* @public */ - Statement?: Statement | undefined; + Location?: Location | undefined; } /** + *Defines a mapping.
* @public */ -export interface GetTableRequest { +export interface MappingEntry { /** - *The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account - * ID is used by default.
+ *The name of the source table.
* @public */ - CatalogId?: string | undefined; + SourceTable?: string | undefined; /** - *The name of the database in the catalog in which the table resides. - * For Hive compatibility, this name is entirely lowercase.
+ *The source path.
* @public */ - DatabaseName: string | undefined; + SourcePath?: string | undefined; /** - *The name of the table for which to retrieve the definition. For Hive - * compatibility, this name is entirely lowercase.
+ *The source type.
* @public */ - Name: string | undefined; + SourceType?: string | undefined; /** - *The transaction ID at which to read the table contents.
+ *The target table.
* @public */ - TransactionId?: string | undefined; + TargetTable?: 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
.
The target path.
* @public */ - QueryAsOfTime?: Date | undefined; + TargetPath?: string | undefined; /** - *Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.
+ *The target type.
* @public */ - IncludeStatusDetails?: boolean | undefined; + TargetType?: string | undefined; } /** - *A table that points to an entity outside the Glue Data Catalog.
* @public */ -export interface FederatedTable { +export interface GetMappingResponse { /** - *A unique identifier for the federated table.
+ *A list of mappings to the specified targets.
* @public */ - Identifier?: string | undefined; + Mapping: MappingEntry[] | undefined; +} +/** + * @public + */ +export interface GetMLTaskRunRequest { /** - *A unique identifier for the federated database.
+ *The unique identifier of the machine learning transform.
* @public */ - DatabaseIdentifier?: string | undefined; + TransformId: string | undefined; /** - *The name of the connection to the external metastore.
+ *The unique identifier of the task run.
* @public */ - ConnectionName?: string | undefined; + TaskRunId: string | undefined; } /** - * @public - * @enum - */ -export const ResourceAction = { - CREATE: "CREATE", - UPDATE: "UPDATE", -} as const; - -/** - * @public - */ -export type ResourceAction = (typeof ResourceAction)[keyof typeof ResourceAction]; - -/** - * @public - * @enum - */ -export const ResourceState = { - FAILED: "FAILED", - IN_PROGRESS: "IN_PROGRESS", - QUEUED: "QUEUED", - STOPPED: "STOPPED", - SUCCESS: "SUCCESS", -} as const; - -/** + *Specifies configuration properties for an exporting labels task run.
* @public */ -export type ResourceState = (typeof ResourceState)[keyof typeof ResourceState]; +export interface ExportLabelsTaskRunProperties { + /** + *The Amazon Simple Storage Service (Amazon S3) path where you will export the + * labels.
+ * @public + */ + OutputS3Path?: 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.
Specifies configuration properties for a Find Matches task run.
* @public */ -export interface ViewValidation { +export interface FindMatchesTaskRunProperties { /** - *The dialect of the query engine.
+ *The job ID for the Find Matches task run.
* @public */ - Dialect?: ViewDialect | undefined; + JobId?: string | undefined; /** - *The version of the dialect of the query engine. For example, 3.0.0.
+ *The name assigned to the job for the Find Matches task run.
* @public */ - DialectVersion?: string | undefined; + JobName?: string | undefined; /** - *The SELECT
query that defines the view, as provided by the customer.
The job run ID for the Find Matches task run.
* @public */ - ViewValidationText?: string | undefined; + JobRunId?: string | undefined; +} +/** + *Specifies configuration properties for an importing labels task run.
+ * @public + */ +export interface ImportLabelsTaskRunProperties { /** - *The time of the last update.
+ *The Amazon Simple Storage Service (Amazon S3) path from where you will import the + * labels.
* @public */ - UpdateTime?: Date | undefined; + InputS3Path?: string | undefined; /** - *The state of the validation.
+ *Indicates whether to overwrite your existing labels.
* @public */ - State?: ResourceState | undefined; + Replace?: boolean | undefined; +} +/** + *Specifies configuration properties for a labeling set generation task run.
+ * @public + */ +export interface LabelingSetGenerationTaskRunProperties { /** - *An error associated with the validation.
+ *The Amazon Simple Storage Service (Amazon S3) path where you will generate the labeling + * set.
* @public */ - Error?: ErrorDetail | undefined; + OutputS3Path?: string | undefined; } /** - *A structure that contains the dialect of the view, and the query that defines the view.
* @public + * @enum */ -export interface ViewRepresentation { - /** - *The dialect of the query engine.
- * @public - */ - Dialect?: ViewDialect | undefined; +export const TaskType = { + EVALUATION: "EVALUATION", + EXPORT_LABELS: "EXPORT_LABELS", + FIND_MATCHES: "FIND_MATCHES", + IMPORT_LABELS: "IMPORT_LABELS", + LABELING_SET_GENERATION: "LABELING_SET_GENERATION", +} as const; + +/** + * @public + */ +export type TaskType = (typeof TaskType)[keyof typeof TaskType]; +/** + *The configuration properties for the task run.
+ * @public + */ +export interface TaskRunProperties { /** - *The version of the dialect of the query engine. For example, 3.0.0.
+ *The type of task run.
* @public */ - DialectVersion?: string | undefined; + TaskType?: TaskType | 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 configuration properties for an importing labels task run.
* @public */ - ViewOriginalText?: string | undefined; + ImportLabelsTaskRunProperties?: ImportLabelsTaskRunProperties | undefined; /** - *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 configuration properties for an exporting labels task run.
* @public */ - ViewExpandedText?: string | undefined; + ExportLabelsTaskRunProperties?: ExportLabelsTaskRunProperties | undefined; /** - *The name of the connection to be used to validate the specific representation of the view.
+ *The configuration properties for a labeling set generation task run.
* @public */ - ValidationConnection?: string | undefined; + LabelingSetGenerationTaskRunProperties?: LabelingSetGenerationTaskRunProperties | undefined; /** - *Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.
+ *The configuration properties for a find matches task run.
* @public */ - IsStale?: boolean | undefined; + FindMatchesTaskRunProperties?: FindMatchesTaskRunProperties | undefined; } /** - *A structure containing details for representations.
* @public */ -export interface ViewDefinition { +export interface GetMLTaskRunResponse { /** - *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.
+ *The unique identifier of the task run.
* @public */ - IsProtected?: boolean | undefined; + TransformId?: string | undefined; /** - *The definer of a view in SQL.
+ *The unique run identifier associated with this run.
* @public */ - Definer?: string | undefined; + TaskRunId?: string | undefined; /** - *A list of table Amazon Resource Names (ARNs).
+ *The status for this task run.
* @public */ - SubObjects?: string[] | undefined; + Status?: TaskStatusType | undefined; /** - *A list of representations.
+ *The names of the log groups that are associated with the task run.
* @public */ - Representations?: ViewRepresentation[] | undefined; -} + LogGroupName?: string | undefined; -/** - * @public - */ -export interface GetTableOptimizerRequest { /** - *The Catalog ID of the table.
+ *The list of properties that are associated with the task run.
* @public */ - CatalogId: string | undefined; + Properties?: TaskRunProperties | undefined; /** - *The name of the database in the catalog in which the table resides.
+ *The error strings that are associated with the task run.
* @public */ - DatabaseName: string | undefined; + ErrorString?: string | undefined; /** - *The name of the table.
+ *The date and time when this task run started.
* @public */ - TableName: string | undefined; + StartedOn?: Date | undefined; /** - *The type of table optimizer.
+ *The date and time when this task run was last modified.
* @public */ - Type: TableOptimizerType | undefined; + 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 GetTableOptimizerResponse { +export interface TaskRunFilterCriteria { /** - *The Catalog ID of the table.
+ *The type of task run.
* @public */ - CatalogId?: string | undefined; + TaskRunType?: TaskType | undefined; /** - *The name of the database in the catalog in which the table resides.
+ *The current status of the task run.
* @public */ - DatabaseName?: string | undefined; + Status?: TaskStatusType | undefined; /** - *The name of the table.
+ *Filter on task runs started before this date.
* @public */ - TableName?: string | undefined; + StartedBefore?: Date | undefined; /** - *The optimizer associated with the specified table.
+ *Filter on task runs started after this date.
* @public */ - TableOptimizer?: TableOptimizer | undefined; + StartedAfter?: Date | undefined; } /** * @public * @enum */ -export const TableAttributes = { - NAME: "NAME", - TABLE_TYPE: "TABLE_TYPE", +export const TaskRunSortColumnType = { + STARTED: "STARTED", + STATUS: "STATUS", + TASK_RUN_TYPE: "TASK_RUN_TYPE", } as const; /** * @public */ -export type TableAttributes = (typeof TableAttributes)[keyof typeof TableAttributes]; +export type TaskRunSortColumnType = (typeof TaskRunSortColumnType)[keyof typeof TaskRunSortColumnType]; /** * @public + * @enum */ -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; +export const SortDirectionType = { + ASCENDING: "ASCENDING", + DESCENDING: "DESCENDING", +} as const; - /** - *The database in the catalog whose tables to list. For Hive - * compatibility, this name is entirely lowercase.
- * @public - */ - DatabaseName: string | undefined; +/** + * @public + */ +export type SortDirectionType = (typeof SortDirectionType)[keyof typeof SortDirectionType]; +/** + *The sorting criteria that are used to sort the list of task runs for the machine learning + * transform.
+ * @public + */ +export interface TaskRunSortCriteria { /** - *A regular expression pattern. If present, only those tables - * whose names match the pattern are returned.
+ *The column to be used to sort the list of task runs for the machine learning + * transform.
* @public */ - Expression?: string | undefined; + Column: TaskRunSortColumnType | undefined; /** - *A continuation token, included if this is a continuation call.
+ *The sort direction to be used to sort the list of task runs for the machine learning + * transform.
* @public */ - NextToken?: string | undefined; + SortDirection: SortDirectionType | undefined; +} +/** + * @public + */ +export interface GetMLTaskRunsRequest { /** - *The maximum number of tables to return in a single response.
+ *The unique identifier of the machine learning transform.
* @public */ - MaxResults?: number | undefined; + TransformId: string | undefined; /** - *The transaction ID at which to read the table contents.
+ *A token for pagination of the results. The default is empty.
* @public */ - TransactionId?: string | undefined; + NextToken?: 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
.
The maximum number of results to return.
* @public */ - QueryAsOfTime?: Date | undefined; + MaxResults?: number | undefined; /** - *Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.
+ *The filter criteria, in the TaskRunFilterCriteria
structure, for the task run.
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 sorting criteria, in the TaskRunSortCriteria
structure, for the task run.
The sampling parameters that are associated with the machine learning transform.
* @public */ -export interface GetTableVersionRequest { +export interface TaskRun { /** - *The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account - * ID is used by default.
+ *The unique identifier for the transform.
* @public */ - CatalogId?: string | undefined; + TransformId?: string | undefined; /** - *The database in the catalog in which the table resides. For Hive - * compatibility, this name is entirely lowercase.
+ *The unique identifier for this task run.
* @public */ - DatabaseName: string | undefined; + TaskRunId?: string | undefined; /** - *The name of the table. For Hive compatibility, - * this name is entirely lowercase.
+ *The current status of the requested task run.
* @public */ - TableName: string | undefined; + Status?: TaskStatusType | 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.
The names of the log group for secure logging, associated with this task run.
* @public */ - VersionId?: string | undefined; -} + LogGroupName?: string | 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.
+ *Specifies configuration properties associated with this task run.
* @public */ - CatalogId?: string | undefined; + Properties?: TaskRunProperties | undefined; /** - *The database in the catalog in which the table resides. For Hive - * compatibility, this name is entirely lowercase.
+ *The list of error strings associated with this task run.
* @public */ - DatabaseName: string | undefined; + ErrorString?: string | undefined; /** - *The name of the table. For Hive - * compatibility, this name is entirely lowercase.
+ *The date and time that this task run started.
* @public */ - TableName: string | undefined; + StartedOn?: Date | undefined; /** - *A continuation token, if this is not the first call.
+ *The last point in time that the requested task run was updated.
* @public */ - NextToken?: string | undefined; + LastModifiedOn?: Date | undefined; /** - *The maximum number of table versions to return in one response.
+ *The last point in time that the requested task run was completed.
* @public */ - MaxResults?: number | undefined; -} + CompletedOn?: Date | undefined; -/** - * @public - */ -export interface GetTagsRequest { /** - *The Amazon Resource Name (ARN) of the resource for which to retrieve tags.
+ *The amount of time (in seconds) that the task run consumed resources.
* @public */ - ResourceArn: string | undefined; + ExecutionTime?: number | undefined; } /** * @public */ -export interface GetTagsResponse { +export interface GetMLTaskRunsResponse { /** - *The requested tags.
+ *A list of task runs that are associated with the transform.
* @public */ - Tags?: RecordA pagination token, if more results are available.
+ * @public + */ + NextToken?: string | undefined; } /** * @public */ -export interface GetTriggerRequest { +export interface GetMLTransformRequest { /** - *The name of the trigger to retrieve.
+ *The unique identifier of the transform, generated at the time that the transform was + * created.
* @public */ - Name: string | undefined; + 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 GetTriggerResponse { +export interface ColumnImportance { /** - *The requested trigger definition.
+ *The name of a column.
* @public */ - Trigger?: Trigger | undefined; + 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 GetTriggersRequest { +export interface ConfusionMatrix { /** - *A continuation token, if this is a continuation call.
+ *The number of matches in the data that the transform correctly found, in the confusion matrix for your transform.
* @public */ - NextToken?: string | undefined; + NumTruePositives?: number | 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.
+ *The number of nonmatches in the data that the transform incorrectly classified as a match, + * in the confusion matrix for your transform.
* @public */ - DependentJobName?: string | undefined; + NumFalsePositives?: number | undefined; /** - *The maximum size of the response.
+ *The number of nonmatches in the data that the transform correctly rejected, in the + * confusion matrix for your transform.
* @public */ - MaxResults?: number | undefined; + 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 GetTriggersResponse { +export interface FindMatchesMetrics { /** - *A list of triggers for the specified job.
+ *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 */ - Triggers?: Trigger[] | undefined; + AreaUnderPRCurve?: number | undefined; /** - *A continuation token, if not all the requested triggers - * have yet been returned.
+ *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 */ - NextToken?: string | undefined; -} + Precision?: 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 - */ -export interface QuerySessionContext { /** - *A unique identifier generated by the query engine for the query.
+ *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 */ - QueryId?: string | undefined; + Recall?: number | undefined; /** - *A timestamp provided by the query engine for when the query started.
+ *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 */ - QueryStartTime?: Date | undefined; + F1?: number | undefined; /** - *An identifier string for the consumer cluster.
+ *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 */ - ClusterId?: string | undefined; + ConfusionMatrix?: ConfusionMatrix | undefined; /** - *A cryptographically generated query identifier generated by Glue or Lake Formation.
+ *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 { /** - *An opaque string-string map passed by the query engine.
+ *The type of machine learning transform.
* @public */ - AdditionalContext?: RecordThe 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 * @enum */ -export const PermissionType = { - CELL_FILTER_PERMISSION: "CELL_FILTER_PERMISSION", - COLUMN_PERMISSION: "COLUMN_PERMISSION", - NESTED_CELL_PERMISSION: "NESTED_CELL_PERMISSION", - NESTED_PERMISSION: "NESTED_PERMISSION", +export const TransformStatusType = { + DELETING: "DELETING", + NOT_READY: "NOT_READY", + READY: "READY", } as const; /** * @public */ -export type PermissionType = (typeof PermissionType)[keyof typeof PermissionType]; +export type TransformStatusType = (typeof TransformStatusType)[keyof typeof TransformStatusType]; /** * @public */ -export interface GetUnfilteredPartitionMetadataRequest { +export interface GetMLTransformResponse { /** - *Specified only if the base tables belong to a different Amazon Web Services Region.
+ *The unique identifier of the transform, generated at the time that the transform was + * created.
* @public */ - Region?: string | undefined; + TransformId?: string | undefined; /** - *The catalog ID where the partition resides.
+ *The unique name given to the transform when it was created.
* @public */ - CatalogId: string | undefined; + Name?: string | undefined; /** - *(Required) Specifies the name of a database that contains the partition.
+ *A description of the transform.
* @public */ - DatabaseName: string | undefined; + Description?: string | undefined; /** - *(Required) Specifies the name of a table that contains the partition.
+ *The last known status of the transform (to indicate whether it can be used or not). One of "NOT_READY", "READY", or "DELETING".
* @public */ - TableName: string | undefined; + Status?: TransformStatusType | undefined; /** - *(Required) A list of partition key values.
+ *The date and time when the transform was created.
* @public */ - PartitionValues: string[] | undefined; + CreatedOn?: Date | undefined; /** - *A structure containing Lake Formation audit context information.
+ *The date and time when the transform was last modified.
* @public */ - AuditContext?: AuditContext | undefined; + LastModifiedOn?: Date | undefined; /** - *(Required) A list of supported permission types.
+ *A list of Glue table definitions used by the transform.
* @public */ - SupportedPermissionTypes: PermissionType[] | undefined; + InputRecordTables?: GlueTable[] | 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.
+ *The configuration parameters that are specific to the algorithm used.
* @public */ - QuerySessionContext?: QuerySessionContext | undefined; -} + Parameters?: TransformParameters | undefined; -/** - * @public - */ -export interface GetUnfilteredPartitionMetadataResponse { /** - *A Partition object containing the partition metadata.
+ *The latest evaluation metrics.
* @public */ - Partition?: Partition | undefined; + EvaluationMetrics?: EvaluationMetrics | undefined; /** - *A list of column names that the user has been granted access to.
+ *The number of labels available for this transform.
* @public */ - AuthorizedColumns?: string[] | undefined; + LabelCount?: number | undefined; /** - *A Boolean value that indicates whether the partition location is registered - * with Lake Formation.
+ *The Map
object that represents the schema that this
+ * transform accepts. Has an upper bound of 100 columns.
The operation timed out.
- * @public - */ -export class PermissionTypeMismatchException extends __BaseException { - readonly name: "PermissionTypeMismatchException" = "PermissionTypeMismatchException"; - readonly $fault: "client" = "client"; /** - *There is a mismatch between the SupportedPermissionType used in the query request - * and the permissions defined on the target table.
+ *The name or Amazon Resource Name (ARN) of the IAM role with the required + * permissions.
* @public */ - Message?: string | undefined; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeSpecified only if the base tables belong to a different Amazon Web Services Region.
+ *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 */ - Region?: string | undefined; + GlueVersion?: 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.
+ *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 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; + MaxCapacity?: number | 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.
+ *The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
*
- * string
- *
- * date
- *
- * timestamp
- *
- * int
- *
- * bigint
- *
- * long
- *
- * tinyint
- *
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
- * smallint
- *
For the G.1X
worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
- * decimal
- *
For the G.2X
worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
If an type is encountered that is not valid, an exception is thrown.
* @public */ - Expression?: string | undefined; + WorkerType?: WorkerType | undefined; /** - *A structure containing Lake Formation audit context information.
+ *The number of workers of a defined workerType
that are allocated when this task runs.
A list of supported permission types.
+ *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).
A continuation token, if this is not the first call to retrieve - * these partitions.
+ *The maximum number of times to retry a task for this transform after a task run fails.
* @public */ - NextToken?: string | undefined; + MaxRetries?: number | undefined; /** - *The segment of the table's partitions to scan in this request.
+ *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 */ - Segment?: Segment | undefined; + TransformEncryption?: TransformEncryption | undefined; +} +/** + *The criteria used to filter the machine learning transforms.
+ * @public + */ +export interface TransformFilterCriteria { /** - *The maximum number of partitions to return in a single response.
+ *A unique transform name that is used to filter the machine learning transforms.
* @public */ - MaxResults?: number | undefined; + Name?: string | 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.
+ *The type of machine learning transform that is used to filter the machine learning + * transforms.
* @public */ - QuerySessionContext?: QuerySessionContext | undefined; -} + TransformType?: TransformType | undefined; -/** - *A partition that contains unfiltered metadata.
- * @public - */ -export interface UnfilteredPartition { /** - *The partition object.
+ *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 */ - Partition?: Partition | undefined; + Status?: TransformStatusType | undefined; /** - *The list of columns the user has permissions to access.
+ *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 */ - AuthorizedColumns?: string[] | undefined; + GlueVersion?: string | undefined; /** - *A Boolean value indicating that the partition location is registered with Lake Formation.
+ *The time and date before which the transforms were created.
* @public */ - IsRegisteredWithLakeFormation?: boolean | undefined; -} + CreatedBefore?: Date | undefined; -/** - * @public - */ -export interface GetUnfilteredPartitionsMetadataResponse { /** - *A list of requested partitions.
+ *The time and date after which the transforms were created.
* @public */ - UnfilteredPartitions?: UnfilteredPartition[] | undefined; + CreatedAfter?: Date | undefined; /** - *A continuation token, if the returned list of partitions does not include the last - * one.
+ *Filter on transforms last modified before this date.
* @public */ - NextToken?: string | undefined; + 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.
A structure specifying the dialect and dialect version used by the query engine.
* @public + * @enum */ -export interface SupportedDialect { +export const TransformSortColumnType = { + CREATED: "CREATED", + LAST_MODIFIED: "LAST_MODIFIED", + NAME: "NAME", + STATUS: "STATUS", + TRANSFORM_TYPE: "TRANSFORM_TYPE", +} as const; + +/** + * @public + */ +export type TransformSortColumnType = (typeof TransformSortColumnType)[keyof typeof TransformSortColumnType]; + +/** + *The sorting criteria that are associated with the machine learning transform.
+ * @public + */ +export interface TransformSortCriteria { /** - *The dialect of the query engine.
+ *The column to be used in the sorting criteria that are associated with the machine + * learning transform.
* @public */ - Dialect?: ViewDialect | undefined; + Column: TransformSortColumnType | undefined; /** - *The version of the dialect of the query engine. For example, 3.0.0.
+ *The sort direction to be used in the sorting criteria that are associated with the machine + * learning transform.
* @public */ - DialectVersion?: string | undefined; + SortDirection: SortDirectionType | undefined; } /** * @public */ -export interface GetUnfilteredTableMetadataRequest { +export interface GetMLTransformsRequest { /** - *Specified only if the base tables belong to a different Amazon Web Services Region.
+ *A paginated token to offset the results.
* @public */ - Region?: string | undefined; + NextToken?: string | undefined; /** - *The catalog ID where the table resides.
+ *The maximum number of results to return.
* @public */ - CatalogId: string | undefined; + MaxResults?: number | undefined; /** - *(Required) Specifies the name of a database that contains the table.
+ *The filter transformation criteria.
* @public */ - DatabaseName: string | undefined; + Filter?: TransformFilterCriteria | undefined; /** - *(Required) Specifies the name of a table for which you are requesting metadata.
+ *The sorting criteria.
* @public */ - Name: string | undefined; + Sort?: TransformSortCriteria | undefined; +} +/** + *A structure for a machine learning transform.
+ * @public + */ +export interface MLTransform { /** - *A structure containing Lake Formation audit context information.
+ *The unique transform ID that is generated for the machine learning transform. The ID is + * guaranteed to be unique and does not change.
* @public */ - AuditContext?: AuditContext | undefined; + TransformId?: string | 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.
+ *A user-defined name for the machine learning transform. Names are not guaranteed unique + * and can be changed at any time.
* @public */ - ParentResourceArn?: string | undefined; + Name?: string | undefined; /** - *The resource ARN of the root view in a chain of nested views.
+ *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 */ - RootResourceArn?: string | undefined; + Description?: string | undefined; /** - *A structure specifying the dialect and dialect version used by the query engine.
+ *The current status of the machine learning transform.
* @public */ - SupportedDialect?: SupportedDialect | undefined; + Status?: TransformStatusType | undefined; /** - *The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.
+ *A timestamp. The time and date that this machine learning transform was created.
* @public */ - Permissions?: Permission[] | undefined; + CreatedOn?: Date | 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.
+ *A timestamp. The last point in time when this machine learning transform was modified.
* @public */ - QuerySessionContext?: QuerySessionContext | undefined; -} + LastModifiedOn?: Date | undefined; -/** - *A filter that uses both column-level and row-level filtering.
- * @public - */ -export interface ColumnRowFilter { /** - *A string containing the name of the column.
+ *A list of Glue table definitions used by the transform.
* @public */ - ColumnName?: string | undefined; + InputRecordTables?: GlueTable[] | undefined; /** - *A string containing the row-level filter expression.
+ *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).
The name of the usage profile to retrieve.
+ *An EvaluationMetrics
object. Evaluation metrics provide an estimate of the quality of your machine learning transform.
The name of the usage profile.
+ *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 */ - Name?: string | undefined; + LabelCount?: number | undefined; /** - *A description of the usage profile.
+ *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 */ - Description?: string | undefined; + Schema?: SchemaColumn[] | undefined; /** - *A ProfileConfiguration
object specifying the job and session values for the profile.
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.
+ *The date and time when the usage profile was created.
+ *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 */ - CreatedOn?: Date | undefined; + GlueVersion?: string | undefined; /** - *The date and time when the usage profile was last modified.
+ *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 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.
+ *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 name of the catalog database where the function is located.
+ *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 name of the function.
+ *The timeout in minutes of the machine learning transform.
* @public */ - FunctionName: string | undefined; -} + Timeout?: number | undefined; -/** - *Represents the equivalent of a Hive user-defined function
- * (UDF
) definition.
The name of the function.
+ *The maximum number of times to retry after an MLTaskRun
of the machine
+ * learning transform fails.
The name of the catalog database that contains the function.
+ *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 */ - DatabaseName?: string | undefined; + TransformEncryption?: TransformEncryption | undefined; +} +/** + * @public + */ +export interface GetMLTransformsResponse { /** - *The Java class that contains the function code.
+ *A list of machine learning transforms.
* @public */ - ClassName?: string | undefined; + Transforms: MLTransform[] | undefined; /** - *The owner of the function.
+ *A pagination token, if more results are available.
* @public */ - OwnerName?: string | undefined; + NextToken?: string | undefined; +} +/** + * @public + */ +export interface GetPartitionRequest { /** - *The owner type.
+ *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 */ - OwnerType?: PrincipalType | undefined; + CatalogId?: string | undefined; /** - *The time at which the function was created.
+ *The name of the catalog database where the partition resides.
* @public */ - CreateTime?: Date | undefined; + DatabaseName: string | undefined; /** - *The resource URIs for the function.
+ *The name of the partition's table.
* @public */ - ResourceUris?: ResourceUri[] | undefined; + TableName: string | undefined; /** - *The ID of the Data Catalog in which the function resides.
+ *The values that define the partition.
* @public */ - CatalogId?: string | undefined; + PartitionValues: string[] | undefined; } /** * @public */ -export interface GetUserDefinedFunctionResponse { +export interface GetPartitionResponse { /** - *The requested function definition.
+ *The requested information, in the form of a Partition
+ * object.
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.
+ *The catalog ID where the table resides.
* @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.
+ *Specifies the name of a database from which you want to retrieve partition indexes.
* @public */ - DatabaseName?: string | undefined; + DatabaseName: string | undefined; /** - *An optional function-name pattern string that filters the function - * definitions returned.
+ *Specifies the name of a table for which you want to retrieve the partition indexes.
* @public */ - Pattern: string | undefined; + TableName: string | undefined; /** - *A continuation token, if this is a continuation call.
+ *A continuation token, included 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 + * @enum */ -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; -} +export const BackfillErrorCode = { + ENCRYPTED_PARTITION_ERROR: "ENCRYPTED_PARTITION_ERROR", + INTERNAL_ERROR: "INTERNAL_ERROR", + INVALID_PARTITION_TYPE_DATA_ERROR: "INVALID_PARTITION_TYPE_DATA_ERROR", + MISSING_PARTITION_VALUE_ERROR: "MISSING_PARTITION_VALUE_ERROR", + UNSUPPORTED_PARTITION_CHARACTER_ERROR: "UNSUPPORTED_PARTITION_CHARACTER_ERROR", +} as const; /** * @public */ -export interface GetWorkflowResponse { - /** - *The resource metadata for the workflow.
- * @public - */ - Workflow?: Workflow | undefined; -} +export type BackfillErrorCode = (typeof BackfillErrorCode)[keyof typeof BackfillErrorCode]; /** + *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.
+ *Name of the workflow being run.
- * @public - */ - Name: string | undefined; - - /** - *The ID of the workflow run.
- * @public - */ - RunId: string | undefined; - +export interface BackfillError { /** - *Specifies whether to include the workflow graph in response or not.
+ *The error code for an error that occurred when registering partition indexes for an existing table.
* @public */ - IncludeGraph?: boolean | undefined; -} + Code?: BackfillErrorCode | undefined; -/** - * @public - */ -export interface GetWorkflowRunResponse { /** - *The requested workflow run metadata.
+ *A list of a limited number of partitions in the response.
* @public */ - Run?: WorkflowRun | undefined; + Partitions?: PartitionValueList[] | undefined; } /** * @public + * @enum */ -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; -} +export const PartitionIndexStatus = { + ACTIVE: "ACTIVE", + CREATING: "CREATING", + DELETING: "DELETING", + FAILED: "FAILED", +} as const; /** * @public */ -export interface GetWorkflowRunPropertiesResponse { - /** - *The workflow run properties which were set during the specified run.
- * @public - */ - RunProperties?: RecordA partition key pair consisting of a name and a type.
* @public */ -export interface GetWorkflowRunsRequest { +export interface KeySchemaElement { /** - *Name of the workflow whose metadata of runs should be returned.
+ *The name of a partition key.
* @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.
+ *The type of a partition key.
* @public */ - CatalogId?: string | undefined; + Type: string | undefined; } /** + *A descriptor for a partition index in a table.
* @public */ -export interface ImportCatalogToGlueResponse {} - -/** - * @public - */ -export interface ListBlueprintsRequest { - /** - *A continuation token, if this is a continuation request.
- * @public - */ - NextToken?: string | undefined; - +export interface PartitionIndexDescriptor { /** - *The maximum size of a list to return.
+ *The name of the partition index.
* @public */ - MaxResults?: number | undefined; + IndexName: string | undefined; /** - *Filters the list by an Amazon Web Services resource tag.
+ *A list of one or more keys, as KeySchemaElement
structures, for the partition index.
List of names of blueprints in the account.
+ *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 continuation token, if not all blueprint names have been returned.
+ *A list of errors that can occur when registering partition indexes for an existing table.
* @public */ - NextToken?: string | undefined; + BackfillErrors?: BackfillError[] | undefined; } /** * @public */ -export interface ListColumnStatisticsTaskRunsRequest { +export interface GetPartitionIndexesResponse { /** - *The maximum size of the response.
+ *A list of index descriptors.
* @public */ - MaxResults?: number | undefined; + PartitionIndexDescriptorList?: PartitionIndexDescriptor[] | undefined; /** - *A continuation token, if this is a continuation call.
+ *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 ListColumnStatisticsTaskRunsResponse { +export interface Segment { /** - *A list of column statistics task run IDs.
+ *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.
A continuation token, if not all task run IDs have yet been returned.
+ *The total number of segments.
* @public */ - NextToken?: string | undefined; + TotalSegments: number | undefined; } /** * @public */ -export interface ListCrawlersRequest { +export interface GetPartitionsRequest { /** - *The maximum size of a list to return.
+ *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 */ - MaxResults?: number | undefined; + CatalogId?: string | undefined; /** - *A continuation token, if this is a continuation request.
+ *The name of the catalog database where the partitions reside.
* @public */ - NextToken?: string | undefined; + DatabaseName: string | undefined; /** - *Specifies to return only these tagged resources.
+ *The name of the partitions' table.
* @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; -} - -/** - * @public - * @enum - */ -export const FieldName = { - CRAWL_ID: "CRAWL_ID", - DPU_HOUR: "DPU_HOUR", - END_TIME: "END_TIME", - START_TIME: "START_TIME", - STATE: "STATE", -} as const; - -/** - * @public - */ -export type FieldName = (typeof FieldName)[keyof typeof FieldName]; - -/** - * @public - * @enum - */ -export const FilterOperator = { - EQ: "EQ", - GE: "GE", - GT: "GT", - LE: "LE", - LT: "LT", - NE: "NE", -} as const; - -/** - * @public - */ -export type FilterOperator = (typeof FilterOperator)[keyof typeof FilterOperator]; - -/** - *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:
+ *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.
*
- * CRAWL_ID
: A string representing the UUID identifier for a crawl.
- * STATE
: A string representing the state of the crawl.
string
+ *
*
- * START_TIME
and END_TIME
: The epoch timestamp in milliseconds.
date
+ *
*
- * DPU_HOUR
: The number of data processing unit (DPU) hours used for the crawl.
timestamp
+ *
* A defined comparator that operates on the value. The available operators are:
- *
- * GT
: Greater than.
int
+ *
*
- * GE
: Greater than or equal to.
bigint
+ *
*
- * LT
: Less than.
long
+ *
*
- * LE
: Less than or equal to.
tinyint
+ *
*
- * EQ
: Equal to.
smallint
+ *
*
- * NE
: Not equal to.
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 */ - FilterOperator?: FilterOperator | undefined; + Expression?: string | undefined; /** - *The value provided for comparison on the crawl field.
+ *A continuation token, if this is not the first call to retrieve + * these partitions.
* @public */ - FieldValue?: string | undefined; -} + NextToken?: string | undefined; -/** - * @public - */ -export interface ListCrawlsRequest { /** - *The name of the crawler whose runs you want to retrieve.
+ *The segment of the table's partitions to scan in this request.
* @public */ - CrawlerName: string | undefined; + Segment?: Segment | undefined; /** - *The maximum number of results to return. The default is 20, and maximum is 100.
+ *The maximum number of partitions to return in a single response.
* @public */ MaxResults?: number | undefined; /** - *Filters the crawls by the criteria you specify in a list of CrawlsFilter
objects.
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 */ - Filters?: CrawlsFilter[] | undefined; + ExcludeColumnSchema?: boolean | undefined; /** - *A continuation token, if this is a continuation call.
+ *The transaction ID at which to read the partition contents.
* @public */ - NextToken?: string | undefined; + 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 list of requested partitions.
+ * @public + */ + Partitions?: Partition[] | undefined; -/** - * @public - */ -export type CrawlerHistoryState = (typeof CrawlerHistoryState)[keyof typeof CrawlerHistoryState]; + /** + *A continuation token, if the returned list of partitions does not include the last + * one.
+ * @public + */ + NextToken?: string | undefined; +} /** - *Contains the information for a run of a crawler.
* @public */ -export interface CrawlerHistory { +export interface GetPlanRequest { /** - *A UUID identifier for each crawl.
+ *The list of mappings from a source table to target tables.
* @public */ - CrawlId?: string | undefined; + Mapping: MappingEntry[] | undefined; /** - *The state of the crawl.
+ *The source table.
* @public */ - State?: CrawlerHistoryState | undefined; + Source: CatalogEntry | undefined; /** - *The date and time on which the crawl started.
+ *The target tables.
* @public */ - StartTime?: Date | undefined; + Sinks?: CatalogEntry[] | undefined; /** - *The date and time on which the crawl ended.
+ *The parameters for the mapping.
* @public */ - EndTime?: Date | undefined; + Location?: Location | undefined; /** - *A run summary for the specific crawl in JSON. Contains the catalog tables and partitions that were added, updated, or deleted.
+ *The programming language of the code to perform the mapping.
* @public */ - Summary?: string | undefined; + Language?: Language | undefined; /** - *If an error occurred, the error message associated with the crawl.
+ *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"\}'
+ *
The log group associated with the crawl.
+ *A Python script to perform the mapping.
* @public */ - LogGroup?: string | undefined; + PythonScript?: string | undefined; /** - *The log stream associated with the crawl.
+ *The Scala code to perform the mapping.
* @public */ - LogStream?: string | undefined; - - /** - *The prefix for a CloudWatch message about this crawl.
- * @public - */ - MessagePrefix?: string | undefined; + ScalaCode?: string | undefined; +} +/** + * @public + */ +export interface GetRegistryInput { /** - *The number of data processing units (DPU) used in hours for the crawl.
+ *This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
* @public */ - DPUHour?: number | undefined; + RegistryId: RegistryId | undefined; } /** * @public */ -export interface ListCrawlsResponse { +export interface GetRegistryResponse { /** - *A list of CrawlerHistory
objects representing the crawl runs that meet your criteria.
The name of the registry.
* @public */ - Crawls?: CrawlerHistory[] | undefined; + RegistryName?: string | undefined; /** - *A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
+ *The Amazon Resource Name (ARN) of the registry.
* @public */ - NextToken?: string | undefined; -} + RegistryArn?: string | undefined; -/** - * @public - */ -export interface ListCustomEntityTypesRequest { /** - *A paginated token to offset the results.
+ *A description of the registry.
* @public */ - NextToken?: string | undefined; + Description?: string | undefined; /** - *The maximum number of results to return.
+ *The status of the registry.
* @public */ - MaxResults?: number | undefined; + Status?: RegistryStatus | undefined; /** - *A list of key-value pair tags.
+ *The date and time the registry was created.
* @public */ - Tags?: RecordThe date and time the registry was updated.
+ * @public + */ + UpdatedTime?: string | undefined; } /** * @public */ -export interface ListCustomEntityTypesResponse { +export interface GetResourcePoliciesRequest { /** - *A list of CustomEntityType
objects representing custom patterns.
A continuation token, if this is a continuation request.
* @public */ - CustomEntityTypes?: CustomEntityType[] | undefined; + NextToken?: string | undefined; /** - *A pagination token, if more results are available.
+ *The maximum size of a list to return.
* @public */ - NextToken?: string | undefined; + MaxResults?: number | undefined; } /** - *Criteria used to return data quality results.
+ *A structure for returning a resource policy.
* @public */ -export interface DataQualityResultFilterCriteria { - /** - *Filter results by the specified data source. For example, retrieving all results for an Glue table.
- * @public - */ - DataSource?: DataSource | undefined; - +export interface GluePolicy { /** - *Filter results by the specified job name.
+ *Contains the requested policy document, in JSON format.
* @public */ - JobName?: string | undefined; + PolicyInJson?: string | undefined; /** - *Filter results by the specified job run ID.
+ *Contains the hash value associated with this policy.
* @public */ - JobRunId?: string | undefined; + PolicyHash?: string | undefined; /** - *Filter results by runs that started after this time.
+ *The date and time at which the policy was created.
* @public */ - StartedAfter?: Date | undefined; + CreateTime?: Date | undefined; /** - *Filter results by runs that started before this time.
+ *The date and time at which the policy was last updated.
* @public */ - StartedBefore?: Date | undefined; + UpdateTime?: Date | undefined; } /** * @public */ -export interface ListDataQualityResultsRequest { +export interface GetResourcePoliciesResponse { /** - *The filter criteria.
+ *A list of the individual resource policies and the account-level resource policy.
* @public */ - Filter?: DataQualityResultFilterCriteria | undefined; + GetResourcePoliciesResponseList?: GluePolicy[] | undefined; /** - *A paginated token to offset the results.
+ *A continuation token, if the returned list does not contain the last resource policy available.
* @public */ NextToken?: string | undefined; +} +/** + * @public + */ +export interface GetResourcePolicyRequest { /** - *The maximum number of results to return.
+ *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.
+ *
Describes a data quality result.
* @public */ -export interface DataQualityResultDescription { +export interface GetResourcePolicyResponse { /** - *The unique result ID for this data quality result.
+ *Contains the requested policy document, in JSON format.
* @public */ - ResultId?: string | undefined; + PolicyInJson?: string | undefined; /** - *The table name associated with the data quality result.
+ *Contains the hash value associated with this policy.
* @public */ - DataSource?: DataSource | undefined; + PolicyHash?: string | undefined; /** - *The job name associated with the data quality result.
+ *The date and time at which the policy was created.
* @public */ - JobName?: string | undefined; + CreateTime?: Date | undefined; /** - *The job run ID associated with the data quality result.
+ *The date and time at which the policy was last updated.
* @public */ - JobRunId?: string | undefined; + UpdateTime?: Date | undefined; +} +/** + * @public + */ +export interface GetSchemaInput { /** - *The time that the run started for this data quality result.
+ *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.
A list of DataQualityResultDescription
objects.
The name of the registry.
* @public */ - Results: DataQualityResultDescription[] | undefined; + RegistryName?: string | undefined; /** - *A pagination token, if more results are available.
+ *The Amazon Resource Name (ARN) of the registry.
* @public */ - NextToken?: string | undefined; -} + RegistryArn?: string | undefined; -/** - *A filter for listing data quality recommendation runs.
- * @public - */ -export interface DataQualityRuleRecommendationRunFilter { /** - *Filter based on a specified data source (Glue table).
+ *The name of the schema.
* @public */ - DataSource: DataSource | undefined; + SchemaName?: string | undefined; /** - *Filter based on time for results started before provided time.
+ *The Amazon Resource Name (ARN) of the schema.
* @public */ - StartedBefore?: Date | undefined; + SchemaArn?: string | undefined; /** - *Filter based on time for results started after provided time.
+ *A description of schema if specified when created
* @public */ - StartedAfter?: Date | undefined; -} + Description?: string | undefined; -/** - * @public - */ -export interface ListDataQualityRuleRecommendationRunsRequest { /** - *The filter criteria.
+ *The data format of the schema definition. Currently AVRO
, JSON
and PROTOBUF
are supported.
A paginated token to offset the results.
+ *The compatibility mode of the schema.
* @public */ - NextToken?: string | undefined; + Compatibility?: Compatibility | undefined; /** - *The maximum number of results to return.
+ *The version number of the checkpoint (the last time the compatibility mode was changed).
* @public */ - MaxResults?: number | undefined; -} + SchemaCheckpoint?: number | undefined; -/** - *Describes the result of a data quality rule recommendation run.
- * @public - */ -export interface DataQualityRuleRecommendationRunDescription { /** - *The unique run identifier associated with this run.
+ *The latest version of the schema associated with the returned schema definition.
* @public */ - RunId?: string | undefined; + LatestSchemaVersion?: number | undefined; /** - *The status for this run.
+ *The next version of the schema associated with the returned schema definition.
* @public */ - Status?: TaskStatusType | undefined; + NextSchemaVersion?: number | undefined; /** - *The date and time when this run started.
+ *The status of the schema.
* @public */ - StartedOn?: Date | undefined; + SchemaStatus?: SchemaStatus | undefined; /** - *The data source (Glue table) associated with the recommendation run.
+ *The date and time the schema was created.
* @public */ - DataSource?: DataSource | undefined; + CreatedTime?: string | undefined; + + /** + *The date and time the schema was updated.
+ * @public + */ + UpdatedTime?: string | undefined; } /** * @public */ -export interface ListDataQualityRuleRecommendationRunsResponse { +export interface GetSchemaByDefinitionInput { /** - *A list of DataQualityRuleRecommendationRunDescription
objects.
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.
A pagination token, if more results are available.
+ *The definition of the schema for which schema details are required.
* @public */ - NextToken?: string | undefined; + SchemaDefinition: string | undefined; } /** - *The filter criteria.
* @public */ -export interface DataQualityRulesetEvaluationRunFilter { +export interface GetSchemaByDefinitionResponse { /** - *Filter based on a data source (an Glue table) associated with the run.
+ *The schema ID of the schema version.
* @public */ - DataSource: DataSource | undefined; + SchemaVersionId?: string | undefined; /** - *Filter results by runs that started before this time.
+ *The Amazon Resource Name (ARN) of the schema.
* @public */ - StartedBefore?: Date | undefined; + SchemaArn?: string | undefined; /** - *Filter results by runs that started after this time.
+ *The data format of the schema definition. Currently AVRO
, JSON
and PROTOBUF
are supported.
The filter criteria.
+ *The status of the schema version.
* @public */ - Filter?: DataQualityRulesetEvaluationRunFilter | undefined; - - /** - *A paginated token to offset the results.
- * @public - */ - NextToken?: string | undefined; + Status?: SchemaVersionStatus | undefined; /** - *The maximum number of results to return.
+ *The date and time the schema was created.
* @public */ - MaxResults?: number | undefined; + CreatedTime?: string | undefined; } /** - *Describes the result of a data quality ruleset evaluation run.
+ *A structure containing the schema version information.
* @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; - +export interface SchemaVersionNumber { /** - *The date and time when the run started.
+ *The latest version available for the schema.
* @public */ - StartedOn?: Date | undefined; + LatestVersion?: boolean | undefined; /** - *The data source (an Glue table) associated with the run.
+ *The version number of the schema.
* @public */ - DataSource?: DataSource | undefined; + VersionNumber?: number | undefined; } /** * @public */ -export interface ListDataQualityRulesetEvaluationRunsResponse { +export interface GetSchemaVersionInput { /** - *A list of DataQualityRulesetEvaluationRunDescription
objects representing data quality ruleset runs.
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.
A pagination token, if more results are available.
+ *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; } /** - *The criteria used to filter data quality rulesets.
* @public */ -export interface DataQualityRulesetFilterCriteria { +export interface GetSchemaVersionResponse { /** - *The name of the ruleset filter criteria.
+ *The SchemaVersionId
of the schema version.
The description of the ruleset filter criteria.
+ *The schema definition for the schema ID.
* @public */ - Description?: string | undefined; + SchemaDefinition?: string | undefined; /** - *Filter on rulesets created before this date.
+ *The data format of the schema definition. Currently AVRO
, JSON
and PROTOBUF
are supported.
Filter on rulesets created after this date.
+ *The Amazon Resource Name (ARN) of the schema.
* @public */ - CreatedAfter?: Date | undefined; + SchemaArn?: string | undefined; /** - *Filter on rulesets last modified before this date.
+ *The version number of the schema.
* @public */ - LastModifiedBefore?: Date | undefined; + VersionNumber?: number | undefined; /** - *Filter on rulesets last modified after this date.
+ *The status of the schema version.
* @public */ - LastModifiedAfter?: Date | undefined; + Status?: SchemaVersionStatus | undefined; /** - *The name and database name of the target table.
+ *The date and time the schema version was created.
* @public */ - TargetTable?: DataQualityTargetTable | undefined; + CreatedTime?: string | undefined; } /** * @public + * @enum */ -export interface ListDataQualityRulesetsRequest { +export const SchemaDiffType = { + SYNTAX_DIFF: "SYNTAX_DIFF", +} as const; + +/** + * @public + */ +export type SchemaDiffType = (typeof SchemaDiffType)[keyof typeof SchemaDiffType]; + +/** + * @public + */ +export interface GetSchemaVersionsDiffInput { /** - *A paginated token to offset the results.
+ *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 maximum number of results to return.
+ *The first of the two schema versions to be compared.
* @public */ - MaxResults?: number | undefined; + FirstSchemaVersionNumber: SchemaVersionNumber | undefined; /** - *The filter criteria.
+ *The second of the two schema versions to be compared.
* @public */ - Filter?: DataQualityRulesetFilterCriteria | undefined; + SecondSchemaVersionNumber: SchemaVersionNumber | undefined; /** - *A list of key-value pair tags.
+ *Refers to SYNTAX_DIFF
, which is the currently supported diff type.
Describes a data quality ruleset returned by GetDataQualityRuleset
.
The name of the data quality ruleset.
- * @public - */ - Name?: string | undefined; - +export interface GetSchemaVersionsDiffResponse { /** - *A description of the data quality ruleset.
+ *The difference between schemas as a string in JsonPatch format.
* @public */ - Description?: string | undefined; + Diff?: string | undefined; +} +/** + * @public + */ +export interface GetSecurityConfigurationRequest { /** - *The date and time the data quality ruleset was created.
+ *The name of the security configuration to retrieve.
* @public */ - CreatedOn?: Date | undefined; + Name: string | undefined; +} +/** + *Specifies a security configuration.
+ * @public + */ +export interface SecurityConfiguration { /** - *The date and time the data quality ruleset was last modified.
+ *The name of the security configuration.
* @public */ - LastModifiedOn?: Date | undefined; + Name?: string | undefined; /** - *An object representing an Glue table.
+ *The time at which this security configuration was created.
* @public */ - TargetTable?: DataQualityTargetTable | undefined; + CreatedTimeStamp?: Date | undefined; /** - *When a ruleset was created from a recommendation run, this run ID is generated to link the two together.
+ *The encryption configuration associated with this security configuration.
* @public */ - RecommendationRunId?: string | undefined; + EncryptionConfiguration?: EncryptionConfiguration | undefined; +} +/** + * @public + */ +export interface GetSecurityConfigurationResponse { /** - *The number of rules in the ruleset.
+ *The requested security configuration.
* @public */ - RuleCount?: number | undefined; + SecurityConfiguration?: SecurityConfiguration | undefined; } /** * @public */ -export interface ListDataQualityRulesetsResponse { +export interface GetSecurityConfigurationsRequest { /** - *A paginated list of rulesets for the specified list of Glue tables.
+ *The maximum number of results to return.
* @public */ - Rulesets?: DataQualityRulesetListDetails[] | undefined; + MaxResults?: number | undefined; /** - *A pagination token, if more results are available.
+ *A continuation token, if this is a continuation call.
* @public */ NextToken?: string | undefined; } /** - *A timestamp filter.
* @public */ -export interface TimestampFilter { +export interface GetSecurityConfigurationsResponse { /** - *The timestamp before which statistics should be included in the results.
+ *A list of security configurations.
* @public */ - RecordedBefore?: Date | undefined; + SecurityConfigurations?: SecurityConfiguration[] | undefined; /** - *The timestamp after which statistics should be included in the results.
+ *A continuation token, if there are more security + * configurations to return.
* @public */ - RecordedAfter?: Date | undefined; + NextToken?: string | 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; - +export interface GetSessionRequest { /** - *The maximum number of results to return in this request.
+ *The ID of the session.
* @public */ - MaxResults?: number | undefined; + Id: string | undefined; /** - *A pagination token to retrieve the next set of results.
+ *The origin of the request.
* @public */ - NextToken?: string | undefined; + RequestOrigin?: string | undefined; } /** * @public */ -export interface ListDataQualityStatisticAnnotationsResponse { - /** - *A list of StatisticAnnotation
applied to the Statistic
A pagination token to retrieve the next set of results.
+ *The session object is returned in the response.
* @public */ - NextToken?: string | undefined; + Session?: Session | undefined; } /** * @public */ -export interface ListDataQualityStatisticsRequest { +export interface GetStatementRequest { /** - *The Statistic ID.
+ *The Session ID of the statement.
* @public */ - StatisticId?: string | undefined; + SessionId: string | undefined; /** - *The Profile ID.
+ *The Id of the statement.
* @public */ - ProfileId?: string | undefined; + Id: number | undefined; /** - *A timestamp filter.
+ *The origin of the request.
* @public */ - TimestampFilter?: TimestampFilter | undefined; + RequestOrigin?: string | undefined; +} - /** - *The maximum number of results to return in this request.
- * @public +/** + *The code execution output in JSON format.
+ * @public + */ +export interface StatementOutputData { + /** + *The code execution output in text format.
+ * @public + */ + TextPlain?: string | undefined; +} + +/** + * @public + * @enum + */ +export const StatementState = { + AVAILABLE: "AVAILABLE", + CANCELLED: "CANCELLED", + CANCELLING: "CANCELLING", + ERROR: "ERROR", + RUNNING: "RUNNING", + WAITING: "WAITING", +} as const; + +/** + * @public + */ +export type StatementState = (typeof StatementState)[keyof typeof StatementState]; + +/** + *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
.
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; +} + +/** + * @public + * @enum + */ +export const ResourceAction = { + CREATE: "CREATE", + UPDATE: "UPDATE", +} as const; + +/** + * @public + */ +export type ResourceAction = (typeof ResourceAction)[keyof typeof ResourceAction]; + +/** + * @public + * @enum + */ +export const ResourceState = { + FAILED: "FAILED", + IN_PROGRESS: "IN_PROGRESS", + QUEUED: "QUEUED", + STOPPED: "STOPPED", + SUCCESS: "SUCCESS", +} as const; + +/** + * @public + */ +export type ResourceState = (typeof ResourceState)[keyof typeof ResourceState]; + +/** + *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; + + /** + *A list of table Amazon Resource Names (ARNs).
+ * @public + */ + SubObjects?: string[] | 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 + * @enum + */ +export const TableAttributes = { + NAME: "NAME", + TABLE_TYPE: "TABLE_TYPE", +} as const; + +/** + * @public + */ +export type TableAttributes = (typeof TableAttributes)[keyof typeof TableAttributes]; + +/** + * @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
.
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.
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; +} + +/** + * @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; +} + +/** + *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 + */ +export interface QuerySessionContext { + /** + *A unique identifier generated by the query engine for the query.
+ * @public */ - MaxResults?: number | undefined; + QueryId?: string | undefined; /** - *A pagination token to request the next page of results.
+ *A timestamp provided by the query engine for when the query started.
* @public */ - NextToken?: string | undefined; + QueryStartTime?: Date | undefined; + + /** + *An identifier string for the consumer cluster.
+ * @public + */ + ClusterId?: string | undefined; + + /** + *A cryptographically generated query identifier generated by Glue or Lake Formation.
+ * @public + */ + QueryAuthorizationId?: string | undefined; + + /** + *An opaque string-string map passed by the query engine.
+ * @public + */ + AdditionalContext?: RecordA run identifier.
* @public */ -export interface RunIdentifier { +export interface GetUnfilteredPartitionMetadataRequest { /** - *The Run ID.
+ *Specified only if the base tables belong to a different Amazon Web Services Region.
* @public */ - RunId?: string | undefined; + Region?: string | undefined; /** - *The Job Run ID.
+ *The catalog ID where the partition resides.
* @public */ - JobRunId?: string | undefined; + 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; } /** - *Summary information about a statistic.
* @public */ -export interface StatisticSummary { +export interface GetUnfilteredPartitionMetadataResponse { /** - *The Statistic ID.
+ *A Partition object containing the partition metadata.
* @public */ - StatisticId?: string | undefined; + Partition?: Partition | undefined; /** - *The Profile ID.
+ *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; +} + +/** + *The operation timed out.
+ * @public + */ +export class PermissionTypeMismatchException extends __BaseException { + readonly name: "PermissionTypeMismatchException" = "PermissionTypeMismatchException"; + readonly $fault: "client" = "client"; + /** + *There is a mismatch between the SupportedPermissionType used in the query request + * and the permissions defined on the target table.
+ * @public + */ + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeSpecified 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 */ - ProfileId?: string | undefined; + Expression?: string | undefined; /** - *The Run Identifier
+ *A structure containing Lake Formation audit context information.
* @public */ - RunIdentifier?: RunIdentifier | undefined; + AuditContext?: AuditContext | undefined; /** - *The name of the statistic.
+ *A list of supported permission types.
* @public */ - StatisticName?: string | undefined; + SupportedPermissionTypes: PermissionType[] | undefined; /** - *The value of the statistic.
+ *A continuation token, if this is not the first call to retrieve + * these partitions.
* @public */ - DoubleValue?: number | undefined; + NextToken?: string | undefined; /** - *The evaluation level of the statistic. Possible values: Dataset
, Column
, Multicolumn
.
The segment of the table's partitions to scan in this request.
* @public */ - EvaluationLevel?: StatisticEvaluationLevel | undefined; + Segment?: Segment | undefined; /** - *The list of columns referenced by the statistic.
+ *The maximum number of partitions to return in a single response.
* @public */ - ColumnsReferenced?: string[] | undefined; + MaxResults?: number | undefined; /** - *The list of datasets referenced by the statistic.
+ *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 */ - ReferencedDatasets?: string[] | undefined; + QuerySessionContext?: QuerySessionContext | undefined; +} +/** + *A partition that contains unfiltered metadata.
+ * @public + */ +export interface UnfilteredPartition { /** - *A StatisticPropertiesMap
, which contains a NameString
and DescriptionString
- *
The partition object.
* @public */ - StatisticProperties?: RecordThe timestamp when the statistic was recorded.
+ *The list of columns the user has permissions to access.
* @public */ - RecordedOn?: Date | undefined; + AuthorizedColumns?: string[] | undefined; /** - *The inclusion annotation for the statistic.
+ *A Boolean value indicating that the partition location is registered with Lake Formation.
* @public */ - InclusionAnnotation?: TimestampedInclusionAnnotation | undefined; + IsRegisteredWithLakeFormation?: boolean | undefined; } /** * @public */ -export interface ListDataQualityStatisticsResponse { +export interface GetUnfilteredPartitionsMetadataResponse { /** - *A StatisticSummaryList
.
A list of requested partitions.
* @public */ - Statistics?: StatisticSummary[] | undefined; + UnfilteredPartitions?: UnfilteredPartition[] | undefined; /** - *A pagination token to request the next page of results.
+ *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 ListDevEndpointsRequest { - /** - *A continuation token, if this is a continuation request.
- * @public - */ - NextToken?: string | undefined; - +export interface SupportedDialect { /** - *The maximum size of a list to return.
+ *The dialect of the query engine.
* @public */ - MaxResults?: number | undefined; + Dialect?: ViewDialect | undefined; /** - *Specifies to return only these tagged resources.
+ *The version of the dialect of the query engine. For example, 3.0.0.
* @public */ - Tags?: RecordThe names of all the DevEndpoint
s in the account, or the
- * DevEndpoint
s with the specified tags.
A continuation token, if the returned list does not contain the - * last metric available.
+ *Specified only if the base tables belong to a different Amazon Web Services Region.
* @public */ - NextToken?: string | undefined; -} + Region?: string | undefined; -/** - * @public - */ -export interface ListJobsRequest { /** - *A continuation token, if this is a continuation request.
+ *The catalog ID where the table resides.
* @public */ - NextToken?: string | undefined; + CatalogId: string | undefined; /** - *The maximum size of a list to return.
+ *(Required) Specifies the name of a database that contains the table.
* @public */ - MaxResults?: number | undefined; + DatabaseName: string | undefined; /** - *Specifies to return only these tagged resources.
+ *(Required) Specifies the name of a table for which you are requesting metadata.
* @public */ - Tags?: RecordThe names of all jobs in the account, or the jobs with the specified tags.
+ *A structure containing Lake Formation audit context information.
* @public */ - JobNames?: string[] | undefined; + AuditContext?: AuditContext | undefined; /** - *A continuation token, if the returned list does not contain the - * last metric available.
+ *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.
A continuation token, if this is a continuation request.
+ *The resource ARN of the view.
* @public */ - NextToken?: string | undefined; + ParentResourceArn?: string | undefined; /** - *The maximum size of a list to return.
+ *The resource ARN of the root view in a chain of nested views.
* @public */ - MaxResults?: number | undefined; + RootResourceArn?: string | undefined; /** - *A TransformFilterCriteria
used to filter the machine learning transforms.
A structure specifying the dialect and dialect version used by the query engine.
* @public */ - Filter?: TransformFilterCriteria | undefined; + SupportedDialect?: SupportedDialect | undefined; /** - *A TransformSortCriteria
used to sort the machine learning transforms.
The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.
* @public */ - Sort?: TransformSortCriteria | undefined; + Permissions?: Permission[] | undefined; /** - *Specifies to return only these tagged resources.
+ *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 */ - Tags?: RecordA filter that uses both column-level and row-level filtering.
* @public */ -export interface ListMLTransformsResponse { +export interface ColumnRowFilter { /** - *The identifiers of all the machine learning transforms in the account, or the - * machine learning transforms with the specified tags.
+ *A string containing the name of the column.
* @public */ - TransformIds: string[] | undefined; + ColumnName?: string | undefined; /** - *A continuation token, if the returned list does not contain the - * last metric available.
+ *A string containing the row-level filter expression.
* @public */ - NextToken?: string | undefined; + RowFilterExpression?: 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; - +export interface GetUsageProfileRequest { /** - *A continuation token, if this is a continuation call.
+ *The name of the usage profile to retrieve.
* @public */ - NextToken?: string | undefined; + Name: string | undefined; } /** - *A structure containing the details for a registry.
* @public */ -export interface RegistryListItem { - /** - *The name of the registry.
- * @public - */ - RegistryName?: string | undefined; - +export interface GetUsageProfileResponse { /** - *The Amazon Resource Name (ARN) of the registry.
+ *The name of the usage profile.
* @public */ - RegistryArn?: string | undefined; + Name?: string | undefined; /** - *A description of the registry.
+ *A description of the usage profile.
* @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).
+ *A ProfileConfiguration
object specifying the job and session values for the profile.
Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
+ *The date and time when the usage profile was created.
* @public */ - MaxResults?: number | undefined; + CreatedOn?: Date | undefined; /** - *A continuation token, if this is a continuation call.
+ *The date and time when the usage profile was last modified.
* @public */ - NextToken?: string | undefined; + LastModifiedOn?: Date | undefined; } /** - *An object that contains minimal details for a schema.
* @public */ -export interface SchemaListItem { +export interface GetUserDefinedFunctionRequest { /** - *the name of the registry where the schema resides.
+ *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 */ - RegistryName?: string | undefined; + CatalogId?: string | undefined; /** - *The name of the schema.
+ *The name of the catalog database where the function is located.
* @public */ - SchemaName?: string | undefined; + DatabaseName: string | undefined; /** - *The Amazon Resource Name (ARN) for the schema.
+ *The name of the function.
* @public */ - SchemaArn?: string | undefined; + FunctionName: string | undefined; +} +/** + *Represents the equivalent of a Hive user-defined function
+ * (UDF
) definition.
A description for the schema.
+ *The name of the function.
* @public */ - Description?: string | undefined; + FunctionName?: string | undefined; /** - *The status of the schema.
+ *The name of the catalog database that contains the function.
* @public */ - SchemaStatus?: SchemaStatus | undefined; + DatabaseName?: string | undefined; /** - *The date and time that a schema was created.
+ *The Java class that contains the function code.
* @public */ - CreatedTime?: string | undefined; + ClassName?: string | undefined; /** - *The date and time that a schema was updated.
+ *The owner of the function.
* @public */ - UpdatedTime?: string | undefined; -} + OwnerName?: string | undefined; -/** - * @public - */ -export interface ListSchemasResponse { /** - *An array of SchemaListItem
objects containing details of each schema.
The owner type.
* @public */ - Schemas?: SchemaListItem[] | undefined; + OwnerType?: PrincipalType | undefined; /** - *A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
+ *The time at which the function was created.
* @public */ - NextToken?: string | undefined; -} + CreateTime?: Date | 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.
The resource URIs for the function.
* @public */ - SchemaId: SchemaId | undefined; + ResourceUris?: ResourceUri[] | undefined; /** - *Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
+ *The ID of the Data Catalog in which the function resides.
* @public */ - MaxResults?: number | undefined; + CatalogId?: string | undefined; +} +/** + * @public + */ +export interface GetUserDefinedFunctionResponse { /** - *A continuation token, if this is a continuation call.
+ *The requested function definition.
* @public */ - NextToken?: string | undefined; + UserDefinedFunction?: UserDefinedFunction | undefined; } /** - *An object containing the details about a schema version.
* @public */ -export interface SchemaVersionListItem { +export interface GetUserDefinedFunctionsRequest { /** - *The Amazon Resource Name (ARN) of the schema.
+ *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 */ - SchemaArn?: string | undefined; + CatalogId?: string | undefined; /** - *The unique identifier of the schema version.
+ *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 */ - SchemaVersionId?: string | undefined; + DatabaseName?: string | undefined; /** - *The version number of the schema.
+ *An optional function-name pattern string that filters the function + * definitions returned.
* @public */ - VersionNumber?: number | undefined; + Pattern: string | undefined; /** - *The status of the schema version.
+ *A continuation token, if this is a continuation call.
* @public */ - Status?: SchemaVersionStatus | undefined; + NextToken?: string | undefined; /** - *The date and time the schema version was created.
+ *The maximum number of functions to return in one response.
* @public */ - CreatedTime?: string | undefined; + MaxResults?: number | undefined; } /** * @public */ -export interface ListSchemaVersionsResponse { +export interface GetUserDefinedFunctionsResponse { /** - *An array of SchemaVersionList
objects containing details of each schema version.
A list of requested function definitions.
* @public */ - Schemas?: SchemaVersionListItem[] | undefined; + UserDefinedFunctions?: UserDefinedFunction[] | undefined; /** - *A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
+ *A continuation token, if the list of functions returned does + * not include the last requested function.
* @public */ NextToken?: string | undefined; @@ -5073,131 +5675,134 @@ export interface ListSchemaVersionsResponse { /** * @public */ -export interface ListSessionsRequest { - /** - *The token for the next set of results, or null if there are no more result.
- * @public - */ - NextToken?: string | undefined; - +export interface GetWorkflowRequest { /** - *The maximum number of results.
+ *The name of the workflow to retrieve.
* @public */ - MaxResults?: number | undefined; + Name: string | undefined; /** - *Tags belonging to the session.
+ *Specifies whether to include a graph when returning the workflow resource metadata.
* @public */ - Tags?: RecordThe origin of the request.
+ *The resource metadata for the workflow.
* @public */ - RequestOrigin?: string | undefined; + Workflow?: Workflow | undefined; } /** * @public */ -export interface ListSessionsResponse { +export interface GetWorkflowRunRequest { /** - *Returns the ID of the session.
+ *Name of the workflow being run.
* @public */ - Ids?: string[] | undefined; + Name: string | undefined; /** - *Returns the session object.
+ *The ID of the workflow run.
* @public */ - Sessions?: Session[] | undefined; + RunId: string | undefined; /** - *The token for the next set of results, or null if there are no more result.
+ *Specifies whether to include the workflow graph in response or not.
* @public */ - NextToken?: string | undefined; + IncludeGraph?: boolean | undefined; } /** * @public */ -export interface ListStatementsRequest { +export interface GetWorkflowRunResponse { /** - *The Session ID of the statements.
+ *The requested workflow run metadata.
* @public */ - SessionId: string | undefined; + Run?: WorkflowRun | undefined; +} +/** + * @public + */ +export interface GetWorkflowRunPropertiesRequest { /** - *The origin of the request to list statements.
+ *Name of the workflow which was run.
* @public */ - RequestOrigin?: string | undefined; + Name: string | undefined; /** - *A continuation token, if this is a continuation call.
+ *The ID of the workflow run whose run properties should be returned.
* @public */ - NextToken?: string | undefined; + RunId: string | undefined; } /** * @public */ -export interface ListStatementsResponse { - /** - *Returns the list of statements.
- * @public - */ - Statements?: Statement[] | undefined; - +export interface GetWorkflowRunPropertiesResponse { /** - *A continuation token, if not all statements have yet been returned.
+ *The workflow run properties which were set during the specified run.
* @public */ - NextToken?: string | undefined; + RunProperties?: RecordThe Catalog ID of the table.
+ *Name of the workflow whose metadata of runs should be returned.
* @public */ - CatalogId: string | undefined; + Name: string | undefined; /** - *The name of the database in the catalog in which the table resides.
+ *Specifies whether to include the workflow graph in response or not.
* @public */ - DatabaseName: string | undefined; + IncludeGraph?: boolean | undefined; /** - *The name of the table.
+ *The maximum size of the response.
* @public */ - TableName: string | undefined; + NextToken?: string | undefined; /** - *The type of table optimizer.
+ *The maximum number of workflow runs to be included in the response.
* @public */ - Type: TableOptimizerType | undefined; + MaxResults?: number | undefined; +} +/** + * @public + */ +export interface GetWorkflowRunsResponse { /** - *The maximum number of optimizer runs to return on each call.
+ *A list of workflow run metadata objects.
* @public */ - MaxResults?: number | undefined; + Runs?: WorkflowRun[] | undefined; /** - *A continuation token, if this is a continuation call.
+ *A continuation token, if not all requested workflow runs have been returned.
* @public */ NextToken?: string | undefined; @@ -5206,81 +5811,88 @@ export interface ListTableOptimizerRunsRequest { /** * @public */ -export interface ListTableOptimizerRunsResponse { +export interface ImportCatalogToGlueRequest { /** - *The Catalog ID of the table.
+ *The ID of the catalog to import. Currently, this should be the Amazon Web Services account ID.
* @public */ CatalogId?: string | undefined; +} - /** - *The name of the database in the catalog in which the table resides.
- * @public - */ - DatabaseName?: string | undefined; +/** + * @public + */ +export interface ImportCatalogToGlueResponse {} +/** + * @public + */ +export interface ListBlueprintsRequest { /** - *The name of the table.
+ *A continuation token, if this is a continuation request.
* @public */ - TableName?: string | undefined; + NextToken?: 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.
+ *The maximum size of a list to return.
* @public */ - NextToken?: string | undefined; + MaxResults?: number | undefined; /** - *A list of the optimizer runs associated with a table.
+ *Filters the list by an Amazon Web Services resource tag.
* @public */ - TableOptimizerRuns?: TableOptimizerRun[] | undefined; + Tags?: RecordA continuation token, if this is a continuation request.
+ *List of names of blueprints in the account.
* @public */ - NextToken?: string | undefined; + Blueprints?: 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.
+ *A continuation token, if not all blueprint names have been returned.
* @public */ - DependentJobName?: string | undefined; + NextToken?: string | undefined; +} +/** + * @public + */ +export interface ListColumnStatisticsTaskRunsRequest { /** - *The maximum size of a list to return.
+ *The maximum size of the response.
* @public */ MaxResults?: number | undefined; /** - *Specifies to return only these tagged resources.
+ *A continuation token, if this is a continuation call.
* @public */ - Tags?: RecordThe names of all triggers in the account, or the triggers with the specified tags.
+ *A list of column statistics task run IDs.
* @public */ - TriggerNames?: string[] | undefined; + ColumnStatisticsTaskRunIds?: string[] | undefined; /** - *A continuation token, if the returned list does not contain the - * last metric available.
+ *A continuation token, if not all task run IDs have yet been returned.
* @public */ NextToken?: string | undefined; @@ -5289,62 +5901,56 @@ export interface ListTriggersResponse { /** * @public */ -export interface ListUsageProfilesRequest { +export interface ListConnectionTypesRequest { /** - *A continuation token, included if this is a continuation call.
+ *The maximum number of results to return.
* @public */ - NextToken?: string | undefined; + MaxResults?: number | undefined; /** - *The maximum number of usage profiles to return in a single response.
+ *A continuation token, if this is a continuation call.
* @public */ - MaxResults?: number | undefined; + NextToken?: string | undefined; } /** - *Describes an Glue usage profile.
+ *Brief information about a supported connection type returned by the ListConnectionTypes
API.
The name of the usage profile.
+ *The name of the connection type.
* @public */ - Name?: string | undefined; + ConnectionType?: ConnectionType | undefined; /** - *A description of the usage profile.
+ *A description of the connection type.
* @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.
+ *The supported authentication types, data interface types (compute environments), and data operations of the connector.
* @public */ - LastModifiedOn?: Date | undefined; + Capabilities?: Capabilities | undefined; } /** * @public */ -export interface ListUsageProfilesResponse { +export interface ListConnectionTypesResponse { /** - *A list of usage profile (UsageProfileDefinition
) objects.
A list of ConnectionTypeBrief
objects containing brief information about the supported connection types.
A continuation token, present if the current list segment is not the last.
+ *A continuation token, if the current list segment is not the last.
* @public */ NextToken?: string | undefined; @@ -5353,7 +5959,13 @@ export interface ListUsageProfilesResponse { /** * @public */ -export interface ListWorkflowsRequest { +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 @@ -5361,24 +5973,25 @@ export interface ListWorkflowsRequest { NextToken?: string | undefined; /** - *The maximum size of a list to return.
+ *Specifies to return only these tagged resources.
* @public */ - MaxResults?: number | undefined; + Tags?: RecordList of names of workflows in the account.
+ *The names of all crawlers in the account, or the crawlers with the specified tags.
* @public */ - Workflows?: string[] | undefined; + CrawlerNames?: string[] | undefined; /** - *A continuation token, if not all workflow names have been returned.
+ *A continuation token, if the returned list does not contain the + * last metric available.
* @public */ NextToken?: string | undefined; @@ -5386,2551 +5999,2632 @@ export interface ListWorkflowsResponse { /** * @public + * @enum */ -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; +export const FieldName = { + CRAWL_ID: "CRAWL_ID", + DPU_HOUR: "DPU_HOUR", + END_TIME: "END_TIME", + START_TIME: "START_TIME", + STATE: "STATE", +} as const; - /** - *The security configuration to set.
- * @public - */ - DataCatalogEncryptionSettings: DataCatalogEncryptionSettings | undefined; -} +/** + * @public + */ +export type FieldName = (typeof FieldName)[keyof typeof FieldName]; /** * @public + * @enum */ -export interface PutDataCatalogEncryptionSettingsResponse {} +export const FilterOperator = { + EQ: "EQ", + GE: "GE", + GT: "GT", + LE: "LE", + LT: "LT", + NE: "NE", +} as const; /** * @public */ -export interface PutDataQualityProfileAnnotationRequest { +export type FilterOperator = (typeof FilterOperator)[keyof typeof FilterOperator]; + +/** + *A list of fields, comparators and value that you can use to filter the crawler runs for a specified crawler.
+ * @public + */ +export interface CrawlsFilter { /** - *The ID of the data quality monitoring profile to annotate.
+ *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.
The inclusion annotation value to apply to the profile.
+ *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; } /** - *Left blank.
* @public */ -export interface PutDataQualityProfileAnnotationResponse {} +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; +} /** * @public * @enum */ -export const EnableHybridValues = { - FALSE: "FALSE", - TRUE: "TRUE", +export const CrawlerHistoryState = { + COMPLETED: "COMPLETED", + FAILED: "FAILED", + RUNNING: "RUNNING", + STOPPED: "STOPPED", } as const; /** * @public */ -export type EnableHybridValues = (typeof EnableHybridValues)[keyof typeof EnableHybridValues]; +export type CrawlerHistoryState = (typeof CrawlerHistoryState)[keyof typeof CrawlerHistoryState]; /** + *Contains the information for a run of a crawler.
* @public - * @enum */ -export const ExistCondition = { - MUST_EXIST: "MUST_EXIST", - NONE: "NONE", - NOT_EXIST: "NOT_EXIST", -} as const; +export interface CrawlerHistory { + /** + *A UUID identifier for each crawl.
+ * @public + */ + CrawlId?: string | undefined; -/** - * @public - */ -export type ExistCondition = (typeof ExistCondition)[keyof typeof ExistCondition]; + /** + *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; -/** - * @public - */ -export interface PutResourcePolicyRequest { /** - *Contains the policy document to set, in JSON format.
+ *The log group associated with the crawl.
* @public */ - PolicyInJson: string | undefined; + LogGroup?: string | undefined; /** - *Do not use. For internal use only.
+ *The log stream associated with the crawl.
* @public */ - ResourceArn?: string | undefined; + LogStream?: 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.
The prefix for a CloudWatch message about this crawl.
* @public */ - PolicyHashCondition?: string | undefined; + MessagePrefix?: string | undefined; /** - *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.
The number of data processing units (DPU) used in hours for the crawl.
* @public */ - PolicyExistsCondition?: ExistCondition | undefined; + DPUHour?: number | undefined; +} +/** + * @public + */ +export interface ListCrawlsResponse { /** - *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 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 PutResourcePolicyResponse { +export interface ListCustomEntityTypesRequest { /** - *A hash of the policy that has just been set. This must - * be included in a subsequent call that overwrites or updates - * this policy.
+ *A paginated token to offset the results.
* @public */ - PolicyHash?: string | undefined; + NextToken?: string | undefined; + + /** + *The maximum number of results to return.
+ * @public + */ + MaxResults?: number | undefined; + + /** + *A list of key-value pair tags.
+ * @public + */ + Tags?: RecordA structure containing a key value pair for metadata.
* @public */ -export interface MetadataKeyValuePair { +export interface ListCustomEntityTypesResponse { /** - *A metadata key.
+ *A list of CustomEntityType
objects representing custom patterns.
A metadata key’s corresponding value.
+ *A pagination token, if more results are available.
* @public */ - MetadataValue?: string | undefined; + NextToken?: string | undefined; } /** + *Criteria used to return data quality results.
* @public */ -export interface PutSchemaVersionMetadataInput { +export interface DataQualityResultFilterCriteria { /** - *The unique ID for the schema.
+ *Filter results by the specified data source. For example, retrieving all results for an Glue table.
* @public */ - SchemaId?: SchemaId | undefined; + DataSource?: DataSource | undefined; /** - *The version number of the schema.
+ *Filter results by the specified job name.
* @public */ - SchemaVersionNumber?: SchemaVersionNumber | undefined; + JobName?: string | undefined; /** - *The unique version ID of the schema version.
+ *Filter results by the specified job run ID.
* @public */ - SchemaVersionId?: string | undefined; + JobRunId?: string | undefined; /** - *The metadata key's corresponding value.
+ *Filter results by runs that started after this time.
* @public */ - MetadataKeyValue: MetadataKeyValuePair | undefined; + StartedAfter?: Date | undefined; + + /** + *Filter results by runs that started before this time.
+ * @public + */ + StartedBefore?: Date | undefined; } /** * @public */ -export interface PutSchemaVersionMetadataResponse { +export interface ListDataQualityResultsRequest { /** - *The Amazon Resource Name (ARN) for the schema.
+ *The filter criteria.
* @public */ - SchemaArn?: string | undefined; + Filter?: DataQualityResultFilterCriteria | undefined; /** - *The name for the schema.
+ *A paginated token to offset the results.
* @public */ - SchemaName?: string | undefined; + NextToken?: string | undefined; /** - *The name for the registry.
+ *The maximum number of results to return.
* @public */ - RegistryName?: string | undefined; + MaxResults?: number | undefined; +} +/** + *Describes a data quality result.
+ * @public + */ +export interface DataQualityResultDescription { /** - *The latest version of the schema.
+ *The unique result ID for this data quality result.
* @public */ - LatestVersion?: boolean | undefined; + ResultId?: string | undefined; /** - *The version number of the schema.
+ *The table name associated with the data quality result.
* @public */ - VersionNumber?: number | undefined; + DataSource?: DataSource | undefined; /** - *The unique version ID of the schema version.
+ *The job name associated with the data quality result.
* @public */ - SchemaVersionId?: string | undefined; + JobName?: string | undefined; /** - *The metadata key.
+ *The job run ID associated with the data quality result.
* @public */ - MetadataKey?: string | undefined; + JobRunId?: string | undefined; /** - *The value of the metadata key.
+ *The time that the run started for this data quality result.
* @public */ - MetadataValue?: string | undefined; + StartedOn?: Date | undefined; } /** * @public */ -export interface PutWorkflowRunPropertiesRequest { +export interface ListDataQualityResultsResponse { /** - *Name of the workflow which was run.
+ *A list of DataQualityResultDescription
objects.
The ID of the workflow run for which the run properties should be updated.
+ *A pagination token, if more results are available.
* @public */ - RunId: string | undefined; + 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; /** - *The properties to put for the specified run.
+ *Filter based on time for results started before provided time.
* @public */ - RunProperties: RecordFilter based on time for results started after provided time.
+ * @public + */ + StartedAfter?: Date | undefined; } /** * @public */ -export interface PutWorkflowRunPropertiesResponse {} +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 QuerySchemaVersionMetadataInput { +export interface DataQualityRuleRecommendationRunDescription { /** - *A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
+ *The unique run identifier associated with this run.
* @public */ - SchemaId?: SchemaId | undefined; + RunId?: string | undefined; /** - *The version number of the schema.
+ *The status for this run.
* @public */ - SchemaVersionNumber?: SchemaVersionNumber | undefined; + Status?: TaskStatusType | undefined; /** - *The unique version ID of the schema version.
+ *The date and time when this run started.
* @public */ - SchemaVersionId?: string | undefined; + StartedOn?: Date | undefined; /** - *Search key-value pairs for metadata, if they are not provided all the metadata information will be fetched.
+ *The data source (Glue table) associated with the recommendation run.
* @public */ - MetadataList?: MetadataKeyValuePair[] | undefined; + DataSource?: DataSource | undefined; +} +/** + * @public + */ +export interface ListDataQualityRuleRecommendationRunsResponse { /** - *Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
+ *A list of DataQualityRuleRecommendationRunDescription
objects.
A continuation token, if this is a continuation call.
+ *A pagination token, if more results are available.
* @public */ NextToken?: string | undefined; } /** - *A structure containing other metadata for a schema version belonging to the same metadata key.
+ *The filter criteria.
* @public */ -export interface OtherMetadataValueListItem { +export interface DataQualityRulesetEvaluationRunFilter { /** - *The metadata key’s corresponding value for the other metadata belonging to the same metadata key.
+ *Filter based on a data source (an Glue table) associated with the run.
* @public */ - MetadataValue?: string | undefined; + DataSource: DataSource | undefined; /** - *The time at which the entry was created.
+ *Filter results by runs that started before this time.
* @public */ - CreatedTime?: string | undefined; + StartedBefore?: Date | undefined; + + /** + *Filter results by runs that started after this time.
+ * @public + */ + StartedAfter?: Date | undefined; } /** - *A structure containing metadata information for a schema version.
* @public */ -export interface MetadataInfo { +export interface ListDataQualityRulesetEvaluationRunsRequest { /** - *The metadata key’s corresponding value.
+ *The filter criteria.
* @public */ - MetadataValue?: string | undefined; + Filter?: DataQualityRulesetEvaluationRunFilter | undefined; /** - *The time at which the entry was created.
+ *A paginated token to offset the results.
* @public */ - CreatedTime?: string | undefined; + NextToken?: string | undefined; /** - *Other metadata belonging to the same metadata key.
+ *The maximum number of results to return.
* @public */ - OtherMetadataValueList?: OtherMetadataValueListItem[] | undefined; + MaxResults?: number | undefined; } /** + *Describes the result of a data quality ruleset evaluation run.
* @public */ -export interface QuerySchemaVersionMetadataResponse { +export interface DataQualityRulesetEvaluationRunDescription { /** - *A map of a metadata key and associated values.
+ *The unique run identifier associated with this run.
* @public */ - MetadataInfoMap?: RecordThe unique version ID of the schema version.
+ *The status for this run.
* @public */ - SchemaVersionId?: string | undefined; + Status?: TaskStatusType | undefined; /** - *A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
+ *The date and time when the run started.
* @public */ - NextToken?: string | undefined; + StartedOn?: Date | undefined; + + /** + *The data source (an Glue table) associated with the run.
+ * @public + */ + DataSource?: DataSource | undefined; } /** * @public */ -export interface RegisterSchemaVersionInput { +export interface ListDataQualityRulesetEvaluationRunsResponse { /** - *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.
A list of DataQualityRulesetEvaluationRunDescription
objects representing data quality ruleset runs.
The schema definition using the DataFormat
setting for the SchemaName
.
A pagination token, if more results are available.
* @public */ - SchemaDefinition: string | undefined; + NextToken?: string | undefined; } /** + *The criteria used to filter data quality rulesets.
* @public */ -export interface RegisterSchemaVersionResponse { +export interface DataQualityRulesetFilterCriteria { /** - *The unique ID that represents the version of this schema.
+ *The name of the ruleset filter criteria.
* @public */ - SchemaVersionId?: string | undefined; + Name?: string | undefined; /** - *The version of this schema (for sync flow only, in case this is the first version).
+ *The description of the ruleset filter criteria.
* @public */ - VersionNumber?: number | undefined; + Description?: string | undefined; /** - *The status of the schema version.
+ *Filter on rulesets created before this date.
* @public */ - Status?: SchemaVersionStatus | undefined; -} + CreatedBefore?: Date | undefined; -/** - * @public - */ -export interface RemoveSchemaVersionMetadataInput { /** - *A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
+ *Filter on rulesets created after this date.
* @public */ - SchemaId?: SchemaId | undefined; + CreatedAfter?: Date | undefined; /** - *The version number of the schema.
+ *Filter on rulesets last modified before this date.
* @public */ - SchemaVersionNumber?: SchemaVersionNumber | undefined; + LastModifiedBefore?: Date | undefined; /** - *The unique version ID of the schema version.
+ *Filter on rulesets last modified after this date.
* @public */ - SchemaVersionId?: string | undefined; + LastModifiedAfter?: Date | undefined; /** - *The value of the metadata key.
+ *The name and database name of the target table.
* @public */ - MetadataKeyValue: MetadataKeyValuePair | undefined; + TargetTable?: DataQualityTargetTable | undefined; } /** * @public */ -export interface RemoveSchemaVersionMetadataResponse { +export interface ListDataQualityRulesetsRequest { /** - *The Amazon Resource Name (ARN) of the schema.
+ *A paginated token to offset the results.
* @public */ - SchemaArn?: string | undefined; + NextToken?: string | undefined; /** - *The name of the schema.
+ *The maximum number of results to return.
* @public */ - SchemaName?: string | undefined; + MaxResults?: number | undefined; /** - *The name of the registry.
+ *The filter criteria.
* @public */ - RegistryName?: string | undefined; + Filter?: DataQualityRulesetFilterCriteria | undefined; /** - *The latest version of the schema.
+ *A list of key-value pair tags.
* @public */ - LatestVersion?: boolean | undefined; + Tags?: RecordDescribes a data quality ruleset returned by GetDataQualityRuleset
.
The version number of the schema.
+ *The name of the data quality ruleset.
* @public */ - VersionNumber?: number | undefined; + Name?: string | undefined; /** - *The version ID for the schema version.
+ *A description of the data quality ruleset.
* @public */ - SchemaVersionId?: string | undefined; + Description?: string | undefined; /** - *The metadata key.
+ *The date and time the data quality ruleset was created.
* @public */ - MetadataKey?: string | undefined; + CreatedOn?: Date | undefined; /** - *The value of the metadata key.
+ *The date and time the data quality ruleset was last modified.
* @public */ - MetadataValue?: string | undefined; -} + LastModifiedOn?: Date | undefined; -/** - * @public - */ -export interface ResetJobBookmarkRequest { /** - *The name of the job in question.
+ *An object representing an Glue table.
* @public */ - JobName: string | undefined; + TargetTable?: DataQualityTargetTable | undefined; /** - *The unique run identifier associated with this job run.
+ *When a ruleset was created from a recommendation run, this run ID is generated to link the two together.
* @public */ - RunId?: string | undefined; -} + RecommendationRunId?: string | undefined; -/** - * @public - */ -export interface ResetJobBookmarkResponse { /** - *The reset bookmark entry.
+ *The number of rules in the ruleset.
* @public */ - JobBookmarkEntry?: JobBookmarkEntry | undefined; + RuleCount?: number | undefined; } /** - *Too many jobs are being run concurrently.
* @public */ -export class ConcurrentRunsExceededException extends __BaseException { - readonly name: "ConcurrentRunsExceededException" = "ConcurrentRunsExceededException"; - readonly $fault: "client" = "client"; +export interface ListDataQualityRulesetsResponse { /** - *A message describing the problem.
+ *A paginated list of rulesets for the specified list of Glue tables.
* @public */ - Message?: string | undefined; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe workflow is in an invalid state to perform a requested operation.
- * @public - */ -export class IllegalWorkflowStateException extends __BaseException { - readonly name: "IllegalWorkflowStateException" = "IllegalWorkflowStateException"; - readonly $fault: "client" = "client"; /** - *A message describing the problem.
+ *A pagination token, if more results are available.
* @public */ - Message?: string | undefined; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeA timestamp filter.
* @public */ -export interface ResumeWorkflowRunRequest { - /** - *The name of the workflow to resume.
- * @public - */ - Name: string | undefined; - +export interface TimestampFilter { /** - *The ID of the workflow run to resume.
+ *The timestamp before which statistics should be included in the results.
* @public */ - RunId: string | undefined; + RecordedBefore?: Date | 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.
+ *The timestamp after which statistics should be included in the results.
* @public */ - NodeIds: string[] | undefined; + RecordedAfter?: Date | undefined; } /** * @public */ -export interface ResumeWorkflowRunResponse { +export interface ListDataQualityStatisticAnnotationsRequest { /** - *The new ID assigned to the resumed workflow run. Each resume of a workflow run will have a new run ID.
+ *The Statistic ID.
* @public */ - RunId?: string | undefined; + StatisticId?: string | undefined; /** - *A list of the node IDs for the nodes that were actually restarted.
+ *The Profile ID.
* @public */ - NodeIds?: string[] | undefined; -} + ProfileId?: string | undefined; -/** - * @public - */ -export interface RunStatementRequest { /** - *The Session Id of the statement to be run.
+ *A timestamp filter.
* @public */ - SessionId: string | undefined; + TimestampFilter?: TimestampFilter | undefined; /** - *The statement code to be run.
+ *The maximum number of results to return in this request.
* @public */ - Code: string | undefined; + MaxResults?: number | undefined; /** - *The origin of the request.
+ *A pagination token to retrieve the next set of results.
* @public */ - RequestOrigin?: string | undefined; + NextToken?: string | undefined; } /** * @public */ -export interface RunStatementResponse { +export interface ListDataQualityStatisticAnnotationsResponse { /** - *Returns the Id of the statement that was run.
+ *A list of StatisticAnnotation
applied to the Statistic
A pagination token to retrieve the next set of results.
+ * @public + */ + NextToken?: string | undefined; +} /** * @public */ -export type Comparator = (typeof Comparator)[keyof typeof Comparator]; +export interface ListDataQualityStatisticsRequest { + /** + *The Statistic ID.
+ * @public + */ + StatisticId?: string | undefined; -/** - *Defines a property predicate.
- * @public - */ -export interface PropertyPredicate { /** - *The key of the property.
+ *The Profile ID.
* @public */ - Key?: string | undefined; + ProfileId?: string | undefined; /** - *The value of the property.
+ *A timestamp filter.
* @public */ - Value?: string | undefined; + TimestampFilter?: TimestampFilter | undefined; /** - *The comparator used to compare this property to others.
+ *The maximum number of results to return in this request.
* @public */ - Comparator?: Comparator | undefined; + MaxResults?: number | undefined; + + /** + *A pagination token to request the next page of results.
+ * @public + */ + NextToken?: string | undefined; } /** * @public * @enum */ -export const Sort = { - ASCENDING: "ASC", - DESCENDING: "DESC", +export const StatisticEvaluationLevel = { + COLUMN: "Column", + DATASET: "Dataset", + MULTICOLUMN: "Multicolumn", } as const; /** * @public */ -export type Sort = (typeof Sort)[keyof typeof Sort]; +export type StatisticEvaluationLevel = (typeof StatisticEvaluationLevel)[keyof typeof StatisticEvaluationLevel]; /** - *Specifies a field to sort by and a sort order.
+ *A run identifier.
* @public */ -export interface SortCriterion { +export interface RunIdentifier { /** - *The name of the field on which to sort.
+ *The Run ID.
* @public */ - FieldName?: string | undefined; + RunId?: string | undefined; /** - *An ascending or descending sort.
+ *The Job Run ID.
* @public */ - Sort?: Sort | undefined; + JobRunId?: string | undefined; } /** + *Summary information about a statistic.
* @public */ -export interface SearchTablesRequest { +export interface StatisticSummary { /** - *A unique identifier, consisting of
- * account_id
- *
.
The Statistic ID.
* @public */ - CatalogId?: string | undefined; + StatisticId?: string | undefined; /** - *A continuation token, included if this is a continuation call.
+ *The Profile ID.
* @public */ - NextToken?: string | undefined; + ProfileId?: string | undefined; + + /** + *The Run Identifier
+ * @public + */ + RunIdentifier?: RunIdentifier | 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.
The name of the statistic.
* @public */ - Filters?: PropertyPredicate[] | undefined; + StatisticName?: string | undefined; /** - *A string used for a text search.
- *Specifying a value in quotes filters based on an exact match to the value.
+ *The value of the statistic.
* @public */ - SearchText?: string | undefined; + DoubleValue?: number | undefined; /** - *A list of criteria for sorting the results by a field name, in an ascending or descending order.
+ *The evaluation level of the statistic. Possible values: Dataset
, Column
, Multicolumn
.
The maximum number of tables to return in a single response.
+ *The list of columns referenced by the statistic.
* @public */ - MaxResults?: number | undefined; + ColumnsReferenced?: string[] | 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.
The list of datasets referenced by the statistic.
* @public */ - ResourceShareType?: ResourceShareType | undefined; + ReferencedDatasets?: string[] | undefined; /** - *Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.
+ *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; } /** - *The blueprint is in an invalid state to perform a requested operation.
* @public */ -export class IllegalBlueprintStateException extends __BaseException { - readonly name: "IllegalBlueprintStateException" = "IllegalBlueprintStateException"; - readonly $fault: "client" = "client"; +export interface ListDataQualityStatisticsResponse { /** - *A message describing the problem.
+ *A StatisticSummaryList
.
A pagination token to request the next page of results.
+ * @public */ - constructor(opts: __ExceptionOptionTypeThe name of the blueprint.
+ *A continuation token, if this is a continuation request.
* @public */ - BlueprintName: string | undefined; + NextToken?: string | undefined; /** - *Specifies the parameters as a BlueprintParameters
object.
The maximum size of a list to return.
* @public */ - Parameters?: string | undefined; + MaxResults?: number | undefined; /** - *Specifies the IAM role used to create the workflow.
+ *Specifies to return only these tagged resources.
* @public */ - RoleArn: string | undefined; + Tags?: RecordThe names of all the DevEndpoint
s in the account, or the
+ * DevEndpoint
s with the specified tags.
The run ID for this blueprint run.
+ *A continuation token, if the returned list does not contain the + * last metric available.
* @public */ - RunId?: string | undefined; + NextToken?: string | undefined; } /** * @public */ -export interface StartColumnStatisticsTaskRunRequest { +export interface ListEntitiesRequest { /** - *The name of the database where the table resides.
+ *A name for the connection that has required credentials to query any connection type.
* @public */ - DatabaseName: string | undefined; + ConnectionName?: string | undefined; /** - *The name of the table to generate statistics.
+ *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 */ - TableName: string | undefined; + CatalogId?: 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.
+ *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 */ - ColumnNameList?: string[] | undefined; + ParentEntityName?: string | undefined; /** - *The IAM role that the service assumes to generate statistics.
+ *A continuation token, included if this is a continuation call.
* @public */ - Role: string | undefined; + NextToken?: string | undefined; /** - *The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
+ *The API version of the SaaS connector.
* @public */ - SampleSize?: number | undefined; + DataStoreApiVersion?: string | undefined; +} +/** + *An entity supported by a given ConnectionType
.
The ID of the Data Catalog where the table reside. If none is supplied, the Amazon Web Services account ID is used by default.
+ *The name of the entity.
* @public */ - CatalogID?: string | undefined; + EntityName?: string | undefined; /** - *Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
+ *Label used for the entity.
* @public */ - SecurityConfiguration?: string | undefined; + 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.
The identifier for the column statistics task run.
+ *A continuation token, present if the current segment is not the last.
* @public */ - ColumnStatisticsTaskRunId?: string | undefined; + NextToken?: string | undefined; } /** * @public */ -export interface StartColumnStatisticsTaskRunScheduleRequest { +export interface ListJobsRequest { /** - *The name of the database where the table resides.
+ *A continuation token, if this is a continuation request.
* @public */ - DatabaseName: string | undefined; + NextToken?: string | undefined; /** - *The name of the table for which to start a column statistic task run schedule.
+ *The maximum size of a list to return.
* @public */ - TableName: string | undefined; + 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; -/** - * @public - */ -export interface StartCrawlerRequest { /** - *Name of the crawler to start.
+ *A continuation token, if the returned list does not contain the + * last metric available.
* @public */ - Name: string | undefined; + NextToken?: string | undefined; } /** * @public */ -export interface StartCrawlerResponse {} +export interface ListMLTransformsRequest { + /** + *A continuation token, if this is a continuation request.
+ * @public + */ + NextToken?: string | undefined; -/** - *There is no applicable schedule.
- * @public - */ -export class NoScheduleException extends __BaseException { - readonly name: "NoScheduleException" = "NoScheduleException"; - readonly $fault: "client" = "client"; /** - *A message describing the problem.
+ *The maximum size of a list to return.
* @public */ - Message?: string | undefined; + MaxResults?: number | undefined; + /** - * @internal + *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 specified scheduler is already running.
* @public */ -export class SchedulerRunningException extends __BaseException { - readonly name: "SchedulerRunningException" = "SchedulerRunningException"; - readonly $fault: "client" = "client"; +export interface ListMLTransformsResponse { /** - *A message describing the problem.
+ *The identifiers of all the machine learning transforms in the account, or the + * machine learning transforms with the specified tags.
* @public */ - Message?: string | undefined; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeName of the crawler to schedule.
+ *A continuation token, if the returned list does not contain the + * last metric available.
* @public */ - CrawlerName: string | undefined; + NextToken?: string | undefined; } /** * @public */ -export interface StartCrawlerScheduleResponse {} +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; -/** - * @public - */ -export interface StartDataQualityRuleRecommendationRunRequest { /** - *The data source (Glue table) associated with this run.
+ *A continuation token, if this is a continuation call.
* @public */ - DataSource: DataSource | undefined; + NextToken?: string | undefined; +} +/** + *A structure containing the details for a registry.
+ * @public + */ +export interface RegistryListItem { /** - *An IAM role supplied to encrypt the results of the run.
+ *The name of the registry.
* @public */ - Role: string | undefined; + RegistryName?: string | undefined; /** - *The number of G.1X
workers to be used in the run. The default is 5.
The Amazon Resource Name (ARN) of the registry.
* @public */ - NumberOfWorkers?: number | undefined; + RegistryArn?: string | undefined; /** - *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 description of the registry.
* @public */ - Timeout?: number | undefined; + Description?: string | undefined; /** - *A name for the ruleset.
+ *The status of the registry.
* @public */ - CreatedRulesetName?: string | undefined; + Status?: RegistryStatus | undefined; /** - *The name of the security configuration created with the data quality encryption option.
+ *The data the registry was created.
* @public */ - DataQualitySecurityConfiguration?: string | undefined; + CreatedTime?: 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.
+ *The date the registry was updated.
* @public */ - ClientToken?: string | undefined; + UpdatedTime?: string | undefined; } /** * @public */ -export interface StartDataQualityRuleRecommendationRunResponse { +export interface ListRegistriesResponse { /** - *The unique run identifier associated with this run.
+ *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 StartDataQualityRulesetEvaluationRunRequest { +export interface ListSchemasInput { /** - *The data source (Glue table) associated with this run.
+ *A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
* @public */ - DataSource: DataSource | undefined; + RegistryId?: RegistryId | undefined; /** - *An IAM role supplied to encrypt the results of the run.
+ *Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
* @public */ - Role: string | undefined; + MaxResults?: number | undefined; /** - *The number of G.1X
workers to be used in the run. The default is 5.
A continuation token, if this is a continuation call.
* @public */ - NumberOfWorkers?: number | undefined; + NextToken?: string | undefined; +} +/** + *An object that contains minimal details for a schema.
+ * @public + */ +export interface SchemaListItem { /** - *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).
the name of the registry where the schema resides.
* @public */ - Timeout?: number | undefined; + RegistryName?: 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.
+ *The name of the schema.
* @public */ - ClientToken?: string | undefined; + SchemaName?: string | undefined; /** - *Additional run options you can specify for an evaluation run.
+ *The Amazon Resource Name (ARN) for the schema.
* @public */ - AdditionalRunOptions?: DataQualityEvaluationRunAdditionalRunOptions | undefined; + SchemaArn?: string | undefined; /** - *A list of ruleset names.
+ *A description for the schema.
* @public */ - RulesetNames: string[] | undefined; + Description?: string | undefined; /** - *A map of reference strings to additional data sources you can specify for an evaluation run.
+ *The status of the schema.
* @public */ - AdditionalDataSources?: RecordThe unique run identifier associated with this run.
+ *The date and time that a schema was created.
* @public */ - RunId?: string | undefined; + CreatedTime?: string | undefined; + + /** + *The date and time that a schema was updated.
+ * @public + */ + UpdatedTime?: string | undefined; } /** * @public */ -export interface StartExportLabelsTaskRunRequest { +export interface ListSchemasResponse { /** - *The unique identifier of the machine learning transform.
+ *An array of SchemaListItem
objects containing details of each schema.
The Amazon S3 path where you export the labels.
+ *A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
* @public */ - OutputS3Path: string | undefined; + NextToken?: string | undefined; } /** * @public */ -export interface StartExportLabelsTaskRunResponse { +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.
The unique identifier for the task run.
+ *Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
* @public */ - TaskRunId?: string | undefined; + 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 StartImportLabelsTaskRunRequest { +export interface SchemaVersionListItem { /** - *The unique identifier of the machine learning transform.
+ *The Amazon Resource Name (ARN) of the schema.
* @public */ - TransformId: string | undefined; + SchemaArn?: string | undefined; /** - *The Amazon Simple Storage Service (Amazon S3) path from where you import the - * labels.
+ *The unique identifier of the schema version.
* @public */ - InputS3Path: string | undefined; + SchemaVersionId?: string | undefined; /** - *Indicates whether to overwrite your existing labels.
+ *The version number of the schema.
* @public */ - ReplaceAllLabels?: boolean | undefined; -} + VersionNumber?: number | undefined; -/** - * @public - */ -export interface StartImportLabelsTaskRunResponse { /** - *The unique identifier for the task run.
+ *The status of the schema version.
* @public */ - TaskRunId?: string | undefined; + Status?: SchemaVersionStatus | undefined; + + /** + *The date and time the schema version was created.
+ * @public + */ + CreatedTime?: string | undefined; } /** * @public */ -export interface StartJobRunRequest { +export interface ListSchemaVersionsResponse { /** - *The name of the job definition to use.
+ *An array of SchemaVersionList
objects containing details of each schema version.
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.
+ *A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
* @public */ - JobRunQueuingEnabled?: boolean | undefined; + NextToken?: string | undefined; +} +/** + * @public + */ +export interface ListSessionsRequest { /** - *The ID of a previous JobRun
to retry.
The token for the next set of results, or null if there are no more result.
* @public */ - JobRunId?: string | undefined; + NextToken?: string | undefined; /** - *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.
+ *The maximum number of results.
* @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.
+ *Tags belonging to the session.
* @public */ - AllocatedCapacity?: number | undefined; + Tags?: RecordThe 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.
Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
+ *The origin of the request.
* @public */ - Timeout?: number | undefined; + RequestOrigin?: string | undefined; +} +/** + * @public + */ +export interface ListSessionsResponse { /** - *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.
Returns the ID of the session.
* @public */ - MaxCapacity?: number | undefined; + Ids?: string[] | undefined; /** - *The name of the SecurityConfiguration
structure to be used with this job
- * run.
Returns the session object.
* @public */ - SecurityConfiguration?: string | undefined; + Sessions?: Session[] | undefined; /** - *Specifies configuration properties of a job run notification.
+ *The token for the next set of results, or null if there are no more result.
* @public */ - NotificationProperty?: NotificationProperty | undefined; + NextToken?: string | undefined; +} +/** + * @public + */ +export interface ListStatementsRequest { /** - *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 84GB disk (approximately 34GB free), 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 128GB disk (approximately 77GB free), 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 (approximately 235GB free), 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 (approximately 487GB free), 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 (approximately 34GB free), 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 streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The Session ID of the statements.
* @public */ - WorkerType?: WorkerType | undefined; + SessionId: string | undefined; /** - *The number of workers of a defined workerType
that are allocated when a job runs.
The origin of the request to list statements.
* @public */ - NumberOfWorkers?: number | undefined; + RequestOrigin?: string | undefined; /** - *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.
A continuation token, if this is a continuation call.
* @public */ - ExecutionClass?: ExecutionClass | undefined; + NextToken?: string | undefined; } /** * @public */ -export interface StartJobRunResponse { +export interface ListStatementsResponse { /** - *The ID assigned to this job run.
+ *Returns the list of statements.
* @public */ - JobRunId?: string | undefined; + Statements?: Statement[] | undefined; + + /** + *A continuation token, if not all statements have yet been returned.
+ * @public + */ + NextToken?: string | undefined; } /** - *The machine learning transform is not ready to run.
* @public */ -export class MLTransformNotReadyException extends __BaseException { - readonly name: "MLTransformNotReadyException" = "MLTransformNotReadyException"; - readonly $fault: "client" = "client"; +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; + /** - *A message describing the problem.
+ *The type of table optimizer.
* @public */ - Message?: string | undefined; + Type: TableOptimizerType | undefined; + /** - * @internal + *The maximum number of optimizer runs to return on each call.
+ * @public */ - constructor(opts: __ExceptionOptionTypeThe unique identifier of the machine learning transform.
+ *A continuation token, if this is a continuation call.
* @public */ - TransformId: string | undefined; + NextToken?: string | undefined; } /** * @public */ -export interface StartMLEvaluationTaskRunResponse { +export interface ListTableOptimizerRunsResponse { /** - *The unique identifier associated with this run.
+ *The Catalog ID of the table.
* @public */ - TaskRunId?: string | undefined; -} + CatalogId?: string | undefined; -/** - * @public - */ -export interface StartMLLabelingSetGenerationTaskRunRequest { /** - *The unique identifier of the machine learning transform.
+ *The name of the database in the catalog in which the table resides.
* @public */ - TransformId: string | undefined; + DatabaseName?: string | undefined; /** - *The Amazon Simple Storage Service (Amazon S3) path where you generate the labeling - * set.
+ *The name of the table.
* @public */ - OutputS3Path: string | undefined; -} + TableName?: string | undefined; -/** - * @public - */ -export interface StartMLLabelingSetGenerationTaskRunResponse { /** - *The unique run identifier that is associated with this task run.
+ *A continuation token for paginating the returned list of optimizer runs, returned if the current segment of the list is not the last.
* @public */ - TaskRunId?: string | undefined; -} + NextToken?: string | undefined; -/** - * @public - */ -export interface StartTriggerRequest { /** - *The name of the trigger to start.
+ *A list of the optimizer runs associated with a table.
* @public */ - Name: string | undefined; + TableOptimizerRuns?: TableOptimizerRun[] | undefined; } /** * @public */ -export interface StartTriggerResponse { +export interface ListTriggersRequest { /** - *The name of the trigger that was started.
+ *A continuation token, if this is a continuation request.
* @public */ - Name?: string | undefined; -} + NextToken?: string | undefined; -/** - * @public - */ -export interface StartWorkflowRunRequest { /** - *The name of the workflow to start.
+ *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 */ - Name: string | undefined; + DependentJobName?: string | undefined; /** - *The workflow run properties for the new workflow run.
+ *The maximum size of a list to return.
* @public */ - RunProperties?: RecordAn Id for the new run.
+ *Specifies to return only these tagged resources.
* @public */ - RunId?: string | undefined; + Tags?: RecordAn exception thrown when you try to stop a task run when there is no task running.
* @public */ -export class ColumnStatisticsTaskNotRunningException extends __BaseException { - readonly name: "ColumnStatisticsTaskNotRunningException" = "ColumnStatisticsTaskNotRunningException"; - readonly $fault: "client" = "client"; +export interface ListTriggersResponse { /** - *A message describing the problem.
+ *The names of all triggers in the account, or the triggers with the specified tags.
* @public */ - Message?: string | undefined; + TriggerNames?: string[] | undefined; + /** - * @internal + *A continuation token, if the returned list does not contain the + * last metric available.
+ * @public */ - constructor(opts: __ExceptionOptionTypeAn exception thrown when you try to stop a task run.
* @public */ -export class ColumnStatisticsTaskStoppingException extends __BaseException { - readonly name: "ColumnStatisticsTaskStoppingException" = "ColumnStatisticsTaskStoppingException"; - readonly $fault: "client" = "client"; +export interface ListUsageProfilesRequest { /** - *A message describing the problem.
+ *A continuation token, included if this is a continuation call.
* @public */ - Message?: string | undefined; + NextToken?: string | undefined; + /** - * @internal + *The maximum number of usage profiles to return in a single response.
+ * @public */ - constructor(opts: __ExceptionOptionTypeDescribes an Glue usage profile.
* @public */ -export interface StopColumnStatisticsTaskRunRequest { +export interface UsageProfileDefinition { /** - *The name of the database where the table resides.
+ *The name of the usage profile.
* @public */ - DatabaseName: string | undefined; + Name?: string | undefined; /** - *The name of the table.
+ *A description of the usage profile.
* @public */ - TableName: string | undefined; -} - -/** - * @public - */ -export interface StopColumnStatisticsTaskRunResponse {} + Description?: string | undefined; -/** - * @public - */ -export interface StopColumnStatisticsTaskRunScheduleRequest { /** - *The name of the database where the table resides.
+ *The date and time when the usage profile was created.
* @public */ - DatabaseName: string | undefined; + CreatedOn?: Date | undefined; /** - *The name of the table for which to stop a column statistic task run schedule.
+ *The date and time when the usage profile was last modified.
* @public */ - TableName: string | undefined; + LastModifiedOn?: Date | undefined; } /** * @public */ -export interface StopColumnStatisticsTaskRunScheduleResponse {} - -/** - *The specified crawler is not running.
- * @public - */ -export class CrawlerNotRunningException extends __BaseException { - readonly name: "CrawlerNotRunningException" = "CrawlerNotRunningException"; - readonly $fault: "client" = "client"; +export interface ListUsageProfilesResponse { /** - *A message describing the problem.
+ *A list of usage profile (UsageProfileDefinition
) objects.
A continuation token, present if the current list segment is not the last.
+ * @public */ - constructor(opts: __ExceptionOptionTypeThe specified crawler is stopping.
* @public */ -export class CrawlerStoppingException extends __BaseException { - readonly name: "CrawlerStoppingException" = "CrawlerStoppingException"; - readonly $fault: "client" = "client"; +export interface ListWorkflowsRequest { /** - *A message describing the problem.
+ *A continuation token, if this is a continuation request.
* @public */ - Message?: string | undefined; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeName of the crawler to stop.
+ *The maximum size of a list to return.
* @public */ - Name: string | undefined; + MaxResults?: number | undefined; } /** * @public */ -export interface StopCrawlerResponse {} - -/** - *The specified scheduler is not running.
- * @public - */ -export class SchedulerNotRunningException extends __BaseException { - readonly name: "SchedulerNotRunningException" = "SchedulerNotRunningException"; - readonly $fault: "client" = "client"; +export interface ListWorkflowsResponse { /** - *A message describing the problem.
+ *List of names of workflows in the account.
* @public */ - Message?: string | undefined; + Workflows?: string[] | undefined; + /** - * @internal + *A continuation token, if not all workflow names have been returned.
+ * @public */ - constructor(opts: __ExceptionOptionTypeName of the crawler whose schedule state to set.
+ *The Amazon Resource Name (ARN) for the integration.
* @public */ - CrawlerName: string | undefined; -} + IntegrationIdentifier: string | undefined; -/** - * @public - */ -export interface StopCrawlerScheduleResponse {} - -/** - * @public - */ -export interface StopSessionRequest { /** - *The ID of the session to be stopped.
+ *A description of the integration.
* @public */ - Id: string | undefined; + Description?: string | undefined; /** - *The origin of the request.
+ *Selects source tables for the integration using Maxwell filter syntax.
* @public */ - RequestOrigin?: string | undefined; -} + DataFilter?: string | undefined; -/** - * @public - */ -export interface StopSessionResponse { /** - *Returns the Id of the stopped session.
+ *A unique name for an integration in Glue.
* @public */ - Id?: string | undefined; + IntegrationName?: string | undefined; } /** * @public */ -export interface StopTriggerRequest { +export interface ModifyIntegrationResponse { /** - *The name of the trigger to stop.
+ *The ARN of the source for the integration.
* @public */ - Name: string | undefined; -} + SourceArn: string | undefined; -/** - * @public - */ -export interface StopTriggerResponse { /** - *The name of the trigger that was stopped.
+ *The ARN of the target for the integration.
* @public */ - Name?: string | undefined; -} + TargetArn: string | undefined; -/** - * @public - */ -export interface StopWorkflowRunRequest { /** - *The name of the workflow to stop.
+ *A unique name for an integration in Glue.
* @public */ - Name: string | undefined; + IntegrationName: string | undefined; /** - *The ID of the workflow run to stop.
+ *A description of the integration.
* @public */ - RunId: string | undefined; -} - -/** - * @public - */ -export interface StopWorkflowRunResponse {} + Description?: string | undefined; -/** - * @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.
+ *The Amazon Resource Name (ARN) for the integration.
* @public */ - ResourceArn: string | undefined; + IntegrationArn: string | undefined; /** - *Tags to add to this resource.
+ *The ARN of a KMS key used for encrypting the channel.
* @public */ - TagsToAdd: RecordAn optional set of non-secret key–value pairs that contains additional contextual information for encryption.
+ * @public + */ + AdditionalEncryptionContext?: 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.
Metadata assigned to the resource consisting of a list of key-value pairs.
* @public */ - ConnectionType: ConnectionType | undefined; + Tags?: Tag[] | undefined; /** - *The key-value pairs that define parameters for the connection.
- *JDBC connections use the following connection properties:
+ *The status of the integration being modified.
+ *The possible statuses are:
*Required: All of (HOST
, PORT
, JDBC_ENGINE
) or JDBC_CONNECTION_URL
.
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.
*Required: All of (USERNAME
, PASSWORD
) or SECRET_ID
.
SYNCING: The integration is synchronizing.
*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.
NEEDS_ATTENTION: The integration needs attention, such as synchronization.
*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.
+ *The time when the integration was created, in UTC.
* @public */ - AuthenticationConfiguration?: AuthenticationConfigurationInput | undefined; + 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; } /** * @public */ -export interface TestConnectionRequest { +export interface PutDataCatalogEncryptionSettingsRequest { /** - *Optional. The name of the connection to test. If only name is provided, the operation will get the connection and use that for testing.
+ *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 */ - ConnectionName?: string | undefined; + CatalogId?: string | undefined; /** - *A structure that is used to specify testing a connection to a service.
+ *The security configuration to set.
* @public */ - TestConnectionInput?: TestConnectionInput | undefined; + DataCatalogEncryptionSettings: DataCatalogEncryptionSettings | undefined; } /** * @public */ -export interface TestConnectionResponse {} +export interface PutDataCatalogEncryptionSettingsResponse {} /** * @public */ -export interface UntagResourceRequest { +export interface PutDataQualityProfileAnnotationRequest { /** - *The Amazon Resource Name (ARN) of the resource from which to remove the tags.
+ *The ID of the data quality monitoring profile to annotate.
* @public */ - ResourceArn: string | undefined; + ProfileId: string | undefined; /** - *Tags to remove from this resource.
+ *The inclusion annotation value to apply to the profile.
* @public */ - TagsToRemove: string[] | undefined; + InclusionAnnotation: InclusionAnnotationValue | undefined; } +/** + *Left blank.
+ * @public + */ +export interface PutDataQualityProfileAnnotationResponse {} + +/** + * @public + * @enum + */ +export const EnableHybridValues = { + FALSE: "FALSE", + TRUE: "TRUE", +} as const; + +/** + * @public + */ +export type EnableHybridValues = (typeof EnableHybridValues)[keyof typeof EnableHybridValues]; + +/** + * @public + * @enum + */ +export const ExistCondition = { + MUST_EXIST: "MUST_EXIST", + NONE: "NONE", + NOT_EXIST: "NOT_EXIST", +} as const; + /** * @public */ -export interface UntagResourceResponse {} +export type ExistCondition = (typeof ExistCondition)[keyof typeof ExistCondition]; /** * @public */ -export interface UpdateBlueprintRequest { +export interface PutResourcePolicyRequest { /** - *The name of the blueprint.
+ *Contains the policy document to set, in JSON format.
* @public */ - Name: string | undefined; + PolicyInJson: string | undefined; /** - *A description of the blueprint.
+ *Do not use. For internal use only.
* @public */ - Description?: string | undefined; + 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.
Specifies a path in Amazon S3 where the blueprint is published.
+ *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'.
Returns the name of the blueprint that was updated.
+ *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 */ - Name?: string | undefined; + PolicyHash?: string | undefined; } /** - *Specifies a custom CSV classifier to be updated.
+ *A structure containing a key value pair for metadata.
* @public */ -export interface UpdateCsvClassifierRequest { +export interface MetadataKeyValuePair { /** - *The name of the classifier.
+ *A metadata key.
* @public */ - Name: string | undefined; + MetadataKey?: string | undefined; /** - *A custom symbol to denote what separates each column entry in the row.
+ *A metadata key’s corresponding value.
* @public */ - Delimiter?: string | undefined; + MetadataValue?: string | undefined; +} +/** + * @public + */ +export interface PutSchemaVersionMetadataInput { /** - *A custom symbol to denote what combines content into a single column value. It must be - * different from the column delimiter.
+ *The unique ID for the schema.
* @public */ - QuoteSymbol?: string | undefined; + SchemaId?: SchemaId | undefined; /** - *Indicates whether the CSV file contains a header.
+ *The version number of the schema.
* @public */ - ContainsHeader?: CsvHeaderOption | undefined; + SchemaVersionNumber?: SchemaVersionNumber | undefined; /** - *A list of strings representing column names.
+ *The unique version ID of the schema version.
* @public */ - Header?: string[] | undefined; + SchemaVersionId?: string | undefined; /** - *Specifies not to trim values before identifying the type of column values. The default value is true.
+ *The metadata key's corresponding value.
* @public */ - DisableValueTrimming?: boolean | undefined; + MetadataKeyValue: MetadataKeyValuePair | undefined; +} +/** + * @public + */ +export interface PutSchemaVersionMetadataResponse { /** - *Enables the processing of files that contain only one column.
+ *The Amazon Resource Name (ARN) for the schema.
* @public */ - AllowSingleColumn?: boolean | undefined; + SchemaArn?: string | undefined; /** - *Specifies the configuration of custom datatypes.
+ *The name for the schema.
* @public */ - CustomDatatypeConfigured?: boolean | undefined; + SchemaName?: string | undefined; /** - *Specifies a list of supported custom datatypes.
+ *The name for the registry.
* @public */ - CustomDatatypes?: string[] | undefined; + RegistryName?: 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.
The latest version of the schema.
* @public */ - Serde?: CsvSerdeOption | undefined; -} + LatestVersion?: boolean | undefined; -/** - *Specifies a grok classifier to update when passed to
- * UpdateClassifier
.
The name of the GrokClassifier
.
The version number of the schema.
* @public */ - Name: string | undefined; + VersionNumber?: number | undefined; /** - *An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, - * Amazon CloudWatch Logs, and so on.
+ *The unique version ID of the schema version.
* @public */ - Classification?: string | undefined; + SchemaVersionId?: string | undefined; /** - *The grok pattern used by this classifier.
+ *The metadata key.
* @public */ - GrokPattern?: string | undefined; + MetadataKey?: string | undefined; /** - *Optional custom grok patterns used by this classifier.
+ *The value of the metadata key.
* @public */ - CustomPatterns?: string | undefined; + MetadataValue?: string | undefined; } /** - *Specifies a JSON classifier to be updated.
* @public */ -export interface UpdateJsonClassifierRequest { +export interface PutWorkflowRunPropertiesRequest { /** - *The name of the classifier.
+ *Name of the workflow which was run.
* @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.
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.
* @public */ - JsonPath?: string | undefined; + RunProperties: RecordSpecifies an XML classifier to be updated.
* @public */ -export interface UpdateXMLClassifierRequest { - /** - *The name of the classifier.
- * @public - */ - Name: string | undefined; +export interface PutWorkflowRunPropertiesResponse {} +/** + * @public + */ +export interface QuerySchemaVersionMetadataInput { /** - *An identifier of the data format that the classifier matches.
+ *A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
* @public */ - Classification?: string | undefined; + SchemaId?: SchemaId | 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,
is okay, but
- *
is not).
The version number of the schema.
* @public */ - RowTag?: string | undefined; -} + SchemaVersionNumber?: SchemaVersionNumber | undefined; -/** - * @public - */ -export interface UpdateClassifierRequest { /** - *A GrokClassifier
object with updated fields.
The unique version ID of the schema version.
* @public */ - GrokClassifier?: UpdateGrokClassifierRequest | undefined; + SchemaVersionId?: string | undefined; /** - *An XMLClassifier
object with updated fields.
Search key-value pairs for metadata, if they are not provided all the metadata information will be fetched.
* @public */ - XMLClassifier?: UpdateXMLClassifierRequest | undefined; + MetadataList?: MetadataKeyValuePair[] | undefined; /** - *A JsonClassifier
object with updated fields.
Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
* @public */ - JsonClassifier?: UpdateJsonClassifierRequest | undefined; + MaxResults?: number | undefined; /** - *A CsvClassifier
object with updated fields.
A continuation token, if this is a continuation call.
* @public */ - CsvClassifier?: UpdateCsvClassifierRequest | undefined; + NextToken?: string | undefined; } /** + *A structure containing other metadata for a schema version belonging to the same metadata key.
* @public */ -export interface UpdateClassifierResponse {} - -/** - *There was a version conflict.
- * @public - */ -export class VersionMismatchException extends __BaseException { - readonly name: "VersionMismatchException" = "VersionMismatchException"; - readonly $fault: "client" = "client"; +export interface OtherMetadataValueListItem { /** - *A message describing the problem.
+ *The metadata key’s corresponding value for the other metadata belonging to the same metadata key.
* @public */ - Message?: string | undefined; + MetadataValue?: string | undefined; + /** - * @internal + *The time at which the entry was created.
+ * @public */ - constructor(opts: __ExceptionOptionTypeA structure containing metadata information for a schema version.
* @public */ -export interface UpdateColumnStatisticsForPartitionRequest { +export interface MetadataInfo { /** - *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.
+ *The metadata key’s corresponding value.
* @public */ - CatalogId?: string | undefined; + MetadataValue?: string | undefined; /** - *The name of the catalog database where the partitions reside.
+ *The time at which the entry was created.
* @public */ - DatabaseName: string | undefined; + CreatedTime?: string | undefined; /** - *The name of the partitions' table.
+ *Other metadata belonging to the same metadata key.
* @public */ - TableName: string | undefined; + OtherMetadataValueList?: OtherMetadataValueListItem[] | undefined; +} +/** + * @public + */ +export interface QuerySchemaVersionMetadataResponse { /** - *A list of partition values identifying the partition.
+ *A map of a metadata key and associated values.
* @public */ - PartitionValues: string[] | undefined; + MetadataInfoMap?: RecordThe unique version ID of the schema version.
+ * @public + */ + SchemaVersionId?: string | undefined; /** - *A list of the column statistics.
+ *A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
* @public */ - ColumnStatisticsList: ColumnStatistics[] | undefined; + NextToken?: string | undefined; } /** - *Encapsulates a ColumnStatistics
object that failed and the reason for failure.
The ColumnStatistics
of the column.
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.
An error message with the reason for the failure of an operation.
+ *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; + /** - *Error occurred during updating column statistics data.
+ *The status of the schema version.
* @public */ - Errors?: ColumnStatisticsError[] | undefined; + Status?: SchemaVersionStatus | 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; - +export interface RemoveSchemaVersionMetadataInput { /** - *The name of the catalog database where the partitions reside.
+ *A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
* @public */ - DatabaseName: string | undefined; + SchemaId?: SchemaId | undefined; /** - *The name of the partitions' table.
+ *The version number of the schema.
* @public */ - TableName: string | undefined; + SchemaVersionNumber?: SchemaVersionNumber | undefined; /** - *A list of the column statistics.
+ *The unique version ID of the schema version.
* @public */ - ColumnStatisticsList: ColumnStatistics[] | undefined; -} + SchemaVersionId?: string | undefined; -/** - * @public - */ -export interface UpdateColumnStatisticsForTableResponse { /** - *List of ColumnStatisticsErrors.
+ *The value of the metadata key.
* @public */ - Errors?: ColumnStatisticsError[] | undefined; + MetadataKeyValue: MetadataKeyValuePair | undefined; } /** * @public */ -export interface UpdateColumnStatisticsTaskSettingsRequest { +export interface RemoveSchemaVersionMetadataResponse { /** - *The name of the database where the table resides.
+ *The Amazon Resource Name (ARN) of the schema.
* @public */ - DatabaseName: string | undefined; + SchemaArn?: string | undefined; /** - *The name of the table for which to generate column statistics.
+ *The name of the schema.
* @public */ - TableName: string | undefined; + SchemaName?: string | undefined; /** - *The role used for running the column statistics.
+ *The name of the registry.
* @public */ - Role?: string | undefined; + RegistryName?: string | undefined; /** - *A schedule for running the column statistics, specified in CRON syntax.
+ *The latest version of the schema.
* @public */ - Schedule?: string | undefined; + LatestVersion?: boolean | undefined; /** - *A list of column names for which to run statistics.
+ *The version number of the schema.
* @public */ - ColumnNameList?: string[] | undefined; + VersionNumber?: number | undefined; /** - *The percentage of data to sample.
+ *The version ID for the schema version.
* @public */ - SampleSize?: number | undefined; + SchemaVersionId?: string | undefined; /** - *The ID of the Data Catalog in which the database resides.
+ *The metadata key.
* @public */ - CatalogID?: string | undefined; + MetadataKey?: string | undefined; /** - *Name of the security configuration that is used to encrypt CloudWatch logs.
+ *The value of the metadata key.
* @public */ - SecurityConfiguration?: string | undefined; + MetadataValue?: 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; - +export interface ResetJobBookmarkRequest { /** - *The name of the connection definition to update.
+ *The name of the job in question.
* @public */ - Name: string | undefined; + JobName: string | undefined; /** - *A ConnectionInput
object that redefines the connection
- * in question.
The unique run identifier associated with this job run.
* @public */ - ConnectionInput: ConnectionInput | undefined; + RunId?: string | undefined; } /** * @public */ -export interface UpdateConnectionResponse {} - -/** - * @public - */ -export interface UpdateCrawlerRequest { - /** - *Name of the new crawler.
- * @public - */ - Name: string | undefined; - +export interface ResetJobBookmarkResponse { /** - *The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the new crawler - * to access customer resources.
+ *The reset bookmark entry.
* @public */ - Role?: string | undefined; + JobBookmarkEntry?: JobBookmarkEntry | undefined; +} +/** + *Too many jobs are being run concurrently.
+ * @public + */ +export class ConcurrentRunsExceededException extends __BaseException { + readonly name: "ConcurrentRunsExceededException" = "ConcurrentRunsExceededException"; + readonly $fault: "client" = "client"; /** - *The Glue database where results are stored, such as:
- * arn:aws:daylight:us-east-1::database/sometable/*
.
A message describing the problem.
* @public */ - DatabaseName?: string | undefined; - + Message?: string | undefined; /** - *A description of the new crawler.
- * @public + * @internal */ - Description?: string | undefined; + constructor(opts: __ExceptionOptionTypeThe workflow is in an invalid state to perform a requested operation.
+ * @public + */ +export class IllegalWorkflowStateException extends __BaseException { + readonly name: "IllegalWorkflowStateException" = "IllegalWorkflowStateException"; + readonly $fault: "client" = "client"; /** - *A list of targets to crawl.
+ *A message describing the problem.
* @public */ - Targets?: CrawlerTargets | undefined; - + Message?: string | 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.
+ *The name of the workflow to resume.
* @public */ - Classifiers?: string[] | undefined; + Name: string | undefined; /** - *The table prefix used for catalog tables that are created.
+ *The ID of the workflow run to resume.
* @public */ - TablePrefix?: string | undefined; + RunId: string | undefined; /** - *The policy for the crawler's update and deletion behavior.
+ *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 */ - SchemaChangePolicy?: SchemaChangePolicy | undefined; + NodeIds: string[] | undefined; +} +/** + * @public + */ +export interface ResumeWorkflowRunResponse { /** - *A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
+ *The new ID assigned to the resumed workflow run. Each resume of a workflow run will have a new run ID.
* @public */ - RecrawlPolicy?: RecrawlPolicy | undefined; + RunId?: string | undefined; /** - *Specifies data lineage configuration settings for the crawler.
+ *A list of the node IDs for the nodes that were actually restarted.
* @public */ - LineageConfiguration?: LineageConfiguration | undefined; + NodeIds?: string[] | undefined; +} +/** + * @public + */ +export interface RunStatementRequest { /** - *Specifies Lake Formation configuration settings for the crawler.
+ *The Session Id of the statement to be run.
* @public */ - LakeFormationConfiguration?: LakeFormationConfiguration | undefined; + SessionId: string | 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.
+ *The statement code to be run.
* @public */ - Configuration?: string | undefined; + Code: string | undefined; /** - *The name of the SecurityConfiguration
structure to be used by this
- * crawler.
The origin of the request.
* @public */ - CrawlerSecurityConfiguration?: string | undefined; + RequestOrigin?: string | undefined; } /** * @public */ -export interface UpdateCrawlerResponse {} - -/** - * @public - */ -export interface UpdateCrawlerScheduleRequest { - /** - *The name of the crawler whose schedule to update.
- * @public - */ - CrawlerName: string | undefined; - +export interface RunStatementResponse { /** - *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 * * ? *)
.
Returns the Id of the statement that was run.
* @public */ - Schedule?: string | undefined; + Id?: number | undefined; } +/** + * @public + * @enum + */ +export const Comparator = { + EQUALS: "EQUALS", + GREATER_THAN: "GREATER_THAN", + GREATER_THAN_EQUALS: "GREATER_THAN_EQUALS", + LESS_THAN: "LESS_THAN", + LESS_THAN_EQUALS: "LESS_THAN_EQUALS", +} as const; + /** * @public */ -export interface UpdateCrawlerScheduleResponse {} +export type Comparator = (typeof Comparator)[keyof typeof Comparator]; /** + *Defines a property predicate.
* @public */ -export interface UpdateDatabaseRequest { +export interface PropertyPredicate { /** - *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.
+ *The key of the property.
* @public */ - CatalogId?: string | undefined; + Key?: string | undefined; /** - *The name of the database to update in the catalog. For Hive - * compatibility, this is folded to lowercase.
+ *The value of the property.
* @public */ - Name: string | undefined; + Value?: string | undefined; /** - *A DatabaseInput
object specifying the new definition
- * of the metadata database in the catalog.
The comparator used to compare this property to others.
* @public */ - DatabaseInput: DatabaseInput | undefined; + Comparator?: Comparator | undefined; } /** * @public + * @enum */ -export interface UpdateDatabaseResponse {} +export const Sort = { + ASCENDING: "ASC", + DESCENDING: "DESC", +} as const; /** * @public */ -export interface UpdateDataQualityRulesetRequest { - /** - *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; -} +export type Sort = (typeof Sort)[keyof typeof Sort]; /** + *Specifies a field to sort by and a sort order.
* @public */ -export interface UpdateDataQualityRulesetResponse { - /** - *The name of the data quality ruleset.
- * @public - */ - Name?: string | undefined; - +export interface SortCriterion { /** - *A description of the ruleset.
+ *The name of the field on which to sort.
* @public */ - Description?: string | undefined; + FieldName?: string | undefined; /** - *A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
+ *An ascending or descending sort.
* @public */ - Ruleset?: string | undefined; + Sort?: Sort | undefined; } /** * @internal */ -export const StatisticSummaryFilterSensitiveLog = (obj: StatisticSummary): any => ({ - ...obj, - ...(obj.StatisticProperties && { StatisticProperties: SENSITIVE_STRING }), -}); - -/** - * @internal - */ -export const ListDataQualityStatisticsResponseFilterSensitiveLog = (obj: ListDataQualityStatisticsResponse): any => ({ +export const GetDataQualityResultResponseFilterSensitiveLog = (obj: GetDataQualityResultResponse): any => ({ ...obj, - ...(obj.Statistics && { Statistics: obj.Statistics.map((item) => StatisticSummaryFilterSensitiveLog(item)) }), + ...(obj.RuleResults && { RuleResults: obj.RuleResults.map((item) => DataQualityRuleResultFilterSensitiveLog(item)) }), + ...(obj.AnalyzerResults && { + AnalyzerResults: obj.AnalyzerResults.map((item) => DataQualityAnalyzerResultFilterSensitiveLog(item)), + }), + ...(obj.Observations && { + Observations: obj.Observations.map((item) => DataQualityObservationFilterSensitiveLog(item)), + }), }); /** * @internal */ -export const TestConnectionInputFilterSensitiveLog = (obj: TestConnectionInput): any => ({ +export const GetEntityRecordsResponseFilterSensitiveLog = (obj: GetEntityRecordsResponse): any => ({ ...obj, - ...(obj.AuthenticationConfiguration && { - AuthenticationConfiguration: AuthenticationConfigurationInputFilterSensitiveLog(obj.AuthenticationConfiguration), - }), + ...(obj.Records && { Records: SENSITIVE_STRING }), }); /** * @internal */ -export const TestConnectionRequestFilterSensitiveLog = (obj: TestConnectionRequest): any => ({ +export const StatisticSummaryFilterSensitiveLog = (obj: StatisticSummary): any => ({ ...obj, - ...(obj.TestConnectionInput && { - TestConnectionInput: TestConnectionInputFilterSensitiveLog(obj.TestConnectionInput), - }), + ...(obj.StatisticProperties && { StatisticProperties: SENSITIVE_STRING }), }); /** * @internal */ -export const UpdateConnectionRequestFilterSensitiveLog = (obj: UpdateConnectionRequest): any => ({ +export const ListDataQualityStatisticsResponseFilterSensitiveLog = (obj: ListDataQualityStatisticsResponse): any => ({ ...obj, - ...(obj.ConnectionInput && { ConnectionInput: ConnectionInputFilterSensitiveLog(obj.ConnectionInput) }), + ...(obj.Statistics && { Statistics: obj.Statistics.map((item) => StatisticSummaryFilterSensitiveLog(item)) }), }); diff --git a/clients/client-glue/src/models/models_3.ts b/clients/client-glue/src/models/models_3.ts index 5b2e6e85eb5e..6242bd1ffcbe 100644 --- a/clients/client-glue/src/models/models_3.ts +++ b/clients/client-glue/src/models/models_3.ts @@ -1,5 +1,7 @@ // smithy-typescript generated code -import { SENSITIVE_STRING } from "@smithy/smithy-client"; +import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@smithy/smithy-client"; + +import { GlueServiceException as __BaseException } from "./GlueServiceException"; import { Action, @@ -7,6 +9,8 @@ import { AmazonRedshiftSource, AmazonRedshiftTarget, AthenaConnectorSource, + AuthenticationConfigurationInput, + AuthenticationConfigurationInputFilterSensitiveLog, BasicCatalogTarget, CatalogDeltaSource, CatalogHudiSource, @@ -17,7 +21,9 @@ import { ConnectionsList, ConnectorDataSource, ConnectorDataTarget, + CrawlerTargets, CustomCode, + DataSource, DirectJDBCSource, DirectKafkaSource, DirectKinesisSource, @@ -41,6 +47,8 @@ import { JobCommand, JobMode, Join, + LakeFormationConfiguration, + LineageConfiguration, Merge, MicrosoftSQLServerCatalogSource, MicrosoftSQLServerCatalogTarget, @@ -55,6 +63,7 @@ import { PostgreSQLCatalogTarget, Predicate, Recipe, + RecrawlPolicy, RedshiftSource, RedshiftTarget, RelationalCatalogSource, @@ -74,6 +83,7 @@ import { S3HudiSource, S3JsonSource, S3ParquetSource, + SchemaChangePolicy, SchemaId, SelectFields, SelectFromCollection, @@ -95,26 +105,1848 @@ import { WorkerType, } from "./models_0"; -import { - Compatibility, - Permission, - ProfileConfiguration, - RegistryId, - TableIdentifier, - TableInput, - TransformParameters, - UserDefinedFunctionInput, -} from "./models_1"; +import { + CatalogInput, + ColumnStatistics, + Compatibility, + ConnectionInput, + ConnectionInputFilterSensitiveLog, + ConnectionPropertyKey, + ConnectionType, + CsvHeaderOption, + CsvSerdeOption, + DatabaseInput, + Permission, + ProfileConfiguration, + RegistryId, + SourceProcessingProperties, + SourceTableConfig, + TableIdentifier, + TableInput, + TargetProcessingProperties, + TargetTableConfig, + TransformParameters, + UserDefinedFunctionInput, +} from "./models_1"; + +import { + ColumnRowFilter, + DataQualityEvaluationRunAdditionalRunOptions, + FederatedTable, + PropertyPredicate, + ResourceAction, + ResourceShareType, + ResourceState, + SchemaVersionNumber, + SortCriterion, + ViewDefinition, + ViewValidation, +} from "./models_2"; + +/** + * @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; +} + +/** + *The blueprint is in an invalid state to perform a requested operation.
+ * @public + */ +export class IllegalBlueprintStateException extends __BaseException { + readonly name: "IllegalBlueprintStateException" = "IllegalBlueprintStateException"; + readonly $fault: "client" = "client"; + /** + *A message describing the problem.
+ * @public + */ + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe 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 {} + +/** + *There is no applicable schedule.
+ * @public + */ +export class NoScheduleException extends __BaseException { + readonly name: "NoScheduleException" = "NoScheduleException"; + readonly $fault: "client" = "client"; + /** + *A message describing the problem.
+ * @public + */ + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe specified scheduler is already running.
+ * @public + */ +export class SchedulerRunningException extends __BaseException { + readonly name: "SchedulerRunningException" = "SchedulerRunningException"; + readonly $fault: "client" = "client"; + /** + *A message describing the problem.
+ * @public + */ + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeName of the crawler to schedule.
+ * @public + */ + CrawlerName: string | undefined; +} + +/** + * @public + */ +export interface StartCrawlerScheduleResponse {} + +/** + * @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.
+ * @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.
Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup 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 84GB disk (approximately 34GB free), 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 128GB disk (approximately 77GB free), 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 (approximately 235GB free), 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 (approximately 487GB free), 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 (approximately 34GB free), 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 streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), 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.
The ID assigned to this job run.
+ * @public + */ + JobRunId?: string | undefined; +} + +/** + *The machine learning transform is not ready to run.
+ * @public + */ +export class MLTransformNotReadyException extends __BaseException { + readonly name: "MLTransformNotReadyException" = "MLTransformNotReadyException"; + readonly $fault: "client" = "client"; + /** + *A message describing the problem.
+ * @public + */ + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe 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.
+ * @public + */ + RunProperties?: RecordAn Id for the new run.
+ * @public + */ + RunId?: string | undefined; +} + +/** + *An exception thrown when you try to stop a task run when there is no task running.
+ * @public + */ +export class ColumnStatisticsTaskNotRunningException extends __BaseException { + readonly name: "ColumnStatisticsTaskNotRunningException" = "ColumnStatisticsTaskNotRunningException"; + readonly $fault: "client" = "client"; + /** + *A message describing the problem.
+ * @public + */ + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeAn exception thrown when you try to stop a task run.
+ * @public + */ +export class ColumnStatisticsTaskStoppingException extends __BaseException { + readonly name: "ColumnStatisticsTaskStoppingException" = "ColumnStatisticsTaskStoppingException"; + readonly $fault: "client" = "client"; + /** + *A message describing the problem.
+ * @public + */ + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe 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 {} + +/** + *The specified crawler is not running.
+ * @public + */ +export class CrawlerNotRunningException extends __BaseException { + readonly name: "CrawlerNotRunningException" = "CrawlerNotRunningException"; + readonly $fault: "client" = "client"; + /** + *A message describing the problem.
+ * @public + */ + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe specified crawler is stopping.
+ * @public + */ +export class CrawlerStoppingException extends __BaseException { + readonly name: "CrawlerStoppingException" = "CrawlerStoppingException"; + readonly $fault: "client" = "client"; + /** + *A message describing the problem.
+ * @public + */ + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeName of the crawler to stop.
+ * @public + */ + Name: string | undefined; +} + +/** + * @public + */ +export interface StopCrawlerResponse {} + +/** + *The specified scheduler is not running.
+ * @public + */ +export class SchedulerNotRunningException extends __BaseException { + readonly name: "SchedulerNotRunningException" = "SchedulerNotRunningException"; + readonly $fault: "client" = "client"; + /** + *A message describing the problem.
+ * @public + */ + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeName of the crawler whose schedule state to set.
+ * @public + */ + CrawlerName: string | undefined; +} + +/** + * @public + */ +export interface StopCrawlerScheduleResponse {} + +/** + * @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,
is okay, but
+ *
is not).
A GrokClassifier
object with updated fields.
An XMLClassifier
object with updated fields.
A JsonClassifier
object with updated fields.
A CsvClassifier
object with updated fields.
There was a version conflict.
+ * @public + */ +export class VersionMismatchException extends __BaseException { + readonly name: "VersionMismatchException" = "VersionMismatchException"; + readonly $fault: "client" = "client"; + /** + *A message describing the problem.
+ * @public + */ + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe 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; -import { - ColumnRowFilter, - FederatedTable, - ResourceAction, - ResourceState, - SchemaVersionNumber, - ViewDefinition, - ViewValidation, -} from "./models_2"; + /** + *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.
@@ -216,6 +2048,86 @@ export interface UpdateDevEndpointRequest { */ export interface UpdateDevEndpointResponse {} +/** + * @public + */ +export interface UpdateIntegrationResourcePropertyRequest { + /** + *The connection ARN of the source, or the database ARN of the target.
+ * @public + */ + ResourceArn: string | undefined; + + /** + *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 UpdateIntegrationResourcePropertyResponse { + /** + *The connection ARN of the source, or the database ARN of the target.
+ * @public + */ + ResourceArn?: string | undefined; + + /** + *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 UpdateIntegrationTablePropertiesRequest { + /** + *The connection ARN of the source, or the database ARN of the target.
+ * @public + */ + ResourceArn: string | undefined; + + /** + *The name of the table to be replicated.
+ * @public + */ + TableName: string | undefined; + + /** + *A structure for the source table configuration.
+ * @public + */ + SourceTableConfig?: SourceTableConfig | undefined; + + /** + *A structure for the target table configuration.
+ * @public + */ + TargetTableConfig?: TargetTableConfig | undefined; +} + +/** + * @public + */ +export interface UpdateIntegrationTablePropertiesResponse {} + /** * @public */ @@ -2673,6 +4585,34 @@ export interface GetJobsResponse { NextToken?: string | undefined; } +/** + * @internal + */ +export const TestConnectionInputFilterSensitiveLog = (obj: TestConnectionInput): any => ({ + ...obj, + ...(obj.AuthenticationConfiguration && { + AuthenticationConfiguration: AuthenticationConfigurationInputFilterSensitiveLog(obj.AuthenticationConfiguration), + }), +}); + +/** + * @internal + */ +export const TestConnectionRequestFilterSensitiveLog = (obj: TestConnectionRequest): any => ({ + ...obj, + ...(obj.TestConnectionInput && { + TestConnectionInput: TestConnectionInputFilterSensitiveLog(obj.TestConnectionInput), + }), +}); + +/** + * @internal + */ +export const UpdateConnectionRequestFilterSensitiveLog = (obj: UpdateConnectionRequest): any => ({ + ...obj, + ...(obj.ConnectionInput && { ConnectionInput: ConnectionInputFilterSensitiveLog(obj.ConnectionInput) }), +}); + /** * @internal */ diff --git a/clients/client-glue/src/pagination/DescribeEntityPaginator.ts b/clients/client-glue/src/pagination/DescribeEntityPaginator.ts new file mode 100644 index 000000000000..bc1d19b81a94 --- /dev/null +++ b/clients/client-glue/src/pagination/DescribeEntityPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { + DescribeEntityCommand, + DescribeEntityCommandInput, + DescribeEntityCommandOutput, +} from "../commands/DescribeEntityCommand"; +import { GlueClient } from "../GlueClient"; +import { GluePaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateDescribeEntity: ( + config: GluePaginationConfiguration, + input: DescribeEntityCommandInput, + ...rest: any[] +) => PaginatorA description of the allowed value.
" + } + }, + "Value": { + "target": "com.amazonaws.glue#AllowedValueValueString", + "traits": { + "smithy.api#documentation": "The value allowed for the property.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing a value allowed for a property.
" + } + }, + "com.amazonaws.glue#AllowedValueDescriptionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.glue#AllowedValueValueString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.glue#AllowedValues": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#AllowedValue" + } + }, "com.amazonaws.glue#AllowedValuesStringList": { "type": "list", "member": { @@ -2298,6 +2420,16 @@ "target": "com.amazonaws.glue#StatisticAnnotation" } }, + "com.amazonaws.glue#ApiVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9.-]*$" + } + }, "com.amazonaws.glue#ApplyMapping": { "type": "structure", "members": { @@ -2438,6 +2570,45 @@ } } }, + "com.amazonaws.glue#AuthConfiguration": { + "type": "structure", + "members": { + "AuthenticationType": { + "target": "com.amazonaws.glue#Property", + "traits": { + "smithy.api#documentation": "The type of authentication for a connection.
", + "smithy.api#required": {} + } + }, + "SecretArn": { + "target": "com.amazonaws.glue#Property", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the Secrets Manager.
" + } + }, + "OAuth2Properties": { + "target": "com.amazonaws.glue#PropertiesMap", + "traits": { + "smithy.api#documentation": "A map of key-value pairs for the OAuth2 properties. Each value is a a Property
object.
A map of key-value pairs for the OAuth2 properties. Each value is a a Property
object.
A map of key-value pairs for the custom authentication properties. Each value is a a Property
object.
The authentication configuration for a connection returned by the DescribeConnectionType
API.
The secret manager ARN to store credentials in the CreateConnection request.
" } + }, + "KmsKeyArn": { + "target": "com.amazonaws.glue#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the KMS key used to encrypt the connection. Only taken an as input in the request and stored in the Secret Manager.
" + } + }, + "BasicAuthenticationCredentials": { + "target": "com.amazonaws.glue#BasicAuthenticationCredentials", + "traits": { + "smithy.api#documentation": "The credentials used when the authentication type is basic authentication.
" + } + }, + "CustomAuthenticationCredentials": { + "target": "com.amazonaws.glue#CredentialMap", + "traits": { + "smithy.api#documentation": "The credentials used when the authentication type is custom authentication.
" + } } }, "traits": { @@ -2520,9 +2709,21 @@ "traits": { "smithy.api#enumValue": "CUSTOM" } + }, + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM" + } } } }, + "com.amazonaws.glue#AuthenticationTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#AuthenticationType" + } + }, "com.amazonaws.glue#AuthorizationCode": { "type": "string", "traits": { @@ -2621,6 +2822,26 @@ "target": "com.amazonaws.glue#BackfillError" } }, + "com.amazonaws.glue#BasicAuthenticationCredentials": { + "type": "structure", + "members": { + "Username": { + "target": "com.amazonaws.glue#Username", + "traits": { + "smithy.api#documentation": "The username to connect to the data source.
" + } + }, + "Password": { + "target": "com.amazonaws.glue#Password", + "traits": { + "smithy.api#documentation": "The password to connect to the data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "For supplying basic auth credentials when not providing a SecretArn
value.
A list of supported authentication types.
", + "smithy.api#required": {} + } + }, + "SupportedDataOperations": { + "target": "com.amazonaws.glue#DataOperations", + "traits": { + "smithy.api#documentation": "A list of supported data operations.
", + "smithy.api#required": {} + } + }, + "SupportedComputeEnvironments": { + "target": "com.amazonaws.glue#ComputeEnvironments", + "traits": { + "smithy.api#documentation": "A list of supported compute environments.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the supported authentication types returned by the DescribeConnectionType
API.
The ID of the catalog. To grant access to the default catalog, this field should not be provided.
" + } + }, + "Name": { + "target": "com.amazonaws.glue#CatalogNameString", + "traits": { + "smithy.api#documentation": "The name of the catalog. Cannot be the same as the account ID.
", + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.glue#ResourceArnString", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the catalog resource.
" + } + }, + "Description": { + "target": "com.amazonaws.glue#DescriptionString", + "traits": { + "smithy.api#documentation": "Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern. A description of the catalog.
" + } + }, + "Parameters": { + "target": "com.amazonaws.glue#ParametersMap", + "traits": { + "smithy.api#documentation": "A map array of key-value pairs that define parameters and properties of the catalog.
" + } + }, + "CreateTime": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the catalog was created.
" + } + }, + "UpdateTime": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the catalog was last updated.
" + } + }, + "TargetRedshiftCatalog": { + "target": "com.amazonaws.glue#TargetRedshiftCatalog", + "traits": { + "smithy.api#documentation": "A TargetRedshiftCatalog
object that describes a target catalog for database resource linking.
A FederatedCatalog
object that points to an entity outside the Glue Data Catalog.
A CatalogProperties
object that specifies data lake access properties and other custom properties.
An array of PrincipalPermissions
objects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.
An array of PrincipalPermissions
objects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.
The catalog object represents a logical grouping of databases in the Glue Data Catalog or a federated source. You can now create a Redshift-federated catalog or a catalog containing resource links to Redshift databases in another account or region.
" + } + }, "com.amazonaws.glue#CatalogDeltaSource": { "type": "structure", "members": { @@ -5010,6 +5344,56 @@ "smithy.api#documentation": "A structure containing migration status information.
" } }, + "com.amazonaws.glue#CatalogInput": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.glue#DescriptionString", + "traits": { + "smithy.api#documentation": "Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern. A description of the catalog.
" + } + }, + "FederatedCatalog": { + "target": "com.amazonaws.glue#FederatedCatalog", + "traits": { + "smithy.api#documentation": "A FederatedCatalog
object. A FederatedCatalog
structure that references an entity outside the Glue Data Catalog, for example a Redshift database.
A map array of key-value pairs that define the parameters and properties of the catalog.
" + } + }, + "TargetRedshiftCatalog": { + "target": "com.amazonaws.glue#TargetRedshiftCatalog", + "traits": { + "smithy.api#documentation": "A TargetRedshiftCatalog
object that describes a target catalog for resource linking.
A CatalogProperties
object that specifies data lake access properties and other custom properties.
An array of PrincipalPermissions
objects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Typically should be explicitly set as an empty list.
An array of PrincipalPermissions
objects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Typically should be explicitly set as an empty list.
A structure that describes catalog properties.
" + } + }, "com.amazonaws.glue#CatalogKafkaSource": { "type": "structure", "members": { @@ -5116,6 +5500,62 @@ "smithy.api#documentation": "Specifies a Kinesis data source in the Glue Data Catalog.
" } }, + "com.amazonaws.glue#CatalogList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#Catalog" + } + }, + "com.amazonaws.glue#CatalogNameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^(?!(.*[.\\/\\\\]|aws:)).*$" + } + }, + "com.amazonaws.glue#CatalogProperties": { + "type": "structure", + "members": { + "DataLakeAccessProperties": { + "target": "com.amazonaws.glue#DataLakeAccessProperties", + "traits": { + "smithy.api#documentation": "A DataLakeAccessProperties
object that specifies properties to configure data lake access for your catalog resource in the Glue Data Catalog.
Additional key-value properties for the catalog, such as column statistics optimizations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that specifies data lake access properties and other custom properties.
" + } + }, + "com.amazonaws.glue#CatalogPropertiesOutput": { + "type": "structure", + "members": { + "DataLakeAccessProperties": { + "target": "com.amazonaws.glue#DataLakeAccessPropertiesOutput", + "traits": { + "smithy.api#documentation": "A DataLakeAccessProperties
object with input properties to configure data lake access for your catalog resource in the Glue Data Catalog.
Additional key-value properties for the catalog, such as column statistics optimizations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Property attributes that include configuration properties for the catalog resource.
" + } + }, "com.amazonaws.glue#CatalogSchemaChangePolicy": { "type": "structure", "members": { @@ -5222,6 +5662,9 @@ "target": "com.amazonaws.glue#CatalogTarget" } }, + "com.amazonaws.glue#Category": { + "type": "string" + }, "com.amazonaws.glue#CheckSchemaVersionValidity": { "type": "operation", "input": { @@ -6462,6 +6905,24 @@ "traits": { "smithy.api#documentation": "Name of the security configuration that is used to encrypt CloudWatch logs.
" } + }, + "ScheduleType": { + "target": "com.amazonaws.glue#ScheduleType", + "traits": { + "smithy.api#documentation": "The type of schedule for a column statistics task. Possible values may be CRON
or AUTO
.
The source of setting the column statistics task. Possible values may be CATALOG
or TABLE
.
The last ExecutionAttempt
for the column statistics task run.
A name for the compute environment configuration.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.glue#ComputeEnvironmentConfigurationDescriptionString", + "traits": { + "smithy.api#documentation": "A description of the compute environment.
", + "smithy.api#required": {} + } + }, + "ComputeEnvironment": { + "target": "com.amazonaws.glue#ComputeEnvironment", + "traits": { + "smithy.api#documentation": "The type of compute environment.
", + "smithy.api#required": {} + } + }, + "SupportedAuthenticationTypes": { + "target": "com.amazonaws.glue#AuthenticationTypes", + "traits": { + "smithy.api#documentation": "The supported authentication types for the compute environment.
", + "smithy.api#required": {} + } + }, + "ConnectionOptions": { + "target": "com.amazonaws.glue#PropertiesMap", + "traits": { + "smithy.api#documentation": "The parameters used as connection options for the compute environment.
", + "smithy.api#required": {} + } + }, + "ConnectionPropertyNameOverrides": { + "target": "com.amazonaws.glue#PropertyNameOverrides", + "traits": { + "smithy.api#documentation": "The connection property name overrides for the compute environment.
", + "smithy.api#required": {} + } + }, + "ConnectionOptionNameOverrides": { + "target": "com.amazonaws.glue#PropertyNameOverrides", + "traits": { + "smithy.api#documentation": "The connection option name overrides for the compute environment.
", + "smithy.api#required": {} + } + }, + "ConnectionPropertiesRequiredOverrides": { + "target": "com.amazonaws.glue#ListOfString", + "traits": { + "smithy.api#default": [], + "smithy.api#documentation": "The connection properties that are required as overrides for the compute environment.
", + "smithy.api#required": {} + } + }, + "PhysicalConnectionPropertiesRequired": { + "target": "com.amazonaws.glue#Bool", + "traits": { + "smithy.api#documentation": "Indicates whether PhysicalConnectionProperties
are required for the compute environment.
An object containing configuration for a compute environment (such as Spark, Python or Athena) returned by the DescribeConnectionType
API.
These key-value pairs define parameters for the connection:
\n\n HOST
- The host URI: either the\n fully qualified domain name (FQDN) or the IPv4 address of\n the database host.
\n PORT
- The port number, between\n 1024 and 65535, of the port on which the database host is\n listening for database connections.
\n USER_NAME
- The name under which\n to log in to the database. The value string for USER_NAME
is \"USERNAME
\".
\n PASSWORD
- A password,\n if one is used, for the user name.
\n ENCRYPTED_PASSWORD
- When you enable connection password protection by setting ConnectionPasswordEncryption
in the Data Catalog encryption settings, this field stores the encrypted password.
\n JDBC_DRIVER_JAR_URI
- The Amazon Simple Storage Service (Amazon S3) path of the\n JAR file that contains the JDBC driver to use.
\n JDBC_DRIVER_CLASS_NAME
- The class name of the JDBC driver to use.
\n JDBC_ENGINE
- The name of the JDBC engine to use.
\n JDBC_ENGINE_VERSION
- The version of the JDBC engine to use.
\n CONFIG_FILES
- (Reserved for future use.)
\n INSTANCE_ID
- The instance ID to use.
\n JDBC_CONNECTION_URL
- The URL for connecting to a JDBC data source.
\n JDBC_ENFORCE_SSL
- A Boolean string (true, false) specifying whether Secure\n Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the\n client. The default is false.
\n CUSTOM_JDBC_CERT
- An Amazon S3 location specifying the customer's root certificate. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.
\n SKIP_CUSTOM_JDBC_CERT_VALIDATION
- By default, this is false
. Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true
to skip Glue’s validation of the customer certificate.
\n CUSTOM_JDBC_CERT_STRING
- A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN
; in Microsoft SQL Server, this is used as the hostNameInCertificate
.
\n CONNECTION_URL
- The URL for connecting to a general (non-JDBC) data source.
\n SECRET_ID
- The secret ID used for the secret manager of credentials.
\n CONNECTOR_URL
- The connector URL for a MARKETPLACE or CUSTOM connection.
\n CONNECTOR_TYPE
- The connector type for a MARKETPLACE or CUSTOM connection.
\n CONNECTOR_CLASS_NAME
- The connector class name for a MARKETPLACE or CUSTOM connection.
\n KAFKA_BOOTSTRAP_SERVERS
- A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.
\n KAFKA_SSL_ENABLED
- Whether to enable or disable SSL on an Apache Kafka connection. Default value is \"true\".
\n KAFKA_CUSTOM_CERT
- The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string.
\n KAFKA_SKIP_CUSTOM_CERT_VALIDATION
- Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is \"false\".
\n KAFKA_CLIENT_KEYSTORE
- The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional).
\n KAFKA_CLIENT_KEYSTORE_PASSWORD
- The password to access the provided keystore (Optional).
\n KAFKA_CLIENT_KEY_PASSWORD
- A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional).
\n ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
- The encrypted version of the Kafka client keystore password (if the user has the Glue encrypt passwords setting selected).
\n ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
- The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).
\n KAFKA_SASL_MECHANISM
- \"SCRAM-SHA-512\"
, \"GSSAPI\"
, \"AWS_MSK_IAM\"
, or \"PLAIN\"
. These are the supported SASL Mechanisms.
\n KAFKA_SASL_PLAIN_USERNAME
- A plaintext username used to authenticate with the \"PLAIN\" mechanism.
\n KAFKA_SASL_PLAIN_PASSWORD
- A plaintext password used to authenticate with the \"PLAIN\" mechanism.
\n ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD
- The encrypted version of the Kafka SASL PLAIN password (if the user has the Glue encrypt passwords setting selected).
\n KAFKA_SASL_SCRAM_USERNAME
- A plaintext username used to authenticate with the \"SCRAM-SHA-512\" mechanism.
\n KAFKA_SASL_SCRAM_PASSWORD
- A plaintext password used to authenticate with the \"SCRAM-SHA-512\" mechanism.
\n ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
- The encrypted version of the Kafka SASL SCRAM password (if the user has the Glue encrypt passwords setting selected).
\n KAFKA_SASL_SCRAM_SECRETS_ARN
- The Amazon Resource Name of a secret in Amazon Web Services Secrets Manager.
\n KAFKA_SASL_GSSAPI_KEYTAB
- The S3 location of a Kerberos keytab
file. A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab.
\n KAFKA_SASL_GSSAPI_KRB5_CONF
- The S3 location of a Kerberos krb5.conf
file. A krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf.
\n KAFKA_SASL_GSSAPI_SERVICE
- The Kerberos service name, as set with sasl.kerberos.service.name
in your Kafka Configuration.
\n KAFKA_SASL_GSSAPI_PRINCIPAL
- The name of the Kerberos princial used by Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers.
\n ROLE_ARN
- The role to be used for running queries.
\n REGION
- The Amazon Web Services Region where queries will be run.
\n WORKGROUP_NAME
- The name of an Amazon Redshift serverless workgroup or Amazon Athena workgroup in which queries will run.
\n CLUSTER_IDENTIFIER
- The cluster identifier of an Amazon Redshift cluster in which queries will run.
\n DATABASE
- The Amazon Redshift database that you are connecting to.
These key-value pairs define parameters for the connection when using the version 1 Connection schema:
\n\n HOST
- The host URI: either the\n fully qualified domain name (FQDN) or the IPv4 address of\n the database host.
\n PORT
- The port number, between\n 1024 and 65535, of the port on which the database host is\n listening for database connections.
\n USER_NAME
- The name under which\n to log in to the database. The value string for USER_NAME
is \"USERNAME
\".
\n PASSWORD
- A password,\n if one is used, for the user name.
\n ENCRYPTED_PASSWORD
- When you enable connection password protection by setting ConnectionPasswordEncryption
in the Data Catalog encryption settings, this field stores the encrypted password.
\n JDBC_DRIVER_JAR_URI
- The Amazon Simple Storage Service (Amazon S3) path of the\n JAR file that contains the JDBC driver to use.
\n JDBC_DRIVER_CLASS_NAME
- The class name of the JDBC driver to use.
\n JDBC_ENGINE
- The name of the JDBC engine to use.
\n JDBC_ENGINE_VERSION
- The version of the JDBC engine to use.
\n CONFIG_FILES
- (Reserved for future use.)
\n INSTANCE_ID
- The instance ID to use.
\n JDBC_CONNECTION_URL
- The URL for connecting to a JDBC data source.
\n JDBC_ENFORCE_SSL
- A Boolean string (true, false) specifying whether Secure\n Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the\n client. The default is false.
\n CUSTOM_JDBC_CERT
- An Amazon S3 location specifying the customer's root certificate. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.
\n SKIP_CUSTOM_JDBC_CERT_VALIDATION
- By default, this is false
. Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true
to skip Glue’s validation of the customer certificate.
\n CUSTOM_JDBC_CERT_STRING
- A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN
; in Microsoft SQL Server, this is used as the hostNameInCertificate
.
\n CONNECTION_URL
- The URL for connecting to a general (non-JDBC) data source.
\n SECRET_ID
- The secret ID used for the secret manager of credentials.
\n CONNECTOR_URL
- The connector URL for a MARKETPLACE or CUSTOM connection.
\n CONNECTOR_TYPE
- The connector type for a MARKETPLACE or CUSTOM connection.
\n CONNECTOR_CLASS_NAME
- The connector class name for a MARKETPLACE or CUSTOM connection.
\n KAFKA_BOOTSTRAP_SERVERS
- A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.
\n KAFKA_SSL_ENABLED
- Whether to enable or disable SSL on an Apache Kafka connection. Default value is \"true\".
\n KAFKA_CUSTOM_CERT
- The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string.
\n KAFKA_SKIP_CUSTOM_CERT_VALIDATION
- Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is \"false\".
\n KAFKA_CLIENT_KEYSTORE
- The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional).
\n KAFKA_CLIENT_KEYSTORE_PASSWORD
- The password to access the provided keystore (Optional).
\n KAFKA_CLIENT_KEY_PASSWORD
- A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional).
\n ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
- The encrypted version of the Kafka client keystore password (if the user has the Glue encrypt passwords setting selected).
\n ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
- The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).
\n KAFKA_SASL_MECHANISM
- \"SCRAM-SHA-512\"
, \"GSSAPI\"
, \"AWS_MSK_IAM\"
, or \"PLAIN\"
. These are the supported SASL Mechanisms.
\n KAFKA_SASL_PLAIN_USERNAME
- A plaintext username used to authenticate with the \"PLAIN\" mechanism.
\n KAFKA_SASL_PLAIN_PASSWORD
- A plaintext password used to authenticate with the \"PLAIN\" mechanism.
\n ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD
- The encrypted version of the Kafka SASL PLAIN password (if the user has the Glue encrypt passwords setting selected).
\n KAFKA_SASL_SCRAM_USERNAME
- A plaintext username used to authenticate with the \"SCRAM-SHA-512\" mechanism.
\n KAFKA_SASL_SCRAM_PASSWORD
- A plaintext password used to authenticate with the \"SCRAM-SHA-512\" mechanism.
\n ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
- The encrypted version of the Kafka SASL SCRAM password (if the user has the Glue encrypt passwords setting selected).
\n KAFKA_SASL_SCRAM_SECRETS_ARN
- The Amazon Resource Name of a secret in Amazon Web Services Secrets Manager.
\n KAFKA_SASL_GSSAPI_KEYTAB
- The S3 location of a Kerberos keytab
file. A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab.
\n KAFKA_SASL_GSSAPI_KRB5_CONF
- The S3 location of a Kerberos krb5.conf
file. A krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf.
\n KAFKA_SASL_GSSAPI_SERVICE
- The Kerberos service name, as set with sasl.kerberos.service.name
in your Kafka Configuration.
\n KAFKA_SASL_GSSAPI_PRINCIPAL
- The name of the Kerberos princial used by Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers.
\n ROLE_ARN
- The role to be used for running queries.
\n REGION
- The Amazon Web Services Region where queries will be run.
\n WORKGROUP_NAME
- The name of an Amazon Redshift serverless workgroup or Amazon Athena workgroup in which queries will run.
\n CLUSTER_IDENTIFIER
- The cluster identifier of an Amazon Redshift cluster in which queries will run.
\n DATABASE
- The Amazon Redshift database that you are connecting to.
Connection properties specific to the Spark compute environment.
" } }, "AthenaProperties": { "target": "com.amazonaws.glue#PropertyMap", "traits": { - "smithy.api#documentation": "This field is not currently used.
" + "smithy.api#documentation": "Connection properties specific to the Athena compute environment.
" + } + }, + "PythonProperties": { + "target": "com.amazonaws.glue#PropertyMap", + "traits": { + "smithy.api#documentation": "Connection properties specific to the Python compute environment.
" } }, "PhysicalConnectionRequirements": { @@ -7012,6 +7618,18 @@ "traits": { "smithy.api#documentation": "The authentication properties of the connection.
" } + }, + "ConnectionSchemaVersion": { + "target": "com.amazonaws.glue#ConnectionSchemaVersion", + "traits": { + "smithy.api#documentation": "The version of the connection schema for this connection. Version 2 supports properties for specific compute environments.
" + } + }, + "CompatibleComputeEnvironments": { + "target": "com.amazonaws.glue#ComputeEnvironmentList", + "traits": { + "smithy.api#documentation": "A list of compute environments compatible with the connection.
" + } } }, "traits": { @@ -7037,7 +7655,7 @@ "ConnectionType": { "target": "com.amazonaws.glue#ConnectionType", "traits": { - "smithy.api#documentation": "The type of the connection. Currently, these types are supported:
\n\n JDBC
- Designates a connection to a database through Java Database Connectivity (JDBC).
\n JDBC
Connections use the following ConnectionParameters.
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.
\n KAFKA
- Designates a connection to an Apache Kafka streaming platform.
\n KAFKA
Connections use the following ConnectionParameters.
Required: KAFKA_BOOTSTRAP_SERVERS
.
Optional: KAFKA_SSL_ENABLED
, KAFKA_CUSTOM_CERT
, KAFKA_SKIP_CUSTOM_CERT_VALIDATION
. These parameters are used to configure SSL with KAFKA
.
Optional: KAFKA_CLIENT_KEYSTORE
, KAFKA_CLIENT_KEYSTORE_PASSWORD
, KAFKA_CLIENT_KEY_PASSWORD
, ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
, ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
. These parameters are used to configure TLS client configuration with SSL in KAFKA
.
Optional: KAFKA_SASL_MECHANISM
. Can be specified as SCRAM-SHA-512
, GSSAPI
, or AWS_MSK_IAM
.
Optional: KAFKA_SASL_SCRAM_USERNAME
, KAFKA_SASL_SCRAM_PASSWORD
, ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
. These parameters are used to configure SASL/SCRAM-SHA-512 authentication with KAFKA
.
Optional: KAFKA_SASL_GSSAPI_KEYTAB
, KAFKA_SASL_GSSAPI_KRB5_CONF
, KAFKA_SASL_GSSAPI_SERVICE
, KAFKA_SASL_GSSAPI_PRINCIPAL
. These parameters are used to configure SASL/GSSAPI authentication with KAFKA
.
\n MONGODB
- Designates a connection to a MongoDB document database.
\n MONGODB
Connections use the following ConnectionParameters.
Required: CONNECTION_URL
.
Required: All of (USERNAME
, PASSWORD
) or SECRET_ID
.
\n SALESFORCE
- Designates a connection to Salesforce using OAuth authencation.
Requires the AuthenticationConfiguration
member to be configured.
\n VIEW_VALIDATION_REDSHIFT
- Designates a connection used for view validation by Amazon Redshift.
\n VIEW_VALIDATION_ATHENA
- Designates a connection used for view validation by Amazon Athena.
\n NETWORK
- Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).
\n NETWORK
Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.
\n MARKETPLACE
- Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.
\n MARKETPLACE
Connections use the following ConnectionParameters.
Required: CONNECTOR_TYPE
, CONNECTOR_URL
, CONNECTOR_CLASS_NAME
, CONNECTION_URL
.
Required for JDBC
\n CONNECTOR_TYPE
connections: All of (USERNAME
, PASSWORD
) or SECRET_ID
.
\n CUSTOM
- Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.
\n SFTP
is not supported.
For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.
\nFor more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.
", + "smithy.api#documentation": "The type of the connection. Currently, these types are supported:
\n\n JDBC
- Designates a connection to a database through Java Database Connectivity (JDBC).
\n JDBC
Connections use the following ConnectionParameters.
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.
\n KAFKA
- Designates a connection to an Apache Kafka streaming platform.
\n KAFKA
Connections use the following ConnectionParameters.
Required: KAFKA_BOOTSTRAP_SERVERS
.
Optional: KAFKA_SSL_ENABLED
, KAFKA_CUSTOM_CERT
, KAFKA_SKIP_CUSTOM_CERT_VALIDATION
. These parameters are used to configure SSL with KAFKA
.
Optional: KAFKA_CLIENT_KEYSTORE
, KAFKA_CLIENT_KEYSTORE_PASSWORD
, KAFKA_CLIENT_KEY_PASSWORD
, ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
, ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
. These parameters are used to configure TLS client configuration with SSL in KAFKA
.
Optional: KAFKA_SASL_MECHANISM
. Can be specified as SCRAM-SHA-512
, GSSAPI
, or AWS_MSK_IAM
.
Optional: KAFKA_SASL_SCRAM_USERNAME
, KAFKA_SASL_SCRAM_PASSWORD
, ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
. These parameters are used to configure SASL/SCRAM-SHA-512 authentication with KAFKA
.
Optional: KAFKA_SASL_GSSAPI_KEYTAB
, KAFKA_SASL_GSSAPI_KRB5_CONF
, KAFKA_SASL_GSSAPI_SERVICE
, KAFKA_SASL_GSSAPI_PRINCIPAL
. These parameters are used to configure SASL/GSSAPI authentication with KAFKA
.
\n MONGODB
- Designates a connection to a MongoDB document database.
\n MONGODB
Connections use the following ConnectionParameters.
Required: CONNECTION_URL
.
Required: All of (USERNAME
, PASSWORD
) or SECRET_ID
.
\n VIEW_VALIDATION_REDSHIFT
- Designates a connection used for view validation by Amazon Redshift.
\n VIEW_VALIDATION_ATHENA
- Designates a connection used for view validation by Amazon Athena.
\n NETWORK
- Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).
\n NETWORK
Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.
\n MARKETPLACE
- Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.
\n MARKETPLACE
Connections use the following ConnectionParameters.
Required: CONNECTOR_TYPE
, CONNECTOR_URL
, CONNECTOR_CLASS_NAME
, CONNECTION_URL
.
Required for JDBC
\n CONNECTOR_TYPE
connections: All of (USERNAME
, PASSWORD
) or SECRET_ID
.
\n CUSTOM
- Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.
Additionally, a ConnectionType
for the following SaaS connectors is supported:
\n FACEBOOKADS
- Designates a connection to Facebook Ads.
\n GOOGLEADS
- Designates a connection to Google Ads.
\n GOOGLESHEETS
- Designates a connection to Google Sheets.
\n GOOGLEANALYTICS4
- Designates a connection to Google Analytics 4.
\n HUBSPOT
- Designates a connection to HubSpot.
\n INSTAGRAMADS
- Designates a connection to Instagram Ads.
\n INTERCOM
- Designates a connection to Intercom.
\n JIRACLOUD
- Designates a connection to Jira Cloud.
\n MARKETO
- Designates a connection to Adobe Marketo Engage.
\n NETSUITEERP
- Designates a connection to Oracle NetSuite.
\n SALESFORCE
- Designates a connection to Salesforce using OAuth authentication.
\n SALESFORCEMARKETINGCLOUD
- Designates a connection to Salesforce Marketing Cloud.
\n SALESFORCEPARDOT
- Designates a connection to Salesforce Marketing Cloud Account Engagement (MCAE).
\n SAPODATA
- Designates a connection to SAP OData.
\n SERVICENOW
- Designates a connection to ServiceNow.
\n SLACK
- Designates a connection to Slack.
\n SNAPCHATADS
- Designates a connection to Snapchat Ads.
\n STRIPE
- Designates a connection to Stripe.
\n ZENDESK
- Designates a connection to Zendesk.
\n ZOHOCRM
- Designates a connection to Zoho CRM.
For more information on the connection parameters needed for a particular connector, see the documentation for the connector in Adding an Glue connectionin the Glue User Guide.
\n\n SFTP
is not supported.
For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.
\nFor more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.
", "smithy.api#required": {} } }, @@ -7054,10 +7672,22 @@ "smithy.api#required": {} } }, + "SparkProperties": { + "target": "com.amazonaws.glue#PropertyMap", + "traits": { + "smithy.api#documentation": "Connection properties specific to the Spark compute environment.
" + } + }, "AthenaProperties": { "target": "com.amazonaws.glue#PropertyMap", "traits": { - "smithy.api#documentation": "This field is not currently used.
" + "smithy.api#documentation": "Connection properties specific to the Athena compute environment.
" + } + }, + "PythonProperties": { + "target": "com.amazonaws.glue#PropertyMap", + "traits": { + "smithy.api#documentation": "Connection properties specific to the Python compute environment.
" } }, "PhysicalConnectionRequirements": { @@ -7069,14 +7699,20 @@ "AuthenticationConfiguration": { "target": "com.amazonaws.glue#AuthenticationConfigurationInput", "traits": { - "smithy.api#documentation": "The authentication properties of the connection. Used for a Salesforce connection.
" + "smithy.api#documentation": "The authentication properties of the connection.
" } }, "ValidateCredentials": { "target": "com.amazonaws.glue#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A flag to validate the credentials during create connection. Used for a Salesforce connection. Default is true.
" + "smithy.api#documentation": "A flag to validate the credentials during create connection. Default is true.
" + } + }, + "ValidateForComputeEnvironments": { + "target": "com.amazonaws.glue#ComputeEnvironmentList", + "traits": { + "smithy.api#documentation": "The compute environments that the specified connection properties are validated against.
" } } }, @@ -7093,6 +7729,21 @@ "com.amazonaws.glue#ConnectionName": { "type": "string" }, + "com.amazonaws.glue#ConnectionOptions": { + "type": "map", + "key": { + "target": "com.amazonaws.glue#OptionKey" + }, + "value": { + "target": "com.amazonaws.glue#OptionValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.glue#ConnectionPasswordEncryption": { "type": "structure", "members": { @@ -7289,30 +7940,6 @@ "smithy.api#enumValue": "ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD" } }, - "SECRET_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SECRET_ID" - } - }, - "CONNECTOR_URL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONNECTOR_URL" - } - }, - "CONNECTOR_TYPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONNECTOR_TYPE" - } - }, - "CONNECTOR_CLASS_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONNECTOR_CLASS_NAME" - } - }, "KAFKA_SASL_MECHANISM": { "target": "smithy.api#Unit", "traits": { @@ -7385,6 +8012,42 @@ "smithy.api#enumValue": "KAFKA_SASL_GSSAPI_PRINCIPAL" } }, + "SECRET_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECRET_ID" + } + }, + "CONNECTOR_URL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECTOR_URL" + } + }, + "CONNECTOR_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECTOR_TYPE" + } + }, + "CONNECTOR_CLASS_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECTOR_CLASS_NAME" + } + }, + "ENDPOINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENDPOINT" + } + }, + "ENDPOINT_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENDPOINT_TYPE" + } + }, "ROLE_ARN": { "target": "smithy.api#Unit", "traits": { @@ -7417,6 +8080,15 @@ } } }, + "com.amazonaws.glue#ConnectionSchemaVersion": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 2 + } + } + }, "com.amazonaws.glue#ConnectionStatus": { "type": "enum", "members": { @@ -7502,9 +8174,155 @@ "traits": { "smithy.api#enumValue": "VIEW_VALIDATION_ATHENA" } + }, + "GOOGLEADS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GOOGLEADS" + } + }, + "GOOGLESHEETS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GOOGLESHEETS" + } + }, + "GOOGLEANALYTICS4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GOOGLEANALYTICS4" + } + }, + "SERVICENOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICENOW" + } + }, + "MARKETO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MARKETO" + } + }, + "SAPODATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAPODATA" + } + }, + "ZENDESK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZENDESK" + } + }, + "JIRACLOUD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JIRACLOUD" + } + }, + "NETSUITEERP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NETSUITEERP" + } + }, + "HUBSPOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HUBSPOT" + } + }, + "FACEBOOKADS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FACEBOOKADS" + } + }, + "INSTAGRAMADS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTAGRAMADS" + } + }, + "ZOHOCRM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZOHOCRM" + } + }, + "SALESFORCEPARDOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SALESFORCEPARDOT" + } + }, + "SALESFORCEMARKETINGCLOUD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SALESFORCEMARKETINGCLOUD" + } + }, + "SLACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SLACK" + } + }, + "STRIPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRIPE" + } + }, + "INTERCOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERCOM" + } + }, + "SNAPCHATADS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNAPCHATADS" + } } } }, + "com.amazonaws.glue#ConnectionTypeBrief": { + "type": "structure", + "members": { + "ConnectionType": { + "target": "com.amazonaws.glue#ConnectionType", + "traits": { + "smithy.api#documentation": "The name of the connection type.
" + } + }, + "Description": { + "target": "com.amazonaws.glue#Description", + "traits": { + "smithy.api#documentation": "A description of the connection type.
" + } + }, + "Capabilities": { + "target": "com.amazonaws.glue#Capabilities", + "traits": { + "smithy.api#documentation": "The supported authentication types, data interface types (compute environments), and data operations of the connector.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Brief information about a supported connection type returned by the ListConnectionTypes
API.
Creates a new catalog in the Glue Data Catalog.
" + } + }, + "com.amazonaws.glue#CreateCatalogRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#CatalogNameString", + "traits": { + "smithy.api#documentation": "The name of the catalog to create.
", + "smithy.api#required": {} + } + }, + "CatalogInput": { + "target": "com.amazonaws.glue#CatalogInput", + "traits": { + "smithy.api#documentation": "A CatalogInput
object that defines the metadata for the catalog.
A map array of key-value pairs, not more than 50 pairs. Each key is a UTF-8 string, not less than 1 or more than 128 bytes long. Each value is a UTF-8 string, not more than 256 bytes long. The tags you assign to the catalog.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#CreateCatalogResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#CreateClassifier": { "type": "operation", "input": { @@ -8959,6 +9859,12 @@ { "target": "com.amazonaws.glue#FederatedResourceAlreadyExistsException" }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#FederationSourceRetryableException" + }, { "target": "com.amazonaws.glue#GlueEncryptionException" }, @@ -9311,6 +10217,369 @@ "smithy.api#documentation": "Specifies a grok
classifier for CreateClassifier
\n to create.
Creates a Zero-ETL integration in the caller's account between two resources with Amazon Resource Names (ARNs): the SourceArn
and TargetArn
.
A unique name for an integration in Glue.
", + "smithy.api#required": {} + } + }, + "SourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The ARN of the source resource for the integration.
", + "smithy.api#required": {} + } + }, + "TargetArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The ARN of the target resource for the integration.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.glue#IntegrationDescription", + "traits": { + "smithy.api#documentation": "A description of the integration.
" + } + }, + "DataFilter": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "Selects source tables for the integration using Maxwell filter syntax.
" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "The ARN of a KMS key used for encrypting the channel.
" + } + }, + "AdditionalEncryptionContext": { + "target": "com.amazonaws.glue#IntegrationAdditionalEncryptionContextMap", + "traits": { + "smithy.api#documentation": "An optional set of non-secret key–value pairs that contains additional contextual information for encryption. This can only be provided if KMSKeyId
is provided.
Metadata assigned to the resource consisting of a list of key-value pairs.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#CreateIntegrationResourceProperty": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#CreateIntegrationResourcePropertyRequest" + }, + "output": { + "target": "com.amazonaws.glue#CreateIntegrationResourcePropertyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#ConflictException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServerException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "This API can be used for setting up the ResourceProperty
of the Glue connection (for the source) or Glue database ARN (for the target). These properties can include the role to access the connection or database. To set both source and target properties the same API needs to be invoked with the Glue connection ARN as ResourceArn
with SourceProcessingProperties
and the Glue database ARN as ResourceArn
with TargetProcessingProperties
respectively.
The connection ARN of the source, or the database ARN of the target.
", + "smithy.api#required": {} + } + }, + "SourceProcessingProperties": { + "target": "com.amazonaws.glue#SourceProcessingProperties", + "traits": { + "smithy.api#documentation": "The resource properties associated with the integration source.
" + } + }, + "TargetProcessingProperties": { + "target": "com.amazonaws.glue#TargetProcessingProperties", + "traits": { + "smithy.api#documentation": "The resource properties associated with the integration target.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#CreateIntegrationResourcePropertyResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The connection ARN of the source, or the database ARN of the target.
", + "smithy.api#required": {} + } + }, + "SourceProcessingProperties": { + "target": "com.amazonaws.glue#SourceProcessingProperties", + "traits": { + "smithy.api#documentation": "The resource properties associated with the integration source.
" + } + }, + "TargetProcessingProperties": { + "target": "com.amazonaws.glue#TargetProcessingProperties", + "traits": { + "smithy.api#documentation": "The resource properties associated with the integration target.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.glue#CreateIntegrationResponse": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The ARN of the source resource for the integration.
", + "smithy.api#required": {} + } + }, + "TargetArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The ARN of the target resource for the integration.
", + "smithy.api#required": {} + } + }, + "IntegrationName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "A unique name for an integration in Glue.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.glue#IntegrationDescription", + "traits": { + "smithy.api#documentation": "A description of the integration.
" + } + }, + "IntegrationArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the created integration.
", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "The ARN of a KMS key used for encrypting the channel.
" + } + }, + "AdditionalEncryptionContext": { + "target": "com.amazonaws.glue#IntegrationAdditionalEncryptionContextMap", + "traits": { + "smithy.api#documentation": "An optional set of non-secret key–value pairs that contains additional contextual information for encryption.
" + } + }, + "Tags": { + "target": "com.amazonaws.glue#IntegrationTagsList", + "traits": { + "smithy.api#documentation": "Metadata assigned to the resource consisting of a list of key-value pairs.
" + } + }, + "Status": { + "target": "com.amazonaws.glue#IntegrationStatus", + "traits": { + "smithy.api#documentation": "The status of the integration being created.
\nThe possible statuses are:
\nCREATING: The integration is being created.
\nACTIVE: The integration creation succeeds.
\nMODIFYING: The integration is being modified.
\nFAILED: The integration creation fails.
\nDELETING: The integration is deleted.
\nSYNCING: The integration is synchronizing.
\nNEEDS_ATTENTION: The integration needs attention, such as synchronization.
\nThe time when the integration was created, in UTC.
", + "smithy.api#required": {} + } + }, + "Errors": { + "target": "com.amazonaws.glue#IntegrationErrorList", + "traits": { + "smithy.api#documentation": "A list of errors associated with the integration creation.
" + } + }, + "DataFilter": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "Selects source tables for the integration using Maxwell filter syntax.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.glue#CreateIntegrationTableProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#CreateIntegrationTablePropertiesRequest" + }, + "output": { + "target": "com.amazonaws.glue#CreateIntegrationTablePropertiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServerException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "This API is used to provide optional override properties for the the tables that need to be replicated. These properties can include properties for filtering and partitioning for the source and target tables. To set both source and target properties the same API need to be invoked with the Glue connection ARN as ResourceArn
with SourceTableConfig
, and the Glue database ARN as ResourceArn
with TargetTableConfig
respectively.
The connection ARN of the source, or the database ARN of the target.
", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The name of the table to be replicated.
", + "smithy.api#required": {} + } + }, + "SourceTableConfig": { + "target": "com.amazonaws.glue#SourceTableConfig", + "traits": { + "smithy.api#documentation": "A structure for the source table configuration.
" + } + }, + "TargetTableConfig": { + "target": "com.amazonaws.glue#TargetTableConfig", + "traits": { + "smithy.api#documentation": "A structure for the target table configuration.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#CreateIntegrationTablePropertiesResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#CreateJob": { "type": "operation", "input": { @@ -10423,6 +11692,12 @@ { "target": "com.amazonaws.glue#EntityNotFoundException" }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#FederationSourceRetryableException" + }, { "target": "com.amazonaws.glue#GlueEncryptionException" }, @@ -10974,6 +12249,36 @@ "com.amazonaws.glue#CreatedTimestamp": { "type": "string" }, + "com.amazonaws.glue#CredentialKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.glue#CredentialMap": { + "type": "map", + "key": { + "target": "com.amazonaws.glue#CredentialKey" + }, + "value": { + "target": "com.amazonaws.glue#CredentialValue" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.glue#CredentialValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, "com.amazonaws.glue#CronExpression": { "type": "string" }, @@ -11241,6 +12546,15 @@ "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, + "com.amazonaws.glue#CustomProperties": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, "com.amazonaws.glue#DQAdditionalOptions": { "type": "map", "key": { @@ -11421,6 +12735,96 @@ } } }, + "com.amazonaws.glue#DataLakeAccessProperties": { + "type": "structure", + "members": { + "DataLakeAccess": { + "target": "com.amazonaws.glue#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Turns on or off data lake access for Apache Spark applications that access Amazon Redshift databases in the Data Catalog from any non-Redshift engine, such as Amazon Athena, Amazon EMR, or Glue ETL.
" + } + }, + "DataTransferRole": { + "target": "com.amazonaws.glue#IAMRoleArn", + "traits": { + "smithy.api#documentation": "A role that will be assumed by Glue for transferring data into/out of the staging bucket during a query.
" + } + }, + "KmsKey": { + "target": "com.amazonaws.glue#ResourceArnString", + "traits": { + "smithy.api#documentation": "An encryption key that will be used for the staging bucket that will be created along with the catalog.
" + } + }, + "CatalogType": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "Specifies a federated catalog type for the native catalog resource. The currently supported type is aws:redshift
.
Input properties to configure data lake access for your catalog resource in the Glue Data Catalog.
" + } + }, + "com.amazonaws.glue#DataLakeAccessPropertiesOutput": { + "type": "structure", + "members": { + "DataLakeAccess": { + "target": "com.amazonaws.glue#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Turns on or off data lake access for Apache Spark applications that access Amazon Redshift databases in the Data Catalog.
" + } + }, + "DataTransferRole": { + "target": "com.amazonaws.glue#IAMRoleArn", + "traits": { + "smithy.api#documentation": "A role that will be assumed by Glue for transferring data into/out of the staging bucket during a query.
" + } + }, + "KmsKey": { + "target": "com.amazonaws.glue#ResourceArnString", + "traits": { + "smithy.api#documentation": "An encryption key that will be used for the staging bucket that will be created along with the catalog.
" + } + }, + "ManagedWorkgroupName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The managed Redshift Serverless compute name that is created for your catalog resource.
" + } + }, + "ManagedWorkgroupStatus": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The managed Redshift Serverless compute status.
" + } + }, + "RedshiftDatabaseName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The default Redshift database resource name in the managed compute.
" + } + }, + "StatusMessage": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "A message that gives more detailed information about the managed workgroup status.
" + } + }, + "CatalogType": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "Specifies a federated catalog type for the native catalog resource. The currently supported type is aws:redshift
.
The output properties of the data lake access configuration for your catalog resource in the Glue Data Catalog.
" + } + }, "com.amazonaws.glue#DataLakePrincipal": { "type": "structure", "members": { @@ -11444,6 +12848,29 @@ } } }, + "com.amazonaws.glue#DataOperation": { + "type": "enum", + "members": { + "READ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ" + } + }, + "WRITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WRITE" + } + } + } + }, + "com.amazonaws.glue#DataOperations": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#DataOperation" + } + }, "com.amazonaws.glue#DataQualityAnalyzerResult": { "type": "structure", "members": { @@ -12606,6 +14033,66 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#DeleteCatalog": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#DeleteCatalogRequest" + }, + "output": { + "target": "com.amazonaws.glue#DeleteCatalogResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#GlueEncryptionException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "Removes the specified catalog from the Glue Data Catalog.
\nAfter completing this operation, you no longer have access to the databases, tables (and all table versions and partitions that might belong to the tables) and the user-defined functions in the deleted catalog. Glue deletes these \"orphaned\" resources asynchronously in a timely manner, at the discretion of the service.
\nTo ensure the immediate deletion of all related resources before calling the DeleteCatalog
operation, use DeleteTableVersion
(or BatchDeleteTableVersion
), DeletePartition
(or BatchDeletePartition
), DeleteTable
(or BatchDeleteTable
), DeleteUserDefinedFunction
and DeleteDatabase
to delete any resources that belong to the catalog.
The ID of the catalog.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#DeleteCatalogResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#DeleteClassifier": { "type": "operation", "input": { @@ -13078,6 +14565,12 @@ { "target": "com.amazonaws.glue#EntityNotFoundException" }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#FederationSourceRetryableException" + }, { "target": "com.amazonaws.glue#InternalServiceException" }, @@ -13168,6 +14661,218 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#DeleteIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#DeleteIntegrationRequest" + }, + "output": { + "target": "com.amazonaws.glue#DeleteIntegrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#ConflictException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#IntegrationConflictOperationFault" + }, + { + "target": "com.amazonaws.glue#IntegrationNotFoundFault" + }, + { + "target": "com.amazonaws.glue#InternalServerException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#InvalidIntegrationStateFault" + }, + { + "target": "com.amazonaws.glue#InvalidStateException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified Zero-ETL integration.
" + } + }, + "com.amazonaws.glue#DeleteIntegrationRequest": { + "type": "structure", + "members": { + "IntegrationIdentifier": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the integration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#DeleteIntegrationResponse": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The ARN of the source for the integration.
", + "smithy.api#required": {} + } + }, + "TargetArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The ARN of the target for the integration.
", + "smithy.api#required": {} + } + }, + "IntegrationName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "A unique name for an integration in Glue.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.glue#IntegrationDescription", + "traits": { + "smithy.api#documentation": "A description of the integration.
" + } + }, + "IntegrationArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the integration.
", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "The ARN of a KMS key used for encrypting the channel.
" + } + }, + "AdditionalEncryptionContext": { + "target": "com.amazonaws.glue#IntegrationAdditionalEncryptionContextMap", + "traits": { + "smithy.api#documentation": "An optional set of non-secret key–value pairs that contains additional contextual information for encryption.
" + } + }, + "Tags": { + "target": "com.amazonaws.glue#IntegrationTagsList", + "traits": { + "smithy.api#documentation": "Metadata assigned to the resource consisting of a list of key-value pairs.
" + } + }, + "Status": { + "target": "com.amazonaws.glue#IntegrationStatus", + "traits": { + "smithy.api#documentation": "The status of the integration being deleted.
\nThe possible statuses are:
\nCREATING: The integration is being created.
\nACTIVE: The integration creation succeeds.
\nMODIFYING: The integration is being modified.
\nFAILED: The integration creation fails.
\nDELETING: The integration is deleted.
\nSYNCING: The integration is synchronizing.
\nNEEDS_ATTENTION: The integration needs attention, such as synchronization.
\nThe time when the integration was created, in UTC.
", + "smithy.api#required": {} + } + }, + "Errors": { + "target": "com.amazonaws.glue#IntegrationErrorList", + "traits": { + "smithy.api#documentation": "A list of errors associated with the integration.
" + } + }, + "DataFilter": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "Selects source tables for the integration using Maxwell filter syntax.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.glue#DeleteIntegrationTableProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#DeleteIntegrationTablePropertiesRequest" + }, + "output": { + "target": "com.amazonaws.glue#DeleteIntegrationTablePropertiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServerException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the table properties that have been created for the tables that need to be replicated.
" + } + }, + "com.amazonaws.glue#DeleteIntegrationTablePropertiesRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The connection ARN of the source, or the database ARN of the target.
", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The name of the table to be replicated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#DeleteIntegrationTablePropertiesResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#DeleteJob": { "type": "operation", "input": { @@ -13799,6 +15504,12 @@ { "target": "com.amazonaws.glue#EntityNotFoundException" }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#FederationSourceRetryableException" + }, { "target": "com.amazonaws.glue#InternalServiceException" }, @@ -14271,6 +15982,410 @@ "target": "com.amazonaws.glue#DeltaTarget" } }, + "com.amazonaws.glue#DescribeConnectionType": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#DescribeConnectionTypeRequest" + }, + "output": { + "target": "com.amazonaws.glue#DescribeConnectionTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "The DescribeConnectionType
API provides full details of the supported options for a given connection type in Glue.
The name of the connection type to be described.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#DescribeConnectionTypeResponse": { + "type": "structure", + "members": { + "ConnectionType": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The name of the connection type.
" + } + }, + "Description": { + "target": "com.amazonaws.glue#Description", + "traits": { + "smithy.api#documentation": "A description of the connection type.
" + } + }, + "Capabilities": { + "target": "com.amazonaws.glue#Capabilities", + "traits": { + "smithy.api#documentation": "The supported authentication types, data interface types (compute environments), and data operations of the connector.
" + } + }, + "ConnectionProperties": { + "target": "com.amazonaws.glue#PropertiesMap", + "traits": { + "smithy.api#documentation": "Connection properties which are common across compute environments.
" + } + }, + "ConnectionOptions": { + "target": "com.amazonaws.glue#PropertiesMap", + "traits": { + "smithy.api#documentation": "Returns properties that can be set when creating a connection in the ConnectionInput.ConnectionProperties
. ConnectionOptions
defines parameters that can be set in a Spark ETL script in the connection options map passed to a dataframe.
The type of authentication used for the connection.
" + } + }, + "ComputeEnvironmentConfigurations": { + "target": "com.amazonaws.glue#ComputeEnvironmentConfigurationMap", + "traits": { + "smithy.api#documentation": "The compute environments that are supported by the connection.
" + } + }, + "PhysicalConnectionRequirements": { + "target": "com.amazonaws.glue#PropertiesMap", + "traits": { + "smithy.api#documentation": "Physical requirements for a connection, such as VPC, Subnet and Security Group specifications.
" + } + }, + "AthenaConnectionProperties": { + "target": "com.amazonaws.glue#PropertiesMap", + "traits": { + "smithy.api#documentation": "Connection properties specific to the Athena compute environment.
" + } + }, + "PythonConnectionProperties": { + "target": "com.amazonaws.glue#PropertiesMap", + "traits": { + "smithy.api#documentation": "Connection properties specific to the Python compute environment.
" + } + }, + "SparkConnectionProperties": { + "target": "com.amazonaws.glue#PropertiesMap", + "traits": { + "smithy.api#documentation": "Connection properties specific to the Spark compute environment.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.glue#DescribeEntity": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#DescribeEntityRequest" + }, + "output": { + "target": "com.amazonaws.glue#DescribeEntityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#GlueEncryptionException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Provides details regarding the entity used with the connection type, with a description of the data model for each field in the selected entity.
\nThe response includes all the fields which make up the entity.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Fields" + } + } + }, + "com.amazonaws.glue#DescribeEntityRequest": { + "type": "structure", + "members": { + "ConnectionName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The name of the connection that contains the connection type credentials.
", + "smithy.api#required": {} + } + }, + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "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.
" + } + }, + "EntityName": { + "target": "com.amazonaws.glue#EntityName", + "traits": { + "smithy.api#documentation": "The name of the entity that you want to describe from the connection type.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.glue#NextToken", + "traits": { + "smithy.api#documentation": "A continuation token, included if this is a continuation call.
" + } + }, + "DataStoreApiVersion": { + "target": "com.amazonaws.glue#ApiVersion", + "traits": { + "smithy.api#documentation": "The version of the API used for the data store.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#DescribeEntityResponse": { + "type": "structure", + "members": { + "Fields": { + "target": "com.amazonaws.glue#FieldsList", + "traits": { + "smithy.api#documentation": "Describes the fields for that connector entity. This is the list of Field
objects. Field
is very similar to column in a database. The Field
object has information about different properties associated with fields in the connector.
A continuation token, present if the current segment is not the last.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.glue#DescribeInboundIntegrations": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#DescribeInboundIntegrationsRequest" + }, + "output": { + "target": "com.amazonaws.glue#DescribeInboundIntegrationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#IntegrationNotFoundFault" + }, + { + "target": "com.amazonaws.glue#InternalServerException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.glue#TargetResourceNotFound" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of inbound integrations for the specified integration.
" + } + }, + "com.amazonaws.glue#DescribeInboundIntegrationsRequest": { + "type": "structure", + "members": { + "IntegrationArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the integration.
" + } + }, + "Marker": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "A token to specify where to start paginating. This is the marker from a previously truncated response.
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.glue#IntegrationInteger", + "traits": { + "smithy.api#documentation": "The total number of items to return in the output.
" + } + }, + "TargetArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the target resource in the integration.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#DescribeInboundIntegrationsResponse": { + "type": "structure", + "members": { + "InboundIntegrations": { + "target": "com.amazonaws.glue#InboundIntegrationsList", + "traits": { + "smithy.api#documentation": "A list of inbound integrations.
" + } + }, + "Marker": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "A value that indicates the starting point for the next set of response records in a subsequent request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.glue#DescribeIntegrations": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#DescribeIntegrationsRequest" + }, + "output": { + "target": "com.amazonaws.glue#DescribeIntegrationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#IntegrationNotFoundFault" + }, + { + "target": "com.amazonaws.glue#InternalServerException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "The API is used to retrieve a list of integrations.
" + } + }, + "com.amazonaws.glue#DescribeIntegrationsRequest": { + "type": "structure", + "members": { + "IntegrationIdentifier": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the integration.
" + } + }, + "Marker": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "A value that indicates the starting point for the next set of response records in a subsequent request.
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.glue#IntegrationInteger", + "traits": { + "smithy.api#documentation": "The total number of items to return in the output.
" + } + }, + "Filters": { + "target": "com.amazonaws.glue#IntegrationFilterList", + "traits": { + "smithy.api#documentation": "A list of key and values, to filter down the results. Supported keys are \"Status\", \"IntegrationName\", and \"SourceArn\". IntegrationName is limited to only one value.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#DescribeIntegrationsResponse": { + "type": "structure", + "members": { + "Integrations": { + "target": "com.amazonaws.glue#IntegrationsList", + "traits": { + "smithy.api#documentation": "A list of zero-ETL integrations.
" + } + }, + "Marker": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "A value that indicates the starting point for the next set of response records in a subsequent request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.glue#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, "com.amazonaws.glue#DescriptionString": { "type": "string", "traits": { @@ -15043,6 +17158,68 @@ "smithy.api#documentation": "Specifies an encryption configuration.
" } }, + "com.amazonaws.glue#Entity": { + "type": "structure", + "members": { + "EntityName": { + "target": "com.amazonaws.glue#EntityName", + "traits": { + "smithy.api#documentation": "The name of the entity.
" + } + }, + "Label": { + "target": "com.amazonaws.glue#EntityLabel", + "traits": { + "smithy.api#documentation": "Label used for the entity.
" + } + }, + "IsParentEntity": { + "target": "com.amazonaws.glue#IsParentEntity", + "traits": { + "smithy.api#documentation": "A Boolean value which helps to determine whether there are sub objects that can be listed.
" + } + }, + "Description": { + "target": "com.amazonaws.glue#EntityDescription", + "traits": { + "smithy.api#documentation": "A description of the entity.
" + } + }, + "Category": { + "target": "com.amazonaws.glue#Category", + "traits": { + "smithy.api#documentation": "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.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An entity supported by a given ConnectionType
.
The status of the last column statistics task run.
" + } + }, + "ColumnStatisticsTaskRunId": { + "target": "com.amazonaws.glue#HashString", + "traits": { + "smithy.api#documentation": "A task run ID for the last column statistics task run.
" + } + }, + "ExecutionTimestamp": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp when the last column statistics task run occurred.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.glue#DescriptionString", + "traits": { + "smithy.api#documentation": "An error message associated with the last column statistics task run.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A run attempt for a column statistics task run.
" + } + }, "com.amazonaws.glue#ExecutionClass": { "type": "enum", "members": { @@ -15317,6 +17526,23 @@ "smithy.api#documentation": "An execution property of a job.
" } }, + "com.amazonaws.glue#ExecutionStatus": { + "type": "enum", + "members": { + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTED" + } + } + } + }, "com.amazonaws.glue#ExecutionTime": { "type": "integer", "traits": { @@ -15366,6 +17592,26 @@ "smithy.api#pattern": "^[\\s\\S]*$" } }, + "com.amazonaws.glue#FederatedCatalog": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.glue#FederationIdentifier", + "traits": { + "smithy.api#documentation": "A unique identifier for the federated catalog.
" + } + }, + "ConnectionName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The name of the connection to an external data source, for example a Redshift-federated catalog.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A catalog that points to an entity outside the Glue Data Catalog.
" + } + }, "com.amazonaws.glue#FederatedDatabase": { "type": "structure", "members": { @@ -15544,6 +17790,294 @@ "smithy.api#error": "client" } }, + "com.amazonaws.glue#Field": { + "type": "structure", + "members": { + "FieldName": { + "target": "com.amazonaws.glue#EntityFieldName", + "traits": { + "smithy.api#documentation": "A unique identifier for the field.
" + } + }, + "Label": { + "target": "com.amazonaws.glue#FieldLabel", + "traits": { + "smithy.api#documentation": "A readable label used for the field.
" + } + }, + "Description": { + "target": "com.amazonaws.glue#FieldDescription", + "traits": { + "smithy.api#documentation": "A description of the field.
" + } + }, + "FieldType": { + "target": "com.amazonaws.glue#FieldDataType", + "traits": { + "smithy.api#documentation": "The type of data in the field.
" + } + }, + "IsPrimaryKey": { + "target": "com.amazonaws.glue#Bool", + "traits": { + "smithy.api#documentation": "Indicates whether this field can used as a primary key for the given entity.
" + } + }, + "IsNullable": { + "target": "com.amazonaws.glue#Bool", + "traits": { + "smithy.api#documentation": "Indicates whether this field can be nullable or not.
" + } + }, + "IsRetrievable": { + "target": "com.amazonaws.glue#Bool", + "traits": { + "smithy.api#documentation": "Indicates whether this field can be added in Select clause of SQL query or whether it is retrievable or not.
" + } + }, + "IsFilterable": { + "target": "com.amazonaws.glue#Bool", + "traits": { + "smithy.api#documentation": " Indicates whether this field can used in a filter clause (WHERE
clause) of a SQL statement when querying data.
Indicates whether a given field can be used in partitioning the query made to SaaS.
" + } + }, + "IsCreateable": { + "target": "com.amazonaws.glue#Bool", + "traits": { + "smithy.api#documentation": "Indicates whether this field can be created as part of a destination write.
" + } + }, + "IsUpdateable": { + "target": "com.amazonaws.glue#Bool", + "traits": { + "smithy.api#documentation": "Indicates whether this field can be updated as part of a destination write.
" + } + }, + "IsUpsertable": { + "target": "com.amazonaws.glue#Bool", + "traits": { + "smithy.api#documentation": "Indicates whether this field can be upserted as part of a destination write.
" + } + }, + "IsDefaultOnCreate": { + "target": "com.amazonaws.glue#Bool", + "traits": { + "smithy.api#documentation": "Indicates whether this field is populated automatically when the object is created, such as a created at timestamp.
" + } + }, + "SupportedValues": { + "target": "com.amazonaws.glue#ListOfString", + "traits": { + "smithy.api#documentation": "A list of supported values for the field.
" + } + }, + "SupportedFilterOperators": { + "target": "com.amazonaws.glue#FieldFilterOperatorsList", + "traits": { + "smithy.api#documentation": "Indicates the support filter operators for this field.
" + } + }, + "ParentField": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A parent field name for a nested field.
" + } + }, + "NativeDataType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The data type returned by the SaaS API, such as “picklist” or “textarea” from Salesforce.
" + } + }, + "CustomProperties": { + "target": "com.amazonaws.glue#CustomProperties", + "traits": { + "smithy.api#documentation": "Optional map of keys which may be returned.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Field
object has information about the different properties associated with a field in the connector.
The name of the Catalog to retrieve. This should be all lowercase.
" + } + }, "com.amazonaws.glue#GetCatalogImportStatus": { "type": "operation", "input": { @@ -16260,6 +18847,127 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#GetCatalogRequest": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "The ID of the parent catalog in which the catalog resides. If none is provided, the Amazon Web Services Account Number is used by default.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#GetCatalogResponse": { + "type": "structure", + "members": { + "Catalog": { + "target": "com.amazonaws.glue#Catalog", + "traits": { + "smithy.api#documentation": "A Catalog
object. The definition of the specified catalog in the Glue Data Catalog.
Retrieves all catalogs defined in a catalog in the Glue Data Catalog. For a Redshift-federated catalog use case, this operation returns the list of catalogs mapped to Redshift databases in the Redshift namespace catalog.
" + } + }, + "com.amazonaws.glue#GetCatalogsRequest": { + "type": "structure", + "members": { + "ParentCatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "The ID of the parent catalog in which the catalog resides. If none is provided, the Amazon Web Services Account Number is used by default.
" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#Token", + "traits": { + "smithy.api#documentation": "A continuation token, if this is a continuation call.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.glue#PageSize", + "traits": { + "smithy.api#documentation": "The maximum number of catalogs to return in one response.
" + } + }, + "Recursive": { + "target": "com.amazonaws.glue#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "When specified as true, iterates through the account and returns all catalog resources (including top-level resources and child resources)
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#GetCatalogsResponse": { + "type": "structure", + "members": { + "CatalogList": { + "target": "com.amazonaws.glue#CatalogList", + "traits": { + "smithy.api#documentation": "An array of Catalog
objects. A list of Catalog
objects from the specified parent catalog.
A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#GetClassifier": { "type": "operation", "input": { @@ -16793,6 +19501,12 @@ "smithy.api#default": false, "smithy.api#documentation": "Allows you to retrieve the connection metadata without returning the password. For\n instance, the Glue console uses this flag to retrieve the connection, and does not display\n the password. Set this parameter when the caller might not have permission to use the KMS\n key to decrypt the password, but it does have permission to access the rest of the connection\n properties.
" } + }, + "ApplyOverrideForComputeEnvironment": { + "target": "com.amazonaws.glue#ComputeEnvironment", + "traits": { + "smithy.api#documentation": "For connections that may be used in multiple services, specifies returning properties for the specified compute environment.
" + } } }, "traits": { @@ -16858,6 +19572,12 @@ "traits": { "smithy.api#documentation": "The type of connections to return. Currently, SFTP is not supported.
" } + }, + "ConnectionSchemaVersion": { + "target": "com.amazonaws.glue#ConnectionSchemaVersion", + "traits": { + "smithy.api#documentation": "Denotes if the connection was created with schema version 1 or 2.
" + } } }, "traits": { @@ -17889,6 +20609,9 @@ { "target": "com.amazonaws.glue#FederationSourceException" }, + { + "target": "com.amazonaws.glue#FederationSourceRetryableException" + }, { "target": "com.amazonaws.glue#GlueEncryptionException" }, @@ -17950,6 +20673,15 @@ "target": "com.amazonaws.glue#GetDatabasesResponse" }, "errors": [ + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#FederationSourceRetryableException" + }, { "target": "com.amazonaws.glue#GlueEncryptionException" }, @@ -18214,6 +20946,296 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#GetEntityRecords": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#GetEntityRecordsRequest" + }, + "output": { + "target": "com.amazonaws.glue#GetEntityRecordsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#GlueEncryptionException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "This API is used to query preview data from a given connection type or from a native Amazon S3 based Glue Data Catalog.
\nReturns records as an array of JSON blobs. Each record is formatted using Jackson JsonNode based on the field type defined by the DescribeEntity
API.
Spark connectors generate schemas according to the same data type mapping as in the DescribeEntity
API. Spark connectors convert data to the appropriate data types matching the schema when returning rows.
The name of the connection that contains the connection type credentials.
" + } + }, + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "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.
" + } + }, + "EntityName": { + "target": "com.amazonaws.glue#EntityName", + "traits": { + "smithy.api#documentation": "Name of the entity that we want to query the preview data from the given connection type.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.glue#NextToken", + "traits": { + "smithy.api#documentation": "A continuation token, included if this is a continuation call.
" + } + }, + "DataStoreApiVersion": { + "target": "com.amazonaws.glue#ApiVersion", + "traits": { + "smithy.api#documentation": "The API version of the SaaS connector.
" + } + }, + "ConnectionOptions": { + "target": "com.amazonaws.glue#ConnectionOptions", + "traits": { + "smithy.api#documentation": "Connector options that are required to query the data.
" + } + }, + "FilterPredicate": { + "target": "com.amazonaws.glue#FilterPredicate", + "traits": { + "smithy.api#documentation": "A filter predicate that you can apply in the query request.
" + } + }, + "Limit": { + "target": "com.amazonaws.glue#Limit", + "traits": { + "smithy.api#documentation": "Limits the number of records fetched with the request.
", + "smithy.api#required": {} + } + }, + "OrderBy": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A parameter that orders the response preview data.
" + } + }, + "SelectedFields": { + "target": "com.amazonaws.glue#SelectedFields", + "traits": { + "smithy.api#documentation": "List of fields that we want to fetch as part of preview data.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#GetEntityRecordsResponse": { + "type": "structure", + "members": { + "Records": { + "target": "com.amazonaws.glue#Records", + "traits": { + "smithy.api#documentation": "A list of the requested objects.
" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#NextToken", + "traits": { + "smithy.api#documentation": "A continuation token, present if the current segment is not the last.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.glue#GetIntegrationResourceProperty": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#GetIntegrationResourcePropertyRequest" + }, + "output": { + "target": "com.amazonaws.glue#GetIntegrationResourcePropertyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServerException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "This API is used for fetching the ResourceProperty
of the Glue connection (for the source) or Glue database ARN (for the target)
The connection ARN of the source, or the database ARN of the target.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#GetIntegrationResourcePropertyResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The connection ARN of the source, or the database ARN of the target.
" + } + }, + "SourceProcessingProperties": { + "target": "com.amazonaws.glue#SourceProcessingProperties", + "traits": { + "smithy.api#documentation": "The resource properties associated with the integration source.
" + } + }, + "TargetProcessingProperties": { + "target": "com.amazonaws.glue#TargetProcessingProperties", + "traits": { + "smithy.api#documentation": "The resource properties associated with the integration target.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.glue#GetIntegrationTableProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#GetIntegrationTablePropertiesRequest" + }, + "output": { + "target": "com.amazonaws.glue#GetIntegrationTablePropertiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServerException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "This API is used to retrieve optional override properties for the tables that need to be replicated. These properties can include properties for filtering and partition for source and target tables.
" + } + }, + "com.amazonaws.glue#GetIntegrationTablePropertiesRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The connection ARN of the source, or the database ARN of the target.
", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The name of the table to be replicated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#GetIntegrationTablePropertiesResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The connection ARN of the source, or the database ARN of the target.
" + } + }, + "TableName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The name of the table to be replicated.
" + } + }, + "SourceTableConfig": { + "target": "com.amazonaws.glue#SourceTableConfig", + "traits": { + "smithy.api#documentation": "A structure for the source table configuration.
" + } + }, + "TargetTableConfig": { + "target": "com.amazonaws.glue#TargetTableConfig", + "traits": { + "smithy.api#documentation": "A structure for the target table configuration.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#GetJob": { "type": "operation", "input": { @@ -22143,7 +25165,7 @@ "min": 1, "max": 10240 }, - "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):glue:" + "smithy.api#pattern": "^arn:aws(-(cn|us-gov|iso(-[bef])?))?:glue:" } }, "com.amazonaws.glue#GlueSchema": { @@ -22283,7 +25305,7 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "^\\w+\\.\\w+$" + "smithy.api#pattern": "^(\\w+\\.)+\\w+$" } }, "com.amazonaws.glue#GovernedCatalogSource": { @@ -22870,6 +25892,61 @@ "smithy.api#documentation": "Specifies configuration properties for an importing labels task run.
" } }, + "com.amazonaws.glue#InboundIntegration": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The ARN of the source resource for the integration.
", + "smithy.api#required": {} + } + }, + "TargetArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The ARN of the target resource for the integration.
", + "smithy.api#required": {} + } + }, + "IntegrationArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The ARN of the zero-ETL integration.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.glue#IntegrationStatus", + "traits": { + "smithy.api#documentation": "The possible statuses are:
\nCREATING: The integration is being created.
\nACTIVE: The integration creation succeeds.
\nMODIFYING: The integration is being modified.
\nFAILED: The integration creation fails.
\nDELETING: The integration is deleted.
\nSYNCING: The integration is synchronizing.
\nNEEDS_ATTENTION: The integration needs attention, such as synchronization.
\nThe time that the integration was created, in UTC.
", + "smithy.api#required": {} + } + }, + "Errors": { + "target": "com.amazonaws.glue#IntegrationErrorList", + "traits": { + "smithy.api#documentation": "A list of errors associated with the integration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure for an integration that writes data into a resource.
" + } + }, + "com.amazonaws.glue#InboundIntegrationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#InboundIntegration" + } + }, "com.amazonaws.glue#InclusionAnnotationList": { "type": "list", "member": { @@ -22915,6 +25992,330 @@ "smithy.api#default": 0 } }, + "com.amazonaws.glue#Integration": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The ARN for the source of the integration.
", + "smithy.api#required": {} + } + }, + "TargetArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The ARN for the target of the integration.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.glue#IntegrationDescription", + "traits": { + "smithy.api#documentation": "A description for the integration.
" + } + }, + "IntegrationName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "A unique name for the integration.
", + "smithy.api#required": {} + } + }, + "IntegrationArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the integration.
", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "The ARN of a KMS key used for encrypting the channel.
" + } + }, + "AdditionalEncryptionContext": { + "target": "com.amazonaws.glue#IntegrationAdditionalEncryptionContextMap", + "traits": { + "smithy.api#documentation": "An optional set of non-secret key–value pairs that contains additional contextual information for encryption. This can only be provided if KMSKeyId
is provided.
Metadata assigned to the resource consisting of a list of key-value pairs.
" + } + }, + "Status": { + "target": "com.amazonaws.glue#IntegrationStatus", + "traits": { + "smithy.api#documentation": "The possible statuses are:
\nCREATING: The integration is being created.
\nACTIVE: The integration creation succeeds.
\nMODIFYING: The integration is being modified.
\nFAILED: The integration creation fails.
\nDELETING: The integration is deleted.
\nSYNCING: The integration is synchronizing.
\nNEEDS_ATTENTION: The integration needs attention, such as synchronization.
\nThe time that the integration was created, in UTC.
", + "smithy.api#required": {} + } + }, + "Errors": { + "target": "com.amazonaws.glue#IntegrationErrorList", + "traits": { + "smithy.api#documentation": "A list of errors associated with the integration.
" + } + }, + "DataFilter": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "Selects source tables for the integration using Maxwell filter syntax.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a zero-ETL integration.
" + } + }, + "com.amazonaws.glue#IntegrationAdditionalEncryptionContextMap": { + "type": "map", + "key": { + "target": "com.amazonaws.glue#IntegrationString" + }, + "value": { + "target": "com.amazonaws.glue#IntegrationString" + } + }, + "com.amazonaws.glue#IntegrationConflictOperationFault": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#IntegrationErrorMessage", + "traits": { + "smithy.api#documentation": "A message describing the problem.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The requested operation conflicts with another operation.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.glue#IntegrationDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.glue#IntegrationError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The code associated with this error.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "A message describing the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An error associated with a zero-ETL integration.
" + } + }, + "com.amazonaws.glue#IntegrationErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#IntegrationError" + } + }, + "com.amazonaws.glue#IntegrationErrorMessage": { + "type": "string" + }, + "com.amazonaws.glue#IntegrationFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The name of the filter.
" + } + }, + "Values": { + "target": "com.amazonaws.glue#IntegrationFilterValues", + "traits": { + "smithy.api#documentation": "A list of filter values.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A filter that can be used when invoking a DescribeIntegrations
request.
A message describing the problem.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified integration could not be found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.glue#IntegrationPartition": { + "type": "structure", + "members": { + "FieldName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The field name used to partition data on the target.
" + } + }, + "FunctionSpec": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "Specifies a function used to partition data on the target.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that describes how data is partitioned on the target.
" + } + }, + "com.amazonaws.glue#IntegrationPartitionSpecList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#IntegrationPartition" + } + }, + "com.amazonaws.glue#IntegrationQuotaExceededFault": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#IntegrationErrorMessage", + "traits": { + "smithy.api#documentation": "A message describing the problem.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The data processed through your integration exceeded your quota.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.glue#IntegrationStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODIFYING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "SYNCING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNCING" + } + }, + "NEEDS_ATTENTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEEDS_ATTENTION" + } + } + } + }, + "com.amazonaws.glue#IntegrationString": { + "type": "string" + }, + "com.amazonaws.glue#IntegrationTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#Tag" + } + }, + "com.amazonaws.glue#IntegrationTimestamp": { + "type": "timestamp" + }, + "com.amazonaws.glue#IntegrationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#Integration" + } + }, + "com.amazonaws.glue#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#IntegrationErrorMessage", + "traits": { + "smithy.api#documentation": "A message describing the problem.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An internal server error occurred.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, "com.amazonaws.glue#InternalServiceException": { "type": "structure", "members": { @@ -22951,6 +26352,22 @@ "smithy.api#error": "client" } }, + "com.amazonaws.glue#InvalidIntegrationStateFault": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#IntegrationErrorMessage", + "traits": { + "smithy.api#documentation": "A message describing the problem.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The integration is in an invalid state.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.glue#InvalidStateException": { "type": "structure", "members": { @@ -22966,6 +26383,9 @@ "smithy.api#error": "client" } }, + "com.amazonaws.glue#IsParentEntity": { + "type": "boolean" + }, "com.amazonaws.glue#IsVersionValid": { "type": "boolean", "traits": { @@ -24411,6 +27831,33 @@ "com.amazonaws.glue#JsonValue": { "type": "string" }, + "com.amazonaws.glue#JwtToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 8000 + }, + "smithy.api#pattern": "^([a-zA-Z0-9_=]+)\\.([a-zA-Z0-9_=]+)\\.([a-zA-Z0-9_\\-\\+\\/=]*)$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.glue#KMSKeyNotAccessibleFault": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#IntegrationErrorMessage", + "traits": { + "smithy.api#documentation": "A message describing the problem.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The KMS key specified is not accessible.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.glue#KafkaStreamingSourceOptions": { "type": "structure", "members": { @@ -24895,6 +28342,15 @@ "smithy.api#default": false } }, + "com.amazonaws.glue#Limit": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, "com.amazonaws.glue#LimitedPathList": { "type": "list", "member": { @@ -25058,6 +28514,72 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#ListConnectionTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#ListConnectionTypesRequest" + }, + "output": { + "target": "com.amazonaws.glue#ListConnectionTypesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + } + ], + "traits": { + "smithy.api#documentation": "The ListConnectionTypes
API provides a discovery mechanism to learn available connection types in Glue. The response contains a list of connection types with high-level details of what is supported for each connection type. The connection types listed are the set of supported options for the ConnectionType
value in the CreateConnection
API.
The maximum number of results to return.
" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#NextToken", + "traits": { + "smithy.api#documentation": "A continuation token, if this is a continuation call.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#ListConnectionTypesResponse": { + "type": "structure", + "members": { + "ConnectionTypes": { + "target": "com.amazonaws.glue#ConnectionTypeList", + "traits": { + "smithy.api#documentation": "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.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#ListCrawlers": { "type": "operation", "input": { @@ -25818,6 +29340,104 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#ListEntities": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#ListEntitiesRequest" + }, + "output": { + "target": "com.amazonaws.glue#ListEntitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#GlueEncryptionException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the available entities supported by the connection type.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Entities" + } + } + }, + "com.amazonaws.glue#ListEntitiesRequest": { + "type": "structure", + "members": { + "ConnectionName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "A name for the connection that has required credentials to query any connection type.
" + } + }, + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "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.
" + } + }, + "ParentEntityName": { + "target": "com.amazonaws.glue#EntityName", + "traits": { + "smithy.api#documentation": "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.
" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#NextToken", + "traits": { + "smithy.api#documentation": "A continuation token, included if this is a continuation call.
" + } + }, + "DataStoreApiVersion": { + "target": "com.amazonaws.glue#ApiVersion", + "traits": { + "smithy.api#documentation": "The API version of the SaaS connector.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#ListEntitiesResponse": { + "type": "structure", + "members": { + "Entities": { + "target": "com.amazonaws.glue#EntityList", + "traits": { + "smithy.api#documentation": "A list of Entity
objects.
A continuation token, present if the current segment is not the last.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#ListJobs": { "type": "operation", "input": { @@ -25986,6 +29606,12 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#ListOfString": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, "com.amazonaws.glue#ListRegistries": { "type": "operation", "input": { @@ -27233,6 +30859,15 @@ "smithy.api#default": 0 } }, + "com.amazonaws.glue#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.glue#MaxResultsNumber": { "type": "integer", "traits": { @@ -27492,6 +31127,172 @@ "smithy.api#default": 0 } }, + "com.amazonaws.glue#ModifyIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#ModifyIntegrationRequest" + }, + "output": { + "target": "com.amazonaws.glue#ModifyIntegrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#ConflictException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#IntegrationConflictOperationFault" + }, + { + "target": "com.amazonaws.glue#IntegrationNotFoundFault" + }, + { + "target": "com.amazonaws.glue#InternalServerException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#InvalidIntegrationStateFault" + }, + { + "target": "com.amazonaws.glue#InvalidStateException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies a Zero-ETL integration in the caller's account.
" + } + }, + "com.amazonaws.glue#ModifyIntegrationRequest": { + "type": "structure", + "members": { + "IntegrationIdentifier": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the integration.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.glue#IntegrationDescription", + "traits": { + "smithy.api#documentation": "A description of the integration.
" + } + }, + "DataFilter": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "Selects source tables for the integration using Maxwell filter syntax.
" + } + }, + "IntegrationName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "A unique name for an integration in Glue.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#ModifyIntegrationResponse": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The ARN of the source for the integration.
", + "smithy.api#required": {} + } + }, + "TargetArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The ARN of the target for the integration.
", + "smithy.api#required": {} + } + }, + "IntegrationName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "A unique name for an integration in Glue.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.glue#IntegrationDescription", + "traits": { + "smithy.api#documentation": "A description of the integration.
" + } + }, + "IntegrationArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the integration.
", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "The ARN of a KMS key used for encrypting the channel.
" + } + }, + "AdditionalEncryptionContext": { + "target": "com.amazonaws.glue#IntegrationAdditionalEncryptionContextMap", + "traits": { + "smithy.api#documentation": "An optional set of non-secret key–value pairs that contains additional contextual information for encryption.
" + } + }, + "Tags": { + "target": "com.amazonaws.glue#IntegrationTagsList", + "traits": { + "smithy.api#documentation": "Metadata assigned to the resource consisting of a list of key-value pairs.
" + } + }, + "Status": { + "target": "com.amazonaws.glue#IntegrationStatus", + "traits": { + "smithy.api#documentation": "The status of the integration being modified.
\nThe possible statuses are:
\nCREATING: The integration is being created.
\nACTIVE: The integration creation succeeds.
\nMODIFYING: The integration is being modified.
\nFAILED: The integration creation fails.
\nDELETING: The integration is deleted.
\nSYNCING: The integration is synchronizing.
\nNEEDS_ATTENTION: The integration needs attention, such as synchronization.
\nThe time when the integration was created, in UTC.
", + "smithy.api#required": {} + } + }, + "Errors": { + "target": "com.amazonaws.glue#IntegrationErrorList", + "traits": { + "smithy.api#documentation": "A list of errors associated with the integration modification.
" + } + }, + "DataFilter": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "Selects source tables for the integration using Maxwell filter syntax.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#MongoDBTarget": { "type": "structure", "members": { @@ -27611,6 +31412,16 @@ "target": "com.amazonaws.glue#NameString" } }, + "com.amazonaws.glue#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9+=/:_]*$" + } + }, "com.amazonaws.glue#NoScheduleException": { "type": "structure", "members": { @@ -27867,6 +31678,38 @@ "smithy.api#documentation": "The OAuth2 client app used for the connection.
" } }, + "com.amazonaws.glue#OAuth2Credentials": { + "type": "structure", + "members": { + "UserManagedClientApplicationClientSecret": { + "target": "com.amazonaws.glue#UserManagedClientApplicationClientSecret", + "traits": { + "smithy.api#documentation": "The client application client secret if the client application is user managed.
" + } + }, + "AccessToken": { + "target": "com.amazonaws.glue#AccessToken", + "traits": { + "smithy.api#documentation": "The access token used when the authentication type is OAuth2.
" + } + }, + "RefreshToken": { + "target": "com.amazonaws.glue#RefreshToken", + "traits": { + "smithy.api#documentation": "The refresh token used when the authentication type is OAuth2.
" + } + }, + "JwtToken": { + "target": "com.amazonaws.glue#JwtToken", + "traits": { + "smithy.api#documentation": "The JSON Web Token (JWT) used when the authentication type is OAuth2.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The credentials used when the authentication type is OAuth2 authentication.
" + } + }, "com.amazonaws.glue#OAuth2GrantType": { "type": "enum", "members": { @@ -27954,6 +31797,12 @@ "traits": { "smithy.api#documentation": "The set of properties required for the the OAuth2 AUTHORIZATION_CODE
grant type.
The credentials used when the authentication type is OAuth2 authentication.
" + } } }, "traits": { @@ -28052,12 +31901,32 @@ "smithy.api#documentation": "Specifies an option value.
" } }, + "com.amazonaws.glue#OptionKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\w]*$" + } + }, "com.amazonaws.glue#OptionList": { "type": "list", "member": { "target": "com.amazonaws.glue#Option" } }, + "com.amazonaws.glue#OptionValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\S]*$" + } + }, "com.amazonaws.glue#OracleSQLCatalogSource": { "type": "structure", "members": { @@ -28785,6 +32654,17 @@ "smithy.api#documentation": "Contains a list of values defining partitions.
" } }, + "com.amazonaws.glue#Password": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": ".*", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.glue#Path": { "type": "string" }, @@ -29124,6 +33004,12 @@ "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, + "com.amazonaws.glue#PrimaryKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#String128" + } + }, "com.amazonaws.glue#PrincipalPermissions": { "type": "structure", "members": { @@ -29202,6 +33088,79 @@ "smithy.api#documentation": "Specifies the job and session values that an admin configures in an Glue usage profile.
" } }, + "com.amazonaws.glue#PropertiesMap": { + "type": "map", + "key": { + "target": "com.amazonaws.glue#PropertyName" + }, + "value": { + "target": "com.amazonaws.glue#Property" + } + }, + "com.amazonaws.glue#Property": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#PropertyName", + "traits": { + "smithy.api#documentation": "The name of the property.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.glue#PropertyDescriptionString", + "traits": { + "smithy.api#documentation": "A description of the property.
", + "smithy.api#required": {} + } + }, + "Required": { + "target": "com.amazonaws.glue#Bool", + "traits": { + "smithy.api#documentation": "Indicates whether the property is required.
", + "smithy.api#required": {} + } + }, + "DefaultValue": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The default value for the property.
" + } + }, + "PropertyTypes": { + "target": "com.amazonaws.glue#PropertyTypes", + "traits": { + "smithy.api#default": [], + "smithy.api#documentation": "Describes the type of property.
", + "smithy.api#required": {} + } + }, + "AllowedValues": { + "target": "com.amazonaws.glue#AllowedValues", + "traits": { + "smithy.api#documentation": "A list of AllowedValue
objects representing the values allowed for the property.
Indicates which data operations are applicable to the property.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that defines a connection type for a compute environment.
" + } + }, + "com.amazonaws.glue#PropertyDescriptionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, "com.amazonaws.glue#PropertyKey": { "type": "string", "traits": { @@ -29220,6 +33179,24 @@ "target": "com.amazonaws.glue#PropertyValue" } }, + "com.amazonaws.glue#PropertyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.glue#PropertyNameOverrides": { + "type": "map", + "key": { + "target": "com.amazonaws.glue#PropertyName" + }, + "value": { + "target": "com.amazonaws.glue#PropertyName" + } + }, "com.amazonaws.glue#PropertyPredicate": { "type": "structure", "members": { @@ -29246,6 +33223,47 @@ "smithy.api#documentation": "Defines a property predicate.
" } }, + "com.amazonaws.glue#PropertyType": { + "type": "enum", + "members": { + "USER_INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_INPUT" + } + }, + "SECRET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECRET" + } + }, + "READ_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ_ONLY" + } + }, + "UNUSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNUSED" + } + }, + "SECRET_OR_USER_INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECRET_OR_USER_INPUT" + } + } + } + }, + "com.amazonaws.glue#PropertyTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#PropertyType" + } + }, "com.amazonaws.glue#PropertyValue": { "type": "string", "traits": { @@ -29934,6 +33952,21 @@ } } }, + "com.amazonaws.glue#Record": { + "type": "document", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.glue#Records": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#Record" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.glue#RecordsCount": { "type": "long" }, @@ -30085,6 +34118,17 @@ "target": "com.amazonaws.glue#NameString" } }, + "com.amazonaws.glue#RefreshToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + }, + "smithy.api#pattern": "^[\\x20-\\x7E]*$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.glue#RegisterSchemaVersion": { "type": "operation", "input": { @@ -30514,6 +34558,25 @@ } } }, + "com.amazonaws.glue#ResourceArnString": { + "type": "string" + }, + "com.amazonaws.glue#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#IntegrationErrorMessage", + "traits": { + "smithy.api#documentation": "A message describing the problem.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The resource could not be found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, "com.amazonaws.glue#ResourceNotReadyException": { "type": "structure", "members": { @@ -32021,6 +36084,23 @@ } } }, + "com.amazonaws.glue#ScheduleType": { + "type": "enum", + "members": { + "CRON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRON" + } + }, + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + } + } + }, "com.amazonaws.glue#SchedulerNotRunningException": { "type": "structure", "members": { @@ -32683,6 +36763,18 @@ "smithy.api#documentation": "Specifies a transform that chooses one DynamicFrame
from a collection of DynamicFrames
. The output is the selected DynamicFrame
\n
The IAM role to access the Glue connection.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The resource properties associated with the integration source.
" + } + }, + "com.amazonaws.glue#SourceTableConfig": { + "type": "structure", + "members": { + "Fields": { + "target": "com.amazonaws.glue#SourceTableFieldsList", + "traits": { + "smithy.api#documentation": "A list of fields used for column-level filtering.
" + } + }, + "FilterPredicate": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "A condition clause used for row-level filtering.
" + } + }, + "PrimaryKey": { + "target": "com.amazonaws.glue#PrimaryKeyList", + "traits": { + "smithy.api#documentation": "Unique identifier of a record.
" + } + }, + "RecordUpdateField": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "Incremental pull timestamp-based field.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Properties used by the source leg to process data from the source.
" + } + }, + "com.amazonaws.glue#SourceTableFieldsList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#String128" + } + }, "com.amazonaws.glue#SparkConnectorSource": { "type": "structure", "members": { @@ -35562,6 +39723,24 @@ "smithy.api#documentation": "Specifies options related to data preview for viewing a sample of your data.
" } }, + "com.amazonaws.glue#String128": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.glue#String2048": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, "com.amazonaws.glue#StringColumnStatisticsData": { "type": "structure", "members": { @@ -36288,6 +40467,26 @@ "target": "com.amazonaws.glue#TableVersionError" } }, + "com.amazonaws.glue#Tag": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.glue#TagKey", + "traits": { + "smithy.api#documentation": "The tag key. The key is required when you create a tag on an object. The key is case-sensitive, and must not contain the prefix aws.
" + } + }, + "value": { + "target": "com.amazonaws.glue#TagValue", + "traits": { + "smithy.api#documentation": "The tag value. The value is optional when you create a tag on an object. The value is case-sensitive, and must not contain the prefix aws.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Tag
object represents a label that you can assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.
For more information about tags, and controlling access to resources in Glue, see\n Amazon Web Services Tags in Glue and Specifying Glue Resource\n ARNs in the developer guide.
" + } + }, "com.amazonaws.glue#TagKey": { "type": "string", "traits": { @@ -36444,6 +40643,95 @@ } } }, + "com.amazonaws.glue#TargetProcessingProperties": { + "type": "structure", + "members": { + "RoleArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The IAM role to access the Glue database.
" + } + }, + "KmsArn": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "The ARN of the KMS key used for encryption.
" + } + }, + "ConnectionName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The Glue network connection to configure the Glue job running in the customer VPC.
" + } + }, + "EventBusArn": { + "target": "com.amazonaws.glue#String2048", + "traits": { + "smithy.api#documentation": "The ARN of an Eventbridge event bus to receive the integration status notification.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The resource properties associated with the integration target.
" + } + }, + "com.amazonaws.glue#TargetRedshiftCatalog": { + "type": "structure", + "members": { + "CatalogArn": { + "target": "com.amazonaws.glue#ResourceArnString", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the catalog resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that describes a target catalog for resource linking.
" + } + }, + "com.amazonaws.glue#TargetResourceNotFound": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#IntegrationErrorMessage", + "traits": { + "smithy.api#documentation": "A message describing the problem.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The target resource could not be found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.glue#TargetTableConfig": { + "type": "structure", + "members": { + "UnnestSpec": { + "target": "com.amazonaws.glue#UnnestSpec", + "traits": { + "smithy.api#documentation": "Specifies how nested objects are flattened to top-level elements. Valid values are: \"TOPLEVEL\", \"FULL\", or \"NOUNNEST\".
" + } + }, + "PartitionSpec": { + "target": "com.amazonaws.glue#IntegrationPartitionSpecList", + "traits": { + "smithy.api#documentation": "Determines the file layout on the target.
" + } + }, + "TargetTableName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The optional name of a target table.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Properties used by the target leg to partition the data on the target.
" + } + }, "com.amazonaws.glue#TaskRun": { "type": "structure", "members": { @@ -36794,6 +41082,12 @@ "smithy.api#documentation": "Optional. The name of the connection to test. If only name is provided, the operation will get the connection and use that for testing.
" } }, + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "The catalog ID where the connection resides.
" + } + }, "TestConnectionInput": { "target": "com.amazonaws.glue#TestConnectionInput", "traits": { @@ -37556,6 +41850,29 @@ } } }, + "com.amazonaws.glue#UnnestSpec": { + "type": "enum", + "members": { + "TOPLEVEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOPLEVEL" + } + }, + "FULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL" + } + }, + "NOUNNEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOUNNEST" + } + } + } + }, "com.amazonaws.glue#UntagResource": { "type": "operation", "input": { @@ -37702,6 +42019,44 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#UpdateCatalog": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#UpdateCatalogRequest" + }, + "output": { + "target": "com.amazonaws.glue#UpdateCatalogResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#GlueEncryptionException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing catalog's properties in the Glue Data Catalog.
" + } + }, "com.amazonaws.glue#UpdateCatalogBehavior": { "type": "enum", "members": { @@ -37719,6 +42074,35 @@ } } }, + "com.amazonaws.glue#UpdateCatalogRequest": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "The ID of the catalog.
", + "smithy.api#required": {} + } + }, + "CatalogInput": { + "target": "com.amazonaws.glue#CatalogInput", + "traits": { + "smithy.api#documentation": "A CatalogInput
object specifying the new properties of an existing catalog.
Specifies a grok classifier to update when passed to\n UpdateClassifier
.
This API can be used for updating the ResourceProperty
of the Glue connection (for the source) or Glue database ARN (for the target). These properties can include the role to access the connection or database. Since the same resource can be used across multiple integrations, updating resource properties will impact all the integrations using it.
The connection ARN of the source, or the database ARN of the target.
", + "smithy.api#required": {} + } + }, + "SourceProcessingProperties": { + "target": "com.amazonaws.glue#SourceProcessingProperties", + "traits": { + "smithy.api#documentation": "The resource properties associated with the integration source.
" + } + }, + "TargetProcessingProperties": { + "target": "com.amazonaws.glue#TargetProcessingProperties", + "traits": { + "smithy.api#documentation": "The resource properties associated with the integration target.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#UpdateIntegrationResourcePropertyResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The connection ARN of the source, or the database ARN of the target.
" + } + }, + "SourceProcessingProperties": { + "target": "com.amazonaws.glue#SourceProcessingProperties", + "traits": { + "smithy.api#documentation": "The resource properties associated with the integration source.
" + } + }, + "TargetProcessingProperties": { + "target": "com.amazonaws.glue#TargetProcessingProperties", + "traits": { + "smithy.api#documentation": "The resource properties associated with the integration target.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.glue#UpdateIntegrationTableProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#UpdateIntegrationTablePropertiesRequest" + }, + "output": { + "target": "com.amazonaws.glue#UpdateIntegrationTablePropertiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServerException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "This API is used to provide optional override properties for the tables that need to be replicated. These properties can include properties for filtering and partitioning for the source and target tables. To set both source and target properties the same API need to be invoked with the Glue connection ARN as ResourceArn
with SourceTableConfig
, and the Glue database ARN as ResourceArn
with TargetTableConfig
respectively.
The override will be reflected across all the integrations using same ResourceArn
and source table.
The connection ARN of the source, or the database ARN of the target.
", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "The name of the table to be replicated.
", + "smithy.api#required": {} + } + }, + "SourceTableConfig": { + "target": "com.amazonaws.glue#SourceTableConfig", + "traits": { + "smithy.api#documentation": "A structure for the source table configuration.
" + } + }, + "TargetTableConfig": { + "target": "com.amazonaws.glue#TargetTableConfig", + "traits": { + "smithy.api#documentation": "A structure for the target table configuration.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#UpdateIntegrationTablePropertiesResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#UpdateJob": { "type": "operation", "input": { @@ -39324,12 +43881,21 @@ "target": "com.amazonaws.glue#UpdateTableResponse" }, "errors": [ + { + "target": "com.amazonaws.glue#AlreadyExistsException" + }, { "target": "com.amazonaws.glue#ConcurrentModificationException" }, { "target": "com.amazonaws.glue#EntityNotFoundException" }, + { + "target": "com.amazonaws.glue#FederationSourceException" + }, + { + "target": "com.amazonaws.glue#FederationSourceRetryableException" + }, { "target": "com.amazonaws.glue#GlueEncryptionException" }, @@ -39997,6 +44563,27 @@ "smithy.api#pattern": "^\\S+$" } }, + "com.amazonaws.glue#UserManagedClientApplicationClientSecret": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\x20-\\x7E]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.glue#Username": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^\\S+$" + } + }, "com.amazonaws.glue#ValidationException": { "type": "structure", "members": { @@ -40016,7 +44603,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 0, + "min": 1, "max": 1024 } }