Skip to content

Type definitions#

Index > GlueDataBrew > Type definitions

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

AllowedStatisticsUnionTypeDef#

# AllowedStatisticsUnionTypeDef definition

AllowedStatisticsUnionTypeDef = Union[
    AllowedStatisticsTypeDef,  # (1)
    AllowedStatisticsOutputTypeDef,  # (2)
]
  1. See AllowedStatisticsTypeDef
  2. See AllowedStatisticsOutputTypeDef

ExcelOptionsUnionTypeDef#

# ExcelOptionsUnionTypeDef definition

ExcelOptionsUnionTypeDef = Union[
    ExcelOptionsTypeDef,  # (1)
    ExcelOptionsOutputTypeDef,  # (2)
]
  1. See ExcelOptionsTypeDef
  2. See ExcelOptionsOutputTypeDef

FilterExpressionUnionTypeDef#

# FilterExpressionUnionTypeDef definition

FilterExpressionUnionTypeDef = Union[
    FilterExpressionTypeDef,  # (1)
    FilterExpressionOutputTypeDef,  # (2)
]
  1. See FilterExpressionTypeDef
  2. See FilterExpressionOutputTypeDef

RecipeActionUnionTypeDef#

# RecipeActionUnionTypeDef definition

RecipeActionUnionTypeDef = Union[
    RecipeActionTypeDef,  # (1)
    RecipeActionOutputTypeDef,  # (2)
]
  1. See RecipeActionTypeDef
  2. See RecipeActionOutputTypeDef

StatisticOverrideUnionTypeDef#

# StatisticOverrideUnionTypeDef definition

StatisticOverrideUnionTypeDef = Union[
    StatisticOverrideTypeDef,  # (1)
    StatisticOverrideOutputTypeDef,  # (2)
]
  1. See StatisticOverrideTypeDef
  2. See StatisticOverrideOutputTypeDef

RuleUnionTypeDef#

# RuleUnionTypeDef definition

RuleUnionTypeDef = Union[
    RuleTypeDef,  # (1)
    RuleOutputTypeDef,  # (2)
]
  1. See RuleTypeDef
  2. See RuleOutputTypeDef

EntityDetectorConfigurationUnionTypeDef#

# EntityDetectorConfigurationUnionTypeDef definition

EntityDetectorConfigurationUnionTypeDef = Union[
    EntityDetectorConfigurationTypeDef,  # (1)
    EntityDetectorConfigurationOutputTypeDef,  # (2)
]
  1. See EntityDetectorConfigurationTypeDef
  2. See EntityDetectorConfigurationOutputTypeDef

UnionTypeDef#

# UnionTypeDef definition

UnionTypeDef = Union[
    OutputTypeDef,  # (1)
    ExtraOutputTypeDef,  # (2)
]
  1. See OutputTypeDef
  2. See ExtraOutputTypeDef

DatasetParameterUnionTypeDef#

# DatasetParameterUnionTypeDef definition

DatasetParameterUnionTypeDef = Union[
    DatasetParameterTypeDef,  # (1)
    DatasetParameterOutputTypeDef,  # (2)
]
  1. See DatasetParameterTypeDef
  2. See DatasetParameterOutputTypeDef

RecipeStepUnionTypeDef#

# RecipeStepUnionTypeDef definition

RecipeStepUnionTypeDef = Union[
    RecipeStepTypeDef,  # (1)
    RecipeStepOutputTypeDef,  # (2)
]
  1. See RecipeStepTypeDef
  2. See RecipeStepOutputTypeDef

StatisticsConfigurationUnionTypeDef#

# StatisticsConfigurationUnionTypeDef definition

StatisticsConfigurationUnionTypeDef = Union[
    StatisticsConfigurationTypeDef,  # (1)
    StatisticsConfigurationOutputTypeDef,  # (2)
]
  1. See StatisticsConfigurationTypeDef
  2. See StatisticsConfigurationOutputTypeDef

ColumnStatisticsConfigurationUnionTypeDef#

# ColumnStatisticsConfigurationUnionTypeDef definition

ColumnStatisticsConfigurationUnionTypeDef = Union[
    ColumnStatisticsConfigurationTypeDef,  # (1)
    ColumnStatisticsConfigurationOutputTypeDef,  # (2)
]
  1. See ColumnStatisticsConfigurationTypeDef
  2. See ColumnStatisticsConfigurationOutputTypeDef

AllowedStatisticsOutputTypeDef#

# AllowedStatisticsOutputTypeDef definition

class AllowedStatisticsOutputTypeDef(TypedDict):
    Statistics: list[str],

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],

FilterExpressionOutputTypeDef#

# FilterExpressionOutputTypeDef definition

