Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Glue.Lens

Contents

Operations
Types

Description

Synopsis

Operations

StartImportLabelsTaskRun

startImportLabelsTaskRun_replaceAllLabels :: Lens' StartImportLabelsTaskRun (Maybe Bool) Source #

Indicates whether to overwrite your existing labels.

startImportLabelsTaskRun_transformId :: Lens' StartImportLabelsTaskRun Text Source #

The unique identifier of the machine learning transform.

startImportLabelsTaskRun_inputS3Path :: Lens' StartImportLabelsTaskRun Text Source #

The Amazon Simple Storage Service (Amazon S3) path from where you import the labels.

startImportLabelsTaskRunResponse_taskRunId :: Lens' StartImportLabelsTaskRunResponse (Maybe Text) Source #

The unique identifier for the task run.

startImportLabelsTaskRunResponse_httpStatus :: Lens' StartImportLabelsTaskRunResponse Int Source #

The response's http status code.

UpdateMLTransform

updateMLTransform_numberOfWorkers :: Lens' UpdateMLTransform (Maybe Int) Source #

The number of workers of a defined workerType that are allocated when this task runs.

updateMLTransform_workerType :: Lens' UpdateMLTransform (Maybe WorkerType) Source #

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.

updateMLTransform_glueVersion :: Lens' UpdateMLTransform (Maybe Text) Source #

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.

updateMLTransform_role :: Lens' UpdateMLTransform (Maybe Text) Source #

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.

updateMLTransform_name :: Lens' UpdateMLTransform (Maybe Text) Source #

The unique name that you gave the transform when you created it.

updateMLTransform_parameters :: Lens' UpdateMLTransform (Maybe TransformParameters) Source #

The configuration parameters that are specific to the transform type (algorithm) used. Conditionally dependent on the transform type.

updateMLTransform_maxRetries :: Lens' UpdateMLTransform (Maybe Int) Source #

The maximum number of times to retry a task for this transform after a task run fails.

updateMLTransform_maxCapacity :: Lens' UpdateMLTransform (Maybe Double) Source #

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.

updateMLTransform_timeout :: Lens' UpdateMLTransform (Maybe Natural) Source #

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).

updateMLTransform_description :: Lens' UpdateMLTransform (Maybe Text) Source #

A description of the transform. The default is an empty string.

updateMLTransform_transformId :: Lens' UpdateMLTransform Text Source #

A unique identifier that was generated when the transform was created.

updateMLTransformResponse_transformId :: Lens' UpdateMLTransformResponse (Maybe Text) Source #

The unique identifier for the transform that was updated.

updateMLTransformResponse_httpStatus :: Lens' UpdateMLTransformResponse Int Source #

The response's http status code.

UpdateRegistry

updateRegistry_registryId :: Lens' UpdateRegistry RegistryId Source #

This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).

updateRegistry_description :: Lens' UpdateRegistry Text Source #

A description of the registry. If description is not provided, this field will not be updated.

updateRegistryResponse_registryName :: Lens' UpdateRegistryResponse (Maybe Text) Source #

The name of the updated registry.

updateRegistryResponse_registryArn :: Lens' UpdateRegistryResponse (Maybe Text) Source #

The Amazon Resource name (ARN) of the updated registry.

updateRegistryResponse_httpStatus :: Lens' UpdateRegistryResponse Int Source #

The response's http status code.

DeleteRegistry

deleteRegistry_registryId :: Lens' DeleteRegistry RegistryId Source #

This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).

deleteRegistryResponse_status :: Lens' DeleteRegistryResponse (Maybe RegistryStatus) Source #

The status of the registry. A successful operation will return the Deleting status.

deleteRegistryResponse_registryName :: Lens' DeleteRegistryResponse (Maybe Text) Source #

The name of the registry being deleted.

deleteRegistryResponse_registryArn :: Lens' DeleteRegistryResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the registry being deleted.

deleteRegistryResponse_httpStatus :: Lens' DeleteRegistryResponse Int Source #

The response's http status code.

DeleteMLTransform

deleteMLTransform_transformId :: Lens' DeleteMLTransform Text Source #

The unique identifier of the transform to delete.

deleteMLTransformResponse_transformId :: Lens' DeleteMLTransformResponse (Maybe Text) Source #

The unique identifier of the transform that was deleted.

deleteMLTransformResponse_httpStatus :: Lens' DeleteMLTransformResponse Int Source #

The response's http status code.

StartCrawler

startCrawler_name :: Lens' StartCrawler Text Source #

Name of the crawler to start.

startCrawlerResponse_httpStatus :: Lens' StartCrawlerResponse Int Source #

The response's http status code.

GetCatalogImportStatus

getCatalogImportStatus_catalogId :: Lens' GetCatalogImportStatus (Maybe Text) Source #

The ID of the catalog to migrate. Currently, this should be the Amazon Web Services account ID.

getCatalogImportStatusResponse_importStatus :: Lens' GetCatalogImportStatusResponse (Maybe CatalogImportStatus) Source #

The status of the specified catalog migration.

getCatalogImportStatusResponse_httpStatus :: Lens' GetCatalogImportStatusResponse Int Source #

The response's http status code.

ListMLTransforms

listMLTransforms_nextToken :: Lens' ListMLTransforms (Maybe Text) Source #

A continuation token, if this is a continuation request.

listMLTransforms_sort :: Lens' ListMLTransforms (Maybe TransformSortCriteria) Source #

A TransformSortCriteria used to sort the machine learning transforms.

listMLTransforms_filter :: Lens' ListMLTransforms (Maybe TransformFilterCriteria) Source #

A TransformFilterCriteria used to filter the machine learning transforms.

listMLTransforms_maxResults :: Lens' ListMLTransforms (Maybe Natural) Source #

The maximum size of a list to return.

listMLTransforms_tags :: Lens' ListMLTransforms (Maybe (HashMap Text Text)) Source #

Specifies to return only these tagged resources.

listMLTransformsResponse_nextToken :: Lens' ListMLTransformsResponse (Maybe Text) Source #

A continuation token, if the returned list does not contain the last metric available.

listMLTransformsResponse_httpStatus :: Lens' ListMLTransformsResponse Int Source #

The response's http status code.

listMLTransformsResponse_transformIds :: Lens' ListMLTransformsResponse [Text] Source #

The identifiers of all the machine learning transforms in the account, or the machine learning transforms with the specified tags.

GetPartition

getPartition_catalogId :: Lens' GetPartition (Maybe Text) Source #

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.

getPartition_databaseName :: Lens' GetPartition Text Source #

The name of the catalog database where the partition resides.

getPartition_tableName :: Lens' GetPartition Text Source #

The name of the partition's table.

getPartition_partitionValues :: Lens' GetPartition [Text] Source #

The values that define the partition.

getPartitionResponse_partition :: Lens' GetPartitionResponse (Maybe Partition) Source #

The requested information, in the form of a Partition object.

getPartitionResponse_httpStatus :: Lens' GetPartitionResponse Int Source #

The response's http status code.

QuerySchemaVersionMetadata

querySchemaVersionMetadata_schemaVersionId :: Lens' QuerySchemaVersionMetadata (Maybe Text) Source #

The unique version ID of the schema version.

querySchemaVersionMetadata_schemaId :: Lens' QuerySchemaVersionMetadata (Maybe SchemaId) Source #

A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).

querySchemaVersionMetadata_nextToken :: Lens' QuerySchemaVersionMetadata (Maybe Text) Source #

A continuation token, if this is a continuation call.

querySchemaVersionMetadata_metadataList :: Lens' QuerySchemaVersionMetadata (Maybe [MetadataKeyValuePair]) Source #

Search key-value pairs for metadata, if they are not provided all the metadata information will be fetched.

querySchemaVersionMetadata_schemaVersionNumber :: Lens' QuerySchemaVersionMetadata (Maybe SchemaVersionNumber) Source #

The version number of the schema.

querySchemaVersionMetadata_maxResults :: Lens' QuerySchemaVersionMetadata (Maybe Natural) Source #

Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.

querySchemaVersionMetadataResponse_schemaVersionId :: Lens' QuerySchemaVersionMetadataResponse (Maybe Text) Source #

The unique version ID of the schema version.

querySchemaVersionMetadataResponse_nextToken :: Lens' QuerySchemaVersionMetadataResponse (Maybe Text) Source #

A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

querySchemaVersionMetadataResponse_metadataInfoMap :: Lens' QuerySchemaVersionMetadataResponse (Maybe (HashMap Text MetadataInfo)) Source #

A map of a metadata key and associated values.

querySchemaVersionMetadataResponse_httpStatus :: Lens' QuerySchemaVersionMetadataResponse Int Source #

The response's http status code.

CreateTrigger

createTrigger_workflowName :: Lens' CreateTrigger (Maybe Text) Source #

The name of the workflow associated with the trigger.

createTrigger_schedule :: Lens' CreateTrigger (Maybe Text) Source #

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.

createTrigger_predicate :: Lens' CreateTrigger (Maybe Predicate) Source #

A predicate to specify when the new trigger should fire.

This field is required when the trigger type is CONDITIONAL.

createTrigger_startOnCreation :: Lens' CreateTrigger (Maybe Bool) Source #

Set to true to start SCHEDULED and CONDITIONAL triggers when created. True is not supported for ON_DEMAND triggers.

createTrigger_eventBatchingCondition :: Lens' CreateTrigger (Maybe EventBatchingCondition) Source #

Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.

createTrigger_description :: Lens' CreateTrigger (Maybe Text) Source #

A description of the new trigger.

createTrigger_tags :: Lens' CreateTrigger (Maybe (HashMap Text Text)) Source #

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.

createTrigger_name :: Lens' CreateTrigger Text Source #

The name of the trigger.

createTrigger_type :: Lens' CreateTrigger TriggerType Source #

The type of the new trigger.

createTrigger_actions :: Lens' CreateTrigger [Action] Source #

The actions initiated by this trigger when it fires.

createTriggerResponse_name :: Lens' CreateTriggerResponse (Maybe Text) Source #

The name of the trigger.

createTriggerResponse_httpStatus :: Lens' CreateTriggerResponse Int Source #

The response's http status code.

CheckSchemaVersionValidity

checkSchemaVersionValidity_dataFormat :: Lens' CheckSchemaVersionValidity DataFormat Source #

The data format of the schema definition. Currently AVRO and JSON are supported.

checkSchemaVersionValidity_schemaDefinition :: Lens' CheckSchemaVersionValidity Text Source #

The definition of the schema that has to be validated.

checkSchemaVersionValidityResponse_error :: Lens' CheckSchemaVersionValidityResponse (Maybe Text) Source #

A validation failure error message.

checkSchemaVersionValidityResponse_valid :: Lens' CheckSchemaVersionValidityResponse (Maybe Bool) Source #

Return true, if the schema is valid and false otherwise.

checkSchemaVersionValidityResponse_httpStatus :: Lens' CheckSchemaVersionValidityResponse Int Source #

The response's http status code.

DeleteTable

deleteTable_catalogId :: Lens' DeleteTable (Maybe Text) Source #

The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.

deleteTable_databaseName :: Lens' DeleteTable Text Source #

The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.

deleteTable_name :: Lens' DeleteTable Text Source #

The name of the table to be deleted. For Hive compatibility, this name is entirely lowercase.

deleteTableResponse_httpStatus :: Lens' DeleteTableResponse Int Source #

The response's http status code.

UpdateTable

updateTable_skipArchive :: Lens' UpdateTable (Maybe Bool) Source #

By default, UpdateTable always creates an archived version of the table before updating it. However, if skipArchive is set to true, UpdateTable does not create the archived version.

updateTable_catalogId :: Lens' UpdateTable (Maybe Text) Source #

The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.

updateTable_databaseName :: Lens' UpdateTable Text Source #

The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.

updateTable_tableInput :: Lens' UpdateTable TableInput Source #

An updated TableInput object to define the metadata table in the catalog.

updateTableResponse_httpStatus :: Lens' UpdateTableResponse Int Source #

The response's http status code.

GetWorkflowRuns

getWorkflowRuns_includeGraph :: Lens' GetWorkflowRuns (Maybe Bool) Source #

Specifies whether to include the workflow graph in response or not.

getWorkflowRuns_nextToken :: Lens' GetWorkflowRuns (Maybe Text) Source #

The maximum size of the response.

getWorkflowRuns_maxResults :: Lens' GetWorkflowRuns (Maybe Natural) Source #

The maximum number of workflow runs to be included in the response.

getWorkflowRuns_name :: Lens' GetWorkflowRuns Text Source #

Name of the workflow whose metadata of runs should be returned.

getWorkflowRunsResponse_runs :: Lens' GetWorkflowRunsResponse (Maybe (NonEmpty WorkflowRun)) Source #

A list of workflow run metadata objects.

getWorkflowRunsResponse_nextToken :: Lens' GetWorkflowRunsResponse (Maybe Text) Source #

A continuation token, if not all requested workflow runs have been returned.

getWorkflowRunsResponse_httpStatus :: Lens' GetWorkflowRunsResponse Int Source #

The response's http status code.

CreateWorkflow

createWorkflow_maxConcurrentRuns :: Lens' CreateWorkflow (Maybe Int) Source #

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.

createWorkflow_defaultRunProperties :: Lens' CreateWorkflow (Maybe (HashMap Text Text)) Source #

A collection of properties to be used as part of each execution of the workflow.

createWorkflow_description :: Lens' CreateWorkflow (Maybe Text) Source #

A description of the workflow.

createWorkflow_tags :: Lens' CreateWorkflow (Maybe (HashMap Text Text)) Source #

The tags to be used with this workflow.

createWorkflow_name :: Lens' CreateWorkflow Text Source #

The name to be assigned to the workflow. It should be unique within your account.

createWorkflowResponse_name :: Lens' CreateWorkflowResponse (Maybe Text) Source #

The name of the workflow which was provided as part of the request.

createWorkflowResponse_httpStatus :: Lens' CreateWorkflowResponse Int Source #

The response's http status code.

UpdateColumnStatisticsForTable

updateColumnStatisticsForTable_catalogId :: Lens' UpdateColumnStatisticsForTable (Maybe Text) Source #

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.

updateColumnStatisticsForTable_databaseName :: Lens' UpdateColumnStatisticsForTable Text Source #

The name of the catalog database where the partitions reside.

updateColumnStatisticsForTable_tableName :: Lens' UpdateColumnStatisticsForTable Text Source #

The name of the partitions' table.

updateColumnStatisticsForTable_columnStatisticsList :: Lens' UpdateColumnStatisticsForTable [ColumnStatistics] Source #

A list of the column statistics.

updateColumnStatisticsForTableResponse_errors :: Lens' UpdateColumnStatisticsForTableResponse (Maybe [ColumnStatisticsError]) Source #

List of ColumnStatisticsErrors.

updateColumnStatisticsForTableResponse_httpStatus :: Lens' UpdateColumnStatisticsForTableResponse Int Source #

The response's http status code.

DeleteColumnStatisticsForTable

deleteColumnStatisticsForTable_catalogId :: Lens' DeleteColumnStatisticsForTable (Maybe Text) Source #

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.

deleteColumnStatisticsForTable_databaseName :: Lens' DeleteColumnStatisticsForTable Text Source #

The name of the catalog database where the partitions reside.

deleteColumnStatisticsForTable_tableName :: Lens' DeleteColumnStatisticsForTable Text Source #

The name of the partitions' table.

deleteColumnStatisticsForTable_columnName :: Lens' DeleteColumnStatisticsForTable Text Source #

The name of the column.

deleteColumnStatisticsForTableResponse_httpStatus :: Lens' DeleteColumnStatisticsForTableResponse Int Source #

The response's http status code.

DeleteConnection

deleteConnection_catalogId :: Lens' DeleteConnection (Maybe Text) Source #

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.

deleteConnection_connectionName :: Lens' DeleteConnection Text Source #

The name of the connection to delete.

deleteConnectionResponse_httpStatus :: Lens' DeleteConnectionResponse Int Source #

The response's http status code.

UpdateConnection

updateConnection_catalogId :: Lens' UpdateConnection (Maybe Text) Source #

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.

updateConnection_name :: Lens' UpdateConnection Text Source #

The name of the connection definition to update.

updateConnection_connectionInput :: Lens' UpdateConnection ConnectionInput Source #

A ConnectionInput object that redefines the connection in question.

updateConnectionResponse_httpStatus :: Lens' UpdateConnectionResponse Int Source #

The response's http status code.

GetUserDefinedFunctions

getUserDefinedFunctions_catalogId :: Lens' GetUserDefinedFunctions (Maybe Text) Source #

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.

getUserDefinedFunctions_nextToken :: Lens' GetUserDefinedFunctions (Maybe Text) Source #

A continuation token, if this is a continuation call.

getUserDefinedFunctions_databaseName :: Lens' GetUserDefinedFunctions (Maybe Text) Source #

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.

getUserDefinedFunctions_maxResults :: Lens' GetUserDefinedFunctions (Maybe Natural) Source #

The maximum number of functions to return in one response.

getUserDefinedFunctions_pattern :: Lens' GetUserDefinedFunctions Text Source #

An optional function-name pattern string that filters the function definitions returned.

getUserDefinedFunctionsResponse_nextToken :: Lens' GetUserDefinedFunctionsResponse (Maybe Text) Source #

A continuation token, if the list of functions returned does not include the last requested function.

getUserDefinedFunctionsResponse_userDefinedFunctions :: Lens' GetUserDefinedFunctionsResponse (Maybe [UserDefinedFunction]) Source #

A list of requested function definitions.

getUserDefinedFunctionsResponse_httpStatus :: Lens' GetUserDefinedFunctionsResponse Int Source #

The response's http status code.

GetTags

getTags_resourceArn :: Lens' GetTags Text Source #

The Amazon Resource Name (ARN) of the resource for which to retrieve tags.

getTagsResponse_tags :: Lens' GetTagsResponse (Maybe (HashMap Text Text)) Source #

The requested tags.

getTagsResponse_httpStatus :: Lens' GetTagsResponse Int Source #

The response's http status code.

GetDataCatalogEncryptionSettings

getDataCatalogEncryptionSettings_catalogId :: Lens' GetDataCatalogEncryptionSettings (Maybe Text) Source #

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.

getDataCatalogEncryptionSettingsResponse_dataCatalogEncryptionSettings :: Lens' GetDataCatalogEncryptionSettingsResponse (Maybe DataCatalogEncryptionSettings) Source #

The requested security configuration.

getDataCatalogEncryptionSettingsResponse_httpStatus :: Lens' GetDataCatalogEncryptionSettingsResponse Int Source #

The response's http status code.

BatchCreatePartition

batchCreatePartition_catalogId :: Lens' BatchCreatePartition (Maybe Text) Source #

The ID of the catalog in which the partition is to be created. Currently, this should be the Amazon Web Services account ID.

batchCreatePartition_databaseName :: Lens' BatchCreatePartition Text Source #

The name of the metadata database in which the partition is to be created.

batchCreatePartition_tableName :: Lens' BatchCreatePartition Text Source #

The name of the metadata table in which the partition is to be created.

batchCreatePartition_partitionInputList :: Lens' BatchCreatePartition [PartitionInput] Source #

A list of PartitionInput structures that define the partitions to be created.

batchCreatePartitionResponse_errors :: Lens' BatchCreatePartitionResponse (Maybe [PartitionError]) Source #

The errors encountered when trying to create the requested partitions.

batchCreatePartitionResponse_httpStatus :: Lens' BatchCreatePartitionResponse Int Source #

The response's http status code.

GetMapping

getMapping_sinks :: Lens' GetMapping (Maybe [CatalogEntry]) Source #

A list of target tables.

getMapping_location :: Lens' GetMapping (Maybe Location) Source #

Parameters for the mapping.

getMapping_source :: Lens' GetMapping CatalogEntry Source #

Specifies the source table.

getMappingResponse_httpStatus :: Lens' GetMappingResponse Int Source #

The response's http status code.

getMappingResponse_mapping :: Lens' GetMappingResponse [MappingEntry] Source #

A list of mappings to the specified targets.

DeleteWorkflow

deleteWorkflow_name :: Lens' DeleteWorkflow Text Source #

Name of the workflow to be deleted.

deleteWorkflowResponse_name :: Lens' DeleteWorkflowResponse (Maybe Text) Source #

Name of the workflow specified in input.

deleteWorkflowResponse_httpStatus :: Lens' DeleteWorkflowResponse Int Source #

The response's http status code.

UpdateWorkflow

updateWorkflow_maxConcurrentRuns :: Lens' UpdateWorkflow (Maybe Int) Source #

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.

updateWorkflow_defaultRunProperties :: Lens' UpdateWorkflow (Maybe (HashMap Text Text)) Source #

A collection of properties to be used as part of each execution of the workflow.

updateWorkflow_description :: Lens' UpdateWorkflow (Maybe Text) Source #

The description of the workflow.

updateWorkflow_name :: Lens' UpdateWorkflow Text Source #

Name of the workflow to be updated.

updateWorkflowResponse_name :: Lens' UpdateWorkflowResponse (Maybe Text) Source #

The name of the workflow which was specified in input.

updateWorkflowResponse_httpStatus :: Lens' UpdateWorkflowResponse Int Source #

The response's http status code.

GetTableVersion

getTableVersion_versionId :: Lens' GetTableVersion (Maybe Text) Source #

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.

getTableVersion_catalogId :: Lens' GetTableVersion (Maybe Text) Source #

The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.

getTableVersion_databaseName :: Lens' GetTableVersion Text Source #

The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

getTableVersion_tableName :: Lens' GetTableVersion Text Source #

The name of the table. For Hive compatibility, this name is entirely lowercase.

getTableVersionResponse_tableVersion :: Lens' GetTableVersionResponse (Maybe TableVersion) Source #

The requested table version.

getTableVersionResponse_httpStatus :: Lens' GetTableVersionResponse Int Source #

The response's http status code.

CreateSecurityConfiguration

createSecurityConfiguration_name :: Lens' CreateSecurityConfiguration Text Source #

The name for the new security configuration.

createSecurityConfiguration_encryptionConfiguration :: Lens' CreateSecurityConfiguration EncryptionConfiguration Source #

The encryption configuration for the new security configuration.

createSecurityConfigurationResponse_name :: Lens' CreateSecurityConfigurationResponse (Maybe Text) Source #

The name assigned to the new security configuration.

createSecurityConfigurationResponse_createdTimestamp :: Lens' CreateSecurityConfigurationResponse (Maybe UTCTime) Source #

The time at which the new security configuration was created.

createSecurityConfigurationResponse_httpStatus :: Lens' CreateSecurityConfigurationResponse Int Source #

The response's http status code.

StartWorkflowRun

startWorkflowRun_name :: Lens' StartWorkflowRun Text Source #

The name of the workflow to start.

startWorkflowRunResponse_runId :: Lens' StartWorkflowRunResponse (Maybe Text) Source #

An Id for the new run.

startWorkflowRunResponse_httpStatus :: Lens' StartWorkflowRunResponse Int Source #

The response's http status code.

GetJobs

getJobs_nextToken :: Lens' GetJobs (Maybe Text) Source #

A continuation token, if this is a continuation call.

getJobs_maxResults :: Lens' GetJobs (Maybe Natural) Source #

The maximum size of the response.

getJobsResponse_nextToken :: Lens' GetJobsResponse (Maybe Text) Source #

A continuation token, if not all job definitions have yet been returned.

getJobsResponse_jobs :: Lens' GetJobsResponse (Maybe [Job]) Source #

A list of job definitions.

getJobsResponse_httpStatus :: Lens' GetJobsResponse Int Source #

The response's http status code.

BatchGetWorkflows

batchGetWorkflows_includeGraph :: Lens' BatchGetWorkflows (Maybe Bool) Source #

Specifies whether to include a graph when returning the workflow resource metadata.

batchGetWorkflows_names :: Lens' BatchGetWorkflows (NonEmpty Text) Source #

A list of workflow names, which may be the names returned from the ListWorkflows operation.

batchGetWorkflowsResponse_missingWorkflows :: Lens' BatchGetWorkflowsResponse (Maybe (NonEmpty Text)) Source #

A list of names of workflows not found.

batchGetWorkflowsResponse_workflows :: Lens' BatchGetWorkflowsResponse (Maybe (NonEmpty Workflow)) Source #

A list of workflow resource metadata.

batchGetWorkflowsResponse_httpStatus :: Lens' BatchGetWorkflowsResponse Int Source #

The response's http status code.

GetClassifiers

getClassifiers_nextToken :: Lens' GetClassifiers (Maybe Text) Source #

An optional continuation token.

getClassifiers_maxResults :: Lens' GetClassifiers (Maybe Natural) Source #

The size of the list to return (optional).

getClassifiersResponse_nextToken :: Lens' GetClassifiersResponse (Maybe Text) Source #

A continuation token.

getClassifiersResponse_classifiers :: Lens' GetClassifiersResponse (Maybe [Classifier]) Source #

The requested list of classifier objects.

getClassifiersResponse_httpStatus :: Lens' GetClassifiersResponse Int Source #

The response's http status code.

GetResourcePolicies

getResourcePolicies_nextToken :: Lens' GetResourcePolicies (Maybe Text) Source #

A continuation token, if this is a continuation request.

getResourcePolicies_maxResults :: Lens' GetResourcePolicies (Maybe Natural) Source #

The maximum size of a list to return.

getResourcePoliciesResponse_getResourcePoliciesResponseList :: Lens' GetResourcePoliciesResponse (Maybe [GluePolicy]) Source #

A list of the individual resource policies and the account-level resource policy.

getResourcePoliciesResponse_nextToken :: Lens' GetResourcePoliciesResponse (Maybe Text) Source #

A continuation token, if the returned list does not contain the last resource policy available.

getResourcePoliciesResponse_httpStatus :: Lens' GetResourcePoliciesResponse Int Source #

The response's http status code.

CreateConnection

createConnection_catalogId :: Lens' CreateConnection (Maybe Text) Source #

The ID of the Data Catalog in which to create the connection. If none is provided, the Amazon Web Services account ID is used by default.

createConnection_tags :: Lens' CreateConnection (Maybe (HashMap Text Text)) Source #

The tags you assign to the connection.

createConnection_connectionInput :: Lens' CreateConnection ConnectionInput Source #

A ConnectionInput object defining the connection to create.

createConnectionResponse_httpStatus :: Lens' CreateConnectionResponse Int Source #

The response's http status code.

ListSchemaVersions

listSchemaVersions_nextToken :: Lens' ListSchemaVersions (Maybe Text) Source #

A continuation token, if this is a continuation call.

listSchemaVersions_maxResults :: Lens' ListSchemaVersions (Maybe Natural) Source #

Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.

listSchemaVersions_schemaId :: Lens' ListSchemaVersions SchemaId Source #

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.

listSchemaVersionsResponse_schemas :: Lens' ListSchemaVersionsResponse (Maybe [SchemaVersionListItem]) Source #

An array of SchemaVersionList objects containing details of each schema version.

listSchemaVersionsResponse_nextToken :: Lens' ListSchemaVersionsResponse (Maybe Text) Source #

A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

listSchemaVersionsResponse_httpStatus :: Lens' ListSchemaVersionsResponse Int Source #

The response's http status code.

GetWorkflowRunProperties

getWorkflowRunProperties_name :: Lens' GetWorkflowRunProperties Text Source #

Name of the workflow which was run.

getWorkflowRunProperties_runId :: Lens' GetWorkflowRunProperties Text Source #

The ID of the workflow run whose run properties should be returned.

getWorkflowRunPropertiesResponse_runProperties :: Lens' GetWorkflowRunPropertiesResponse (Maybe (HashMap Text Text)) Source #

The workflow run properties which were set during the specified run.

getWorkflowRunPropertiesResponse_httpStatus :: Lens' GetWorkflowRunPropertiesResponse Int Source #

The response's http status code.

BatchGetDevEndpoints

batchGetDevEndpoints_devEndpointNames :: Lens' BatchGetDevEndpoints (NonEmpty Text) Source #

The list of DevEndpoint names, which might be the names returned from the ListDevEndpoint operation.

batchGetDevEndpointsResponse_devEndpointsNotFound :: Lens' BatchGetDevEndpointsResponse (Maybe (NonEmpty Text)) Source #

A list of DevEndpoints not found.

batchGetDevEndpointsResponse_devEndpoints :: Lens' BatchGetDevEndpointsResponse (Maybe [DevEndpoint]) Source #

A list of DevEndpoint definitions.

batchGetDevEndpointsResponse_httpStatus :: Lens' BatchGetDevEndpointsResponse Int Source #

The response's http status code.

DeletePartitionIndex

deletePartitionIndex_catalogId :: Lens' DeletePartitionIndex (Maybe Text) Source #

The catalog ID where the table resides.

deletePartitionIndex_databaseName :: Lens' DeletePartitionIndex Text Source #

Specifies the name of a database from which you want to delete a partition index.

deletePartitionIndex_tableName :: Lens' DeletePartitionIndex Text Source #

Specifies the name of a table from which you want to delete a partition index.

deletePartitionIndex_indexName :: Lens' DeletePartitionIndex Text Source #

The name of the partition index to be deleted.

deletePartitionIndexResponse_httpStatus :: Lens' DeletePartitionIndexResponse Int Source #

The response's http status code.

DeleteTableVersion

deleteTableVersion_catalogId :: Lens' DeleteTableVersion (Maybe Text) Source #

The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.

deleteTableVersion_databaseName :: Lens' DeleteTableVersion Text Source #

The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

deleteTableVersion_tableName :: Lens' DeleteTableVersion Text Source #

