Amazon EventBridge Pipes Pipes API is one of 2 APIs that Amazon EventBridge Pipes publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 3 JSON Schema definitions.
Tagged areas include Pipes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, pricing, a JSON-LD context, and 3 JSON Schemas.
This API exposes
7 operations
across 4 paths,
and defines 176 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 4 base URLs: http://pipes.{region}.amazonaws.com, https://pipes.{region}.amazonaws.com, http://pipes.{region}.amazonaws.com.cn, https://pipes.{region}.amazonaws.com.cn.
The identity and technical contract details declared by the specification.
PipeTargetEventBridgeEventBusParameters
object
The parameters for using an EventBridge event bus as a target.
5 properties
PlacementStrategyField
string
UpdatePipeSourceRabbitMQBrokerParameters
object
The parameters for using a Rabbit MQ broker as a source.
3 properties
1 required
BatchParametersMap
object
ServiceQuotaExceededException
PipeSourceDynamoDBStreamParameters
object
The parameters for using a DynamoDB stream as a source.
8 properties
1 required
CapacityProviderStrategyItemBase
integer
BatchEnvironmentVariable
object
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the…
2 properties
UpdatePipeSourceManagedStreamingKafkaParameters
object
The parameters for using an MSK stream as a source.
3 properties
DeletePipeResponse
object
6 properties
EcsEnvironmentFileType
string
CapacityProviderStrategyItemWeight
integer
EcsResourceRequirementsList
array
PipeSourceKinesisStreamParameters
object
The parameters for using a Kinesis stream as a source.
9 properties
1 required
UpdatePipeSourceActiveMQBrokerParameters
object
The parameters for using an Active MQ broker as a source.
3 properties
1 required
MaximumRecordAgeInSeconds
integer
UpdatePipeSourceDynamoDBStreamParameters
object
The parameters for using a DynamoDB stream as a source.
7 properties
EcsInferenceAcceleratorOverrideList
array
SecretManagerArnOrJsonPath
string
// For targets, can either specify an ARN or a jsonpath pointing to the ARN.
PipeEnrichmentHttpParameters
object
These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations. In the latter case, these are merged with any…
3 properties
PipeTargetEcsTaskParameters
object
The parameters for using an Amazon ECS task as a target.
15 properties
1 required
BatchResourceRequirementType
string
UpdatePipeSourceSqsQueueParameters
object
The parameters for using a Amazon SQS stream as a source.
2 properties
UpdatePipeSourceKinesisStreamParameters
object
The parameters for using a Kinesis stream as a source.
7 properties
PipeSourceParameters
object
The parameters required to set up a source for your pipe.
8 properties
PipeTargetBatchJobParameters
object
The parameters for using an Batch job as a target.
7 properties
2 required
EcsEphemeralStorage
object
The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default…
1 property
1 required
StopPipeResponse
object
6 properties
StartPipeResponse
object
6 properties
AwsVpcConfiguration
object
This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for E…
3 properties
1 required
BatchContainerOverrides
object
The overrides that are sent to a container.
4 properties
Sqls
array
// A list of SQLs.
UpdatePipeResponse
object
6 properties
RequestedPipeState
string
PipeTargetHttpParameters
object
These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
3 properties
BatchArrayProperties
object
The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a jo…
1 property
SageMakerPipelineParameter
object
Name/Value pair of a parameter to start execution of a SageMaker Model Building Pipeline.
2 properties
2 required
PlacementStrategyType
string
MaximumRetryAttemptsESM
integer
SelfManagedKafkaAccessConfigurationVpc
object
This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
2 properties
PlacementStrategies
array
PlacementConstraintExpression
string
PlacementConstraints
array
CapacityProviderStrategyItem
object
The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem in the Amazon ECS API Reference.
3 properties
1 required
DbUser
string
// Database user name
EphemeralStorageSize
integer
EcsEnvironmentVariable
object
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the…
2 properties
PipeTargetSageMakerPipelineParameters
object
The parameters for using a SageMaker pipeline as a target.
1 property
KinesisPartitionKey
string
BatchResourceRequirement
object
The type and amount of a resource to assign to a container. The supported resources include GPU , MEMORY , and VCPU .
2 properties
2 required
OnPartialBatchItemFailureStreams
string
BatchJobDependencyType
string
MSKAccessCredentials
object
The Secrets Manager secret that stores your stream credentials.
2 properties
PipeTargetRedshiftDataParameters
object
These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement.
6 properties
2 required
KafkaBootstrapServers
array
EcsEnvironmentVariableList
array
UpdatePipeSourceSelfManagedKafkaParameters
object
The parameters for using a self-managed Apache Kafka stream as a source.
5 properties
MQBrokerAccessCredentials
object
The Secrets Manager secret that stores your broker credentials.
1 property
DescribePipeResponse
object
16 properties
KinesisStreamStartPosition
string
PipeTargetCloudWatchLogsParameters
object
The parameters for using an CloudWatch Logs log stream as a target.
2 properties
Tag
object
A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging.
2 properties
2 required
SecurityGroupIds
array
List of SecurityGroupId.
PipeEnrichmentParameters
object
The parameters required to set up enrichment on your pipe.
2 properties
PipeSourceActiveMQBrokerParameters
object
The parameters for using an Active MQ broker as a source.
4 properties
2 required
SelfManagedKafkaAccessConfigurationCredentials
object
The Secrets Manager secret that stores your stream credentials.
4 properties
EcsContainerOverride
object
The overrides that are sent to a container. An empty container override can be passed in. An example of an empty container override is {"containerOverrides": […
8 properties
EventBridgeEventResourceList
array
PipeTargetStateMachineParameters
object
The parameters for using a Step Functions state machine as a target.
1 property
FilterCriteria
object
The collection of event patterns used to filter events. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide .
1 property
CapacityProviderStrategy
array
EventBridgeDetailType
string
RequestedPipeStateDescribeResponse
string
CreatePipeResponse
object
6 properties
PipeTargetLambdaFunctionParameters
object
The parameters for using a Lambda function as a target.
1 property
MessageDeduplicationId
string
PipeTargetInvocationType
string
MaximumBatchingWindowInSeconds
integer
SecretManagerArn
string
// Optional SecretManager ARN which stores the database credentials
PipeSourceSelfManagedKafkaParameters
object
The parameters for using a self-managed Apache Kafka stream as a source.
9 properties
1 required
EcsEnvironmentFileList
array
PipeTargetKinesisStreamParameters
object
The parameters for using a Kinesis stream as a source.
1 property
1 required
PipeSourceManagedStreamingKafkaParameters
object
The parameters for using an MSK stream as a source.
6 properties
1 required
SelfManagedKafkaStartPosition
string
EcsTaskOverride
object
The overrides that are associated with a task.
7 properties
ListPipesResponse
object
2 properties
BatchRetryAttempts
integer
DynamoDBStreamStartPosition
string
Pipe
object
An object that represents a pipe. Amazon EventBridgePipes connect event sources to targets and reduces the need for specialized knowledge and integration code.
10 properties
BatchEnvironmentVariableList
array
PlacementConstraint
object
An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
2 properties
EcsContainerOverrideList
array
StatementName
string
// A name for Redshift DataAPI statement which can be used as filter of // ListStatement.
EcsInferenceAcceleratorOverride
object
Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definitio…
2 properties
BatchRetryStrategy
object
The retry strategy that's associated with a job. For more information, see Automated job retries in the Batch User Guide .
1 property
SubnetIds
array
List of SubnetId.
Database
string
// Redshift Database
EventBridgeEndpointId
string
SageMakerPipelineParameterValue
string
NetworkConfiguration
object
This structure specifies the network configuration for an Amazon ECS task.
1 property
EcsResourceRequirement
object
The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see…
2 properties
2 required
PipeTargetSqsQueueParameters
object
The parameters for using a Amazon SQS stream as a source.
2 properties
EcsResourceRequirementType
string
EcsEnvironmentFile
object
A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a .env file extens…
2 properties
2 required
DeadLetterConfig
object
A DeadLetterConfig object that contains information about a dead-letter queue configuration.
1 property
BatchJobDependency
object
An object that represents an Batch job dependency.
2 properties
QueryStringParametersMap
object
BatchResourceRequirementsList
array
Sql
string
// A single Redshift SQL
PipeSourceRabbitMQBrokerParameters
object
The parameters for using a Rabbit MQ broker as a source.
5 properties
2 required
PipeTargetParameters
object
The parameters required to set up a target for your pipe.
12 properties
SageMakerPipelineParameterName
string
PipeSourceSqsQueueParameters
object
The parameters for using a Amazon SQS stream as a source.
2 properties
SageMakerPipelineParameterList
array
PlacementConstraintType
string
PlacementStrategy
object
The task placement strategy for a task or service. To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Service Developer Guide.
2 properties
HeaderParametersMap
object
EventBridgeEventSource
string
Filter
object
Filter events using an event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide .
1 property
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Amazon EventBridge Pipes publishes across the network.
