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' examples: CreatePipe200Example: summary: Default CreatePipe 200 response x-microcks-default: true value: Arn: arn:aws:service:us-east-1:123456789012:resource/example CreationTime: '2025-01-15T00:00:00Z' CurrentState: example DesiredState: example LastModifiedTime: '2025-01-15T00:00:00Z' '480': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' examples: CreatePipe480Example: summary: Default CreatePipe 480 response x-microcks-default: true value: {} '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: CreatePipe481Example: summary: Default CreatePipe 481 response x-microcks-default: true value: {} '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: CreatePipe482Example: summary: Default CreatePipe 482 response x-microcks-default: true value: {} '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: CreatePipe483Example: summary: Default CreatePipe 483 response x-microcks-default: true value: {} '484': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: CreatePipe484Example: summary: Default CreatePipe 484 response x-microcks-default: true value: {} '485': description: ServiceQuotaExceededException content: application/json: schema: $ref: '#/components/schemas/ServiceQuotaExceededException' examples: CreatePipe485Example: summary: Default CreatePipe 485 response x-microcks-default: true value: {} 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: '

Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.

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.

' 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 The JavaScript Object Notation (JSON) Data Interchange Format.' 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 Events and Event Patterns in the Amazon EventBridge User Guide.' 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 The JavaScript Object Notation (JSON) Data Interchange Format.' 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. examples: CreatePipeRequestExample: summary: Default CreatePipe request x-microcks-default: true value: Description: Example description DesiredState: RUNNING Enrichment: example EnrichmentParameters: {} RoleArn: arn:aws:service:us-east-1:123456789012:resource/example summary: Amazon EventBridge Pipes CreatePipe x-microcks-operation: delay: 0 dispatcher: FALLBACK 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 Amazon EventBridge Pipes in the Amazon EventBridge User Guide.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeletePipeResponse' examples: DeletePipe200Example: summary: Default DeletePipe 200 response x-microcks-default: true value: Arn: arn:aws:service:us-east-1:123456789012:resource/example CreationTime: '2025-01-15T00:00:00Z' CurrentState: example DesiredState: example LastModifiedTime: '2025-01-15T00:00:00Z' '480': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' examples: DeletePipe480Example: summary: Default DeletePipe 480 response x-microcks-default: true value: {} '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: DeletePipe481Example: summary: Default DeletePipe 481 response x-microcks-default: true value: {} '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: DeletePipe482Example: summary: Default DeletePipe 482 response x-microcks-default: true value: {} '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DeletePipe483Example: summary: Default DeletePipe 483 response x-microcks-default: true value: {} '484': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: DeletePipe484Example: summary: Default DeletePipe 484 response x-microcks-default: true value: {} 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 summary: Amazon EventBridge Pipes DeletePipe x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: DescribePipe description: 'Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribePipeResponse' examples: DescribePipe200Example: summary: Default DescribePipe 200 response x-microcks-default: true value: Arn: arn:aws:service:us-east-1:123456789012:resource/example CreationTime: '2025-01-15T00:00:00Z' CurrentState: example Description: Example description DesiredState: example '480': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' examples: DescribePipe480Example: summary: Default DescribePipe 480 response x-microcks-default: true value: {} '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: DescribePipe481Example: summary: Default DescribePipe 481 response x-microcks-default: true value: {} '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: DescribePipe482Example: summary: Default DescribePipe 482 response x-microcks-default: true value: {} '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DescribePipe483Example: summary: Default DescribePipe 483 response x-microcks-default: true value: {} 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 summary: Amazon EventBridge Pipes DescribePipe x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: UpdatePipe description: '

Update an existing pipe. When you call UpdatePipe, 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 SourceParameters, EnrichmentParameters, or TargetParameters 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.

For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdatePipeResponse' examples: UpdatePipe200Example: summary: Default UpdatePipe 200 response x-microcks-default: true value: Arn: arn:aws:service:us-east-1:123456789012:resource/example CreationTime: '2025-01-15T00:00:00Z' CurrentState: example DesiredState: example LastModifiedTime: '2025-01-15T00:00:00Z' '480': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' examples: UpdatePipe480Example: summary: Default UpdatePipe 480 response x-microcks-default: true value: {} '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: UpdatePipe481Example: summary: Default UpdatePipe 481 response x-microcks-default: true value: {} '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: UpdatePipe482Example: summary: Default UpdatePipe 482 response x-microcks-default: true value: {} '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: UpdatePipe483Example: summary: Default UpdatePipe 483 response x-microcks-default: true value: {} '484': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: UpdatePipe484Example: summary: Default UpdatePipe 484 response x-microcks-default: true value: {} 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: '

Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.

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.

' 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 The JavaScript Object Notation (JSON) Data Interchange Format.' 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 Events and Event Patterns in the Amazon EventBridge User Guide.' 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 The JavaScript Object Notation (JSON) Data Interchange Format.' 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. examples: UpdatePipeRequestExample: summary: Default UpdatePipe request x-microcks-default: true value: Description: Example description DesiredState: RUNNING Enrichment: example EnrichmentParameters: {} RoleArn: arn:aws:service:us-east-1:123456789012:resource/example summary: Amazon EventBridge Pipes UpdatePipe x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1/pipes: get: operationId: ListPipes description: 'Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListPipesResponse' examples: ListPipes200Example: summary: Default ListPipes 200 response x-microcks-default: true value: NextToken: example Pipes: example '480': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' examples: ListPipes480Example: summary: Default ListPipes 480 response x-microcks-default: true value: {} '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: ListPipes481Example: summary: Default ListPipes 481 response x-microcks-default: true value: {} '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: ListPipes482Example: summary: Default ListPipes 482 response x-microcks-default: true value: {} 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, "NamePrefix": "ABC" 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 nextToken is returned, there are more results available. The value of nextToken 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 summary: Amazon EventBridge Pipes ListPipes x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' examples: ListTagsForResource200Example: summary: Default ListTagsForResource 200 response x-microcks-default: true value: tags: example '480': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' examples: ListTagsForResource480Example: summary: Default ListTagsForResource 480 response x-microcks-default: true value: {} '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: ListTagsForResource481Example: summary: Default ListTagsForResource 481 response x-microcks-default: true value: {} '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: ListTagsForResource482Example: summary: Default ListTagsForResource 482 response x-microcks-default: true value: {} 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 summary: Amazon EventBridge Pipes ListTagsForResource x-microcks-operation: delay: 0 dispatcher: FALLBACK 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: '

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.

