Typed dictionaries
Auto-generated documentation for Glue type annotations stubs module mypy-boto3-glue.
NotificationPropertyTypeDef
Usage Example
from mypy_boto3_glue.type_defs import NotificationPropertyTypeDef
def get_value() -> NotificationPropertyTypeDef:
return {
"NotifyDelayAfter": ...,
}
AggregateOperationTypeDef
Usage Example
from mypy_boto3_glue.type_defs import AggregateOperationTypeDef
def get_value() -> AggregateOperationTypeDef:
return {
"Column": ...,
"AggFunc": ...,
}
Definition
class AggregateOperationTypeDef(TypedDict):
Column: List[str],
AggFunc: AggFunctionType, # (1)
- See AggFunctionType
ApplyMappingTypeDef
Usage Example
from mypy_boto3_glue.type_defs import ApplyMappingTypeDef
def get_value() -> ApplyMappingTypeDef:
return {
"Name": ...,
"Inputs": ...,
"Mapping": ...,
}
Definition
class ApplyMappingTypeDef(TypedDict):
Name: str,
Inputs: List[str],
Mapping: List[MappingTypeDef], # (1)
- See MappingTypeDef
AuditContextTypeDef
Usage Example
from mypy_boto3_glue.type_defs import AuditContextTypeDef
def get_value() -> AuditContextTypeDef:
return {
"AdditionalAuditContext": ...,
}
Definition
class AuditContextTypeDef(TypedDict):
AdditionalAuditContext: NotRequired[str],
RequestedColumns: NotRequired[Sequence[str]],
AllColumnsRequested: NotRequired[bool],
PartitionValueListTypeDef
Usage Example
from mypy_boto3_glue.type_defs import PartitionValueListTypeDef
def get_value() -> PartitionValueListTypeDef:
return {
"Values": ...,
}
BasicCatalogTargetTypeDef
Usage Example
from mypy_boto3_glue.type_defs import BasicCatalogTargetTypeDef
def get_value() -> BasicCatalogTargetTypeDef:
return {
"Name": ...,
"Inputs": ...,
"Database": ...,
"Table": ...,
}
Definition
class BasicCatalogTargetTypeDef(TypedDict):
Name: str,
Inputs: List[str],
Database: str,
Table: str,
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_glue.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
BatchDeleteConnectionRequestRequestTypeDef
Usage Example
from mypy_boto3_glue.type_defs import BatchDeleteConnectionRequestRequestTypeDef
def get_value() -> BatchDeleteConnectionRequestRequestTypeDef:
return {
"ConnectionNameList": ...,
}
Definition
class BatchDeleteConnectionRequestRequestTypeDef(TypedDict):
ConnectionNameList: Sequence[str],
CatalogId: NotRequired[str],
ErrorDetailTypeDef
Usage Example
from mypy_boto3_glue.type_defs import ErrorDetailTypeDef
def get_value() -> ErrorDetailTypeDef:
return {
"ErrorCode": ...,
}
Definition
class ErrorDetailTypeDef(TypedDict):
ErrorCode: NotRequired[str],
ErrorMessage: NotRequired[str],
BatchDeleteTableRequestRequestTypeDef
Usage Example
from mypy_boto3_glue.type_defs import BatchDeleteTableRequestRequestTypeDef
def get_value() -> BatchDeleteTableRequestRequestTypeDef:
return {
"DatabaseName": ...,
"TablesToDelete": ...,
}
Definition
class BatchDeleteTableRequestRequestTypeDef(TypedDict):
DatabaseName: str,
TablesToDelete: Sequence[str],
CatalogId: NotRequired[str],
TransactionId: NotRequired[str],
BatchDeleteTableVersionRequestRequestTypeDef
Usage Example
from mypy_boto3_glue.type_defs import BatchDeleteTableVersionRequestRequestTypeDef
def get_value() -> BatchDeleteTableVersionRequestRequestTypeDef:
return {
"DatabaseName": ...,
"TableName": ...,
"VersionIds": ...,
}
Definition
class BatchDeleteTableVersionRequestRequestTypeDef(TypedDict):
DatabaseName: str,
TableName: str,
VersionIds: Sequence[str],
CatalogId: NotRequired[str],
BatchGetBlueprintsRequestRequestTypeDef
Usage Example
from mypy_boto3_glue.type_defs import BatchGetBlueprintsRequestRequestTypeDef
def get_value() -> BatchGetBlueprintsRequestRequestTypeDef:
return {
"Names": ...,
}
Definition
class BatchGetBlueprintsRequestRequestTypeDef(TypedDict):
Names: Sequence[str],
IncludeBlueprint: NotRequired[bool],
IncludeParameterSpec: NotRequired[bool],
BatchGetCrawlersRequestRequestTypeDef
Usage Example
from mypy_boto3_glue.type_defs import BatchGetCrawlersRequestRequestTypeDef
def get_value() -> BatchGetCrawlersRequestRequestTypeDef:
return {
"CrawlerNames": ...,
}
BatchGetCustomEntityTypesRequestRequestTypeDef
Usage Example
from mypy_boto3_glue.type_defs import BatchGetCustomEntityTypesRequestRequestTypeDef
def get_value() -> BatchGetCustomEntityTypesRequestRequestTypeDef:
return {
"Names": ...,
}
CustomEntityTypeTypeDef
Usage Example
from mypy_boto3_glue.type_defs import CustomEntityTypeTypeDef
def get_value() -> CustomEntityTypeTypeDef:
return {
"Name": ...,
"RegexString": ...,
}
Definition
class CustomEntityTypeTypeDef(TypedDict):
Name: str,
RegexString: str,
ContextWords: NotRequired[List[str]],
BatchGetDataQualityResultRequestRequestTypeDef
Usage Example
from mypy_boto3_glue.type_defs import BatchGetDataQualityResultRequestRequestTypeDef
def get_value() -> BatchGetDataQualityResultRequestRequestTypeDef:
return {
"ResultIds": ...,
}
Definition
class BatchGetDataQualityResultRequestRequestTypeDef(TypedDict):
ResultIds: Sequence[str],
BatchGetDevEndpointsRequestRequestTypeDef
Usage Example
from mypy_boto3_glue.type_defs import BatchGetDevEndpointsRequestRequestTypeDef
def get_value() -> BatchGetDevEndpointsRequestRequestTypeDef:
return {
"DevEndpointNames": ...,
}
Definition
class BatchGetDevEndpointsRequestRequestTypeDef(TypedDict):
DevEndpointNames: Sequence[str],
DevEndpointTypeDef
Usage Example
from mypy_boto3_glue.type_defs import DevEndpointTypeDef
def get_value() -> DevEndpointTypeDef:
return {
"EndpointName": ...,
}
Definition
class DevEndpointTypeDef(TypedDict):
EndpointName: NotRequired[str],
RoleArn: NotRequired[str],
SecurityGroupIds: NotRequired[List[str]],
SubnetId: NotRequired[str],
YarnEndpointAddress: NotRequired[str],
PrivateAddress: NotRequired[str],
ZeppelinRemoteSparkInterpreterPort: NotRequired[int],
PublicAddress: NotRequired[str],
Status: NotRequired[str],
WorkerType: NotRequired[WorkerTypeType], # (1)
GlueVersion: NotRequired[str],
NumberOfWorkers: NotRequired[int],
NumberOfNodes: NotRequired[int],
AvailabilityZone: NotRequired[str],
VpcId: NotRequired[str],
ExtraPythonLibsS3Path: NotRequired[str],
ExtraJarsS3Path: NotRequired[str],
FailureReason: NotRequired[str],
LastUpdateStatus: NotRequired[str],
CreatedTimestamp: NotRequired[datetime],
LastModifiedTimestamp: NotRequired[datetime],
PublicKey: NotRequired[str],
PublicKeys: NotRequired[List[str]],
SecurityConfiguration: NotRequired[str],
Arguments: NotRequired[Dict[str, str]],
- See WorkerTypeType
BatchGetJobsRequestRequestTypeDef
Usage Example
from mypy_boto3_glue.type_defs import BatchGetJobsRequestRequestTypeDef
def get_value() -> BatchGetJobsRequestRequestTypeDef:
return {
"JobNames": ...,
}
BatchGetTriggersRequestRequestTypeDef
Usage Example
from mypy_boto3_glue.type_defs import BatchGetTriggersRequestRequestTypeDef
def get_value() -> BatchGetTriggersRequestRequestTypeDef:
return {
"TriggerNames": ...,
}
BatchGetWorkflowsRequestRequestTypeDef
Usage Example
from mypy_boto3_glue.type_defs import BatchGetWorkflowsRequestRequestTypeDef
def get_value() -> BatchGetWorkflowsRequestRequestTypeDef:
return {
"Names": ...,
}
Definition
class BatchGetWorkflowsRequestRequestTypeDef(TypedDict):
Names: Sequence[str],
IncludeGraph: NotRequired[bool],
BatchStopJobRunRequestRequestTypeDef
Usage Example
from mypy_boto3_glue.type_defs import BatchStopJobRunRequestRequestTypeDef
def get_value() -> BatchStopJobRunRequestRequestTypeDef:
return {
"JobName": ...,
"JobRunIds": ...,
}
Definition
class BatchStopJobRunRequestRequestTypeDef(TypedDict):
JobName: str,
JobRunIds: Sequence[str],
BatchStopJobRunSuccessfulSubmissionTypeDef
Usage Example
from mypy_boto3_glue.type_defs import BatchStopJobRunSuccessfulSubmissionTypeDef
def get_value() -> BatchStopJobRunSuccessfulSubmissionTypeDef:
return {
"JobName": ...,
}
Definition
class BatchStopJobRunSuccessfulSubmissionTypeDef(TypedDict):
JobName: NotRequired[str],
JobRunId: NotRequired[str],
BinaryColumnStatisticsDataTypeDef
Usage Example
from mypy_boto3_glue.type_defs import BinaryColumnStatisticsDataTypeDef
def get_value() -> BinaryColumnStatisticsDataTypeDef:
return {
"MaximumLength": ...,
"AverageLength": ...,
"NumberOfNulls": ...,
}
Definition
class BinaryColumnStatisticsDataTypeDef(TypedDict):
MaximumLength: int,
AverageLength: float,
NumberOfNulls: int,
BlueprintDetailsTypeDef
Usage Example
from mypy_boto3_glue.type_defs import BlueprintDetailsTypeDef
def get_value() -> BlueprintDetailsTypeDef:
return {
"BlueprintName": ...,
}
Definition
class BlueprintDetailsTypeDef(TypedDict):
BlueprintName: NotRequired[str],
RunId: NotRequired[str],
BlueprintRunTypeDef
Usage Example
from mypy_boto3_glue.type_defs import BlueprintRunTypeDef
def get_value() -> BlueprintRunTypeDef:
return {
"BlueprintName": ...,
}
Definition
class BlueprintRunTypeDef(TypedDict):
BlueprintName: NotRequired[str],
RunId: NotRequired[str],
WorkflowName: NotRequired[str],
State: NotRequired[BlueprintRunStateType], # (1)
StartedOn: NotRequired[datetime],
CompletedOn: NotRequired[datetime],
ErrorMessage: NotRequired[str],
RollbackErrorMessage: NotRequired[str],
Parameters: NotRequired[str],
RoleArn: NotRequired[str],
LastActiveDefinitionTypeDef
Usage Example
from mypy_boto3_glue.type_defs import LastActiveDefinitionTypeDef
def get_value() -> LastActiveDefinitionTypeDef:
return {
"Description": ...,
}
Definition
class LastActiveDefinitionTypeDef(TypedDict):
Description: NotRequired[str],
LastModifiedOn: NotRequired[datetime],
ParameterSpec: NotRequired[str],
BlueprintLocation: NotRequired[str],
BlueprintServiceLocation: NotRequired[str],
BooleanColumnStatisticsDataTypeDef
Usage Example
from mypy_boto3_glue.type_defs import BooleanColumnStatisticsDataTypeDef
def get_value() -> BooleanColumnStatisticsDataTypeDef:
return {
"NumberOfTrues": ...,
"NumberOfFalses": ...,
"NumberOfNulls": ...,
}
Definition
class BooleanColumnStatisticsDataTypeDef(TypedDict):
NumberOfTrues: int,
NumberOfFalses: int,
NumberOfNulls: int,
CancelDataQualityRuleRecommendationRunRequestRequestTypeDef
Usage Example
from mypy_boto3_glue.type_defs import CancelDataQualityRuleRecommendationRunRequestRequestTypeDef
def get_value() -> CancelDataQualityRuleRecommendationRunRequestRequestTypeDef:
return {
"RunId": ...,
}
CancelDataQualityRulesetEvaluationRunRequestRequestTypeDef
Usage Example
from mypy_boto3_glue.type_defs import CancelDataQualityRulesetEvaluationRunRequestRequestTypeDef
def get_value() -> CancelDataQualityRulesetEvaluationRunRequestRequestTypeDef:
return {
"RunId": ...,
}
CancelMLTaskRunRequestRequestTypeDef
Usage Example
from mypy_boto3_glue.type_defs import CancelMLTaskRunRequestRequestTypeDef
def get_value() -> CancelMLTaskRunRequestRequestTypeDef:
return {
"TransformId": ...,
"TaskRunId": ...,
}
CancelStatementRequestRequestTypeDef
Usage Example
from mypy_boto3_glue.type_defs import CancelStatementRequestRequestTypeDef
def get_value() -> CancelStatementRequestRequestTypeDef:
return {
"SessionId": ...,
"Id": ...,
}
Definition
class CancelStatementRequestRequestTypeDef(TypedDict):
SessionId: str,
Id: int,
RequestOrigin: NotRequired[str],
CatalogEntryTypeDef
Usage Example
from mypy_boto3_glue.type_defs import CatalogEntryTypeDef
def get_value() -> CatalogEntryTypeDef:
return {
"DatabaseName": ...,
"TableName": ...,
}
CatalogImportStatusTypeDef
Usage Example
from mypy_boto3_glue.type_defs import CatalogImportStatusTypeDef
def get_value() -> CatalogImportStatusTypeDef:
return {
"ImportCompleted": ...,
}
Definition
class CatalogImportStatusTypeDef(TypedDict):
ImportCompleted: NotRequired[bool],
ImportTime: NotRequired[datetime],
ImportedBy: NotRequired[str],
KafkaStreamingSourceOptionsTypeDef
Usage Example
from mypy_boto3_glue.type_defs import KafkaStreamingSourceOptionsTypeDef
def get_value() -> KafkaStreamingSourceOptionsTypeDef:
return {
"BootstrapServers": ...,
}
Definition
class KafkaStreamingSourceOptionsTypeDef(TypedDict):
BootstrapServers: NotRequired[str],
SecurityProtocol: NotRequired[str],
ConnectionName: NotRequired[str],
TopicName: NotRequired[str],
Assign: NotRequired[str],
SubscribePattern: NotRequired[str],
Classification: NotRequired[str],
Delimiter: NotRequired[str],
StartingOffsets: NotRequired[str],
EndingOffsets: NotRequired[str],
PollTimeoutMs: NotRequired[int],
NumRetries: NotRequired[int],
RetryIntervalMs: NotRequired[int],
MaxOffsetsPerTrigger: NotRequired[int],
MinPartitions: NotRequired[int],
IncludeHeaders: NotRequired[bool],
AddRecordTimestamp: NotRequired[str],
EmitConsumerLagMetrics: NotRequired[str],
StreamingDataPreviewOptionsTypeDef
Usage Example
from mypy_boto3_glue.type_defs import StreamingDataPreviewOptionsTypeDef
def get_value() -> StreamingDataPreviewOptionsTypeDef:
return {
"PollingTime": ...,
}
Definition
class StreamingDataPreviewOptionsTypeDef(TypedDict):
PollingTime: NotRequired[int],
RecordPollingLimit: NotRequired[int],
KinesisStreamingSourceOptionsTypeDef
Usage Example
from mypy_boto3_glue.type_defs import KinesisStreamingSourceOptionsTypeDef
def get_value() -> KinesisStreamingSourceOptionsTypeDef:
return {
"EndpointUrl": ...,
}
Definition
class KinesisStreamingSourceOptionsTypeDef(TypedDict):
EndpointUrl: NotRequired[str],
StreamName: NotRequired[str],
Classification: NotRequired[str],
Delimiter: NotRequired[str],
StartingPosition: NotRequired[StartingPositionType], # (1)
MaxFetchTimeInMs: NotRequired[int],
MaxFetchRecordsPerShard: NotRequired[int],
MaxRecordPerRead: NotRequired[int],
AddIdleTimeBetweenReads: NotRequired[bool],
IdleTimeBetweenReadsInMs: NotRequired[int],
DescribeShardInterval: NotRequired[int],
NumRetries: NotRequired[int],
RetryIntervalMs: NotRequired[int],
MaxRetryIntervalMs: NotRequired[int],
AvoidEmptyBatches: NotRequired[bool],
StreamArn: NotRequired[str],
RoleArn: NotRequired[str],
RoleSessionName: NotRequired[str],
AddRecordTimestamp: NotRequired[str],
EmitConsumerLagMetrics: NotRequired[str],
CatalogSchemaChangePolicyTypeDef
Usage Example
from mypy_boto3_glue.type_defs import CatalogSchemaChangePolicyTypeDef
def get_value() -> CatalogSchemaChangePolicyTypeDef:
return {
"EnableUpdateCatalog": ...,
}
Definition
class CatalogSchemaChangePolicyTypeDef(TypedDict):
EnableUpdateCatalog: NotRequired[bool],
UpdateBehavior: NotRequired[UpdateCatalogBehaviorType], # (1)
CatalogSourceTypeDef
Usage Example
from mypy_boto3_glue.type_defs import CatalogSourceTypeDef
def get_value() -> CatalogSourceTypeDef:
return {
"Name": ...,
"Database": ...,
"Table": ...,
}
CatalogTargetTypeDef
Usage Example
from mypy_boto3_glue.type_defs import CatalogTargetTypeDef
def get_value() -> CatalogTargetTypeDef:
return {
"DatabaseName": ...,
"Tables": ...,
}
Definition
class CatalogTargetTypeDef(TypedDict):
DatabaseName: str,
Tables: List[str],
ConnectionName: NotRequired[str],
EventQueueArn: NotRequired[str],
DlqEventQueueArn: NotRequired[str],
CheckSchemaVersionValidityInputRequestTypeDef
Usage Example
from mypy_boto3_glue.type_defs import CheckSchemaVersionValidityInputRequestTypeDef
def get_value() -> CheckSchemaVersionValidityInputRequestTypeDef:
return {
"DataFormat": ...,
"SchemaDefinition": ...,
}
Definition
class CheckSchemaVersionValidityInputRequestTypeDef(TypedDict):
DataFormat: DataFormatType, # (1)
SchemaDefinition: str,
- See DataFormatType
CsvClassifierTypeDef
Usage Example
from mypy_boto3_glue.type_defs import CsvClassifierTypeDef
def get_value() -> CsvClassifierTypeDef:
return {
"Name": ...,
}
Definition
class CsvClassifierTypeDef(TypedDict):
Name: str,
CreationTime: NotRequired[datetime],
LastUpdated: NotRequired[datetime],
Version: NotRequired[int],
Delimiter: NotRequired[str],
QuoteSymbol: NotRequired[str],
ContainsHeader: NotRequired[CsvHeaderOptionType], # (1)
Header: NotRequired[List[str]],
DisableValueTrimming: NotRequired[bool],
AllowSingleColumn: NotRequired[bool],
CustomDatatypeConfigured: NotRequired[bool],
CustomDatatypes: NotRequired[List[str]],
GrokClassifierTypeDef
Usage Example
from mypy_boto3_glue.type_defs import GrokClassifierTypeDef
def get_value() -> GrokClassifierTypeDef:
return {
"Name": ...,
"Classification": ...,
"GrokPattern": ...,
}
Definition
class GrokClassifierTypeDef(TypedDict):
Name: str,
Classification: str,
GrokPattern: str,
CreationTime: NotRequired[datetime],
LastUpdated: NotRequired[datetime],
Version: NotRequired[int],
CustomPatterns: NotRequired[str],
JsonClassifierTypeDef
Usage Example
from mypy_boto3_glue.type_defs import JsonClassifierTypeDef
def get_value() -> JsonClassifierTypeDef:
return {
"Name": ...,
"JsonPath": ...,
}
Definition
class JsonClassifierTypeDef(TypedDict):
Name: str,
JsonPath: str,
CreationTime: NotRequired[datetime],
LastUpdated: NotRequired[datetime],
Version: NotRequired[int],
XMLClassifierTypeDef
Usage Example
from mypy_boto3_glue.type_defs import XMLClassifierTypeDef
def get_value() -> XMLClassifierTypeDef:
return {
"Name": ...,
"Classification": ...,
}
Definition
class XMLClassifierTypeDef(TypedDict):
Name: str,
Classification: str,
CreationTime: NotRequired[datetime],
LastUpdated: NotRequired[datetime],
Version: NotRequired[int],
RowTag: NotRequired[str],
CloudWatchEncryptionTypeDef
Usage Example
from mypy_boto3_glue.type_defs import CloudWatchEncryptionTypeDef
def get_value() -> CloudWatchEncryptionTypeDef:
return {
"CloudWatchEncryptionMode": ...,
}
Definition
class CloudWatchEncryptionTypeDef(TypedDict):
CloudWatchEncryptionMode: NotRequired[CloudWatchEncryptionModeType], # (1)
KmsKeyArn: NotRequired[str],
DropDuplicatesTypeDef
Usage Example
from mypy_boto3_glue.type_defs import DropDuplicatesTypeDef
def get_value() -> DropDuplicatesTypeDef:
return {
"Name": ...,
"Inputs": ...,
}
Definition
class DropDuplicatesTypeDef(TypedDict):
Name: str,
Inputs: List[str],
Columns: NotRequired[List[List[str]]],