Skip to content

Type definitions#

Index > EventBridgePipes > Type definitions

Auto-generated documentation for EventBridgePipes type annotations stubs module types-boto3-pipes.

TimestampTypeDef#

# TimestampTypeDef Union usage example

from types_boto3_pipes.type_defs import TimestampTypeDef


def get_value() -> TimestampTypeDef:
    return ...


# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

SelfManagedKafkaAccessConfigurationVpcUnionTypeDef#

# SelfManagedKafkaAccessConfigurationVpcUnionTypeDef Union usage example

from types_boto3_pipes.type_defs import SelfManagedKafkaAccessConfigurationVpcUnionTypeDef


def get_value() -> SelfManagedKafkaAccessConfigurationVpcUnionTypeDef:
    return ...


# SelfManagedKafkaAccessConfigurationVpcUnionTypeDef definition

SelfManagedKafkaAccessConfigurationVpcUnionTypeDef = Union[
    SelfManagedKafkaAccessConfigurationVpcTypeDef,  # (1)
    SelfManagedKafkaAccessConfigurationVpcOutputTypeDef,  # (2)
]
  1. See SelfManagedKafkaAccessConfigurationVpcTypeDef
  2. See SelfManagedKafkaAccessConfigurationVpcOutputTypeDef

FilterCriteriaUnionTypeDef#

# FilterCriteriaUnionTypeDef Union usage example

from types_boto3_pipes.type_defs import FilterCriteriaUnionTypeDef


def get_value() -> FilterCriteriaUnionTypeDef:
    return ...


# FilterCriteriaUnionTypeDef definition

FilterCriteriaUnionTypeDef = Union[
    FilterCriteriaTypeDef,  # (1)
    FilterCriteriaOutputTypeDef,  # (2)
]
  1. See FilterCriteriaTypeDef
  2. See FilterCriteriaOutputTypeDef

PipeEnrichmentParametersUnionTypeDef#

# PipeEnrichmentParametersUnionTypeDef Union usage example

from types_boto3_pipes.type_defs import PipeEnrichmentParametersUnionTypeDef


def get_value() -> PipeEnrichmentParametersUnionTypeDef:
    return ...


# PipeEnrichmentParametersUnionTypeDef definition

PipeEnrichmentParametersUnionTypeDef = Union[
    PipeEnrichmentParametersTypeDef,  # (1)
    PipeEnrichmentParametersOutputTypeDef,  # (2)
]
  1. See PipeEnrichmentParametersTypeDef
  2. See PipeEnrichmentParametersOutputTypeDef

PipeSourceParametersUnionTypeDef#

# PipeSourceParametersUnionTypeDef Union usage example

from types_boto3_pipes.type_defs import PipeSourceParametersUnionTypeDef


def get_value() -> PipeSourceParametersUnionTypeDef:
    return ...


# PipeSourceParametersUnionTypeDef definition

PipeSourceParametersUnionTypeDef = Union[
    PipeSourceParametersTypeDef,  # (1)
    PipeSourceParametersOutputTypeDef,  # (2)
]
  1. See PipeSourceParametersTypeDef
  2. See PipeSourceParametersOutputTypeDef

PipeTargetParametersUnionTypeDef#

# PipeTargetParametersUnionTypeDef Union usage example

from types_boto3_pipes.type_defs import PipeTargetParametersUnionTypeDef


def get_value() -> PipeTargetParametersUnionTypeDef:
    return ...


# PipeTargetParametersUnionTypeDef definition

PipeTargetParametersUnionTypeDef = Union[
    PipeTargetParametersTypeDef,  # (1)
    PipeTargetParametersOutputTypeDef,  # (2)
]
  1. See PipeTargetParametersTypeDef
  2. See PipeTargetParametersOutputTypeDef

AwsVpcConfigurationOutputTypeDef#

# AwsVpcConfigurationOutputTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import AwsVpcConfigurationOutputTypeDef


def get_value() -> AwsVpcConfigurationOutputTypeDef:
    return {
        "Subnets": ...,
    }


# AwsVpcConfigurationOutputTypeDef definition

class AwsVpcConfigurationOutputTypeDef(TypedDict):
    Subnets: List[str],
    SecurityGroups: NotRequired[List[str]],
    AssignPublicIp: NotRequired[AssignPublicIpType],  # (1)
  1. See AssignPublicIpType

AwsVpcConfigurationTypeDef#

# AwsVpcConfigurationTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import AwsVpcConfigurationTypeDef


def get_value() -> AwsVpcConfigurationTypeDef:
    return {
        "Subnets": ...,
    }


# AwsVpcConfigurationTypeDef definition

class AwsVpcConfigurationTypeDef(TypedDict):
    Subnets: Sequence[str],
    SecurityGroups: NotRequired[Sequence[str]],
    AssignPublicIp: NotRequired[AssignPublicIpType],  # (1)
  1. See AssignPublicIpType

BatchArrayPropertiesTypeDef#

# BatchArrayPropertiesTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import BatchArrayPropertiesTypeDef


def get_value() -> BatchArrayPropertiesTypeDef:
    return {
        "Size": ...,
    }


# BatchArrayPropertiesTypeDef definition

class BatchArrayPropertiesTypeDef(TypedDict):
    Size: NotRequired[int],

BatchEnvironmentVariableTypeDef#

# BatchEnvironmentVariableTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import BatchEnvironmentVariableTypeDef


def get_value() -> BatchEnvironmentVariableTypeDef:
    return {
        "Name": ...,
    }


# BatchEnvironmentVariableTypeDef definition

class BatchEnvironmentVariableTypeDef(TypedDict):
    Name: NotRequired[str],
    Value: NotRequired[str],

BatchResourceRequirementTypeDef#

# BatchResourceRequirementTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import BatchResourceRequirementTypeDef


def get_value() -> BatchResourceRequirementTypeDef:
    return {
        "Type": ...,
    }


# BatchResourceRequirementTypeDef definition

class BatchResourceRequirementTypeDef(TypedDict):
    Type: BatchResourceRequirementTypeType,  # (1)
    Value: str,
  1. See BatchResourceRequirementTypeType

BatchJobDependencyTypeDef#

# BatchJobDependencyTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import BatchJobDependencyTypeDef


def get_value() -> BatchJobDependencyTypeDef:
    return {
        "JobId": ...,
    }


# BatchJobDependencyTypeDef definition

class BatchJobDependencyTypeDef(TypedDict):
    JobId: NotRequired[str],
    Type: NotRequired[BatchJobDependencyTypeType],  # (1)
  1. See BatchJobDependencyTypeType

BatchRetryStrategyTypeDef#

# BatchRetryStrategyTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import BatchRetryStrategyTypeDef


def get_value() -> BatchRetryStrategyTypeDef:
    return {
        "Attempts": ...,
    }


# BatchRetryStrategyTypeDef definition

class BatchRetryStrategyTypeDef(TypedDict):
    Attempts: NotRequired[int],

CapacityProviderStrategyItemTypeDef#

# CapacityProviderStrategyItemTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import CapacityProviderStrategyItemTypeDef


def get_value() -> CapacityProviderStrategyItemTypeDef:
    return {
        "capacityProvider": ...,
    }


# CapacityProviderStrategyItemTypeDef definition

class CapacityProviderStrategyItemTypeDef(TypedDict):
    capacityProvider: str,
    weight: NotRequired[int],
    base: NotRequired[int],

CloudwatchLogsLogDestinationParametersTypeDef#

# CloudwatchLogsLogDestinationParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import CloudwatchLogsLogDestinationParametersTypeDef


def get_value() -> CloudwatchLogsLogDestinationParametersTypeDef:
    return {
        "LogGroupArn": ...,
    }


# CloudwatchLogsLogDestinationParametersTypeDef definition

class CloudwatchLogsLogDestinationParametersTypeDef(TypedDict):
    LogGroupArn: str,

CloudwatchLogsLogDestinationTypeDef#

# CloudwatchLogsLogDestinationTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import CloudwatchLogsLogDestinationTypeDef


def get_value() -> CloudwatchLogsLogDestinationTypeDef:
    return {
        "LogGroupArn": ...,
    }


# CloudwatchLogsLogDestinationTypeDef definition

class CloudwatchLogsLogDestinationTypeDef(TypedDict):
    LogGroupArn: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

DeadLetterConfigTypeDef#

# DeadLetterConfigTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import DeadLetterConfigTypeDef


def get_value() -> DeadLetterConfigTypeDef:
    return {
        "Arn": ...,
    }


# DeadLetterConfigTypeDef definition

class DeadLetterConfigTypeDef(TypedDict):
    Arn: NotRequired[str],

DeletePipeRequestTypeDef#

# DeletePipeRequestTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import DeletePipeRequestTypeDef


def get_value() -> DeletePipeRequestTypeDef:
    return {
        "Name": ...,
    }


# DeletePipeRequestTypeDef definition

class DeletePipeRequestTypeDef(TypedDict):
    Name: str,

DescribePipeRequestTypeDef#

# DescribePipeRequestTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import DescribePipeRequestTypeDef


def get_value() -> DescribePipeRequestTypeDef:
    return {
        "Name": ...,
    }


# DescribePipeRequestTypeDef definition

class DescribePipeRequestTypeDef(TypedDict):
    Name: str,

DimensionMappingTypeDef#

# DimensionMappingTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import DimensionMappingTypeDef


def get_value() -> DimensionMappingTypeDef:
    return {
        "DimensionValue": ...,
    }


# DimensionMappingTypeDef definition

class DimensionMappingTypeDef(TypedDict):
    DimensionValue: str,
    DimensionValueType: DimensionValueTypeType,  # (1)
    DimensionName: str,
  1. See DimensionValueTypeType

EcsEnvironmentFileTypeDef#

# EcsEnvironmentFileTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import EcsEnvironmentFileTypeDef


def get_value() -> EcsEnvironmentFileTypeDef:
    return {
        "type": ...,
    }


# EcsEnvironmentFileTypeDef definition

class EcsEnvironmentFileTypeDef(TypedDict):
    type: EcsEnvironmentFileTypeType,  # (1)
    value: str,
  1. See EcsEnvironmentFileTypeType

EcsEnvironmentVariableTypeDef#

# EcsEnvironmentVariableTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import EcsEnvironmentVariableTypeDef


def get_value() -> EcsEnvironmentVariableTypeDef:
    return {
        "name": ...,
    }


# EcsEnvironmentVariableTypeDef definition

class EcsEnvironmentVariableTypeDef(TypedDict):
    name: NotRequired[str],
    value: NotRequired[str],

EcsResourceRequirementTypeDef#

# EcsResourceRequirementTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import EcsResourceRequirementTypeDef


def get_value() -> EcsResourceRequirementTypeDef:
    return {
        "type": ...,
    }


# EcsResourceRequirementTypeDef definition

class EcsResourceRequirementTypeDef(TypedDict):
    type: EcsResourceRequirementTypeType,  # (1)
    value: str,
  1. See EcsResourceRequirementTypeType

EcsEphemeralStorageTypeDef#

# EcsEphemeralStorageTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import EcsEphemeralStorageTypeDef


def get_value() -> EcsEphemeralStorageTypeDef:
    return {
        "sizeInGiB": ...,
    }


# EcsEphemeralStorageTypeDef definition

class EcsEphemeralStorageTypeDef(TypedDict):
    sizeInGiB: int,

EcsInferenceAcceleratorOverrideTypeDef#

# EcsInferenceAcceleratorOverrideTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import EcsInferenceAcceleratorOverrideTypeDef


def get_value() -> EcsInferenceAcceleratorOverrideTypeDef:
    return {
        "deviceName": ...,
    }


# EcsInferenceAcceleratorOverrideTypeDef definition

class EcsInferenceAcceleratorOverrideTypeDef(TypedDict):
    deviceName: NotRequired[str],
    deviceType: NotRequired[str],

FilterTypeDef#

# FilterTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import FilterTypeDef


def get_value() -> FilterTypeDef:
    return {
        "Pattern": ...,
    }


# FilterTypeDef definition

class FilterTypeDef(TypedDict):
    Pattern: NotRequired[str],

FirehoseLogDestinationParametersTypeDef#

# FirehoseLogDestinationParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import FirehoseLogDestinationParametersTypeDef


def get_value() -> FirehoseLogDestinationParametersTypeDef:
    return {
        "DeliveryStreamArn": ...,
    }


# FirehoseLogDestinationParametersTypeDef definition

class FirehoseLogDestinationParametersTypeDef(TypedDict):
    DeliveryStreamArn: str,

FirehoseLogDestinationTypeDef#

# FirehoseLogDestinationTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import FirehoseLogDestinationTypeDef


def get_value() -> FirehoseLogDestinationTypeDef:
    return {
        "DeliveryStreamArn": ...,
    }


# FirehoseLogDestinationTypeDef definition

class FirehoseLogDestinationTypeDef(TypedDict):
    DeliveryStreamArn: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

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

ListPipesRequestTypeDef#

# ListPipesRequestTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import ListPipesRequestTypeDef


def get_value() -> ListPipesRequestTypeDef:
    return {
        "NamePrefix": ...,
    }


# ListPipesRequestTypeDef definition

class ListPipesRequestTypeDef(TypedDict):
    NamePrefix: NotRequired[str],
    DesiredState: NotRequired[RequestedPipeStateType],  # (1)
    CurrentState: NotRequired[PipeStateType],  # (2)
    SourcePrefix: NotRequired[str],
    TargetPrefix: NotRequired[str],
    NextToken: NotRequired[str],
    Limit: NotRequired[int],
  1. See RequestedPipeStateType
  2. See PipeStateType

PipeTypeDef#

# PipeTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeTypeDef


def get_value() -> PipeTypeDef:
    return {
        "Name": ...,
    }


# PipeTypeDef definition

class PipeTypeDef(TypedDict):
    Name: NotRequired[str],
    Arn: NotRequired[str],
    DesiredState: NotRequired[RequestedPipeStateType],  # (1)
    CurrentState: NotRequired[PipeStateType],  # (2)
    StateReason: NotRequired[str],
    CreationTime: NotRequired[datetime],
    LastModifiedTime: NotRequired[datetime],
    Source: NotRequired[str],
    Target: NotRequired[str],
    Enrichment: NotRequired[str],
  1. See RequestedPipeStateType
  2. See PipeStateType

ListTagsForResourceRequestTypeDef#

# ListTagsForResourceRequestTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    resourceArn: str,

MQBrokerAccessCredentialsTypeDef#

# MQBrokerAccessCredentialsTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import MQBrokerAccessCredentialsTypeDef


def get_value() -> MQBrokerAccessCredentialsTypeDef:
    return {
        "BasicAuth": ...,
    }


# MQBrokerAccessCredentialsTypeDef definition

class MQBrokerAccessCredentialsTypeDef(TypedDict):
    BasicAuth: NotRequired[str],

MSKAccessCredentialsTypeDef#

# MSKAccessCredentialsTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import MSKAccessCredentialsTypeDef


def get_value() -> MSKAccessCredentialsTypeDef:
    return {
        "SaslScram512Auth": ...,
    }


# MSKAccessCredentialsTypeDef definition

class MSKAccessCredentialsTypeDef(TypedDict):
    SaslScram512Auth: NotRequired[str],
    ClientCertificateTlsAuth: NotRequired[str],

MultiMeasureAttributeMappingTypeDef#

# MultiMeasureAttributeMappingTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import MultiMeasureAttributeMappingTypeDef


def get_value() -> MultiMeasureAttributeMappingTypeDef:
    return {
        "MeasureValue": ...,
    }


# MultiMeasureAttributeMappingTypeDef definition

class MultiMeasureAttributeMappingTypeDef(TypedDict):
    MeasureValue: str,
    MeasureValueType: MeasureValueTypeType,  # (1)
    MultiMeasureAttributeName: str,
  1. See MeasureValueTypeType

PipeEnrichmentHttpParametersOutputTypeDef#

# PipeEnrichmentHttpParametersOutputTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeEnrichmentHttpParametersOutputTypeDef


def get_value() -> PipeEnrichmentHttpParametersOutputTypeDef:
    return {
        "PathParameterValues": ...,
    }


# PipeEnrichmentHttpParametersOutputTypeDef definition

class PipeEnrichmentHttpParametersOutputTypeDef(TypedDict):
    PathParameterValues: NotRequired[List[str]],
    HeaderParameters: NotRequired[Dict[str, str]],
    QueryStringParameters: NotRequired[Dict[str, str]],

PipeEnrichmentHttpParametersTypeDef#

# PipeEnrichmentHttpParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeEnrichmentHttpParametersTypeDef


def get_value() -> PipeEnrichmentHttpParametersTypeDef:
    return {
        "PathParameterValues": ...,
    }


# PipeEnrichmentHttpParametersTypeDef definition

class PipeEnrichmentHttpParametersTypeDef(TypedDict):
    PathParameterValues: NotRequired[Sequence[str]],
    HeaderParameters: NotRequired[Mapping[str, str]],
    QueryStringParameters: NotRequired[Mapping[str, str]],

S3LogDestinationParametersTypeDef#

# S3LogDestinationParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import S3LogDestinationParametersTypeDef


def get_value() -> S3LogDestinationParametersTypeDef:
    return {
        "BucketName": ...,
    }


# S3LogDestinationParametersTypeDef definition

class S3LogDestinationParametersTypeDef(TypedDict):
    BucketName: str,
    BucketOwner: str,
    OutputFormat: NotRequired[S3OutputFormatType],  # (1)
    Prefix: NotRequired[str],
  1. See S3OutputFormatType

S3LogDestinationTypeDef#

# S3LogDestinationTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import S3LogDestinationTypeDef


def get_value() -> S3LogDestinationTypeDef:
    return {
        "BucketName": ...,
    }


# S3LogDestinationTypeDef definition

class S3LogDestinationTypeDef(TypedDict):
    BucketName: NotRequired[str],
    Prefix: NotRequired[str],
    BucketOwner: NotRequired[str],
    OutputFormat: NotRequired[S3OutputFormatType],  # (1)
  1. See S3OutputFormatType

PipeSourceSqsQueueParametersTypeDef#

# PipeSourceSqsQueueParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeSourceSqsQueueParametersTypeDef


def get_value() -> PipeSourceSqsQueueParametersTypeDef:
    return {
        "BatchSize": ...,
    }


# PipeSourceSqsQueueParametersTypeDef definition

class PipeSourceSqsQueueParametersTypeDef(TypedDict):
    BatchSize: NotRequired[int],
    MaximumBatchingWindowInSeconds: NotRequired[int],

SelfManagedKafkaAccessConfigurationCredentialsTypeDef#

# SelfManagedKafkaAccessConfigurationCredentialsTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import SelfManagedKafkaAccessConfigurationCredentialsTypeDef


def get_value() -> SelfManagedKafkaAccessConfigurationCredentialsTypeDef:
    return {
        "BasicAuth": ...,
    }


# SelfManagedKafkaAccessConfigurationCredentialsTypeDef definition

class SelfManagedKafkaAccessConfigurationCredentialsTypeDef(TypedDict):
    BasicAuth: NotRequired[str],
    SaslScram512Auth: NotRequired[str],
    SaslScram256Auth: NotRequired[str],
    ClientCertificateTlsAuth: NotRequired[str],

SelfManagedKafkaAccessConfigurationVpcOutputTypeDef#

# SelfManagedKafkaAccessConfigurationVpcOutputTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import SelfManagedKafkaAccessConfigurationVpcOutputTypeDef


def get_value() -> SelfManagedKafkaAccessConfigurationVpcOutputTypeDef:
    return {
        "Subnets": ...,
    }


# SelfManagedKafkaAccessConfigurationVpcOutputTypeDef definition

class SelfManagedKafkaAccessConfigurationVpcOutputTypeDef(TypedDict):
    Subnets: NotRequired[List[str]],
    SecurityGroup: NotRequired[List[str]],

SelfManagedKafkaAccessConfigurationVpcTypeDef#

# SelfManagedKafkaAccessConfigurationVpcTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import SelfManagedKafkaAccessConfigurationVpcTypeDef


def get_value() -> SelfManagedKafkaAccessConfigurationVpcTypeDef:
    return {
        "Subnets": ...,
    }


# SelfManagedKafkaAccessConfigurationVpcTypeDef definition

class SelfManagedKafkaAccessConfigurationVpcTypeDef(TypedDict):
    Subnets: NotRequired[Sequence[str]],
    SecurityGroup: NotRequired[Sequence[str]],

PipeTargetCloudWatchLogsParametersTypeDef#

# PipeTargetCloudWatchLogsParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeTargetCloudWatchLogsParametersTypeDef


def get_value() -> PipeTargetCloudWatchLogsParametersTypeDef:
    return {
        "LogStreamName": ...,
    }


# PipeTargetCloudWatchLogsParametersTypeDef definition

class PipeTargetCloudWatchLogsParametersTypeDef(TypedDict):
    LogStreamName: NotRequired[str],
    Timestamp: NotRequired[str],

