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

CloudwatchLogsLogDestinationParametersTypeDef#

# CloudwatchLogsLogDestinationParametersTypeDef definition

class CloudwatchLogsLogDestinationParametersTypeDef(TypedDict):
    LogGroupArn: str,

CloudwatchLogsLogDestinationTypeDef#

# CloudwatchLogsLogDestinationTypeDef definition

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

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

FirehoseLogDestinationParametersTypeDef#

# FirehoseLogDestinationParametersTypeDef definition

class FirehoseLogDestinationParametersTypeDef(TypedDict):
    DeliveryStreamArn: str,

FirehoseLogDestinationTypeDef#

# FirehoseLogDestinationTypeDef definition

class FirehoseLogDestinationTypeDef(TypedDict):
    DeliveryStreamArn: 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]],

S3LogDestinationParametersTypeDef#

# S3LogDestinationParametersTypeDef definition

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

S3LogDestinationTypeDef#

# S3LogDestinationTypeDef definition

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

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):
    C