Skip to content

Type definitions#

Index > GlueDataBrew > Type definitions

Auto-generated documentation for GlueDataBrew type annotations stubs module mypy-boto3-databrew.

AllowedStatisticsTypeDef#

# AllowedStatisticsTypeDef definition

class AllowedStatisticsTypeDef(TypedDict):
    Statistics: Sequence[str],

BatchDeleteRecipeVersionRequestRequestTypeDef#

# BatchDeleteRecipeVersionRequestRequestTypeDef definition

class BatchDeleteRecipeVersionRequestRequestTypeDef(TypedDict):
    Name: str,
    RecipeVersions: Sequence[str],

RecipeVersionErrorDetailTypeDef#

# RecipeVersionErrorDetailTypeDef definition

class RecipeVersionErrorDetailTypeDef(TypedDict):
    ErrorCode: NotRequired[str],
    ErrorMessage: NotRequired[str],
    RecipeVersion: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

ColumnSelectorTypeDef#

# ColumnSelectorTypeDef definition

class ColumnSelectorTypeDef(TypedDict):
    Regex: NotRequired[str],
    Name: NotRequired[str],

ConditionExpressionTypeDef#

# ConditionExpressionTypeDef definition

class ConditionExpressionTypeDef(TypedDict):
    Condition: str,
    TargetColumn: str,
    Value: NotRequired[str],

JobSampleTypeDef#

# JobSampleTypeDef definition

class JobSampleTypeDef(TypedDict):
    Mode: NotRequired[SampleModeType],  # (1)
    Size: NotRequired[int],
  1. See SampleModeType

S3LocationTypeDef#

# S3LocationTypeDef definition

class S3LocationTypeDef(TypedDict):
    Bucket: str,
    Key: NotRequired[str],
    BucketOwner: NotRequired[str],

ValidationConfigurationTypeDef#

# ValidationConfigurationTypeDef definition

class ValidationConfigurationTypeDef(TypedDict):
    RulesetArn: str,
    ValidationMode: NotRequired[ValidationModeType],  # (1)
  1. See ValidationModeType

SampleTypeDef#

# SampleTypeDef definition

class SampleTypeDef(TypedDict):
    Type: SampleTypeType,  # (1)
    Size: NotRequired[int],
  1. See SampleTypeType

RecipeReferenceTypeDef#

# RecipeReferenceTypeDef definition

class RecipeReferenceTypeDef(TypedDict):
    Name: str,
    RecipeVersion: NotRequired[str],

CreateScheduleRequestRequestTypeDef#

# CreateScheduleRequestRequestTypeDef definition

class CreateScheduleRequestRequestTypeDef(TypedDict):
    CronExpression: str,
    Name: str,
    JobNames: NotRequired[Sequence[str]],
    Tags: NotRequired[Mapping[str, str]],

CsvOptionsTypeDef#

# CsvOptionsTypeDef definition

class CsvOptionsTypeDef(TypedDict):
    Delimiter: NotRequired[str],
    HeaderRow: NotRequired[bool],

CsvOutputOptionsTypeDef#

# CsvOutputOptionsTypeDef definition

class CsvOutputOptionsTypeDef(TypedDict):
    Delimiter: NotRequired[str],

DatetimeOptionsTypeDef#

# DatetimeOptionsTypeDef definition

class DatetimeOptionsTypeDef(TypedDict):
    Format: str,
    TimezoneOffset: NotRequired[str],
    LocaleCode: NotRequired[str],

FilterExpressionPaginatorTypeDef#

# FilterExpressionPaginatorTypeDef definition

class FilterExpressionPaginatorTypeDef(TypedDict):
    Expression: str,
    ValuesMap: Dict[str, str],

FilterExpressionTypeDef#

# FilterExpressionTypeDef definition

class FilterExpressionTypeDef(TypedDict):
    Expression: str,
    ValuesMap: Mapping[str, str],

DeleteDatasetRequestRequestTypeDef#

# DeleteDatasetRequestRequestTypeDef definition

class DeleteDatasetRequestRequestTypeDef(TypedDict):
    Name: str,

DeleteJobRequestRequestTypeDef#

# DeleteJobRequestRequestTypeDef definition

class DeleteJobRequestRequestTypeDef(TypedDict):
    Name: str,

DeleteProjectRequestRequestTypeDef#

# DeleteProjectRequestRequestTypeDef definition

class DeleteProjectRequestRequestTypeDef(TypedDict):
    Name: str,

DeleteRecipeVersionRequestRequestTypeDef#

# DeleteRecipeVersionRequestRequestTypeDef definition

class DeleteRecipeVersionRequestRequestTypeDef(TypedDict):
    Name: str,
    RecipeVersion: str,