PlacementConstraintTypeDef#

# PlacementConstraintTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PlacementConstraintTypeDef


def get_value() -> PlacementConstraintTypeDef:
    return {
        "type": ...,
    }


# PlacementConstraintTypeDef definition

class PlacementConstraintTypeDef(TypedDict):
    type: NotRequired[PlacementConstraintTypeType],  # (1)
    expression: NotRequired[str],
  1. See PlacementConstraintTypeType

PlacementStrategyTypeDef#

# PlacementStrategyTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PlacementStrategyTypeDef


def get_value() -> PlacementStrategyTypeDef:
    return {
        "type": ...,
    }


# PlacementStrategyTypeDef definition

class PlacementStrategyTypeDef(TypedDict):
    type: NotRequired[PlacementStrategyTypeType],  # (1)
    field: NotRequired[str],
  1. See PlacementStrategyTypeType

TagTypeDef#

# TagTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import TagTypeDef


def get_value() -> TagTypeDef:
    return {
        "Key": ...,
    }


# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

PipeTargetEventBridgeEventBusParametersOutputTypeDef#

# PipeTargetEventBridgeEventBusParametersOutputTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeTargetEventBridgeEventBusParametersOutputTypeDef


def get_value() -> PipeTargetEventBridgeEventBusParametersOutputTypeDef:
    return {
        "EndpointId": ...,
    }


# PipeTargetEventBridgeEventBusParametersOutputTypeDef definition

class PipeTargetEventBridgeEventBusParametersOutputTypeDef(TypedDict):
    EndpointId: NotRequired[str],
    DetailType: NotRequired[str],
    Source: NotRequired[str],
    Resources: NotRequired[List[str]],
    Time: NotRequired[str],

PipeTargetEventBridgeEventBusParametersTypeDef#

# PipeTargetEventBridgeEventBusParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeTargetEventBridgeEventBusParametersTypeDef


def get_value() -> PipeTargetEventBridgeEventBusParametersTypeDef:
    return {
        "EndpointId": ...,
    }


# PipeTargetEventBridgeEventBusParametersTypeDef definition

class PipeTargetEventBridgeEventBusParametersTypeDef(TypedDict):
    EndpointId: NotRequired[str],
    DetailType: NotRequired[str],
    Source: NotRequired[str],
    Resources: NotRequired[Sequence[str]],
    Time: NotRequired[str],

PipeTargetHttpParametersOutputTypeDef#

# PipeTargetHttpParametersOutputTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeTargetHttpParametersOutputTypeDef


def get_value() -> PipeTargetHttpParametersOutputTypeDef:
    return {
        "PathParameterValues": ...,
    }


# PipeTargetHttpParametersOutputTypeDef definition

class PipeTargetHttpParametersOutputTypeDef(TypedDict):
    PathParameterValues: NotRequired[List[str]],
    HeaderParameters: NotRequired[Dict[str, str]],
    QueryStringParameters: NotRequired[Dict[str, str]],

PipeTargetHttpParametersTypeDef#

# PipeTargetHttpParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeTargetHttpParametersTypeDef


def get_value() -> PipeTargetHttpParametersTypeDef:
    return {
        "PathParameterValues": ...,
    }


# PipeTargetHttpParametersTypeDef definition

class PipeTargetHttpParametersTypeDef(TypedDict):
    PathParameterValues: NotRequired[Sequence[str]],
    HeaderParameters: NotRequired[Mapping[str, str]],
    QueryStringParameters: NotRequired[Mapping[str, str]],

PipeTargetKinesisStreamParametersTypeDef#

# PipeTargetKinesisStreamParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeTargetKinesisStreamParametersTypeDef


def get_value() -> PipeTargetKinesisStreamParametersTypeDef:
    return {
        "PartitionKey": ...,
    }


# PipeTargetKinesisStreamParametersTypeDef definition

class PipeTargetKinesisStreamParametersTypeDef(TypedDict):
    PartitionKey: str,

PipeTargetLambdaFunctionParametersTypeDef#

# PipeTargetLambdaFunctionParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeTargetLambdaFunctionParametersTypeDef


def get_value() -> PipeTargetLambdaFunctionParametersTypeDef:
    return {
        "InvocationType": ...,
    }


# PipeTargetLambdaFunctionParametersTypeDef definition

class PipeTargetLambdaFunctionParametersTypeDef(TypedDict):
    InvocationType: NotRequired[PipeTargetInvocationTypeType],  # (1)
  1. See PipeTargetInvocationTypeType

PipeTargetRedshiftDataParametersOutputTypeDef#

# PipeTargetRedshiftDataParametersOutputTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeTargetRedshiftDataParametersOutputTypeDef


def get_value() -> PipeTargetRedshiftDataParametersOutputTypeDef:
    return {
        "SecretManagerArn": ...,
    }


# PipeTargetRedshiftDataParametersOutputTypeDef definition

class PipeTargetRedshiftDataParametersOutputTypeDef(TypedDict):
    Database: str,
    Sqls: List[str],
    SecretManagerArn: NotRequired[str],
    DbUser: NotRequired[str],
    StatementName: NotRequired[str],
    WithEvent: NotRequired[bool],

PipeTargetSqsQueueParametersTypeDef#

# PipeTargetSqsQueueParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeTargetSqsQueueParametersTypeDef


def get_value() -> PipeTargetSqsQueueParametersTypeDef:
    return {
        "MessageGroupId": ...,
    }


# PipeTargetSqsQueueParametersTypeDef definition

class PipeTargetSqsQueueParametersTypeDef(TypedDict):
    MessageGroupId: NotRequired[str],
    MessageDeduplicationId: NotRequired[str],

PipeTargetStateMachineParametersTypeDef#

# PipeTargetStateMachineParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeTargetStateMachineParametersTypeDef


def get_value() -> PipeTargetStateMachineParametersTypeDef:
    return {
        "InvocationType": ...,
    }


# PipeTargetStateMachineParametersTypeDef definition

class PipeTargetStateMachineParametersTypeDef(TypedDict):
    InvocationType: NotRequired[PipeTargetInvocationTypeType],  # (1)
  1. See PipeTargetInvocationTypeType

PipeTargetRedshiftDataParametersTypeDef#

# PipeTargetRedshiftDataParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeTargetRedshiftDataParametersTypeDef


def get_value() -> PipeTargetRedshiftDataParametersTypeDef:
    return {
        "SecretManagerArn": ...,
    }


# PipeTargetRedshiftDataParametersTypeDef definition

class PipeTargetRedshiftDataParametersTypeDef(TypedDict):
    Database: str,
    Sqls: Sequence[str],
    SecretManagerArn: NotRequired[str],
    DbUser: NotRequired[str],
    StatementName: NotRequired[str],
    WithEvent: NotRequired[bool],

SageMakerPipelineParameterTypeDef#

# SageMakerPipelineParameterTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import SageMakerPipelineParameterTypeDef


def get_value() -> SageMakerPipelineParameterTypeDef:
    return {
        "Name": ...,
    }


# SageMakerPipelineParameterTypeDef definition

class SageMakerPipelineParameterTypeDef(TypedDict):
    Name: str,
    Value: str,

SingleMeasureMappingTypeDef#

# SingleMeasureMappingTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import SingleMeasureMappingTypeDef


def get_value() -> SingleMeasureMappingTypeDef:
    return {
        "MeasureValue": ...,
    }


# SingleMeasureMappingTypeDef definition

class SingleMeasureMappingTypeDef(TypedDict):
    MeasureValue: str,
    MeasureValueType: MeasureValueTypeType,  # (1)
    MeasureName: str,
  1. See MeasureValueTypeType

StartPipeRequestTypeDef#

# StartPipeRequestTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import StartPipeRequestTypeDef


def get_value() -> StartPipeRequestTypeDef:
    return {
        "Name": ...,
    }


# StartPipeRequestTypeDef definition

class StartPipeRequestTypeDef(TypedDict):
    Name: str,

StopPipeRequestTypeDef#

# StopPipeRequestTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import StopPipeRequestTypeDef


def get_value() -> StopPipeRequestTypeDef:
    return {
        "Name": ...,
    }


# StopPipeRequestTypeDef definition

class StopPipeRequestTypeDef(TypedDict):
    Name: str,

TagResourceRequestTypeDef#

# TagResourceRequestTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# TagResourceRequestTypeDef definition

class TagResourceRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestTypeDef#

# UntagResourceRequestTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# UntagResourceRequestTypeDef definition

class UntagResourceRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdatePipeSourceSqsQueueParametersTypeDef#

# UpdatePipeSourceSqsQueueParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import UpdatePipeSourceSqsQueueParametersTypeDef


def get_value() -> UpdatePipeSourceSqsQueueParametersTypeDef:
    return {
        "BatchSize": ...,
    }


# UpdatePipeSourceSqsQueueParametersTypeDef definition

class UpdatePipeSourceSqsQueueParametersTypeDef(TypedDict):
    BatchSize: NotRequired[int],
    MaximumBatchingWindowInSeconds: NotRequired[int],

NetworkConfigurationOutputTypeDef#

# NetworkConfigurationOutputTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import NetworkConfigurationOutputTypeDef


def get_value() -> NetworkConfigurationOutputTypeDef:
    return {
        "awsvpcConfiguration": ...,
    }


# NetworkConfigurationOutputTypeDef definition

class NetworkConfigurationOutputTypeDef(TypedDict):
    awsvpcConfiguration: NotRequired[AwsVpcConfigurationOutputTypeDef],  # (1)
  1. See AwsVpcConfigurationOutputTypeDef

NetworkConfigurationTypeDef#

# NetworkConfigurationTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import NetworkConfigurationTypeDef


def get_value() -> NetworkConfigurationTypeDef:
    return {
        "awsvpcConfiguration": ...,
    }


# NetworkConfigurationTypeDef definition

class NetworkConfigurationTypeDef(TypedDict):
    awsvpcConfiguration: NotRequired[AwsVpcConfigurationTypeDef],  # (1)
  1. See AwsVpcConfigurationTypeDef

BatchContainerOverridesOutputTypeDef#

# BatchContainerOverridesOutputTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import BatchContainerOverridesOutputTypeDef


def get_value() -> BatchContainerOverridesOutputTypeDef:
    return {
        "Command": ...,
    }


# BatchContainerOverridesOutputTypeDef definition

class BatchContainerOverridesOutputTypeDef(TypedDict):
    Command: NotRequired[List[str]],
    Environment: NotRequired[List[BatchEnvironmentVariableTypeDef]],  # (1)
    InstanceType: NotRequired[str],
    ResourceRequirements: NotRequired[List[BatchResourceRequirementTypeDef]],  # (2)
  1. See BatchEnvironmentVariableTypeDef
  2. See BatchResourceRequirementTypeDef

