Typed dictionaries
Index > DataPipeline > Typed dictionaries
Auto-generated documentation for DataPipeline type annotations stubs module mypy-boto3-datapipeline.
ParameterValueTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import ParameterValueTypeDef
def get_value() -> ParameterValueTypeDef:
return {
"id": ...,
"stringValue": ...,
}
TagTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"key": ...,
"value": ...,
}
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
DeactivatePipelineInputRequestTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import DeactivatePipelineInputRequestTypeDef
def get_value() -> DeactivatePipelineInputRequestTypeDef:
return {
"pipelineId": ...,
}
Definition
class DeactivatePipelineInputRequestTypeDef(TypedDict):
pipelineId: str,
cancelActive: NotRequired[bool],
DeletePipelineInputRequestTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import DeletePipelineInputRequestTypeDef
def get_value() -> DeletePipelineInputRequestTypeDef:
return {
"pipelineId": ...,
}
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
DescribeObjectsInputRequestTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import DescribeObjectsInputRequestTypeDef
def get_value() -> DescribeObjectsInputRequestTypeDef:
return {
"pipelineId": ...,
"objectIds": ...,
}
Definition
class DescribeObjectsInputRequestTypeDef(TypedDict):
pipelineId: str,
objectIds: Sequence[str],
evaluateExpressions: NotRequired[bool],
marker: NotRequired[str],
DescribePipelinesInputRequestTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import DescribePipelinesInputRequestTypeDef
def get_value() -> DescribePipelinesInputRequestTypeDef:
return {
"pipelineIds": ...,
}
EvaluateExpressionInputRequestTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import EvaluateExpressionInputRequestTypeDef
def get_value() -> EvaluateExpressionInputRequestTypeDef:
return {
"pipelineId": ...,
"objectId": ...,
"expression": ...,
}
Definition
class EvaluateExpressionInputRequestTypeDef(TypedDict):
pipelineId: str,
objectId: str,
expression: str,
FieldTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import FieldTypeDef
def get_value() -> FieldTypeDef:
return {
"key": ...,
}
Definition
class FieldTypeDef(TypedDict):
key: str,
stringValue: NotRequired[str],
refValue: NotRequired[str],
GetPipelineDefinitionInputRequestTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import GetPipelineDefinitionInputRequestTypeDef
def get_value() -> GetPipelineDefinitionInputRequestTypeDef:
return {
"pipelineId": ...,
}
Definition
class GetPipelineDefinitionInputRequestTypeDef(TypedDict):
pipelineId: str,
version: NotRequired[str],
InstanceIdentityTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import InstanceIdentityTypeDef
def get_value() -> InstanceIdentityTypeDef:
return {
"document": ...,
}
Definition
class InstanceIdentityTypeDef(TypedDict):
document: NotRequired[str],
signature: NotRequired[str],
ListPipelinesInputRequestTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import ListPipelinesInputRequestTypeDef
def get_value() -> ListPipelinesInputRequestTypeDef:
return {
"marker": ...,
}
PipelineIdNameTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import PipelineIdNameTypeDef
def get_value() -> PipelineIdNameTypeDef:
return {
"id": ...,
}
OperatorTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import OperatorTypeDef
def get_value() -> OperatorTypeDef:
return {
"type": ...,
}
Definition
class OperatorTypeDef(TypedDict):
type: NotRequired[OperatorTypeType], # (1)
values: NotRequired[Sequence[str]],
- See OperatorTypeType
ParameterAttributeTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import ParameterAttributeTypeDef
def get_value() -> ParameterAttributeTypeDef:
return {
"key": ...,
"stringValue": ...,
}
ValidationErrorTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import ValidationErrorTypeDef
def get_value() -> ValidationErrorTypeDef:
return {
"id": ...,
}
Definition
class ValidationErrorTypeDef(TypedDict):
id: NotRequired[str],
errors: NotRequired[List[str]],
ValidationWarningTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import ValidationWarningTypeDef
def get_value() -> ValidationWarningTypeDef:
return {
"id": ...,
}
Definition
class ValidationWarningTypeDef(TypedDict):
id: NotRequired[str],
warnings: NotRequired[List[str]],
RemoveTagsInputRequestTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import RemoveTagsInputRequestTypeDef
def get_value() -> RemoveTagsInputRequestTypeDef:
return {
"pipelineId": ...,
"tagKeys": ...,
}
ReportTaskRunnerHeartbeatInputRequestTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import ReportTaskRunnerHeartbeatInputRequestTypeDef
def get_value() -> ReportTaskRunnerHeartbeatInputRequestTypeDef:
return {
"taskrunnerId": ...,
}
Definition
class ReportTaskRunnerHeartbeatInputRequestTypeDef(TypedDict):
taskrunnerId: str,
workerGroup: NotRequired[str],
hostname: NotRequired[str],
SetStatusInputRequestTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import SetStatusInputRequestTypeDef
def get_value() -> SetStatusInputRequestTypeDef:
return {
"pipelineId": ...,
"objectIds": ...,
"status": ...,
}
Definition
class SetStatusInputRequestTypeDef(TypedDict):
pipelineId: str,
objectIds: Sequence[str],
status: str,
SetTaskStatusInputRequestTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import SetTaskStatusInputRequestTypeDef
def get_value() -> SetTaskStatusInputRequestTypeDef:
return {
"taskId": ...,
"taskStatus": ...,
}
Definition
class SetTaskStatusInputRequestTypeDef(TypedDict):
taskId: str,
taskStatus: TaskStatusType, # (1)
errorId: NotRequired[str],
errorMessage: NotRequired[str],
errorStackTrace: NotRequired[str],
- See TaskStatusType
ActivatePipelineInputRequestTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import ActivatePipelineInputRequestTypeDef
def get_value() -> ActivatePipelineInputRequestTypeDef:
return {
"pipelineId": ...,
}
Definition
class ActivatePipelineInputRequestTypeDef(TypedDict):
pipelineId: str,
parameterValues: NotRequired[Sequence[ParameterValueTypeDef]], # (1)
startTimestamp: NotRequired[Union[datetime, str]],
AddTagsInputRequestTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import AddTagsInputRequestTypeDef
def get_value() -> AddTagsInputRequestTypeDef:
return {
"pipelineId": ...,
"tags": ...,
}
Definition
class AddTagsInputRequestTypeDef(TypedDict):
pipelineId: str,
tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreatePipelineInputRequestTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import CreatePipelineInputRequestTypeDef
def get_value() -> CreatePipelineInputRequestTypeDef:
return {
"name": ...,
"uniqueId": ...,
}
Definition
class CreatePipelineInputRequestTypeDef(TypedDict):
name: str,
uniqueId: str,
description: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreatePipelineOutputTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import CreatePipelineOutputTypeDef
def get_value() -> CreatePipelineOutputTypeDef:
return {
"pipelineId": ...,
"ResponseMetadata": ...,
}
Definition
class CreatePipelineOutputTypeDef(TypedDict):
pipelineId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EmptyResponseMetadataTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EvaluateExpressionOutputTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import EvaluateExpressionOutputTypeDef
def get_value() -> EvaluateExpressionOutputTypeDef:
return {
"evaluatedExpression": ...,
"ResponseMetadata": ...,
}
Definition
class EvaluateExpressionOutputTypeDef(TypedDict):
evaluatedExpression: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
QueryObjectsOutputTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import QueryObjectsOutputTypeDef
def get_value() -> QueryObjectsOutputTypeDef:
return {
"ids": ...,
"marker": ...,
"hasMoreResults": ...,
"ResponseMetadata": ...,
}
Definition
class QueryObjectsOutputTypeDef(TypedDict):
ids: List[str],
marker: str,
hasMoreResults: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ReportTaskProgressOutputTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import ReportTaskProgressOutputTypeDef
def get_value() -> ReportTaskProgressOutputTypeDef:
return {
"canceled": ...,
"ResponseMetadata": ...,
}
Definition
class ReportTaskProgressOutputTypeDef(TypedDict):
canceled: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ReportTaskRunnerHeartbeatOutputTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import ReportTaskRunnerHeartbeatOutputTypeDef
def get_value() -> ReportTaskRunnerHeartbeatOutputTypeDef:
return {
"terminate": ...,
"ResponseMetadata": ...,
}
Definition
class ReportTaskRunnerHeartbeatOutputTypeDef(TypedDict):
terminate: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeObjectsInputDescribeObjectsPaginateTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import DescribeObjectsInputDescribeObjectsPaginateTypeDef
def get_value() -> DescribeObjectsInputDescribeObjectsPaginateTypeDef:
return {
"pipelineId": ...,
"objectIds": ...,
}
Definition
class DescribeObjectsInputDescribeObjectsPaginateTypeDef(TypedDict):
pipelineId: str,
objectIds: Sequence[str],
evaluateExpressions: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPipelinesInputListPipelinesPaginateTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import ListPipelinesInputListPipelinesPaginateTypeDef
def get_value() -> ListPipelinesInputListPipelinesPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListPipelinesInputListPipelinesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
PipelineDescriptionTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import PipelineDescriptionTypeDef
def get_value() -> PipelineDescriptionTypeDef:
return {
"pipelineId": ...,
"name": ...,
"fields": ...,
}
Definition
class PipelineDescriptionTypeDef(TypedDict):
pipelineId: str,
name: str,
fields: List[FieldTypeDef], # (1)
description: NotRequired[str],
tags: NotRequired[List[TagTypeDef]], # (2)
- See FieldTypeDef
- See TagTypeDef
PipelineObjectTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import PipelineObjectTypeDef
def get_value() -> PipelineObjectTypeDef:
return {
"id": ...,
"name": ...,
"fields": ...,
}
Definition
class PipelineObjectTypeDef(TypedDict):
id: str,
name: str,
fields: List[FieldTypeDef], # (1)
- See FieldTypeDef
ReportTaskProgressInputRequestTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import ReportTaskProgressInputRequestTypeDef
def get_value() -> ReportTaskProgressInputRequestTypeDef:
return {
"taskId": ...,
}
Definition
class ReportTaskProgressInputRequestTypeDef(TypedDict):
taskId: str,
fields: NotRequired[Sequence[FieldTypeDef]], # (1)
- See FieldTypeDef
PollForTaskInputRequestTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import PollForTaskInputRequestTypeDef
def get_value() -> PollForTaskInputRequestTypeDef:
return {
"workerGroup": ...,
}
Definition
class PollForTaskInputRequestTypeDef(TypedDict):
workerGroup: str,
hostname: NotRequired[str],
instanceIdentity: NotRequired[InstanceIdentityTypeDef], # (1)
ListPipelinesOutputTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import ListPipelinesOutputTypeDef
def get_value() -> ListPipelinesOutputTypeDef:
return {
"pipelineIdList": ...,
"marker": ...,
"hasMoreResults": ...,
"ResponseMetadata": ...,
}
Definition
class ListPipelinesOutputTypeDef(TypedDict):
pipelineIdList: List[PipelineIdNameTypeDef], # (1)
marker: str,
hasMoreResults: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SelectorTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import SelectorTypeDef
def get_value() -> SelectorTypeDef:
return {
"fieldName": ...,
}
Definition
class SelectorTypeDef(TypedDict):
fieldName: NotRequired[str],
operator: NotRequired[OperatorTypeDef], # (1)
- See OperatorTypeDef
ParameterObjectTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import ParameterObjectTypeDef
def get_value() -> ParameterObjectTypeDef:
return {
"id": ...,
"attributes": ...,
}
Definition
class ParameterObjectTypeDef(TypedDict):
id: str,
attributes: List[ParameterAttributeTypeDef], # (1)
PutPipelineDefinitionOutputTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import PutPipelineDefinitionOutputTypeDef
def get_value() -> PutPipelineDefinitionOutputTypeDef:
return {
"validationErrors": ...,
"validationWarnings": ...,
"errored": ...,
"ResponseMetadata": ...,
}
Definition
class PutPipelineDefinitionOutputTypeDef(TypedDict):
validationErrors: List[ValidationErrorTypeDef], # (1)
validationWarnings: List[ValidationWarningTypeDef], # (2)
errored: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ValidatePipelineDefinitionOutputTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import ValidatePipelineDefinitionOutputTypeDef
def get_value() -> ValidatePipelineDefinitionOutputTypeDef:
return {
"validationErrors": ...,
"validationWarnings": ...,
"errored": ...,
"ResponseMetadata": ...,
}
Definition
class ValidatePipelineDefinitionOutputTypeDef(TypedDict):
validationErrors: List[ValidationErrorTypeDef], # (1)
validationWarnings: List[ValidationWarningTypeDef], # (2)
errored: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
DescribePipelinesOutputTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import DescribePipelinesOutputTypeDef
def get_value() -> DescribePipelinesOutputTypeDef:
return {
"pipelineDescriptionList": ...,
"ResponseMetadata": ...,
}
Definition
class DescribePipelinesOutputTypeDef(TypedDict):
pipelineDescriptionList: List[PipelineDescriptionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeObjectsOutputTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import DescribeObjectsOutputTypeDef
def get_value() -> DescribeObjectsOutputTypeDef:
return {
"pipelineObjects": ...,
"marker": ...,
"hasMoreResults": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeObjectsOutputTypeDef(TypedDict):
pipelineObjects: List[PipelineObjectTypeDef], # (1)
marker: str,
hasMoreResults: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TaskObjectTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import TaskObjectTypeDef
def get_value() -> TaskObjectTypeDef:
return {
"taskId": ...,
}
Definition
class TaskObjectTypeDef(TypedDict):
taskId: NotRequired[str],
pipelineId: NotRequired[str],
attemptId: NotRequired[str],
objects: NotRequired[Dict[str, PipelineObjectTypeDef]], # (1)
QueryTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import QueryTypeDef
def get_value() -> QueryTypeDef:
return {
"selectors": ...,
}
- See SelectorTypeDef
GetPipelineDefinitionOutputTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import GetPipelineDefinitionOutputTypeDef
def get_value() -> GetPipelineDefinitionOutputTypeDef:
return {
"pipelineObjects": ...,
"parameterObjects": ...,
"parameterValues": ...,
"ResponseMetadata": ...,
}
Definition
class GetPipelineDefinitionOutputTypeDef(TypedDict):
pipelineObjects: List[PipelineObjectTypeDef], # (1)
parameterObjects: List[ParameterObjectTypeDef], # (2)
parameterValues: List[ParameterValueTypeDef], # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See PipelineObjectTypeDef
- See ParameterObjectTypeDef
- See ParameterValueTypeDef
- See ResponseMetadataTypeDef
PutPipelineDefinitionInputRequestTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import PutPipelineDefinitionInputRequestTypeDef
def get_value() -> PutPipelineDefinitionInputRequestTypeDef:
return {
"pipelineId": ...,
"pipelineObjects": ...,
}
Definition
class PutPipelineDefinitionInputRequestTypeDef(TypedDict):
pipelineId: str,
pipelineObjects: Sequence[PipelineObjectTypeDef], # (1)
parameterObjects: NotRequired[Sequence[ParameterObjectTypeDef]], # (2)
parameterValues: NotRequired[Sequence[ParameterValueTypeDef]], # (3)
ValidatePipelineDefinitionInputRequestTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import ValidatePipelineDefinitionInputRequestTypeDef
def get_value() -> ValidatePipelineDefinitionInputRequestTypeDef:
return {
"pipelineId": ...,
"pipelineObjects": ...,
}
Definition
class ValidatePipelineDefinitionInputRequestTypeDef(TypedDict):
pipelineId: str,
pipelineObjects: Sequence[PipelineObjectTypeDef], # (1)
parameterObjects: NotRequired[Sequence[ParameterObjectTypeDef]], # (2)
parameterValues: NotRequired[Sequence[ParameterValueTypeDef]], # (3)
PollForTaskOutputTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import PollForTaskOutputTypeDef
def get_value() -> PollForTaskOutputTypeDef:
return {
"taskObject": ...,
"ResponseMetadata": ...,
}
Definition
class PollForTaskOutputTypeDef(TypedDict):
taskObject: TaskObjectTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
QueryObjectsInputQueryObjectsPaginateTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import QueryObjectsInputQueryObjectsPaginateTypeDef
def get_value() -> QueryObjectsInputQueryObjectsPaginateTypeDef:
return {
"pipelineId": ...,
"sphere": ...,
}
Definition
class QueryObjectsInputQueryObjectsPaginateTypeDef(TypedDict):
pipelineId: str,
sphere: str,
query: NotRequired[QueryTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See QueryTypeDef
- See PaginatorConfigTypeDef
QueryObjectsInputRequestTypeDef
Usage Example
from mypy_boto3_datapipeline.type_defs import QueryObjectsInputRequestTypeDef
def get_value() -> QueryObjectsInputRequestTypeDef:
return {
"pipelineId": ...,
"sphere": ...,
}
Definition
class QueryObjectsInputRequestTypeDef(TypedDict):
pipelineId: str,
sphere: str,
query: NotRequired[QueryTypeDef], # (1)
marker: NotRequired[str],
limit: NotRequired[int],
- See QueryTypeDef