class FilterExpressionOutputTypeDef(TypedDict):
    Expression: str,
    ValuesMap: dict[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,

ExcelOptionsOutputTypeDef#

# ExcelOptionsOutputTypeDef definition

class ExcelOptionsOutputTypeDef(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

FilterExpressionTypeDef#

# FilterExpressionTypeDef definition

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

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],

RecipeActionOutputTypeDef#

# RecipeActionOutputTypeDef definition

class RecipeActionOutputTypeDef(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],

StatisticOverrideOutputTypeDef#

# StatisticOverrideOutputTypeDef definition

class StatisticOverrideOutputTypeDef(TypedDict):
    Statistic: str,
    Parameters: dict[str, str],

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]],

EntityDetectorConfigurationOutputTypeDef#

# EntityDetectorConfigurationOutputTypeDef definition

class EntityDetectorConfigurationOutputTypeDef(TypedDict):
    EntityTypes: list[str],
    AllowedStatistics: NotRequired[list[AllowedStatisticsOutputTypeDef]],  # (1)
  1. See AllowedStatisticsOutputTypeDef

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

DatasetParameterOutputTypeDef#

# DatasetParameterOutputTypeDef definition

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

FormatOptionsOutputTypeDef#

# FormatOptionsOutputTypeDef definition

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

ListDatasetsRequestPaginateTypeDef#

# ListDatasetsRequestPaginateTypeDef definition

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

ListJobRunsRequestPaginateTypeDef#

# ListJobRunsRequestPaginateTypeDef definition

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

ListJobsRequestPaginateTypeDef#

# ListJobsRequestPaginateTypeDef definition

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

ListProjectsRequestPaginateTypeDef#

# ListProjectsRequestPaginateTypeDef definition

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

ListRecipeVersionsRequestPaginateTypeDef#

# ListRecipeVersionsRequestPaginateTypeDef definition

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

ListRecipesRequestPaginateTypeDef#

# ListRecipesRequestPaginateTypeDef definition

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

ListRulesetsRequestPaginateTypeDef#

# ListRulesetsRequestPaginateTypeDef definition

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

ListSchedulesRequestPaginateTypeDef#

# ListSchedulesRequestPaginateTypeDef definition

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

ListRulesetsResponseTypeDef#

# ListRulesetsResponseTypeDef definition

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

ListSchedulesResponseTypeDef#

# ListSchedulesResponseTypeDef definition

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

RecipeStepOutputTypeDef#

# RecipeStepOutputTypeDef definition

class RecipeStepOutputTypeDef(TypedDict):
    Action: RecipeActionOutputTypeDef,  # (1)
    ConditionExpressions: NotRequired[list[ConditionExpressionTypeDef]],  # (2)
  1. See RecipeActionOutputTypeDef
  2. See ConditionExpressionTypeDef

RuleOutputTypeDef#

# RuleOutputTypeDef definition

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

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

StatisticsConfigurationOutputTypeDef#

# StatisticsConfigurationOutputTypeDef definition

class StatisticsConfigurationOutputTypeDef(TypedDict):
    IncludedStatistics: NotRequired[list[str]],
    Overrides: NotRequired[list[StatisticOverrideOutputTypeDef]],  # (1)
  1. See StatisticOverrideOutputTypeDef

EntityDetectorConfigurationTypeDef#

# EntityDetectorConfigurationTypeDef definition

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

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)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ProjectTypeDef
  2. See ResponseMetadataTypeDef

ExtraOutputTypeDef#

# ExtraOutputTypeDef definition

class ExtraOutputTypeDef(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

PathOptionsOutputTypeDef#

# PathOptionsOutputTypeDef definition

class PathOptionsOutputTypeDef(TypedDict):
    LastModifiedDateCondition: NotRequired[FilterExpressionOutputTypeDef],  # (1)
    FilesLimit: NotRequired[FilesLimitTypeDef],  # (2)
    Parameters: NotRequired[dict[str, DatasetParameterOutputTypeDef]],  # (3)
  1. See FilterExpressionOutputTypeDef
  2. See FilesLimitTypeDef
  3. See DatasetParameterOutputTypeDef

FormatOptionsTypeDef#

# FormatOptionsTypeDef definition

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

DatasetParameterTypeDef#

# DatasetParameterTypeDef definition

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

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[RecipeStepOutputTypeDef],  # (1)
    Tags: dict[str, str],
    ResourceArn: str,
    RecipeVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RecipeStepOutputTypeDef
  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[RecipeStepOutputTypeDef]],  # (1)
    Tags: NotRequired[dict[str, str]],
    RecipeVersion: NotRequired[str],
  1. See RecipeStepOutputTypeDef

RecipeStepTypeDef#

# RecipeStepTypeDef definition

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

DescribeRulesetResponseTypeDef#

# DescribeRulesetResponseTypeDef definition

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

UpdateRulesetRequestRequestTypeDef#

# UpdateRulesetRequestRequestTypeDef definition

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

ColumnStatisticsConfigurationOutputTypeDef#

# ColumnStatisticsConfigurationOutputTypeDef definition

