Skip to content

Typed dictionaries

Index > EventBridgePipes > Typed dictionaries

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

AwsVpcConfigurationTypeDef

# AwsVpcConfigurationTypeDef usage example

from mypy_boto3_pipes.type_defs import AwsVpcConfigurationTypeDef

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

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

BatchArrayPropertiesTypeDef

# BatchArrayPropertiesTypeDef usage example

from mypy_boto3_pipes.type_defs import BatchArrayPropertiesTypeDef

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

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

BatchEnvironmentVariableTypeDef

# BatchEnvironmentVariableTypeDef usage example

from mypy_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 usage example

from mypy_boto3_pipes.type_defs import BatchResourceRequirementTypeDef

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

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

BatchJobDependencyTypeDef

# BatchJobDependencyTypeDef usage example

from mypy_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 usage example

from mypy_boto3_pipes.type_defs import BatchRetryStrategyTypeDef

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

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

CapacityProviderStrategyItemTypeDef

# CapacityProviderStrategyItemTypeDef usage example

from mypy_boto3_pipes.type_defs import CapacityProviderStrategyItemTypeDef

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

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

ResponseMetadataTypeDef

# ResponseMetadataTypeDef usage example

from mypy_boto3_pipes.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
# ResponseMetadataTypeDef definition

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

DeadLetterConfigTypeDef

# DeadLetterConfigTypeDef usage example

from mypy_boto3_pipes.type_defs import DeadLetterConfigTypeDef

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

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

DeletePipeRequestRequestTypeDef

# DeletePipeRequestRequestTypeDef usage example

from mypy_boto3_pipes.type_defs import DeletePipeRequestRequestTypeDef

def get_value() -> DeletePipeRequestRequestTypeDef:
    return {
        "Name": ...,
    }
# DeletePipeRequestRequestTypeDef definition

class DeletePipeRequestRequestTypeDef(TypedDict):
    Name: str,

DescribePipeRequestRequestTypeDef

# DescribePipeRequestRequestTypeDef usage example

from mypy_boto3_pipes.type_defs import DescribePipeRequestRequestTypeDef

def get_value() -> DescribePipeRequestRequestTypeDef:
    return {
        "Name": ...,
    }
# DescribePipeRequestRequestTypeDef definition

class DescribePipeRequestRequestTypeDef(TypedDict):
    Name: str,

EcsEnvironmentFileTypeDef

# EcsEnvironmentFileTypeDef usage example

from mypy_boto3_pipes.type_defs import EcsEnvironmentFileTypeDef

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

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

EcsEnvironmentVariableTypeDef

# EcsEnvironmentVariableTypeDef usage example

from mypy_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 usage example

from mypy_boto3_pipes.type_defs import EcsResourceRequirementTypeDef

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

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

EcsEphemeralStorageTypeDef

# EcsEphemeralStorageTypeDef usage example

from mypy_boto3_pipes.type_defs import EcsEphemeralStorageTypeDef

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

class EcsEphemeralStorageTypeDef(TypedDict):
    sizeInGiB: int,

EcsInferenceAcceleratorOverrideTypeDef

# EcsInferenceAcceleratorOverrideTypeDef usage example

from mypy_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 usage example

from mypy_boto3_pipes.type_defs import FilterTypeDef

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

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

PaginatorConfigTypeDef

# PaginatorConfigTypeDef usage example

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

ListPipesRequestRequestTypeDef

# ListPipesRequestRequestTypeDef usage example

from mypy_boto3_pipes.type_defs import ListPipesRequestRequestTypeDef

def get_value() -> ListPipesRequestRequestTypeDef:
    return {
        "CurrentState": ...,
    }
# 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 usage example

from mypy_boto3_pipes.type_defs import PipeTypeDef

def get_value() -> PipeTypeDef:
    return {
        "Arn": ...,
    }
# 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 usage example

from mypy_boto3_pipes.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
    }
# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

MQBrokerAccessCredentialsTypeDef

