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,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

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(TypedDict):
    Name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateRecipeJobResponseTypeDef#

# CreateRecipeJobResponseTypeDef definition

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

CreateRecipeResponseTypeDef#

# CreateRecipeResponseTypeDef definition

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

CreateRulesetResponseTypeDef#

# CreateRulesetResponseTypeDef definition

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

CreateScheduleResponseTypeDef#

# CreateScheduleResponseTypeDef definition

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

DeleteDatasetResponseTypeDef#

# DeleteDatasetResponseTypeDef definition

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

DeleteJobResponseTypeDef#

# DeleteJobResponseTypeDef definition

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

DeleteProjectResponseTypeDef#

# DeleteProjectResponseTypeDef definition

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

DeleteRecipeVersionResponseTypeDef#

# DeleteRecipeVersionResponseTypeDef definition

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

DeleteRulesetResponseTypeDef#

# DeleteRulesetResponseTypeDef definition

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

DeleteScheduleResponseTypeDef#

# DeleteScheduleResponseTypeDef definition

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

DescribeScheduleResponseTypeDef#

# DescribeScheduleResponseTypeDef definition

class DescribeScheduleResponseTypeDef(TypedDict):
    CreateDate: datetime,
    CreatedBy: str,
    JobNames: List[str],
    LastModifiedBy: str,
    LastModifiedDate: datetime,
    ResourceArn: str,
    CronExpression: str,
    Tags: Dict[str, str],
    Name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PublishRecipeResponseTypeDef#

# PublishRecipeResponseTypeDef definition

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

SendProjectSessionActionResponseTypeDef#

# SendProjectSessionActionResponseTypeDef definition

class SendProjectSessionActionResponseTypeDef(TypedDict):
    Result: str,
    Name: str,
    ActionId: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartJobRunResponseTypeDef#

# StartJobRunResponseTypeDef definition

class StartJobRunResponseTypeDef(TypedDict):
    RunId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartProjectSessionResponseTypeDef#

# StartProjectSessionResponseTypeDef definition

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

StopJobRunResponseTypeDef#

# StopJobRunResponseTypeDef definition

class StopJobRunResponseTypeDef(TypedDict):
    RunId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateDatasetResponseTypeDef#

# UpdateDatasetResponseTypeDef definition

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

UpdateProfileJobResponseTypeDef#

# UpdateProfileJobResponseTypeDef definition

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

UpdateProjectResponseTypeDef#

# UpdateProjectResponseTypeDef definition

class UpdateProjectResponseTypeDef(TypedDict):
    LastModifiedDate: datetime,
    Name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateRecipeJobResponseTypeDef#

# UpdateRecipeJobResponseTypeDef definition

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

UpdateRecipeResponseTypeDef#

# UpdateRecipeResponseTypeDef definition

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

UpdateRulesetResponseTypeDef#

# UpdateRulesetResponseTypeDef definition

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

UpdateScheduleResponseTypeDef#

# UpdateScheduleResponseTypeDef definition

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

DataCatalogInputDefinitionTypeDef#

# DataCatalogInputDefinitionTypeDef definition

class DataCatalogInputDefinitionTypeDef(TypedDict):
    DatabaseName: str,
    TableName: str,
    CatalogId: NotRequired[str],
    TempDirectory: NotRequired[S3LocationTypeDef],  # (1)
  1. See S3LocationTypeDef

DatabaseInputDefinitionTypeDef#

# DatabaseInputDefinitionTypeDef definition

class DatabaseInputDefinitionTypeDef(TypedDict):
    GlueConnectionName: str,
    DatabaseTableName: NotRequired[str],
    TempDirectory: NotRequired[S3LocationTypeDef],  # (1)
    QueryString: NotRequired[str],
  1. See S3LocationTypeDef

DatabaseTableOutputOptionsTypeDef#

# DatabaseTableOutputOptionsTypeDef definition

class DatabaseTableOutputOptionsTypeDef(TypedDict):
    TableName: str,
    TempDirectory: NotRequired[S3LocationTypeDef],  # (1)
  1. See S3LocationTypeDef

S3TableOutputOptionsTypeDef#

# S3TableOutputOptionsTypeDef definition

class S3TableOutputOptionsTypeDef(TypedDict):
    Location: S3LocationTypeDef,  # (1)
  1. See S3LocationTypeDef

CreateProjectRequestRequestTypeDef#

# CreateProjectRequestRequestTypeDef definition

class CreateProjectRequestRequestTypeDef(TypedDict):
    DatasetName: str,
    Name: str,
    RecipeName: str,
    RoleArn: str,
    Sample: NotRequired[SampleTypeDef],  # (1)
    Tags: NotRequired[Mapping[str, str]],
  1. See SampleTypeDef

DescribeProjectResponseTypeDef#

# DescribeProjectResponseTypeDef definition

class DescribeProjectResponseTypeDef(TypedDict):
    CreateDate: datetime,
    CreatedBy: str,
    DatasetName: str,
    LastModifiedDate: datetime,
    LastModifiedBy: str,
    Name: str,
    RecipeName: str,
    ResourceArn: str,
    Sample: SampleTypeDef,  # (1)
    RoleArn: str,
    Tags: Dict[str, str],
    SessionStatus: SessionStatusType,  # (2)
    OpenedBy: str,
    OpenDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See SampleTypeDef
  2. See SessionStatusType
  3. See ResponseMetadataTypeDef

ProjectTypeDef#

# ProjectTypeDef definition

