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

PipeEnrichmentParametersUnionTypeDef#

# PipeEnrichmentParametersUnionTypeDef definition

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

PipeSourceParametersUnionTypeDef#

# PipeSourceParametersUnionTypeDef definition

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

PipeTargetParametersUnionTypeDef#

# PipeTargetParametersUnionTypeDef definition

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

AwsVpcConfigurationOutputTypeDef#

# AwsVpcConfigurationOutputTypeDef definition

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

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,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

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

PipeEnrichmentHttpParametersOutputTypeDef#

# PipeEnrichmentHttpParametersOutputTypeDef definition

class PipeEnrichmentHttpParametersOutputTypeDef(TypedDict):
    HeaderParameters: NotRequired[Dict[str, str]],
    PathParameterValues: NotRequired[List[str]],
    QueryStringParameters: NotRequired[Dict[str, 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],

SelfManagedKafkaAccessConfigurationVpcOutputTypeDef#

# SelfManagedKafkaAccessConfigurationVpcOutputTypeDef definition

class SelfManagedKafkaAccessConfigurationVpcOutputTypeDef(TypedDict):
    SecurityGroup: NotRequired[List[str]],
    Subnets: NotRequired[List[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,

PipeTargetEventBridgeEventBusParametersOutputTypeDef#

# PipeTargetEventBridgeEventBusParametersOutputTypeDef definition

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

PipeTargetEventBridgeEventBusParametersTypeDef#

# PipeTargetEventBridgeEventBusParametersTypeDef definition

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

PipeTargetHttpParametersOutputTypeDef#

# PipeTargetHttpParametersOutputTypeDef definition

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

PipeTargetHttpParametersTypeDef