Skip to content

Type definitions#

Index > EventBridgePipes > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AwsVpcConfigurationTypeDef#

# AwsVpcConfigurationTypeDef definition

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

BatchArrayPropertiesTypeDef#

# BatchArrayPropertiesTypeDef definition

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

BatchEnvironmentVariableTypeDef#

# BatchEnvironmentVariableTypeDef definition

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

BatchResourceRequirementTypeDef#

# BatchResourceRequirementTypeDef definition

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

BatchJobDependencyTypeDef#

# BatchJobDependencyTypeDef definition

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

BatchRetryStrategyTypeDef#

# BatchRetryStrategyTypeDef definition

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

CapacityProviderStrategyItemTypeDef#

# CapacityProviderStrategyItemTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

DeadLetterConfigTypeDef#

# DeadLetterConfigTypeDef definition

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

DeletePipeRequestRequestTypeDef#

# DeletePipeRequestRequestTypeDef definition

class DeletePipeRequestRequestTypeDef(TypedDict):
    Name: str,

DescribePipeRequestRequestTypeDef#

# DescribePipeRequestRequestTypeDef definition

class DescribePipeRequestRequestTypeDef(TypedDict):
    Name: str,

EcsEnvironmentFileTypeDef#

# EcsEnvironmentFileTypeDef definition

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

EcsEnvironmentVariableTypeDef#

# EcsEnvironmentVariableTypeDef definition

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

EcsResourceRequirementTypeDef#

# EcsResourceRequirementTypeDef definition

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

EcsEphemeralStorageTypeDef#

# EcsEphemeralStorageTypeDef definition

class EcsEphemeralStorageTypeDef(TypedDict):
    sizeInGiB: int,

EcsInferenceAcceleratorOverrideTypeDef#

# EcsInferenceAcceleratorOverrideTypeDef definition

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

FilterTypeDef#

# FilterTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListPipesRequestRequestTypeDef#

# ListPipesRequestRequestTypeDef definition

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

PipeTypeDef#

# PipeTypeDef definition

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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

MQBrokerAccessCredentialsTypeDef#

# MQBrokerAccessCredentialsTypeDef definition

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

MSKAccessCredentialsTypeDef#

# MSKAccessCredentialsTypeDef definition

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

PipeEnrichmentHttpParametersTypeDef#

# PipeEnrichmentHttpParametersTypeDef definition

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

PipeSourceSqsQueueParametersTypeDef#

# PipeSourceSqsQueueParametersTypeDef definition

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

SelfManagedKafkaAccessConfigurationCredentialsTypeDef#

# SelfManagedKafkaAccessConfigurationCredentialsTypeDef definition

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

SelfManagedKafkaAccessConfigurationVpcTypeDef#

# SelfManagedKafkaAccessConfigurationVpcTypeDef definition

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

PipeTargetCloudWatchLogsParametersTypeDef#

# PipeTargetCloudWatchLogsParametersTypeDef definition

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

PlacementConstraintTypeDef#

# PlacementConstraintTypeDef definition

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

PlacementStrategyTypeDef#

# PlacementStrategyTypeDef definition

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

TagTypeDef#

# TagTypeDef definition

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

PipeTargetEventBridgeEventBusParametersTypeDef#

# PipeTargetEventBridgeEventBusParametersTypeDef definition

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

PipeTargetHttpParametersTypeDef#

# PipeTargetHttpParametersTypeDef definition

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

PipeTargetKinesisStreamParametersTypeDef#

# PipeTargetKinesisStreamParametersTypeDef definition

class PipeTargetKinesisStreamParametersTypeDef(TypedDict):
    PartitionKey: str,

PipeTargetLambdaFunctionParametersTypeDef#

# PipeTargetLambdaFunctionParametersTypeDef definition

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

PipeTargetRedshiftDataParametersTypeDef#

# PipeTargetRedshiftDataParametersTypeDef definition

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

PipeTargetSqsQueueParametersTypeDef#

# PipeTargetSqsQueueParametersTypeDef definition

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

PipeTargetStateMachineParametersTypeDef#

# PipeTargetStateMachineParametersTypeDef definition

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

SageMakerPipelineParameterTypeDef#

# SageMakerPipelineParameterTypeDef definition

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

StartPipeRequestRequestTypeDef#

# StartPipeRequestRequestTypeDef definition

class StartPipeRequestRequestTypeDef(TypedDict):
    Name: str,

StopPipeRequestRequestTypeDef#

# StopPipeRequestRequestTypeDef definition

class StopPipeRequestRequestTypeDef(TypedDict):
    Name: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

UpdatePipeSourceSqsQueueParametersTypeDef#

# UpdatePipeSourceSqsQueueParametersTypeDef definition

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

NetworkConfigurationTypeDef#

# NetworkConfigurationTypeDef definition

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

BatchContainerOverridesTypeDef#

# 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 definition

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

DeletePipeResponseTypeDef#

# DeletePipeResponseTypeDef definition

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

StartPipeResponseTypeDef#

# StartPipeResponseTypeDef definition

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