Tags don''t have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the TagResource 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.

You can associate as many as 50 tags with a pipe.

' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TagResourceResponse' examples: TagResource200Example: summary: Default TagResource 200 response x-microcks-default: true value: {} '480': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' examples: TagResource480Example: summary: Default TagResource 480 response x-microcks-default: true value: {} '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: TagResource481Example: summary: Default TagResource 481 response x-microcks-default: true value: {} '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: TagResource482Example: summary: Default TagResource 482 response x-microcks-default: true value: {} 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' examples: TagResourceRequestExample: summary: Default TagResource request x-microcks-default: true value: tags: {} summary: Amazon EventBridge Pipes TagResource x-microcks-operation: delay: 0 dispatcher: FALLBACK '/v1/pipes/{Name}/start': post: operationId: StartPipe description: Start an existing pipe. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartPipeResponse' examples: StartPipe200Example: summary: Default StartPipe 200 response x-microcks-default: true value: Arn: arn:aws:service:us-east-1:123456789012:resource/example CreationTime: '2025-01-15T00:00:00Z' CurrentState: example DesiredState: example LastModifiedTime: '2025-01-15T00:00:00Z' '480': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' examples: StartPipe480Example: summary: Default StartPipe 480 response x-microcks-default: true value: {} '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: StartPipe481Example: summary: Default StartPipe 481 response x-microcks-default: true value: {} '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: StartPipe482Example: summary: Default StartPipe 482 response x-microcks-default: true value: {} '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: StartPipe483Example: summary: Default StartPipe 483 response x-microcks-default: true value: {} '484': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: StartPipe484Example: summary: Default StartPipe 484 response x-microcks-default: true value: {} 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 summary: Amazon EventBridge Pipes StartPipe x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' examples: StopPipe200Example: summary: Default StopPipe 200 response x-microcks-default: true value: Arn: arn:aws:service:us-east-1:123456789012:resource/example CreationTime: '2025-01-15T00:00:00Z' CurrentState: example DesiredState: example LastModifiedTime: '2025-01-15T00:00:00Z' '480': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' examples: StopPipe480Example: summary: Default StopPipe 480 response x-microcks-default: true value: {} '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: StopPipe481Example: summary: Default StopPipe 481 response x-microcks-default: true value: {} '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: StopPipe482Example: summary: Default StopPipe 482 response x-microcks-default: true value: {} '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: StopPipe483Example: summary: Default StopPipe 483 response x-microcks-default: true value: {} '484': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: StopPipe484Example: summary: Default StopPipe 484 response x-microcks-default: true value: {} 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 summary: Amazon EventBridge Pipes StopPipe x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' examples: UntagResource200Example: summary: Default UntagResource 200 response x-microcks-default: true value: {} '480': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' examples: UntagResource480Example: summary: Default UntagResource 480 response x-microcks-default: true value: {} '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: UntagResource481Example: summary: Default UntagResource 481 response x-microcks-default: true value: {} '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: UntagResource482Example: summary: Default UntagResource 482 response x-microcks-default: true value: {} 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 summary: Amazon EventBridge Pipes UntagResource x-microcks-operation: delay: 0 dispatcher: FALLBACK 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 ISO-8601 format (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. AUTOMATIC_BISECT 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 Events and Event Patterns in the Amazon EventBridge User Guide.' 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. AUTOMATIC_BISECT 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 StartingPosition set to AT_TIMESTAMP, 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 SEQUENTIAL 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 N_TO_N 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 name, name:revision, 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: '

The capacity provider strategy to use for the task.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

' EnableECSManagedTags: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide. ' EnableExecuteCommand: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.' Group: allOf: - $ref: '#/components/schemas/String' - description: Specifies an Amazon ECS task group for the task. The maximum length is 255 characters. LaunchType: allOf: - $ref: '#/components/schemas/LaunchType' - description: 'Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.' NetworkConfiguration: allOf: - $ref: '#/components/schemas/NetworkConfiguration' - description: '

Use this structure if the Amazon ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks.

If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.

' Overrides: allOf: - $ref: '#/components/schemas/EcsTaskOverride' - description: The overrides that are associated with a task. PlacementConstraints: allOf: - $ref: '#/components/schemas/PlacementConstraints' - description: An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime). PlacementStrategy: allOf: - $ref: '#/components/schemas/PlacementStrategies' - description: 'The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task. ' PlatformVersion: allOf: - $ref: '#/components/schemas/String' - description: '

Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.

This structure is used only if LaunchType is FARGATE. For more information about valid platform versions, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

' PropagateTags: allOf: - $ref: '#/components/schemas/PropagateTags' - description: 'Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action. ' ReferenceId: allOf: - $ref: '#/components/schemas/ReferenceId' - description: The reference ID to use for the task. Tags: allOf: - $ref: '#/components/schemas/TagList' - description: 'The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.' TaskCount: allOf: - $ref: '#/components/schemas/LimitMin1' - description: The number of tasks to create based on TaskDefinition. The default is 1. TaskDefinitionArn: allOf: - $ref: '#/components/schemas/ArnOrJsonPath' - description: 'The ARN of the task definition to use if the event target is an Amazon ECS task. ' description: The parameters for using an Amazon ECS task as a target. PipeTargetEventBridgeEventBusParameters: type: object properties: DetailType: allOf: - $ref: '#/components/schemas/EventBridgeDetailType' - description: 'A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.' EndpointId: allOf: - $ref: '#/components/schemas/EventBridgeEndpointId' - description: '

The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.

When using Java, you must include auth-crt on the class path.

' Resources: allOf: - $ref: '#/components/schemas/EventBridgeEventResourceList' - description: 'Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.' Source: allOf: - $ref: '#/components/schemas/EventBridgeEventSource' - description: The source of the event. Time: allOf: - $ref: '#/components/schemas/JsonPath' - description: 'The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.' description: The parameters for using an EventBridge event bus as a target. PipeTargetHttpParameters: 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. PipeTargetKinesisStreamParameters: type: object required: - PartitionKey properties: PartitionKey: allOf: - $ref: '#/components/schemas/KinesisPartitionKey' - description: 'Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.' description: The parameters for using a Kinesis stream as a source. PipeTargetLambdaFunctionParameters: type: object properties: InvocationType: allOf: - $ref: '#/components/schemas/PipeTargetInvocationType' - description:

Choose from the following options.

description: The parameters for using a Lambda function as a target. PipeTargetRedshiftDataParameters: type: object required: - Database - Sqls properties: Database: allOf: - $ref: '#/components/schemas/Database' - description: The name of the database. Required when authenticating using temporary credentials. DbUser: allOf: - $ref: '#/components/schemas/DbUser' - description: The database user name. Required when authenticating using temporary credentials. SecretManagerArn: allOf: - $ref: '#/components/schemas/SecretManagerArnOrJsonPath' - description: The name or ARN of the secret that enables access to the database. Required when authenticating using SageMaker. Sqls: allOf: - $ref: '#/components/schemas/Sqls' - description: The SQL statement text to run. StatementName: allOf: - $ref: '#/components/schemas/StatementName' - description: The name of the SQL statement. You can name the SQL statement when you create it to identify the query. WithEvent: allOf: - $ref: '#/components/schemas/Boolean' - description: Indicates whether to send an event back to EventBridge after the SQL statement runs. description: These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement. PipeTargetSageMakerPipelineParameters: type: object properties: PipelineParameterList: allOf: - $ref: '#/components/schemas/SageMakerPipelineParameterList' - description: List of Parameter names and values for SageMaker Model Building Pipeline execution. description: The parameters for using a SageMaker pipeline as a target. PipeTargetSqsQueueParameters: type: object properties: MessageDeduplicationId: allOf: - $ref: '#/components/schemas/MessageDeduplicationId' - description:

This parameter applies only to FIFO (first-in-first-out) queues.

The token used for deduplication of sent messages.

MessageGroupId: allOf: - $ref: '#/components/schemas/MessageGroupId' - description: The FIFO message group ID to use as the target. description: The parameters for using a Amazon SQS stream as a source. PipeTargetStateMachineParameters: type: object properties: InvocationType: allOf: - $ref: '#/components/schemas/PipeTargetInvocationType' - description: Specify whether to wait for the state machine to finish or not. description: The parameters for using a Step Functions state machine as a target. InternalException: {} ValidationException: {} ThrottlingException: {} NotFoundException: {} ConflictException: {} ServiceQuotaExceededException: {} DeletePipeResponse: 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/RequestedPipeStateDescribeResponse' - description: The state the pipe should be in. LastModifiedTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).' Name: allOf: - $ref: '#/components/schemas/PipeName' - description: The name of the pipe. DescribePipeResponse: 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. Description: allOf: - $ref: '#/components/schemas/PipeDescription' - description: A description of the pipe. DesiredState: allOf: - $ref: '#/components/schemas/RequestedPipeStateDescribeResponse' - description: The state the pipe should be in. Enrichment: allOf: - $ref: '#/components/schemas/OptionalArn' - description: The ARN of the enrichment resource. EnrichmentParameters: allOf: - $ref: '#/components/schemas/PipeEnrichmentParameters' - description: The parameters required to set up enrichment on your pipe. LastModifiedTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).' Name: allOf: - $ref: '#/components/schemas/PipeName' - description: The name of the pipe. RoleArn: allOf: - $ref: '#/components/schemas/RoleArn' - description: The ARN of the role that allows the pipe to send data to the target. Source: allOf: - $ref: '#/components/schemas/ArnOrUrl' - description: The ARN of the source resource. SourceParameters: allOf: - $ref: '#/components/schemas/PipeSourceParameters' - description: The parameters required to set up a source for your pipe. StateReason: allOf: - $ref: '#/components/schemas/PipeStateReason' - description: The reason the pipe is in its current state. Tags: allOf: - $ref: '#/components/schemas/TagMap' - description: The list of key-value pairs to associate with the pipe. Target: allOf: - $ref: '#/components/schemas/Arn' - description: The ARN of the target resource. TargetParameters: allOf: - $ref: '#/components/schemas/PipeTargetParameters' - description: The parameters required to set up a target for your pipe. ListPipesResponse: type: object properties: NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: 'If nextToken is returned, there are more results available. The value of nextToken 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.' Pipes: allOf: - $ref: '#/components/schemas/PipeList' - description: The pipes returned by the call. ListTagsForResourceResponse: type: object properties: tags: allOf: - $ref: '#/components/schemas/TagMap' - description: The list of key-value pairs to associate with the pipe. StartPipeResponse: 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 ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).' Name: allOf: - $ref: '#/components/schemas/PipeName' - description: The name of the pipe. StopPipeResponse: 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 ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).' Name: allOf: - $ref: '#/components/schemas/PipeName' - description: The name of the pipe. TagResourceResponse: type: object properties: {} UntagResourceResponse: type: object properties: {} TagKey: type: string minLength: 1 maxLength: 128 UpdatePipeResponse: 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 ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).' Name: allOf: - $ref: '#/components/schemas/PipeName' - description: The name of the pipe. UpdatePipeSourceActiveMQBrokerParameters: type: object required: - Credentials 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. description: The parameters for using an Active MQ broker as a source. UpdatePipeSourceDynamoDBStreamParameters: type: object 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. AUTOMATIC_BISECT 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. description: The parameters for using a DynamoDB stream as a source. UpdatePipeSourceKinesisStreamParameters: type: object 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. AUTOMATIC_BISECT 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. description: The parameters for using a Kinesis stream as a source. UpdatePipeSourceManagedStreamingKafkaParameters: type: object properties: BatchSize: allOf: - $ref: '#/components/schemas/LimitMax10000' - description: The maximum number of records to include in each batch. 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. description: The parameters for using an MSK stream as a source. UpdatePipeSourceRabbitMQBrokerParameters: type: object required: - Credentials 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. description: The parameters for using a Rabbit MQ broker as a source. UpdatePipeSourceSelfManagedKafkaParameters: type: object properties: BatchSize: allOf: - $ref: '#/components/schemas/LimitMax10000' - description: The maximum number of records to include in each batch. 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. 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. UpdatePipeSourceSqsQueueParameters: 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. Arn: 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 ArnOrJsonPath: 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})?:(.+)|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$' minLength: 1 maxLength: 1600 ArnOrUrl: 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 AssignPublicIp: type: string enum: - ENABLED - DISABLED SecurityGroups: type: array items: $ref: '#/components/schemas/SecurityGroup' minItems: 0 maxItems: 5 Subnets: type: array items: $ref: '#/components/schemas/Subnet' minItems: 0 maxItems: 16 AwsVpcConfiguration: type: object required: - Subnets properties: AssignPublicIp: allOf: - $ref: '#/components/schemas/AssignPublicIp' - description: Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE. SecurityGroups: allOf: - $ref: '#/components/schemas/SecurityGroups' - description: 'Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.' Subnets: allOf: - $ref: '#/components/schemas/Subnets' - description: Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets. description: '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 ECS tasks that use the awsvpc network mode.' BatchArraySize: type: integer minimum: 2 maximum: 10000 BatchArrayProperties: type: object properties: Size: allOf: - $ref: '#/components/schemas/BatchArraySize' - description: 'The size of the array, if this is an array batch job.' 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.' StringList: type: array items: $ref: '#/components/schemas/String' BatchEnvironmentVariableList: type: array items: $ref: '#/components/schemas/BatchEnvironmentVariable' String: type: string BatchResourceRequirementsList: type: array items: $ref: '#/components/schemas/BatchResourceRequirement' BatchContainerOverrides: type: object properties: Command: allOf: - $ref: '#/components/schemas/StringList' - description: The command to send to the container that overrides the default command from the Docker image or the task definition. Environment: allOf: - $ref: '#/components/schemas/BatchEnvironmentVariableList' - description: '

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 existing environment variables from the Docker image or the task definition.