# MQBrokerAccessCredentialsTypeDef usage example

from mypy_boto3_pipes.type_defs import MQBrokerAccessCredentialsTypeDef

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

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

MSKAccessCredentialsTypeDef

# MSKAccessCredentialsTypeDef usage example

from mypy_boto3_pipes.type_defs import MSKAccessCredentialsTypeDef

def get_value() -> MSKAccessCredentialsTypeDef:
    return {
        "ClientCertificateTlsAuth": ...,
    }
# MSKAccessCredentialsTypeDef definition

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

PipeEnrichmentHttpParametersTypeDef

# PipeEnrichmentHttpParametersTypeDef usage example

from mypy_boto3_pipes.type_defs import PipeEnrichmentHttpParametersTypeDef

def get_value() -> PipeEnrichmentHttpParametersTypeDef:
    return {
        "HeaderParameters": ...,
    }
# PipeEnrichmentHttpParametersTypeDef definition

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

PipeSourceSqsQueueParametersTypeDef

# PipeSourceSqsQueueParametersTypeDef usage example

from mypy_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 usage example

from mypy_boto3_pipes.type_defs import SelfManagedKafkaAccessConfigurationCredentialsTypeDef

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

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

SelfManagedKafkaAccessConfigurationVpcTypeDef

# SelfManagedKafkaAccessConfigurationVpcTypeDef usage example

from mypy_boto3_pipes.type_defs import SelfManagedKafkaAccessConfigurationVpcTypeDef

def get_value() -> SelfManagedKafkaAccessConfigurationVpcTypeDef:
    return {
        "SecurityGroup": ...,
    }
# SelfManagedKafkaAccessConfigurationVpcTypeDef definition

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

PipeTargetCloudWatchLogsParametersTypeDef

# PipeTargetCloudWatchLogsParametersTypeDef usage example

from mypy_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 usage example

from mypy_boto3_pipes.type_defs import PlacementConstraintTypeDef

def get_value() -> PlacementConstraintTypeDef:
    return {
        "expression": ...,
    }
# PlacementConstraintTypeDef definition

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

PlacementStrategyTypeDef

# PlacementStrategyTypeDef usage example

from mypy_boto3_pipes.type_defs import PlacementStrategyTypeDef

def get_value() -> PlacementStrategyTypeDef:
    return {
        "field": ...,
    }
# PlacementStrategyTypeDef definition

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

TagTypeDef

# TagTypeDef usage example

from mypy_boto3_pipes.type_defs import TagTypeDef

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

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

PipeTargetEventBridgeEventBusParametersTypeDef

# PipeTargetEventBridgeEventBusParametersTypeDef usage example

from mypy_boto3_pipes.type_defs import PipeTargetEventBridgeEventBusParametersTypeDef

def get_value() -> PipeTargetEventBridgeEventBusParametersTypeDef:
    return {
        "DetailType": ...,
    }
# PipeTargetEventBridgeEventBusParametersTypeDef definition

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

PipeTargetHttpParametersTypeDef

# PipeTargetHttpParametersTypeDef usage example

from mypy_boto3_pipes.type_defs import PipeTargetHttpParametersTypeDef

def get_value() -> PipeTargetHttpParametersTypeDef:
    return {
        "HeaderParameters": ...,
    }
# PipeTargetHttpParametersTypeDef definition

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

PipeTargetKinesisStreamParametersTypeDef

# PipeTargetKinesisStreamParametersTypeDef usage example

from mypy_boto3_pipes.type_defs import PipeTargetKinesisStreamParametersTypeDef

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

class PipeTargetKinesisStreamParametersTypeDef(TypedDict):
    PartitionKey: str,

PipeTargetLambdaFunctionParametersTypeDef

# PipeTargetLambdaFunctionParametersTypeDef usage example

from mypy_boto3_pipes.type_defs import PipeTargetLambdaFunctionParametersTypeDef

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

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

PipeTargetRedshiftDataParametersTypeDef

# PipeTargetRedshiftDataParametersTypeDef usage example