The name of the table. For Hive compatibility, this name is entirely lowercase.

deleteTableVersion_versionId :: Lens' DeleteTableVersion Text Source #

The ID of the table version to be deleted. A VersionID is a string representation of an integer. Each version is incremented by 1.

deleteTableVersionResponse_httpStatus :: Lens' DeleteTableVersionResponse Int Source #

The response's http status code.

DeleteDevEndpoint

deleteDevEndpoint_endpointName :: Lens' DeleteDevEndpoint Text Source #

The name of the DevEndpoint.

deleteDevEndpointResponse_httpStatus :: Lens' DeleteDevEndpointResponse Int Source #

The response's http status code.

UpdateDevEndpoint

updateDevEndpoint_addPublicKeys :: Lens' UpdateDevEndpoint (Maybe [Text]) Source #

The list of public keys for the DevEndpoint to use.

updateDevEndpoint_customLibraries :: Lens' UpdateDevEndpoint (Maybe DevEndpointCustomLibraries) Source #

Custom Python or Java libraries to be loaded in the DevEndpoint.

updateDevEndpoint_publicKey :: Lens' UpdateDevEndpoint (Maybe Text) Source #

The public key for the DevEndpoint to use.

updateDevEndpoint_deleteArguments :: Lens' UpdateDevEndpoint (Maybe [Text]) Source #

The list of argument keys to be deleted from the map of arguments used to configure the DevEndpoint.

updateDevEndpoint_deletePublicKeys :: Lens' UpdateDevEndpoint (Maybe [Text]) Source #

The list of public keys to be deleted from the DevEndpoint.

updateDevEndpoint_updateEtlLibraries :: Lens' UpdateDevEndpoint (Maybe Bool) Source #

True if the list of custom libraries to be loaded in the development endpoint needs to be updated, or False if otherwise.

updateDevEndpoint_addArguments :: Lens' UpdateDevEndpoint (Maybe (HashMap Text Text)) Source #

The map of arguments to add the map of arguments used to configure the DevEndpoint.

Valid arguments are:

```
"--enable-glue-datacatalog": ""
```

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

updateDevEndpoint_endpointName :: Lens' UpdateDevEndpoint Text Source #

The name of the DevEndpoint to be updated.

updateDevEndpointResponse_httpStatus :: Lens' UpdateDevEndpointResponse Int Source #

The response's http status code.

GetWorkflow

getWorkflow_includeGraph :: Lens' GetWorkflow (Maybe Bool) Source #

Specifies whether to include a graph when returning the workflow resource metadata.

getWorkflow_name :: Lens' GetWorkflow Text Source #

The name of the workflow to retrieve.

getWorkflowResponse_workflow :: Lens' GetWorkflowResponse (Maybe Workflow) Source #

The resource metadata for the workflow.

getWorkflowResponse_httpStatus :: Lens' GetWorkflowResponse Int Source #

The response's http status code.

BatchGetCrawlers

batchGetCrawlers_crawlerNames :: Lens' BatchGetCrawlers [Text] Source #

A list of crawler names, which might be the names returned from the ListCrawlers operation.

batchGetCrawlersResponse_crawlersNotFound :: Lens' BatchGetCrawlersResponse (Maybe [Text]) Source #

A list of names of crawlers that were not found.

batchGetCrawlersResponse_crawlers :: Lens' BatchGetCrawlersResponse (Maybe [Crawler]) Source #

A list of crawler definitions.

batchGetCrawlersResponse_httpStatus :: Lens' BatchGetCrawlersResponse Int Source #

The response's http status code.

GetJobBookmark

getJobBookmark_runId :: Lens' GetJobBookmark (Maybe Text) Source #

The unique run identifier associated with this job run.

getJobBookmark_jobName :: Lens' GetJobBookmark Text Source #

The name of the job in question.

getJobBookmarkResponse_jobBookmarkEntry :: Lens' GetJobBookmarkResponse (Maybe JobBookmarkEntry) Source #

A structure that defines a point that a job can resume processing.

getJobBookmarkResponse_httpStatus :: Lens' GetJobBookmarkResponse Int Source #

The response's http status code.

DeleteCrawler

deleteCrawler_name :: Lens' DeleteCrawler Text Source #

The name of the crawler to remove.

deleteCrawlerResponse_httpStatus :: Lens' DeleteCrawlerResponse Int Source #

The response's http status code.

UpdateCrawler

updateCrawler_schemaChangePolicy :: Lens' UpdateCrawler (Maybe SchemaChangePolicy) Source #

The policy for the crawler's update and deletion behavior.

updateCrawler_schedule :: Lens' UpdateCrawler (Maybe Text) Source #

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 * * ? *).

updateCrawler_recrawlPolicy :: Lens' UpdateCrawler (Maybe RecrawlPolicy) Source #

A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.

updateCrawler_classifiers :: Lens' UpdateCrawler (Maybe [Text]) Source #

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.

updateCrawler_role :: Lens' UpdateCrawler (Maybe Text) Source #

The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the new crawler to access customer resources.

updateCrawler_targets :: Lens' UpdateCrawler (Maybe CrawlerTargets) Source #

A list of targets to crawl.

updateCrawler_databaseName :: Lens' UpdateCrawler (Maybe Text) Source #