class ProjectTypeDef(TypedDict):
    Name: str,
    RecipeName: str,
    AccountId: NotRequired[str],
    CreateDate: NotRequired[datetime],
    CreatedBy: NotRequired[str],
    DatasetName: NotRequired[str],
    LastModifiedDate: NotRequired[datetime],
    LastModifiedBy: NotRequired[str],
    ResourceArn: NotRequired[str],
    Sample: NotRequired[SampleTypeDef],  # (1)
    Tags: NotRequired[Dict[str, str]],
    RoleArn: NotRequired[str],
    OpenedBy: NotRequired[str],
    OpenDate: NotRequired[datetime],
  1. See SampleTypeDef

UpdateProjectRequestRequestTypeDef#

# UpdateProjectRequestRequestTypeDef definition

class UpdateProjectRequestRequestTypeDef(TypedDict):
    RoleArn: str,
    Name: str,
    Sample: NotRequired[SampleTypeDef],  # (1)
  1. See SampleTypeDef

OutputFormatOptionsTypeDef#

# OutputFormatOptionsTypeDef definition

class OutputFormatOptionsTypeDef(TypedDict):
    Csv: NotRequired[CsvOutputOptionsTypeDef],  # (1)
  1. See CsvOutputOptionsTypeDef

DatasetParameterPaginatorTypeDef#

# DatasetParameterPaginatorTypeDef definition

class DatasetParameterPaginatorTypeDef(TypedDict):
    Name: str,
    Type: ParameterTypeType,  # (1)
    DatetimeOptions: NotRequired[DatetimeOptionsTypeDef],  # (2)
    CreateColumn: NotRequired[bool],
    Filter: NotRequired[FilterExpressionPaginatorTypeDef],  # (3)
  1. See ParameterTypeType
  2. See DatetimeOptionsTypeDef
  3. See FilterExpressionPaginatorTypeDef

DatasetParameterTypeDef#

# DatasetParameterTypeDef definition

class DatasetParameterTypeDef(TypedDict):
    Name: str,
    Type: ParameterTypeType,  # (1)
    DatetimeOptions: NotRequired[DatetimeOptionsTypeDef],  # (2)
    CreateColumn: NotRequired[bool],
    Filter: NotRequired[FilterExpressionTypeDef],  # (3)
  1. See ParameterTypeType
  2. See DatetimeOptionsTypeDef
  3. See FilterExpressionTypeDef

FormatOptionsPaginatorTypeDef#

# FormatOptionsPaginatorTypeDef definition

class FormatOptionsPaginatorTypeDef(TypedDict):
    Json: NotRequired[JsonOptionsTypeDef],  # (1)
    Excel: NotRequired[ExcelOptionsPaginatorTypeDef],  # (2)
    Csv: NotRequired[CsvOptionsTypeDef],  # (3)
  1. See JsonOptionsTypeDef
  2. See ExcelOptionsPaginatorTypeDef
  3. See CsvOptionsTypeDef

FormatOptionsTypeDef#

# FormatOptionsTypeDef definition

class FormatOptionsTypeDef(TypedDict):
    Json: NotRequired[JsonOptionsTypeDef],  # (1)
    Excel: NotRequired[ExcelOptionsTypeDef],  # (2)
    Csv: NotRequired[CsvOptionsTypeDef],  # (3)
  1. See JsonOptionsTypeDef
  2. See ExcelOptionsTypeDef
  3. See CsvOptionsTypeDef

ListDatasetsRequestListDatasetsPaginateTypeDef#

# ListDatasetsRequestListDatasetsPaginateTypeDef definition

class ListDatasetsRequestListDatasetsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListJobRunsRequestListJobRunsPaginateTypeDef#

# ListJobRunsRequestListJobRunsPaginateTypeDef definition

class ListJobRunsRequestListJobRunsPaginateTypeDef(TypedDict):
    Name: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListJobsRequestListJobsPaginateTypeDef#

# ListJobsRequestListJobsPaginateTypeDef definition

class ListJobsRequestListJobsPaginateTypeDef(TypedDict):
    DatasetName: NotRequired[str],
    ProjectName: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListProjectsRequestListProjectsPaginateTypeDef#

# ListProjectsRequestListProjectsPaginateTypeDef definition

class ListProjectsRequestListProjectsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListRecipeVersionsRequestListRecipeVersionsPaginateTypeDef#

# ListRecipeVersionsRequestListRecipeVersionsPaginateTypeDef definition

class ListRecipeVersionsRequestListRecipeVersionsPaginateTypeDef(TypedDict):
    Name: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListRecipesRequestListRecipesPaginateTypeDef#

# ListRecipesRequestListRecipesPaginateTypeDef definition

class ListRecipesRequestListRecipesPaginateTypeDef(TypedDict):
    RecipeVersion: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListRulesetsRequestListRulesetsPaginateTypeDef#

# ListRulesetsRequestListRulesetsPaginateTypeDef definition

class ListRulesetsRequestListRulesetsPaginateTypeDef(TypedDict):
    TargetArn: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListSchedulesRequestListSchedulesPaginateTypeDef#

# ListSchedulesRequestListSchedulesPaginateTypeDef definition

class ListSchedulesRequestListSchedulesPaginateTypeDef(TypedDict):
    JobName: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListRulesetsResponseTypeDef#

# ListRulesetsResponseTypeDef definition