from mypy_boto3_pipes.type_defs import PipeTargetRedshiftDataParametersTypeDef

def get_value() -> PipeTargetRedshiftDataParametersTypeDef:
    return {
        "Database": ...,
        "Sqls": ...,
    }
# PipeTargetRedshiftDataParametersTypeDef definition

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

PipeTargetSqsQueueParametersTypeDef

# PipeTargetSqsQueueParametersTypeDef usage example

from mypy_boto3_pipes.type_defs import PipeTargetSqsQueueParametersTypeDef

def get_value() -> PipeTargetSqsQueueParametersTypeDef:
    return {
        "MessageDeduplicationId": ...,
    }
# PipeTargetSqsQueueParametersTypeDef definition

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

PipeTargetStateMachineParametersTypeDef

# PipeTargetStateMachineParametersTypeDef usage example

from mypy_boto3_pipes.type_defs import PipeTargetStateMachineParametersTypeDef

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

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

SageMakerPipelineParameterTypeDef

# SageMakerPipelineParameterTypeDef usage example

from mypy_boto3_pipes.type_defs import SageMakerPipelineParameterTypeDef

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

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

StartPipeRequestRequestTypeDef

# StartPipeRequestRequestTypeDef usage example

from mypy_boto3_pipes.type_defs import StartPipeRequestRequestTypeDef

def get_value() -> StartPipeRequestRequestTypeDef:
    return {
        "Name": ...,
    }
# StartPipeRequestRequestTypeDef definition

class StartPipeRequestRequestTypeDef(TypedDict):
    Name: str,

StopPipeRequestRequestTypeDef

# StopPipeRequestRequestTypeDef usage example

from mypy_boto3_pipes.type_defs import StopPipeRequestRequestTypeDef

def get_value() -> StopPipeRequestRequestTypeDef:
    return {
        "Name": ...,
    }
# StopPipeRequestRequestTypeDef definition

class StopPipeRequestRequestTypeDef(TypedDict):
    Name: str,

TagResourceRequestRequestTypeDef

# TagResourceRequestRequestTypeDef usage example

from mypy_boto3_pipes.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tags": ...,
    }
# TagResourceRequestRequestTypeDef definition

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

UntagResourceRequestRequestTypeDef

# UntagResourceRequestRequestTypeDef usage example

from mypy_boto3_pipes.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tagKeys": ...,
    }
# UntagResourceRequestRequestTypeDef definition

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

UpdatePipeSourceSqsQueueParametersTypeDef

# UpdatePipeSourceSqsQueueParametersTypeDef usage example

from mypy_boto3_pipes.type_defs import UpdatePipeSourceSqsQueueParametersTypeDef

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

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

NetworkConfigurationTypeDef

# NetworkConfigurationTypeDef usage example

from mypy_boto3_pipes.type_defs import NetworkConfigurationTypeDef

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

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

BatchContainerOverridesTypeDef

# BatchContainerOverridesTypeDef usage example

from mypy_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 usage example

from mypy_boto3_pipes.type_defs import CreatePipeResponseTypeDef

def get_value() -> CreatePipeResponseTypeDef:
    return {
        "Arn": ...,
        "CreationTime": ...,
        "CurrentState": ...,
        "DesiredState": ...,
        "LastModifiedTime": ...,
        "Name": ...,
        "ResponseMetadata": ...,
    }
# 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 usage example

from mypy_boto3_pipes.type_defs import DeletePipeResponseTypeDef

def get_value() -> DeletePipeResponseTypeDef:
    return {
        "Arn": ...,
        "CreationTime": ...,
        "CurrentState": ...,
        "DesiredState": ...,
        "LastModifiedTime": ...,
        "Name": ...,
        "ResponseMetadata": ...,
    }
# 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 usage example

from mypy_boto3_pipes.type_defs import ListTagsForResourceResponseTypeDef

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

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

StartPipeResponseTypeDef

# StartPipeResponseTypeDef usage example

