{ "version": "2.0", "metadata": { "apiVersion": "2015-10-07", "endpointPrefix": "pipes", "jsonVersion": "1.1", "protocol": "rest-json", "serviceFullName": "Amazon EventBridge Pipes", "serviceId": "Pipes", "signatureVersion": "v4", "signingName": "pipes", "uid": "pipes-2015-10-07" }, "operations": { "CreatePipe": { "http": { "requestUri": "/v1/pipes/{Name}", "responseCode": 200 }, "input": { "type": "structure", "required": [ "Name", "RoleArn", "Source", "Target" ], "members": { "Description": { "shape": "S2" }, "DesiredState": {}, "Enrichment": {}, "EnrichmentParameters": { "shape": "S5" }, "LogConfiguration": { "shape": "Sg" }, "Name": { "location": "uri", "locationName": "Name" }, "RoleArn": {}, "Source": {}, "SourceParameters": { "shape": "Sw" }, "Tags": { "shape": "S1z" }, "Target": {}, "TargetParameters": { "shape": "S22" } } }, "output": { "type": "structure", "members": { "Arn": {}, "CreationTime": { "type": "timestamp" }, "CurrentState": {}, "DesiredState": {}, "LastModifiedTime": { "type": "timestamp" }, "Name": {} } }, "idempotent": true }, "DeletePipe": { "http": { "method": "DELETE", "requestUri": "/v1/pipes/{Name}", "responseCode": 200 }, "input": { "type": "structure", "required": [ "Name" ], "members": { "Name": { "location": "uri", "locationName": "Name" } } }, "output": { "type": "structure", "members": { "Arn": {}, "CreationTime": { "type": "timestamp" }, "CurrentState": {}, "DesiredState": {}, "LastModifiedTime": { "type": "timestamp" }, "Name": {} } }, "idempotent": true }, "DescribePipe": { "http": { "method": "GET", "requestUri": "/v1/pipes/{Name}", "responseCode": 200 }, "input": { "type": "structure", "required": [ "Name" ], "members": { "Name": { "location": "uri", "locationName": "Name" } } }, "output": { "type": "structure", "members": { "Arn": {}, "CreationTime": { "type": "timestamp" }, "CurrentState": {}, "Description": { "shape": "S2" }, "DesiredState": {}, "Enrichment": {}, "EnrichmentParameters": { "shape": "S5" }, "LastModifiedTime": { "type": "timestamp" }, "LogConfiguration": { "type": "structure", "members": { "CloudwatchLogsLogDestination": { "type": "structure", "members": { "LogGroupArn": {} } }, "FirehoseLogDestination": { "type": "structure", "members": { "DeliveryStreamArn": {} } }, "IncludeExecutionData": { "shape": "Sl" }, "Level": {}, "S3LogDestination": { "type": "structure", "members": { "BucketName": {}, "BucketOwner": {}, "OutputFormat": {}, "Prefix": {} } } } }, "Name": {}, "RoleArn": {}, "Source": {}, "SourceParameters": { "shape": "Sw" }, "StateReason": {}, "Tags": { "shape": "S1z" }, "Target": {}, "TargetParameters": { "shape": "S22" } } } }, "ListPipes": { "http": { "method": "GET", "requestUri": "/v1/pipes", "responseCode": 200 }, "input": { "type": "structure", "members": { "CurrentState": { "location": "querystring", "locationName": "CurrentState" }, "DesiredState": { "location": "querystring", "locationName": "DesiredState" }, "Limit": { "location": "querystring", "locationName": "Limit", "type": "integer" }, "NamePrefix": { "location": "querystring", "locationName": "NamePrefix" }, "NextToken": { "shape": "S51", "location": "querystring", "locationName": "NextToken" }, "SourcePrefix": { "location": "querystring", "locationName": "SourcePrefix" }, "TargetPrefix": { "location": "querystring", "locationName": "TargetPrefix" } } }, "output": { "type": "structure", "members": { "NextToken": { "shape": "S51" }, "Pipes": { "type": "list", "member": { "type": "structure", "members": { "Arn": {}, "CreationTime": { "type": "timestamp" }, "CurrentState": {}, "DesiredState": {}, "Enrichment": {}, "LastModifiedTime": { "type": "timestamp" }, "Name": {}, "Source": {}, "StateReason": {}, "Target": {} } } } } } }, "ListTagsForResource": { "http": { "method": "GET", "requestUri": "/tags/{resourceArn}", "responseCode": 200 }, "input": { "type": "structure", "required": [ "resourceArn" ], "members": { "resourceArn": { "location": "uri", "locationName": "resourceArn" } } }, "output": { "type": "structure", "members": { "tags": { "shape": "S1z" } } } }, "StartPipe": { "http": { "requestUri": "/v1/pipes/{Name}/start", "responseCode": 200 }, "input": { "type": "structure", "required": [ "Name" ], "members": { "Name": { "location": "uri", "locationName": "Name" } } }, "output": { "type": "structure", "members": { "Arn": {}, "CreationTime": { "type": "timestamp" }, "CurrentState": {}, "DesiredState": {}, "LastModifiedTime": { "type": "timestamp" }, "Name": {} } } }, "StopPipe": { "http": { "requestUri": "/v1/pipes/{Name}/stop", "responseCode": 200 }, "input": { "type": "structure", "required": [ "Name" ], "members": { "Name": { "location": "uri", "locationName": "Name" } } }, "output": { "type": "structure", "members": { "Arn": {}, "CreationTime": { "type": "timestamp" }, "CurrentState": {}, "DesiredState": {}, "LastModifiedTime": { "type": "timestamp" }, "Name": {} } } }, "TagResource": { "http": { "requestUri": "/tags/{resourceArn}", "responseCode": 200 }, "input": { "type": "structure", "required": [ "resourceArn", "tags" ], "members": { "resourceArn": { "location": "uri", "locationName": "resourceArn" }, "tags": { "shape": "S1z" } } }, "output": { "type": "structure", "members": {} }, "idempotent": true }, "UntagResource": { "http": { "method": "DELETE", "requestUri": "/tags/{resourceArn}", "responseCode": 200 }, "input": { "type": "structure", "required": [ "resourceArn", "tagKeys" ], "members": { "resourceArn": { "location": "uri", "locationName": "resourceArn" }, "tagKeys": { "location": "querystring", "locationName": "tagKeys", "type": "list", "member": {} } } }, "output": { "type": "structure", "members": {} }, "idempotent": true }, "UpdatePipe": { "http": { "method": "PUT", "requestUri": "/v1/pipes/{Name}", "responseCode": 200 }, "input": { "type": "structure", "required": [ "Name", "RoleArn" ], "members": { "Description": { "shape": "S2" }, "DesiredState": {}, "Enrichment": {}, "EnrichmentParameters": { "shape": "S5" }, "LogConfiguration": { "shape": "Sg" }, "Name": { "location": "uri", "locationName": "Name" }, "RoleArn": {}, "SourceParameters": { "type": "structure", "members": { "ActiveMQBrokerParameters": { "type": "structure", "required": [ "Credentials" ], "members": { "BatchSize": { "type": "integer" }, "Credentials": { "shape": "Sz" }, "MaximumBatchingWindowInSeconds": { "type": "integer" } } }, "DynamoDBStreamParameters": { "type": "structure", "members": { "BatchSize": { "type": "integer" }, "DeadLetterConfig": { "shape": "S14" }, "MaximumBatchingWindowInSeconds": { "type": "integer" }, "MaximumRecordAgeInSeconds": { "type": "integer" }, "MaximumRetryAttempts": { "type": "integer" }, "OnPartialBatchItemFailure": {}, "ParallelizationFactor": { "type": "integer" } } }, "FilterCriteria": { "shape": "S1b" }, "KinesisStreamParameters": { "type": "structure", "members": { "BatchSize": { "type": "integer" }, "DeadLetterConfig": { "shape": "S14" }, "MaximumBatchingWindowInSeconds": { "type": "integer" }, "MaximumRecordAgeInSeconds": { "type": "integer" }, "MaximumRetryAttempts": { "type": "integer" }, "OnPartialBatchItemFailure": {}, "ParallelizationFactor": { "type": "integer" } } }, "ManagedStreamingKafkaParameters": { "type": "structure", "members": { "BatchSize": { "type": "integer" }, "Credentials": { "shape": "S1k" }, "MaximumBatchingWindowInSeconds": { "type": "integer" } } }, "RabbitMQBrokerParameters": { "type": "structure", "required": [ "Credentials" ], "members": { "BatchSize": { "type": "integer" }, "Credentials": { "shape": "Sz" }, "MaximumBatchingWindowInSeconds": { "type": "integer" } } }, "SelfManagedKafkaParameters": { "type": "structure", "members": { "BatchSize": { "type": "integer" }, "Credentials": { "shape": "S1r" }, "MaximumBatchingWindowInSeconds": { "type": "integer" }, "ServerRootCaCertificate": {}, "Vpc": { "shape": "S1t" } } }, "SqsQueueParameters": { "type": "structure", "members": { "BatchSize": { "type": "integer" }, "MaximumBatchingWindowInSeconds": { "type": "integer" } } } } }, "Target": {}, "TargetParameters": { "shape": "S22" } } }, "output": { "type": "structure", "members": { "Arn": {}, "CreationTime": { "type": "timestamp" }, "CurrentState": {}, "DesiredState": {}, "LastModifiedTime": { "type": "timestamp" }, "Name": {} } }, "idempotent": true } }, "shapes": { "S2": { "type": "string", "sensitive": true }, "S5": { "type": "structure", "members": { "HttpParameters": { "type": "structure", "members": { "HeaderParameters": { "shape": "S7" }, "PathParameterValues": { "shape": "Sa" }, "QueryStringParameters": { "shape": "Sc" } } }, "InputTemplate": { "shape": "Sf" } } }, "S7": { "type": "map", "key": {}, "value": { "type": "string", "sensitive": true } }, "Sa": { "type": "list", "member": { "type": "string", "sensitive": true } }, "Sc": { "type": "map", "key": {}, "value": { "type": "string", "sensitive": true } }, "Sf": { "type": "string", "sensitive": true }, "Sg": { "type": "structure", "required": [ "Level" ], "members": { "CloudwatchLogsLogDestination": { "type": "structure", "required": [ "LogGroupArn" ], "members": { "LogGroupArn": {} } }, "FirehoseLogDestination": { "type": "structure", "required": [ "DeliveryStreamArn" ], "members": { "DeliveryStreamArn": {} } }, "IncludeExecutionData": { "shape": "Sl" }, "Level": {}, "S3LogDestination": { "type": "structure", "required": [ "BucketName", "BucketOwner" ], "members": { "BucketName": {}, "BucketOwner": {}, "OutputFormat": {}, "Prefix": {} } } } }, "Sl": { "type": "list", "member": {} }, "Sw": { "type": "structure", "members": { "ActiveMQBrokerParameters": { "type": "structure", "required": [ "Credentials", "QueueName" ], "members": { "BatchSize": { "type": "integer" }, "Credentials": { "shape": "Sz" }, "MaximumBatchingWindowInSeconds": { "type": "integer" }, "QueueName": { "shape": "S12" } } }, "DynamoDBStreamParameters": { "type": "structure", "required": [ "StartingPosition" ], "members": { "BatchSize": { "type": "integer" }, "DeadLetterConfig": { "shape": "S14" }, "MaximumBatchingWindowInSeconds": { "type": "integer" }, "MaximumRecordAgeInSeconds": { "type": "integer" }, "MaximumRetryAttempts": { "type": "integer" }, "OnPartialBatchItemFailure": {}, "ParallelizationFactor": { "type": "integer" }, "StartingPosition": {} } }, "FilterCriteria": { "shape": "S1b" }, "KinesisStreamParameters": { "type": "structure", "required": [ "StartingPosition" ], "members": { "BatchSize": { "type": "integer" }, "DeadLetterConfig": { "shape": "S14" }, "MaximumBatchingWindowInSeconds": { "type": "integer" }, "MaximumRecordAgeInSeconds": { "type": "integer" }, "MaximumRetryAttempts": { "type": "integer" }, "OnPartialBatchItemFailure": {}, "ParallelizationFactor": { "type": "integer" }, "StartingPosition": {}, "StartingPositionTimestamp": { "type": "timestamp" } } }, "ManagedStreamingKafkaParameters": { "type": "structure", "required": [ "TopicName" ], "members": { "BatchSize": { "type": "integer" }, "ConsumerGroupID": { "shape": "S1j" }, "Credentials": { "shape": "S1k" }, "MaximumBatchingWindowInSeconds": { "type": "integer" }, "StartingPosition": {}, "TopicName": { "shape": "S1m" } } }, "RabbitMQBrokerParameters": { "type": "structure", "required": [ "Credentials", "QueueName" ], "members": { "BatchSize": { "type": "integer" }, "Credentials": { "shape": "Sz" }, "MaximumBatchingWindowInSeconds": { "type": "integer" }, "QueueName": { "shape": "S12" }, "VirtualHost": { "shape": "S1j" } } }, "SelfManagedKafkaParameters": { "type": "structure", "required": [ "TopicName" ], "members": { "AdditionalBootstrapServers": { "type": "list", "member": { "type": "string", "sensitive": true } }, "BatchSize": { "type": "integer" }, "ConsumerGroupID": { "shape": "S1j" }, "Credentials": { "shape": "S1r" }, "MaximumBatchingWindowInSeconds": { "type": "integer" }, "ServerRootCaCertificate": {}, "StartingPosition": {}, "TopicName": { "shape": "S1m" }, "Vpc": { "shape": "S1t" } } }, "SqsQueueParameters": { "type": "structure", "members": { "BatchSize": { "type": "integer" }, "MaximumBatchingWindowInSeconds": { "type": "integer" } } } } }, "Sz": { "type": "structure", "members": { "BasicAuth": {} }, "union": true }, "S12": { "type": "string", "sensitive": true }, "S14": { "type": "structure", "members": { "Arn": {} } }, "S1b": { "type": "structure", "members": { "Filters": { "type": "list", "member": { "type": "structure", "members": { "Pattern": { "type": "string", "sensitive": true } } } } } }, "S1j": { "type": "string", "sensitive": true }, "S1k": { "type": "structure", "members": { "ClientCertificateTlsAuth": {}, "SaslScram512Auth": {} }, "union": true }, "S1m": { "type": "string", "sensitive": true }, "S1r": { "type": "structure", "members": { "BasicAuth": {}, "ClientCertificateTlsAuth": {}, "SaslScram256Auth": {}, "SaslScram512Auth": {} }, "union": true }, "S1t": { "type": "structure", "members": { "SecurityGroup": { "type": "list", "member": { "type": "string", "sensitive": true } }, "Subnets": { "type": "list", "member": { "type": "string", "sensitive": true } } } }, "S1z": { "type": "map", "key": {}, "value": { "shape": "S21" } }, "S21": { "type": "string", "sensitive": true }, "S22": { "type": "structure", "members": { "BatchJobParameters": { "type": "structure", "required": [ "JobDefinition", "JobName" ], "members": { "ArrayProperties": { "type": "structure", "members": { "Size": { "type": "integer" } } }, "ContainerOverrides": { "type": "structure", "members": { "Command": { "shape": "S27" }, "Environment": { "type": "list", "member": { "type": "structure", "members": { "Name": {}, "Value": {} } } }, "InstanceType": {}, "ResourceRequirements": { "type": "list", "member": { "type": "structure", "required": [ "Type", "Value" ], "members": { "Type": {}, "Value": {} } } } } }, "DependsOn": { "type": "list", "member": { "type": "structure", "members": { "JobId": {}, "Type": {} } } }, "JobDefinition": {}, "JobName": {}, "Parameters": { "type": "map", "key": {}, "value": {} }, "RetryStrategy": { "type": "structure", "members": { "Attempts": { "type": "integer" } } } } }, "CloudWatchLogsParameters": { "type": "structure", "members": { "LogStreamName": {}, "Timestamp": {} } }, "EcsTaskParameters": { "type": "structure", "required": [ "TaskDefinitionArn" ], "members": { "CapacityProviderStrategy": { "type": "list", "member": { "type": "structure", "required": [ "capacityProvider" ], "members": { "base": { "type": "integer" }, "capacityProvider": { "type": "string", "sensitive": true }, "weight": { "type": "integer" } } } }, "EnableECSManagedTags": { "type": "boolean" }, "EnableExecuteCommand": { "type": "boolean" }, "Group": {}, "LaunchType": {}, "NetworkConfiguration": { "type": "structure", "members": { "awsvpcConfiguration": { "type": "structure", "required": [ "Subnets" ], "members": { "AssignPublicIp": {}, "SecurityGroups": { "type": "list", "member": { "type": "string", "sensitive": true } }, "Subnets": { "type": "list", "member": { "type": "string", "sensitive": true } } } } } }, "Overrides": { "type": "structure", "members": { "ContainerOverrides": { "type": "list", "member": { "type": "structure", "members": { "Command": { "shape": "S27" }, "Cpu": { "type": "integer" }, "Environment": { "type": "list", "member": { "type": "structure", "members": { "name": {}, "value": {} } } }, "EnvironmentFiles": { "type": "list", "member": { "type": "structure", "required": [ "type", "value" ], "members": { "type": {}, "value": {} } } }, "Memory": { "type": "integer" }, "MemoryReservation": { "type": "integer" }, "Name": {}, "ResourceRequirements": { "type": "list", "member": { "type": "structure", "required": [ "type", "value" ], "members": { "type": {}, "value": {} } } } } } }, "Cpu": {}, "EphemeralStorage": { "type": "structure", "required": [ "sizeInGiB" ], "members": { "sizeInGiB": { "type": "integer" } } }, "ExecutionRoleArn": {}, "InferenceAcceleratorOverrides": { "type": "list", "member": { "type": "structure", "members": { "deviceName": {}, "deviceType": {} } } }, "Memory": {}, "TaskRoleArn": {} } }, "PlacementConstraints": { "type": "list", "member": { "type": "structure", "members": { "expression": { "type": "string", "sensitive": true }, "type": {} } } }, "PlacementStrategy": { "type": "list", "member": { "type": "structure", "members": { "field": { "type": "string", "sensitive": true }, "type": {} } } }, "PlatformVersion": {}, "PropagateTags": {}, "ReferenceId": { "type": "string", "sensitive": true }, "Tags": { "type": "list", "member": { "type": "structure", "required": [ "Key", "Value" ], "members": { "Key": {}, "Value": { "shape": "S21" } } } }, "TaskCount": { "type": "integer" }, "TaskDefinitionArn": {} } }, "EventBridgeEventBusParameters": { "type": "structure", "members": { "DetailType": { "type": "string", "sensitive": true }, "EndpointId": { "type": "string", "sensitive": true }, "Resources": { "type": "list", "member": {} }, "Source": { "type": "string", "sensitive": true }, "Time": {} } }, "HttpParameters": { "type": "structure", "members": { "HeaderParameters": { "shape": "S7" }, "PathParameterValues": { "shape": "Sa" }, "QueryStringParameters": { "shape": "Sc" } } }, "InputTemplate": { "shape": "Sf" }, "KinesisStreamParameters": { "type": "structure", "required": [ "PartitionKey" ], "members": { "PartitionKey": { "type": "string", "sensitive": true } } }, "LambdaFunctionParameters": { "type": "structure", "members": { "InvocationType": {} } }, "RedshiftDataParameters": { "type": "structure", "required": [ "Database", "Sqls" ], "members": { "Database": { "type": "string", "sensitive": true }, "DbUser": { "type": "string", "sensitive": true }, "SecretManagerArn": {}, "Sqls": { "type": "list", "member": { "type": "string", "sensitive": true } }, "StatementName": { "type": "string", "sensitive": true }, "WithEvent": { "type": "boolean" } } }, "SageMakerPipelineParameters": { "type": "structure", "members": { "PipelineParameterList": { "type": "list", "member": { "type": "structure", "required": [ "Name", "Value" ], "members": { "Name": { "type": "string", "sensitive": true }, "Value": { "type": "string", "sensitive": true } } } } } }, "SqsQueueParameters": { "type": "structure", "members": { "MessageDeduplicationId": { "type": "string", "sensitive": true }, "MessageGroupId": { "type": "string", "sensitive": true } } }, "StepFunctionStateMachineParameters": { "type": "structure", "members": { "InvocationType": {} } } } }, "S27": { "type": "list", "member": {} }, "S51": { "type": "string", "sensitive": true } }, "xmlNamespace": "http://events.amazonaws.com/doc/2015-10-07" }