UNPKG

openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

1 lines 129 kB
{"openapi":"3.0.0","info":{"version":"2015-10-07","x-release":"v4","title":"Amazon EventBridge Pipes","description":"Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need for specialized knowledge and integration code when developing event driven architectures. This helps ensures consistency across your company’s applications. With Pipes, the target can be any available EventBridge target. To set up a pipe, you select the event source, add optional event filtering, define optional enrichment, and select the target for the event data. ","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"pipes","x-aws-signingName":"pipes","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/pipes-2015-10-07.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/pipes/"},"servers":[{"url":"http://pipes.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon EventBridge Pipes multi-region endpoint"},{"url":"https://pipes.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon EventBridge Pipes multi-region endpoint"},{"url":"http://pipes.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon EventBridge Pipes endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://pipes.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon EventBridge Pipes endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/v1/pipes/{Name}":{"post":{"operationId":"CreatePipe","description":"Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePipeResponse"}}}},"480":{"description":"InternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"485":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}}},"parameters":[{"name":"Name","in":"path","required":true,"description":"The name of the pipe.","schema":{"type":"string","pattern":"^[\\.\\-_A-Za-z0-9]+$","minLength":1,"maxLength":64}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RoleArn","Source","Target"],"properties":{"Description":{"description":"A description of the pipe.","type":"string","pattern":"^.*$","minLength":0,"maxLength":512,"format":"password"},"DesiredState":{"description":"The state the pipe should be in.","type":"string","enum":["RUNNING","STOPPED"]},"Enrichment":{"description":"The ARN of the enrichment resource.","type":"string","pattern":"^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)$","minLength":0,"maxLength":1600},"EnrichmentParameters":{"description":"The parameters required to set up enrichment on your pipe.","type":"object","properties":{"HttpParameters":{"allOf":[{"$ref":"#/components/schemas/PipeEnrichmentHttpParameters"},{"description":"<p>Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.</p> <p>If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.</p>"}]},"InputTemplate":{"allOf":[{"$ref":"#/components/schemas/InputTemplate"},{"description":"Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the enrichment. For more information, see <a href=\"http://www.rfc-editor.org/rfc/rfc7159.txt\">The JavaScript Object Notation (JSON) Data Interchange Format</a>."}]}}},"RoleArn":{"description":"The ARN of the role that allows the pipe to send data to the target.","type":"string","pattern":"^arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z0-9+=,.@\\-_/]+$","minLength":1,"maxLength":1600},"Source":{"description":"The ARN of the source resource.","type":"string","pattern":"^smk://(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]):[0-9]{1,5}|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)$","minLength":1,"maxLength":1600},"SourceParameters":{"description":"The parameters required to set up a source for your pipe.","type":"object","properties":{"ActiveMQBrokerParameters":{"allOf":[{"$ref":"#/components/schemas/PipeSourceActiveMQBrokerParameters"},{"description":"The parameters for using an Active MQ broker as a source."}]},"DynamoDBStreamParameters":{"allOf":[{"$ref":"#/components/schemas/PipeSourceDynamoDBStreamParameters"},{"description":"The parameters for using a DynamoDB stream as a source."}]},"FilterCriteria":{"allOf":[{"$ref":"#/components/schemas/FilterCriteria"},{"description":"The collection of event patterns used to filter events. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html\">Events and Event Patterns</a> in the <i>Amazon EventBridge User Guide</i>."}]},"KinesisStreamParameters":{"allOf":[{"$ref":"#/components/schemas/PipeSourceKinesisStreamParameters"},{"description":"The parameters for using a Kinesis stream as a source."}]},"ManagedStreamingKafkaParameters":{"allOf":[{"$ref":"#/components/schemas/PipeSourceManagedStreamingKafkaParameters"},{"description":"The parameters for using an MSK stream as a source."}]},"RabbitMQBrokerParameters":{"allOf":[{"$ref":"#/components/schemas/PipeSourceRabbitMQBrokerParameters"},{"description":"The parameters for using a Rabbit MQ broker as a source."}]},"SelfManagedKafkaParameters":{"allOf":[{"$ref":"#/components/schemas/PipeSourceSelfManagedKafkaParameters"},{"description":"The parameters for using a self-managed Apache Kafka stream as a source."}]},"SqsQueueParameters":{"allOf":[{"$ref":"#/components/schemas/PipeSourceSqsQueueParameters"},{"description":"The parameters for using a Amazon SQS stream as a source."}]}}},"Tags":{"description":"The list of key-value pairs to associate with the pipe.","type":"object","minProperties":1,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}},"Target":{"description":"The ARN of the target resource.","type":"string","pattern":"^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)$","minLength":1,"maxLength":1600},"TargetParameters":{"description":"The parameters required to set up a target for your pipe.","type":"object","properties":{"BatchJobParameters":{"allOf":[{"$ref":"#/components/schemas/PipeTargetBatchJobParameters"},{"description":"The parameters for using an Batch job as a target."}]},"CloudWatchLogsParameters":{"allOf":[{"$ref":"#/components/schemas/PipeTargetCloudWatchLogsParameters"},{"description":"The parameters for using an CloudWatch Logs log stream as a target."}]},"EcsTaskParameters":{"allOf":[{"$ref":"#/components/schemas/PipeTargetEcsTaskParameters"},{"description":"The parameters for using an Amazon ECS task as a target."}]},"EventBridgeEventBusParameters":{"allOf":[{"$ref":"#/components/schemas/PipeTargetEventBridgeEventBusParameters"},{"description":"The parameters for using an EventBridge event bus as a target."}]},"HttpParameters":{"allOf":[{"$ref":"#/components/schemas/PipeTargetHttpParameters"},{"description":"These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations."}]},"InputTemplate":{"allOf":[{"$ref":"#/components/schemas/InputTemplate"},{"description":"Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see <a href=\"http://www.rfc-editor.org/rfc/rfc7159.txt\">The JavaScript Object Notation (JSON) Data Interchange Format</a>."}]},"KinesisStreamParameters":{"allOf":[{"$ref":"#/components/schemas/PipeTargetKinesisStreamParameters"},{"description":"The parameters for using a Kinesis stream as a source."}]},"LambdaFunctionParameters":{"allOf":[{"$ref":"#/components/schemas/PipeTargetLambdaFunctionParameters"},{"description":"The parameters for using a Lambda function as a target."}]},"RedshiftDataParameters":{"allOf":[{"$ref":"#/components/schemas/PipeTargetRedshiftDataParameters"},{"description":"These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement."}]},"SageMakerPipelineParameters":{"allOf":[{"$ref":"#/components/schemas/PipeTargetSageMakerPipelineParameters"},{"description":"The parameters for using a SageMaker pipeline as a target."}]},"SqsQueueParameters":{"allOf":[{"$ref":"#/components/schemas/PipeTargetSqsQueueParameters"},{"description":"The parameters for using a Amazon SQS stream as a source."}]},"StepFunctionStateMachineParameters":{"allOf":[{"$ref":"#/components/schemas/PipeTargetStateMachineParameters"},{"description":"The parameters for using a Step Functions state machine as a target."}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"delete":{"operationId":"DeletePipe","description":"Delete an existing pipe. For more information about pipes, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html\">Amazon EventBridge Pipes</a> in the Amazon EventBridge User Guide.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletePipeResponse"}}}},"480":{"description":"InternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"Name","in":"path","required":true,"description":"The name of the pipe.","schema":{"type":"string","pattern":"^[\\.\\-_A-Za-z0-9]+$","minLength":1,"maxLength":64}}]},"get":{"operationId":"DescribePipe","description":"Get the information about an existing pipe. For more information about pipes, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html\">Amazon EventBridge Pipes</a> in the Amazon EventBridge User Guide.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribePipeResponse"}}}},"480":{"description":"InternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}}},"parameters":[{"name":"Name","in":"path","required":true,"description":"The name of the pipe.","schema":{"type":"string","pattern":"^[\\.\\-_A-Za-z0-9]+$","minLength":1,"maxLength":64}}]},"put":{"operationId":"UpdatePipe","description":"<p>Update an existing pipe. When you call <code>UpdatePipe</code>, only the fields that are included in the request are changed, the rest are unchanged. The exception to this is if you modify any Amazon Web Services-service specific fields in the <code>SourceParameters</code>, <code>EnrichmentParameters</code>, or <code>TargetParameters</code> objects. The fields in these objects are updated atomically as one and override existing values. This is by design and means that if you don't specify an optional field in one of these Parameters objects, that field will be set to its system-default value after the update.</p> <p>For more information about pipes, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html\"> Amazon EventBridge Pipes</a> in the Amazon EventBridge User Guide.</p>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePipeResponse"}}}},"480":{"description":"InternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"Name","in":"path","required":true,"description":"The name of the pipe.","schema":{"type":"string","pattern":"^[\\.\\-_A-Za-z0-9]+$","minLength":1,"maxLength":64}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RoleArn"],"properties":{"Description":{"description":"A description of the pipe.","type":"string","pattern":"^.*$","minLength":0,"maxLength":512,"format":"password"},"DesiredState":{"description":"The state the pipe should be in.","type":"string","enum":["RUNNING","STOPPED"]},"Enrichment":{"description":"The ARN of the enrichment resource.","type":"string","pattern":"^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)$","minLength":0,"maxLength":1600},"EnrichmentParameters":{"description":"The parameters required to set up enrichment on your pipe.","type":"object","properties":{"HttpParameters":{"allOf":[{"$ref":"#/components/schemas/PipeEnrichmentHttpParameters"},{"description":"<p>Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.</p> <p>If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.</p>"}]},"InputTemplate":{"allOf":[{"$ref":"#/components/schemas/InputTemplate"},{"description":"Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the enrichment. For more information, see <a href=\"http://www.rfc-editor.org/rfc/rfc7159.txt\">The JavaScript Object Notation (JSON) Data Interchange Format</a>."}]}}},"RoleArn":{"description":"The ARN of the role that allows the pipe to send data to the target.","type":"string","pattern":"^arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z0-9+=,.@\\-_/]+$","minLength":1,"maxLength":1600},"SourceParameters":{"description":"The parameters required to set up a source for your pipe.","type":"object","properties":{"ActiveMQBrokerParameters":{"allOf":[{"$ref":"#/components/schemas/UpdatePipeSourceActiveMQBrokerParameters"},{"description":"The parameters for using an Active MQ broker as a source."}]},"DynamoDBStreamParameters":{"allOf":[{"$ref":"#/components/schemas/UpdatePipeSourceDynamoDBStreamParameters"},{"description":"The parameters for using a DynamoDB stream as a source."}]},"FilterCriteria":{"allOf":[{"$ref":"#/components/schemas/FilterCriteria"},{"description":"The collection of event patterns used to filter events. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html\">Events and Event Patterns</a> in the <i>Amazon EventBridge User Guide</i>."}]},"KinesisStreamParameters":{"allOf":[{"$ref":"#/components/schemas/UpdatePipeSourceKinesisStreamParameters"},{"description":"The parameters for using a Kinesis stream as a source."}]},"ManagedStreamingKafkaParameters":{"allOf":[{"$ref":"#/components/schemas/UpdatePipeSourceManagedStreamingKafkaParameters"},{"description":"The parameters for using an MSK stream as a source."}]},"RabbitMQBrokerParameters":{"allOf":[{"$ref":"#/components/schemas/UpdatePipeSourceRabbitMQBrokerParameters"},{"description":"The parameters for using a Rabbit MQ broker as a source."}]},"SelfManagedKafkaParameters":{"allOf":[{"$ref":"#/components/schemas/UpdatePipeSourceSelfManagedKafkaParameters"},{"description":"The parameters for using a self-managed Apache Kafka stream as a source."}]},"SqsQueueParameters":{"allOf":[{"$ref":"#/components/schemas/UpdatePipeSourceSqsQueueParameters"},{"description":"The parameters for using a Amazon SQS stream as a source."}]}}},"Target":{"description":"The ARN of the target resource.","type":"string","pattern":"^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)$","minLength":1,"maxLength":1600},"TargetParameters":{"description":"The parameters required to set up a target for your pipe.","type":"object","properties":{"BatchJobParameters":{"allOf":[{"$ref":"#/components/schemas/PipeTargetBatchJobParameters"},{"description":"The parameters for using an Batch job as a target."}]},"CloudWatchLogsParameters":{"allOf":[{"$ref":"#/components/schemas/PipeTargetCloudWatchLogsParameters"},{"description":"The parameters for using an CloudWatch Logs log stream as a target."}]},"EcsTaskParameters":{"allOf":[{"$ref":"#/components/schemas/PipeTargetEcsTaskParameters"},{"description":"The parameters for using an Amazon ECS task as a target."}]},"EventBridgeEventBusParameters":{"allOf":[{"$ref":"#/components/schemas/PipeTargetEventBridgeEventBusParameters"},{"description":"The parameters for using an EventBridge event bus as a target."}]},"HttpParameters":{"allOf":[{"$ref":"#/components/schemas/PipeTargetHttpParameters"},{"description":"These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations."}]},"InputTemplate":{"allOf":[{"$ref":"#/components/schemas/InputTemplate"},{"description":"Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see <a href=\"http://www.rfc-editor.org/rfc/rfc7159.txt\">The JavaScript Object Notation (JSON) Data Interchange Format</a>."}]},"KinesisStreamParameters":{"allOf":[{"$ref":"#/components/schemas/PipeTargetKinesisStreamParameters"},{"description":"The parameters for using a Kinesis stream as a source."}]},"LambdaFunctionParameters":{"allOf":[{"$ref":"#/components/schemas/PipeTargetLambdaFunctionParameters"},{"description":"The parameters for using a Lambda function as a target."}]},"RedshiftDataParameters":{"allOf":[{"$ref":"#/components/schemas/PipeTargetRedshiftDataParameters"},{"description":"These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement."}]},"SageMakerPipelineParameters":{"allOf":[{"$ref":"#/components/schemas/PipeTargetSageMakerPipelineParameters"},{"description":"The parameters for using a SageMaker pipeline as a target."}]},"SqsQueueParameters":{"allOf":[{"$ref":"#/components/schemas/PipeTargetSqsQueueParameters"},{"description":"The parameters for using a Amazon SQS stream as a source."}]},"StepFunctionStateMachineParameters":{"allOf":[{"$ref":"#/components/schemas/PipeTargetStateMachineParameters"},{"description":"The parameters for using a Step Functions state machine as a target."}]}}}}}}}}}},"/v1/pipes":{"get":{"operationId":"ListPipes","description":"Get the pipes associated with this account. For more information about pipes, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html\">Amazon EventBridge Pipes</a> in the Amazon EventBridge User Guide.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPipesResponse"}}}},"480":{"description":"InternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"CurrentState","in":"query","required":false,"description":"The state the pipe is in.","schema":{"type":"string","enum":["RUNNING","STOPPED","CREATING","UPDATING","DELETING","STARTING","STOPPING","CREATE_FAILED","UPDATE_FAILED","START_FAILED","STOP_FAILED"]}},{"name":"DesiredState","in":"query","required":false,"description":"The state the pipe should be in.","schema":{"type":"string","enum":["RUNNING","STOPPED"]}},{"name":"Limit","in":"query","required":false,"description":"The maximum number of pipes to include in the response.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"NamePrefix","in":"query","required":false,"description":"A value that will return a subset of the pipes associated with this account. For example, <code>\"NamePrefix\": \"ABC\"</code> will return all endpoints with \"ABC\" in the name.","schema":{"type":"string","pattern":"^[\\.\\-_A-Za-z0-9]+$","minLength":1,"maxLength":64}},{"name":"NextToken","in":"query","required":false,"description":"If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.","schema":{"type":"string","minLength":1,"maxLength":2048,"format":"password"}},{"name":"SourcePrefix","in":"query","required":false,"description":"The prefix matching the pipe source.","schema":{"type":"string","minLength":1,"maxLength":1600}},{"name":"TargetPrefix","in":"query","required":false,"description":"The prefix matching the pipe target.","schema":{"type":"string","minLength":1,"maxLength":1600}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/tags/{resourceArn}":{"get":{"operationId":"ListTagsForResource","description":"Displays the tags associated with a pipe.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTagsForResourceResponse"}}}},"480":{"description":"InternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}}},"parameters":[{"name":"resourceArn","in":"path","required":true,"description":"The ARN of the pipe for which you want to view tags.","schema":{"type":"string","pattern":"^arn:aws([a-z]|\\-)*:([a-zA-Z0-9\\-]+):([a-z]|\\d|\\-)*:([0-9]{12})?:(.+)$","minLength":1,"maxLength":1600}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"operationId":"TagResource","description":"<p>Assigns one or more tags (key-value pairs) to the specified pipe. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.</p> <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.</p> <p>You can use the <code>TagResource</code> action with a pipe that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the pipe. If you specify a tag key that is already associated with the pipe, the new tag value that you specify replaces the previous value for that tag.</p> <p>You can associate as many as 50 tags with a pipe.</p>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagResourceResponse"}}}},"480":{"description":"InternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}}},"parameters":[{"name":"resourceArn","in":"path","required":true,"description":"The ARN of the pipe.","schema":{"type":"string","pattern":"^arn:aws([a-z]|\\-)*:([a-zA-Z0-9\\-]+):([a-z]|\\d|\\-)*:([0-9]{12})?:(.+)$","minLength":1,"maxLength":1600}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["tags"],"properties":{"tags":{"description":"The list of key-value pairs associated with the pipe.","type":"object","minProperties":1,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}}},"/v1/pipes/{Name}/start":{"post":{"operationId":"StartPipe","description":"Start an existing pipe.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartPipeResponse"}}}},"480":{"description":"InternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"Name","in":"path","required":true,"description":"The name of the pipe.","schema":{"type":"string","pattern":"^[\\.\\-_A-Za-z0-9]+$","minLength":1,"maxLength":64}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v1/pipes/{Name}/stop":{"post":{"operationId":"StopPipe","description":"Stop an existing pipe.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopPipeResponse"}}}},"480":{"description":"InternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"Name","in":"path","required":true,"description":"The name of the pipe.","schema":{"type":"string","pattern":"^[\\.\\-_A-Za-z0-9]+$","minLength":1,"maxLength":64}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/tags/{resourceArn}#tagKeys":{"delete":{"operationId":"UntagResource","description":"Removes one or more tags from the specified pipes.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UntagResourceResponse"}}}},"480":{"description":"InternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}}},"parameters":[{"name":"resourceArn","in":"path","required":true,"description":"The ARN of the pipe.","schema":{"type":"string","pattern":"^arn:aws([a-z]|\\-)*:([a-zA-Z0-9\\-]+):([a-z]|\\d|\\-)*:([0-9]{12})?:(.+)$","minLength":1,"maxLength":1600}},{"name":"tagKeys","in":"query","required":true,"description":"The list of tag keys to remove from the pipe.","schema":{"type":"array","items":{"$ref":"#/components/schemas/TagKey"},"minItems":0,"maxItems":50}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]}},"components":{"parameters":{"X-Amz-Content-Sha256":{"name":"X-Amz-Content-Sha256","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Date":{"name":"X-Amz-Date","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Algorithm":{"name":"X-Amz-Algorithm","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Credential":{"name":"X-Amz-Credential","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Security-Token":{"name":"X-Amz-Security-Token","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Signature":{"name":"X-Amz-Signature","in":"header","schema":{"type":"string"},"required":false},"X-Amz-SignedHeaders":{"name":"X-Amz-SignedHeaders","in":"header","schema":{"type":"string"},"required":false}},"securitySchemes":{"hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"Amazon Signature authorization v4","x-amazon-apigateway-authtype":"awsSigv4"}},"schemas":{"CreatePipeResponse":{"type":"object","properties":{"Arn":{"allOf":[{"$ref":"#/components/schemas/PipeArn"},{"description":"The ARN of the pipe."}]},"CreationTime":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"The time the pipe was created."}]},"CurrentState":{"allOf":[{"$ref":"#/components/schemas/PipeState"},{"description":"The state the pipe is in."}]},"DesiredState":{"allOf":[{"$ref":"#/components/schemas/RequestedPipeState"},{"description":"The state the pipe should be in."}]},"LastModifiedTime":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"When the pipe was last updated, in <a href=\"https://www.w3.org/TR/NOTE-datetime\">ISO-8601 format</a> (YYYY-MM-DDThh:mm:ss.sTZD)."}]},"Name":{"allOf":[{"$ref":"#/components/schemas/PipeName"},{"description":"The name of the pipe."}]}}},"PipeEnrichmentHttpParameters":{"type":"object","properties":{"HeaderParameters":{"allOf":[{"$ref":"#/components/schemas/HeaderParametersMap"},{"description":"The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination."}]},"PathParameterValues":{"allOf":[{"$ref":"#/components/schemas/PathParameterList"},{"description":"The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards (\"*\")."}]},"QueryStringParameters":{"allOf":[{"$ref":"#/components/schemas/QueryStringParametersMap"},{"description":"The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination."}]}},"description":"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 InvocationParameters specified on the Connection, with any values from the Connection taking precedence."},"InputTemplate":{"type":"string","minLength":0,"maxLength":8192,"format":"password"},"PipeSourceActiveMQBrokerParameters":{"type":"object","required":["Credentials","QueueName"],"properties":{"BatchSize":{"allOf":[{"$ref":"#/components/schemas/LimitMax10000"},{"description":"The maximum number of records to include in each batch."}]},"Credentials":{"allOf":[{"$ref":"#/components/schemas/MQBrokerAccessCredentials"},{"description":"The credentials needed to access the resource."}]},"MaximumBatchingWindowInSeconds":{"allOf":[{"$ref":"#/components/schemas/MaximumBatchingWindowInSeconds"},{"description":"The maximum length of a time to wait for events."}]},"QueueName":{"allOf":[{"$ref":"#/components/schemas/MQBrokerQueueName"},{"description":"The name of the destination queue to consume."}]}},"description":"The parameters for using an Active MQ broker as a source."},"PipeSourceDynamoDBStreamParameters":{"type":"object","required":["StartingPosition"],"properties":{"BatchSize":{"allOf":[{"$ref":"#/components/schemas/LimitMax10000"},{"description":"The maximum number of records to include in each batch."}]},"DeadLetterConfig":{"allOf":[{"$ref":"#/components/schemas/DeadLetterConfig"},{"description":"Define the target queue to send dead-letter queue events to."}]},"MaximumBatchingWindowInSeconds":{"allOf":[{"$ref":"#/components/schemas/MaximumBatchingWindowInSeconds"},{"description":"The maximum length of a time to wait for events."}]},"MaximumRecordAgeInSeconds":{"allOf":[{"$ref":"#/components/schemas/MaximumRecordAgeInSeconds"},{"description":"(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records. "}]},"MaximumRetryAttempts":{"allOf":[{"$ref":"#/components/schemas/MaximumRetryAttemptsESM"},{"description":"(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source."}]},"OnPartialBatchItemFailure":{"allOf":[{"$ref":"#/components/schemas/OnPartialBatchItemFailureStreams"},{"description":"(Streams only) Define how to handle item process failures. <code>AUTOMATIC_BISECT</code> halves each batch and retry each half until all the records are processed or there is one failed message left in the batch."}]},"ParallelizationFactor":{"allOf":[{"$ref":"#/components/schemas/LimitMax10"},{"description":"(Streams only) The number of batches to process concurrently from each shard. The default value is 1."}]},"StartingPosition":{"allOf":[{"$ref":"#/components/schemas/DynamoDBStreamStartPosition"},{"description":"(Streams only) The position in a stream from which to start reading."}]}},"description":"The parameters for using a DynamoDB stream as a source."},"FilterCriteria":{"type":"object","properties":{"Filters":{"allOf":[{"$ref":"#/components/schemas/FilterList"},{"description":"The event patterns."}]}},"description":"The collection of event patterns used to filter events. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html\">Events and Event Patterns</a> in the <i>Amazon EventBridge User Guide</i>."},"PipeSourceKinesisStreamParameters":{"type":"object","required":["StartingPosition"],"properties":{"BatchSize":{"allOf":[{"$ref":"#/components/schemas/LimitMax10000"},{"description":"The maximum number of records to include in each batch."}]},"DeadLetterConfig":{"allOf":[{"$ref":"#/components/schemas/DeadLetterConfig"},{"description":"Define the target queue to send dead-letter queue events to."}]},"MaximumBatchingWindowInSeconds":{"allOf":[{"$ref":"#/components/schemas/MaximumBatchingWindowInSeconds"},{"description":"The maximum length of a time to wait for events."}]},"MaximumRecordAgeInSeconds":{"allOf":[{"$ref":"#/components/schemas/MaximumRecordAgeInSeconds"},{"description":"(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records. "}]},"MaximumRetryAttempts":{"allOf":[{"$ref":"#/components/schemas/MaximumRetryAttemptsESM"},{"description":"(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source."}]},"OnPartialBatchItemFailure":{"allOf":[{"$ref":"#/components/schemas/OnPartialBatchItemFailureStreams"},{"description":"(Streams only) Define how to handle item process failures. <code>AUTOMATIC_BISECT</code> halves each batch and retry each half until all the records are processed or there is one failed message left in the batch."}]},"ParallelizationFactor":{"allOf":[{"$ref":"#/components/schemas/LimitMax10"},{"description":"(Streams only) The number of batches to process concurrently from each shard. The default value is 1."}]},"StartingPosition":{"allOf":[{"$ref":"#/components/schemas/KinesisStreamStartPosition"},{"description":"(Streams only) The position in a stream from which to start reading."}]},"StartingPositionTimestamp":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"With <code>StartingPosition</code> set to <code>AT_TIMESTAMP</code>, the time from which to start reading, in Unix time seconds."}]}},"description":"The parameters for using a Kinesis stream as a source."},"PipeSourceManagedStreamingKafkaParameters":{"type":"object","required":["TopicName"],"properties":{"BatchSize":{"allOf":[{"$ref":"#/components/schemas/LimitMax10000"},{"description":"The maximum number of records to include in each batch."}]},"ConsumerGroupID":{"allOf":[{"$ref":"#/components/schemas/URI"},{"description":"The name of the destination queue to consume."}]},"Credentials":{"allOf":[{"$ref":"#/components/schemas/MSKAccessCredentials"},{"description":"The credentials needed to access the resource."}]},"MaximumBatchingWindowInSeconds":{"allOf":[{"$ref":"#/components/schemas/MaximumBatchingWindowInSeconds"},{"description":"The maximum length of a time to wait for events."}]},"StartingPosition":{"allOf":[{"$ref":"#/components/schemas/MSKStartPosition"},{"description":"(Streams only) The position in a stream from which to start reading."}]},"TopicName":{"allOf":[{"$ref":"#/components/schemas/KafkaTopicName"},{"description":"The name of the topic that the pipe will read from."}]}},"description":"The parameters for using an MSK stream as a source."},"PipeSourceRabbitMQBrokerParameters":{"type":"object","required":["Credentials","QueueName"],"properties":{"BatchSize":{"allOf":[{"$ref":"#/components/schemas/LimitMax10000"},{"description":"The maximum number of records to include in each batch."}]},"Credentials":{"allOf":[{"$ref":"#/components/schemas/MQBrokerAccessCredentials"},{"description":"The credentials needed to access the resource."}]},"MaximumBatchingWindowInSeconds":{"allOf":[{"$ref":"#/components/schemas/MaximumBatchingWindowInSeconds"},{"description":"The maximum length of a time to wait for events."}]},"QueueName":{"allOf":[{"$ref":"#/components/schemas/MQBrokerQueueName"},{"description":"The name of the destination queue to consume."}]},"VirtualHost":{"allOf":[{"$ref":"#/components/schemas/URI"},{"description":"The name of the virtual host associated with the source broker."}]}},"description":"The parameters for using a Rabbit MQ broker as a source."},"PipeSourceSelfManagedKafkaParameters":{"type":"object","required":["TopicName"],"properties":{"AdditionalBootstrapServers":{"allOf":[{"$ref":"#/components/schemas/KafkaBootstrapServers"},{"description":"An array of server URLs."}]},"BatchSize":{"allOf":[{"$ref":"#/components/schemas/LimitMax10000"},{"description":"The maximum number of records to include in each batch."}]},"ConsumerGroupID":{"allOf":[{"$ref":"#/components/schemas/URI"},{"description":"The name of the destination queue to consume."}]},"Credentials":{"allOf":[{"$ref":"#/components/schemas/SelfManagedKafkaAccessConfigurationCredentials"},{"description":"The credentials needed to access the resource."}]},"MaximumBatchingWindowInSeconds":{"allOf":[{"$ref":"#/components/schemas/MaximumBatchingWindowInSeconds"},{"description":"The maximum length of a time to wait for events."}]},"ServerRootCaCertificate":{"allOf":[{"$ref":"#/components/schemas/SecretManagerArn"},{"description":"The ARN of the Secrets Manager secret used for certification."}]},"StartingPosition":{"allOf":[{"$ref":"#/components/schemas/SelfManagedKafkaStartPosition"},{"description":"(Streams only) The position in a stream from which to start reading."}]},"TopicName":{"allOf":[{"$ref":"#/components/schemas/KafkaTopicName"},{"description":"The name of the topic that the pipe will read from."}]},"Vpc":{"allOf":[{"$ref":"#/components/schemas/SelfManagedKafkaAccessConfigurationVpc"},{"description":"This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used."}]}},"description":"The parameters for using a self-managed Apache Kafka stream as a source."},"PipeSourceSqsQueueParameters":{"type":"object","properties":{"BatchSize":{"allOf":[{"$ref":"#/components/schemas/LimitMax10000"},{"description":"The maximum number of records to include in each batch."}]},"MaximumBatchingWindowInSeconds":{"allOf":[{"$ref":"#/components/schemas/MaximumBatchingWindowInSeconds"},{"description":"The maximum length of a time to wait for events."}]}},"description":"The parameters for using a Amazon SQS stream as a source."},"TagValue":{"type":"string","minLength":0,"maxLength":256,"format":"password"},"PipeTargetBatchJobParameters":{"type":"object","required":["JobDefinition","JobName"],"properties":{"ArrayProperties":{"allOf":[{"$ref":"#/components/schemas/BatchArrayProperties"},{"description":"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 job, it becomes an array job. This parameter is used only if the target is an Batch job."}]},"ContainerOverrides":{"allOf":[{"$ref":"#/components/schemas/BatchContainerOverrides"},{"description":"The overrides that are sent to a container."}]},"DependsOn":{"allOf":[{"$ref":"#/components/schemas/BatchDependsOn"},{"description":"A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a <code>SEQUENTIAL</code> type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an <code>N_TO_N</code> type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin."}]},"JobDefinition":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The job definition used by this job. This value can be one of <code>name</code>, <code>name:revision</code>, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used."}]},"JobName":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_)."}]},"Parameters":{"allOf":[{"$ref":"#/components/schemas/BatchParametersMap"},{"description":"Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition."}]},"RetryStrategy":{"allOf":[{"$ref":"#/components/schemas/BatchRetryStrategy"},{"description":"The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition."}]}},"description":"The parameters for using an Batch job as a target."},"PipeTargetCloudWatchLogsParameters":{"type":"object","properties":{"LogStreamName":{"allOf":[{"$ref":"#/components/schemas/LogStreamName"},{"description":"The name of the log stream."}]},"Timestamp":{"allOf":[{"$ref":"#/components/schemas/JsonPath"},{"description":"The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC."}]}},"description":"The parameters for using an CloudWatch Logs log stream as a target."},"PipeTargetEcsTaskParameters":{"type":"object","required":["TaskDefinitionArn"],"properties":{"CapacityProviderStrategy":{"allOf":[{"$ref":"#/components/schemas/CapacityProviderStrategy"},{"description":"<p>The capacity provider strategy to use for the task.</p> <p>If a <code>capacityProviderStrategy</code> is specified, the <code>launchType</code> parameter must be omitted. If no <code>capacityProviderStrategy</code> or launchType is specified, the <code>defaultCapacityProviderStrategy</code> for the cluster is used. </p>"}]},"EnableECSManagedTags":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"Specifies whether to enable Amazon ECS managed tags f