Environment variables cannot start with "Batch". This naming convention is reserved for variables that Batch sets.

' InstanceType: allOf: - $ref: '#/components/schemas/String' - description: '

The instance type to use for a multi-node parallel job.

This parameter isn''t applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn''t be provided.

' ResourceRequirements: allOf: - $ref: '#/components/schemas/BatchResourceRequirementsList' - description: 'The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.' description: The overrides that are sent to a container. BatchJobDependency: type: object properties: JobId: allOf: - $ref: '#/components/schemas/String' - description: The job ID of the Batch job that's associated with this dependency. Type: allOf: - $ref: '#/components/schemas/BatchJobDependencyType' - description: The type of the job dependency. description: An object that represents an Batch job dependency. BatchDependsOn: type: array items: $ref: '#/components/schemas/BatchJobDependency' minItems: 0 maxItems: 20 BatchEnvironmentVariable: type: object properties: Name: allOf: - $ref: '#/components/schemas/String' - description: 'The name of the key-value pair. For environment variables, this is the name of the environment variable.' Value: allOf: - $ref: '#/components/schemas/String' - description: 'The value of the key-value pair. For environment variables, this is the value of the environment variable.' description: '

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 existing environment variables from the Docker image or the task definition.

Environment variables cannot start with "Batch". This naming convention is reserved for variables that Batch sets.