from mypy_boto3_pipes.type_defs import StartPipeResponseTypeDef

def get_value() -> StartPipeResponseTypeDef:
    return {
        "Arn": ...,
        "CreationTime": ...,
        "CurrentState": ...,
        "DesiredState": ...,
        "LastModifiedTime": ...,
        "Name": ...,
        "ResponseMetadata": ...,
    }
# 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 usage example

from mypy_boto3_pipes.type_defs import StopPipeResponseTypeDef

def get_value() -> StopPipeResponseTypeDef:
    return {
        "Arn": ...,
        "CreationTime": ...,
        "CurrentState": ...,
        "DesiredState": ...,
        "LastModifiedTime": ...,
        "Name": ...,
        "ResponseMetadata": ...,
    }
# 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 usage example

from mypy_boto3_pipes.type_defs import UpdatePipeResponseTypeDef

def get_value() -> UpdatePipeResponseTypeDef:
    return {
        "Arn": ...,
        "CreationTime": ...,
        "CurrentState": ...,
        "DesiredState": ...,
        "LastModifiedTime": ...,
        "Name": ...,
        "ResponseMetadata": ...,
    }
# 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 usage example

from mypy_boto3_pipes.type_defs import PipeSourceDynamoDBStreamParametersTypeDef

def get_value() -> PipeSourceDynamoDBStreamParametersTypeDef:
    return {
        "StartingPosition": ...,
    }
# 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

PipeSourceKinesisStreamParametersTypeDef

# PipeSourceKinesisStreamParametersTypeDef usage example

from mypy_boto3_pipes.type_defs import PipeSourceKinesisStreamParametersTypeDef

def get_value() -> PipeSourceKinesisStreamParametersTypeDef:
    return {
        "StartingPosition": ...,
    }
# 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

UpdatePipeSourceDynamoDBStreamParametersTypeDef

# UpdatePipeSourceDynamoDBStreamParametersTypeDef usage example

from mypy_boto3_pipes.type_defs import UpdatePipeSourceDynamoDBStreamParametersTypeDef

def get_value() -> UpdatePipeSourceDynamoDBStreamParametersTypeDef:
    return {
        "BatchSize": ...,
    }
# 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 usage example

from mypy_boto3_pipes.type_defs import UpdatePipeSourceKinesisStreamParametersTypeDef

def get_value() -> UpdatePipeSourceKinesisStreamParametersTypeDef:
    return {
        "BatchSize": ...,
    }
# 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 usage example

from mypy_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

FilterCriteriaTypeDef

# FilterCriteriaTypeDef usage example

from mypy_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

ListPipesRequestListPipesPaginateTypeDef

# ListPipesRequestListPipesPaginateTypeDef usage example

from mypy_boto3_pipes.type_defs import ListPipesRequestListPipesPaginateTypeDef

def get_value() -> ListPipesRequestListPipesPaginateTypeDef:
    return {
        "CurrentState": ...,
    }
# 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 usage example

from mypy_boto3_pipes.type_defs import ListPipesResponseTypeDef

def get_value() -> ListPipesResponseTypeDef:
    return {
        "NextToken": ...,
        "Pipes": ...,
        "ResponseMetadata": ...,
    }
# ListPipesResponseTypeDef definition

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

PipeSourceActiveMQBrokerParametersTypeDef

# PipeSourceActiveMQBrokerParametersTypeDef usage example

from mypy_boto3_pipes.type_defs import PipeSourceActiveMQBrokerParametersTypeDef

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

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

PipeSourceRabbitMQBrokerParametersTypeDef

# PipeSourceRabbitMQBrokerParametersTypeDef usage example

from mypy_boto3_pipes.type_defs import PipeSourceRabbitMQBrokerParametersTypeDef

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

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

UpdatePipeSourceActiveMQBrokerParametersTypeDef

# UpdatePipeSourceActiveMQBrokerParametersTypeDef usage example

from mypy_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 usage example

from mypy_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 usage example