BatchContainerOverridesTypeDef#

# BatchContainerOverridesTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import BatchContainerOverridesTypeDef


def get_value() -> BatchContainerOverridesTypeDef:
    return {
        "Command": ...,
    }


# BatchContainerOverridesTypeDef definition

class BatchContainerOverridesTypeDef(TypedDict):
    Command: NotRequired[Sequence[str]],
    Environment: NotRequired[Sequence[BatchEnvironmentVariableTypeDef]],  # (1)
    InstanceType: NotRequired[str],
    ResourceRequirements: NotRequired[Sequence[BatchResourceRequirementTypeDef]],  # (2)
  1. See BatchEnvironmentVariableTypeDef
  2. See BatchResourceRequirementTypeDef

CreatePipeResponseTypeDef#

# CreatePipeResponseTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import CreatePipeResponseTypeDef


def get_value() -> CreatePipeResponseTypeDef:
    return {
        "Arn": ...,
    }


# CreatePipeResponseTypeDef definition

class CreatePipeResponseTypeDef(TypedDict):
    Arn: str,
    Name: str,
    DesiredState: RequestedPipeStateType,  # (1)
    CurrentState: PipeStateType,  # (2)
    CreationTime: datetime,
    LastModifiedTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See RequestedPipeStateType
  2. See PipeStateType
  3. See ResponseMetadataTypeDef

DeletePipeResponseTypeDef#

# DeletePipeResponseTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import DeletePipeResponseTypeDef


def get_value() -> DeletePipeResponseTypeDef:
    return {
        "Arn": ...,
    }


# DeletePipeResponseTypeDef definition

class DeletePipeResponseTypeDef(TypedDict):
    Arn: str,
    Name: str,
    DesiredState: RequestedPipeStateDescribeResponseType,  # (1)
    CurrentState: PipeStateType,  # (2)
    CreationTime: datetime,
    LastModifiedTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See RequestedPipeStateDescribeResponseType
  2. See PipeStateType
  3. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import ListTagsForResourceResponseTypeDef


def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "tags": ...,
    }


# ListTagsForResourceResponseTypeDef definition

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

StartPipeResponseTypeDef#

# StartPipeResponseTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import StartPipeResponseTypeDef


def get_value() -> StartPipeResponseTypeDef:
    return {
        "Arn": ...,
    }


# StartPipeResponseTypeDef definition

class StartPipeResponseTypeDef(TypedDict):
    Arn: str,
    Name: str,
    DesiredState: RequestedPipeStateType,  # (1)
    CurrentState: PipeStateType,  # (2)
    CreationTime: datetime,
    LastModifiedTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See RequestedPipeStateType
  2. See PipeStateType
  3. See ResponseMetadataTypeDef

StopPipeResponseTypeDef#

# StopPipeResponseTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import StopPipeResponseTypeDef


def get_value() -> StopPipeResponseTypeDef:
    return {
        "Arn": ...,
    }


# StopPipeResponseTypeDef definition

class StopPipeResponseTypeDef(TypedDict):
    Arn: str,
    Name: str,
    DesiredState: RequestedPipeStateType,  # (1)
    CurrentState: PipeStateType,  # (2)
    CreationTime: datetime,
    LastModifiedTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See RequestedPipeStateType
  2. See PipeStateType
  3. See ResponseMetadataTypeDef

UpdatePipeResponseTypeDef#

# UpdatePipeResponseTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import UpdatePipeResponseTypeDef


def get_value() -> UpdatePipeResponseTypeDef:
    return {
        "Arn": ...,
    }


# UpdatePipeResponseTypeDef definition

class UpdatePipeResponseTypeDef(TypedDict):
    Arn: str,
    Name: str,
    DesiredState: RequestedPipeStateType,  # (1)
    CurrentState: PipeStateType,  # (2)
    CreationTime: datetime,
    LastModifiedTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See RequestedPipeStateType
  2. See PipeStateType
  3. See ResponseMetadataTypeDef

PipeSourceDynamoDBStreamParametersTypeDef#

# PipeSourceDynamoDBStreamParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeSourceDynamoDBStreamParametersTypeDef


def get_value() -> PipeSourceDynamoDBStreamParametersTypeDef:
    return {
        "BatchSize": ...,
    }


# PipeSourceDynamoDBStreamParametersTypeDef definition

class PipeSourceDynamoDBStreamParametersTypeDef(TypedDict):
    StartingPosition: DynamoDBStreamStartPositionType,  # (3)
    BatchSize: NotRequired[int],
    DeadLetterConfig: NotRequired[DeadLetterConfigTypeDef],  # (1)
    OnPartialBatchItemFailure: NotRequired[OnPartialBatchItemFailureStreamsType],  # (2)
    MaximumBatchingWindowInSeconds: NotRequired[int],
    MaximumRecordAgeInSeconds: NotRequired[int],
    MaximumRetryAttempts: NotRequired[int],
    ParallelizationFactor: NotRequired[int],
  1. See DeadLetterConfigTypeDef
  2. See OnPartialBatchItemFailureStreamsType
  3. See DynamoDBStreamStartPositionType

PipeSourceKinesisStreamParametersOutputTypeDef#

# PipeSourceKinesisStreamParametersOutputTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeSourceKinesisStreamParametersOutputTypeDef


def get_value() -> PipeSourceKinesisStreamParametersOutputTypeDef:
    return {
        "BatchSize": ...,
    }


# PipeSourceKinesisStreamParametersOutputTypeDef definition

class PipeSourceKinesisStreamParametersOutputTypeDef(TypedDict):
    StartingPosition: KinesisStreamStartPositionType,  # (3)
    BatchSize: NotRequired[int],
    DeadLetterConfig: NotRequired[DeadLetterConfigTypeDef],  # (1)
    OnPartialBatchItemFailure: NotRequired[OnPartialBatchItemFailureStreamsType],  # (2)
    MaximumBatchingWindowInSeconds: NotRequired[int],
    MaximumRecordAgeInSeconds: NotRequired[int],
    MaximumRetryAttempts: NotRequired[int],
    ParallelizationFactor: NotRequired[int],
    StartingPositionTimestamp: NotRequired[datetime],
  1. See DeadLetterConfigTypeDef
  2. See OnPartialBatchItemFailureStreamsType
  3. See KinesisStreamStartPositionType

UpdatePipeSourceDynamoDBStreamParametersTypeDef#

# UpdatePipeSourceDynamoDBStreamParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import UpdatePipeSourceDynamoDBStreamParametersTypeDef


def get_value() -> UpdatePipeSourceDynamoDBStreamParametersTypeDef:
    return {
        "BatchSize": ...,
    }


# UpdatePipeSourceDynamoDBStreamParametersTypeDef definition

class UpdatePipeSourceDynamoDBStreamParametersTypeDef(TypedDict):
    BatchSize: NotRequired[int],
    DeadLetterConfig: NotRequired[DeadLetterConfigTypeDef],  # (1)
    OnPartialBatchItemFailure: NotRequired[OnPartialBatchItemFailureStreamsType],  # (2)
    MaximumBatchingWindowInSeconds: NotRequired[int],
    MaximumRecordAgeInSeconds: NotRequired[int],
    MaximumRetryAttempts: NotRequired[int],
    ParallelizationFactor: NotRequired[int],
  1. See DeadLetterConfigTypeDef
  2. See OnPartialBatchItemFailureStreamsType

UpdatePipeSourceKinesisStreamParametersTypeDef#

# UpdatePipeSourceKinesisStreamParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import UpdatePipeSourceKinesisStreamParametersTypeDef


def get_value() -> UpdatePipeSourceKinesisStreamParametersTypeDef:
    return {
        "BatchSize": ...,
    }


# UpdatePipeSourceKinesisStreamParametersTypeDef definition

class UpdatePipeSourceKinesisStreamParametersTypeDef(TypedDict):
    BatchSize: NotRequired[int],
    DeadLetterConfig: NotRequired[DeadLetterConfigTypeDef],  # (1)
    OnPartialBatchItemFailure: NotRequired[OnPartialBatchItemFailureStreamsType],  # (2)
    MaximumBatchingWindowInSeconds: NotRequired[int],
    MaximumRecordAgeInSeconds: NotRequired[int],
    MaximumRetryAttempts: NotRequired[int],
    ParallelizationFactor: NotRequired[int],
  1. See DeadLetterConfigTypeDef
  2. See OnPartialBatchItemFailureStreamsType

EcsContainerOverrideOutputTypeDef#

# EcsContainerOverrideOutputTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import EcsContainerOverrideOutputTypeDef


def get_value() -> EcsContainerOverrideOutputTypeDef:
    return {
        "Command": ...,
    }


# EcsContainerOverrideOutputTypeDef definition

class EcsContainerOverrideOutputTypeDef(TypedDict):
    Command: NotRequired[List[str]],
    Cpu: NotRequired[int],
    Environment: NotRequired[List[EcsEnvironmentVariableTypeDef]],  # (1)
    EnvironmentFiles: NotRequired[List[EcsEnvironmentFileTypeDef]],  # (2)
    Memory: NotRequired[int],
    MemoryReservation: NotRequired[int],
    Name: NotRequired[str],
    ResourceRequirements: NotRequired[List[EcsResourceRequirementTypeDef]],  # (3)
  1. See EcsEnvironmentVariableTypeDef
  2. See EcsEnvironmentFileTypeDef
  3. See EcsResourceRequirementTypeDef

EcsContainerOverrideTypeDef#

# EcsContainerOverrideTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import EcsContainerOverrideTypeDef


def get_value() -> EcsContainerOverrideTypeDef:
    return {
        "Command": ...,
    }


# EcsContainerOverrideTypeDef definition

class EcsContainerOverrideTypeDef(TypedDict):
    Command: NotRequired[Sequence[str]],
    Cpu: NotRequired[int],
    Environment: NotRequired[Sequence[EcsEnvironmentVariableTypeDef]],  # (1)
    EnvironmentFiles: NotRequired[Sequence[EcsEnvironmentFileTypeDef]],  # (2)
    Memory: NotRequired[int],
    MemoryReservation: NotRequired[int],
    Name: NotRequired[str],
    ResourceRequirements: NotRequired[Sequence[EcsResourceRequirementTypeDef]],  # (3)
  1. See EcsEnvironmentVariableTypeDef
  2. See EcsEnvironmentFileTypeDef
  3. See EcsResourceRequirementTypeDef