class ColumnStatisticsConfigurationOutputTypeDef(TypedDict):
    Statistics: StatisticsConfigurationOutputTypeDef,  # (2)
    Selectors: NotRequired[list[ColumnSelectorTypeDef]],  # (1)
  1. See ColumnSelectorTypeDef
  2. See StatisticsConfigurationOutputTypeDef

StatisticsConfigurationTypeDef#

# StatisticsConfigurationTypeDef definition

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

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[ExtraOutputTypeDef]],  # (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 ExtraOutputTypeDef
  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[ExtraOutputTypeDef]],  # (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 ExtraOutputTypeDef
  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

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[FormatOptionsOutputTypeDef],  # (2)
    LastModifiedDate: NotRequired[datetime],
    LastModifiedBy: NotRequired[str],
    Source: NotRequired[SourceType],  # (4)
    PathOptions: NotRequired[PathOptionsOutputTypeDef],  # (5)
    Tags: NotRequired[dict[str, str]],
    ResourceArn: NotRequired[str],
  1. See InputFormatType
  2. See FormatOptionsOutputTypeDef
  3. See InputTypeDef
  4. See SourceType
  5. See PathOptionsOutputTypeDef

DescribeDatasetResponseTypeDef#

# DescribeDatasetResponseTypeDef definition

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

ListRecipeVersionsResponseTypeDef#

# ListRecipeVersionsResponseTypeDef definition

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

ListRecipesResponseTypeDef#

# ListRecipesResponseTypeDef definition

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

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[RuleUnionTypeDef],  # (1)
    Description: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
  1. See RuleTypeDef RuleOutputTypeDef

ProfileConfigurationOutputTypeDef#

# ProfileConfigurationOutputTypeDef definition

class ProfileConfigurationOutputTypeDef(TypedDict):
    DatasetStatisticsConfiguration: NotRequired[StatisticsConfigurationOutputTypeDef],  # (1)
    ProfileColumns: NotRequired[list[ColumnSelectorTypeDef]],  # (2)
    ColumnStatisticsConfigurations: NotRequired[list[ColumnStatisticsConfigurationOutputTypeDef]],  # (3)
    EntityDetectorConfiguration: NotRequired[EntityDetectorConfigurationOutputTypeDef],  # (4)
  1. See StatisticsConfigurationOutputTypeDef
  2. See ColumnSelectorTypeDef
  3. See ColumnStatisticsConfigurationOutputTypeDef
  4. See EntityDetectorConfigurationOutputTypeDef

ListJobRunsResponseTypeDef#

# ListJobRunsResponseTypeDef definition

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

ListJobsResponseTypeDef#

# ListJobsResponseTypeDef definition

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

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[UnionTypeDef]],  # (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 ExtraOutputTypeDef
  4. See DataCatalogOutputTypeDef
  5. See DatabaseOutputTypeDef
  6. See RecipeReferenceTypeDef

ListDatasetsResponseTypeDef#

# ListDatasetsResponseTypeDef definition

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

PathOptionsTypeDef#

# PathOptionsTypeDef definition

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

CreateRecipeRequestRequestTypeDef#

# CreateRecipeRequestRequestTypeDef definition

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

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[ExtraOutputTypeDef],  # (4)
    DataCatalogOutputs: list[DataCatalogOutputTypeDef],  # (5)
    DatabaseOutputs: list[DatabaseOutputTypeDef],  # (6)
    ProjectName: str,
    ProfileConfiguration: ProfileConfigurationOutputTypeDef,  # (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 ExtraOutputTypeDef
  5. See DataCatalogOutputTypeDef
  6. See DatabaseOutputTypeDef
  7. See ProfileConfigurationOutputTypeDef
  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: ProfileConfigurationOutputTypeDef,  # (1)
    ValidationConfigurations: list[ValidationConfigurationTypeDef],  # (2)
    RunId: str,
    State: JobRunStateType,  # (3)
    LogSubscription: LogSubscriptionType,  # (4)
    LogGroupName: str,
    Outputs: list[ExtraOutputTypeDef],  # (5)
    DataCatalogOutputs: list[DataCatalogOutputTypeDef],  # (6)
    DatabaseOutputs: list[DatabaseOutputTypeDef],  # (7)
    RecipeReference: RecipeReferenceTypeDef,  # (8)
    StartedBy: str,
    StartedOn: datetime,
    JobSample: JobSampleTypeDef,  # (9)
    ResponseMetadata: ResponseMetadataTypeDef,  # (10)
  1. See ProfileConfigurationOutputTypeDef
  2. See ValidationConfigurationTypeDef
  3. See JobRunStateType
  4. See LogSubscriptionType
  5. See ExtraOutputTypeDef
  6. See DataCatalogOutputTypeDef
  7. See DatabaseOutputTypeDef
  8. See RecipeReferenceTypeDef
  9. See JobSampleTypeDef
  10. See ResponseMetadataTypeDef

ColumnStatisticsConfigurationTypeDef#

# ColumnStatisticsConfigurationTypeDef definition

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

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

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

ProfileConfigurationTypeDef#

# ProfileConfigurationTypeDef definition

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

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

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