from mypy_boto3_pipes.type_defs import PipeSourceManagedStreamingKafkaParametersTypeDef

def get_value() -> PipeSourceManagedStreamingKafkaParametersTypeDef:
    return {
        "TopicName": ...,
    }
# 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 usage example

from mypy_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

PipeEnrichmentParametersTypeDef

# PipeEnrichmentParametersTypeDef usage example

from mypy_boto3_pipes.type_defs import PipeEnrichmentParametersTypeDef

def get_value() -> PipeEnrichmentParametersTypeDef:
    return {
        "HttpParameters": ...,
    }
# PipeEnrichmentParametersTypeDef definition

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

PipeSourceSelfManagedKafkaParametersTypeDef

# PipeSourceSelfManagedKafkaParametersTypeDef usage example

from mypy_boto3_pipes.type_defs import PipeSourceSelfManagedKafkaParametersTypeDef

def get_value() -> PipeSourceSelfManagedKafkaParametersTypeDef:
    return {
        "TopicName": ...,
    }
# 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 usage example

from mypy_boto3_pipes.type_defs import UpdatePipeSourceSelfManagedKafkaParametersTypeDef

def get_value() -> UpdatePipeSourceSelfManagedKafkaParametersTypeDef:
    return {
        "BatchSize": ...,
    }
# 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 usage example

from mypy_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

PipeTargetBatchJobParametersTypeDef

# PipeTargetBatchJobParametersTypeDef usage example

from mypy_boto3_pipes.type_defs import PipeTargetBatchJobParametersTypeDef

def get_value() -> PipeTargetBatchJobParametersTypeDef:
    return {
        "JobDefinition": ...,
        "JobName": ...,
    }
# 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 usage example

from mypy_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

PipeSourceParametersTypeDef

# PipeSourceParametersTypeDef usage example

from mypy_boto3_pipes.type_defs import PipeSourceParametersTypeDef

def get_value() -> PipeSourceParametersTypeDef:
    return {
        "ActiveMQBrokerParameters": ...,
    }
# 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 usage example

from mypy_boto3_pipes.type_defs import UpdatePipeSourceParametersTypeDef

def get_value() -> UpdatePipeSourceParametersTypeDef:
    return {
        "ActiveMQBrokerParameters": ...,
    }
# 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 usage example

from mypy_boto3_pipes.type_defs import PipeTargetEcsTaskParametersTypeDef

def get_value() -> PipeTargetEcsTaskParametersTypeDef:
    return {
        "TaskDefinitionArn": ...,
    }
# 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 usage example

from mypy_boto3_pipes.type_defs import PipeTargetParametersTypeDef

def get_value() -> PipeTargetParametersTypeDef:
    return {
        "BatchJobParameters": ...,
    }
# 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 usage example

from mypy_boto3_pipes.type_defs import CreatePipeRequestRequestTypeDef

def get_value() -> CreatePipeRequestRequestTypeDef:
    return {
        "Name": ...,
        "RoleArn": ...,
        "Source": ...,
        "Target": ...,
    }
# 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 usage example

from mypy_boto3_pipes.type_defs import DescribePipeResponseTypeDef

def get_value() -> DescribePipeResponseTypeDef:
    return {
        "Arn": ...,
        "CreationTime": ...,
        "CurrentState": ...,
        "Description": ...,
        "DesiredState": ...,
        "Enrichment": ...,
        "EnrichmentParameters": ...,
        "LastModifiedTime": ...,
        "Name": ...,
        "RoleArn": ...,
        "Source": ...,
        "SourceParameters": ...,
        "StateReason": ...,
        "Tags": ...,
        "Target": ...,
        "TargetParameters": ...,
        "ResponseMetadata": ...,
    }
# 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 usage example

from mypy_boto3_pipes.type_defs import UpdatePipeRequestRequestTypeDef

def get_value() -> UpdatePipeRequestRequestTypeDef:
    return {
        "Name": ...,
        "RoleArn": ...,
    }
# 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