' BatchJobDependencyType: type: string enum: - N_TO_N - SEQUENTIAL BatchParametersMap: type: object additionalProperties: $ref: '#/components/schemas/String' BatchResourceRequirementType: type: string enum: - GPU - MEMORY - VCPU BatchResourceRequirement: type: object required: - Type - Value properties: Type: allOf: - $ref: '#/components/schemas/BatchResourceRequirementType' - description: 'The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.' Value: allOf: - $ref: '#/components/schemas/String' - description: '

The quantity of the specified resource to reserve for the container. The values vary based on the type specified.

type="GPU"

The number of physical GPUs to reserve for the container. Make sure that the number of GPUs reserved for all containers in a job doesn''t exceed the number of available GPUs on the compute resource that the job is launched on.

GPUs aren''t available for jobs that are running on Fargate resources.
type="MEMORY"

The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

If you''re trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory management in the Batch User Guide.

For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.

value = 512

VCPU = 0.25

value = 1024

VCPU = 0.25 or 0.5

value = 2048

VCPU = 0.25, 0.5, or 1

value = 3072

VCPU = 0.5, or 1

value = 4096

VCPU = 0.5, 1, or 2

value = 5120, 6144, or 7168

VCPU = 1 or 2

value = 8192

VCPU = 1, 2, 4, or 8

value = 9216, 10240, 11264, 12288, 13312, 14336, or 15360

VCPU = 2 or 4

value = 16384

VCPU = 2, 4, or 8

value = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696, or 30720

VCPU = 4

value = 20480, 24576, or 28672

VCPU = 4 or 8

value = 36864, 45056, 53248, or 61440

VCPU = 8

value = 32768, 40960, 49152, or 57344

VCPU = 8 or 16

value = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880

VCPU = 16

type="VCPU"

The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.