StopPipeResponseTypeDef#

# StopPipeResponseTypeDef definition

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

UpdatePipeResponseTypeDef#

# UpdatePipeResponseTypeDef definition

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

PipeSourceDynamoDBStreamParametersTypeDef#

# PipeSourceDynamoDBStreamParametersTypeDef definition

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

UpdatePipeSourceDynamoDBStreamParametersTypeDef#

# UpdatePipeSourceDynamoDBStreamParametersTypeDef definition

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

UpdatePipeSourceKinesisStreamParametersTypeDef#

# UpdatePipeSourceKinesisStreamParametersTypeDef definition

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

EcsContainerOverrideTypeDef#

# 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

FilterCriteriaTypeDef#

# FilterCriteriaTypeDef definition

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

ListPipesRequestListPipesPaginateTypeDef#

# ListPipesRequestListPipesPaginateTypeDef definition

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

ListPipesResponseTypeDef#

# ListPipesResponseTypeDef definition

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

PipeSourceActiveMQBrokerParametersTypeDef#

# PipeSourceActiveMQBrokerParametersTypeDef definition

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

PipeSourceRabbitMQBrokerParametersTypeDef#

# PipeSourceRabbitMQBrokerParametersTypeDef definition

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

UpdatePipeSourceActiveMQBrokerParametersTypeDef#

# UpdatePipeSourceActiveMQBrokerParametersTypeDef definition

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

UpdatePipeSourceRabbitMQBrokerParametersTypeDef#

# UpdatePipeSourceRabbitMQBrokerParametersTypeDef definition

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

PipeSourceManagedStreamingKafkaParametersTypeDef#

# PipeSourceManagedStreamingKafkaParametersTypeDef definition

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

UpdatePipeSourceManagedStreamingKafkaParametersTypeDef#

# UpdatePipeSourceManagedStreamingKafkaParametersTypeDef definition

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

PipeEnrichmentParametersTypeDef#

# PipeEnrichmentParametersTypeDef definition

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

PipeSourceKinesisStreamParametersTypeDef#

# PipeSourceKinesisStreamParametersTypeDef definition

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

PipeSourceSelfManagedKafkaParametersTypeDef#

# PipeSourceSelfManagedKafkaParametersTypeDef definition

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

UpdatePipeSourceSelfManagedKafkaParametersTypeDef#

# UpdatePipeSourceSelfManagedKafkaParametersTypeDef definition

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

PipeTargetSageMakerPipelineParametersTypeDef#

# PipeTargetSageMakerPipelineParametersTypeDef definition

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

PipeTargetBatchJobParametersTypeDef#

# PipeTargetBatchJobParametersTypeDef definition

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

EcsTaskOverrideTypeDef#

# 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

PipeSourceParametersTypeDef#

# PipeSourceParametersTypeDef definition

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

UpdatePipeSourceParametersTypeDef#

# UpdatePipeSourceParametersTypeDef definition

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

PipeTargetEcsTaskParametersTypeDef#

# PipeTargetEcsTaskParametersTypeDef definition

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

PipeTargetParametersTypeDef#

# PipeTargetParametersTypeDef definition

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

CreatePipeRequestRequestTypeDef#

# CreatePipeRequestRequestTypeDef definition

class CreatePipeRequestRequestTypeDef(TypedDict):
    Name: str,
    RoleArn: str,
    Source: str,
    Target: str,
    Description: NotRequired[str],
    DesiredState: NotRequired[RequestedPipeStateType],  # (1)
    Enrichment: NotRequired[str],
    EnrichmentParameters: NotRequired[PipeEnrichmentParametersTypeDef],  # (2)
    SourceParameters: NotRequired[PipeSourceParametersTypeDef],  # (3)
    Tags: NotRequired[Mapping[str, str]],
    TargetParameters: NotRequired[PipeTargetParametersTypeDef],  # (4)
  1. See RequestedPipeStateType
  2. See PipeEnrichmentParametersTypeDef
  3. See PipeSourceParametersTypeDef
  4. See PipeTargetParametersTypeDef

DescribePipeResponseTypeDef#

# DescribePipeResponseTypeDef definition

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

UpdatePipeRequestRequestTypeDef#

# UpdatePipeRequestRequestTypeDef definition

class UpdatePipeRequestRequestTypeDef(TypedDict):
    Name: str,
    RoleArn: str,
    Description: NotRequired[str],
    DesiredState: NotRequired[RequestedPipeStateType],  # (1)
    Enrichment: NotRequired[str],
    EnrichmentParameters: NotRequired[PipeEnrichmentParametersTypeDef],  # (2)
    SourceParameters: NotRequired[UpdatePipeSourceParametersTypeDef],  # (3)
    Target: NotRequired[str],
    TargetParameters: NotRequired[PipeTargetParametersTypeDef],  # (4)
  1. See RequestedPipeStateType
  2. See PipeEnrichmentParametersTypeDef
  3. See UpdatePipeSourceParametersTypeDef
  4. See PipeTargetParametersTypeDef