FilterCriteriaOutputTypeDef#

# FilterCriteriaOutputTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import FilterCriteriaOutputTypeDef


def get_value() -> FilterCriteriaOutputTypeDef:
    return {
        "Filters": ...,
    }


# FilterCriteriaOutputTypeDef definition

class FilterCriteriaOutputTypeDef(TypedDict):
    Filters: NotRequired[List[FilterTypeDef]],  # (1)
  1. See FilterTypeDef

FilterCriteriaTypeDef#

# FilterCriteriaTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import FilterCriteriaTypeDef


def get_value() -> FilterCriteriaTypeDef:
    return {
        "Filters": ...,
    }


# FilterCriteriaTypeDef definition

class FilterCriteriaTypeDef(TypedDict):
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
  1. See FilterTypeDef

ListPipesRequestPaginateTypeDef#

# ListPipesRequestPaginateTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import ListPipesRequestPaginateTypeDef


def get_value() -> ListPipesRequestPaginateTypeDef:
    return {
        "NamePrefix": ...,
    }


# ListPipesRequestPaginateTypeDef definition

class ListPipesRequestPaginateTypeDef(TypedDict):
    NamePrefix: NotRequired[str],
    DesiredState: NotRequired[RequestedPipeStateType],  # (1)
    CurrentState: NotRequired[PipeStateType],  # (2)
    SourcePrefix: NotRequired[str],
    TargetPrefix: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See RequestedPipeStateType
  2. See PipeStateType
  3. See PaginatorConfigTypeDef

ListPipesResponseTypeDef#

# ListPipesResponseTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import ListPipesResponseTypeDef


def get_value() -> ListPipesResponseTypeDef:
    return {
        "Pipes": ...,
    }


# ListPipesResponseTypeDef definition