DeleteRulesetRequestRequestTypeDef#

# DeleteRulesetRequestRequestTypeDef definition

class DeleteRulesetRequestRequestTypeDef(TypedDict):
    Name: str,

DeleteScheduleRequestRequestTypeDef#

# DeleteScheduleRequestRequestTypeDef definition

class DeleteScheduleRequestRequestTypeDef(TypedDict):
    Name: str,

DescribeDatasetRequestRequestTypeDef#

# DescribeDatasetRequestRequestTypeDef definition

class DescribeDatasetRequestRequestTypeDef(TypedDict):
    Name: str,

DescribeJobRequestRequestTypeDef#

# DescribeJobRequestRequestTypeDef definition

class DescribeJobRequestRequestTypeDef(TypedDict):
    Name: str,

DescribeJobRunRequestRequestTypeDef#

# DescribeJobRunRequestRequestTypeDef definition

class DescribeJobRunRequestRequestTypeDef(TypedDict):
    Name: str,
    RunId: str,

DescribeProjectRequestRequestTypeDef#

# DescribeProjectRequestRequestTypeDef definition

class DescribeProjectRequestRequestTypeDef(TypedDict):
    Name: str,

DescribeRecipeRequestRequestTypeDef#

# DescribeRecipeRequestRequestTypeDef definition

class DescribeRecipeRequestRequestTypeDef(TypedDict):
    Name: str,
    RecipeVersion: NotRequired[str],

DescribeRulesetRequestRequestTypeDef#

# DescribeRulesetRequestRequestTypeDef definition

class DescribeRulesetRequestRequestTypeDef(TypedDict):
    Name: str,

DescribeScheduleRequestRequestTypeDef#

# DescribeScheduleRequestRequestTypeDef definition

class DescribeScheduleRequestRequestTypeDef(TypedDict):
    Name: str,

ExcelOptionsPaginatorTypeDef#

# ExcelOptionsPaginatorTypeDef definition

class ExcelOptionsPaginatorTypeDef(TypedDict):
    SheetNames: NotRequired[List[str]],
    SheetIndexes: NotRequired[List[int]],
    HeaderRow: NotRequired[bool],

ExcelOptionsTypeDef#

# ExcelOptionsTypeDef definition

class ExcelOptionsTypeDef(TypedDict):
    SheetNames: NotRequired[Sequence[str]],
    SheetIndexes: NotRequired[Sequence[int]],
    HeaderRow: NotRequired[bool],

FilesLimitTypeDef#

# FilesLimitTypeDef definition

class FilesLimitTypeDef(TypedDict):
    MaxFiles: int,
    OrderedBy: NotRequired[OrderedByType],  # (1)
    Order: NotRequired[OrderType],  # (2)
  1. See OrderedByType
  2. See OrderType

JsonOptionsTypeDef#

# JsonOptionsTypeDef definition

class JsonOptionsTypeDef(TypedDict):
    MultiLine: NotRequired[bool],

MetadataTypeDef#

# MetadataTypeDef definition

class MetadataTypeDef(TypedDict):
    SourceArn: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListDatasetsRequestRequestTypeDef#

# ListDatasetsRequestRequestTypeDef definition

class ListDatasetsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListJobRunsRequestRequestTypeDef#

# ListJobRunsRequestRequestTypeDef definition

class ListJobRunsRequestRequestTypeDef(TypedDict):
    Name: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListJobsRequestRequestTypeDef#

# ListJobsRequestRequestTypeDef definition

class ListJobsRequestRequestTypeDef(TypedDict):
    DatasetName: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    ProjectName: NotRequired[str],

ListProjectsRequestRequestTypeDef#

# ListProjectsRequestRequestTypeDef definition

class ListProjectsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListRecipeVersionsRequestRequestTypeDef#

# ListRecipeVersionsRequestRequestTypeDef definition

class ListRecipeVersionsRequestRequestTypeDef(TypedDict):
    Name: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListRecipesRequestRequestTypeDef#

# ListRecipesRequestRequestTypeDef definition

class ListRecipesRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    RecipeVersion: NotRequired[str],

ListRulesetsRequestRequestTypeDef#

# ListRulesetsRequestRequestTypeDef definition

class ListRulesetsRequestRequestTypeDef(TypedDict):
    TargetArn: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

RulesetItemTypeDef#

# RulesetItemTypeDef definition

class RulesetItemTypeDef(TypedDict):
    Name: str,
    TargetArn: str,
    AccountId: NotRequired[str],
    CreatedBy: NotRequired[str],
    CreateDate: NotRequired[datetime],
    Description: NotRequired[str],
    LastModifiedBy: NotRequired[str],
    LastModifiedDate: NotRequired[datetime],
    ResourceArn: NotRequired[str],
    RuleCount: NotRequired[int],
    Tags: NotRequired[Dict[str, str]],