class ListRulesetsResponseTypeDef(TypedDict):
    Rulesets: List[RulesetItemTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RulesetItemTypeDef
  2. See ResponseMetadataTypeDef

ListSchedulesResponseTypeDef#

# ListSchedulesResponseTypeDef definition

class ListSchedulesResponseTypeDef(TypedDict):
    Schedules: List[ScheduleTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScheduleTypeDef
  2. See ResponseMetadataTypeDef

RecipeStepPaginatorTypeDef#

# RecipeStepPaginatorTypeDef definition

class RecipeStepPaginatorTypeDef(TypedDict):
    Action: RecipeActionPaginatorTypeDef,  # (1)
    ConditionExpressions: NotRequired[List[ConditionExpressionTypeDef]],  # (2)
  1. See RecipeActionPaginatorTypeDef
  2. See ConditionExpressionTypeDef

RecipeStepTypeDef#

# RecipeStepTypeDef definition

class RecipeStepTypeDef(TypedDict):
    Action: RecipeActionTypeDef,  # (1)
    ConditionExpressions: NotRequired[Sequence[ConditionExpressionTypeDef]],  # (2)
  1. See RecipeActionTypeDef
  2. See ConditionExpressionTypeDef

RuleTypeDef#

# RuleTypeDef definition

class RuleTypeDef(TypedDict):
    Name: str,
    CheckExpression: str,
    Disabled: NotRequired[bool],
    SubstitutionMap: NotRequired[Mapping[str, str]],
    Threshold: NotRequired[ThresholdTypeDef],  # (1)
    ColumnSelectors: NotRequired[Sequence[ColumnSelectorTypeDef]],  # (2)
  1. See ThresholdTypeDef
  2. See ColumnSelectorTypeDef

StatisticsConfigurationTypeDef#

# StatisticsConfigurationTypeDef definition

class StatisticsConfigurationTypeDef(TypedDict):
    IncludedStatistics: NotRequired[Sequence[str]],
    Overrides: NotRequired[Sequence[StatisticOverrideTypeDef]],  # (1)
  1. See StatisticOverrideTypeDef

InputTypeDef#

# InputTypeDef definition

class InputTypeDef(TypedDict):
    S3InputDefinition: NotRequired[S3LocationTypeDef],  # (1)
    DataCatalogInputDefinition: NotRequired[DataCatalogInputDefinitionTypeDef],  # (2)
    DatabaseInputDefinition: NotRequired[DatabaseInputDefinitionTypeDef],  # (3)
    Metadata: NotRequired[MetadataTypeDef],  # (4)
  1. See S3LocationTypeDef
  2. See DataCatalogInputDefinitionTypeDef
  3. See DatabaseInputDefinitionTypeDef
  4. See MetadataTypeDef

DatabaseOutputTypeDef#

# DatabaseOutputTypeDef definition

class DatabaseOutputTypeDef(TypedDict):
    GlueConnectionName: str,
    DatabaseOptions: DatabaseTableOutputOptionsTypeDef,  # (1)
    DatabaseOutputMode: NotRequired[DatabaseOutputModeType],  # (2)
  1. See DatabaseTableOutputOptionsTypeDef
  2. See DatabaseOutputModeType

DataCatalogOutputTypeDef#

# DataCatalogOutputTypeDef definition

class DataCatalogOutputTypeDef(TypedDict):
    DatabaseName: str,
    TableName: str,
    CatalogId: NotRequired[str],
    S3Options: NotRequired[S3TableOutputOptionsTypeDef],  # (1)
    DatabaseOptions: NotRequired[DatabaseTableOutputOptionsTypeDef],  # (2)
    Overwrite: NotRequired[bool],
  1. See S3TableOutputOptionsTypeDef
  2. See DatabaseTableOutputOptionsTypeDef

ListProjectsResponseTypeDef#

# ListProjectsResponseTypeDef definition

class ListProjectsResponseTypeDef(TypedDict):
    Projects: List[ProjectTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProjectTypeDef
  2. See ResponseMetadataTypeDef

OutputPaginatorTypeDef#

# OutputPaginatorTypeDef definition

class OutputPaginatorTypeDef(TypedDict):
    Location: S3LocationTypeDef,  # (3)
    CompressionFormat: NotRequired[CompressionFormatType],  # (1)
    Format: NotRequired[OutputFormatType],  # (2)
    PartitionColumns: NotRequired[List[str]],
    Overwrite: NotRequired[bool],
    FormatOptions: NotRequired[OutputFormatOptionsTypeDef],  # (4)
    MaxOutputFiles: NotRequired[int],
  1. See CompressionFormatType
  2. See OutputFormatType
  3. See S3LocationTypeDef
  4. See OutputFormatOptionsTypeDef

OutputTypeDef#

# OutputTypeDef definition

class OutputTypeDef(TypedDict):
    Location: S3LocationTypeDef,  # (3)
    CompressionFormat: NotRequired[CompressionFormatType],  # (1)
    Format: NotRequired[OutputFormatType],  # (2)
    PartitionColumns: NotRequired[Sequence[str]],
    Overwrite: NotRequired[bool],
    FormatOptions: NotRequired[OutputFormatOptionsTypeDef],  # (4)
    MaxOutputFiles: NotRequired[int],
  1. See CompressionFormatType
  2. See OutputFormatType
  3. See S3LocationTypeDef
  4. See OutputFormatOptionsTypeDef

PathOptionsPaginatorTypeDef#

# PathOptionsPaginatorTypeDef definition

class PathOptionsPaginatorTypeDef(TypedDict):
    LastModifiedDateCondition: NotRequired[FilterExpressionPaginatorTypeDef],  # (1)
    FilesLimit: NotRequired[FilesLimitTypeDef],  # (2)
    Parameters: NotRequired[Dict[str, DatasetParameterPaginatorTypeDef]],  # (3)
  1. See FilterExpressionPaginatorTypeDef
  2. See FilesLimitTypeDef
  3. See DatasetParameterPaginatorTypeDef

PathOptionsTypeDef#

# PathOptionsTypeDef definition

class PathOptionsTypeDef(TypedDict):
    LastModifiedDateCondition: NotRequired[FilterExpressionTypeDef],  # (1)
    FilesLimit: NotRequired[FilesLimitTypeDef],  # (2)
    Parameters: NotRequired[Mapping[str, DatasetParameterTypeDef]],  # (3)
  1. See FilterExpressionTypeDef
  2. See FilesLimitTypeDef
  3. See DatasetParameterTypeDef

RecipePaginatorTypeDef#

# RecipePaginatorTypeDef definition

class RecipePaginatorTypeDef(TypedDict):
    Name: str,
    CreatedBy: NotRequired[str],
    CreateDate: NotRequired[datetime],
    LastModifiedBy: NotRequired[str],
    LastModifiedDate: NotRequired[datetime],
    ProjectName: NotRequired[str],
    PublishedBy: NotRequired[str],
    PublishedDate: NotRequired[datetime],
    Description: NotRequired[str],
    ResourceArn: NotRequired[str],
    Steps: NotRequired[List[RecipeStepPaginatorTypeDef]],  # (1)
    Tags: NotRequired[Dict[str, str]],
    RecipeVersion: NotRequired[str],
  1. See RecipeStepPaginatorTypeDef

CreateRecipeRequestRequestTypeDef#

# CreateRecipeRequestRequestTypeDef definition

class CreateRecipeRequestRequestTypeDef(TypedDict):
    Name: str,
    Steps: Sequence[RecipeStepTypeDef],  # (1)
    Description: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
  1. See RecipeStepTypeDef

DescribeRecipeResponseTypeDef#

# DescribeRecipeResponseTypeDef definition

class DescribeRecipeResponseTypeDef(TypedDict):
    CreatedBy: str,
    CreateDate: datetime,
    LastModifiedBy: str,
    LastModifiedDate: datetime,
    ProjectName: str,
    PublishedBy: str,
    PublishedDate: datetime,
    Description: str,
    Name: str,
    Steps: List[RecipeStepTypeDef],  # (1)
    Tags: Dict[str, str],
    ResourceArn: str,
    RecipeVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RecipeStepTypeDef
  2. See ResponseMetadataTypeDef

RecipeTypeDef#

# RecipeTypeDef definition

class RecipeTypeDef(TypedDict):
    Name: str,
    CreatedBy: NotRequired[str],
    CreateDate: NotRequired[datetime],
    LastModifiedBy: NotRequired[str],
    LastModifiedDate: NotRequired[datetime],
    ProjectName: NotRequired[str],
    PublishedBy: NotRequired[str],
    PublishedDate: NotRequired[datetime],
    Description: NotRequired[str],
    ResourceArn: NotRequired[str],
    Steps: NotRequired[List[RecipeStepTypeDef]],  # (1)
    Tags: NotRequired[Dict[str, str]],
    RecipeVersion: NotRequired[str],
  1. See RecipeStepTypeDef

SendProjectSessionActionRequestRequestTypeDef#

# SendProjectSessionActionRequestRequestTypeDef definition

class SendProjectSessionActionRequestRequestTypeDef(TypedDict):
    Name: str,
    Preview: NotRequired[bool],
    RecipeStep: NotRequired[RecipeStepTypeDef],  # (1)
    StepIndex: NotRequired[int],
    ClientSessionId: NotRequired[str],
    ViewFrame: NotRequired[ViewFrameTypeDef],  # (2)
  1. See RecipeStepTypeDef
  2. See ViewFrameTypeDef

UpdateRecipeRequestRequestTypeDef#

# UpdateRecipeRequestRequestTypeDef definition

class UpdateRecipeRequestRequestTypeDef(TypedDict):
    Name: str,
    Description: NotRequired[str],
    Steps: NotRequired[Sequence[RecipeStepTypeDef]],  # (1)
  1. See RecipeStepTypeDef

CreateRulesetRequestRequestTypeDef#

# CreateRulesetRequestRequestTypeDef definition

class CreateRulesetRequestRequestTypeDef(TypedDict):
    Name: str,
    TargetArn: str,
    Rules: Sequence[RuleTypeDef],  # (1)
    Description: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
  1. See RuleTypeDef

DescribeRulesetResponseTypeDef#

# DescribeRulesetResponseTypeDef definition

class DescribeRulesetResponseTypeDef(TypedDict):
    Name: str,
    Description: str,
    TargetArn: str,
    Rules: List[RuleTypeDef],  # (1)
    CreateDate: datetime,
    CreatedBy: str,
    LastModifiedBy: str,
    LastModifiedDate: datetime,
    ResourceArn: str,
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RuleTypeDef
  2. See ResponseMetadataTypeDef

UpdateRulesetRequestRequestTypeDef#

# UpdateRulesetRequestRequestTypeDef definition

class UpdateRulesetRequestRequestTypeDef(TypedDict):
    Name: str,
    Rules: Sequence[RuleTypeDef],  # (1)
    Description: NotRequired[str],
  1. See RuleTypeDef

ColumnStatisticsConfigurationTypeDef#

# ColumnStatisticsConfigurationTypeDef definition

class ColumnStatisticsConfigurationTypeDef(TypedDict):
    Statistics: StatisticsConfigurationTypeDef,  # (2)
    Selectors: NotRequired[Sequence[ColumnSelectorTypeDef]],  # (1)
  1. See ColumnSelectorTypeDef
  2. See StatisticsConfigurationTypeDef

JobPaginatorTypeDef#

# JobPaginatorTypeDef definition

class JobPaginatorTypeDef(TypedDict):
    Name: str,
    AccountId: NotRequired[str],
    CreatedBy: NotRequired[str],
    CreateDate: NotRequired[datetime],
    DatasetName: NotRequired[str],
    EncryptionKeyArn: NotRequired[str],
    EncryptionMode: NotRequired[EncryptionModeType],  # (1)
    Type: NotRequired[JobTypeType],  # (2)
    LastModifiedBy: NotRequired[str],
    LastModifiedDate: NotRequired[datetime],
    LogSubscription: NotRequired[LogSubscriptionType],  # (3)
    MaxCapacity: NotRequired[int],
    MaxRetries: NotRequired[int],
    Outputs: NotRequired[List[OutputPaginatorTypeDef]],  # (4)
    DataCatalogOutputs: NotRequired[List[DataCatalogOutputTypeDef]],  # (5)
    DatabaseOutputs: NotRequired[List[DatabaseOutputTypeDef]],  # (6)
    ProjectName: NotRequired[str],
    RecipeReference: NotRequired[RecipeReferenceTypeDef],  # (7)
    ResourceArn: NotRequired[str],
    RoleArn: NotRequired[str],
    Timeout: NotRequired[int],
    Tags: NotRequired[Dict[str, str]],
    JobSample: NotRequired[JobSampleTypeDef],  # (8)
    ValidationConfigurations: NotRequired[List[ValidationConfigurationTypeDef]],  # (9)
  1. See EncryptionModeType
  2. See JobTypeType
  3. See LogSubscriptionType
  4. See OutputPaginatorTypeDef
  5. See DataCatalogOutputTypeDef
  6. See DatabaseOutputTypeDef
  7. See RecipeReferenceTypeDef
  8. See JobSampleTypeDef
  9. See ValidationConfigurationTypeDef

JobRunPaginatorTypeDef#

# JobRunPaginatorTypeDef definition

class JobRunPaginatorTypeDef(TypedDict):
    Attempt: NotRequired[int],
    CompletedOn: NotRequired[datetime],
    DatasetName: NotRequired[str],
    ErrorMessage: NotRequired[str],
    ExecutionTime: NotRequired[int],
    JobName: NotRequired[str],
    RunId: NotRequired[str],
    State: NotRequired[JobRunStateType],  # (1)
    LogSubscription: NotRequired[LogSubscriptionType],  # (2)
    LogGroupName: NotRequired[str],
    Outputs: NotRequired[List[OutputPaginatorTypeDef]],  # (3)
    DataCatalogOutputs: NotRequired[List[DataCatalogOutputTypeDef]],  # (4)
    DatabaseOutputs: NotRequired[List[DatabaseOutputTypeDef]],  # (5)
    RecipeReference: NotRequired[RecipeReferenceTypeDef],  # (6)
    StartedBy: NotRequired[str],
    StartedOn: NotRequired[datetime],
    JobSample: NotRequired[JobSampleTypeDef],  # (7)
    ValidationConfigurations: NotRequired[List[ValidationConfigurationTypeDef]],  # (8)
  1. See JobRunStateType
  2. See LogSubscriptionType
  3. See OutputPaginatorTypeDef
  4. See DataCatalogOutputTypeDef
  5. See DatabaseOutputTypeDef
  6. See RecipeReferenceTypeDef
  7. See JobSampleTypeDef
  8. See ValidationConfigurationTypeDef

CreateRecipeJobRequestRequestTypeDef#

# CreateRecipeJobRequestRequestTypeDef definition

class CreateRecipeJobRequestRequestTypeDef(TypedDict):
    Name: str,
    RoleArn: str,
    DatasetName: NotRequired[str],
    EncryptionKeyArn: NotRequired[str],
    EncryptionMode: NotRequired[EncryptionModeType],  # (1)
    LogSubscription: NotRequired[LogSubscriptionType],  # (2)
    MaxCapacity: NotRequired[int],
    MaxRetries: NotRequired[int],
    Outputs: NotRequired[Sequence[OutputTypeDef]],  # (3)
    DataCatalogOutputs: NotRequired[Sequence[DataCatalogOutputTypeDef]],  # (4)
    DatabaseOutputs: NotRequired[Sequence[DatabaseOutputTypeDef]],  # (5)
    ProjectName: NotRequired[str],
    RecipeReference: NotRequired[RecipeReferenceTypeDef],  # (6)
    Tags: NotRequired[Mapping[str, str]],
    Timeout: NotRequired[int],
  1. See EncryptionModeType
  2. See LogSubscriptionType
  3. See OutputTypeDef
  4. See DataCatalogOutputTypeDef
  5. See DatabaseOutputTypeDef
  6. See RecipeReferenceTypeDef

JobRunTypeDef#

# JobRunTypeDef definition

class JobRunTypeDef(TypedDict):
    Attempt: NotRequired[int],
    CompletedOn: NotRequired[datetime],
    DatasetName: NotRequired[str],
    ErrorMessage: NotRequired[str],
    ExecutionTime: NotRequired[int],
    JobName: NotRequired[str],
    RunId: NotRequired[str],
    State: NotRequired[JobRunStateType],  # (1)
    LogSubscription: NotRequired[LogSubscriptionType],  # (2)
    LogGroupName: NotRequired[str],
    Outputs: NotRequired[List[OutputTypeDef]],  # (3)
    DataCatalogOutputs: NotRequired[List[DataCatalogOutputTypeDef]],  # (4)
    DatabaseOutputs: NotRequired[List[DatabaseOutputTypeDef]],  # (5)
    RecipeReference: NotRequired[RecipeReferenceTypeDef],  # (6)
    StartedBy: NotRequired[str],
    StartedOn: NotRequired[datetime],
    JobSample: NotRequired[JobSampleTypeDef],  # (7)
    ValidationConfigurations: NotRequired[List[ValidationConfigurationTypeDef]],  # (8)
  1. See JobRunStateType
  2. See LogSubscriptionType
  3. See OutputTypeDef
  4. See DataCatalogOutputTypeDef
  5. See DatabaseOutputTypeDef
  6. See RecipeReferenceTypeDef
  7. See JobSampleTypeDef
  8. See ValidationConfigurationTypeDef

JobTypeDef#

# JobTypeDef definition

class JobTypeDef(TypedDict):
    Name: str,
    AccountId: NotRequired[str],
    CreatedBy: NotRequired[str],
    CreateDate: NotRequired[datetime],
    DatasetName: NotRequired[str],
    EncryptionKeyArn: NotRequired[str],
    EncryptionMode: NotRequired[EncryptionModeType],  # (1)
    Type: NotRequired[JobTypeType],  # (2)
    LastModifiedBy: NotRequired[str],
    LastModifiedDate: NotRequired[datetime],
    LogSubscription: NotRequired[LogSubscriptionType],  # (3)
    MaxCapacity: NotRequired[int],
    MaxRetries: NotRequired[int],
    Outputs: NotRequired[List[OutputTypeDef]],  # (4)
    DataCatalogOutputs: NotRequired[List[DataCatalogOutputTypeDef]],  # (5)
    DatabaseOutputs: NotRequired[List[DatabaseOutputTypeDef]],  # (6)
    ProjectName: NotRequired[str],
    RecipeReference: NotRequired[RecipeReferenceTypeDef],  # (7)
    ResourceArn: NotRequired[str],
    RoleArn: NotRequired[str],
    Timeout: NotRequired[int],
    Tags: NotRequired[Dict[str, str]],
    JobSample: NotRequired[JobSampleTypeDef],  # (8)
    ValidationConfigurations: NotRequired[List[ValidationConfigurationTypeDef]],  # (9)
  1. See EncryptionModeType
  2. See JobTypeType
  3. See LogSubscriptionType
  4. See OutputTypeDef
  5. See DataCatalogOutputTypeDef
  6. See DatabaseOutputTypeDef
  7. See RecipeReferenceTypeDef
  8. See JobSampleTypeDef
  9. See ValidationConfigurationTypeDef

UpdateRecipeJobRequestRequestTypeDef#

# UpdateRecipeJobRequestRequestTypeDef definition

class UpdateRecipeJobRequestRequestTypeDef(TypedDict):
    Name: str,
    RoleArn: str,
    EncryptionKeyArn: NotRequired[str],
    EncryptionMode: NotRequired[EncryptionModeType],  # (1)
    LogSubscription: NotRequired[LogSubscriptionType],  # (2)
    MaxCapacity: NotRequired[int],
    MaxRetries: NotRequired[int],
    Outputs: NotRequired[Sequence[OutputTypeDef]],  # (3)
    DataCatalogOutputs: NotRequired[Sequence[DataCatalogOutputTypeDef]],  # (4)
    DatabaseOutputs: NotRequired[Sequence[DatabaseOutputTypeDef]],  # (5)
    Timeout: NotRequired[int],
  1. See EncryptionModeType
  2. See LogSubscriptionType
  3. See OutputTypeDef
  4. See DataCatalogOutputTypeDef
  5. See DatabaseOutputTypeDef

DatasetPaginatorTypeDef#

# DatasetPaginatorTypeDef definition

class DatasetPaginatorTypeDef(TypedDict):
    Name: str,
    Input: InputTypeDef,  # (3)
    AccountId: NotRequired[str],
    CreatedBy: NotRequired[str],
    CreateDate: NotRequired[datetime],
    Format: NotRequired[InputFormatType],  # (1)
    FormatOptions: NotRequired[FormatOptionsPaginatorTypeDef],  # (2)
    LastModifiedDate: NotRequired[datetime],
    LastModifiedBy: NotRequired[str],
    Source: NotRequired[SourceType],  # (4)
    PathOptions: NotRequired[PathOptionsPaginatorTypeDef],  # (5)
    Tags: NotRequired[Dict[str, str]],
    ResourceArn: NotRequired[str],
  1. See InputFormatType
  2. See FormatOptionsPaginatorTypeDef
  3. See InputTypeDef
  4. See SourceType
  5. See PathOptionsPaginatorTypeDef

CreateDatasetRequestRequestTypeDef#

# CreateDatasetRequestRequestTypeDef definition

class CreateDatasetRequestRequestTypeDef(TypedDict):
    Name: str,
    Input: InputTypeDef,  # (1)
    Format: NotRequired[InputFormatType],  # (2)
    FormatOptions: NotRequired[FormatOptionsTypeDef],  # (3)
    PathOptions: NotRequired[PathOptionsTypeDef],  # (4)
    Tags: NotRequired[Mapping[str, str]],
  1. See InputTypeDef
  2. See InputFormatType
  3. See FormatOptionsTypeDef
  4. See PathOptionsTypeDef

DatasetTypeDef#

# DatasetTypeDef definition

class DatasetTypeDef(TypedDict):
    Name: str,
    Input: InputTypeDef,  # (3)
    AccountId: NotRequired[str],
    CreatedBy: NotRequired[str],
    CreateDate: NotRequired[datetime],
    Format: NotRequired[InputFormatType],  # (1)
    FormatOptions: NotRequired[FormatOptionsTypeDef],  # (2)
    LastModifiedDate: NotRequired[datetime],
    LastModifiedBy: NotRequired[str],
    Source: NotRequired[SourceType],  # (4)
    PathOptions: NotRequired[PathOptionsTypeDef],  # (5)
    Tags: NotRequired[Dict[str, str]],
    ResourceArn: NotRequired[str],
  1. See InputFormatType
  2. See FormatOptionsTypeDef
  3. See InputTypeDef
  4. See SourceType
  5. See PathOptionsTypeDef

DescribeDatasetResponseTypeDef#

# DescribeDatasetResponseTypeDef definition

class DescribeDatasetResponseTypeDef(TypedDict):
    CreatedBy: str,
    CreateDate: datetime,
    Name: str,
    Format: InputFormatType,  # (1)
    FormatOptions: FormatOptionsTypeDef,  # (2)
    Input: InputTypeDef,  # (3)
    LastModifiedDate: datetime,
    LastModifiedBy: str,
    Source: SourceType,  # (4)
    PathOptions: PathOptionsTypeDef,  # (5)
    Tags: Dict[str, str],
    ResourceArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See InputFormatType
  2. See FormatOptionsTypeDef
  3. See InputTypeDef
  4. See SourceType
  5. See PathOptionsTypeDef
  6. See ResponseMetadataTypeDef

UpdateDatasetRequestRequestTypeDef#

# UpdateDatasetRequestRequestTypeDef definition

class UpdateDatasetRequestRequestTypeDef(TypedDict):
    Name: str,
    Input: InputTypeDef,  # (1)
    Format: NotRequired[InputFormatType],  # (2)
    FormatOptions: NotRequired[FormatOptionsTypeDef],  # (3)
    PathOptions: NotRequired[PathOptionsTypeDef],  # (4)
  1. See InputTypeDef
  2. See InputFormatType
  3. See FormatOptionsTypeDef
  4. See PathOptionsTypeDef

ListRecipeVersionsResponsePaginatorTypeDef#

# ListRecipeVersionsResponsePaginatorTypeDef definition

class ListRecipeVersionsResponsePaginatorTypeDef(TypedDict):
    NextToken: str,
    Recipes: List[RecipePaginatorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RecipePaginatorTypeDef
  2. See ResponseMetadataTypeDef

ListRecipesResponsePaginatorTypeDef#

# ListRecipesResponsePaginatorTypeDef definition

class ListRecipesResponsePaginatorTypeDef(TypedDict):
    Recipes: List[RecipePaginatorTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RecipePaginatorTypeDef
  2. See ResponseMetadataTypeDef

ListRecipeVersionsResponseTypeDef#

# ListRecipeVersionsResponseTypeDef definition

class ListRecipeVersionsResponseTypeDef(TypedDict):
    NextToken: str,
    Recipes: List[RecipeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RecipeTypeDef
  2. See ResponseMetadataTypeDef

ListRecipesResponseTypeDef#

# ListRecipesResponseTypeDef definition

class ListRecipesResponseTypeDef(TypedDict):
    Recipes: List[RecipeTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RecipeTypeDef
  2. See ResponseMetadataTypeDef

ProfileConfigurationTypeDef#

# ProfileConfigurationTypeDef definition

class ProfileConfigurationTypeDef(TypedDict):
    DatasetStatisticsConfiguration: NotRequired[StatisticsConfigurationTypeDef],  # (1)
    ProfileColumns: NotRequired[Sequence[ColumnSelectorTypeDef]],  # (2)
    ColumnStatisticsConfigurations: NotRequired[Sequence[ColumnStatisticsConfigurationTypeDef]],  # (3)
    EntityDetectorConfiguration: NotRequired[EntityDetectorConfigurationTypeDef],  # (4)
  1. See StatisticsConfigurationTypeDef
  2. See ColumnSelectorTypeDef
  3. See ColumnStatisticsConfigurationTypeDef
  4. See EntityDetectorConfigurationTypeDef

ListJobsResponsePaginatorTypeDef#

# ListJobsResponsePaginatorTypeDef definition

class ListJobsResponsePaginatorTypeDef(TypedDict):
    Jobs: List[JobPaginatorTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobPaginatorTypeDef
  2. See ResponseMetadataTypeDef

ListJobRunsResponsePaginatorTypeDef#

# ListJobRunsResponsePaginatorTypeDef definition

class ListJobRunsResponsePaginatorTypeDef(TypedDict):
    JobRuns: List[JobRunPaginatorTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobRunPaginatorTypeDef
  2. See ResponseMetadataTypeDef

ListJobRunsResponseTypeDef#

# ListJobRunsResponseTypeDef definition

class ListJobRunsResponseTypeDef(TypedDict):
    JobRuns: List[JobRunTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobRunTypeDef
  2. See ResponseMetadataTypeDef

ListJobsResponseTypeDef#

# ListJobsResponseTypeDef definition

class ListJobsResponseTypeDef(TypedDict):
    Jobs: List[JobTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobTypeDef
  2. See ResponseMetadataTypeDef

ListDatasetsResponsePaginatorTypeDef#

# ListDatasetsResponsePaginatorTypeDef definition

class ListDatasetsResponsePaginatorTypeDef(TypedDict):
    Datasets: List[DatasetPaginatorTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatasetPaginatorTypeDef
  2. See ResponseMetadataTypeDef

ListDatasetsResponseTypeDef#

# ListDatasetsResponseTypeDef definition

class ListDatasetsResponseTypeDef(TypedDict):
    Datasets: List[DatasetTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatasetTypeDef
  2. See ResponseMetadataTypeDef

CreateProfileJobRequestRequestTypeDef#

# CreateProfileJobRequestRequestTypeDef definition

class CreateProfileJobRequestRequestTypeDef(TypedDict):
    DatasetName: str,
    Name: str,
    OutputLocation: S3LocationTypeDef,  # (1)
    RoleArn: str,
    EncryptionKeyArn: NotRequired[str],
    EncryptionMode: NotRequired[EncryptionModeType],  # (2)
    LogSubscription: NotRequired[LogSubscriptionType],  # (3)
    MaxCapacity: NotRequired[int],
    MaxRetries: NotRequired[int],
    Configuration: NotRequired[ProfileConfigurationTypeDef],  # (4)
    ValidationConfigurations: NotRequired[Sequence[ValidationConfigurationTypeDef]],  # (5)
    Tags: NotRequired[Mapping[str, str]],
    Timeout: NotRequired[int],
    JobSample: NotRequired[JobSampleTypeDef],  # (6)
  1. See S3LocationTypeDef
  2. See EncryptionModeType
  3. See LogSubscriptionType
  4. See ProfileConfigurationTypeDef
  5. See ValidationConfigurationTypeDef
  6. See JobSampleTypeDef

DescribeJobResponseTypeDef#

# DescribeJobResponseTypeDef definition

class DescribeJobResponseTypeDef(TypedDict):
    CreateDate: datetime,
    CreatedBy: str,
    DatasetName: str,
    EncryptionKeyArn: str,
    EncryptionMode: EncryptionModeType,  # (1)
    Name: str,
    Type: JobTypeType,  # (2)
    LastModifiedBy: str,
    LastModifiedDate: datetime,
    LogSubscription: LogSubscriptionType,  # (3)
    MaxCapacity: int,
    MaxRetries: int,
    Outputs: List[OutputTypeDef],  # (4)
    DataCatalogOutputs: List[DataCatalogOutputTypeDef],  # (5)
    DatabaseOutputs: List[DatabaseOutputTypeDef],  # (6)
    ProjectName: str,
    ProfileConfiguration: ProfileConfigurationTypeDef,  # (7)
    ValidationConfigurations: List[ValidationConfigurationTypeDef],  # (8)
    RecipeReference: RecipeReferenceTypeDef,  # (9)
    ResourceArn: str,
    RoleArn: str,
    Tags: Dict[str, str],
    Timeout: int,
    JobSample: JobSampleTypeDef,  # (10)
    ResponseMetadata: ResponseMetadataTypeDef,  # (11)
  1. See EncryptionModeType
  2. See JobTypeType
  3. See LogSubscriptionType
  4. See OutputTypeDef
  5. See DataCatalogOutputTypeDef
  6. See DatabaseOutputTypeDef
  7. See ProfileConfigurationTypeDef
  8. See ValidationConfigurationTypeDef
  9. See RecipeReferenceTypeDef
  10. See JobSampleTypeDef
  11. See ResponseMetadataTypeDef

DescribeJobRunResponseTypeDef#

# DescribeJobRunResponseTypeDef definition

class DescribeJobRunResponseTypeDef(TypedDict):
    Attempt: int,
    CompletedOn: datetime,
    DatasetName: str,
    ErrorMessage: str,
    ExecutionTime: int,
    JobName: str,
    ProfileConfiguration: ProfileConfigurationTypeDef,  # (1)
    ValidationConfigurations: List[ValidationConfigurationTypeDef],  # (2)
    RunId: str,
    State: JobRunStateType,  # (3)
    LogSubscription: LogSubscriptionType,  # (4)
    LogGroupName: str,
    Outputs: List[OutputTypeDef],  # (5)
    DataCatalogOutputs: List[DataCatalogOutputTypeDef],  # (6)
    DatabaseOutputs: List[DatabaseOutputTypeDef],  # (7)
    RecipeReference: RecipeReferenceTypeDef,  # (8)
    StartedBy: str,
    StartedOn: datetime,
    JobSample: JobSampleTypeDef,  # (9)
    ResponseMetadata: ResponseMetadataTypeDef,  # (10)
  1. See ProfileConfigurationTypeDef
  2. See ValidationConfigurationTypeDef
  3. See JobRunStateType
  4. See LogSubscriptionType
  5. See OutputTypeDef
  6. See DataCatalogOutputTypeDef
  7. See DatabaseOutputTypeDef
  8. See RecipeReferenceTypeDef
  9. See JobSampleTypeDef
  10. See ResponseMetadataTypeDef

UpdateProfileJobRequestRequestTypeDef#

# UpdateProfileJobRequestRequestTypeDef definition

class UpdateProfileJobRequestRequestTypeDef(TypedDict):
    Name: str,
    OutputLocation: S3LocationTypeDef,  # (1)
    RoleArn: str,
    Configuration: NotRequired[ProfileConfigurationTypeDef],  # (2)
    EncryptionKeyArn: NotRequired[str],
    EncryptionMode: NotRequired[EncryptionModeType],  # (3)
    LogSubscription: NotRequired[LogSubscriptionType],  # (4)
    MaxCapacity: NotRequired[int],
    MaxRetries: NotRequired[int],
    ValidationConfigurations: NotRequired[Sequence[ValidationConfigurationTypeDef]],  # (5)
    Timeout: NotRequired[int],
    JobSample: NotRequired[JobSampleTypeDef],  # (6)
  1. See S3LocationTypeDef
  2. See ProfileConfigurationTypeDef
  3. See EncryptionModeType
  4. See LogSubscriptionType
  5. See ValidationConfigurationTypeDef
  6. See JobSampleTypeDef