The Glue database where results are stored, such as: arn:aws:daylight:us-east-1::database/sometable/*.

updateCrawler_crawlerSecurityConfiguration :: Lens' UpdateCrawler (Maybe Text) Source #

The name of the SecurityConfiguration structure to be used by this crawler.

updateCrawler_lineageConfiguration :: Lens' UpdateCrawler (Maybe LineageConfiguration) Source #

Specifies data lineage configuration settings for the crawler.

updateCrawler_configuration :: Lens' UpdateCrawler (Maybe Text) Source #

Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler.

updateCrawler_tablePrefix :: Lens' UpdateCrawler (Maybe Text) Source #

The table prefix used for catalog tables that are created.

updateCrawler_description :: Lens' UpdateCrawler (Maybe Text) Source #

A description of the new crawler.

updateCrawler_name :: Lens' UpdateCrawler Text Source #

Name of the new crawler.

updateCrawlerResponse_httpStatus :: Lens' UpdateCrawlerResponse Int Source #

The response's http status code.

StartExportLabelsTaskRun

startExportLabelsTaskRun_transformId :: Lens' StartExportLabelsTaskRun Text Source #

The unique identifier of the machine learning transform.

startExportLabelsTaskRun_outputS3Path :: Lens' StartExportLabelsTaskRun Text Source #

The Amazon S3 path where you export the labels.

startExportLabelsTaskRunResponse_taskRunId :: Lens' StartExportLabelsTaskRunResponse (Maybe Text) Source #

The unique identifier for the task run.

startExportLabelsTaskRunResponse_httpStatus :: Lens' StartExportLabelsTaskRunResponse Int Source #

The response's http status code.

GetSecurityConfiguration

getSecurityConfiguration_name :: Lens' GetSecurityConfiguration Text Source #

The name of the security configuration to retrieve.

getSecurityConfigurationResponse_securityConfiguration :: Lens' GetSecurityConfigurationResponse (Maybe SecurityConfiguration) Source #

The requested security configuration.

getSecurityConfigurationResponse_httpStatus :: Lens' GetSecurityConfigurationResponse Int Source #

The response's http status code.

CreatePartitionIndex

createPartitionIndex_catalogId :: Lens' CreatePartitionIndex (Maybe Text) Source #

The catalog ID where the table resides.

createPartitionIndex_databaseName :: Lens' CreatePartitionIndex Text Source #

Specifies the name of a database in which you want to create a partition index.

createPartitionIndex_tableName :: Lens' CreatePartitionIndex Text Source #

Specifies the name of a table in which you want to create a partition index.

createPartitionIndex_partitionIndex :: Lens' CreatePartitionIndex PartitionIndex Source #

Specifies a PartitionIndex structure to create a partition index in an existing table.

createPartitionIndexResponse_httpStatus :: Lens' CreatePartitionIndexResponse Int Source #

The response's http status code.

GetBlueprintRun

getBlueprintRun_blueprintName :: Lens' GetBlueprintRun Text Source #

The name of the blueprint.

getBlueprintRun_runId :: Lens' GetBlueprintRun Text Source #

The run ID for the blueprint run you want to retrieve.

getBlueprintRunResponse_blueprintRun :: Lens' GetBlueprintRunResponse (Maybe BlueprintRun) Source #

Returns a BlueprintRun object.

getBlueprintRunResponse_httpStatus :: Lens' GetBlueprintRunResponse Int Source #

The response's http status code.

RemoveSchemaVersionMetadata

removeSchemaVersionMetadata_schemaVersionId :: Lens' RemoveSchemaVersionMetadata (Maybe Text) Source #

The unique version ID of the schema version.

removeSchemaVersionMetadata_schemaId :: Lens' RemoveSchemaVersionMetadata (Maybe SchemaId) Source #

A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).

removeSchemaVersionMetadata_schemaVersionNumber :: Lens' RemoveSchemaVersionMetadata (Maybe SchemaVersionNumber) Source #

The version number of the schema.

removeSchemaVersionMetadata_metadataKeyValue :: Lens' RemoveSchemaVersionMetadata MetadataKeyValuePair Source #

The value of the metadata key.

removeSchemaVersionMetadataResponse_registryName :: Lens' RemoveSchemaVersionMetadataResponse (Maybe Text) Source #

The name of the registry.

removeSchemaVersionMetadataResponse_schemaName :: Lens' RemoveSchemaVersionMetadataResponse (Maybe Text) Source #

The name of the schema.

removeSchemaVersionMetadataResponse_schemaVersionId :: Lens' RemoveSchemaVersionMetadataResponse (Maybe Text) Source #

The version ID for the schema version.

removeSchemaVersionMetadataResponse_versionNumber :: Lens' RemoveSchemaVersionMetadataResponse (Maybe Natural) Source #

The version number of the schema.

removeSchemaVersionMetadataResponse_schemaArn :: Lens' RemoveSchemaVersionMetadataResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the schema.

removeSchemaVersionMetadataResponse_metadataKey :: Lens' RemoveSchemaVersionMetadataResponse (Maybe Text) Source #

The metadata key.

removeSchemaVersionMetadataResponse_metadataValue :: Lens' RemoveSchemaVersionMetadataResponse (Maybe Text) Source #

The value of the metadata key.

removeSchemaVersionMetadataResponse_latestVersion :: Lens' RemoveSchemaVersionMetadataResponse (Maybe Bool) Source #

The latest version of the schema.

removeSchemaVersionMetadataResponse_httpStatus :: Lens' RemoveSchemaVersionMetadataResponse Int Source #

The response's http status code.

ListSchemas

listSchemas_registryId :: Lens' ListSchemas (Maybe RegistryId) Source #

A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).

listSchemas_nextToken :: Lens' ListSchemas (Maybe Text) Source #

A continuation token, if this is a continuation call.

listSchemas_maxResults :: Lens' ListSchemas (Maybe Natural) Source #

Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.

listSchemasResponse_schemas :: Lens' ListSchemasResponse (Maybe [SchemaListItem]) Source #

An array of SchemaListItem objects containing details of each schema.

listSchemasResponse_nextToken :: Lens' ListSchemasResponse (Maybe Text) Source #

A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

listSchemasResponse_httpStatus :: Lens' ListSchemasResponse Int Source #

The response's http status code.

GetConnection

getConnection_catalogId :: Lens' GetConnection (Maybe Text) Source #

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.

getConnection_hidePassword :: Lens' GetConnection (Maybe Bool) Source #

Allows you to retrieve the connection metadata without returning the password. For instance, the AWS 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.

getConnection_name :: Lens' GetConnection Text Source #

The name of the connection definition to retrieve.

getConnectionResponse_connection :: Lens' GetConnectionResponse (Maybe Connection) Source #

The requested connection definition.

getConnectionResponse_httpStatus :: Lens' GetConnectionResponse Int Source #

The response's http status code.

GetColumnStatisticsForTable

getColumnStatisticsForTable_catalogId :: Lens' GetColumnStatisticsForTable (Maybe Text) Source #

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.

getColumnStatisticsForTable_databaseName :: Lens' GetColumnStatisticsForTable Text Source #

The name of the catalog database where the partitions reside.

getColumnStatisticsForTable_tableName :: Lens' GetColumnStatisticsForTable Text Source #

The name of the partitions' table.

getColumnStatisticsForTable_columnNames :: Lens' GetColumnStatisticsForTable [Text] Source #

A list of the column names.

getColumnStatisticsForTableResponse_errors :: Lens' GetColumnStatisticsForTableResponse (Maybe [ColumnError]) Source #

List of ColumnStatistics that failed to be retrieved.

getColumnStatisticsForTableResponse_columnStatisticsList :: Lens' GetColumnStatisticsForTableResponse (Maybe [ColumnStatistics]) Source #

List of ColumnStatistics that failed to be retrieved.

getColumnStatisticsForTableResponse_httpStatus :: Lens' GetColumnStatisticsForTableResponse Int Source #

The response's http status code.

BatchGetPartition

batchGetPartition_catalogId :: Lens' BatchGetPartition (Maybe Text) Source #

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.

batchGetPartition_databaseName :: Lens' BatchGetPartition Text Source #

The name of the catalog database where the partitions reside.

batchGetPartition_tableName :: Lens' BatchGetPartition Text Source #

The name of the partitions' table.

batchGetPartition_partitionsToGet :: Lens' BatchGetPartition [PartitionValueList] Source #

A list of partition values identifying the partitions to retrieve.

batchGetPartitionResponse_unprocessedKeys :: Lens' BatchGetPartitionResponse (Maybe [PartitionValueList]) Source #

A list of the partition values in the request for which partitions were not returned.

batchGetPartitionResponse_partitions :: Lens' BatchGetPartitionResponse (Maybe [Partition]) Source #

A list of the requested partitions.

batchGetPartitionResponse_httpStatus :: Lens' BatchGetPartitionResponse Int Source #

The response's http status code.

StopTrigger

stopTrigger_name :: Lens' StopTrigger Text Source #

The name of the trigger to stop.

stopTriggerResponse_name :: Lens' StopTriggerResponse (Maybe Text) Source #

The name of the trigger that was stopped.

stopTriggerResponse_httpStatus :: Lens' StopTriggerResponse Int Source #

The response's http status code.

UpdateCrawlerSchedule

updateCrawlerSchedule_schedule :: Lens' UpdateCrawlerSchedule (Maybe Text) Source #

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 * * ? *).

updateCrawlerSchedule_crawlerName :: Lens' UpdateCrawlerSchedule Text Source #

The name of the crawler whose schedule to update.

updateCrawlerScheduleResponse_httpStatus :: Lens' UpdateCrawlerScheduleResponse Int Source #

The response's http status code.

StartMLEvaluationTaskRun

startMLEvaluationTaskRun_transformId :: Lens' StartMLEvaluationTaskRun Text Source #

The unique identifier of the machine learning transform.

startMLEvaluationTaskRunResponse_taskRunId :: Lens' StartMLEvaluationTaskRunResponse (Maybe Text) Source #

The unique identifier associated with this run.

startMLEvaluationTaskRunResponse_httpStatus :: Lens' StartMLEvaluationTaskRunResponse Int Source #

The response's http status code.

DeleteUserDefinedFunction

deleteUserDefinedFunction_catalogId :: Lens' DeleteUserDefinedFunction (Maybe Text) Source #

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.

deleteUserDefinedFunction_databaseName :: Lens' DeleteUserDefinedFunction Text Source #

The name of the catalog database where the function is located.

deleteUserDefinedFunction_functionName :: Lens' DeleteUserDefinedFunction Text Source #

The name of the function definition to be deleted.

deleteUserDefinedFunctionResponse_httpStatus :: Lens' DeleteUserDefinedFunctionResponse Int Source #

The response's http status code.

UpdateUserDefinedFunction

updateUserDefinedFunction_catalogId :: Lens' UpdateUserDefinedFunction (Maybe Text) Source #

The ID of the Data Catalog where the function to be updated is located. If none is provided, the Amazon Web Services account ID is used by default.

updateUserDefinedFunction_databaseName :: Lens' UpdateUserDefinedFunction Text Source #

The name of the catalog database where the function to be updated is located.

updateUserDefinedFunction_functionName :: Lens' UpdateUserDefinedFunction Text Source #

The name of the function.

updateUserDefinedFunction_functionInput :: Lens' UpdateUserDefinedFunction UserDefinedFunctionInput Source #

A FunctionInput object that redefines the function in the Data Catalog.

updateUserDefinedFunctionResponse_httpStatus :: Lens' UpdateUserDefinedFunctionResponse Int Source #

The response's http status code.

GetRegistry

getRegistry_registryId :: Lens' GetRegistry RegistryId Source #

This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).

getRegistryResponse_status :: Lens' GetRegistryResponse (Maybe RegistryStatus) Source #

The status of the registry.

getRegistryResponse_registryName :: Lens' GetRegistryResponse (Maybe Text) Source #

The name of the registry.

getRegistryResponse_createdTime :: Lens' GetRegistryResponse (Maybe Text) Source #

The date and time the registry was created.

getRegistryResponse_registryArn :: Lens' GetRegistryResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the registry.

getRegistryResponse_updatedTime :: Lens' GetRegistryResponse (Maybe Text) Source #

The date and time the registry was updated.

getRegistryResponse_description :: Lens' GetRegistryResponse (Maybe Text) Source #

A description of the registry.

getRegistryResponse_httpStatus :: Lens' GetRegistryResponse Int Source #

The response's http status code.

BatchDeleteTable

batchDeleteTable_catalogId :: Lens' BatchDeleteTable (Maybe Text) Source #

The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.

batchDeleteTable_databaseName :: Lens' BatchDeleteTable Text Source #

The name of the catalog database in which the tables to delete reside. For Hive compatibility, this name is entirely lowercase.

batchDeleteTable_tablesToDelete :: Lens' BatchDeleteTable [Text] Source #

A list of the table to delete.

batchDeleteTableResponse_errors :: Lens' BatchDeleteTableResponse (Maybe [TableError]) Source #

A list of errors encountered in attempting to delete the specified tables.

batchDeleteTableResponse_httpStatus :: Lens' BatchDeleteTableResponse Int Source #

The response's http status code.

CancelMLTaskRun

cancelMLTaskRun_transformId :: Lens' CancelMLTaskRun Text Source #

The unique identifier of the machine learning transform.

cancelMLTaskRun_taskRunId :: Lens' CancelMLTaskRun Text Source #

A unique identifier for the task run.

cancelMLTaskRunResponse_status :: Lens' CancelMLTaskRunResponse (Maybe TaskStatusType) Source #

The status for this run.

cancelMLTaskRunResponse_transformId :: Lens' CancelMLTaskRunResponse (Maybe Text) Source #

The unique identifier of the machine learning transform.

cancelMLTaskRunResponse_taskRunId :: Lens' CancelMLTaskRunResponse (Maybe Text) Source #

The unique identifier for the task run.

cancelMLTaskRunResponse_httpStatus :: Lens' CancelMLTaskRunResponse Int Source #

The response's http status code.

GetTables

getTables_catalogId :: Lens' GetTables (Maybe Text) Source #

The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.

getTables_nextToken :: Lens' GetTables (Maybe Text) Source #

A continuation token, included if this is a continuation call.

getTables_expression :: Lens' GetTables (Maybe Text) Source #

A regular expression pattern. If present, only those tables whose names match the pattern are returned.

getTables_maxResults :: Lens' GetTables (Maybe Natural) Source #

The maximum number of tables to return in a single response.

getTables_databaseName :: Lens' GetTables Text Source #

The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.

getTablesResponse_tableList :: Lens' GetTablesResponse (Maybe [Table]) Source #

A list of the requested Table objects.

getTablesResponse_nextToken :: Lens' GetTablesResponse (Maybe Text) Source #

A continuation token, present if the current list segment is not the last.

getTablesResponse_httpStatus :: Lens' GetTablesResponse Int Source #

The response's http status code.

ResumeWorkflowRun

resumeWorkflowRun_name :: Lens' ResumeWorkflowRun Text Source #

The name of the workflow to resume.

resumeWorkflowRun_runId :: Lens' ResumeWorkflowRun Text Source #

The ID of the workflow run to resume.

resumeWorkflowRun_nodeIds :: Lens' ResumeWorkflowRun [Text] Source #

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.

resumeWorkflowRunResponse_nodeIds :: Lens' ResumeWorkflowRunResponse (Maybe [Text]) Source #

A list of the node IDs for the nodes that were actually restarted.

resumeWorkflowRunResponse_runId :: Lens' ResumeWorkflowRunResponse (Maybe Text) Source #

The new ID assigned to the resumed workflow run. Each resume of a workflow run will have a new run ID.

resumeWorkflowRunResponse_httpStatus :: Lens' ResumeWorkflowRunResponse Int Source #

The response's http status code.

CreateClassifier

createClassifier_grokClassifier :: Lens' CreateClassifier (Maybe CreateGrokClassifierRequest) Source #

A GrokClassifier object specifying the classifier to create.

createClassifier_xMLClassifier :: Lens' CreateClassifier (Maybe CreateXMLClassifierRequest) Source #

An XMLClassifier object specifying the classifier to create.

createClassifier_csvClassifier :: Lens' CreateClassifier (Maybe CreateCsvClassifierRequest) Source #

A CsvClassifier object specifying the classifier to create.

createClassifier_jsonClassifier :: Lens' CreateClassifier (Maybe CreateJsonClassifierRequest) Source #

A JsonClassifier object specifying the classifier to create.

createClassifierResponse_httpStatus :: Lens' CreateClassifierResponse Int Source #

The response's http status code.

BatchDeleteConnection

batchDeleteConnection_catalogId :: Lens' BatchDeleteConnection (Maybe Text) Source #

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.

batchDeleteConnection_connectionNameList :: Lens' BatchDeleteConnection [Text] Source #

A list of names of the connections to delete.

batchDeleteConnectionResponse_succeeded :: Lens' BatchDeleteConnectionResponse (Maybe [Text]) Source #

A list of names of the connection definitions that were successfully deleted.

batchDeleteConnectionResponse_errors :: Lens' BatchDeleteConnectionResponse (Maybe (HashMap Text ErrorDetail)) Source #

A map of the names of connections that were not successfully deleted to error details.

batchDeleteConnectionResponse_httpStatus :: Lens' BatchDeleteConnectionResponse Int Source #

The response's http status code.

CreateJob

createJob_numberOfWorkers :: Lens' CreateJob (Maybe Int) Source #

The number of workers of a defined workerType that are allocated when a job runs.

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

createJob_notificationProperty :: Lens' CreateJob (Maybe NotificationProperty) Source #

Specifies configuration properties of a job notification.

createJob_connections :: Lens' CreateJob (Maybe ConnectionsList) Source #

The connections used for this job.

createJob_workerType :: Lens' CreateJob (Maybe WorkerType) Source #

The type of predefined worker that is allocated when a job 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 maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.

createJob_securityConfiguration :: Lens' CreateJob (Maybe Text) Source #

The name of the SecurityConfiguration structure to be used with this job.

createJob_glueVersion :: Lens' CreateJob (Maybe Text) Source #

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Jobs that are created without specifying a Glue version default to Glue 0.9.

createJob_nonOverridableArguments :: Lens' CreateJob (Maybe (HashMap Text Text)) Source #

Non-overridable arguments for this job, specified as name-value pairs.

createJob_logUri :: Lens' CreateJob (Maybe Text) Source #

This field is reserved for future use.

createJob_maxRetries :: Lens' CreateJob (Maybe Int) Source #

The maximum number of times to retry this job if it fails.

createJob_executionProperty :: Lens' CreateJob (Maybe ExecutionProperty) Source #

An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

createJob_allocatedCapacity :: Lens' CreateJob (Maybe Int) Source #

This parameter is deprecated. Use MaxCapacity instead.

The number of Glue data processing units (DPUs) to allocate to this Job. 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.

createJob_maxCapacity :: Lens' CreateJob (Maybe Double) Source #

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.

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark 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.

For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.

createJob_timeout :: Lens' CreateJob (Maybe Natural) Source #

The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

createJob_defaultArguments :: Lens' CreateJob (Maybe (HashMap Text Text)) Source #

The default arguments for this job.

You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.

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 key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.

createJob_description :: Lens' CreateJob (Maybe Text) Source #

Description of the job being defined.

createJob_tags :: Lens' CreateJob (Maybe (HashMap Text Text)) Source #

The tags to use with this job. You may use tags to limit access to the job. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.

createJob_name :: Lens' CreateJob Text Source #

The name you assign to this job definition. It must be unique in your account.

createJob_role :: Lens' CreateJob Text Source #

The name or Amazon Resource Name (ARN) of the IAM role associated with this job.

createJob_command :: Lens' CreateJob JobCommand Source #

The JobCommand that runs this job.

createJobResponse_name :: Lens' CreateJobResponse (Maybe Text) Source #

The unique name that was provided for this job definition.

createJobResponse_httpStatus :: Lens' CreateJobResponse Int Source #

The response's http status code.

GetJobRuns

getJobRuns_nextToken :: Lens' GetJobRuns (Maybe Text) Source #

A continuation token, if this is a continuation call.

getJobRuns_maxResults :: Lens' GetJobRuns (Maybe Natural) Source #

The maximum size of the response.

getJobRuns_jobName :: Lens' GetJobRuns Text Source #

The name of the job definition for which to retrieve all job runs.

getJobRunsResponse_nextToken :: Lens' GetJobRunsResponse (Maybe Text) Source #

A continuation token, if not all requested job runs have been returned.

getJobRunsResponse_jobRuns :: Lens' GetJobRunsResponse (Maybe [JobRun]) Source #

A list of job-run metadata objects.

getJobRunsResponse_httpStatus :: Lens' GetJobRunsResponse Int Source #

The response's http status code.

CreateUserDefinedFunction

createUserDefinedFunction_catalogId :: Lens' CreateUserDefinedFunction (Maybe Text) Source #

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.

createUserDefinedFunction_databaseName :: Lens' CreateUserDefinedFunction Text Source #

The name of the catalog database in which to create the function.

createUserDefinedFunction_functionInput :: Lens' CreateUserDefinedFunction UserDefinedFunctionInput Source #

A FunctionInput object that defines the function to create in the Data Catalog.

createUserDefinedFunctionResponse_httpStatus :: Lens' CreateUserDefinedFunctionResponse Int Source #

The response's http status code.

ResetJobBookmark

resetJobBookmark_runId :: Lens' ResetJobBookmark (Maybe Text) Source #

The unique run identifier associated with this job run.

resetJobBookmark_jobName :: Lens' ResetJobBookmark Text Source #

The name of the job in question.

resetJobBookmarkResponse_jobBookmarkEntry :: Lens' ResetJobBookmarkResponse (Maybe JobBookmarkEntry) Source #

The reset bookmark entry.

resetJobBookmarkResponse_httpStatus :: Lens' ResetJobBookmarkResponse Int Source #

The response's http status code.

ListJobs

listJobs_nextToken :: Lens' ListJobs (Maybe Text) Source #

A continuation token, if this is a continuation request.

listJobs_maxResults :: Lens' ListJobs (Maybe Natural) Source #

The maximum size of a list to return.

listJobs_tags :: Lens' ListJobs (Maybe (HashMap Text Text)) Source #

Specifies to return only these tagged resources.

listJobsResponse_nextToken :: Lens' ListJobsResponse (Maybe Text) Source #

A continuation token, if the returned list does not contain the last metric available.

listJobsResponse_jobNames :: Lens' ListJobsResponse (Maybe [Text]) Source #

The names of all jobs in the account, or the jobs with the specified tags.

listJobsResponse_httpStatus :: Lens' ListJobsResponse Int Source #

The response's http status code.

StartBlueprintRun

startBlueprintRun_parameters :: Lens' StartBlueprintRun (Maybe Text) Source #

Specifies the parameters as a BlueprintParameters object.

startBlueprintRun_blueprintName :: Lens' StartBlueprintRun Text Source #

The name of the blueprint.

startBlueprintRun_roleArn :: Lens' StartBlueprintRun Text Source #

Specifies the IAM role used to create the workflow.

startBlueprintRunResponse_runId :: Lens' StartBlueprintRunResponse (Maybe Text) Source #

The run ID for this blueprint run.

startBlueprintRunResponse_httpStatus :: Lens' StartBlueprintRunResponse Int Source #

The response's http status code.

BatchGetBlueprints

batchGetBlueprints_includeParameterSpec :: Lens' BatchGetBlueprints (Maybe Bool) Source #

Specifies whether or not to include the parameters, as a JSON string, for the blueprint in the response.

batchGetBlueprints_includeBlueprint :: Lens' BatchGetBlueprints (Maybe Bool) Source #

Specifies whether or not to include the blueprint in the response.

batchGetBlueprints_names :: Lens' BatchGetBlueprints (NonEmpty Text) Source #

A list of blueprint names.

batchGetBlueprintsResponse_blueprints :: Lens' BatchGetBlueprintsResponse (Maybe [Blueprint]) Source #

Returns a list of blueprint as a Blueprints object.

batchGetBlueprintsResponse_missingBlueprints :: Lens' BatchGetBlueprintsResponse (Maybe [Text]) Source #

Returns a list of BlueprintNames that were not found.

batchGetBlueprintsResponse_httpStatus :: Lens' BatchGetBlueprintsResponse Int Source #

The response's http status code.

DeleteJob

deleteJob_jobName :: Lens' DeleteJob Text Source #

The name of the job definition to delete.

deleteJobResponse_jobName :: Lens' DeleteJobResponse (Maybe Text) Source #

The name of the job definition that was deleted.

deleteJobResponse_httpStatus :: Lens' DeleteJobResponse Int Source #

The response's http status code.

UpdateJob

updateJob_jobName :: Lens' UpdateJob Text Source #

The name of the job definition to update.

updateJob_jobUpdate :: Lens' UpdateJob JobUpdate Source #

Specifies the values with which to update the job definition.

updateJobResponse_jobName :: Lens' UpdateJobResponse (Maybe Text) Source #

Returns the name of the updated job definition.

updateJobResponse_httpStatus :: Lens' UpdateJobResponse Int Source #

The response's http status code.

CreateRegistry

createRegistry_description :: Lens' CreateRegistry (Maybe Text) Source #

A description of the registry. If description is not provided, there will not be any default value for this.

createRegistry_tags :: Lens' CreateRegistry (Maybe (HashMap Text Text)) Source #

Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API.

createRegistry_registryName :: Lens' CreateRegistry Text Source #

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.

createRegistryResponse_registryName :: Lens' CreateRegistryResponse (Maybe Text) Source #

The name of the registry.

createRegistryResponse_registryArn :: Lens' CreateRegistryResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the newly created registry.

createRegistryResponse_description :: Lens' CreateRegistryResponse (Maybe Text) Source #

A description of the registry.

createRegistryResponse_tags :: Lens' CreateRegistryResponse (Maybe (HashMap Text Text)) Source #

The tags for the registry.

createRegistryResponse_httpStatus :: Lens' CreateRegistryResponse Int Source #

The response's http status code.

GetCrawlers

getCrawlers_nextToken :: Lens' GetCrawlers (Maybe Text) Source #

A continuation token, if this is a continuation request.

getCrawlers_maxResults :: Lens' GetCrawlers (Maybe Natural) Source #

The number of crawlers to return on each call.

getCrawlersResponse_nextToken :: Lens' GetCrawlersResponse (Maybe Text) Source #

A continuation token, if the returned list has not reached the end of those defined in this customer account.

getCrawlersResponse_crawlers :: Lens' GetCrawlersResponse (Maybe [Crawler]) Source #

A list of crawler metadata.

getCrawlersResponse_httpStatus :: Lens' GetCrawlersResponse Int Source #

The response's http status code.

ListTriggers

listTriggers_nextToken :: Lens' ListTriggers (Maybe Text) Source #

A continuation token, if this is a continuation request.

listTriggers_maxResults :: Lens' ListTriggers (Maybe Natural) Source #

The maximum size of a list to return.

listTriggers_tags :: Lens' ListTriggers (Maybe (HashMap Text Text)) Source #

Specifies to return only these tagged resources.

listTriggers_dependentJobName :: Lens' ListTriggers (Maybe Text) Source #

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.

listTriggersResponse_triggerNames :: Lens' ListTriggersResponse (Maybe [Text]) Source #

The names of all triggers in the account, or the triggers with the specified tags.

listTriggersResponse_nextToken :: Lens' ListTriggersResponse (Maybe Text) Source #

A continuation token, if the returned list does not contain the last metric available.

listTriggersResponse_httpStatus :: Lens' ListTriggersResponse Int Source #

The response's http status code.

GetClassifier

getClassifier_name :: Lens' GetClassifier Text Source #

Name of the classifier to retrieve.

getClassifierResponse_classifier :: Lens' GetClassifierResponse (Maybe Classifier) Source #

The requested classifier.

getClassifierResponse_httpStatus :: Lens' GetClassifierResponse Int Source #

The response's http status code.

GetJob

getJob_jobName :: Lens' GetJob Text Source #

The name of the job definition to retrieve.

getJobResponse_job :: Lens' GetJobResponse (Maybe Job) Source #

The requested job definition.

getJobResponse_httpStatus :: Lens' GetJobResponse Int Source #

The response's http status code.

ListRegistries

listRegistries_nextToken :: Lens' ListRegistries (Maybe Text) Source #

A continuation token, if this is a continuation call.

listRegistries_maxResults :: Lens' ListRegistries (Maybe Natural) Source #

Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.

listRegistriesResponse_registries :: Lens' ListRegistriesResponse (Maybe [RegistryListItem]) Source #

An array of RegistryDetailedListItem objects containing minimal details of each registry.

listRegistriesResponse_nextToken :: Lens' ListRegistriesResponse (Maybe Text) Source #

A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

listRegistriesResponse_httpStatus :: Lens' ListRegistriesResponse Int Source #

The response's http status code.

BatchDeleteTableVersion

batchDeleteTableVersion_catalogId :: Lens' BatchDeleteTableVersion (Maybe Text) Source #

The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.

batchDeleteTableVersion_databaseName :: Lens' BatchDeleteTableVersion Text Source #

The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

batchDeleteTableVersion_tableName :: Lens' BatchDeleteTableVersion Text Source #

The name of the table. For Hive compatibility, this name is entirely lowercase.

batchDeleteTableVersion_versionIds :: Lens' BatchDeleteTableVersion [Text] Source #

A list of the IDs of versions to be deleted. A VersionId is a string representation of an integer. Each version is incremented by 1.

batchDeleteTableVersionResponse_errors :: Lens' BatchDeleteTableVersionResponse (Maybe [TableVersionError]) Source #

A list of errors encountered while trying to delete the specified table versions.

batchDeleteTableVersionResponse_httpStatus :: Lens' BatchDeleteTableVersionResponse Int Source #

The response's http status code.

GetDevEndpoints

getDevEndpoints_nextToken :: Lens' GetDevEndpoints (Maybe Text) Source #

A continuation token, if this is a continuation call.

getDevEndpoints_maxResults :: Lens' GetDevEndpoints (Maybe Natural) Source #

The maximum size of information to return.

getDevEndpointsResponse_nextToken :: Lens' GetDevEndpointsResponse (Maybe Text) Source #

A continuation token, if not all DevEndpoint definitions have yet been returned.

getDevEndpointsResponse_devEndpoints :: Lens' GetDevEndpointsResponse (Maybe [DevEndpoint]) Source #

A list of DevEndpoint definitions.

getDevEndpointsResponse_httpStatus :: Lens' GetDevEndpointsResponse Int Source #

The response's http status code.

StartCrawlerSchedule

startCrawlerSchedule_crawlerName :: Lens' StartCrawlerSchedule Text Source #

Name of the crawler to schedule.

startCrawlerScheduleResponse_httpStatus :: Lens' StartCrawlerScheduleResponse Int Source #

The response's http status code.

GetPartitionIndexes

getPartitionIndexes_catalogId :: Lens' GetPartitionIndexes (Maybe Text) Source #

The catalog ID where the table resides.

getPartitionIndexes_nextToken :: Lens' GetPartitionIndexes (Maybe Text) Source #

A continuation token, included if this is a continuation call.

getPartitionIndexes_databaseName :: Lens' GetPartitionIndexes Text Source #

Specifies the name of a database from which you want to retrieve partition indexes.

getPartitionIndexes_tableName :: Lens' GetPartitionIndexes Text Source #

Specifies the name of a table for which you want to retrieve the partition indexes.

getPartitionIndexesResponse_partitionIndexDescriptorList :: Lens' GetPartitionIndexesResponse (Maybe [PartitionIndexDescriptor]) Source #

A list of index descriptors.

getPartitionIndexesResponse_nextToken :: Lens' GetPartitionIndexesResponse (Maybe Text) Source #

A continuation token, present if the current list segment is not the last.

getPartitionIndexesResponse_httpStatus :: Lens' GetPartitionIndexesResponse Int Source #

The response's http status code.

GetUserDefinedFunction

getUserDefinedFunction_catalogId :: Lens' GetUserDefinedFunction (Maybe Text) Source #

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.

getUserDefinedFunction_databaseName :: Lens' GetUserDefinedFunction Text Source #

The name of the catalog database where the function is located.

getUserDefinedFunction_functionName :: Lens' GetUserDefinedFunction Text Source #

The name of the function.

getUserDefinedFunctionResponse_userDefinedFunction :: Lens' GetUserDefinedFunctionResponse (Maybe UserDefinedFunction) Source #

The requested function definition.

getUserDefinedFunctionResponse_httpStatus :: Lens' GetUserDefinedFunctionResponse Int Source #

The response's http status code.

GetResourcePolicy

getResourcePolicy_resourceArn :: Lens' GetResourcePolicy (Maybe Text) Source #

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.

getResourcePolicyResponse_policyInJson :: Lens' GetResourcePolicyResponse (Maybe Text) Source #

Contains the requested policy document, in JSON format.

getResourcePolicyResponse_updateTime :: Lens' GetResourcePolicyResponse (Maybe UTCTime) Source #

The date and time at which the policy was last updated.

getResourcePolicyResponse_policyHash :: Lens' GetResourcePolicyResponse (Maybe Text) Source #

Contains the hash value associated with this policy.

getResourcePolicyResponse_createTime :: Lens' GetResourcePolicyResponse (Maybe UTCTime) Source #

The date and time at which the policy was created.

getResourcePolicyResponse_httpStatus :: Lens' GetResourcePolicyResponse Int Source #

The response's http status code.

GetWorkflowRun

getWorkflowRun_includeGraph :: Lens' GetWorkflowRun (Maybe Bool) Source #

Specifies whether to include the workflow graph in response or not.

getWorkflowRun_name :: Lens' GetWorkflowRun Text Source #

Name of the workflow being run.

getWorkflowRun_runId :: Lens' GetWorkflowRun Text Source #

The ID of the workflow run.

getWorkflowRunResponse_run :: Lens' GetWorkflowRunResponse (Maybe WorkflowRun) Source #

The requested workflow run metadata.

getWorkflowRunResponse_httpStatus :: Lens' GetWorkflowRunResponse Int Source #

The response's http status code.

DeleteDatabase

deleteDatabase_catalogId :: Lens' DeleteDatabase (Maybe Text) Source #

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.

deleteDatabase_name :: Lens' DeleteDatabase Text Source #

The name of the database to delete. For Hive compatibility, this must be all lowercase.

deleteDatabaseResponse_httpStatus :: Lens' DeleteDatabaseResponse Int Source #

The response's http status code.

UpdateDatabase

updateDatabase_catalogId :: Lens' UpdateDatabase (Maybe Text) Source #

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.

updateDatabase_name :: Lens' UpdateDatabase Text Source #

The name of the database to update in the catalog. For Hive compatibility, this is folded to lowercase.

updateDatabase_databaseInput :: Lens' UpdateDatabase DatabaseInput Source #

A DatabaseInput object specifying the new definition of the metadata database in the catalog.

updateDatabaseResponse_httpStatus :: Lens' UpdateDatabaseResponse Int Source #

The response's http status code.

GetColumnStatisticsForPartition

getColumnStatisticsForPartition_catalogId :: Lens' GetColumnStatisticsForPartition (Maybe Text) Source #

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.

getColumnStatisticsForPartition_databaseName :: Lens' GetColumnStatisticsForPartition Text Source #

The name of the catalog database where the partitions reside.

getColumnStatisticsForPartition_tableName :: Lens' GetColumnStatisticsForPartition Text Source #

The name of the partitions' table.

getColumnStatisticsForPartition_partitionValues :: Lens' GetColumnStatisticsForPartition [Text] Source #

A list of partition values identifying the partition.

getColumnStatisticsForPartition_columnNames :: Lens' GetColumnStatisticsForPartition [Text] Source #

A list of the column names.

getColumnStatisticsForPartitionResponse_errors :: Lens' GetColumnStatisticsForPartitionResponse (Maybe [ColumnError]) Source #

Error occurred during retrieving column statistics data.

getColumnStatisticsForPartitionResponse_columnStatisticsList :: Lens' GetColumnStatisticsForPartitionResponse (Maybe [ColumnStatistics]) Source #

List of ColumnStatistics that failed to be retrieved.

getColumnStatisticsForPartitionResponse_httpStatus :: Lens' GetColumnStatisticsForPartitionResponse Int Source #

The response's http status code.

StopCrawler

stopCrawler_name :: Lens' StopCrawler Text Source #

Name of the crawler to stop.

stopCrawlerResponse_httpStatus :: Lens' StopCrawlerResponse Int Source #

The response's http status code.

DeleteSecurityConfiguration

deleteSecurityConfiguration_name :: Lens' DeleteSecurityConfiguration Text Source #

The name of the security configuration to delete.

deleteSecurityConfigurationResponse_httpStatus :: Lens' DeleteSecurityConfigurationResponse Int Source #

The response's http status code.

GetPartitions

getPartitions_catalogId :: Lens' GetPartitions (Maybe Text) Source #

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.

getPartitions_excludeColumnSchema :: Lens' GetPartitions (Maybe Bool) Source #

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.

getPartitions_nextToken :: Lens' GetPartitions (Maybe Text) Source #

A continuation token, if this is not the first call to retrieve these partitions.

getPartitions_expression :: Lens' GetPartitions (Maybe Text) Source #

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.

AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL

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:

getPartitions_segment :: Lens' GetPartitions (Maybe Segment) Source #

The segment of the table's partitions to scan in this request.

getPartitions_maxResults :: Lens' GetPartitions (Maybe Natural) Source #

The maximum number of partitions to return in a single response.

getPartitions_databaseName :: Lens' GetPartitions Text Source #

The name of the catalog database where the partitions reside.

getPartitions_tableName :: Lens' GetPartitions Text Source #

The name of the partitions' table.

getPartitionsResponse_partitions :: Lens' GetPartitionsResponse (Maybe [Partition]) Source #

A list of requested partitions.

getPartitionsResponse_nextToken :: Lens' GetPartitionsResponse (Maybe Text) Source #

A continuation token, if the returned list of partitions does not include the last one.

getPartitionsResponse_httpStatus :: Lens' GetPartitionsResponse Int Source #

The response's http status code.

PutSchemaVersionMetadata

putSchemaVersionMetadata_schemaVersionId :: Lens' PutSchemaVersionMetadata (Maybe Text) Source #

The unique version ID of the schema version.

putSchemaVersionMetadata_schemaId :: Lens' PutSchemaVersionMetadata (Maybe SchemaId) Source #

The unique ID for the schema.

putSchemaVersionMetadata_schemaVersionNumber :: Lens' PutSchemaVersionMetadata (Maybe SchemaVersionNumber) Source #

The version number of the schema.

putSchemaVersionMetadata_metadataKeyValue :: Lens' PutSchemaVersionMetadata MetadataKeyValuePair Source #

The metadata key's corresponding value.

putSchemaVersionMetadataResponse_registryName :: Lens' PutSchemaVersionMetadataResponse (Maybe Text) Source #

The name for the registry.

putSchemaVersionMetadataResponse_schemaName :: Lens' PutSchemaVersionMetadataResponse (Maybe Text) Source #

The name for the schema.

putSchemaVersionMetadataResponse_schemaVersionId :: Lens' PutSchemaVersionMetadataResponse (Maybe Text) Source #

The unique version ID of the schema version.

putSchemaVersionMetadataResponse_versionNumber :: Lens' PutSchemaVersionMetadataResponse (Maybe Natural) Source #

The version number of the schema.

putSchemaVersionMetadataResponse_schemaArn :: Lens' PutSchemaVersionMetadataResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the schema.

putSchemaVersionMetadataResponse_metadataKey :: Lens' PutSchemaVersionMetadataResponse (Maybe Text) Source #

The metadata key.

putSchemaVersionMetadataResponse_metadataValue :: Lens' PutSchemaVersionMetadataResponse (Maybe Text) Source #

The value of the metadata key.

putSchemaVersionMetadataResponse_latestVersion :: Lens' PutSchemaVersionMetadataResponse (Maybe Bool) Source #

The latest version of the schema.

putSchemaVersionMetadataResponse_httpStatus :: Lens' PutSchemaVersionMetadataResponse Int Source #

The response's http status code.

GetSchema

getSchema_schemaId :: Lens' GetSchema SchemaId Source #

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.

getSchemaResponse_registryName :: Lens' GetSchemaResponse (Maybe Text) Source #

The name of the registry.

getSchemaResponse_createdTime :: Lens' GetSchemaResponse (Maybe Text) Source #

The date and time the schema was created.

getSchemaResponse_schemaStatus :: Lens' GetSchemaResponse (Maybe SchemaStatus) Source #

The status of the schema.

getSchemaResponse_registryArn :: Lens' GetSchemaResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the registry.

getSchemaResponse_latestSchemaVersion :: Lens' GetSchemaResponse (Maybe Natural) Source #

The latest version of the schema associated with the returned schema definition.

getSchemaResponse_dataFormat :: Lens' GetSchemaResponse (Maybe DataFormat) Source #

The data format of the schema definition. Currently AVRO and JSON are supported.

getSchemaResponse_schemaCheckpoint :: Lens' GetSchemaResponse (Maybe Natural) Source #

The version number of the checkpoint (the last time the compatibility mode was changed).

getSchemaResponse_schemaName :: Lens' GetSchemaResponse (Maybe Text) Source #

The name of the schema.

getSchemaResponse_schemaArn :: Lens' GetSchemaResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the schema.

getSchemaResponse_nextSchemaVersion :: Lens' GetSchemaResponse (Maybe Natural) Source #

The next version of the schema associated with the returned schema definition.

getSchemaResponse_updatedTime :: Lens' GetSchemaResponse (Maybe Text) Source #

The date and time the schema was updated.

getSchemaResponse_description :: Lens' GetSchemaResponse (Maybe Text) Source #

A description of schema if specified when created

getSchemaResponse_compatibility :: Lens' GetSchemaResponse (Maybe Compatibility) Source #

The compatibility mode of the schema.

getSchemaResponse_httpStatus :: Lens' GetSchemaResponse Int Source #

The response's http status code.

BatchDeletePartition

batchDeletePartition_catalogId :: Lens' BatchDeletePartition (Maybe Text) Source #

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.

batchDeletePartition_databaseName :: Lens' BatchDeletePartition Text Source #

The name of the catalog database in which the table in question resides.

batchDeletePartition_tableName :: Lens' BatchDeletePartition Text Source #

The name of the table that contains the partitions to be deleted.

batchDeletePartition_partitionsToDelete :: Lens' BatchDeletePartition [PartitionValueList] Source #

A list of PartitionInput structures that define the partitions to be deleted.

batchDeletePartitionResponse_errors :: Lens' BatchDeletePartitionResponse (Maybe [PartitionError]) Source #

The errors encountered when trying to delete the requested partitions.

batchDeletePartitionResponse_httpStatus :: Lens' BatchDeletePartitionResponse Int Source #

The response's http status code.

StartMLLabelingSetGenerationTaskRun

startMLLabelingSetGenerationTaskRun_transformId :: Lens' StartMLLabelingSetGenerationTaskRun Text Source #

The unique identifier of the machine learning transform.

startMLLabelingSetGenerationTaskRun_outputS3Path :: Lens' StartMLLabelingSetGenerationTaskRun Text Source #

The Amazon Simple Storage Service (Amazon S3) path where you generate the labeling set.

startMLLabelingSetGenerationTaskRunResponse_taskRunId :: Lens' StartMLLabelingSetGenerationTaskRunResponse (Maybe Text) Source #

The unique run identifier that is associated with this task run.

startMLLabelingSetGenerationTaskRunResponse_httpStatus :: Lens' StartMLLabelingSetGenerationTaskRunResponse Int Source #

The response's http status code.

BatchUpdatePartition

batchUpdatePartition_catalogId :: Lens' BatchUpdatePartition (Maybe Text) Source #

The ID of the catalog in which the partition is to be updated. Currently, this should be the Amazon Web Services account ID.

batchUpdatePartition_databaseName :: Lens' BatchUpdatePartition Text Source #

The name of the metadata database in which the partition is to be updated.

batchUpdatePartition_tableName :: Lens' BatchUpdatePartition Text Source #

The name of the metadata table in which the partition is to be updated.

batchUpdatePartition_entries :: Lens' BatchUpdatePartition (NonEmpty BatchUpdatePartitionRequestEntry) Source #

A list of up to 100 BatchUpdatePartitionRequestEntry objects to update.

batchUpdatePartitionResponse_errors :: Lens' BatchUpdatePartitionResponse (Maybe [BatchUpdatePartitionFailureEntry]) Source #

The errors encountered when trying to update the requested partitions. A list of BatchUpdatePartitionFailureEntry objects.

batchUpdatePartitionResponse_httpStatus :: Lens' BatchUpdatePartitionResponse Int Source #

The response's http status code.

RegisterSchemaVersion

registerSchemaVersion_schemaId :: Lens' RegisterSchemaVersion SchemaId Source #

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.

registerSchemaVersion_schemaDefinition :: Lens' RegisterSchemaVersion Text Source #

The schema definition using the DataFormat setting for the SchemaName.

registerSchemaVersionResponse_status :: Lens' RegisterSchemaVersionResponse (Maybe SchemaVersionStatus) Source #

The status of the schema version.

registerSchemaVersionResponse_schemaVersionId :: Lens' RegisterSchemaVersionResponse (Maybe Text) Source #

The unique ID that represents the version of this schema.

registerSchemaVersionResponse_versionNumber :: Lens' RegisterSchemaVersionResponse (Maybe Natural) Source #

The version of this schema (for sync flow only, in case this is the first version).

registerSchemaVersionResponse_httpStatus :: Lens' RegisterSchemaVersionResponse Int Source #

The response's http status code.

StopWorkflowRun

stopWorkflowRun_name :: Lens' StopWorkflowRun Text Source #

The name of the workflow to stop.

stopWorkflowRun_runId :: Lens' StopWorkflowRun Text Source #

The ID of the workflow run to stop.

stopWorkflowRunResponse_httpStatus :: Lens' StopWorkflowRunResponse Int Source #

The response's http status code.

GetCrawler

getCrawler_name :: Lens' GetCrawler Text Source #

The name of the crawler to retrieve metadata for.

getCrawlerResponse_crawler :: Lens' GetCrawlerResponse (Maybe Crawler) Source #

The metadata for the specified crawler.

getCrawlerResponse_httpStatus :: Lens' GetCrawlerResponse Int Source #

The response's http status code.

ListWorkflows

listWorkflows_nextToken :: Lens' ListWorkflows (Maybe Text) Source #

A continuation token, if this is a continuation request.

listWorkflows_maxResults :: Lens' ListWorkflows (Maybe Natural) Source #

The maximum size of a list to return.

listWorkflowsResponse_nextToken :: Lens' ListWorkflowsResponse (Maybe Text) Source #

A continuation token, if not all workflow names have been returned.

listWorkflowsResponse_workflows :: Lens' ListWorkflowsResponse (Maybe (NonEmpty Text)) Source #

List of names of workflows in the account.

listWorkflowsResponse_httpStatus :: Lens' ListWorkflowsResponse Int Source #

The response's http status code.

BatchStopJobRun

batchStopJobRun_jobName :: Lens' BatchStopJobRun Text Source #

The name of the job definition for which to stop job runs.

batchStopJobRun_jobRunIds :: Lens' BatchStopJobRun (NonEmpty Text) Source #

A list of the JobRunIds that should be stopped for that job definition.

batchStopJobRunResponse_successfulSubmissions :: Lens' BatchStopJobRunResponse (Maybe [BatchStopJobRunSuccessfulSubmission]) Source #

A list of the JobRuns that were successfully submitted for stopping.

batchStopJobRunResponse_errors :: Lens' BatchStopJobRunResponse (Maybe [BatchStopJobRunError]) Source #

A list of the errors that were encountered in trying to stop JobRuns, including the JobRunId for which each error was encountered and details about the error.

batchStopJobRunResponse_httpStatus :: Lens' BatchStopJobRunResponse Int Source #

The response's http status code.

GetDevEndpoint

getDevEndpoint_endpointName :: Lens' GetDevEndpoint Text Source #

Name of the DevEndpoint to retrieve information for.

getDevEndpointResponse_devEndpoint :: Lens' GetDevEndpointResponse (Maybe DevEndpoint) Source #

A DevEndpoint definition.

getDevEndpointResponse_httpStatus :: Lens' GetDevEndpointResponse Int Source #

The response's http status code.

PutWorkflowRunProperties

putWorkflowRunProperties_name :: Lens' PutWorkflowRunProperties Text Source #

Name of the workflow which was run.

putWorkflowRunProperties_runId :: Lens' PutWorkflowRunProperties Text Source #

The ID of the workflow run for which the run properties should be updated.

putWorkflowRunProperties_runProperties :: Lens' PutWorkflowRunProperties (HashMap Text Text) Source #

The properties to put for the specified run.

putWorkflowRunPropertiesResponse_httpStatus :: Lens' PutWorkflowRunPropertiesResponse Int Source #

The response's http status code.

CreateTable

createTable_partitionIndexes :: Lens' CreateTable (Maybe [PartitionIndex]) Source #

A list of partition indexes, PartitionIndex structures, to create in the table.

createTable_catalogId :: Lens' CreateTable (Maybe Text) Source #

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.

createTable_databaseName :: Lens' CreateTable Text Source #

The catalog database in which to create the new table. For Hive compatibility, this name is entirely lowercase.

createTable_tableInput :: Lens' CreateTable TableInput Source #

The TableInput object that defines the metadata table to create in the catalog.

createTableResponse_httpStatus :: Lens' CreateTableResponse Int Source #

The response's http status code.

ListCrawlers

listCrawlers_nextToken :: Lens' ListCrawlers (Maybe Text) Source #

A continuation token, if this is a continuation request.

listCrawlers_maxResults :: Lens' ListCrawlers (Maybe Natural) Source #

The maximum size of a list to return.

listCrawlers_tags :: Lens' ListCrawlers (Maybe (HashMap Text Text)) Source #

Specifies to return only these tagged resources.

listCrawlersResponse_nextToken :: Lens' ListCrawlersResponse (Maybe Text) Source #

A continuation token, if the returned list does not contain the last metric available.

listCrawlersResponse_crawlerNames :: Lens' ListCrawlersResponse (Maybe [Text]) Source #

The names of all crawlers in the account, or the crawlers with the specified tags.

listCrawlersResponse_httpStatus :: Lens' ListCrawlersResponse Int Source #

The response's http status code.

GetCrawlerMetrics

getCrawlerMetrics_nextToken :: Lens' GetCrawlerMetrics (Maybe Text) Source #

A continuation token, if this is a continuation call.

getCrawlerMetrics_maxResults :: Lens' GetCrawlerMetrics (Maybe Natural) Source #

The maximum size of a list to return.

getCrawlerMetrics_crawlerNameList :: Lens' GetCrawlerMetrics (Maybe [Text]) Source #

A list of the names of crawlers about which to retrieve metrics.

getCrawlerMetricsResponse_crawlerMetricsList :: Lens' GetCrawlerMetricsResponse (Maybe [CrawlerMetrics]) Source #

A list of metrics for the specified crawler.

getCrawlerMetricsResponse_nextToken :: Lens' GetCrawlerMetricsResponse (Maybe Text) Source #

A continuation token, if the returned list does not contain the last metric available.

getCrawlerMetricsResponse_httpStatus :: Lens' GetCrawlerMetricsResponse Int Source #

The response's http status code.

GetSchemaVersion

getSchemaVersion_schemaVersionId :: Lens' GetSchemaVersion (Maybe Text) Source #

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.

getSchemaVersion_schemaId :: Lens' GetSchemaVersion (Maybe SchemaId) Source #

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.

getSchemaVersion_schemaVersionNumber :: Lens' GetSchemaVersion (Maybe SchemaVersionNumber) Source #

The version number of the schema.

getSchemaVersionResponse_status :: Lens' GetSchemaVersionResponse (Maybe SchemaVersionStatus) Source #

The status of the schema version.

getSchemaVersionResponse_schemaDefinition :: Lens' GetSchemaVersionResponse (Maybe Text) Source #

The schema definition for the schema ID.

getSchemaVersionResponse_createdTime :: Lens' GetSchemaVersionResponse (Maybe Text) Source #

The date and time the schema version was created.

getSchemaVersionResponse_dataFormat :: Lens' GetSchemaVersionResponse (Maybe DataFormat) Source #

The data format of the schema definition. Currently AVRO and JSON are supported.

getSchemaVersionResponse_schemaVersionId :: Lens' GetSchemaVersionResponse (Maybe Text) Source #

The SchemaVersionId of the schema version.

getSchemaVersionResponse_versionNumber :: Lens' GetSchemaVersionResponse (Maybe Natural) Source #

The version number of the schema.

getSchemaVersionResponse_schemaArn :: Lens' GetSchemaVersionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the schema.

getSchemaVersionResponse_httpStatus :: Lens' GetSchemaVersionResponse Int Source #

The response's http status code.

GetPlan

getPlan_sinks :: Lens' GetPlan (Maybe [CatalogEntry]) Source #

The target tables.

getPlan_location :: Lens' GetPlan (Maybe Location) Source #

The parameters for the mapping.

getPlan_language :: Lens' GetPlan (Maybe Language) Source #

The programming language of the code to perform the mapping.

getPlan_additionalPlanOptionsMap :: Lens' GetPlan (Maybe (HashMap Text Text)) Source #

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"}'
```

getPlan_mapping :: Lens' GetPlan [MappingEntry] Source #

The list of mappings from a source table to target tables.

getPlan_source :: Lens' GetPlan CatalogEntry Source #

The source table.

getPlanResponse_pythonScript :: Lens' GetPlanResponse (Maybe Text) Source #

A Python script to perform the mapping.

getPlanResponse_scalaCode :: Lens' GetPlanResponse (Maybe Text) Source #

The Scala code to perform the mapping.

getPlanResponse_httpStatus :: Lens' GetPlanResponse Int Source #

The response's http status code.

GetTriggers

getTriggers_nextToken :: Lens' GetTriggers (Maybe Text) Source #

A continuation token, if this is a continuation call.

getTriggers_maxResults :: Lens' GetTriggers (Maybe Natural) Source #

The maximum size of the response.

getTriggers_dependentJobName :: Lens' GetTriggers (Maybe Text) Source #

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.

getTriggersResponse_triggers :: Lens' GetTriggersResponse (Maybe [Trigger]) Source #

A list of triggers for the specified job.

getTriggersResponse_nextToken :: Lens' GetTriggersResponse (Maybe Text) Source #

A continuation token, if not all the requested triggers have yet been returned.

getTriggersResponse_httpStatus :: Lens' GetTriggersResponse Int Source #

The response's http status code.

CreateSchema

createSchema_schemaDefinition :: Lens' CreateSchema (Maybe Text) Source #

The schema definition using the DataFormat setting for SchemaName.

createSchema_registryId :: Lens' CreateSchema (Maybe RegistryId) Source #

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:<customer id>:registry/default-registry:random-5-letter-id.

createSchema_description :: Lens' CreateSchema (Maybe Text) Source #

An optional description of the schema. If description is not provided, there will not be any automatic default value for this.

createSchema_compatibility :: Lens' CreateSchema (Maybe Compatibility) Source #

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.

createSchema_tags :: Lens' CreateSchema (Maybe (HashMap Text Text)) Source #

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.

createSchema_schemaName :: Lens' CreateSchema Text Source #

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.

createSchema_dataFormat :: Lens' CreateSchema DataFormat Source #

The data format of the schema definition. Currently AVRO and JSON are supported.

createSchemaResponse_schemaVersionStatus :: Lens' CreateSchemaResponse (Maybe SchemaVersionStatus) Source #

The status of the first schema version created.

createSchemaResponse_registryName :: Lens' CreateSchemaResponse (Maybe Text) Source #

The name of the registry.

createSchemaResponse_schemaStatus :: Lens' CreateSchemaResponse (Maybe SchemaStatus) Source #

The status of the schema.

createSchemaResponse_registryArn :: Lens' CreateSchemaResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the registry.

createSchemaResponse_latestSchemaVersion :: Lens' CreateSchemaResponse (Maybe Natural) Source #

The latest version of the schema associated with the returned schema definition.

createSchemaResponse_dataFormat :: Lens' CreateSchemaResponse (Maybe DataFormat) Source #

The data format of the schema definition. Currently AVRO and JSON are supported.

createSchemaResponse_schemaCheckpoint :: Lens' CreateSchemaResponse (Maybe Natural) Source #

The version number of the checkpoint (the last time the compatibility mode was changed).

createSchemaResponse_schemaName :: Lens' CreateSchemaResponse (Maybe Text) Source #

The name of the schema.

createSchemaResponse_schemaVersionId :: Lens' CreateSchemaResponse (Maybe Text) Source #

The unique identifier of the first schema version.

createSchemaResponse_schemaArn :: Lens' CreateSchemaResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the schema.

createSchemaResponse_nextSchemaVersion :: Lens' CreateSchemaResponse (Maybe Natural) Source #

The next version of the schema associated with the returned schema definition.

createSchemaResponse_description :: Lens' CreateSchemaResponse (Maybe Text) Source #

A description of the schema if specified when created.

createSchemaResponse_compatibility :: Lens' CreateSchemaResponse (Maybe Compatibility) Source #

The schema compatibility mode.

createSchemaResponse_tags :: Lens' CreateSchemaResponse (Maybe (HashMap Text Text)) Source #

The tags for the schema.

createSchemaResponse_httpStatus :: Lens' CreateSchemaResponse Int Source #

The response's http status code.

ListDevEndpoints

listDevEndpoints_nextToken :: Lens' ListDevEndpoints (Maybe Text) Source #

A continuation token, if this is a continuation request.

listDevEndpoints_maxResults :: Lens' ListDevEndpoints (Maybe Natural) Source #

The maximum size of a list to return.

listDevEndpoints_tags :: Lens' ListDevEndpoints (Maybe (HashMap Text Text)) Source #

Specifies to return only these tagged resources.

listDevEndpointsResponse_nextToken :: Lens' ListDevEndpointsResponse (Maybe Text) Source #

A continuation token, if the returned list does not contain the last metric available.

listDevEndpointsResponse_devEndpointNames :: Lens' ListDevEndpointsResponse (Maybe [Text]) Source #

The names of all the DevEndpoints in the account, or the DevEndpoints with the specified tags.

listDevEndpointsResponse_httpStatus :: Lens' ListDevEndpointsResponse Int Source #

The response's http status code.

StartTrigger

startTrigger_name :: Lens' StartTrigger Text Source #

The name of the trigger to start.

startTriggerResponse_name :: Lens' StartTriggerResponse (Maybe Text) Source #

The name of the trigger that was started.

startTriggerResponse_httpStatus :: Lens' StartTriggerResponse Int Source #

The response's http status code.

GetDataflowGraph

getDataflowGraph_pythonScript :: Lens' GetDataflowGraph (Maybe Text) Source #

The Python script to transform.

getDataflowGraphResponse_dagEdges :: Lens' GetDataflowGraphResponse (Maybe [CodeGenEdge]) Source #

A list of the edges in the resulting DAG.

getDataflowGraphResponse_dagNodes :: Lens' GetDataflowGraphResponse (Maybe [CodeGenNode]) Source #

A list of the nodes in the resulting DAG.

getDataflowGraphResponse_httpStatus :: Lens' GetDataflowGraphResponse Int Source #

The response's http status code.

GetDatabases

getDatabases_resourceShareType :: Lens' GetDatabases (Maybe ResourceShareType) Source #

Allows you to specify that you want to list the databases shared with your account. The allowable values are FOREIGN or ALL.

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.

getDatabases_catalogId :: Lens' GetDatabases (Maybe Text) Source #

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.

getDatabases_nextToken :: Lens' GetDatabases (Maybe Text) Source #

A continuation token, if this is a continuation call.

getDatabases_maxResults :: Lens' GetDatabases (Maybe Natural) Source #

The maximum number of databases to return in one response.

getDatabasesResponse_nextToken :: Lens' GetDatabasesResponse (Maybe Text) Source #

A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

getDatabasesResponse_httpStatus :: Lens' GetDatabasesResponse Int Source #

The response's http status code.

getDatabasesResponse_databaseList :: Lens' GetDatabasesResponse [Database] Source #

A list of Database objects from the specified catalog.

GetTable

getTable_catalogId :: Lens' GetTable (Maybe Text) Source #

The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.

getTable_databaseName :: Lens' GetTable Text Source #

The name of the database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

getTable_name :: Lens' GetTable Text Source #

The name of the table for which to retrieve the definition. For Hive compatibility, this name is entirely lowercase.

getTableResponse_table :: Lens' GetTableResponse (Maybe Table) Source #

The Table object that defines the specified table.

getTableResponse_httpStatus :: Lens' GetTableResponse Int Source #

The response's http status code.

CreateCrawler

createCrawler_schemaChangePolicy :: Lens' CreateCrawler (Maybe SchemaChangePolicy) Source #

The policy for the crawler's update and deletion behavior.

createCrawler_schedule :: Lens' CreateCrawler (Maybe Text) Source #

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 * * ? *).

createCrawler_recrawlPolicy :: Lens' CreateCrawler (Maybe RecrawlPolicy) Source #

A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.

createCrawler_classifiers :: Lens' CreateCrawler (Maybe [Text]) Source #

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.

createCrawler_databaseName :: Lens' CreateCrawler (Maybe Text) Source #

The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.

createCrawler_crawlerSecurityConfiguration :: Lens' CreateCrawler (Maybe Text) Source #

The name of the SecurityConfiguration structure to be used by this crawler.

createCrawler_lineageConfiguration :: Lens' CreateCrawler (Maybe LineageConfiguration) Source #

Specifies data lineage configuration settings for the crawler.

createCrawler_configuration :: Lens' CreateCrawler (Maybe Text) Source #

Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler.

createCrawler_tablePrefix :: Lens' CreateCrawler (Maybe Text) Source #

The table prefix used for catalog tables that are created.

createCrawler_description :: Lens' CreateCrawler (Maybe Text) Source #

A description of the new crawler.

createCrawler_tags :: Lens' CreateCrawler (Maybe (HashMap Text Text)) Source #

The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.

createCrawler_name :: Lens' CreateCrawler Text Source #

Name of the new crawler.

createCrawler_role :: Lens' CreateCrawler Text Source #

The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.

createCrawler_targets :: Lens' CreateCrawler CrawlerTargets Source #

A list of collection of targets to crawl.

createCrawlerResponse_httpStatus :: Lens' CreateCrawlerResponse Int Source #

The response's http status code.

GetJobRun

getJobRun_predecessorsIncluded :: Lens' GetJobRun (Maybe Bool) Source #

True if a list of predecessor runs should be returned.

getJobRun_jobName :: Lens' GetJobRun Text Source #

Name of the job definition being run.

getJobRun_runId :: Lens' GetJobRun Text Source #

The ID of the job run.

getJobRunResponse_jobRun :: Lens' GetJobRunResponse (Maybe JobRun) Source #

The requested job-run metadata.

getJobRunResponse_httpStatus :: Lens' GetJobRunResponse Int Source #

The response's http status code.

CreateDevEndpoint

createDevEndpoint_numberOfWorkers :: Lens' CreateDevEndpoint (Maybe Int) Source #

The number of workers of a defined workerType that are allocated to the development endpoint.

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

createDevEndpoint_extraPythonLibsS3Path :: Lens' CreateDevEndpoint (Maybe Text) Source #

The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.

You can only use pure Python libraries with a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.

createDevEndpoint_securityGroupIds :: Lens' CreateDevEndpoint (Maybe [Text]) Source #

Security group IDs for the security groups to be used by the new DevEndpoint.

createDevEndpoint_publicKeys :: Lens' CreateDevEndpoint (Maybe [Text]) Source #

A list of public keys to be used by the development endpoints for authentication. The use of this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.

If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys. Call the UpdateDevEndpoint API with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.

createDevEndpoint_arguments :: Lens' CreateDevEndpoint (Maybe (HashMap Text Text)) Source #

A map of arguments used to configure the DevEndpoint.

createDevEndpoint_workerType :: Lens' CreateDevEndpoint (Maybe WorkerType) Source #

The type of predefined worker that is allocated to the development endpoint. 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 maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.

Known issue: when a development endpoint is created with the G.2X WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.

createDevEndpoint_securityConfiguration :: Lens' CreateDevEndpoint (Maybe Text) Source #

The name of the SecurityConfiguration structure to be used with this DevEndpoint.

createDevEndpoint_publicKey :: Lens' CreateDevEndpoint (Maybe Text) Source #

The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility because the recommended attribute to use is public keys.

createDevEndpoint_subnetId :: Lens' CreateDevEndpoint (Maybe Text) Source #

The subnet ID for the new DevEndpoint to use.

createDevEndpoint_glueVersion :: Lens' CreateDevEndpoint (Maybe Text) Source #

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Development endpoints that are created without specifying a Glue version default to Glue 0.9.

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

createDevEndpoint_numberOfNodes :: Lens' CreateDevEndpoint (Maybe Int) Source #

The number of Glue Data Processing Units (DPUs) to allocate to this DevEndpoint.

createDevEndpoint_extraJarsS3Path :: Lens' CreateDevEndpoint (Maybe Text) Source #

The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint.

createDevEndpoint_tags :: Lens' CreateDevEndpoint (Maybe (HashMap Text Text)) Source #

The tags to use with this DevEndpoint. You may use tags to limit access to the DevEndpoint. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.

createDevEndpoint_endpointName :: Lens' CreateDevEndpoint Text Source #

The name to be assigned to the new DevEndpoint.

createDevEndpoint_roleArn :: Lens' CreateDevEndpoint Text Source #

The IAM role for the DevEndpoint.

createDevEndpointResponse_status :: Lens' CreateDevEndpointResponse (Maybe Text) Source #

The current status of the new DevEndpoint.

createDevEndpointResponse_failureReason :: Lens' CreateDevEndpointResponse (Maybe Text) Source #

The reason for a current failure in this DevEndpoint.

createDevEndpointResponse_endpointName :: Lens' CreateDevEndpointResponse (Maybe Text) Source #

The name assigned to the new DevEndpoint.

createDevEndpointResponse_numberOfWorkers :: Lens' CreateDevEndpointResponse (Maybe Int) Source #

The number of workers of a defined workerType that are allocated to the development endpoint.

createDevEndpointResponse_extraPythonLibsS3Path :: Lens' CreateDevEndpointResponse (Maybe Text) Source #

The paths to one or more Python libraries in an S3 bucket that will be loaded in your DevEndpoint.

createDevEndpointResponse_securityGroupIds :: Lens' CreateDevEndpointResponse (Maybe [Text]) Source #

The security groups assigned to the new DevEndpoint.

createDevEndpointResponse_vpcId :: Lens' CreateDevEndpointResponse (Maybe Text) Source #

The ID of the virtual private cloud (VPC) used by this DevEndpoint.

createDevEndpointResponse_arguments :: Lens' CreateDevEndpointResponse (Maybe (HashMap Text Text)) Source #

The map of arguments used to configure this DevEndpoint.

Valid arguments are:

```
"--enable-glue-datacatalog": ""
```

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

createDevEndpointResponse_workerType :: Lens' CreateDevEndpointResponse (Maybe WorkerType) Source #

The type of predefined worker that is allocated to the development endpoint. May be a value of Standard, G.1X, or G.2X.

createDevEndpointResponse_securityConfiguration :: Lens' CreateDevEndpointResponse (Maybe Text) Source #

The name of the SecurityConfiguration structure being used with this DevEndpoint.

createDevEndpointResponse_subnetId :: Lens' CreateDevEndpointResponse (Maybe Text) Source #

The subnet ID assigned to the new DevEndpoint.

createDevEndpointResponse_glueVersion :: Lens' CreateDevEndpointResponse (Maybe Text) Source #

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

createDevEndpointResponse_numberOfNodes :: Lens' CreateDevEndpointResponse (Maybe Int) Source #

The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint.

createDevEndpointResponse_availabilityZone :: Lens' CreateDevEndpointResponse (Maybe Text) Source #

The AWS Availability Zone where this DevEndpoint is located.

createDevEndpointResponse_zeppelinRemoteSparkInterpreterPort :: Lens' CreateDevEndpointResponse (Maybe Int) Source #

The Apache Zeppelin port for the remote Apache Spark interpreter.

createDevEndpointResponse_extraJarsS3Path :: Lens' CreateDevEndpointResponse (Maybe Text) Source #

Path to one or more Java .jar files in an S3 bucket that will be loaded in your DevEndpoint.

createDevEndpointResponse_createdTimestamp :: Lens' CreateDevEndpointResponse (Maybe UTCTime) Source #

The point in time at which this DevEndpoint was created.

createDevEndpointResponse_yarnEndpointAddress :: Lens' CreateDevEndpointResponse (Maybe Text) Source #

The address of the YARN endpoint used by this DevEndpoint.

createDevEndpointResponse_roleArn :: Lens' CreateDevEndpointResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the role assigned to the new DevEndpoint.

createDevEndpointResponse_httpStatus :: Lens' CreateDevEndpointResponse Int Source #

The response's http status code.

GetMLTaskRuns

getMLTaskRuns_nextToken :: Lens' GetMLTaskRuns (Maybe Text) Source #

A token for pagination of the results. The default is empty.

getMLTaskRuns_sort :: Lens' GetMLTaskRuns (Maybe TaskRunSortCriteria) Source #

The sorting criteria, in the TaskRunSortCriteria structure, for the task run.

getMLTaskRuns_filter :: Lens' GetMLTaskRuns (Maybe TaskRunFilterCriteria) Source #

The filter criteria, in the TaskRunFilterCriteria structure, for the task run.

getMLTaskRuns_maxResults :: Lens' GetMLTaskRuns (Maybe Natural) Source #

The maximum number of results to return.

getMLTaskRuns_transformId :: Lens' GetMLTaskRuns Text Source #

The unique identifier of the machine learning transform.

getMLTaskRunsResponse_nextToken :: Lens' GetMLTaskRunsResponse (Maybe Text) Source #

A pagination token, if more results are available.

getMLTaskRunsResponse_taskRuns :: Lens' GetMLTaskRunsResponse (Maybe [TaskRun]) Source #

A list of task runs that are associated with the transform.

getMLTaskRunsResponse_httpStatus :: Lens' GetMLTaskRunsResponse Int Source #

The response's http status code.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

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.

tagResource_tagsToAdd :: Lens' TagResource (HashMap Text Text) Source #

Tags to add to this resource.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

PutDataCatalogEncryptionSettings

putDataCatalogEncryptionSettings_catalogId :: Lens' PutDataCatalogEncryptionSettings (Maybe Text) Source #

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.

putDataCatalogEncryptionSettings_dataCatalogEncryptionSettings :: Lens' PutDataCatalogEncryptionSettings DataCatalogEncryptionSettings Source #

The security configuration to set.

putDataCatalogEncryptionSettingsResponse_httpStatus :: Lens' PutDataCatalogEncryptionSettingsResponse Int Source #

The response's http status code.

GetMLTransforms

getMLTransforms_nextToken :: Lens' GetMLTransforms (Maybe Text) Source #

A paginated token to offset the results.

getMLTransforms_sort :: Lens' GetMLTransforms (Maybe TransformSortCriteria) Source #

The sorting criteria.

getMLTransforms_filter :: Lens' GetMLTransforms (Maybe TransformFilterCriteria) Source #

The filter transformation criteria.

getMLTransforms_maxResults :: Lens' GetMLTransforms (Maybe Natural) Source #

The maximum number of results to return.

getMLTransformsResponse_nextToken :: Lens' GetMLTransformsResponse (Maybe Text) Source #

A pagination token, if more results are available.

getMLTransformsResponse_httpStatus :: Lens' GetMLTransformsResponse Int Source #

The response's http status code.

getMLTransformsResponse_transforms :: Lens' GetMLTransformsResponse [MLTransform] Source #

A list of machine learning transforms.

UpdateSchema

updateSchema_schemaVersionNumber :: Lens' UpdateSchema (Maybe SchemaVersionNumber) Source #

Version number required for check pointing. One of VersionNumber or Compatibility has to be provided.

updateSchema_description :: Lens' UpdateSchema (Maybe Text) Source #

The new description for the schema.

updateSchema_compatibility :: Lens' UpdateSchema (Maybe Compatibility) Source #

The new compatibility setting for the schema.

updateSchema_schemaId :: Lens' UpdateSchema SchemaId Source #

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.

updateSchemaResponse_registryName :: Lens' UpdateSchemaResponse (Maybe Text) Source #

The name of the registry that contains the schema.

updateSchemaResponse_schemaName :: Lens' UpdateSchemaResponse (Maybe Text) Source #

The name of the schema.

updateSchemaResponse_schemaArn :: Lens' UpdateSchemaResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the schema.

updateSchemaResponse_httpStatus :: Lens' UpdateSchemaResponse Int Source #

The response's http status code.

DeleteSchema

deleteSchema_schemaId :: Lens' DeleteSchema SchemaId Source #

This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).

deleteSchemaResponse_status :: Lens' DeleteSchemaResponse (Maybe SchemaStatus) Source #

The status of the schema.

deleteSchemaResponse_schemaName :: Lens' DeleteSchemaResponse (Maybe Text) Source #

The name of the schema being deleted.

deleteSchemaResponse_schemaArn :: Lens' DeleteSchemaResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the schema being deleted.

deleteSchemaResponse_httpStatus :: Lens' DeleteSchemaResponse Int Source #

The response's http status code.

GetDatabase

getDatabase_catalogId :: Lens' GetDatabase (Maybe Text) Source #

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.

getDatabase_name :: Lens' GetDatabase Text Source #

The name of the database to retrieve. For Hive compatibility, this should be all lowercase.

getDatabaseResponse_database :: Lens' GetDatabaseResponse (Maybe Database) Source #

The definition of the specified database in the Data Catalog.

getDatabaseResponse_httpStatus :: Lens' GetDatabaseResponse Int Source #

The response's http status code.

DeleteColumnStatisticsForPartition

deleteColumnStatisticsForPartition_catalogId :: Lens' DeleteColumnStatisticsForPartition (Maybe Text) Source #

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.

deleteColumnStatisticsForPartition_databaseName :: Lens' DeleteColumnStatisticsForPartition Text Source #

The name of the catalog database where the partitions reside.

deleteColumnStatisticsForPartition_tableName :: Lens' DeleteColumnStatisticsForPartition Text Source #

The name of the partitions' table.

deleteColumnStatisticsForPartition_partitionValues :: Lens' DeleteColumnStatisticsForPartition [Text] Source #

A list of partition values identifying the partition.

deleteColumnStatisticsForPartition_columnName :: Lens' DeleteColumnStatisticsForPartition Text Source #

Name of the column.

deleteColumnStatisticsForPartitionResponse_httpStatus :: Lens' DeleteColumnStatisticsForPartitionResponse Int Source #

The response's http status code.

UpdateColumnStatisticsForPartition

updateColumnStatisticsForPartition_catalogId :: Lens' UpdateColumnStatisticsForPartition (Maybe Text) Source #

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.

updateColumnStatisticsForPartition_databaseName :: Lens' UpdateColumnStatisticsForPartition Text Source #

The name of the catalog database where the partitions reside.

updateColumnStatisticsForPartition_tableName :: Lens' UpdateColumnStatisticsForPartition Text Source #

The name of the partitions' table.

updateColumnStatisticsForPartition_partitionValues :: Lens' UpdateColumnStatisticsForPartition [Text] Source #

A list of partition values identifying the partition.

updateColumnStatisticsForPartition_columnStatisticsList :: Lens' UpdateColumnStatisticsForPartition [ColumnStatistics] Source #

A list of the column statistics.

updateColumnStatisticsForPartitionResponse_errors :: Lens' UpdateColumnStatisticsForPartitionResponse (Maybe [ColumnStatisticsError]) Source #

Error occurred during updating column statistics data.

updateColumnStatisticsForPartitionResponse_httpStatus :: Lens' UpdateColumnStatisticsForPartitionResponse Int Source #

The response's http status code.

CreateBlueprint

createBlueprint_description :: Lens' CreateBlueprint (Maybe Text) Source #

A description of the blueprint.

createBlueprint_tags :: Lens' CreateBlueprint (Maybe (HashMap Text Text)) Source #

The tags to be applied to this blueprint.

createBlueprint_name :: Lens' CreateBlueprint Text Source #

The name of the blueprint.

createBlueprint_blueprintLocation :: Lens' CreateBlueprint Text Source #

Specifies a path in Amazon S3 where the blueprint is published.

createBlueprintResponse_name :: Lens' CreateBlueprintResponse (Maybe Text) Source #

Returns the name of the blueprint that was registered.

createBlueprintResponse_httpStatus :: Lens' CreateBlueprintResponse Int Source #

The response's http status code.

GetMLTaskRun

getMLTaskRun_transformId :: Lens' GetMLTaskRun Text Source #

The unique identifier of the machine learning transform.

getMLTaskRun_taskRunId :: Lens' GetMLTaskRun Text Source #

The unique identifier of the task run.

getMLTaskRunResponse_completedOn :: Lens' GetMLTaskRunResponse (Maybe UTCTime) Source #

The date and time when this task run was completed.

getMLTaskRunResponse_status :: Lens' GetMLTaskRunResponse (Maybe TaskStatusType) Source #

The status for this task run.

getMLTaskRunResponse_lastModifiedOn :: Lens' GetMLTaskRunResponse (Maybe UTCTime) Source #

The date and time when this task run was last modified.

getMLTaskRunResponse_errorString :: Lens' GetMLTaskRunResponse (Maybe Text) Source #

The error strings that are associated with the task run.

getMLTaskRunResponse_startedOn :: Lens' GetMLTaskRunResponse (Maybe UTCTime) Source #

The date and time when this task run started.

getMLTaskRunResponse_logGroupName :: Lens' GetMLTaskRunResponse (Maybe Text) Source #

The names of the log groups that are associated with the task run.

getMLTaskRunResponse_executionTime :: Lens' GetMLTaskRunResponse (Maybe Int) Source #

The amount of time (in seconds) that the task run consumed resources.

getMLTaskRunResponse_properties :: Lens' GetMLTaskRunResponse (Maybe TaskRunProperties) Source #

The list of properties that are associated with the task run.

getMLTaskRunResponse_transformId :: Lens' GetMLTaskRunResponse (Maybe Text) Source #

The unique identifier of the task run.

getMLTaskRunResponse_taskRunId :: Lens' GetMLTaskRunResponse (Maybe Text) Source #

The unique run identifier associated with this run.

getMLTaskRunResponse_httpStatus :: Lens' GetMLTaskRunResponse Int Source #

The response's http status code.

DeletePartition

deletePartition_catalogId :: Lens' DeletePartition (Maybe Text) Source #

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.

deletePartition_databaseName :: Lens' DeletePartition Text Source #

The name of the catalog database in which the table in question resides.

deletePartition_tableName :: Lens' DeletePartition Text Source #

The name of the table that contains the partition to be deleted.

deletePartition_partitionValues :: Lens' DeletePartition [Text] Source #

The values that define the partition.

deletePartitionResponse_httpStatus :: Lens' DeletePartitionResponse Int Source #

The response's http status code.

UpdatePartition

updatePartition_catalogId :: Lens' UpdatePartition (Maybe Text) Source #

The ID of the Data Catalog where the partition to be updated resides. If none is provided, the Amazon Web Services account ID is used by default.

updatePartition_databaseName :: Lens' UpdatePartition Text Source #

The name of the catalog database in which the table in question resides.

updatePartition_tableName :: Lens' UpdatePartition Text Source #

The name of the table in which the partition to be updated is located.

updatePartition_partitionValueList :: Lens' UpdatePartition [Text] Source #

List of partition key values that define the partition to update.

updatePartition_partitionInput :: Lens' UpdatePartition PartitionInput Source #

The new partition object to update the partition to.

The Values property can't be changed. If you want to change the partition key values for a partition, delete and recreate the partition.

updatePartitionResponse_httpStatus :: Lens' UpdatePartitionResponse Int Source #

The response's http status code.

GetMLTransform

getMLTransform_transformId :: Lens' GetMLTransform Text Source #

The unique identifier of the transform, generated at the time that the transform was created.

getMLTransformResponse_status :: Lens' GetMLTransformResponse (Maybe TransformStatusType) Source #

The last known status of the transform (to indicate whether it can be used or not). One of "NOT_READY", "READY", or "DELETING".

getMLTransformResponse_numberOfWorkers :: Lens' GetMLTransformResponse (Maybe Int) Source #

The number of workers of a defined workerType that are allocated when this task runs.

getMLTransformResponse_lastModifiedOn :: Lens' GetMLTransformResponse (Maybe UTCTime) Source #

The date and time when the transform was last modified.

getMLTransformResponse_labelCount :: Lens' GetMLTransformResponse (Maybe Int) Source #

The number of labels available for this transform.

getMLTransformResponse_workerType :: Lens' GetMLTransformResponse (Maybe WorkerType) Source #

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.

getMLTransformResponse_inputRecordTables :: Lens' GetMLTransformResponse (Maybe [GlueTable]) Source #

A list of Glue table definitions used by the transform.

getMLTransformResponse_glueVersion :: Lens' GetMLTransformResponse (Maybe Text) Source #

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.

getMLTransformResponse_evaluationMetrics :: Lens' GetMLTransformResponse (Maybe EvaluationMetrics) Source #

The latest evaluation metrics.

getMLTransformResponse_schema :: Lens' GetMLTransformResponse (Maybe [SchemaColumn]) Source #

The Map<Column, Type> object that represents the schema that this transform accepts. Has an upper bound of 100 columns.

getMLTransformResponse_role :: Lens' GetMLTransformResponse (Maybe Text) Source #

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.

getMLTransformResponse_name :: Lens' GetMLTransformResponse (Maybe Text) Source #

The unique name given to the transform when it was created.

getMLTransformResponse_parameters :: Lens' GetMLTransformResponse (Maybe TransformParameters) Source #

The configuration parameters that are specific to the algorithm used.

getMLTransformResponse_maxRetries :: Lens' GetMLTransformResponse (Maybe Int) Source #

The maximum number of times to retry a task for this transform after a task run fails.

getMLTransformResponse_maxCapacity :: Lens' GetMLTransformResponse (Maybe Double) Source #

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.

getMLTransformResponse_timeout :: Lens' GetMLTransformResponse (Maybe Natural) Source #

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).

getMLTransformResponse_transformEncryption :: Lens' GetMLTransformResponse (Maybe TransformEncryption) Source #

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.

getMLTransformResponse_description :: Lens' GetMLTransformResponse (Maybe Text) Source #

A description of the transform.

getMLTransformResponse_createdOn :: Lens' GetMLTransformResponse (Maybe UTCTime) Source #

The date and time when the transform was created.

getMLTransformResponse_transformId :: Lens' GetMLTransformResponse (Maybe Text) Source #

The unique identifier of the transform, generated at the time that the transform was created.

getMLTransformResponse_httpStatus :: Lens' GetMLTransformResponse Int Source #

The response's http status code.

CreateScript

createScript_dagEdges :: Lens' CreateScript (Maybe [CodeGenEdge]) Source #

A list of the edges in the DAG.

createScript_language :: Lens' CreateScript (Maybe Language) Source #

The programming language of the resulting code from the DAG.

createScript_dagNodes :: Lens' CreateScript (Maybe [CodeGenNode]) Source #

A list of the nodes in the DAG.

createScriptResponse_pythonScript :: Lens' CreateScriptResponse (Maybe Text) Source #

The Python script generated from the DAG.

createScriptResponse_scalaCode :: Lens' CreateScriptResponse (Maybe Text) Source #

The Scala code generated from the DAG.

createScriptResponse_httpStatus :: Lens' CreateScriptResponse Int Source #

The response's http status code.

PutResourcePolicy

putResourcePolicy_policyExistsCondition :: Lens' PutResourcePolicy (Maybe ExistCondition) Source #

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.

putResourcePolicy_policyHashCondition :: Lens' PutResourcePolicy (Maybe Text) Source #

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.

putResourcePolicy_resourceArn :: Lens' PutResourcePolicy (Maybe Text) Source #

Do not use. For internal use only.

putResourcePolicy_enableHybrid :: Lens' PutResourcePolicy (Maybe EnableHybridValues) Source #

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'.

putResourcePolicy_policyInJson :: Lens' PutResourcePolicy Text Source #

Contains the policy document to set, in JSON format.

putResourcePolicyResponse_policyHash :: Lens' PutResourcePolicyResponse (Maybe Text) Source #

A hash of the policy that has just been set. This must be included in a subsequent call that overwrites or updates this policy.

putResourcePolicyResponse_httpStatus :: Lens' PutResourcePolicyResponse Int Source #

The response's http status code.

GetBlueprintRuns

getBlueprintRuns_nextToken :: Lens' GetBlueprintRuns (Maybe Text) Source #

A continuation token, if this is a continuation request.

getBlueprintRuns_maxResults :: Lens' GetBlueprintRuns (Maybe Natural) Source #

The maximum size of a list to return.

getBlueprintRuns_blueprintName :: Lens' GetBlueprintRuns Text Source #

The name of the blueprint.

getBlueprintRunsResponse_blueprintRuns :: Lens' GetBlueprintRunsResponse (Maybe [BlueprintRun]) Source #

Returns a list of BlueprintRun objects.

getBlueprintRunsResponse_nextToken :: Lens' GetBlueprintRunsResponse (Maybe Text) Source #

A continuation token, if not all blueprint runs have been returned.

getBlueprintRunsResponse_httpStatus :: Lens' GetBlueprintRunsResponse Int Source #

The response's http status code.

GetSecurityConfigurations

getSecurityConfigurations_nextToken :: Lens' GetSecurityConfigurations (Maybe Text) Source #

A continuation token, if this is a continuation call.

getSecurityConfigurations_maxResults :: Lens' GetSecurityConfigurations (Maybe Natural) Source #

The maximum number of results to return.

getSecurityConfigurationsResponse_securityConfigurations :: Lens' GetSecurityConfigurationsResponse (Maybe [SecurityConfiguration]) Source #

A list of security configurations.

getSecurityConfigurationsResponse_nextToken :: Lens' GetSecurityConfigurationsResponse (Maybe Text) Source #

A continuation token, if there are more security configurations to return.

getSecurityConfigurationsResponse_httpStatus :: Lens' GetSecurityConfigurationsResponse Int Source #

The response's http status code.

DeleteResourcePolicy

deleteResourcePolicy_policyHashCondition :: Lens' DeleteResourcePolicy (Maybe Text) Source #

The hash value returned when this policy was set.

deleteResourcePolicy_resourceArn :: Lens' DeleteResourcePolicy (Maybe Text) Source #

The ARN of the Glue resource for the resource policy to be deleted.

deleteResourcePolicyResponse_httpStatus :: Lens' DeleteResourcePolicyResponse Int Source #

The response's http status code.

GetConnections

getConnections_catalogId :: Lens' GetConnections (Maybe Text) Source #

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.

getConnections_nextToken :: Lens' GetConnections (Maybe Text) Source #

A continuation token, if this is a continuation call.

getConnections_hidePassword :: Lens' GetConnections (Maybe Bool) Source #

Allows you to retrieve the connection metadata without returning the password. For instance, the AWS 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.

getConnections_filter :: Lens' GetConnections (Maybe GetConnectionsFilter) Source #

A filter that controls which connections are returned.

getConnections_maxResults :: Lens' GetConnections (Maybe Natural) Source #

The maximum number of connections to return in one response.

getConnectionsResponse_nextToken :: Lens' GetConnectionsResponse (Maybe Text) Source #

A continuation token, if the list of connections returned does not include the last of the filtered connections.

getConnectionsResponse_connectionList :: Lens' GetConnectionsResponse (Maybe [Connection]) Source #

A list of requested connection definitions.

getConnectionsResponse_httpStatus :: Lens' GetConnectionsResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource from which to remove the tags.

untagResource_tagsToRemove :: Lens' UntagResource [Text] Source #

Tags to remove from this resource.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

GetSchemaVersionsDiff

getSchemaVersionsDiff_schemaId :: Lens' GetSchemaVersionsDiff SchemaId Source #

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.

getSchemaVersionsDiff_firstSchemaVersionNumber :: Lens' GetSchemaVersionsDiff SchemaVersionNumber Source #

The first of the two schema versions to be compared.

getSchemaVersionsDiff_secondSchemaVersionNumber :: Lens' GetSchemaVersionsDiff SchemaVersionNumber Source #

The second of the two schema versions to be compared.

getSchemaVersionsDiff_schemaDiffType :: Lens' GetSchemaVersionsDiff SchemaDiffType Source #

Refers to SYNTAX_DIFF, which is the currently supported diff type.

getSchemaVersionsDiffResponse_diff :: Lens' GetSchemaVersionsDiffResponse (Maybe Text) Source #

The difference between schemas as a string in JsonPatch format.

getSchemaVersionsDiffResponse_httpStatus :: Lens' GetSchemaVersionsDiffResponse Int Source #

The response's http status code.

SearchTables

searchTables_resourceShareType :: Lens' SearchTables (Maybe ResourceShareType) Source #

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.

searchTables_searchText :: Lens' SearchTables (Maybe Text) Source #

A string used for a text search.

Specifying a value in quotes filters based on an exact match to the value.

searchTables_filters :: Lens' SearchTables (Maybe [PropertyPredicate]) Source #

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.

searchTables_catalogId :: Lens' SearchTables (Maybe Text) Source #

A unique identifier, consisting of account_id .

searchTables_sortCriteria :: Lens' SearchTables (Maybe [SortCriterion]) Source #

A list of criteria for sorting the results by a field name, in an ascending or descending order.

searchTables_nextToken :: Lens' SearchTables (Maybe Text) Source #

A continuation token, included if this is a continuation call.

searchTables_maxResults :: Lens' SearchTables (Maybe Natural) Source #

The maximum number of tables to return in a single response.

searchTablesResponse_tableList :: Lens' SearchTablesResponse (Maybe [Table]) Source #

A list of the requested Table objects. The SearchTables response returns only the tables that you have access to.

searchTablesResponse_nextToken :: Lens' SearchTablesResponse (Maybe Text) Source #

A continuation token, present if the current list segment is not the last.

searchTablesResponse_httpStatus :: Lens' SearchTablesResponse Int Source #

The response's http status code.

GetTrigger

getTrigger_name :: Lens' GetTrigger Text Source #

The name of the trigger to retrieve.

getTriggerResponse_trigger :: Lens' GetTriggerResponse (Maybe Trigger) Source #

The requested trigger definition.

getTriggerResponse_httpStatus :: Lens' GetTriggerResponse Int Source #

The response's http status code.

BatchGetJobs

batchGetJobs_jobNames :: Lens' BatchGetJobs [Text] Source #

A list of job names, which might be the names returned from the ListJobs operation.

batchGetJobsResponse_jobs :: Lens' BatchGetJobsResponse (Maybe [Job]) Source #

A list of job definitions.

batchGetJobsResponse_jobsNotFound :: Lens' BatchGetJobsResponse (Maybe [Text]) Source #

A list of names of jobs not found.

batchGetJobsResponse_httpStatus :: Lens' BatchGetJobsResponse Int Source #

The response's http status code.

ImportCatalogToGlue

importCatalogToGlue_catalogId :: Lens' ImportCatalogToGlue (Maybe Text) Source #

The ID of the catalog to import. Currently, this should be the Amazon Web Services account ID.

importCatalogToGlueResponse_httpStatus :: Lens' ImportCatalogToGlueResponse Int Source #

The response's http status code.

DeleteClassifier

deleteClassifier_name :: Lens' DeleteClassifier Text Source #

Name of the classifier to remove.

deleteClassifierResponse_httpStatus :: Lens' DeleteClassifierResponse Int Source #

The response's http status code.

UpdateClassifier

updateClassifier_grokClassifier :: Lens' UpdateClassifier (Maybe UpdateGrokClassifierRequest) Source #

A GrokClassifier object with updated fields.

updateClassifier_xMLClassifier :: Lens' UpdateClassifier (Maybe UpdateXMLClassifierRequest) Source #

An XMLClassifier object with updated fields.

updateClassifier_csvClassifier :: Lens' UpdateClassifier (Maybe UpdateCsvClassifierRequest) Source #

A CsvClassifier object with updated fields.

updateClassifier_jsonClassifier :: Lens' UpdateClassifier (Maybe UpdateJsonClassifierRequest) Source #

A JsonClassifier object with updated fields.

updateClassifierResponse_httpStatus :: Lens' UpdateClassifierResponse Int Source #

The response's http status code.

StartJobRun

startJobRun_numberOfWorkers :: Lens' StartJobRun (Maybe Int) Source #

The number of workers of a defined workerType that are allocated when a job runs.

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

startJobRun_notificationProperty :: Lens' StartJobRun (Maybe NotificationProperty) Source #

Specifies configuration properties of a job run notification.

startJobRun_arguments :: Lens' StartJobRun (Maybe (HashMap Text Text)) Source #

The job arguments specifically for 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.

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 key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.

startJobRun_workerType :: Lens' StartJobRun (Maybe WorkerType) Source #

The type of predefined worker that is allocated when a job 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.

startJobRun_securityConfiguration :: Lens' StartJobRun (Maybe Text) Source #

The name of the SecurityConfiguration structure to be used with this job run.

startJobRun_allocatedCapacity :: Lens' StartJobRun (Maybe Int) Source #

This field is deprecated. Use MaxCapacity instead.

The number of Glue data processing units (DPUs) to allocate to this JobRun. From 2 to 100 DPUs can be allocated; 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.

startJobRun_maxCapacity :: Lens' StartJobRun (Maybe Double) Source #

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.

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job, or an Apache Spark 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"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

startJobRun_timeout :: Lens' StartJobRun (Maybe Natural) Source #

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. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

startJobRun_jobRunId :: Lens' StartJobRun (Maybe Text) Source #

The ID of a previous JobRun to retry.

startJobRun_jobName :: Lens' StartJobRun Text Source #

The name of the job definition to use.

startJobRunResponse_jobRunId :: Lens' StartJobRunResponse (Maybe Text) Source #

The ID assigned to this job run.

startJobRunResponse_httpStatus :: Lens' StartJobRunResponse Int Source #

The response's http status code.

DeleteBlueprint

deleteBlueprint_name :: Lens' DeleteBlueprint Text Source #

The name of the blueprint to delete.

deleteBlueprintResponse_name :: Lens' DeleteBlueprintResponse (Maybe Text) Source #

Returns the name of the blueprint that was deleted.

deleteBlueprintResponse_httpStatus :: Lens' DeleteBlueprintResponse Int Source #

The response's http status code.

UpdateBlueprint

updateBlueprint_description :: Lens' UpdateBlueprint (Maybe Text) Source #

A description of the blueprint.

updateBlueprint_name :: Lens' UpdateBlueprint Text Source #

The name of the blueprint.

updateBlueprint_blueprintLocation :: Lens' UpdateBlueprint Text Source #

Specifies a path in Amazon S3 where the blueprint is published.

updateBlueprintResponse_name :: Lens' UpdateBlueprintResponse (Maybe Text) Source #

Returns the name of the blueprint that was updated.

updateBlueprintResponse_httpStatus :: Lens' UpdateBlueprintResponse Int Source #

The response's http status code.

ListBlueprints

listBlueprints_nextToken :: Lens' ListBlueprints (Maybe Text) Source #

A continuation token, if this is a continuation request.

listBlueprints_maxResults :: Lens' ListBlueprints (Maybe Natural) Source #

The maximum size of a list to return.

listBlueprints_tags :: Lens' ListBlueprints (Maybe (HashMap Text Text)) Source #

Filters the list by an Amazon Web Services resource tag.

listBlueprintsResponse_blueprints :: Lens' ListBlueprintsResponse (Maybe [Text]) Source #

List of names of blueprints in the account.

listBlueprintsResponse_nextToken :: Lens' ListBlueprintsResponse (Maybe Text) Source #

A continuation token, if not all blueprint names have been returned.

listBlueprintsResponse_httpStatus :: Lens' ListBlueprintsResponse Int Source #

The response's http status code.

CreatePartition

createPartition_catalogId :: Lens' CreatePartition (Maybe Text) Source #

The Amazon Web Services account ID of the catalog in which the partition is to be created.

createPartition_databaseName :: Lens' CreatePartition Text Source #

The name of the metadata database in which the partition is to be created.

createPartition_tableName :: Lens' CreatePartition Text Source #

The name of the metadata table in which the partition is to be created.

createPartition_partitionInput :: Lens' CreatePartition PartitionInput Source #

A PartitionInput structure defining the partition to be created.

createPartitionResponse_httpStatus :: Lens' CreatePartitionResponse Int Source #

The response's http status code.

BatchGetTriggers

batchGetTriggers_triggerNames :: Lens' BatchGetTriggers [Text] Source #

A list of trigger names, which may be the names returned from the ListTriggers operation.

batchGetTriggersResponse_triggersNotFound :: Lens' BatchGetTriggersResponse (Maybe [Text]) Source #

A list of names of triggers not found.

batchGetTriggersResponse_triggers :: Lens' BatchGetTriggersResponse (Maybe [Trigger]) Source #

A list of trigger definitions.

batchGetTriggersResponse_httpStatus :: Lens' BatchGetTriggersResponse Int Source #

The response's http status code.

GetBlueprint

getBlueprint_includeParameterSpec :: Lens' GetBlueprint (Maybe Bool) Source #

Specifies whether or not to include the parameter specification.

getBlueprint_includeBlueprint :: Lens' GetBlueprint (Maybe Bool) Source #

Specifies whether or not to include the blueprint in the response.

getBlueprint_name :: Lens' GetBlueprint Text Source #

The name of the blueprint.

getBlueprintResponse_blueprint :: Lens' GetBlueprintResponse (Maybe Blueprint) Source #

Returns a Blueprint object.

getBlueprintResponse_httpStatus :: Lens' GetBlueprintResponse Int Source #

The response's http status code.

StopCrawlerSchedule

stopCrawlerSchedule_crawlerName :: Lens' StopCrawlerSchedule Text Source #

Name of the crawler whose schedule state to set.

stopCrawlerScheduleResponse_httpStatus :: Lens' StopCrawlerScheduleResponse Int Source #

The response's http status code.

GetSchemaByDefinition

getSchemaByDefinition_schemaId :: Lens' GetSchemaByDefinition SchemaId Source #

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.

getSchemaByDefinition_schemaDefinition :: Lens' GetSchemaByDefinition Text Source #

The definition of the schema for which schema details are required.

getSchemaByDefinitionResponse_status :: Lens' GetSchemaByDefinitionResponse (Maybe SchemaVersionStatus) Source #

The status of the schema version.

getSchemaByDefinitionResponse_createdTime :: Lens' GetSchemaByDefinitionResponse (Maybe Text) Source #

The date and time the schema was created.

getSchemaByDefinitionResponse_dataFormat :: Lens' GetSchemaByDefinitionResponse (Maybe DataFormat) Source #

The data format of the schema definition. Currently only AVRO and JSON are supported.

getSchemaByDefinitionResponse_schemaVersionId :: Lens' GetSchemaByDefinitionResponse (Maybe Text) Source #

The schema ID of the schema version.

getSchemaByDefinitionResponse_schemaArn :: Lens' GetSchemaByDefinitionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the schema.

getSchemaByDefinitionResponse_httpStatus :: Lens' GetSchemaByDefinitionResponse Int Source #

The response's http status code.

CreateDatabase

createDatabase_catalogId :: Lens' CreateDatabase (Maybe Text) Source #

The ID of the Data Catalog in which to create the database. If none is provided, the Amazon Web Services account ID is used by default.

createDatabase_databaseInput :: Lens' CreateDatabase DatabaseInput Source #

The metadata for the database.

createDatabaseResponse_httpStatus :: Lens' CreateDatabaseResponse Int Source #

The response's http status code.

GetTableVersions

getTableVersions_catalogId :: Lens' GetTableVersions (Maybe Text) Source #

The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.

getTableVersions_nextToken :: Lens' GetTableVersions (Maybe Text) Source #

A continuation token, if this is not the first call.

getTableVersions_maxResults :: Lens' GetTableVersions (Maybe Natural) Source #

The maximum number of table versions to return in one response.

getTableVersions_databaseName :: Lens' GetTableVersions Text Source #

The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

getTableVersions_tableName :: Lens' GetTableVersions Text Source #

The name of the table. For Hive compatibility, this name is entirely lowercase.

getTableVersionsResponse_tableVersions :: Lens' GetTableVersionsResponse (Maybe [TableVersion]) Source #

A list of strings identifying available versions of the specified table.

getTableVersionsResponse_nextToken :: Lens' GetTableVersionsResponse (Maybe Text) Source #

A continuation token, if the list of available versions does not include the last one.

getTableVersionsResponse_httpStatus :: Lens' GetTableVersionsResponse Int Source #

The response's http status code.

CreateMLTransform

createMLTransform_numberOfWorkers :: Lens' CreateMLTransform (Maybe Int) Source #

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).

createMLTransform_workerType :: Lens' CreateMLTransform (Maybe WorkerType) Source #

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.

createMLTransform_glueVersion :: Lens' CreateMLTransform (Maybe Text) Source #

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.

createMLTransform_maxRetries :: Lens' CreateMLTransform (Maybe Int) Source #

The maximum number of times to retry a task for this transform after a task run fails.

createMLTransform_maxCapacity :: Lens' CreateMLTransform (Maybe Double) Source #

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.

createMLTransform_timeout :: Lens' CreateMLTransform (Maybe Natural) Source #

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).

createMLTransform_transformEncryption :: Lens' CreateMLTransform (Maybe TransformEncryption) Source #

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.

createMLTransform_description :: Lens' CreateMLTransform (Maybe Text) Source #

A description of the machine learning transform that is being defined. The default is an empty string.

createMLTransform_tags :: Lens' CreateMLTransform (Maybe (HashMap Text Text)) Source #

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.

createMLTransform_name :: Lens' CreateMLTransform Text Source #

The unique name that you give the transform when you create it.

createMLTransform_inputRecordTables :: Lens' CreateMLTransform [GlueTable] Source #

A list of Glue table definitions used by the transform.

createMLTransform_parameters :: Lens' CreateMLTransform TransformParameters Source #

The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.

createMLTransform_role :: Lens' CreateMLTransform Text Source #

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.

createMLTransformResponse_transformId :: Lens' CreateMLTransformResponse (Maybe Text) Source #

A unique identifier that is generated for the transform.

createMLTransformResponse_httpStatus :: Lens' CreateMLTransformResponse Int Source #

The response's http status code.

DeleteSchemaVersions

deleteSchemaVersions_schemaId :: Lens' DeleteSchemaVersions SchemaId Source #

This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).

deleteSchemaVersions_versions :: Lens' DeleteSchemaVersions Text Source #

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

deleteSchemaVersionsResponse_schemaVersionErrors :: Lens' DeleteSchemaVersionsResponse (Maybe [SchemaVersionErrorItem]) Source #

A list of SchemaVersionErrorItem objects, each containing an error and schema version.

deleteSchemaVersionsResponse_httpStatus :: Lens' DeleteSchemaVersionsResponse Int Source #

The response's http status code.

DeleteTrigger

deleteTrigger_name :: Lens' DeleteTrigger Text Source #

The name of the trigger to delete.

deleteTriggerResponse_name :: Lens' DeleteTriggerResponse (Maybe Text) Source #

The name of the trigger that was deleted.

deleteTriggerResponse_httpStatus :: Lens' DeleteTriggerResponse Int Source #

The response's http status code.

UpdateTrigger

updateTrigger_name :: Lens' UpdateTrigger Text Source #

The name of the trigger to update.

updateTrigger_triggerUpdate :: Lens' UpdateTrigger TriggerUpdate Source #

The new values with which to update the trigger.

updateTriggerResponse_trigger :: Lens' UpdateTriggerResponse (Maybe Trigger) Source #

The resulting trigger definition.

updateTriggerResponse_httpStatus :: Lens' UpdateTriggerResponse Int Source #

The response's http status code.

Types

Action

action_notificationProperty :: Lens' Action (Maybe NotificationProperty) Source #

Specifies configuration properties of a job run notification.

action_arguments :: Lens' Action (Maybe (HashMap Text Text)) Source #

The job arguments used when this trigger fires. 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.

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 key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.

action_jobName :: Lens' Action (Maybe Text) Source #

The name of a job to be run.

action_securityConfiguration :: Lens' Action (Maybe Text) Source #

The name of the SecurityConfiguration structure to be used with this action.

action_timeout :: Lens' Action (Maybe Natural) Source #

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. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

action_crawlerName :: Lens' Action (Maybe Text) Source #

The name of the crawler to be used with this action.

BackfillError

backfillError_partitions :: Lens' BackfillError (Maybe [PartitionValueList]) Source #

A list of a limited number of partitions in the response.

backfillError_code :: Lens' BackfillError (Maybe BackfillErrorCode) Source #

The error code for an error that occurred when registering partition indexes for an existing table.

BatchStopJobRunError

batchStopJobRunError_jobName :: Lens' BatchStopJobRunError (Maybe Text) Source #

The name of the job definition that is used in the job run in question.

batchStopJobRunError_jobRunId :: Lens' BatchStopJobRunError (Maybe Text) Source #

The JobRunId of the job run in question.

batchStopJobRunError_errorDetail :: Lens' BatchStopJobRunError (Maybe ErrorDetail) Source #

Specifies details about the error that was encountered.

BatchStopJobRunSuccessfulSubmission

batchStopJobRunSuccessfulSubmission_jobName :: Lens' BatchStopJobRunSuccessfulSubmission (Maybe Text) Source #

The name of the job definition used in the job run that was stopped.

batchStopJobRunSuccessfulSubmission_jobRunId :: Lens' BatchStopJobRunSuccessfulSubmission (Maybe Text) Source #

The JobRunId of the job run that was stopped.

BatchUpdatePartitionFailureEntry

batchUpdatePartitionFailureEntry_partitionValueList :: Lens' BatchUpdatePartitionFailureEntry (Maybe [Text]) Source #

A list of values defining the partitions.

batchUpdatePartitionFailureEntry_errorDetail :: Lens' BatchUpdatePartitionFailureEntry (Maybe ErrorDetail) Source #

The details about the batch update partition error.

BatchUpdatePartitionRequestEntry

batchUpdatePartitionRequestEntry_partitionValueList :: Lens' BatchUpdatePartitionRequestEntry [Text] Source #

A list of values defining the partitions.

batchUpdatePartitionRequestEntry_partitionInput :: Lens' BatchUpdatePartitionRequestEntry PartitionInput Source #

The structure used to update a partition.

BinaryColumnStatisticsData

binaryColumnStatisticsData_maximumLength :: Lens' BinaryColumnStatisticsData Natural Source #

The size of the longest bit sequence in the column.

binaryColumnStatisticsData_averageLength :: Lens' BinaryColumnStatisticsData Double Source #

The average bit sequence length in the column.

binaryColumnStatisticsData_numberOfNulls :: Lens' BinaryColumnStatisticsData Natural Source #

The number of null values in the column.

Blueprint

blueprint_status :: Lens' Blueprint (Maybe BlueprintStatus) Source #

The status of the blueprint registration.

Creating — The blueprint registration is in progress.
Active — The blueprint has been successfully registered.
Updating — An update to the blueprint registration is in progress.
Failed — The blueprint registration failed.

blueprint_parameterSpec :: Lens' Blueprint (Maybe Text) Source #

A JSON string that indicates the list of parameter specifications for the blueprint.

blueprint_blueprintLocation :: Lens' Blueprint (Maybe Text) Source #

Specifies the path in Amazon S3 where the blueprint is published.

blueprint_lastModifiedOn :: Lens' Blueprint (Maybe UTCTime) Source #

The date and time the blueprint was last modified.

blueprint_lastActiveDefinition :: Lens' Blueprint (Maybe LastActiveDefinition) Source #

When there are multiple versions of a blueprint and the latest version has some errors, this attribute indicates the last successful blueprint definition that is available with the service.

blueprint_name :: Lens' Blueprint (Maybe Text) Source #

The name of the blueprint.

blueprint_blueprintServiceLocation :: Lens' Blueprint (Maybe Text) Source #

Specifies a path in Amazon S3 where the blueprint is copied when you call CreateBlueprint/UpdateBlueprint to register the blueprint in Glue.

blueprint_errorMessage :: Lens' Blueprint (Maybe Text) Source #

An error message.

blueprint_description :: Lens' Blueprint (Maybe Text) Source #

The description of the blueprint.

blueprint_createdOn :: Lens' Blueprint (Maybe UTCTime) Source #

The date and time the blueprint was registered.

BlueprintDetails

blueprintDetails_runId :: Lens' BlueprintDetails (Maybe Text) Source #

The run ID for this blueprint.

blueprintDetails_blueprintName :: Lens' BlueprintDetails (Maybe Text) Source #

The name of the blueprint.

BlueprintRun

blueprintRun_workflowName :: Lens' BlueprintRun (Maybe Text) Source #

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.

blueprintRun_completedOn :: Lens' BlueprintRun (Maybe UTCTime) Source #

The date and time that the blueprint run completed.

blueprintRun_state :: Lens' BlueprintRun (Maybe BlueprintRunState) Source #

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.

blueprintRun_rollbackErrorMessage :: Lens' BlueprintRun (Maybe Text) Source #

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.

blueprintRun_startedOn :: Lens' BlueprintRun (Maybe UTCTime) Source #

The date and time that the blueprint run started.

blueprintRun_runId :: Lens' BlueprintRun (Maybe Text) Source #

The run ID for this blueprint run.

blueprintRun_parameters :: Lens' BlueprintRun (Maybe Text) Source #

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.

blueprintRun_blueprintName :: Lens' BlueprintRun (Maybe Text) Source #

The name of the blueprint.

blueprintRun_errorMessage :: Lens' BlueprintRun (Maybe Text) Source #

Indicates any errors that are seen while running the blueprint.

blueprintRun_roleArn :: Lens' BlueprintRun (Maybe Text) Source #

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.

BooleanColumnStatisticsData

booleanColumnStatisticsData_numberOfTrues :: Lens' BooleanColumnStatisticsData Natural Source #

The number of true values in the column.

booleanColumnStatisticsData_numberOfFalses :: Lens' BooleanColumnStatisticsData Natural Source #

The number of false values in the column.

booleanColumnStatisticsData_numberOfNulls :: Lens' BooleanColumnStatisticsData Natural Source #

The number of null values in the column.

CatalogEntry

catalogEntry_databaseName :: Lens' CatalogEntry Text Source #

The database in which the table metadata resides.

catalogEntry_tableName :: Lens' CatalogEntry Text Source #

The name of the table in question.

CatalogImportStatus

catalogImportStatus_importedBy :: Lens' CatalogImportStatus (Maybe Text) Source #

The name of the person who initiated the migration.

catalogImportStatus_importTime :: Lens' CatalogImportStatus (Maybe UTCTime) Source #

The time that the migration was started.

catalogImportStatus_importCompleted :: Lens' CatalogImportStatus (Maybe Bool) Source #

True if the migration has completed, or False otherwise.

CatalogTarget

catalogTarget_databaseName :: Lens' CatalogTarget Text Source #

The name of the database to be synchronized.

catalogTarget_tables :: Lens' CatalogTarget (NonEmpty Text) Source #

A list of the tables to be synchronized.

Classifier

classifier_grokClassifier :: Lens' Classifier (Maybe GrokClassifier) Source #

A classifier that uses grok.

classifier_xMLClassifier :: Lens' Classifier (Maybe XMLClassifier) Source #

A classifier for XML content.

classifier_csvClassifier :: Lens' Classifier (Maybe CsvClassifier) Source #

A classifier for comma-separated values (CSV).

classifier_jsonClassifier :: Lens' Classifier (Maybe JsonClassifier) Source #

A classifier for JSON content.

CloudWatchEncryption

cloudWatchEncryption_cloudWatchEncryptionMode :: Lens' CloudWatchEncryption (Maybe CloudWatchEncryptionMode) Source #

The encryption mode to use for CloudWatch data.

cloudWatchEncryption_kmsKeyArn :: Lens' CloudWatchEncryption (Maybe Text) Source #

The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.

CodeGenEdge

codeGenEdge_targetParameter :: Lens' CodeGenEdge (Maybe Text) Source #

The target of the edge.

codeGenEdge_source :: Lens' CodeGenEdge Text Source #

The ID of the node at which the edge starts.

codeGenEdge_target :: Lens' CodeGenEdge Text Source #

The ID of the node at which the edge ends.

CodeGenNode

codeGenNode_lineNumber :: Lens' CodeGenNode (Maybe Int) Source #

The line number of the node.

codeGenNode_id :: Lens' CodeGenNode Text Source #

A node identifier that is unique within the node's graph.

codeGenNode_nodeType :: Lens' CodeGenNode Text Source #

The type of node that this is.

codeGenNode_args :: Lens' CodeGenNode [CodeGenNodeArg] Source #

Properties of the node, in the form of name-value pairs.

CodeGenNodeArg

codeGenNodeArg_param :: Lens' CodeGenNodeArg (Maybe Bool) Source #

True if the value is used as a parameter.

codeGenNodeArg_name :: Lens' CodeGenNodeArg Text Source #

The name of the argument or property.

codeGenNodeArg_value :: Lens' CodeGenNodeArg Text Source #

The value of the argument or property.

Column

column_parameters :: Lens' Column (Maybe (HashMap Text Text)) Source #

These key-value pairs define properties associated with the column.

column_type :: Lens' Column (Maybe Text) Source #

The data type of the Column.

column_comment :: Lens' Column (Maybe Text) Source #

A free-form text comment.

column_name :: Lens' Column Text Source #

The name of the Column.

ColumnError

columnError_error :: Lens' ColumnError (Maybe ErrorDetail) Source #

An error message with the reason for the failure of an operation.

columnError_columnName :: Lens' ColumnError (Maybe Text) Source #

The name of the column that failed.

ColumnImportance

columnImportance_importance :: Lens' ColumnImportance (Maybe Double) Source #

The column importance score for the column, as a decimal.

columnImportance_columnName :: Lens' ColumnImportance (Maybe Text) Source #

The name of a column.

ColumnStatistics

columnStatistics_columnName :: Lens' ColumnStatistics Text Source #

Name of column which statistics belong to.

columnStatistics_columnType :: Lens' ColumnStatistics Text Source #

The data type of the column.

columnStatistics_analyzedTime :: Lens' ColumnStatistics UTCTime Source #

The timestamp of when column statistics were generated.

columnStatistics_statisticsData :: Lens' ColumnStatistics ColumnStatisticsData Source #

A ColumnStatisticData object that contains the statistics data values.

ColumnStatisticsData

columnStatisticsData_binaryColumnStatisticsData :: Lens' ColumnStatisticsData (Maybe BinaryColumnStatisticsData) Source #

Binary column statistics data.

columnStatisticsData_dateColumnStatisticsData :: Lens' ColumnStatisticsData (Maybe DateColumnStatisticsData) Source #

Date column statistics data.

columnStatisticsData_booleanColumnStatisticsData :: Lens' ColumnStatisticsData (Maybe BooleanColumnStatisticsData) Source #

Boolean column statistics data.

columnStatisticsData_decimalColumnStatisticsData :: Lens' ColumnStatisticsData (Maybe DecimalColumnStatisticsData) Source #

Decimal column statistics data.

columnStatisticsData_doubleColumnStatisticsData :: Lens' ColumnStatisticsData (Maybe DoubleColumnStatisticsData) Source #

Double column statistics data.

columnStatisticsData_stringColumnStatisticsData :: Lens' ColumnStatisticsData (Maybe StringColumnStatisticsData) Source #

String column statistics data.

columnStatisticsData_longColumnStatisticsData :: Lens' ColumnStatisticsData (Maybe LongColumnStatisticsData) Source #

Long column statistics data.

columnStatisticsData_type :: Lens' ColumnStatisticsData ColumnStatisticsType Source #

The type of column statistics data.

ColumnStatisticsError

columnStatisticsError_error :: Lens' ColumnStatisticsError (Maybe ErrorDetail) Source #

An error message with the reason for the failure of an operation.

columnStatisticsError_columnStatistics :: Lens' ColumnStatisticsError (Maybe ColumnStatistics) Source #

The ColumnStatistics of the column.

Condition

condition_crawlState :: Lens' Condition (Maybe CrawlState) Source #

The state of the crawler to which this condition applies.

condition_state :: Lens' Condition (Maybe JobRunState) Source #

The condition state. Currently, the only job states that a trigger can listen for are SUCCEEDED, STOPPED, FAILED, and TIMEOUT. The only crawler states that a trigger can listen for are SUCCEEDED, FAILED, and CANCELLED.

condition_jobName :: Lens' Condition (Maybe Text) Source #

The name of the job whose JobRuns this condition applies to, and on which this trigger waits.

condition_logicalOperator :: Lens' Condition (Maybe LogicalOperator) Source #

A logical operator.

condition_crawlerName :: Lens' Condition (Maybe Text) Source #

The name of the crawler to which this condition applies.

ConfusionMatrix

confusionMatrix_numTrueNegatives :: Lens' ConfusionMatrix (Maybe Integer) Source #

The number of nonmatches in the data that the transform correctly rejected, in the confusion matrix for your transform.

confusionMatrix_numFalseNegatives :: Lens' ConfusionMatrix (Maybe Integer) Source #

The number of matches in the data that the transform didn't find, in the confusion matrix for your transform.

confusionMatrix_numTruePositives :: Lens' ConfusionMatrix (Maybe Integer) Source #

The number of matches in the data that the transform correctly found, in the confusion matrix for your transform.

confusionMatrix_numFalsePositives :: Lens' ConfusionMatrix (Maybe Integer) Source #

The number of nonmatches in the data that the transform incorrectly classified as a match, in the confusion matrix for your transform.

Connection

connection_creationTime :: Lens' Connection (Maybe UTCTime) Source #

The time that this connection definition was created.

connection_lastUpdatedBy :: Lens' Connection (Maybe Text) Source #

The user, group, or role that last updated this connection definition.

connection_connectionProperties :: Lens' Connection (Maybe (HashMap ConnectionPropertyKey Text)) Source #

These key-value pairs define parameters for the connection:

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.
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".
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_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).

connection_lastUpdatedTime :: Lens' Connection (Maybe UTCTime) Source #

The last time that this connection definition was updated.

connection_matchCriteria :: Lens' Connection (Maybe [Text]) Source #

A list of criteria that can be used in selecting this connection.

connection_physicalConnectionRequirements :: Lens' Connection (Maybe PhysicalConnectionRequirements) Source #

A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to make this connection successfully.

connection_name :: Lens' Connection (Maybe Text) Source #

The name of the connection definition.

connection_description :: Lens' Connection (Maybe Text) Source #

The description of the connection.

connection_connectionType :: Lens' Connection (Maybe ConnectionType) Source #

The type of the connection. Currently, SFTP is not supported.

ConnectionInput

connectionInput_matchCriteria :: Lens' ConnectionInput (Maybe [Text]) Source #

A list of criteria that can be used in selecting this connection.

connectionInput_physicalConnectionRequirements :: Lens' ConnectionInput (Maybe PhysicalConnectionRequirements) Source #

A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to successfully make this connection.

connectionInput_description :: Lens' ConnectionInput (Maybe Text) Source #

The description of the connection.

connectionInput_name :: Lens' ConnectionInput Text Source #

The name of the connection.

connectionInput_connectionType :: Lens' ConnectionInput ConnectionType Source #

The type of the connection. Currently, these types are supported:

JDBC - Designates a connection to a database through Java Database Connectivity (JDBC).
KAFKA - Designates a connection to an Apache Kafka streaming platform.
MONGODB - Designates a connection to a MongoDB document database.
NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).
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.
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.

connectionInput_connectionProperties :: Lens' ConnectionInput (HashMap ConnectionPropertyKey Text) Source #

These key-value pairs define parameters for the connection.

ConnectionPasswordEncryption

connectionPasswordEncryption_awsKmsKeyId :: Lens' ConnectionPasswordEncryption (Maybe Text) Source #

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.

connectionPasswordEncryption_returnConnectionPasswordEncrypted :: Lens' ConnectionPasswordEncryption Bool Source #

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.

ConnectionsList

connectionsList_connections :: Lens' ConnectionsList (Maybe [Text]) Source #

A list of connections used by the job.

Crawl

crawl_completedOn :: Lens' Crawl (Maybe UTCTime) Source #

The date and time on which the crawl completed.

crawl_state :: Lens' Crawl (Maybe CrawlState) Source #

The state of the crawler.

crawl_startedOn :: Lens' Crawl (Maybe UTCTime) Source #

The date and time on which the crawl started.

crawl_logStream :: Lens' Crawl (Maybe Text) Source #

The log stream associated with the crawl.

crawl_logGroup :: Lens' Crawl (Maybe Text) Source #

The log group associated with the crawl.

crawl_errorMessage :: Lens' Crawl (Maybe Text) Source #

The error message associated with the crawl.

Crawler

crawler_creationTime :: Lens' Crawler (Maybe UTCTime) Source #

The time that the crawler was created.

crawler_state :: Lens' Crawler (Maybe CrawlerState) Source #

Indicates whether the crawler is running, or whether a run is pending.

crawler_schemaChangePolicy :: Lens' Crawler (Maybe SchemaChangePolicy) Source #

The policy that specifies update and delete behaviors for the crawler.

crawler_lastUpdated :: Lens' Crawler (Maybe UTCTime) Source #

The time that the crawler was last updated.

crawler_schedule :: Lens' Crawler (Maybe Schedule) Source #

For scheduled crawlers, the schedule when the crawler runs.

crawler_lastCrawl :: Lens' Crawler (Maybe LastCrawlInfo) Source #

The status of the last crawl, and potentially error information if an error occurred.

crawler_crawlElapsedTime :: Lens' Crawler (Maybe Integer) Source #

If the crawler is running, contains the total time elapsed since the last crawl began.

crawler_recrawlPolicy :: Lens' Crawler (Maybe RecrawlPolicy) Source #

A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.

crawler_classifiers :: Lens' Crawler (Maybe [Text]) Source #

A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.

crawler_role :: Lens' Crawler (Maybe Text) Source #

The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.

crawler_name :: Lens' Crawler (Maybe Text) Source #

The name of the crawler.

crawler_targets :: Lens' Crawler (Maybe CrawlerTargets) Source #

A collection of targets to crawl.

crawler_version :: Lens' Crawler (Maybe Integer) Source #

The version of the crawler.

crawler_databaseName :: Lens' Crawler (Maybe Text) Source #

The name of the database in which the crawler's output is stored.

crawler_crawlerSecurityConfiguration :: Lens' Crawler (Maybe Text) Source #

The name of the SecurityConfiguration structure to be used by this crawler.

crawler_lineageConfiguration :: Lens' Crawler (Maybe LineageConfiguration) Source #

A configuration that specifies whether data lineage is enabled for the crawler.

crawler_configuration :: Lens' Crawler (Maybe Text) Source #

Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Include and Exclude Patterns.

crawler_tablePrefix :: Lens' Crawler (Maybe Text) Source #

The prefix added to the names of tables that are created.

crawler_description :: Lens' Crawler (Maybe Text) Source #

A description of the crawler.

CrawlerMetrics

crawlerMetrics_lastRuntimeSeconds :: Lens' CrawlerMetrics (Maybe Double) Source #

The duration of the crawler's most recent run, in seconds.

crawlerMetrics_tablesCreated :: Lens' CrawlerMetrics (Maybe Natural) Source #

The number of tables created by this crawler.

crawlerMetrics_stillEstimating :: Lens' CrawlerMetrics (Maybe Bool) Source #

True if the crawler is still estimating how long it will take to complete this run.

crawlerMetrics_medianRuntimeSeconds :: Lens' CrawlerMetrics (Maybe Double) Source #

The median duration of this crawler's runs, in seconds.

crawlerMetrics_timeLeftSeconds :: Lens' CrawlerMetrics (Maybe Double) Source #

The estimated time left to complete a running crawl.

crawlerMetrics_tablesDeleted :: Lens' CrawlerMetrics (Maybe Natural) Source #

The number of tables deleted by this crawler.

crawlerMetrics_tablesUpdated :: Lens' CrawlerMetrics (Maybe Natural) Source #

The number of tables updated by this crawler.

crawlerMetrics_crawlerName :: Lens' CrawlerMetrics (Maybe Text) Source #

The name of the crawler.

CrawlerNodeDetails

crawlerNodeDetails_crawls :: Lens' CrawlerNodeDetails (Maybe [Crawl]) Source #

A list of crawls represented by the crawl node.

CrawlerTargets

crawlerTargets_dynamoDBTargets :: Lens' CrawlerTargets (Maybe [DynamoDBTarget]) Source #

Specifies Amazon DynamoDB targets.

crawlerTargets_s3Targets :: Lens' CrawlerTargets (Maybe [S3Target]) Source #

Specifies Amazon Simple Storage Service (Amazon S3) targets.

crawlerTargets_mongoDBTargets :: Lens' CrawlerTargets (Maybe [MongoDBTarget]) Source #

Specifies Amazon DocumentDB or MongoDB targets.

crawlerTargets_catalogTargets :: Lens' CrawlerTargets (Maybe [CatalogTarget]) Source #

Specifies Glue Data Catalog targets.

crawlerTargets_jdbcTargets :: Lens' CrawlerTargets (Maybe [JdbcTarget]) Source #

Specifies JDBC targets.

CreateCsvClassifierRequest

createCsvClassifierRequest_quoteSymbol :: Lens' CreateCsvClassifierRequest (Maybe Text) Source #

A custom symbol to denote what combines content into a single column value. Must be different from the column delimiter.

createCsvClassifierRequest_containsHeader :: Lens' CreateCsvClassifierRequest (Maybe CsvHeaderOption) Source #

Indicates whether the CSV file contains a header.

createCsvClassifierRequest_disableValueTrimming :: Lens' CreateCsvClassifierRequest (Maybe Bool) Source #

Specifies not to trim values before identifying the type of column values. The default value is true.

createCsvClassifierRequest_header :: Lens' CreateCsvClassifierRequest (Maybe [Text]) Source #

A list of strings representing column names.

createCsvClassifierRequest_allowSingleColumn :: Lens' CreateCsvClassifierRequest (Maybe Bool) Source #

Enables the processing of files that contain only one column.

createCsvClassifierRequest_delimiter :: Lens' CreateCsvClassifierRequest (Maybe Text) Source #

A custom symbol to denote what separates each column entry in the row.

createCsvClassifierRequest_name :: Lens' CreateCsvClassifierRequest Text Source #

The name of the classifier.

CreateGrokClassifierRequest

createGrokClassifierRequest_customPatterns :: Lens' CreateGrokClassifierRequest (Maybe Text) Source #

Optional custom grok patterns used by this classifier.

createGrokClassifierRequest_classification :: Lens' CreateGrokClassifierRequest Text Source #

An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on.

createGrokClassifierRequest_name :: Lens' CreateGrokClassifierRequest Text Source #

The name of the new classifier.

createGrokClassifierRequest_grokPattern :: Lens' CreateGrokClassifierRequest Text Source #

The grok pattern used by this classifier.

CreateJsonClassifierRequest

createJsonClassifierRequest_name :: Lens' CreateJsonClassifierRequest Text Source #

The name of the classifier.

createJsonClassifierRequest_jsonPath :: Lens' CreateJsonClassifierRequest Text Source #

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.

CreateXMLClassifierRequest

createXMLClassifierRequest_rowTag :: Lens' CreateXMLClassifierRequest (Maybe Text) Source #

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, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).

createXMLClassifierRequest_classification :: Lens' CreateXMLClassifierRequest Text Source #

An identifier of the data format that the classifier matches.

createXMLClassifierRequest_name :: Lens' CreateXMLClassifierRequest Text Source #

The name of the classifier.

CsvClassifier

csvClassifier_creationTime :: Lens' CsvClassifier (Maybe UTCTime) Source #

The time that this classifier was registered.

csvClassifier_quoteSymbol :: Lens' CsvClassifier (Maybe Text) Source #

A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.

csvClassifier_containsHeader :: Lens' CsvClassifier (Maybe CsvHeaderOption) Source #

Indicates whether the CSV file contains a header.

csvClassifier_lastUpdated :: Lens' CsvClassifier (Maybe UTCTime) Source #

The time that this classifier was last updated.

csvClassifier_disableValueTrimming :: Lens' CsvClassifier (Maybe Bool) Source #

Specifies not to trim values before identifying the type of column values. The default value is true.

csvClassifier_header :: Lens' CsvClassifier (Maybe [Text]) Source #

A list of strings representing column names.

csvClassifier_version :: Lens' CsvClassifier (Maybe Integer) Source #

The version of this classifier.

csvClassifier_allowSingleColumn :: Lens' CsvClassifier (Maybe Bool) Source #

Enables the processing of files that contain only one column.

csvClassifier_delimiter :: Lens' CsvClassifier (Maybe Text) Source #

A custom symbol to denote what separates each column entry in the row.

csvClassifier_name :: Lens' CsvClassifier Text Source #

The name of the classifier.

DataCatalogEncryptionSettings

dataCatalogEncryptionSettings_encryptionAtRest :: Lens' DataCatalogEncryptionSettings (Maybe EncryptionAtRest) Source #

Specifies the encryption-at-rest configuration for the Data Catalog.

dataCatalogEncryptionSettings_connectionPasswordEncryption :: Lens' DataCatalogEncryptionSettings (Maybe ConnectionPasswordEncryption) Source #

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.

DataLakePrincipal

dataLakePrincipal_dataLakePrincipalIdentifier :: Lens' DataLakePrincipal (Maybe Text) Source #

An identifier for the Lake Formation principal.

Database

database_locationUri :: Lens' Database (Maybe Text) Source #

The location of the database (for example, an HDFS path).

database_catalogId :: Lens' Database (Maybe Text) Source #

The ID of the Data Catalog in which the database resides.

database_targetDatabase :: Lens' Database (Maybe DatabaseIdentifier) Source #

A DatabaseIdentifier structure that describes a target database for resource linking.

database_parameters :: Lens' Database (Maybe (HashMap Text Text)) Source #

These key-value pairs define parameters and properties of the database.

database_description :: Lens' Database (Maybe Text) Source #

A description of the database.

database_createTime :: Lens' Database (Maybe UTCTime) Source #

The time at which the metadata database was created in the catalog.

database_createTableDefaultPermissions :: Lens' Database (Maybe [PrincipalPermissions]) Source #

Creates a set of default permissions on the table for principals.

database_name :: Lens' Database Text Source #

The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.

DatabaseIdentifier

databaseIdentifier_catalogId :: Lens' DatabaseIdentifier (Maybe Text) Source #

The ID of the Data Catalog in which the database resides.

databaseIdentifier_databaseName :: Lens' DatabaseIdentifier (Maybe Text) Source #

The name of the catalog database.

DatabaseInput

databaseInput_locationUri :: Lens' DatabaseInput (Maybe Text) Source #

The location of the database (for example, an HDFS path).

databaseInput_targetDatabase :: Lens' DatabaseInput (Maybe DatabaseIdentifier) Source #

A DatabaseIdentifier structure that describes a target database for resource linking.

databaseInput_parameters :: Lens' DatabaseInput (Maybe (HashMap Text Text)) Source #

These key-value pairs define parameters and properties of the database.

databaseInput_description :: Lens' DatabaseInput (Maybe Text) Source #

A description of the database.

databaseInput_createTableDefaultPermissions :: Lens' DatabaseInput (Maybe [PrincipalPermissions]) Source #

Creates a set of default permissions on the table for principals.

databaseInput_name :: Lens' DatabaseInput Text Source #

The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.

DateColumnStatisticsData

dateColumnStatisticsData_maximumValue :: Lens' DateColumnStatisticsData (Maybe UTCTime) Source #

The highest value in the column.

dateColumnStatisticsData_minimumValue :: Lens' DateColumnStatisticsData (Maybe UTCTime) Source #

The lowest value in the column.

dateColumnStatisticsData_numberOfNulls :: Lens' DateColumnStatisticsData Natural Source #

The number of null values in the column.

dateColumnStatisticsData_numberOfDistinctValues :: Lens' DateColumnStatisticsData Natural Source #

The number of distinct values in a column.

DecimalColumnStatisticsData

decimalColumnStatisticsData_maximumValue :: Lens' DecimalColumnStatisticsData (Maybe DecimalNumber) Source #

The highest value in the column.

decimalColumnStatisticsData_minimumValue :: Lens' DecimalColumnStatisticsData (Maybe DecimalNumber) Source #

The lowest value in the column.

decimalColumnStatisticsData_numberOfNulls :: Lens' DecimalColumnStatisticsData Natural Source #

The number of null values in the column.

decimalColumnStatisticsData_numberOfDistinctValues :: Lens' DecimalColumnStatisticsData Natural Source #

The number of distinct values in a column.

DecimalNumber

decimalNumber_unscaledValue :: Lens' DecimalNumber ByteString Source #

The unscaled numeric value.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

decimalNumber_scale :: Lens' DecimalNumber Int Source #

The scale that determines where the decimal point falls in the unscaled value.

DevEndpoint

devEndpoint_status :: Lens' DevEndpoint (Maybe Text) Source #

The current status of this DevEndpoint.

devEndpoint_failureReason :: Lens' DevEndpoint (Maybe Text) Source #

The reason for a current failure in this DevEndpoint.

devEndpoint_endpointName :: Lens' DevEndpoint (Maybe Text) Source #

The name of the DevEndpoint.

devEndpoint_numberOfWorkers :: Lens' DevEndpoint (Maybe Int) Source #

The number of workers of a defined workerType that are allocated to the development endpoint.

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

devEndpoint_extraPythonLibsS3Path :: Lens' DevEndpoint (Maybe Text) Source #

The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.

You can only use pure Python libraries with a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not currently supported.

devEndpoint_lastUpdateStatus :: Lens' DevEndpoint (Maybe Text) Source #

The status of the last update.

devEndpoint_securityGroupIds :: Lens' DevEndpoint (Maybe [Text]) Source #

A list of security group identifiers used in this DevEndpoint.

devEndpoint_lastModifiedTimestamp :: Lens' DevEndpoint (Maybe UTCTime) Source #

The point in time at which this DevEndpoint was last modified.

devEndpoint_publicKeys :: Lens' DevEndpoint (Maybe [Text]) Source #

A list of public keys to be used by the DevEndpoints for authentication. Using this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.

If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys. Call the UpdateDevEndpoint API operation with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.

devEndpoint_vpcId :: Lens' DevEndpoint (Maybe Text) Source #

The ID of the virtual private cloud (VPC) used by this DevEndpoint.

devEndpoint_arguments :: Lens' DevEndpoint (Maybe (HashMap Text Text)) Source #

A map of arguments used to configure the DevEndpoint.

Valid arguments are:

```
"--enable-glue-datacatalog": ""
```

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

devEndpoint_privateAddress :: Lens' DevEndpoint (Maybe Text) Source #

A private IP address to access the DevEndpoint within a VPC if the DevEndpoint is created within one. The PrivateAddress field is present only when you create the DevEndpoint within your VPC.

devEndpoint_workerType :: Lens' DevEndpoint (Maybe WorkerType) Source #

The type of predefined worker that is allocated to the development endpoint. 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 maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.

Known issue: when a development endpoint is created with the G.2X WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.

devEndpoint_securityConfiguration :: Lens' DevEndpoint (Maybe Text) Source #

The name of the SecurityConfiguration structure to be used with this DevEndpoint.

devEndpoint_publicKey :: Lens' DevEndpoint (Maybe Text) Source #

The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility because the recommended attribute to use is public keys.

devEndpoint_subnetId :: Lens' DevEndpoint (Maybe Text) Source #

The subnet ID for this DevEndpoint.

devEndpoint_glueVersion :: Lens' DevEndpoint (Maybe Text) Source #

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Development endpoints that are created without specifying a Glue version default to Glue 0.9.

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

devEndpoint_numberOfNodes :: Lens' DevEndpoint (Maybe Int) Source #

The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint.

devEndpoint_publicAddress :: Lens' DevEndpoint (Maybe Text) Source #

The public IP address used by this DevEndpoint. The PublicAddress field is present only when you create a non-virtual private cloud (VPC) DevEndpoint.

devEndpoint_availabilityZone :: Lens' DevEndpoint (Maybe Text) Source #

The AWS Availability Zone where this DevEndpoint is located.

devEndpoint_zeppelinRemoteSparkInterpreterPort :: Lens' DevEndpoint (Maybe Int) Source #

The Apache Zeppelin port for the remote Apache Spark interpreter.

devEndpoint_extraJarsS3Path :: Lens' DevEndpoint (Maybe Text) Source #

The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint.

You can only use pure Java/Scala libraries with a DevEndpoint.

devEndpoint_createdTimestamp :: Lens' DevEndpoint (Maybe UTCTime) Source #

The point in time at which this DevEndpoint was created.

devEndpoint_yarnEndpointAddress :: Lens' DevEndpoint (Maybe Text) Source #

The YARN endpoint address used by this DevEndpoint.

devEndpoint_roleArn :: Lens' DevEndpoint (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint.

DevEndpointCustomLibraries

devEndpointCustomLibraries_extraPythonLibsS3Path :: Lens' DevEndpointCustomLibraries (Maybe Text) Source #

The paths to one or more Python libraries in an Amazon Simple Storage Service (Amazon S3) bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.

You can only use pure Python libraries with a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not currently supported.

devEndpointCustomLibraries_extraJarsS3Path :: Lens' DevEndpointCustomLibraries (Maybe Text) Source #

The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint.

You can only use pure Java/Scala libraries with a DevEndpoint.

DoubleColumnStatisticsData

doubleColumnStatisticsData_maximumValue :: Lens' DoubleColumnStatisticsData (Maybe Double) Source #

The highest value in the column.

doubleColumnStatisticsData_minimumValue :: Lens' DoubleColumnStatisticsData (Maybe Double) Source #

The lowest value in the column.

doubleColumnStatisticsData_numberOfNulls :: Lens' DoubleColumnStatisticsData Natural Source #

The number of null values in the column.

doubleColumnStatisticsData_numberOfDistinctValues :: Lens' DoubleColumnStatisticsData Natural Source #

The number of distinct values in a column.

DynamoDBTarget

dynamoDBTarget_path :: Lens' DynamoDBTarget (Maybe Text) Source #

The name of the DynamoDB table to crawl.

dynamoDBTarget_scanRate :: Lens' DynamoDBTarget (Maybe Double) Source #

The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.

The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).

dynamoDBTarget_scanAll :: Lens' DynamoDBTarget (Maybe Bool) Source #

Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.

A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.

Edge

edge_sourceId :: Lens' Edge (Maybe Text) Source #

The unique of the node within the workflow where the edge starts.

edge_destinationId :: Lens' Edge (Maybe Text) Source #

The unique of the node within the workflow where the edge ends.

EncryptionAtRest

encryptionAtRest_sseAwsKmsKeyId :: Lens' EncryptionAtRest (Maybe Text) Source #

The ID of the KMS key to use for encryption at rest.

encryptionAtRest_catalogEncryptionMode :: Lens' EncryptionAtRest CatalogEncryptionMode Source #

The encryption-at-rest mode for encrypting Data Catalog data.

EncryptionConfiguration

encryptionConfiguration_s3Encryption :: Lens' EncryptionConfiguration (Maybe [S3Encryption]) Source #

The encryption configuration for Amazon Simple Storage Service (Amazon S3) data.

encryptionConfiguration_jobBookmarksEncryption :: Lens' EncryptionConfiguration (Maybe JobBookmarksEncryption) Source #

The encryption configuration for job bookmarks.

encryptionConfiguration_cloudWatchEncryption :: Lens' EncryptionConfiguration (Maybe CloudWatchEncryption) Source #

The encryption configuration for Amazon CloudWatch.

ErrorDetail

errorDetail_errorCode :: Lens' ErrorDetail (Maybe Text) Source #

The code associated with this error.

errorDetail_errorMessage :: Lens' ErrorDetail (Maybe Text) Source #

A message describing the error.

ErrorDetails

errorDetails_errorCode :: Lens' ErrorDetails (Maybe Text) Source #

The error code for an error.

errorDetails_errorMessage :: Lens' ErrorDetails (Maybe Text) Source #

The error message for an error.

EvaluationMetrics

evaluationMetrics_findMatchesMetrics :: Lens' EvaluationMetrics (Maybe FindMatchesMetrics) Source #

The evaluation metrics for the find matches algorithm.

evaluationMetrics_transformType :: Lens' EvaluationMetrics TransformType Source #

The type of machine learning transform.

EventBatchingCondition

eventBatchingCondition_batchWindow :: Lens' EventBatchingCondition (Maybe Natural) Source #

Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.

eventBatchingCondition_batchSize :: Lens' EventBatchingCondition Natural Source #

Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.

ExecutionProperty

executionProperty_maxConcurrentRuns :: Lens' ExecutionProperty (Maybe Int) Source #

The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.

ExportLabelsTaskRunProperties

exportLabelsTaskRunProperties_outputS3Path :: Lens' ExportLabelsTaskRunProperties (Maybe Text) Source #

The Amazon Simple Storage Service (Amazon S3) path where you will export the labels.

FindMatchesMetrics

findMatchesMetrics_f1 :: Lens' FindMatchesMetrics (Maybe Double) Source #

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.

findMatchesMetrics_areaUnderPRCurve :: Lens' FindMatchesMetrics (Maybe Double) Source #

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.

findMatchesMetrics_recall :: Lens' FindMatchesMetrics (Maybe Double) Source #

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.

findMatchesMetrics_precision :: Lens' FindMatchesMetrics (Maybe Double) Source #

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.

findMatchesMetrics_columnImportances :: Lens' FindMatchesMetrics (Maybe [ColumnImportance]) Source #

A list of ColumnImportance structures containing column importance metrics, sorted in order of descending importance.

findMatchesMetrics_confusionMatrix :: Lens' FindMatchesMetrics (Maybe ConfusionMatrix) Source #

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.

FindMatchesParameters

findMatchesParameters_enforceProvidedLabels :: Lens' FindMatchesParameters (Maybe Bool) Source #

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.

findMatchesParameters_accuracyCostTradeoff :: Lens' FindMatchesParameters (Maybe Double) Source #

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.

findMatchesParameters_precisionRecallTradeoff :: Lens' FindMatchesParameters (Maybe Double) Source #

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.

findMatchesParameters_primaryKeyColumnName :: Lens' FindMatchesParameters (Maybe Text) Source #

The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.

FindMatchesTaskRunProperties

findMatchesTaskRunProperties_jobId :: Lens' FindMatchesTaskRunProperties (Maybe Text) Source #

The job ID for the Find Matches task run.

findMatchesTaskRunProperties_jobName :: Lens' FindMatchesTaskRunProperties (Maybe Text) Source #

The name assigned to the job for the Find Matches task run.

findMatchesTaskRunProperties_jobRunId :: Lens' FindMatchesTaskRunProperties (Maybe Text) Source #

The job run ID for the Find Matches task run.

GetConnectionsFilter

getConnectionsFilter_matchCriteria :: Lens' GetConnectionsFilter (Maybe [Text]) Source #

A criteria string that must match the criteria recorded in the connection definition for that connection definition to be returned.

getConnectionsFilter_connectionType :: Lens' GetConnectionsFilter (Maybe ConnectionType) Source #

The type of connections to return. Currently, SFTP is not supported.

GluePolicy

gluePolicy_policyInJson :: Lens' GluePolicy (Maybe Text) Source #

Contains the requested policy document, in JSON format.

gluePolicy_updateTime :: Lens' GluePolicy (Maybe UTCTime) Source #

The date and time at which the policy was last updated.

gluePolicy_policyHash :: Lens' GluePolicy (Maybe Text) Source #

Contains the hash value associated with this policy.

gluePolicy_createTime :: Lens' GluePolicy (Maybe UTCTime) Source #

The date and time at which the policy was created.

GlueTable

glueTable_catalogId :: Lens' GlueTable (Maybe Text) Source #

A unique identifier for the Glue Data Catalog.

glueTable_connectionName :: Lens' GlueTable (Maybe Text) Source #

The name of the connection to the Glue Data Catalog.

glueTable_databaseName :: Lens' GlueTable Text Source #

A database name in the Glue Data Catalog.

glueTable_tableName :: Lens' GlueTable Text Source #

A table name in the Glue Data Catalog.

GrokClassifier

grokClassifier_creationTime :: Lens' GrokClassifier (Maybe UTCTime) Source #

The time that this classifier was registered.

grokClassifier_lastUpdated :: Lens' GrokClassifier (Maybe UTCTime) Source #

The time that this classifier was last updated.

grokClassifier_version :: Lens' GrokClassifier (Maybe Integer) Source #

The version of this classifier.

grokClassifier_customPatterns :: Lens' GrokClassifier (Maybe Text) Source #

Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifiers.

grokClassifier_name :: Lens' GrokClassifier Text Source #

The name of the classifier.

grokClassifier_classification :: Lens' GrokClassifier Text Source #

An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and so on.

grokClassifier_grokPattern :: Lens' GrokClassifier Text Source #

The grok pattern applied to a data store by this classifier. For more information, see built-in patterns in Writing Custom Classifiers.

ImportLabelsTaskRunProperties

importLabelsTaskRunProperties_replace :: Lens' ImportLabelsTaskRunProperties (Maybe Bool) Source #

Indicates whether to overwrite your existing labels.

importLabelsTaskRunProperties_inputS3Path :: Lens' ImportLabelsTaskRunProperties (Maybe Text) Source #

The Amazon Simple Storage Service (Amazon S3) path from where you will import the labels.

JdbcTarget

jdbcTarget_path :: Lens' JdbcTarget (Maybe Text) Source #

The path of the JDBC target.

jdbcTarget_connectionName :: Lens' JdbcTarget (Maybe Text) Source #

The name of the connection to use to connect to the JDBC target.

jdbcTarget_exclusions :: Lens' JdbcTarget (Maybe [Text]) Source #

A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.

Job

job_numberOfWorkers :: Lens' Job (Maybe Int) Source #

The number of workers of a defined workerType that are allocated when a job runs.

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

job_command :: Lens' Job (Maybe JobCommand) Source #

The JobCommand that runs this job.

job_notificationProperty :: Lens' Job (Maybe NotificationProperty) Source #

Specifies configuration properties of a job notification.

job_lastModifiedOn :: Lens' Job (Maybe UTCTime) Source #

The last point in time when this job definition was modified.

job_connections :: Lens' Job (Maybe ConnectionsList) Source #

The connections used for this job.

job_workerType :: Lens' Job (Maybe WorkerType) Source #

The type of predefined worker that is allocated when a job 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 maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.

job_securityConfiguration :: Lens' Job (Maybe Text) Source #

The name of the SecurityConfiguration structure to be used with this job.

job_glueVersion :: Lens' Job (Maybe Text) Source #

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Jobs that are created without specifying a Glue version default to Glue 0.9.

job_nonOverridableArguments :: Lens' Job (Maybe (HashMap Text Text)) Source #

Non-overridable arguments for this job, specified as name-value pairs.

job_role :: Lens' Job (Maybe Text) Source #

The name or Amazon Resource Name (ARN) of the IAM role associated with this job.

job_name :: Lens' Job (Maybe Text) Source #

The name you assign to this job definition.

job_logUri :: Lens' Job (Maybe Text) Source #

This field is reserved for future use.

job_maxRetries :: Lens' Job (Maybe Int) Source #

The maximum number of times to retry this job after a JobRun fails.

job_executionProperty :: Lens' Job (Maybe ExecutionProperty) Source #

An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

job_allocatedCapacity :: Lens' Job (Maybe Int) Source #

This field is deprecated. Use MaxCapacity instead.

The number of Glue data processing units (DPUs) allocated to runs of this job. 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.

job_maxCapacity :: Lens' Job (Maybe Double) Source #

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.

Do not set Max Capacity 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.

For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.

job_timeout :: Lens' Job (Maybe Natural) Source #

The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

job_defaultArguments :: Lens' Job (Maybe (HashMap Text Text)) Source #

The default arguments for this job, specified as name-value pairs.

You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.

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 key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.

job_description :: Lens' Job (Maybe Text) Source #

A description of the job.

job_createdOn :: Lens' Job (Maybe UTCTime) Source #

The time and date that this job definition was created.

JobBookmarkEntry

jobBookmarkEntry_jobName :: Lens' JobBookmarkEntry (Maybe Text) Source #

The name of the job in question.

jobBookmarkEntry_run :: Lens' JobBookmarkEntry (Maybe Int) Source #

The run ID number.

jobBookmarkEntry_runId :: Lens' JobBookmarkEntry (Maybe Text) Source #

The run ID number.

jobBookmarkEntry_version :: Lens' JobBookmarkEntry (Maybe Int) Source #

The version of the job.

jobBookmarkEntry_previousRunId :: Lens' JobBookmarkEntry (Maybe Text) Source #

The unique run identifier associated with the previous job run.

jobBookmarkEntry_attempt :: Lens' JobBookmarkEntry (Maybe Int) Source #

The attempt ID number.

jobBookmarkEntry_jobBookmark :: Lens' JobBookmarkEntry (Maybe Text) Source #

The bookmark itself.

JobBookmarksEncryption

jobBookmarksEncryption_jobBookmarksEncryptionMode :: Lens' JobBookmarksEncryption (Maybe JobBookmarksEncryptionMode) Source #

The encryption mode to use for job bookmarks data.

jobBookmarksEncryption_kmsKeyArn :: Lens' JobBookmarksEncryption (Maybe Text) Source #

The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.

JobCommand

jobCommand_scriptLocation :: Lens' JobCommand (Maybe Text) Source #

Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that runs a job.

jobCommand_pythonVersion :: Lens' JobCommand (Maybe Text) Source #

The Python version being used to run a Python shell job. Allowed values are 2 or 3.

jobCommand_name :: Lens' JobCommand (Maybe Text) Source #

The name of the job command. For an Apache Spark ETL job, this must be glueetl. For a Python shell job, it must be pythonshell. For an Apache Spark streaming ETL job, this must be gluestreaming.

JobNodeDetails

jobNodeDetails_jobRuns :: Lens' JobNodeDetails (Maybe [JobRun]) Source #

The information for the job runs represented by the job node.

JobRun

jobRun_completedOn :: Lens' JobRun (Maybe UTCTime) Source #

The date and time that this job run completed.

jobRun_numberOfWorkers :: Lens' JobRun (Maybe Int) Source #

The number of workers of a defined workerType that are allocated when a job runs.

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

jobRun_triggerName :: Lens' JobRun (Maybe Text) Source #

The name of the trigger that started this job run.

jobRun_notificationProperty :: Lens' JobRun (Maybe NotificationProperty) Source #

Specifies configuration properties of a job run notification.

jobRun_lastModifiedOn :: Lens' JobRun (Maybe UTCTime) Source #

The last time that this job run was modified.

jobRun_arguments :: Lens' JobRun (Maybe (HashMap Text Text)) Source #

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.

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 key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.

jobRun_jobName :: Lens' JobRun (Maybe Text) Source #

The name of the job definition being used in this run.

jobRun_startedOn :: Lens' JobRun (Maybe UTCTime) Source #

The date and time at which this job run was started.

jobRun_workerType :: Lens' JobRun (Maybe WorkerType) Source #

The type of predefined worker that is allocated when a job 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.

jobRun_securityConfiguration :: Lens' JobRun (Maybe Text) Source #

The name of the SecurityConfiguration structure to be used with this job run.

jobRun_glueVersion :: Lens' JobRun (Maybe Text) Source #

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Jobs that are created without specifying a Glue version default to Glue 0.9.

jobRun_jobRunState :: Lens' JobRun (Maybe JobRunState) Source #

The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses.

jobRun_logGroupName :: Lens' JobRun (Maybe Text) Source #

The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using KMS. This name can be /aws-glue/jobs/, in which case the default encryption is NONE. If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/), then that security configuration is used to encrypt the log group.

jobRun_executionTime :: Lens' JobRun (Maybe Int) Source #

The amount of time (in seconds) that the job run consumed resources.

jobRun_predecessorRuns :: Lens' JobRun (Maybe [Predecessor]) Source #

A list of predecessors to this job run.

jobRun_previousRunId :: Lens' JobRun (Maybe Text) Source #

The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.

jobRun_id :: Lens' JobRun (Maybe Text) Source #

The ID of this job run.

jobRun_attempt :: Lens' JobRun (Maybe Int) Source #

The number of the attempt to run this job.

jobRun_allocatedCapacity :: Lens' JobRun (Maybe Int) Source #

This field is deprecated. Use MaxCapacity instead.

The number of Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; 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.

jobRun_maxCapacity :: Lens' JobRun (Maybe Double) Source #

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.

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark 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"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

jobRun_timeout :: Lens' JobRun (Maybe Natural) Source #

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. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

jobRun_errorMessage :: Lens' JobRun (Maybe Text) Source #

An error message associated with this job run.

JobUpdate

jobUpdate_numberOfWorkers :: Lens' JobUpdate (Maybe Int) Source #

The number of workers of a defined workerType that are allocated when a job runs.

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

jobUpdate_command :: Lens' JobUpdate (Maybe JobCommand) Source #

The JobCommand that runs this job (required).

jobUpdate_notificationProperty :: Lens' JobUpdate (Maybe NotificationProperty) Source #

Specifies the configuration properties of a job notification.

jobUpdate_connections :: Lens' JobUpdate (Maybe ConnectionsList) Source #

The connections used for this job.

jobUpdate_workerType :: Lens' JobUpdate (Maybe WorkerType) Source #

The type of predefined worker that is allocated when a job 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 maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.

jobUpdate_securityConfiguration :: Lens' JobUpdate (Maybe Text) Source #

The name of the SecurityConfiguration structure to be used with this job.

jobUpdate_glueVersion :: Lens' JobUpdate (Maybe Text) Source #

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

jobUpdate_nonOverridableArguments :: Lens' JobUpdate (Maybe (HashMap Text Text)) Source #

Non-overridable arguments for this job, specified as name-value pairs.

jobUpdate_role :: Lens' JobUpdate (Maybe Text) Source #

The name or Amazon Resource Name (ARN) of the IAM role associated with this job (required).

jobUpdate_logUri :: Lens' JobUpdate (Maybe Text) Source #

This field is reserved for future use.

jobUpdate_maxRetries :: Lens' JobUpdate (Maybe Int) Source #

The maximum number of times to retry this job if it fails.

jobUpdate_executionProperty :: Lens' JobUpdate (Maybe ExecutionProperty) Source #

An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

jobUpdate_allocatedCapacity :: Lens' JobUpdate (Maybe Int) Source #

This field is deprecated. Use MaxCapacity instead.

The number of Glue data processing units (DPUs) to allocate to this job. 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.

jobUpdate_maxCapacity :: Lens' JobUpdate (Maybe Double) Source #

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.

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark 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.

For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.

jobUpdate_timeout :: Lens' JobUpdate (Maybe Natural) Source #

The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

jobUpdate_defaultArguments :: Lens' JobUpdate (Maybe (HashMap Text Text)) Source #

The default arguments for this job.

You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.

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 key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.

jobUpdate_description :: Lens' JobUpdate (Maybe Text) Source #

Description of the job being defined.

JsonClassifier

jsonClassifier_creationTime :: Lens' JsonClassifier (Maybe UTCTime) Source #

The time that this classifier was registered.

jsonClassifier_lastUpdated :: Lens' JsonClassifier (Maybe UTCTime) Source #

The time that this classifier was last updated.

jsonClassifier_version :: Lens' JsonClassifier (Maybe Integer) Source #

The version of this classifier.

jsonClassifier_name :: Lens' JsonClassifier Text Source #

The name of the classifier.

jsonClassifier_jsonPath :: Lens' JsonClassifier Text Source #

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.

KeySchemaElement

keySchemaElement_name :: Lens' KeySchemaElement Text Source #

The name of a partition key.

keySchemaElement_type :: Lens' KeySchemaElement Text Source #

The type of a partition key.

LabelingSetGenerationTaskRunProperties

labelingSetGenerationTaskRunProperties_outputS3Path :: Lens' LabelingSetGenerationTaskRunProperties (Maybe Text) Source #

The Amazon Simple Storage Service (Amazon S3) path where you will generate the labeling set.

LastActiveDefinition

lastActiveDefinition_parameterSpec :: Lens' LastActiveDefinition (Maybe Text) Source #

A JSON string specifying the parameters for the blueprint.

lastActiveDefinition_blueprintLocation :: Lens' LastActiveDefinition (Maybe Text) Source #

Specifies a path in Amazon S3 where the blueprint is published by the Glue developer.

lastActiveDefinition_lastModifiedOn :: Lens' LastActiveDefinition (Maybe UTCTime) Source #

The date and time the blueprint was last modified.

lastActiveDefinition_blueprintServiceLocation :: Lens' LastActiveDefinition (Maybe Text) Source #

Specifies a path in Amazon S3 where the blueprint is copied when you create or update the blueprint.

lastActiveDefinition_description :: Lens' LastActiveDefinition (Maybe Text) Source #

The description of the blueprint.

LastCrawlInfo

lastCrawlInfo_status :: Lens' LastCrawlInfo (Maybe LastCrawlStatus) Source #

Status of the last crawl.

lastCrawlInfo_startTime :: Lens' LastCrawlInfo (Maybe UTCTime) Source #

The time at which the crawl started.

lastCrawlInfo_logStream :: Lens' LastCrawlInfo (Maybe Text) Source #

The log stream for the last crawl.

lastCrawlInfo_logGroup :: Lens' LastCrawlInfo (Maybe Text) Source #

The log group for the last crawl.

lastCrawlInfo_messagePrefix :: Lens' LastCrawlInfo (Maybe Text) Source #

The prefix for a message about this crawl.

lastCrawlInfo_errorMessage :: Lens' LastCrawlInfo (Maybe Text) Source #

If an error occurred, the error information about the last crawl.

LineageConfiguration

lineageConfiguration_crawlerLineageSettings :: Lens' LineageConfiguration (Maybe CrawlerLineageSettings) Source #

Specifies whether data lineage is enabled for the crawler. Valid values are:

ENABLE: enables data lineage for the crawler
DISABLE: disables data lineage for the crawler

Location

location_dynamoDB :: Lens' Location (Maybe [CodeGenNodeArg]) Source #

An Amazon DynamoDB table location.

location_jdbc :: Lens' Location (Maybe [CodeGenNodeArg]) Source #

A JDBC location.

location_s3 :: Lens' Location (Maybe [CodeGenNodeArg]) Source #

An Amazon Simple Storage Service (Amazon S3) location.

LongColumnStatisticsData

longColumnStatisticsData_maximumValue :: Lens' LongColumnStatisticsData (Maybe Integer) Source #

The highest value in the column.

longColumnStatisticsData_minimumValue :: Lens' LongColumnStatisticsData (Maybe Integer) Source #

The lowest value in the column.

longColumnStatisticsData_numberOfNulls :: Lens' LongColumnStatisticsData Natural Source #

The number of null values in the column.

longColumnStatisticsData_numberOfDistinctValues :: Lens' LongColumnStatisticsData Natural Source #

The number of distinct values in a column.

MLTransform

mLTransform_status :: Lens' MLTransform (Maybe TransformStatusType) Source #

The current status of the machine learning transform.

mLTransform_numberOfWorkers :: Lens' MLTransform (Maybe Int) Source #

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).

mLTransform_lastModifiedOn :: Lens' MLTransform (Maybe UTCTime) Source #

A timestamp. The last point in time when this machine learning transform was modified.

mLTransform_labelCount :: Lens' MLTransform (Maybe Int) Source #

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.

mLTransform_workerType :: Lens' MLTransform (Maybe WorkerType) Source #

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.

mLTransform_inputRecordTables :: Lens' MLTransform (Maybe [GlueTable]) Source #

A list of Glue table definitions used by the transform.

mLTransform_glueVersion :: Lens' MLTransform (Maybe Text) Source #

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.

mLTransform_evaluationMetrics :: Lens' MLTransform (Maybe EvaluationMetrics) Source #

An EvaluationMetrics object. Evaluation metrics provide an estimate of the quality of your machine learning transform.

mLTransform_schema :: Lens' MLTransform (Maybe [SchemaColumn]) Source #

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.

mLTransform_role :: Lens' MLTransform (Maybe Text) Source #

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.

mLTransform_name :: Lens' MLTransform (Maybe Text) Source #

A user-defined name for the machine learning transform. Names are not guaranteed unique and can be changed at any time.

mLTransform_parameters :: Lens' MLTransform (Maybe TransformParameters) Source #

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).

mLTransform_maxRetries :: Lens' MLTransform (Maybe Int) Source #

The maximum number of times to retry after an MLTaskRun of the machine learning transform fails.

mLTransform_maxCapacity :: Lens' MLTransform (Maybe Double) Source #

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.

mLTransform_timeout :: Lens' MLTransform (Maybe Natural) Source #

The timeout in minutes of the machine learning transform.

mLTransform_transformEncryption :: Lens' MLTransform (Maybe TransformEncryption) Source #

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.

mLTransform_description :: Lens' MLTransform (Maybe Text) Source #

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.

mLTransform_createdOn :: Lens' MLTransform (Maybe UTCTime) Source #

A timestamp. The time and date that this machine learning transform was created.

mLTransform_transformId :: Lens' MLTransform (Maybe Text) Source #

The unique transform ID that is generated for the machine learning transform. The ID is guaranteed to be unique and does not change.

MLUserDataEncryption

mLUserDataEncryption_kmsKeyId :: Lens' MLUserDataEncryption (Maybe Text) Source #

The ID for the customer-provided KMS key.

mLUserDataEncryption_mlUserDataEncryptionMode :: Lens' MLUserDataEncryption MLUserDataEncryptionModeString Source #

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.

MappingEntry

mappingEntry_targetTable :: Lens' MappingEntry (Maybe Text) Source #

The target table.

mappingEntry_sourceType :: Lens' MappingEntry (Maybe Text) Source #

The source type.

mappingEntry_sourceTable :: Lens' MappingEntry (Maybe Text) Source #

The name of the source table.

mappingEntry_targetType :: Lens' MappingEntry (Maybe Text) Source #

The target type.

mappingEntry_targetPath :: Lens' MappingEntry (Maybe Text) Source #

The target path.

mappingEntry_sourcePath :: Lens' MappingEntry (Maybe Text) Source #

The source path.

MetadataInfo

metadataInfo_createdTime :: Lens' MetadataInfo (Maybe Text) Source #

The time at which the entry was created.

metadataInfo_otherMetadataValueList :: Lens' MetadataInfo (Maybe [OtherMetadataValueListItem]) Source #

Other metadata belonging to the same metadata key.

metadataInfo_metadataValue :: Lens' MetadataInfo (Maybe Text) Source #

The metadata key’s corresponding value.

MetadataKeyValuePair

metadataKeyValuePair_metadataKey :: Lens' MetadataKeyValuePair (Maybe Text) Source #

A metadata key.

metadataKeyValuePair_metadataValue :: Lens' MetadataKeyValuePair (Maybe Text) Source #

A metadata key’s corresponding value.

MongoDBTarget

mongoDBTarget_path :: Lens' MongoDBTarget (Maybe Text) Source #

The path of the Amazon DocumentDB or MongoDB target (database/collection).

mongoDBTarget_connectionName :: Lens' MongoDBTarget (Maybe Text) Source #

The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.

mongoDBTarget_scanAll :: Lens' MongoDBTarget (Maybe Bool) Source #

Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.

A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.

Node

node_triggerDetails :: Lens' Node (Maybe TriggerNodeDetails) Source #

Details of the Trigger when the node represents a Trigger.

node_uniqueId :: Lens' Node (Maybe Text) Source #

The unique Id assigned to the node within the workflow.

node_crawlerDetails :: Lens' Node (Maybe CrawlerNodeDetails) Source #

Details of the crawler when the node represents a crawler.

node_name :: Lens' Node (Maybe Text) Source #

The name of the Glue component represented by the node.

node_jobDetails :: Lens' Node (Maybe JobNodeDetails) Source #

Details of the Job when the node represents a Job.

node_type :: Lens' Node (Maybe NodeType) Source #

The type of Glue component represented by the node.

NotificationProperty

notificationProperty_notifyDelayAfter :: Lens' NotificationProperty (Maybe Natural) Source #

After a job run starts, the number of minutes to wait before sending a job run delay notification.

Order

order_column :: Lens' Order Text Source #

The name of the column.

order_sortOrder :: Lens' Order Natural Source #

Indicates that the column is sorted in ascending order (== 1), or in descending order (==0).

OtherMetadataValueListItem

otherMetadataValueListItem_createdTime :: Lens' OtherMetadataValueListItem (Maybe Text) Source #

The time at which the entry was created.

otherMetadataValueListItem_metadataValue :: Lens' OtherMetadataValueListItem (Maybe Text) Source #

The metadata key’s corresponding value for the other metadata belonging to the same metadata key.

Partition

partition_creationTime :: Lens' Partition (Maybe UTCTime) Source #

The time at which the partition was created.

partition_values :: Lens' Partition (Maybe [Text]) Source #

The values of the partition.

partition_catalogId :: Lens' Partition (Maybe Text) Source #

The ID of the Data Catalog in which the partition resides.

partition_lastAnalyzedTime :: Lens' Partition (Maybe UTCTime) Source #

The last time at which column statistics were computed for this partition.

partition_storageDescriptor :: Lens' Partition (Maybe StorageDescriptor) Source #

Provides information about the physical location where the partition is stored.

partition_databaseName :: Lens' Partition (Maybe Text) Source #

The name of the catalog database in which to create the partition.

partition_parameters :: Lens' Partition (Maybe (HashMap Text Text)) Source #

These key-value pairs define partition parameters.

partition_lastAccessTime :: Lens' Partition (Maybe UTCTime) Source #

The last time at which the partition was accessed.

partition_tableName :: Lens' Partition (Maybe Text) Source #

The name of the database table in which to create the partition.

PartitionError

partitionError_partitionValues :: Lens' PartitionError (Maybe [Text]) Source #

The values that define the partition.

partitionError_errorDetail :: Lens' PartitionError (Maybe ErrorDetail) Source #

The details about the partition error.

PartitionIndex

partitionIndex_keys :: Lens' PartitionIndex (NonEmpty Text) Source #

The keys for the partition index.

partitionIndex_indexName :: Lens' PartitionIndex Text Source #

The name of the partition index.

PartitionIndexDescriptor

partitionIndexDescriptor_backfillErrors :: Lens' PartitionIndexDescriptor (Maybe [BackfillError]) Source #

A list of errors that can occur when registering partition indexes for an existing table.

partitionIndexDescriptor_indexName :: Lens' PartitionIndexDescriptor Text Source #

The name of the partition index.

partitionIndexDescriptor_keys :: Lens' PartitionIndexDescriptor (NonEmpty KeySchemaElement) Source #

A list of one or more keys, as KeySchemaElement structures, for the partition index.

partitionIndexDescriptor_indexStatus :: Lens' PartitionIndexDescriptor PartitionIndexStatus Source #

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.

PartitionInput

partitionInput_values :: Lens' PartitionInput (Maybe [Text]) Source #

The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.

The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise Glue will add the values to the wrong keys.

partitionInput_lastAnalyzedTime :: Lens' PartitionInput (Maybe UTCTime) Source #

The last time at which column statistics were computed for this partition.

partitionInput_storageDescriptor :: Lens' PartitionInput (Maybe StorageDescriptor) Source #

Provides information about the physical location where the partition is stored.

partitionInput_parameters :: Lens' PartitionInput (Maybe (HashMap Text Text)) Source #

These key-value pairs define partition parameters.

partitionInput_lastAccessTime :: Lens' PartitionInput (Maybe UTCTime) Source #

The last time at which the partition was accessed.

PartitionValueList

partitionValueList_values :: Lens' PartitionValueList [Text] Source #

The list of values.

PhysicalConnectionRequirements

physicalConnectionRequirements_securityGroupIdList :: Lens' PhysicalConnectionRequirements (Maybe [Text]) Source #

The security group ID list used by the connection.

physicalConnectionRequirements_subnetId :: Lens' PhysicalConnectionRequirements (Maybe Text) Source #

The subnet ID used by the connection.

physicalConnectionRequirements_availabilityZone :: Lens' PhysicalConnectionRequirements (Maybe Text) Source #

The connection's Availability Zone. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future.

Predecessor

predecessor_jobName :: Lens' Predecessor (Maybe Text) Source #

The name of the job definition used by the predecessor job run.

predecessor_runId :: Lens' Predecessor (Maybe Text) Source #

The job-run ID of the predecessor job run.

Predicate

predicate_logical :: Lens' Predicate (Maybe Logical) Source #

An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.

predicate_conditions :: Lens' Predicate (Maybe [Condition]) Source #

A list of the conditions that determine when the trigger will fire.

PrincipalPermissions

principalPermissions_principal :: Lens' PrincipalPermissions (Maybe DataLakePrincipal) Source #

The principal who is granted permissions.

principalPermissions_permissions :: Lens' PrincipalPermissions (Maybe [Permission]) Source #

The permissions that are granted to the principal.

PropertyPredicate

propertyPredicate_value :: Lens' PropertyPredicate (Maybe Text) Source #

The value of the property.

propertyPredicate_key :: Lens' PropertyPredicate (Maybe Text) Source #

The key of the property.

propertyPredicate_comparator :: Lens' PropertyPredicate (Maybe Comparator) Source #

The comparator used to compare this property to others.

RecrawlPolicy

recrawlPolicy_recrawlBehavior :: Lens' RecrawlPolicy (Maybe RecrawlBehavior) Source #

Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.

A value of CRAWL_EVERYTHING specifies crawling the entire dataset again.

A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run.

A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.

RegistryId

registryId_registryName :: Lens' RegistryId (Maybe Text) Source #

Name of the registry. Used only for lookup. One of RegistryArn or RegistryName has to be provided.

registryId_registryArn :: Lens' RegistryId (Maybe Text) Source #

Arn of the registry to be updated. One of RegistryArn or RegistryName has to be provided.

RegistryListItem

registryListItem_status :: Lens' RegistryListItem (Maybe RegistryStatus) Source #

The status of the registry.

registryListItem_registryName :: Lens' RegistryListItem (Maybe Text) Source #

The name of the registry.

registryListItem_createdTime :: Lens' RegistryListItem (Maybe Text) Source #

The data the registry was created.

registryListItem_registryArn :: Lens' RegistryListItem (Maybe Text) Source #

The Amazon Resource Name (ARN) of the registry.

registryListItem_updatedTime :: Lens' RegistryListItem (Maybe Text) Source #

The date the registry was updated.

registryListItem_description :: Lens' RegistryListItem (Maybe Text) Source #

A description of the registry.

ResourceUri

resourceUri_resourceType :: Lens' ResourceUri (Maybe ResourceType) Source #

The type of the resource.

resourceUri_uri :: Lens' ResourceUri (Maybe Text) Source #

The URI for accessing the resource.

S3Encryption

s3Encryption_s3EncryptionMode :: Lens' S3Encryption (Maybe S3EncryptionMode) Source #

The encryption mode to use for Amazon S3 data.

s3Encryption_kmsKeyArn :: Lens' S3Encryption (Maybe Text) Source #

The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.

S3Target

s3Target_path :: Lens' S3Target (Maybe Text) Source #

The path to the Amazon S3 target.

s3Target_sampleSize :: Lens' S3Target (Maybe Int) Source #

Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.

s3Target_connectionName :: Lens' S3Target (Maybe Text) Source #

The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).

s3Target_exclusions :: Lens' S3Target (Maybe [Text]) Source #

A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.

s3Target_eventQueueArn :: Lens' S3Target (Maybe Text) Source #

A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.

s3Target_dlqEventQueueArn :: Lens' S3Target (Maybe Text) Source #

A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.

Schedule

schedule_state :: Lens' Schedule (Maybe ScheduleState) Source #

The state of the schedule.

schedule_scheduleExpression :: Lens' Schedule (Maybe Text) Source #

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 * * ? *).

SchemaChangePolicy

schemaChangePolicy_deleteBehavior :: Lens' SchemaChangePolicy (Maybe DeleteBehavior) Source #

The deletion behavior when the crawler finds a deleted object.

schemaChangePolicy_updateBehavior :: Lens' SchemaChangePolicy (Maybe UpdateBehavior) Source #

The update behavior when the crawler finds a changed schema.

SchemaColumn

schemaColumn_name :: Lens' SchemaColumn (Maybe Text) Source #

The name of the column.

schemaColumn_dataType :: Lens' SchemaColumn (Maybe Text) Source #

The type of data in the column.

SchemaId

schemaId_registryName :: Lens' SchemaId (Maybe Text) Source #

The name of the schema registry that contains the schema.

schemaId_schemaName :: Lens' SchemaId (Maybe Text) Source #

The name of the schema. One of SchemaArn or SchemaName has to be provided.

schemaId_schemaArn :: Lens' SchemaId (Maybe Text) Source #

The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.

SchemaListItem

schemaListItem_registryName :: Lens' SchemaListItem (Maybe Text) Source #

the name of the registry where the schema resides.

schemaListItem_createdTime :: Lens' SchemaListItem (Maybe Text) Source #

The date and time that a schema was created.

schemaListItem_schemaStatus :: Lens' SchemaListItem (Maybe SchemaStatus) Source #

The status of the schema.

schemaListItem_schemaName :: Lens' SchemaListItem (Maybe Text) Source #

The name of the schema.

schemaListItem_schemaArn :: Lens' SchemaListItem (Maybe Text) Source #

The Amazon Resource Name (ARN) for the schema.

schemaListItem_updatedTime :: Lens' SchemaListItem (Maybe Text) Source #

The date and time that a schema was updated.

schemaListItem_description :: Lens' SchemaListItem (Maybe Text) Source #

A description for the schema.

SchemaReference

schemaReference_schemaVersionId :: Lens' SchemaReference (Maybe Text) Source #

The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.

schemaReference_schemaId :: Lens' SchemaReference (Maybe SchemaId) Source #

A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.

schemaReference_schemaVersionNumber :: Lens' SchemaReference (Maybe Natural) Source #

The version number of the schema.

SchemaVersionErrorItem

schemaVersionErrorItem_versionNumber :: Lens' SchemaVersionErrorItem (Maybe Natural) Source #

The version number of the schema.

schemaVersionErrorItem_errorDetails :: Lens' SchemaVersionErrorItem (Maybe ErrorDetails) Source #

The details of the error for the schema version.

SchemaVersionListItem

schemaVersionListItem_status :: Lens' SchemaVersionListItem (Maybe SchemaVersionStatus) Source #

The status of the schema version.

schemaVersionListItem_createdTime :: Lens' SchemaVersionListItem (Maybe Text) Source #

The date and time the schema version was created.

schemaVersionListItem_schemaVersionId :: Lens' SchemaVersionListItem (Maybe Text) Source #

The unique identifier of the schema version.

schemaVersionListItem_versionNumber :: Lens' SchemaVersionListItem (Maybe Natural) Source #

The version number of the schema.

schemaVersionListItem_schemaArn :: Lens' SchemaVersionListItem (Maybe Text) Source #

The Amazon Resource Name (ARN) of the schema.

SchemaVersionNumber

schemaVersionNumber_versionNumber :: Lens' SchemaVersionNumber (Maybe Natural) Source #

The version number of the schema.

schemaVersionNumber_latestVersion :: Lens' SchemaVersionNumber (Maybe Bool) Source #

The latest version available for the schema.

SecurityConfiguration

securityConfiguration_name :: Lens' SecurityConfiguration (Maybe Text) Source #

The name of the security configuration.

securityConfiguration_encryptionConfiguration :: Lens' SecurityConfiguration (Maybe EncryptionConfiguration) Source #

The encryption configuration associated with this security configuration.

securityConfiguration_createdTimeStamp :: Lens' SecurityConfiguration (Maybe UTCTime) Source #

The time at which this security configuration was created.

Segment

segment_segmentNumber :: Lens' Segment Natural Source #

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.

segment_totalSegments :: Lens' Segment Natural Source #

The total number of segments.

SerDeInfo

serDeInfo_serializationLibrary :: Lens' SerDeInfo (Maybe Text) Source #

Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

serDeInfo_name :: Lens' SerDeInfo (Maybe Text) Source #

Name of the SerDe.

serDeInfo_parameters :: Lens' SerDeInfo (Maybe (HashMap Text Text)) Source #

These key-value pairs define initialization parameters for the SerDe.

SkewedInfo

skewedInfo_skewedColumnValueLocationMaps :: Lens' SkewedInfo (Maybe (HashMap Text Text)) Source #

A mapping of skewed values to the columns that contain them.

skewedInfo_skewedColumnValues :: Lens' SkewedInfo (Maybe [Text]) Source #

A list of values that appear so frequently as to be considered skewed.

skewedInfo_skewedColumnNames :: Lens' SkewedInfo (Maybe [Text]) Source #

A list of names of columns that contain skewed values.

SortCriterion

sortCriterion_sort :: Lens' SortCriterion (Maybe Sort) Source #

An ascending or descending sort.

sortCriterion_fieldName :: Lens' SortCriterion (Maybe Text) Source #

The name of the field on which to sort.

StartingEventBatchCondition

startingEventBatchCondition_batchWindow :: Lens' StartingEventBatchCondition (Maybe Int) Source #

Duration of the batch window in seconds.

startingEventBatchCondition_batchSize :: Lens' StartingEventBatchCondition (Maybe Int) Source #

Number of events in the batch.

StorageDescriptor

storageDescriptor_sortColumns :: Lens' StorageDescriptor (Maybe [Order]) Source #

A list specifying the sort order of each bucket in the table.

storageDescriptor_compressed :: Lens' StorageDescriptor (Maybe Bool) Source #

True if the data in the table is compressed, or False if not.

storageDescriptor_location :: Lens' StorageDescriptor (Maybe Text) Source #

The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.

storageDescriptor_bucketColumns :: Lens' StorageDescriptor (Maybe [Text]) Source #

A list of reducer grouping columns, clustering columns, and bucketing columns in the table.

storageDescriptor_serdeInfo :: Lens' StorageDescriptor (Maybe SerDeInfo) Source #

The serialization/deserialization (SerDe) information.

storageDescriptor_outputFormat :: Lens' StorageDescriptor (Maybe Text) Source #

The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

storageDescriptor_numberOfBuckets :: Lens' StorageDescriptor (Maybe Int) Source #

Must be specified if the table contains any dimension columns.

storageDescriptor_schemaReference :: Lens' StorageDescriptor (Maybe SchemaReference) Source #

An object that references a schema stored in the Glue Schema Registry.

When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.

storageDescriptor_storedAsSubDirectories :: Lens' StorageDescriptor (Maybe Bool) Source #

True if the table data is stored in subdirectories, or False if not.

storageDescriptor_parameters :: Lens' StorageDescriptor (Maybe (HashMap Text Text)) Source #

The user-supplied properties in key-value form.

storageDescriptor_inputFormat :: Lens' StorageDescriptor (Maybe Text) Source #

The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.

storageDescriptor_skewedInfo :: Lens' StorageDescriptor (Maybe SkewedInfo) Source #

The information about values that appear frequently in a column (skewed values).

storageDescriptor_columns :: Lens' StorageDescriptor (Maybe [Column]) Source #

A list of the Columns in the table.

StringColumnStatisticsData

stringColumnStatisticsData_maximumLength :: Lens' StringColumnStatisticsData Natural Source #

The size of the longest string in the column.

stringColumnStatisticsData_averageLength :: Lens' StringColumnStatisticsData Double Source #

The average string length in the column.

stringColumnStatisticsData_numberOfNulls :: Lens' StringColumnStatisticsData Natural Source #

The number of null values in the column.

stringColumnStatisticsData_numberOfDistinctValues :: Lens' StringColumnStatisticsData Natural Source #

The number of distinct values in a column.

Table

table_retention :: Lens' Table (Maybe Natural) Source #

The retention time for this table.

table_targetTable :: Lens' Table (Maybe TableIdentifier) Source #

A TableIdentifier structure that describes a target table for resource linking.

table_isRegisteredWithLakeFormation :: Lens' Table (Maybe Bool) Source #

Indicates whether the table has been registered with Lake Formation.

table_createdBy :: Lens' Table (Maybe Text) Source #

The person or entity who created the table.

table_tableType :: Lens' Table (Maybe Text) Source #

The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).

table_catalogId :: Lens' Table (Maybe Text) Source #

The ID of the Data Catalog in which the table resides.

table_owner :: Lens' Table (Maybe Text) Source #

The owner of the table.

table_viewOriginalText :: Lens' Table (Maybe Text) Source #

If the table is a view, the original text of the view; otherwise null.

table_updateTime :: Lens' Table (Maybe UTCTime) Source #

The last time that the table was updated.

table_viewExpandedText :: Lens' Table (Maybe Text) Source #

If the table is a view, the expanded text of the view; otherwise null.

table_lastAnalyzedTime :: Lens' Table (Maybe UTCTime) Source #

The last time that column statistics were computed for this table.

table_storageDescriptor :: Lens' Table (Maybe StorageDescriptor) Source #

A storage descriptor containing information about the physical storage of this table.

table_databaseName :: Lens' Table (Maybe Text) Source #

The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.

table_parameters :: Lens' Table (Maybe (HashMap Text Text)) Source #

These key-value pairs define properties associated with the table.

table_lastAccessTime :: Lens' Table (Maybe UTCTime) Source #

The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.

table_description :: Lens' Table (Maybe Text) Source #

A description of the table.

table_partitionKeys :: Lens' Table (Maybe [Column]) Source #

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": []

table_createTime :: Lens' Table (Maybe UTCTime) Source #

The time when the table definition was created in the Data Catalog.

table_name :: Lens' Table Text Source #

The table name. For Hive compatibility, this must be entirely lowercase.

TableError

tableError_tableName :: Lens' TableError (Maybe Text) Source #

The name of the table. For Hive compatibility, this must be entirely lowercase.

tableError_errorDetail :: Lens' TableError (Maybe ErrorDetail) Source #

The details about the error.

TableIdentifier

tableIdentifier_catalogId :: Lens' TableIdentifier (Maybe Text) Source #

The ID of the Data Catalog in which the table resides.

tableIdentifier_name :: Lens' TableIdentifier (Maybe Text) Source #

The name of the target table.

tableIdentifier_databaseName :: Lens' TableIdentifier (Maybe Text) Source #

The name of the catalog database that contains the target table.

TableInput

tableInput_retention :: Lens' TableInput (Maybe Natural) Source #

The retention time for this table.

tableInput_targetTable :: Lens' TableInput (Maybe TableIdentifier) Source #

A TableIdentifier structure that describes a target table for resource linking.

tableInput_tableType :: Lens' TableInput (Maybe Text) Source #

The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).

tableInput_owner :: Lens' TableInput (Maybe Text) Source #

The table owner.

tableInput_viewOriginalText :: Lens' TableInput (Maybe Text) Source #

If the table is a view, the original text of the view; otherwise null.

tableInput_viewExpandedText :: Lens' TableInput (Maybe Text) Source #

If the table is a view, the expanded text of the view; otherwise null.

tableInput_lastAnalyzedTime :: Lens' TableInput (Maybe UTCTime) Source #

The last time that column statistics were computed for this table.

tableInput_storageDescriptor :: Lens' TableInput (Maybe StorageDescriptor) Source #

A storage descriptor containing information about the physical storage of this table.

tableInput_parameters :: Lens' TableInput (Maybe (HashMap Text Text)) Source #

These key-value pairs define properties associated with the table.

tableInput_lastAccessTime :: Lens' TableInput (Maybe UTCTime) Source #

The last time that the table was accessed.

tableInput_description :: Lens' TableInput (Maybe Text) Source #

A description of the table.

tableInput_partitionKeys :: Lens' TableInput (Maybe [Column]) Source #

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": []

tableInput_name :: Lens' TableInput Text Source #

The table name. For Hive compatibility, this is folded to lowercase when it is stored.

TableVersion

tableVersion_versionId :: Lens' TableVersion (Maybe Text) Source #

The ID value that identifies this table version. A VersionId is a string representation of an integer. Each version is incremented by 1.

tableVersion_table :: Lens' TableVersion (Maybe Table) Source #

The table in question.

TableVersionError

tableVersionError_versionId :: Lens' TableVersionError (Maybe Text) Source #

The ID value of the version in question. A VersionID is a string representation of an integer. Each version is incremented by 1.

tableVersionError_tableName :: Lens' TableVersionError (Maybe Text) Source #

The name of the table in question.

tableVersionError_errorDetail :: Lens' TableVersionError (Maybe ErrorDetail) Source #

The details about the error.

TaskRun

taskRun_completedOn :: Lens' TaskRun (Maybe UTCTime) Source #

The last point in time that the requested task run was completed.

taskRun_status :: Lens' TaskRun (Maybe TaskStatusType) Source #

The current status of the requested task run.

taskRun_lastModifiedOn :: Lens' TaskRun (Maybe UTCTime) Source #

The last point in time that the requested task run was updated.

taskRun_errorString :: Lens' TaskRun (Maybe Text) Source #

The list of error strings associated with this task run.

taskRun_startedOn :: Lens' TaskRun (Maybe UTCTime) Source #

The date and time that this task run started.

taskRun_logGroupName :: Lens' TaskRun (Maybe Text) Source #

The names of the log group for secure logging, associated with this task run.

taskRun_executionTime :: Lens' TaskRun (Maybe Int) Source #

The amount of time (in seconds) that the task run consumed resources.

taskRun_properties :: Lens' TaskRun (Maybe TaskRunProperties) Source #

Specifies configuration properties associated with this task run.

taskRun_transformId :: Lens' TaskRun (Maybe Text) Source #

The unique identifier for the transform.

taskRun_taskRunId :: Lens' TaskRun (Maybe Text) Source #

The unique identifier for this task run.

TaskRunFilterCriteria

taskRunFilterCriteria_status :: Lens' TaskRunFilterCriteria (Maybe TaskStatusType) Source #

The current status of the task run.

taskRunFilterCriteria_startedAfter :: Lens' TaskRunFilterCriteria (Maybe UTCTime) Source #

Filter on task runs started after this date.

taskRunFilterCriteria_startedBefore :: Lens' TaskRunFilterCriteria (Maybe UTCTime) Source #

Filter on task runs started before this date.

taskRunFilterCriteria_taskRunType :: Lens' TaskRunFilterCriteria (Maybe TaskType) Source #

The type of task run.

TaskRunProperties

taskRunProperties_taskType :: Lens' TaskRunProperties (Maybe TaskType) Source #

The type of task run.

taskRunProperties_exportLabelsTaskRunProperties :: Lens' TaskRunProperties (Maybe ExportLabelsTaskRunProperties) Source #

The configuration properties for an exporting labels task run.

taskRunProperties_labelingSetGenerationTaskRunProperties :: Lens' TaskRunProperties (Maybe LabelingSetGenerationTaskRunProperties) Source #

The configuration properties for a labeling set generation task run.

taskRunProperties_findMatchesTaskRunProperties :: Lens' TaskRunProperties (Maybe FindMatchesTaskRunProperties) Source #

The configuration properties for a find matches task run.

taskRunProperties_importLabelsTaskRunProperties :: Lens' TaskRunProperties (Maybe ImportLabelsTaskRunProperties) Source #

The configuration properties for an importing labels task run.

TaskRunSortCriteria

taskRunSortCriteria_column :: Lens' TaskRunSortCriteria TaskRunSortColumnType Source #

The column to be used to sort the list of task runs for the machine learning transform.

taskRunSortCriteria_sortDirection :: Lens' TaskRunSortCriteria SortDirectionType Source #

The sort direction to be used to sort the list of task runs for the machine learning transform.

TransformEncryption

transformEncryption_mlUserDataEncryption :: Lens' TransformEncryption (Maybe MLUserDataEncryption) Source #

An MLUserDataEncryption object containing the encryption mode and customer-provided KMS key ID.

transformEncryption_taskRunSecurityConfigurationName :: Lens' TransformEncryption (Maybe Text) Source #

The name of the security configuration.

TransformFilterCriteria

transformFilterCriteria_createdAfter :: Lens' TransformFilterCriteria (Maybe UTCTime) Source #

The time and date after which the transforms were created.

transformFilterCriteria_status :: Lens' TransformFilterCriteria (Maybe TransformStatusType) Source #

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".

transformFilterCriteria_lastModifiedAfter :: Lens' TransformFilterCriteria (Maybe UTCTime) Source #

Filter on transforms last modified after this date.

transformFilterCriteria_lastModifiedBefore :: Lens' TransformFilterCriteria (Maybe UTCTime) Source #

Filter on transforms last modified before this date.

transformFilterCriteria_glueVersion :: Lens' TransformFilterCriteria (Maybe Text) Source #

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.

transformFilterCriteria_schema :: Lens' TransformFilterCriteria (Maybe [SchemaColumn]) Source #

Filters on datasets with a specific schema. The Map<Column, Type> 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.

transformFilterCriteria_transformType :: Lens' TransformFilterCriteria (Maybe TransformType) Source #

The type of machine learning transform that is used to filter the machine learning transforms.

transformFilterCriteria_name :: Lens' TransformFilterCriteria (Maybe Text) Source #

A unique transform name that is used to filter the machine learning transforms.

transformFilterCriteria_createdBefore :: Lens' TransformFilterCriteria (Maybe UTCTime) Source #

The time and date before which the transforms were created.

TransformParameters

transformParameters_findMatchesParameters :: Lens' TransformParameters (Maybe FindMatchesParameters) Source #

The parameters for the find matches algorithm.

transformParameters_transformType :: Lens' TransformParameters TransformType Source #

The type of machine learning transform.

For information about the types of machine learning transforms, see Creating Machine Learning Transforms.

TransformSortCriteria

transformSortCriteria_column :: Lens' TransformSortCriteria TransformSortColumnType Source #

The column to be used in the sorting criteria that are associated with the machine learning transform.

transformSortCriteria_sortDirection :: Lens' TransformSortCriteria SortDirectionType Source #

The sort direction to be used in the sorting criteria that are associated with the machine learning transform.

Trigger

trigger_workflowName :: Lens' Trigger (Maybe Text) Source #

The name of the workflow associated with the trigger.

trigger_state :: Lens' Trigger (Maybe TriggerState) Source #

The current state of the trigger.

trigger_actions :: Lens' Trigger (Maybe [Action]) Source #

The actions initiated by this trigger.

trigger_schedule :: Lens' Trigger (Maybe Text) Source #

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 * * ? *).

trigger_predicate :: Lens' Trigger (Maybe Predicate) Source #

The predicate of this trigger, which defines when it will fire.

trigger_name :: Lens' Trigger (Maybe Text) Source #

The name of the trigger.

trigger_id :: Lens' Trigger (Maybe Text) Source #

Reserved for future use.

trigger_type :: Lens' Trigger (Maybe TriggerType) Source #

The type of trigger that this is.

trigger_eventBatchingCondition :: Lens' Trigger (Maybe EventBatchingCondition) Source #

Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.

trigger_description :: Lens' Trigger (Maybe Text) Source #

A description of this trigger.

TriggerNodeDetails

triggerNodeDetails_trigger :: Lens' TriggerNodeDetails (Maybe Trigger) Source #

The information of the trigger represented by the trigger node.

TriggerUpdate

triggerUpdate_actions :: Lens' TriggerUpdate (Maybe [Action]) Source #

The actions initiated by this trigger.

triggerUpdate_schedule :: Lens' TriggerUpdate (Maybe Text) Source #

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 * * ? *).

triggerUpdate_predicate :: Lens' TriggerUpdate (Maybe Predicate) Source #

The predicate of this trigger, which defines when it will fire.

triggerUpdate_name :: Lens' TriggerUpdate (Maybe Text) Source #

Reserved for future use.

triggerUpdate_eventBatchingCondition :: Lens' TriggerUpdate (Maybe EventBatchingCondition) Source #

Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.

triggerUpdate_description :: Lens' TriggerUpdate (Maybe Text) Source #

A description of this trigger.

UpdateCsvClassifierRequest

updateCsvClassifierRequest_quoteSymbol :: Lens' UpdateCsvClassifierRequest (Maybe Text) Source #

A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.

updateCsvClassifierRequest_containsHeader :: Lens' UpdateCsvClassifierRequest (Maybe CsvHeaderOption) Source #

Indicates whether the CSV file contains a header.

updateCsvClassifierRequest_disableValueTrimming :: Lens' UpdateCsvClassifierRequest (Maybe Bool) Source #

Specifies not to trim values before identifying the type of column values. The default value is true.

updateCsvClassifierRequest_header :: Lens' UpdateCsvClassifierRequest (Maybe [Text]) Source #

A list of strings representing column names.

updateCsvClassifierRequest_allowSingleColumn :: Lens' UpdateCsvClassifierRequest (Maybe Bool) Source #

Enables the processing of files that contain only one column.

updateCsvClassifierRequest_delimiter :: Lens' UpdateCsvClassifierRequest (Maybe Text) Source #

A custom symbol to denote what separates each column entry in the row.

updateCsvClassifierRequest_name :: Lens' UpdateCsvClassifierRequest Text Source #

The name of the classifier.

UpdateGrokClassifierRequest

updateGrokClassifierRequest_classification :: Lens' UpdateGrokClassifierRequest (Maybe Text) Source #

An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on.

updateGrokClassifierRequest_customPatterns :: Lens' UpdateGrokClassifierRequest (Maybe Text) Source #

Optional custom grok patterns used by this classifier.

updateGrokClassifierRequest_grokPattern :: Lens' UpdateGrokClassifierRequest (Maybe Text) Source #

The grok pattern used by this classifier.

updateGrokClassifierRequest_name :: Lens' UpdateGrokClassifierRequest Text Source #

The name of the GrokClassifier.

UpdateJsonClassifierRequest

updateJsonClassifierRequest_jsonPath :: Lens' UpdateJsonClassifierRequest (Maybe Text) Source #

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.

updateJsonClassifierRequest_name :: Lens' UpdateJsonClassifierRequest Text Source #

The name of the classifier.

UpdateXMLClassifierRequest

updateXMLClassifierRequest_classification :: Lens' UpdateXMLClassifierRequest (Maybe Text) Source #

An identifier of the data format that the classifier matches.

updateXMLClassifierRequest_rowTag :: Lens' UpdateXMLClassifierRequest (Maybe Text) Source #

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, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).

updateXMLClassifierRequest_name :: Lens' UpdateXMLClassifierRequest Text Source #

The name of the classifier.

UserDefinedFunction

userDefinedFunction_ownerName :: Lens' UserDefinedFunction (Maybe Text) Source #

The owner of the function.

userDefinedFunction_catalogId :: Lens' UserDefinedFunction (Maybe Text) Source #

The ID of the Data Catalog in which the function resides.

userDefinedFunction_resourceUris :: Lens' UserDefinedFunction (Maybe [ResourceUri]) Source #

The resource URIs for the function.

userDefinedFunction_databaseName :: Lens' UserDefinedFunction (Maybe Text) Source #

The name of the catalog database that contains the function.

userDefinedFunction_functionName :: Lens' UserDefinedFunction (Maybe Text) Source #

The name of the function.

userDefinedFunction_ownerType :: Lens' UserDefinedFunction (Maybe PrincipalType) Source #

The owner type.

userDefinedFunction_createTime :: Lens' UserDefinedFunction (Maybe UTCTime) Source #

The time at which the function was created.

userDefinedFunction_className :: Lens' UserDefinedFunction (Maybe Text) Source #

The Java class that contains the function code.

UserDefinedFunctionInput

userDefinedFunctionInput_ownerName :: Lens' UserDefinedFunctionInput (Maybe Text) Source #

The owner of the function.

userDefinedFunctionInput_resourceUris :: Lens' UserDefinedFunctionInput (Maybe [ResourceUri]) Source #

The resource URIs for the function.

userDefinedFunctionInput_functionName :: Lens' UserDefinedFunctionInput (Maybe Text) Source #

The name of the function.

userDefinedFunctionInput_ownerType :: Lens' UserDefinedFunctionInput (Maybe PrincipalType) Source #

The owner type.

userDefinedFunctionInput_className :: Lens' UserDefinedFunctionInput (Maybe Text) Source #

The Java class that contains the function code.

Workflow

workflow_graph :: Lens' Workflow (Maybe WorkflowGraph) Source #

The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.

workflow_lastModifiedOn :: Lens' Workflow (Maybe UTCTime) Source #

The date and time when the workflow was last modified.

workflow_blueprintDetails :: Lens' Workflow (Maybe BlueprintDetails) Source #

This structure indicates the details of the blueprint that this particular workflow is created from.

workflow_maxConcurrentRuns :: Lens' Workflow (Maybe Int) Source #

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.

workflow_defaultRunProperties :: Lens' Workflow (Maybe (HashMap Text Text)) Source #

A collection of properties to be used as part of each execution of the workflow. The run properties are made available to each job in the workflow. A job can modify the properties for the next jobs in the flow.

workflow_name :: Lens' Workflow (Maybe Text) Source #

The name of the workflow.

workflow_lastRun :: Lens' Workflow (Maybe WorkflowRun) Source #

The information about the last execution of the workflow.

workflow_description :: Lens' Workflow (Maybe Text) Source #

A description of the workflow.

workflow_createdOn :: Lens' Workflow (Maybe UTCTime) Source #

The date and time when the workflow was created.

WorkflowGraph

workflowGraph_edges :: Lens' WorkflowGraph (Maybe [Edge]) Source #

A list of all the directed connections between the nodes belonging to the workflow.

workflowGraph_nodes :: Lens' WorkflowGraph (Maybe [Node]) Source #

A list of the the Glue components belong to the workflow represented as nodes.

WorkflowRun

workflowRun_completedOn :: Lens' WorkflowRun (Maybe UTCTime) Source #

The date and time when the workflow run completed.

workflowRun_status :: Lens' WorkflowRun (Maybe WorkflowRunStatus) Source #

The status of the workflow run.

workflowRun_graph :: Lens' WorkflowRun (Maybe WorkflowGraph) Source #

The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.

workflowRun_startedOn :: Lens' WorkflowRun (Maybe UTCTime) Source #

The date and time when the workflow run was started.

workflowRun_workflowRunId :: Lens' WorkflowRun (Maybe Text) Source #

The ID of this workflow run.

workflowRun_name :: Lens' WorkflowRun (Maybe Text) Source #

Name of the workflow that was run.

workflowRun_previousRunId :: Lens' WorkflowRun (Maybe Text) Source #

The ID of the previous workflow run.

workflowRun_statistics :: Lens' WorkflowRun (Maybe WorkflowRunStatistics) Source #

The statistics of the run.

workflowRun_startingEventBatchCondition :: Lens' WorkflowRun (Maybe StartingEventBatchCondition) Source #

The batch condition that started the workflow run.

workflowRun_errorMessage :: Lens' WorkflowRun (Maybe Text) Source #

This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow: foo."

workflowRun_workflowRunProperties :: Lens' WorkflowRun (Maybe (HashMap Text Text)) Source #

The workflow run properties which were set during the run.

WorkflowRunStatistics

workflowRunStatistics_runningActions :: Lens' WorkflowRunStatistics (Maybe Int) Source #

Total number Actions in running state.

workflowRunStatistics_stoppedActions :: Lens' WorkflowRunStatistics (Maybe Int) Source #

Total number of Actions that have stopped.

workflowRunStatistics_totalActions :: Lens' WorkflowRunStatistics (Maybe Int) Source #

Total number of Actions in the workflow run.

workflowRunStatistics_failedActions :: Lens' WorkflowRunStatistics (Maybe Int) Source #

Total number of Actions that have failed.

workflowRunStatistics_timeoutActions :: Lens' WorkflowRunStatistics (Maybe Int) Source #

Total number of Actions that timed out.

workflowRunStatistics_succeededActions :: Lens' WorkflowRunStatistics (Maybe Int) Source #

Total number of Actions that have succeeded.

XMLClassifier

xMLClassifier_creationTime :: Lens' XMLClassifier (Maybe UTCTime) Source #

The time that this classifier was registered.

xMLClassifier_lastUpdated :: Lens' XMLClassifier (Maybe UTCTime) Source #

The time that this classifier was last updated.

xMLClassifier_version :: Lens' XMLClassifier (Maybe Integer) Source #

The version of this classifier.

xMLClassifier_rowTag :: Lens' XMLClassifier (Maybe Text) Source #

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, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).

xMLClassifier_name :: Lens' XMLClassifier Text Source #

The name of the classifier.

xMLClassifier_classification :: Lens' XMLClassifier Text Source #

An identifier of the data format that the classifier matches.