ListSchedulesRequestRequestTypeDef#

# ListSchedulesRequestRequestTypeDef definition

class ListSchedulesRequestRequestTypeDef(TypedDict):
    JobName: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ScheduleTypeDef#

# ScheduleTypeDef definition

class ScheduleTypeDef(TypedDict):
    Name: str,
    AccountId: NotRequired[str],
    CreatedBy: NotRequired[str],
    CreateDate: NotRequired[datetime],
    JobNames: NotRequired[List[str]],
    LastModifiedBy: NotRequired[str],
    LastModifiedDate: NotRequired[datetime],
    ResourceArn: NotRequired[str],
    CronExpression: NotRequired[str],
    Tags: NotRequired[Dict[str, str]],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

PublishRecipeRequestRequestTypeDef#

# PublishRecipeRequestRequestTypeDef definition

class PublishRecipeRequestRequestTypeDef(TypedDict):
    Name: str,
    Description: NotRequired[str],

RecipeActionPaginatorTypeDef#

# RecipeActionPaginatorTypeDef definition

class RecipeActionPaginatorTypeDef(TypedDict):
    Operation: str,
    Parameters: NotRequired[Dict[str, str]],

RecipeActionTypeDef#

# RecipeActionTypeDef definition

class RecipeActionTypeDef(TypedDict):
    Operation: str,
    Parameters: NotRequired[Mapping[str, str]],

ThresholdTypeDef#

# ThresholdTypeDef definition

class ThresholdTypeDef(TypedDict):
    Value: float,
    Type: NotRequired[ThresholdTypeType],  # (1)
    Unit: NotRequired[ThresholdUnitType],  # (2)
  1. See ThresholdTypeType
  2. See ThresholdUnitType

ViewFrameTypeDef#

# ViewFrameTypeDef definition

class ViewFrameTypeDef(TypedDict):
    StartColumnIndex: int,
    ColumnRange: NotRequired[int],
    HiddenColumns: NotRequired[Sequence[str]],
    StartRowIndex: NotRequired[int],
    RowRange: NotRequired[int],
    Analytics: NotRequired[AnalyticsModeType],  # (1)
  1. See AnalyticsModeType

StartJobRunRequestRequestTypeDef#

# StartJobRunRequestRequestTypeDef definition

class StartJobRunRequestRequestTypeDef(TypedDict):
    Name: str,

StartProjectSessionRequestRequestTypeDef#

# StartProjectSessionRequestRequestTypeDef definition

class StartProjectSessionRequestRequestTypeDef(TypedDict):
    Name: str,
    AssumeControl: NotRequired[bool],

StatisticOverrideTypeDef#

# StatisticOverrideTypeDef definition

class StatisticOverrideTypeDef(TypedDict):
    Statistic: str,
    Parameters: Mapping[str, str],

StopJobRunRequestRequestTypeDef#

# StopJobRunRequestRequestTypeDef definition

class StopJobRunRequestRequestTypeDef(TypedDict):
    Name: str,
    RunId: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateScheduleRequestRequestTypeDef#

# UpdateScheduleRequestRequestTypeDef definition

class UpdateScheduleRequestRequestTypeDef(TypedDict):
    CronExpression: str,
    Name: str,
    JobNames: NotRequired[Sequence[str]],

EntityDetectorConfigurationTypeDef#

# EntityDetectorConfigurationTypeDef definition

class EntityDetectorConfigurationTypeDef(TypedDict):
    EntityTypes: Sequence[str],
    AllowedStatistics: NotRequired[Sequence[AllowedStatisticsTypeDef]],  # (1)
  1. See AllowedStatisticsTypeDef

BatchDeleteRecipeVersionResponseTypeDef#

# BatchDeleteRecipeVersionResponseTypeDef definition

class BatchDeleteRecipeVersionResponseTypeDef(TypedDict):
    Name: str,
    Errors: List[RecipeVersionErrorDetailTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RecipeVersionErrorDetailTypeDef
  2. See ResponseMetadataTypeDef

CreateDatasetResponseTypeDef#

# CreateDatasetResponseTypeDef definition

class CreateDatasetResponseTypeDef(TypedDict):
    Name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateProfileJobResponseTypeDef#

# CreateProfileJobResponseTypeDef definition

class CreateProfileJobResponseTypeDef(TypedDict):
    Name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateProjectResponseTypeDef#

# CreateProjectResponseTypeDef definition

class CreateProjectResponseTypeDef(Ty