The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about Fargate quotas, see Fargate quotas in the Amazon Web Services General Reference.

For jobs that are running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16

value = 0.25

MEMORY = 512, 1024, or 2048

value = 0.5

MEMORY = 1024, 2048, 3072, or 4096

value = 1

MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

value = 2

MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

value = 4

MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

value = 8

MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440

value = 16

MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880

' description: 'The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.' BatchRetryAttempts: type: integer minimum: 1 maximum: 10 BatchRetryStrategy: type: object properties: Attempts: allOf: - $ref: '#/components/schemas/BatchRetryAttempts' - description: 'The number of times to move a job to the RUNNABLE status. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.' description: 'The retry strategy that''s associated with a job. For more information, see Automated job retries in the Batch User Guide.' Boolean: type: boolean CapacityProvider: type: string minLength: 1 maxLength: 255 format: password CapacityProviderStrategyItem: type: object required: - capacityProvider properties: base: allOf: - $ref: '#/components/schemas/CapacityProviderStrategyItemBase' - description: 'The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used. ' capacityProvider: allOf: - $ref: '#/components/schemas/CapacityProvider' - description: The short name of the capacity provider. weight: allOf: - $ref: '#/components/schemas/CapacityProviderStrategyItemWeight' - description: 'The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.' description: 'The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem in the Amazon ECS API Reference.' CapacityProviderStrategy: type: array items: $ref: '#/components/schemas/CapacityProviderStrategyItem' minItems: 0 maxItems: 6 CapacityProviderStrategyItemBase: type: integer minimum: 0 maximum: 100000 CapacityProviderStrategyItemWeight: type: integer minimum: 0 maximum: 1000 PipeDescription: type: string pattern: ^.*$ minLength: 0 maxLength: 512 format: password RequestedPipeState: type: string enum: - RUNNING - STOPPED OptionalArn: 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 PipeEnrichmentParameters: type: object properties: HttpParameters: allOf: - $ref: '#/components/schemas/PipeEnrichmentHttpParameters' - description: '

Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.

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.

' 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 The JavaScript Object Notation (JSON) Data Interchange Format.' description: The parameters required to set up enrichment on your pipe. PipeName: type: string pattern: '^[\.\-_A-Za-z0-9]+$' minLength: 1 maxLength: 64 RoleArn: type: string pattern: '^arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z0-9+=,.@\-_/]+$' minLength: 1 maxLength: 1600 PipeSourceParameters: 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 Events and Event Patterns in the Amazon EventBridge User Guide.' 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. description: The parameters required to set up a source for your pipe. TagMap: type: object minProperties: 1 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' PipeTargetParameters: 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 The JavaScript Object Notation (JSON) Data Interchange Format.' 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. description: The parameters required to set up a target for your pipe. CreatePipeRequest: type: object required: - RoleArn - Source - Target title: CreatePipeRequest properties: Description: allOf: - $ref: '#/components/schemas/PipeDescription' - description: A description of the pipe. DesiredState: allOf: - $ref: '#/components/schemas/RequestedPipeState' - description: The state the pipe should be in. Enrichment: allOf: - $ref: '#/components/schemas/OptionalArn' - description: The ARN of the enrichment resource. EnrichmentParameters: allOf: - $ref: '#/components/schemas/PipeEnrichmentParameters' - description: The parameters required to set up enrichment on your pipe. RoleArn: allOf: - $ref: '#/components/schemas/RoleArn' - description: The ARN of the role that allows the pipe to send data to the target. Source: allOf: - $ref: '#/components/schemas/ArnOrUrl' - description: The ARN of the source resource. SourceParameters: allOf: - $ref: '#/components/schemas/PipeSourceParameters' - description: The parameters required to set up a source for your pipe. Tags: allOf: - $ref: '#/components/schemas/TagMap' - description: The list of key-value pairs to associate with the pipe. Target: allOf: - $ref: '#/components/schemas/Arn' - description: The ARN of the target resource. TargetParameters: allOf: - $ref: '#/components/schemas/PipeTargetParameters' - description: The parameters required to set up a target for your pipe. PipeArn: type: string pattern: '^arn:aws([a-z]|\-)*:([a-zA-Z0-9\-]+):([a-z]|\d|\-)*:([0-9]{12})?:(.+)$' minLength: 1 maxLength: 1600 Timestamp: type: string format: date-time PipeState: type: string enum: - RUNNING - STOPPED - CREATING - UPDATING - DELETING - STARTING - STOPPING - CREATE_FAILED - UPDATE_FAILED - START_FAILED - STOP_FAILED Database: type: string description: // Redshift Database minLength: 1 maxLength: 64 format: password DbUser: type: string description: // Database user name minLength: 1 maxLength: 128 format: password DeadLetterConfig: type: object properties: Arn: allOf: - $ref: '#/components/schemas/Arn' - description: The ARN of the Amazon SQS queue specified as the target for the dead-letter queue. description: A DeadLetterConfig object that contains information about a dead-letter queue configuration. DeletePipeRequest: type: object title: DeletePipeRequest properties: {} RequestedPipeStateDescribeResponse: type: string enum: - RUNNING - STOPPED - DELETED DescribePipeRequest: type: object title: DescribePipeRequest properties: {} PipeStateReason: type: string pattern: ^.*$ minLength: 0 maxLength: 512 DynamoDBStreamStartPosition: type: string enum: - TRIM_HORIZON - LATEST Integer: type: integer EcsEnvironmentVariableList: type: array items: $ref: '#/components/schemas/EcsEnvironmentVariable' EcsEnvironmentFileList: type: array items: $ref: '#/components/schemas/EcsEnvironmentFile' EcsResourceRequirementsList: type: array items: $ref: '#/components/schemas/EcsResourceRequirement' EcsContainerOverride: type: object properties: Command: allOf: - $ref: '#/components/schemas/StringList' - description: The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name. Cpu: allOf: - $ref: '#/components/schemas/Integer' - description: 'The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.' Environment: allOf: - $ref: '#/components/schemas/EcsEnvironmentVariableList' - description: '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 existing environment variables from the Docker image or the task definition. You must also specify a container name.' EnvironmentFiles: allOf: - $ref: '#/components/schemas/EcsEnvironmentFileList' - description: 'A list of files containing the environment variables to pass to a container, instead of the value from the container definition.' Memory: allOf: - $ref: '#/components/schemas/Integer' - description: 'The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.' MemoryReservation: allOf: - $ref: '#/components/schemas/Integer' - description: 'The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.' Name: allOf: - $ref: '#/components/schemas/String' - description: The name of the container that receives the override. This parameter is required if any override is specified. ResourceRequirements: allOf: - $ref: '#/components/schemas/EcsResourceRequirementsList' - description: 'The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.' description: '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": [ ] }. If a non-empty container override is specified, the name parameter must be included.' EcsContainerOverrideList: type: array items: $ref: '#/components/schemas/EcsContainerOverride' EcsEnvironmentFileType: type: string enum: - s3 EcsEnvironmentFile: type: object required: - type - value properties: type: allOf: - $ref: '#/components/schemas/EcsEnvironmentFileType' - description: The file type to use. The only supported value is s3. value: allOf: - $ref: '#/components/schemas/String' - description: The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file. description: '

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 extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file.

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they''re processed from the top down. We recommend that you use unique variable names. For more information, see Specifying environment variables in the Amazon Elastic Container Service Developer Guide.