class ListPipesResponseTypeDef(TypedDict):
    Pipes: List[PipeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See PipeTypeDef
  2. See ResponseMetadataTypeDef

PipeSourceActiveMQBrokerParametersTypeDef#

# PipeSourceActiveMQBrokerParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeSourceActiveMQBrokerParametersTypeDef


def get_value() -> PipeSourceActiveMQBrokerParametersTypeDef:
    return {
        "Credentials": ...,
    }


# PipeSourceActiveMQBrokerParametersTypeDef definition

class PipeSourceActiveMQBrokerParametersTypeDef(TypedDict):
    Credentials: MQBrokerAccessCredentialsTypeDef,  # (1)
    QueueName: str,
    BatchSize: NotRequired[int],
    MaximumBatchingWindowInSeconds: NotRequired[int],
  1. See MQBrokerAccessCredentialsTypeDef

PipeSourceRabbitMQBrokerParametersTypeDef#

# PipeSourceRabbitMQBrokerParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeSourceRabbitMQBrokerParametersTypeDef


def get_value() -> PipeSourceRabbitMQBrokerParametersTypeDef:
    return {
        "Credentials": ...,
    }


# PipeSourceRabbitMQBrokerParametersTypeDef definition

class PipeSourceRabbitMQBrokerParametersTypeDef(TypedDict):
    Credentials: MQBrokerAccessCredentialsTypeDef,  # (1)
    QueueName: str,
    VirtualHost: NotRequired[str],
    BatchSize: NotRequired[int],
    MaximumBatchingWindowInSeconds: NotRequired[int],
  1. See MQBrokerAccessCredentialsTypeDef

UpdatePipeSourceActiveMQBrokerParametersTypeDef#

# UpdatePipeSourceActiveMQBrokerParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import UpdatePipeSourceActiveMQBrokerParametersTypeDef


def get_value() -> UpdatePipeSourceActiveMQBrokerParametersTypeDef:
    return {
        "Credentials": ...,
    }


# UpdatePipeSourceActiveMQBrokerParametersTypeDef definition

class UpdatePipeSourceActiveMQBrokerParametersTypeDef(TypedDict):
    Credentials: MQBrokerAccessCredentialsTypeDef,  # (1)
    BatchSize: NotRequired[int],
    MaximumBatchingWindowInSeconds: NotRequired[int],
  1. See MQBrokerAccessCredentialsTypeDef

UpdatePipeSourceRabbitMQBrokerParametersTypeDef#

# UpdatePipeSourceRabbitMQBrokerParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import UpdatePipeSourceRabbitMQBrokerParametersTypeDef


def get_value() -> UpdatePipeSourceRabbitMQBrokerParametersTypeDef:
    return {
        "Credentials": ...,
    }


# UpdatePipeSourceRabbitMQBrokerParametersTypeDef definition

class UpdatePipeSourceRabbitMQBrokerParametersTypeDef(TypedDict):
    Credentials: MQBrokerAccessCredentialsTypeDef,  # (1)
    BatchSize: NotRequired[int],
    MaximumBatchingWindowInSeconds: NotRequired[int],
  1. See MQBrokerAccessCredentialsTypeDef

PipeSourceManagedStreamingKafkaParametersTypeDef#

# PipeSourceManagedStreamingKafkaParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeSourceManagedStreamingKafkaParametersTypeDef


def get_value() -> PipeSourceManagedStreamingKafkaParametersTypeDef:
    return {
        "TopicName": ...,
    }


# PipeSourceManagedStreamingKafkaParametersTypeDef definition

class PipeSourceManagedStreamingKafkaParametersTypeDef(TypedDict):
    TopicName: str,
    StartingPosition: NotRequired[MSKStartPositionType],  # (1)
    BatchSize: NotRequired[int],
    MaximumBatchingWindowInSeconds: NotRequired[int],
    ConsumerGroupID: NotRequired[str],
    Credentials: NotRequired[MSKAccessCredentialsTypeDef],  # (2)
  1. See MSKStartPositionType
  2. See MSKAccessCredentialsTypeDef

UpdatePipeSourceManagedStreamingKafkaParametersTypeDef#

# UpdatePipeSourceManagedStreamingKafkaParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import UpdatePipeSourceManagedStreamingKafkaParametersTypeDef


def get_value() -> UpdatePipeSourceManagedStreamingKafkaParametersTypeDef:
    return {
        "BatchSize": ...,
    }


# UpdatePipeSourceManagedStreamingKafkaParametersTypeDef definition

class UpdatePipeSourceManagedStreamingKafkaParametersTypeDef(TypedDict):
    BatchSize: NotRequired[int],
    Credentials: NotRequired[MSKAccessCredentialsTypeDef],  # (1)
    MaximumBatchingWindowInSeconds: NotRequired[int],
  1. See MSKAccessCredentialsTypeDef

MultiMeasureMappingOutputTypeDef#

# MultiMeasureMappingOutputTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import MultiMeasureMappingOutputTypeDef


def get_value() -> MultiMeasureMappingOutputTypeDef:
    return {
        "MultiMeasureName": ...,
    }


# MultiMeasureMappingOutputTypeDef definition

class MultiMeasureMappingOutputTypeDef(TypedDict):
    MultiMeasureName: str,
    MultiMeasureAttributeMappings: List[MultiMeasureAttributeMappingTypeDef],  # (1)
  1. See MultiMeasureAttributeMappingTypeDef

MultiMeasureMappingTypeDef#

# MultiMeasureMappingTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import MultiMeasureMappingTypeDef


def get_value() -> MultiMeasureMappingTypeDef:
    return {
        "MultiMeasureName": ...,
    }


# MultiMeasureMappingTypeDef definition

class MultiMeasureMappingTypeDef(TypedDict):
    MultiMeasureName: str,
    MultiMeasureAttributeMappings: Sequence[MultiMeasureAttributeMappingTypeDef],  # (1)
  1. See MultiMeasureAttributeMappingTypeDef

PipeEnrichmentParametersOutputTypeDef#

# PipeEnrichmentParametersOutputTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeEnrichmentParametersOutputTypeDef


def get_value() -> PipeEnrichmentParametersOutputTypeDef:
    return {
        "InputTemplate": ...,
    }


# PipeEnrichmentParametersOutputTypeDef definition

class PipeEnrichmentParametersOutputTypeDef(TypedDict):
    InputTemplate: NotRequired[str],
    HttpParameters: NotRequired[PipeEnrichmentHttpParametersOutputTypeDef],  # (1)
  1. See PipeEnrichmentHttpParametersOutputTypeDef

PipeEnrichmentParametersTypeDef#

# PipeEnrichmentParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeEnrichmentParametersTypeDef


def get_value() -> PipeEnrichmentParametersTypeDef:
    return {
        "InputTemplate": ...,
    }


# PipeEnrichmentParametersTypeDef definition

class PipeEnrichmentParametersTypeDef(TypedDict):
    InputTemplate: NotRequired[str],
    HttpParameters: NotRequired[PipeEnrichmentHttpParametersTypeDef],  # (1)
  1. See PipeEnrichmentHttpParametersTypeDef

PipeLogConfigurationParametersTypeDef#

# PipeLogConfigurationParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeLogConfigurationParametersTypeDef


def get_value() -> PipeLogConfigurationParametersTypeDef:
    return {
        "S3LogDestination": ...,
    }


# PipeLogConfigurationParametersTypeDef definition

class PipeLogConfigurationParametersTypeDef(TypedDict):
    Level: LogLevelType,  # (4)
    S3LogDestination: NotRequired[S3LogDestinationParametersTypeDef],  # (1)
    FirehoseLogDestination: NotRequired[FirehoseLogDestinationParametersTypeDef],  # (2)
    CloudwatchLogsLogDestination: NotRequired[CloudwatchLogsLogDestinationParametersTypeDef],  # (3)
    IncludeExecutionData: NotRequired[Sequence[IncludeExecutionDataOptionType]],  # (5)
  1. See S3LogDestinationParametersTypeDef
  2. See FirehoseLogDestinationParametersTypeDef
  3. See CloudwatchLogsLogDestinationParametersTypeDef
  4. See LogLevelType
  5. See IncludeExecutionDataOptionType

PipeLogConfigurationTypeDef#

# PipeLogConfigurationTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeLogConfigurationTypeDef


def get_value() -> PipeLogConfigurationTypeDef:
    return {
        "S3LogDestination": ...,
    }


# PipeLogConfigurationTypeDef definition

class PipeLogConfigurationTypeDef(TypedDict):
    S3LogDestination: NotRequired[S3LogDestinationTypeDef],  # (1)
    FirehoseLogDestination: NotRequired[FirehoseLogDestinationTypeDef],  # (2)
    CloudwatchLogsLogDestination: NotRequired[CloudwatchLogsLogDestinationTypeDef],  # (3)
    Level: NotRequired[LogLevelType],  # (4)
    IncludeExecutionData: NotRequired[List[IncludeExecutionDataOptionType]],  # (5)
  1. See S3LogDestinationTypeDef
  2. See FirehoseLogDestinationTypeDef
  3. See CloudwatchLogsLogDestinationTypeDef
  4. See LogLevelType
  5. See IncludeExecutionDataOptionType

PipeSourceKinesisStreamParametersTypeDef#

# PipeSourceKinesisStreamParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeSourceKinesisStreamParametersTypeDef


def get_value() -> PipeSourceKinesisStreamParametersTypeDef:
    return {
        "BatchSize": ...,
    }


# PipeSourceKinesisStreamParametersTypeDef definition

class PipeSourceKinesisStreamParametersTypeDef(TypedDict):
    StartingPosition: KinesisStreamStartPositionType,  # (3)
    BatchSize: NotRequired[int],
    DeadLetterConfig: NotRequired[DeadLetterConfigTypeDef],  # (1)
    OnPartialBatchItemFailure: NotRequired[OnPartialBatchItemFailureStreamsType],  # (2)
    MaximumBatchingWindowInSeconds: NotRequired[int],
    MaximumRecordAgeInSeconds: NotRequired[int],
    MaximumRetryAttempts: NotRequired[int],
    ParallelizationFactor: NotRequired[int],
    StartingPositionTimestamp: NotRequired[TimestampTypeDef],
  1. See DeadLetterConfigTypeDef
  2. See OnPartialBatchItemFailureStreamsType
  3. See KinesisStreamStartPositionType

PipeSourceSelfManagedKafkaParametersOutputTypeDef#

# PipeSourceSelfManagedKafkaParametersOutputTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeSourceSelfManagedKafkaParametersOutputTypeDef


def get_value() -> PipeSourceSelfManagedKafkaParametersOutputTypeDef:
    return {
        "TopicName": ...,
    }


# PipeSourceSelfManagedKafkaParametersOutputTypeDef definition

class PipeSourceSelfManagedKafkaParametersOutputTypeDef(TypedDict):
    TopicName: str,
    StartingPosition: NotRequired[SelfManagedKafkaStartPositionType],  # (1)
    AdditionalBootstrapServers: NotRequired[List[str]],
    BatchSize: NotRequired[int],
    MaximumBatchingWindowInSeconds: NotRequired[int],
    ConsumerGroupID: NotRequired[str],
    Credentials: NotRequired[SelfManagedKafkaAccessConfigurationCredentialsTypeDef],  # (2)
    ServerRootCaCertificate: NotRequired[str],
    Vpc: NotRequired[SelfManagedKafkaAccessConfigurationVpcOutputTypeDef],  # (3)
  1. See SelfManagedKafkaStartPositionType
  2. See SelfManagedKafkaAccessConfigurationCredentialsTypeDef
  3. See SelfManagedKafkaAccessConfigurationVpcOutputTypeDef

PipeSourceSelfManagedKafkaParametersTypeDef#

# PipeSourceSelfManagedKafkaParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeSourceSelfManagedKafkaParametersTypeDef


def get_value() -> PipeSourceSelfManagedKafkaParametersTypeDef:
    return {
        "TopicName": ...,
    }


# PipeSourceSelfManagedKafkaParametersTypeDef definition

class PipeSourceSelfManagedKafkaParametersTypeDef(TypedDict):
    TopicName: str,
    StartingPosition: NotRequired[SelfManagedKafkaStartPositionType],  # (1)
    AdditionalBootstrapServers: NotRequired[Sequence[str]],
    BatchSize: NotRequired[int],
    MaximumBatchingWindowInSeconds: NotRequired[int],
    ConsumerGroupID: NotRequired[str],
    Credentials: NotRequired[SelfManagedKafkaAccessConfigurationCredentialsTypeDef],  # (2)
    ServerRootCaCertificate: NotRequired[str],
    Vpc: NotRequired[SelfManagedKafkaAccessConfigurationVpcTypeDef],  # (3)
  1. See SelfManagedKafkaStartPositionType
  2. See SelfManagedKafkaAccessConfigurationCredentialsTypeDef
  3. See SelfManagedKafkaAccessConfigurationVpcTypeDef

PipeTargetSageMakerPipelineParametersOutputTypeDef#

# PipeTargetSageMakerPipelineParametersOutputTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeTargetSageMakerPipelineParametersOutputTypeDef


def get_value() -> PipeTargetSageMakerPipelineParametersOutputTypeDef:
    return {
        "PipelineParameterList": ...,
    }


# PipeTargetSageMakerPipelineParametersOutputTypeDef definition

class PipeTargetSageMakerPipelineParametersOutputTypeDef(TypedDict):
    PipelineParameterList: NotRequired[List[SageMakerPipelineParameterTypeDef]],  # (1)
  1. See SageMakerPipelineParameterTypeDef

PipeTargetSageMakerPipelineParametersTypeDef#

# PipeTargetSageMakerPipelineParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeTargetSageMakerPipelineParametersTypeDef


def get_value() -> PipeTargetSageMakerPipelineParametersTypeDef:
    return {
        "PipelineParameterList": ...,
    }


# PipeTargetSageMakerPipelineParametersTypeDef definition

class PipeTargetSageMakerPipelineParametersTypeDef(TypedDict):
    PipelineParameterList: NotRequired[Sequence[SageMakerPipelineParameterTypeDef]],  # (1)
  1. See SageMakerPipelineParameterTypeDef

PipeTargetBatchJobParametersOutputTypeDef#

# PipeTargetBatchJobParametersOutputTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeTargetBatchJobParametersOutputTypeDef


def get_value() -> PipeTargetBatchJobParametersOutputTypeDef:
    return {
        "JobDefinition": ...,
    }


# PipeTargetBatchJobParametersOutputTypeDef definition

class PipeTargetBatchJobParametersOutputTypeDef(TypedDict):
    JobDefinition: str,
    JobName: str,
    ArrayProperties: NotRequired[BatchArrayPropertiesTypeDef],  # (1)
    RetryStrategy: NotRequired[BatchRetryStrategyTypeDef],  # (2)
    ContainerOverrides: NotRequired[BatchContainerOverridesOutputTypeDef],  # (3)
    DependsOn: NotRequired[List[BatchJobDependencyTypeDef]],  # (4)
    Parameters: NotRequired[Dict[str, str]],
  1. See BatchArrayPropertiesTypeDef
  2. See BatchRetryStrategyTypeDef
  3. See BatchContainerOverridesOutputTypeDef
  4. See BatchJobDependencyTypeDef

PipeTargetBatchJobParametersTypeDef#

# PipeTargetBatchJobParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeTargetBatchJobParametersTypeDef


def get_value() -> PipeTargetBatchJobParametersTypeDef:
    return {
        "JobDefinition": ...,
    }


# PipeTargetBatchJobParametersTypeDef definition

class PipeTargetBatchJobParametersTypeDef(TypedDict):
    JobDefinition: str,
    JobName: str,
    ArrayProperties: NotRequired[BatchArrayPropertiesTypeDef],  # (1)
    RetryStrategy: NotRequired[BatchRetryStrategyTypeDef],  # (2)
    ContainerOverrides: NotRequired[BatchContainerOverridesTypeDef],  # (3)
    DependsOn: NotRequired[Sequence[BatchJobDependencyTypeDef]],  # (4)
    Parameters: NotRequired[Mapping[str, str]],
  1. See BatchArrayPropertiesTypeDef
  2. See BatchRetryStrategyTypeDef
  3. See BatchContainerOverridesTypeDef
  4. See BatchJobDependencyTypeDef

EcsTaskOverrideOutputTypeDef#

# EcsTaskOverrideOutputTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import EcsTaskOverrideOutputTypeDef


def get_value() -> EcsTaskOverrideOutputTypeDef:
    return {
        "ContainerOverrides": ...,
    }


# EcsTaskOverrideOutputTypeDef definition

class EcsTaskOverrideOutputTypeDef(TypedDict):
    ContainerOverrides: NotRequired[List[EcsContainerOverrideOutputTypeDef]],  # (1)
    Cpu: NotRequired[str],
    EphemeralStorage: NotRequired[EcsEphemeralStorageTypeDef],  # (2)
    ExecutionRoleArn: NotRequired[str],
    InferenceAcceleratorOverrides: NotRequired[List[EcsInferenceAcceleratorOverrideTypeDef]],  # (3)
    Memory: NotRequired[str],
    TaskRoleArn: NotRequired[str],
  1. See EcsContainerOverrideOutputTypeDef
  2. See EcsEphemeralStorageTypeDef
  3. See EcsInferenceAcceleratorOverrideTypeDef

EcsTaskOverrideTypeDef#

# EcsTaskOverrideTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import EcsTaskOverrideTypeDef


def get_value() -> EcsTaskOverrideTypeDef:
    return {
        "ContainerOverrides": ...,
    }


# EcsTaskOverrideTypeDef definition

class EcsTaskOverrideTypeDef(TypedDict):
    ContainerOverrides: NotRequired[Sequence[EcsContainerOverrideTypeDef]],  # (1)
    Cpu: NotRequired[str],
    EphemeralStorage: NotRequired[EcsEphemeralStorageTypeDef],  # (2)
    ExecutionRoleArn: NotRequired[str],
    InferenceAcceleratorOverrides: NotRequired[Sequence[EcsInferenceAcceleratorOverrideTypeDef]],  # (3)
    Memory: NotRequired[str],
    TaskRoleArn: NotRequired[str],
  1. See EcsContainerOverrideTypeDef
  2. See EcsEphemeralStorageTypeDef
  3. See EcsInferenceAcceleratorOverrideTypeDef

PipeTargetTimestreamParametersOutputTypeDef#

# PipeTargetTimestreamParametersOutputTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeTargetTimestreamParametersOutputTypeDef


def get_value() -> PipeTargetTimestreamParametersOutputTypeDef:
    return {
        "TimeValue": ...,
    }


# PipeTargetTimestreamParametersOutputTypeDef definition

class PipeTargetTimestreamParametersOutputTypeDef(TypedDict):
    TimeValue: str,
    VersionValue: str,
    DimensionMappings: List[DimensionMappingTypeDef],  # (3)
    EpochTimeUnit: NotRequired[EpochTimeUnitType],  # (1)
    TimeFieldType: NotRequired[TimeFieldTypeType],  # (2)
    TimestampFormat: NotRequired[str],
    SingleMeasureMappings: NotRequired[List[SingleMeasureMappingTypeDef]],  # (4)
    MultiMeasureMappings: NotRequired[List[MultiMeasureMappingOutputTypeDef]],  # (5)
  1. See EpochTimeUnitType
  2. See TimeFieldTypeType
  3. See DimensionMappingTypeDef
  4. See SingleMeasureMappingTypeDef
  5. See MultiMeasureMappingOutputTypeDef

PipeTargetTimestreamParametersTypeDef#

# PipeTargetTimestreamParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeTargetTimestreamParametersTypeDef


def get_value() -> PipeTargetTimestreamParametersTypeDef:
    return {
        "TimeValue": ...,
    }


# PipeTargetTimestreamParametersTypeDef definition

class PipeTargetTimestreamParametersTypeDef(TypedDict):
    TimeValue: str,
    VersionValue: str,
    DimensionMappings: Sequence[DimensionMappingTypeDef],  # (3)
    EpochTimeUnit: NotRequired[EpochTimeUnitType],  # (1)
    TimeFieldType: NotRequired[TimeFieldTypeType],  # (2)
    TimestampFormat: NotRequired[str],
    SingleMeasureMappings: NotRequired[Sequence[SingleMeasureMappingTypeDef]],  # (4)
    MultiMeasureMappings: NotRequired[Sequence[MultiMeasureMappingTypeDef]],  # (5)
  1. See EpochTimeUnitType
  2. See TimeFieldTypeType
  3. See DimensionMappingTypeDef
  4. See SingleMeasureMappingTypeDef
  5. See MultiMeasureMappingTypeDef

PipeSourceParametersOutputTypeDef#

# PipeSourceParametersOutputTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeSourceParametersOutputTypeDef


def get_value() -> PipeSourceParametersOutputTypeDef:
    return {
        "FilterCriteria": ...,
    }


# PipeSourceParametersOutputTypeDef definition

class PipeSourceParametersOutputTypeDef(TypedDict):
    FilterCriteria: NotRequired[FilterCriteriaOutputTypeDef],  # (1)
    KinesisStreamParameters: NotRequired[PipeSourceKinesisStreamParametersOutputTypeDef],  # (2)
    DynamoDBStreamParameters: NotRequired[PipeSourceDynamoDBStreamParametersTypeDef],  # (3)
    SqsQueueParameters: NotRequired[PipeSourceSqsQueueParametersTypeDef],  # (4)
    ActiveMQBrokerParameters: NotRequired[PipeSourceActiveMQBrokerParametersTypeDef],  # (5)
    RabbitMQBrokerParameters: NotRequired[PipeSourceRabbitMQBrokerParametersTypeDef],  # (6)
    ManagedStreamingKafkaParameters: NotRequired[PipeSourceManagedStreamingKafkaParametersTypeDef],  # (7)
    SelfManagedKafkaParameters: NotRequired[PipeSourceSelfManagedKafkaParametersOutputTypeDef],  # (8)
  1. See FilterCriteriaOutputTypeDef
  2. See PipeSourceKinesisStreamParametersOutputTypeDef
  3. See PipeSourceDynamoDBStreamParametersTypeDef
  4. See PipeSourceSqsQueueParametersTypeDef
  5. See PipeSourceActiveMQBrokerParametersTypeDef
  6. See PipeSourceRabbitMQBrokerParametersTypeDef
  7. See PipeSourceManagedStreamingKafkaParametersTypeDef
  8. See PipeSourceSelfManagedKafkaParametersOutputTypeDef

PipeSourceParametersTypeDef#

# PipeSourceParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeSourceParametersTypeDef


def get_value() -> PipeSourceParametersTypeDef:
    return {
        "FilterCriteria": ...,
    }


# PipeSourceParametersTypeDef definition

class PipeSourceParametersTypeDef(TypedDict):
    FilterCriteria: NotRequired[FilterCriteriaTypeDef],  # (1)
    KinesisStreamParameters: NotRequired[PipeSourceKinesisStreamParametersTypeDef],  # (2)
    DynamoDBStreamParameters: NotRequired[PipeSourceDynamoDBStreamParametersTypeDef],  # (3)
    SqsQueueParameters: NotRequired[PipeSourceSqsQueueParametersTypeDef],  # (4)
    ActiveMQBrokerParameters: NotRequired[PipeSourceActiveMQBrokerParametersTypeDef],  # (5)
    RabbitMQBrokerParameters: NotRequired[PipeSourceRabbitMQBrokerParametersTypeDef],  # (6)
    ManagedStreamingKafkaParameters: NotRequired[PipeSourceManagedStreamingKafkaParametersTypeDef],  # (7)
    SelfManagedKafkaParameters: NotRequired[PipeSourceSelfManagedKafkaParametersTypeDef],  # (8)
  1. See FilterCriteriaTypeDef
  2. See PipeSourceKinesisStreamParametersTypeDef
  3. See PipeSourceDynamoDBStreamParametersTypeDef
  4. See PipeSourceSqsQueueParametersTypeDef
  5. See PipeSourceActiveMQBrokerParametersTypeDef
  6. See PipeSourceRabbitMQBrokerParametersTypeDef
  7. See PipeSourceManagedStreamingKafkaParametersTypeDef
  8. See PipeSourceSelfManagedKafkaParametersTypeDef

UpdatePipeSourceSelfManagedKafkaParametersTypeDef#

# UpdatePipeSourceSelfManagedKafkaParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import UpdatePipeSourceSelfManagedKafkaParametersTypeDef


def get_value() -> UpdatePipeSourceSelfManagedKafkaParametersTypeDef:
    return {
        "BatchSize": ...,
    }


# UpdatePipeSourceSelfManagedKafkaParametersTypeDef definition

class UpdatePipeSourceSelfManagedKafkaParametersTypeDef(TypedDict):
    BatchSize: NotRequired[int],
    MaximumBatchingWindowInSeconds: NotRequired[int],
    Credentials: NotRequired[SelfManagedKafkaAccessConfigurationCredentialsTypeDef],  # (1)
    ServerRootCaCertificate: NotRequired[str],
    Vpc: NotRequired[SelfManagedKafkaAccessConfigurationVpcUnionTypeDef],  # (2)
  1. See SelfManagedKafkaAccessConfigurationCredentialsTypeDef
  2. See SelfManagedKafkaAccessConfigurationVpcTypeDef SelfManagedKafkaAccessConfigurationVpcOutputTypeDef

PipeTargetEcsTaskParametersOutputTypeDef#

# PipeTargetEcsTaskParametersOutputTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeTargetEcsTaskParametersOutputTypeDef


def get_value() -> PipeTargetEcsTaskParametersOutputTypeDef:
    return {
        "TaskDefinitionArn": ...,
    }


# PipeTargetEcsTaskParametersOutputTypeDef definition

class PipeTargetEcsTaskParametersOutputTypeDef(TypedDict):
    TaskDefinitionArn: str,
    TaskCount: NotRequired[int],
    LaunchType: NotRequired[LaunchTypeType],  # (1)
    NetworkConfiguration: NotRequired[NetworkConfigurationOutputTypeDef],  # (2)
    PlatformVersion: NotRequired[str],
    Group: NotRequired[str],
    CapacityProviderStrategy: NotRequired[List[CapacityProviderStrategyItemTypeDef]],  # (3)
    EnableECSManagedTags: NotRequired[bool],
    EnableExecuteCommand: NotRequired[bool],
    PlacementConstraints: NotRequired[List[PlacementConstraintTypeDef]],  # (4)
    PlacementStrategy: NotRequired[List[PlacementStrategyTypeDef]],  # (5)
    PropagateTags: NotRequired[PropagateTagsType],  # (6)
    ReferenceId: NotRequired[str],
    Overrides: NotRequired[EcsTaskOverrideOutputTypeDef],  # (7)
    Tags: NotRequired[List[TagTypeDef]],  # (8)
  1. See LaunchTypeType
  2. See NetworkConfigurationOutputTypeDef
  3. See CapacityProviderStrategyItemTypeDef
  4. See PlacementConstraintTypeDef
  5. See PlacementStrategyTypeDef
  6. See PropagateTagsType
  7. See EcsTaskOverrideOutputTypeDef
  8. See TagTypeDef

PipeTargetEcsTaskParametersTypeDef#

# PipeTargetEcsTaskParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeTargetEcsTaskParametersTypeDef


def get_value() -> PipeTargetEcsTaskParametersTypeDef:
    return {
        "TaskDefinitionArn": ...,
    }


# PipeTargetEcsTaskParametersTypeDef definition

class PipeTargetEcsTaskParametersTypeDef(TypedDict):
    TaskDefinitionArn: str,
    TaskCount: NotRequired[int],
    LaunchType: NotRequired[LaunchTypeType],  # (1)
    NetworkConfiguration: NotRequired[NetworkConfigurationTypeDef],  # (2)
    PlatformVersion: NotRequired[str],
    Group: NotRequired[str],
    CapacityProviderStrategy: NotRequired[Sequence[CapacityProviderStrategyItemTypeDef]],  # (3)
    EnableECSManagedTags: NotRequired[bool],
    EnableExecuteCommand: NotRequired[bool],
    PlacementConstraints: NotRequired[Sequence[PlacementConstraintTypeDef]],  # (4)
    PlacementStrategy: NotRequired[Sequence[PlacementStrategyTypeDef]],  # (5)
    PropagateTags: NotRequired[PropagateTagsType],  # (6)
    ReferenceId: NotRequired[str],
    Overrides: NotRequired[EcsTaskOverrideTypeDef],  # (7)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (8)
  1. See LaunchTypeType
  2. See NetworkConfigurationTypeDef
  3. See CapacityProviderStrategyItemTypeDef
  4. See PlacementConstraintTypeDef
  5. See PlacementStrategyTypeDef
  6. See PropagateTagsType
  7. See EcsTaskOverrideTypeDef
  8. See TagTypeDef

UpdatePipeSourceParametersTypeDef#

# UpdatePipeSourceParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import UpdatePipeSourceParametersTypeDef


def get_value() -> UpdatePipeSourceParametersTypeDef:
    return {
        "FilterCriteria": ...,
    }


# UpdatePipeSourceParametersTypeDef definition

class UpdatePipeSourceParametersTypeDef(TypedDict):
    FilterCriteria: NotRequired[FilterCriteriaUnionTypeDef],  # (1)
    KinesisStreamParameters: NotRequired[UpdatePipeSourceKinesisStreamParametersTypeDef],  # (2)
    DynamoDBStreamParameters: NotRequired[UpdatePipeSourceDynamoDBStreamParametersTypeDef],  # (3)
    SqsQueueParameters: NotRequired[UpdatePipeSourceSqsQueueParametersTypeDef],  # (4)
    ActiveMQBrokerParameters: NotRequired[UpdatePipeSourceActiveMQBrokerParametersTypeDef],  # (5)
    RabbitMQBrokerParameters: NotRequired[UpdatePipeSourceRabbitMQBrokerParametersTypeDef],  # (6)
    ManagedStreamingKafkaParameters: NotRequired[UpdatePipeSourceManagedStreamingKafkaParametersTypeDef],  # (7)
    SelfManagedKafkaParameters: NotRequired[UpdatePipeSourceSelfManagedKafkaParametersTypeDef],  # (8)
  1. See FilterCriteriaTypeDef FilterCriteriaOutputTypeDef
  2. See UpdatePipeSourceKinesisStreamParametersTypeDef
  3. See UpdatePipeSourceDynamoDBStreamParametersTypeDef
  4. See UpdatePipeSourceSqsQueueParametersTypeDef
  5. See UpdatePipeSourceActiveMQBrokerParametersTypeDef
  6. See UpdatePipeSourceRabbitMQBrokerParametersTypeDef
  7. See UpdatePipeSourceManagedStreamingKafkaParametersTypeDef
  8. See UpdatePipeSourceSelfManagedKafkaParametersTypeDef

PipeTargetParametersOutputTypeDef#

# PipeTargetParametersOutputTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeTargetParametersOutputTypeDef


def get_value() -> PipeTargetParametersOutputTypeDef:
    return {
        "InputTemplate": ...,
    }


# PipeTargetParametersOutputTypeDef definition

class PipeTargetParametersOutputTypeDef(TypedDict):
    InputTemplate: NotRequired[str],
    LambdaFunctionParameters: NotRequired[PipeTargetLambdaFunctionParametersTypeDef],  # (1)
    StepFunctionStateMachineParameters: NotRequired[PipeTargetStateMachineParametersTypeDef],  # (2)
    KinesisStreamParameters: NotRequired[PipeTargetKinesisStreamParametersTypeDef],  # (3)
    EcsTaskParameters: NotRequired[PipeTargetEcsTaskParametersOutputTypeDef],  # (4)
    BatchJobParameters: NotRequired[PipeTargetBatchJobParametersOutputTypeDef],  # (5)
    SqsQueueParameters: NotRequired[PipeTargetSqsQueueParametersTypeDef],  # (6)
    HttpParameters: NotRequired[PipeTargetHttpParametersOutputTypeDef],  # (7)
    RedshiftDataParameters: NotRequired[PipeTargetRedshiftDataParametersOutputTypeDef],  # (8)
    SageMakerPipelineParameters: NotRequired[PipeTargetSageMakerPipelineParametersOutputTypeDef],  # (9)
    EventBridgeEventBusParameters: NotRequired[PipeTargetEventBridgeEventBusParametersOutputTypeDef],  # (10)
    CloudWatchLogsParameters: NotRequired[PipeTargetCloudWatchLogsParametersTypeDef],  # (11)
    TimestreamParameters: NotRequired[PipeTargetTimestreamParametersOutputTypeDef],  # (12)
  1. See PipeTargetLambdaFunctionParametersTypeDef
  2. See PipeTargetStateMachineParametersTypeDef
  3. See PipeTargetKinesisStreamParametersTypeDef
  4. See PipeTargetEcsTaskParametersOutputTypeDef
  5. See PipeTargetBatchJobParametersOutputTypeDef
  6. See PipeTargetSqsQueueParametersTypeDef
  7. See PipeTargetHttpParametersOutputTypeDef
  8. See PipeTargetRedshiftDataParametersOutputTypeDef
  9. See PipeTargetSageMakerPipelineParametersOutputTypeDef
  10. See PipeTargetEventBridgeEventBusParametersOutputTypeDef
  11. See PipeTargetCloudWatchLogsParametersTypeDef
  12. See PipeTargetTimestreamParametersOutputTypeDef

PipeTargetParametersTypeDef#

# PipeTargetParametersTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import PipeTargetParametersTypeDef


def get_value() -> PipeTargetParametersTypeDef:
    return {
        "InputTemplate": ...,
    }


# PipeTargetParametersTypeDef definition

class PipeTargetParametersTypeDef(TypedDict):
    InputTemplate: NotRequired[str],
    LambdaFunctionParameters: NotRequired[PipeTargetLambdaFunctionParametersTypeDef],  # (1)
    StepFunctionStateMachineParameters: NotRequired[PipeTargetStateMachineParametersTypeDef],  # (2)
    KinesisStreamParameters: NotRequired[PipeTargetKinesisStreamParametersTypeDef],  # (3)
    EcsTaskParameters: NotRequired[PipeTargetEcsTaskParametersTypeDef],  # (4)
    BatchJobParameters: NotRequired[PipeTargetBatchJobParametersTypeDef],  # (5)
    SqsQueueParameters: NotRequired[PipeTargetSqsQueueParametersTypeDef],  # (6)
    HttpParameters: NotRequired[PipeTargetHttpParametersTypeDef],  # (7)
    RedshiftDataParameters: NotRequired[PipeTargetRedshiftDataParametersTypeDef],  # (8)
    SageMakerPipelineParameters: NotRequired[PipeTargetSageMakerPipelineParametersTypeDef],  # (9)
    EventBridgeEventBusParameters: NotRequired[PipeTargetEventBridgeEventBusParametersTypeDef],  # (10)
    CloudWatchLogsParameters: NotRequired[PipeTargetCloudWatchLogsParametersTypeDef],  # (11)
    TimestreamParameters: NotRequired[PipeTargetTimestreamParametersTypeDef],  # (12)
  1. See PipeTargetLambdaFunctionParametersTypeDef
  2. See PipeTargetStateMachineParametersTypeDef
  3. See PipeTargetKinesisStreamParametersTypeDef
  4. See PipeTargetEcsTaskParametersTypeDef
  5. See PipeTargetBatchJobParametersTypeDef
  6. See PipeTargetSqsQueueParametersTypeDef
  7. See PipeTargetHttpParametersTypeDef
  8. See PipeTargetRedshiftDataParametersTypeDef
  9. See PipeTargetSageMakerPipelineParametersTypeDef
  10. See PipeTargetEventBridgeEventBusParametersTypeDef
  11. See PipeTargetCloudWatchLogsParametersTypeDef
  12. See PipeTargetTimestreamParametersTypeDef

DescribePipeResponseTypeDef#

# DescribePipeResponseTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import DescribePipeResponseTypeDef


def get_value() -> DescribePipeResponseTypeDef:
    return {
        "Arn": ...,
    }


# DescribePipeResponseTypeDef definition

class DescribePipeResponseTypeDef(TypedDict):
    Arn: str,
    Name: str,
    Description: str,
    DesiredState: RequestedPipeStateDescribeResponseType,  # (1)
    CurrentState: PipeStateType,  # (2)
    StateReason: str,
    Source: str,
    SourceParameters: PipeSourceParametersOutputTypeDef,  # (3)
    Enrichment: str,
    EnrichmentParameters: PipeEnrichmentParametersOutputTypeDef,  # (4)
    Target: str,
    TargetParameters: PipeTargetParametersOutputTypeDef,  # (5)
    RoleArn: str,
    Tags: Dict[str, str],
    CreationTime: datetime,
    LastModifiedTime: datetime,
    LogConfiguration: PipeLogConfigurationTypeDef,  # (6)
    KmsKeyIdentifier: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (7)
  1. See RequestedPipeStateDescribeResponseType
  2. See PipeStateType
  3. See PipeSourceParametersOutputTypeDef
  4. See PipeEnrichmentParametersOutputTypeDef
  5. See PipeTargetParametersOutputTypeDef
  6. See PipeLogConfigurationTypeDef
  7. See ResponseMetadataTypeDef

CreatePipeRequestTypeDef#

# CreatePipeRequestTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import CreatePipeRequestTypeDef


def get_value() -> CreatePipeRequestTypeDef:
    return {
        "Name": ...,
    }


# CreatePipeRequestTypeDef definition

class CreatePipeRequestTypeDef(TypedDict):
    Name: str,
    Source: str,
    Target: str,
    RoleArn: str,
    Description: NotRequired[str],
    DesiredState: NotRequired[RequestedPipeStateType],  # (1)
    SourceParameters: NotRequired[PipeSourceParametersUnionTypeDef],  # (2)
    Enrichment: NotRequired[str],
    EnrichmentParameters: NotRequired[PipeEnrichmentParametersUnionTypeDef],  # (3)
    TargetParameters: NotRequired[PipeTargetParametersUnionTypeDef],  # (4)
    Tags: NotRequired[Mapping[str, str]],
    LogConfiguration: NotRequired[PipeLogConfigurationParametersTypeDef],  # (5)
    KmsKeyIdentifier: NotRequired[str],
  1. See RequestedPipeStateType
  2. See PipeSourceParametersTypeDef PipeSourceParametersOutputTypeDef
  3. See PipeEnrichmentParametersTypeDef PipeEnrichmentParametersOutputTypeDef
  4. See PipeTargetParametersTypeDef PipeTargetParametersOutputTypeDef
  5. See PipeLogConfigurationParametersTypeDef

UpdatePipeRequestTypeDef#

# UpdatePipeRequestTypeDef TypedDict usage example

from types_boto3_pipes.type_defs import UpdatePipeRequestTypeDef


def get_value() -> UpdatePipeRequestTypeDef:
    return {
        "Name": ...,
    }


# UpdatePipeRequestTypeDef definition

class UpdatePipeRequestTypeDef(TypedDict):
    Name: str,
    RoleArn: str,
    Description: NotRequired[str],
    DesiredState: NotRequired[RequestedPipeStateType],  # (1)
    SourceParameters: NotRequired[UpdatePipeSourceParametersTypeDef],  # (2)
    Enrichment: NotRequired[str],
    EnrichmentParameters: NotRequired[PipeEnrichmentParametersUnionTypeDef],  # (3)
    Target: NotRequired[str],
    TargetParameters: NotRequired[PipeTargetParametersUnionTypeDef],  # (4)
    LogConfiguration: NotRequired[PipeLogConfigurationParametersTypeDef],  # (5)
    KmsKeyIdentifier: NotRequired[str],
  1. See RequestedPipeStateType
  2. See UpdatePipeSourceParametersTypeDef
  3. See PipeEnrichmentParametersTypeDef PipeEnrichmentParametersOutputTypeDef
  4. See PipeTargetParametersTypeDef PipeTargetParametersOutputTypeDef
  5. See PipeLogConfigurationParametersTypeDef