EventBridgePipes module#
Index > EventBridgePipes
Auto-generated documentation for EventBridgePipes type annotations stubs module mypy-boto3-pipes.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and EventBridgePipes
.
From PyPI with pip#
Install boto3-stubs
for EventBridgePipes
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[pipes]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[pipes]'
# standalone installation
python -m pip install mypy-boto3-pipes
How to uninstall#
python -m pip uninstall -y mypy-boto3-pipes
Usage#
Code samples can be found in Examples.
EventBridgePipesClient#
Type annotations and code completion for boto3.client("pipes")
as EventBridgePipesClient
boto3 documentation
# EventBridgePipesClient usage example
from boto3.session import Session
from mypy_boto3_pipes.client import EventBridgePipesClient
def get_client() -> EventBridgePipesClient:
return Session().client("pipes")
Paginators#
Type annotations and code completion for paginators
from boto3.client("pipes").get_paginator("...")
.
# ListPipesPaginator usage example
from boto3.session import Session
from mypy_boto3_pipes.paginator import ListPipesPaginator
def get_list_pipes_paginator() -> ListPipesPaginator:
return Session().client("pipes").get_paginator("list_pipes"))
Literals#
Type annotations for literals used in methods and schema.
# AssignPublicIpType usage example
from mypy_boto3_pipes.literals import AssignPublicIpType
def get_value() -> AssignPublicIpType:
return "DISABLED"
- AssignPublicIpType
- BatchJobDependencyTypeType
- BatchResourceRequirementTypeType
- DimensionValueTypeType
- DynamoDBStreamStartPositionType
- EcsEnvironmentFileTypeType
- EcsResourceRequirementTypeType
- EpochTimeUnitType
- IncludeExecutionDataOptionType
- KinesisStreamStartPositionType
- LaunchTypeType
- ListPipesPaginatorName
- LogLevelType
- MSKStartPositionType
- MeasureValueTypeType
- OnPartialBatchItemFailureStreamsType
- PipeStateType
- PipeTargetInvocationTypeType
- PlacementConstraintTypeType
- PlacementStrategyTypeType
- PropagateTagsType
- RequestedPipeStateDescribeResponseType
- RequestedPipeStateType
- S3OutputFormatType
- SelfManagedKafkaStartPositionType
- TimeFieldTypeType
- EventBridgePipesServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AwsVpcConfigurationOutputTypeDef
- AwsVpcConfigurationTypeDef
- BatchArrayPropertiesTypeDef
- BatchEnvironmentVariableTypeDef
- BatchResourceRequirementTypeDef
- BatchJobDependencyTypeDef
- BatchRetryStrategyTypeDef
- CapacityProviderStrategyItemTypeDef
- CloudwatchLogsLogDestinationParametersTypeDef
- CloudwatchLogsLogDestinationTypeDef
- ResponseMetadataTypeDef
- DeadLetterConfigTypeDef
- DeletePipeRequestRequestTypeDef
- DescribePipeRequestRequestTypeDef
- DimensionMappingTypeDef
- EcsEnvironmentFileTypeDef
- EcsEnvironmentVariableTypeDef
- EcsResourceRequirementTypeDef
- EcsEphemeralStorageTypeDef
- EcsInferenceAcceleratorOverrideTypeDef
- FilterTypeDef
- FirehoseLogDestinationParametersTypeDef
- FirehoseLogDestinationTypeDef
- PaginatorConfigTypeDef
- ListPipesRequestRequestTypeDef
- PipeTypeDef
- ListTagsForResourceRequestRequestTypeDef
- MQBrokerAccessCredentialsTypeDef
- MSKAccessCredentialsTypeDef
- MultiMeasureAttributeMappingTypeDef
- PipeEnrichmentHttpParametersOutputTypeDef
- PipeEnrichmentHttpParametersTypeDef
- S3LogDestinationParametersTypeDef
- S3LogDestinationTypeDef
- TimestampTypeDef
- PipeSourceSqsQueueParametersTypeDef
- SelfManagedKafkaAccessConfigurationCredentialsTypeDef
- SelfManagedKafkaAccessConfigurationVpcOutputTypeDef
- SelfManagedKafkaAccessConfigurationVpcTypeDef
- PipeTargetCloudWatchLogsParametersTypeDef
- PlacementConstraintTypeDef
- PlacementStrategyTypeDef
- TagTypeDef
- PipeTargetEventBridgeEventBusParametersOutputTypeDef
- PipeTargetEventBridgeEventBusParametersTypeDef
- PipeTargetHttpParametersOutputTypeDef
- PipeTargetHttpParametersTypeDef
- PipeTargetKinesisStreamParametersTypeDef
- PipeTargetLambdaFunctionParametersTypeDef
- PipeTargetRedshiftDataParametersOutputTypeDef
- PipeTargetSqsQueueParametersTypeDef
- PipeTargetStateMachineParametersTypeDef
- PipeTargetRedshiftDataParametersTypeDef
- SageMakerPipelineParameterTypeDef
- SingleMeasureMappingTypeDef
- StartPipeRequestRequestTypeDef
- StopPipeRequestRequestTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdatePipeSourceSqsQueueParametersTypeDef
- NetworkConfigurationOutputTypeDef
- NetworkConfigurationTypeDef
- BatchContainerOverridesOutputTypeDef
- BatchContainerOverridesTypeDef
- CreatePipeResponseTypeDef
- DeletePipeResponseTypeDef
- ListTagsForResourceResponseTypeDef
- StartPipeResponseTypeDef
- StopPipeResponseTypeDef
- UpdatePipeResponseTypeDef
- PipeSourceDynamoDBStreamParametersTypeDef
- PipeSourceKinesisStreamParametersOutputTypeDef
- UpdatePipeSourceDynamoDBStreamParametersTypeDef
- UpdatePipeSourceKinesisStreamParametersTypeDef
- EcsContainerOverrideOutputTypeDef
- EcsContainerOverrideTypeDef
- FilterCriteriaOutputTypeDef
- FilterCriteriaTypeDef
- ListPipesRequestListPipesPaginateTypeDef
- ListPipesResponseTypeDef
- PipeSourceActiveMQBrokerParametersTypeDef
- PipeSourceRabbitMQBrokerParametersTypeDef
- UpdatePipeSourceActiveMQBrokerParametersTypeDef
- UpdatePipeSourceRabbitMQBrokerParametersTypeDef
- PipeSourceManagedStreamingKafkaParametersTypeDef
- UpdatePipeSourceManagedStreamingKafkaParametersTypeDef
- MultiMeasureMappingOutputTypeDef
- MultiMeasureMappingTypeDef
- PipeEnrichmentParametersOutputTypeDef
- PipeEnrichmentParametersTypeDef
- PipeLogConfigurationParametersTypeDef
- PipeLogConfigurationTypeDef
- PipeSourceKinesisStreamParametersTypeDef
- PipeSourceSelfManagedKafkaParametersOutputTypeDef
- PipeSourceSelfManagedKafkaParametersTypeDef
- UpdatePipeSourceSelfManagedKafkaParametersTypeDef
- PipeTargetSageMakerPipelineParametersOutputTypeDef
- PipeTargetSageMakerPipelineParametersTypeDef
- PipeTargetBatchJobParametersOutputTypeDef
- PipeTargetBatchJobParametersTypeDef
- EcsTaskOverrideOutputTypeDef
- EcsTaskOverrideTypeDef
- PipeTargetTimestreamParametersOutputTypeDef
- PipeTargetTimestreamParametersTypeDef
- PipeEnrichmentParametersUnionTypeDef
- PipeSourceParametersOutputTypeDef
- PipeSourceParametersTypeDef
- UpdatePipeSourceParametersTypeDef
- PipeTargetEcsTaskParametersOutputTypeDef
- PipeTargetEcsTaskParametersTypeDef
- PipeSourceParametersUnionTypeDef
- PipeTargetParametersOutputTypeDef
- PipeTargetParametersTypeDef
- DescribePipeResponseTypeDef
- CreatePipeRequestRequestTypeDef
- PipeTargetParametersUnionTypeDef
- UpdatePipeRequestRequestTypeDef