This parameter is only supported for tasks hosted on Fargate using the following platform versions:

' EcsEnvironmentVariable: type: object properties: name: allOf: - $ref: '#/components/schemas/String' - description: 'The name of the key-value pair. For environment variables, this is the name of the environment variable.' value: allOf: - $ref: '#/components/schemas/String' - description: 'The value of the key-value pair. For environment variables, this is the value of the environment variable.' description: '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 existing environment variables from the Docker image or the task definition. You must also specify a container name.' EphemeralStorageSize: type: integer minimum: 21 maximum: 200 EcsEphemeralStorage: type: object required: - sizeInGiB properties: sizeInGiB: allOf: - $ref: '#/components/schemas/EphemeralStorageSize' - description: 'The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.' description: '

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 amount, for tasks hosted on Fargate. For more information, see Fargate task storage in the Amazon ECS User Guide for Fargate.

This parameter is only supported for tasks hosted on Fargate using Linux platform version 1.4.0 or later. This parameter is not supported for Windows containers on Fargate.

' EcsInferenceAcceleratorOverride: type: object properties: deviceName: allOf: - $ref: '#/components/schemas/String' - description: The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition. deviceType: allOf: - $ref: '#/components/schemas/String' - description: The Elastic Inference accelerator type to use. description: 'Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.' EcsInferenceAcceleratorOverrideList: type: array items: $ref: '#/components/schemas/EcsInferenceAcceleratorOverride' EcsResourceRequirementType: type: string enum: - GPU - InferenceAccelerator EcsResourceRequirement: type: object required: - type - value properties: type: allOf: - $ref: '#/components/schemas/EcsResourceRequirementType' - description: The type of resource to assign to a container. The supported values are GPU or InferenceAccelerator. value: allOf: - $ref: '#/components/schemas/String' - description: '

The value for the specified resource type.

If the GPU type is used, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that''s reserved for all containers in a task can''t exceed the number of available GPUs on the container instance that the task is launched on.

If the InferenceAccelerator type is used, the value matches the deviceName for an InferenceAccelerator specified in a task definition.

' description: '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 Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide ' EcsTaskOverride: type: object properties: ContainerOverrides: allOf: - $ref: '#/components/schemas/EcsContainerOverrideList' - description: One or more container overrides that are sent to a task. Cpu: allOf: - $ref: '#/components/schemas/String' - description: The cpu override for the task. EphemeralStorage: allOf: - $ref: '#/components/schemas/EcsEphemeralStorage' - description: '

The ephemeral storage setting override for the task.

This parameter is only supported for tasks hosted on Fargate that use the following platform versions:

' ExecutionRoleArn: allOf: - $ref: '#/components/schemas/ArnOrJsonPath' - description: 'The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.' InferenceAcceleratorOverrides: allOf: - $ref: '#/components/schemas/EcsInferenceAcceleratorOverrideList' - description: The Elastic Inference accelerator override for the task. Memory: allOf: - $ref: '#/components/schemas/String' - description: The memory override for the task. TaskRoleArn: allOf: - $ref: '#/components/schemas/ArnOrJsonPath' - description: 'The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Role for Tasks in the Amazon Elastic Container Service Developer Guide.' description: The overrides that are associated with a task. EndpointString: type: string pattern: '^(([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}$' minLength: 1 maxLength: 300 format: password EventBridgeDetailType: type: string minLength: 1 maxLength: 128 format: password EventBridgeEndpointId: type: string pattern: '^[A-Za-z0-9\-]+[\.][A-Za-z0-9\-]+$' minLength: 1 maxLength: 50 format: password EventBridgeEventResourceList: type: array items: $ref: '#/components/schemas/ArnOrJsonPath' minItems: 0 maxItems: 10 EventBridgeEventSource: type: string pattern: '(?=[/\.\-_A-Za-z0-9]+)((?!aws\.).*)|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)' minLength: 1 maxLength: 256 format: password EventPattern: type: string minLength: 0 maxLength: 4096 format: password Filter: type: object properties: Pattern: allOf: - $ref: '#/components/schemas/EventPattern' - description: The event pattern. description: 'Filter events using an event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.' FilterList: type: array items: $ref: '#/components/schemas/Filter' minItems: 0 maxItems: 5 HeaderKey: type: string pattern: '^[!#$%&''*+-.^_`|~0-9a-zA-Z]+|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$' minLength: 0 maxLength: 512 HeaderValue: type: string pattern: '^[ \t]*[\x20-\x7E]+([ \t]+[\x20-\x7E]+)*[ \t]*|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$' minLength: 0 maxLength: 512 format: password HeaderParametersMap: type: object additionalProperties: $ref: '#/components/schemas/HeaderValue' JsonPath: type: string pattern: '^\$(\.[\w/_-]+(\[(\d+|\*)\])*)*$' minLength: 1 maxLength: 256 KafkaBootstrapServers: type: array items: $ref: '#/components/schemas/EndpointString' minItems: 0 maxItems: 2 KafkaTopicName: type: string pattern: '^[^.]([a-zA-Z0-9\-_.]+)$' minLength: 1 maxLength: 249 format: password KinesisPartitionKey: type: string minLength: 0 maxLength: 256 format: password KinesisStreamStartPosition: type: string enum: - TRIM_HORIZON - LATEST - AT_TIMESTAMP LaunchType: type: string enum: - EC2 - FARGATE - EXTERNAL LimitMax10: type: integer minimum: 1 maximum: 10 LimitMax100: type: integer minimum: 1 maximum: 100 LimitMax10000: type: integer minimum: 1 maximum: 10000 LimitMin1: type: integer minimum: 1 NextToken: type: string minLength: 1 maxLength: 2048 format: password ResourceArn: type: string minLength: 1 maxLength: 1600 ListPipesRequest: type: object title: ListPipesRequest properties: {} PipeList: type: array items: $ref: '#/components/schemas/Pipe' ListTagsForResourceRequest: type: object title: ListTagsForResourceRequest properties: {} LogStreamName: type: string minLength: 1 maxLength: 256 SecretManagerArn: type: string pattern: '^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$' description: // Optional SecretManager ARN which stores the database credentials minLength: 1 maxLength: 1600 MQBrokerAccessCredentials: type: object properties: BasicAuth: allOf: - $ref: '#/components/schemas/SecretManagerArn' - description: The ARN of the Secrets Manager secret. description: The Secrets Manager secret that stores your broker credentials. MQBrokerQueueName: type: string pattern: '^[\s\S]*$' minLength: 1 maxLength: 1000 format: password MSKAccessCredentials: type: object properties: ClientCertificateTlsAuth: allOf: - $ref: '#/components/schemas/SecretManagerArn' - description: The ARN of the Secrets Manager secret. SaslScram512Auth: allOf: - $ref: '#/components/schemas/SecretManagerArn' - description: The ARN of the Secrets Manager secret. description: The Secrets Manager secret that stores your stream credentials. MSKStartPosition: type: string enum: - TRIM_HORIZON - LATEST MaximumBatchingWindowInSeconds: type: integer minimum: 0 maximum: 300 MaximumRecordAgeInSeconds: type: integer minimum: -1 maximum: 604800 MaximumRetryAttemptsESM: type: integer minimum: -1 maximum: 10000 MessageDeduplicationId: type: string minLength: 0 maxLength: 100 format: password MessageGroupId: type: string minLength: 0 maxLength: 100 format: password NetworkConfiguration: type: object properties: awsvpcConfiguration: allOf: - $ref: '#/components/schemas/AwsVpcConfiguration' - description: 'Use this structure to specify 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 ECS tasks that use the awsvpc network mode.' description: This structure specifies the network configuration for an Amazon ECS task. OnPartialBatchItemFailureStreams: type: string enum: - AUTOMATIC_BISECT PathParameter: type: string pattern: '^(?!\s*$).+|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$' format: password PathParameterList: type: array items: $ref: '#/components/schemas/PathParameter' minItems: 0 maxItems: 1 Pipe: 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. Enrichment: allOf: - $ref: '#/components/schemas/OptionalArn' - description: The ARN of the enrichment resource. LastModifiedTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).' Name: allOf: - $ref: '#/components/schemas/PipeName' - description: The name of the pipe. Source: allOf: - $ref: '#/components/schemas/ArnOrUrl' - description: The ARN of the source resource. StateReason: allOf: - $ref: '#/components/schemas/PipeStateReason' - description: The reason the pipe is in its current state. Target: allOf: - $ref: '#/components/schemas/Arn' - description: The ARN of the target resource. description: An object that represents a pipe. Amazon EventBridgePipes connect event sources to targets and reduces the need for specialized knowledge and integration code. QueryStringParametersMap: type: object additionalProperties: $ref: '#/components/schemas/QueryStringValue' URI: type: string pattern: '^[a-zA-Z0-9-\/*:_+=.@-]*$' minLength: 1 maxLength: 200 format: password SelfManagedKafkaAccessConfigurationCredentials: type: object properties: BasicAuth: allOf: - $ref: '#/components/schemas/SecretManagerArn' - description: The ARN of the Secrets Manager secret. ClientCertificateTlsAuth: allOf: - $ref: '#/components/schemas/SecretManagerArn' - description: The ARN of the Secrets Manager secret. SaslScram256Auth: allOf: - $ref: '#/components/schemas/SecretManagerArn' - description: The ARN of the Secrets Manager secret. SaslScram512Auth: allOf: - $ref: '#/components/schemas/SecretManagerArn' - description: The ARN of the Secrets Manager secret. description: The Secrets Manager secret that stores your stream credentials. SelfManagedKafkaStartPosition: type: string enum: - TRIM_HORIZON - LATEST SelfManagedKafkaAccessConfigurationVpc: type: object properties: SecurityGroup: allOf: - $ref: '#/components/schemas/SecurityGroupIds' - description: 'Specifies the security groups associated with the stream. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.' Subnets: allOf: - $ref: '#/components/schemas/SubnetIds' - description: Specifies the subnets associated with the stream. These subnets must all be in the same VPC. You can specify as many as 16 subnets. description: 'This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.' PlacementConstraints: type: array items: $ref: '#/components/schemas/PlacementConstraint' minItems: 0 maxItems: 10 PlacementStrategies: type: array items: $ref: '#/components/schemas/PlacementStrategy' minItems: 0 maxItems: 5 PropagateTags: type: string enum: - TASK_DEFINITION ReferenceId: type: string minLength: 0 maxLength: 1024 format: password TagList: type: array items: $ref: '#/components/schemas/Tag' PipeTargetInvocationType: type: string enum: - REQUEST_RESPONSE - FIRE_AND_FORGET SecretManagerArnOrJsonPath: type: string pattern: '^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$' description: '// For targets, can either specify an ARN or a jsonpath pointing to the ARN.' minLength: 1 maxLength: 1600 Sqls: type: array description: // A list of SQLs. items: $ref: '#/components/schemas/Sql' minItems: 1 StatementName: type: string description: // A name for Redshift DataAPI statement which can be used as filter of // ListStatement. minLength: 1 maxLength: 500 format: password SageMakerPipelineParameterList: type: array items: $ref: '#/components/schemas/SageMakerPipelineParameter' minItems: 0 maxItems: 200 PlacementConstraintExpression: type: string minLength: 0 maxLength: 2000 format: password PlacementConstraintType: type: string enum: - distinctInstance - memberOf PlacementConstraint: type: object properties: expression: allOf: - $ref: '#/components/schemas/PlacementConstraintExpression' - description: 'A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide. ' type: allOf: - $ref: '#/components/schemas/PlacementConstraintType' - description: 'The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates. ' description: 'An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.' PlacementStrategy: type: object properties: field: allOf: - $ref: '#/components/schemas/PlacementStrategyField' - description: 'The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used. ' type: allOf: - $ref: '#/components/schemas/PlacementStrategyType' - description: 'The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task). ' description: '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.' PlacementStrategyField: type: string minLength: 0 maxLength: 255 format: password PlacementStrategyType: type: string enum: - random - spread - binpack QueryStringKey: type: string pattern: '^[^\x00-\x1F\x7F]+|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$' minLength: 0 maxLength: 512 QueryStringValue: type: string pattern: '^[^\x00-\x09\x0B\x0C\x0E-\x1F\x7F]+|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$' minLength: 0 maxLength: 512 format: password SageMakerPipelineParameterName: type: string pattern: '^[a-zA-Z0-9](-*[a-zA-Z0-9])*|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$' minLength: 1 maxLength: 256 format: password SageMakerPipelineParameterValue: type: string minLength: 0 maxLength: 1024 format: password SageMakerPipelineParameter: type: object required: - Name - Value properties: Name: allOf: - $ref: '#/components/schemas/SageMakerPipelineParameterName' - description: Name of parameter to start execution of a SageMaker Model Building Pipeline. Value: allOf: - $ref: '#/components/schemas/SageMakerPipelineParameterValue' - description: Value of parameter to start execution of a SageMaker Model Building Pipeline. description: Name/Value pair of a parameter to start execution of a SageMaker Model Building Pipeline. SecurityGroup: type: string pattern: '^sg-[0-9a-zA-Z]*|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$' minLength: 1 maxLength: 1024 format: password SecurityGroupId: type: string pattern: '^sg-[0-9a-zA-Z]*$' minLength: 1 maxLength: 1024 format: password SecurityGroupIds: type: array description: List of SecurityGroupId. items: $ref: '#/components/schemas/SecurityGroupId' minItems: 0 maxItems: 5 SubnetIds: type: array description: List of SubnetId. items: $ref: '#/components/schemas/SubnetId' minItems: 0 maxItems: 16 Sql: type: string description: // A single Redshift SQL minLength: 1 maxLength: 100000 format: password StartPipeRequest: type: object title: StartPipeRequest properties: {} StopPipeRequest: type: object title: StopPipeRequest properties: {} Subnet: type: string pattern: '^subnet-[0-9a-z]*|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$' minLength: 1 maxLength: 1024 format: password SubnetId: type: string pattern: '^subnet-[0-9a-z]*$' minLength: 1 maxLength: 1024 format: password Tag: type: object required: - Key - Value properties: Key: allOf: - $ref: '#/components/schemas/TagKey' - description: A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources. Value: allOf: - $ref: '#/components/schemas/TagValue' - description: The value for the specified tag key. description: 'A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging.' TagKeyList: type: array items: $ref: '#/components/schemas/TagKey' minItems: 0 maxItems: 50 TagResourceRequest: type: object required: - tags title: TagResourceRequest properties: tags: allOf: - $ref: '#/components/schemas/TagMap' - description: The list of key-value pairs associated with the pipe. UntagResourceRequest: type: object title: UntagResourceRequest properties: {} UpdatePipeSourceParameters: 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 Events and Event Patterns in the Amazon EventBridge User Guide.' 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. description: The parameters required to set up a source for your pipe. UpdatePipeRequest: type: object required: - RoleArn title: UpdatePipeRequest properties: Description: allOf: - $ref: '#/components/schemas/PipeDescription' - description: A description of the pipe. DesiredState: allOf: - $ref: '#/components/schemas/RequestedPipeState' - description: The state the pipe should be in. Enrichment: allOf: - $ref: '#/components/schemas/OptionalArn' - description: The ARN of the enrichment resource. EnrichmentParameters: allOf: - $ref: '#/components/schemas/PipeEnrichmentParameters' - description: The parameters required to set up enrichment on your pipe. RoleArn: allOf: - $ref: '#/components/schemas/RoleArn' - description: The ARN of the role that allows the pipe to send data to the target. SourceParameters: allOf: - $ref: '#/components/schemas/UpdatePipeSourceParameters' - description: The parameters required to set up a source for your pipe. Target: allOf: - $ref: '#/components/schemas/Arn' - description: The ARN of the target resource. TargetParameters: allOf: - $ref: '#/components/schemas/PipeTargetParameters' - description: The parameters required to set up a target for your pipe. security: - hmac: []