Module Awso_pipes.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule EcsEnvironmentFileType : sig ... end
Sourcemodule String_ : sig ... end
Sourcemodule EcsEnvironmentFile : sig ... end

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: Linux platform version 1.4.0 or later. Windows platform version 1.0.0 or later.

Sourcemodule EcsEnvironmentVariable : sig ... end

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.

Sourcemodule EcsResourceRequirement : sig ... end

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

Sourcemodule MeasureValue : sig ... end
Sourcemodule MeasureValueType : sig ... end
Sourcemodule MultiMeasureAttributeName : sig ... end
Sourcemodule EcsEnvironmentFileList : sig ... end
Sourcemodule Integer : sig ... end
Sourcemodule StringList : sig ... end
Sourcemodule SecurityGroup : sig ... end
Sourcemodule Subnet : sig ... end

A mapping of a source event data field to a measure in a Timestream for LiveAnalytics record.

Sourcemodule BatchEnvironmentVariable : sig ... end

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.

Sourcemodule BatchResourceRequirement : sig ... end

The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

Sourcemodule BatchJobDependencyType : sig ... end
Sourcemodule CapacityProvider : sig ... end
Sourcemodule EcsContainerOverride : sig ... end

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.

Sourcemodule EphemeralStorageSize : sig ... end

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.

Sourcemodule AssignPublicIp : sig ... end
Sourcemodule SecurityGroups : sig ... end
Sourcemodule Subnets : sig ... end
Sourcemodule PlacementConstraintType : sig ... end
Sourcemodule PlacementStrategyField : sig ... end
Sourcemodule PlacementStrategyType : sig ... end
Sourcemodule TagKey : sig ... end
Sourcemodule TagValue : sig ... end
Sourcemodule DimensionName : sig ... end
Sourcemodule DimensionValue : sig ... end
Sourcemodule DimensionValueType : sig ... end
Sourcemodule MultiMeasureName : sig ... end
Sourcemodule MeasureName : sig ... end
Sourcemodule EventPattern : sig ... end
Sourcemodule SecurityGroupId : sig ... end
Sourcemodule SubnetId : sig ... end
Sourcemodule ErrorMessage : sig ... end
Sourcemodule HeaderKey : sig ... end
Sourcemodule HeaderValue : sig ... end
Sourcemodule PathParameter : sig ... end
Sourcemodule QueryStringKey : sig ... end
Sourcemodule QueryStringValue : sig ... end
Sourcemodule BatchArraySize : sig ... end
Sourcemodule BatchJobDependency : sig ... end

An object that represents an Batch job dependency.

Sourcemodule BatchRetryAttempts : sig ... end

The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem in the Amazon ECS API Reference.

Sourcemodule ArnOrJsonPath : sig ... end
Sourcemodule EcsContainerOverrideList : sig ... end
Sourcemodule EcsEphemeralStorage : sig ... end

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.

Sourcemodule AwsVpcConfiguration : sig ... end

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.

Sourcemodule PlacementConstraint : sig ... end

An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.

Sourcemodule PlacementStrategy : sig ... end

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.

Sourcemodule Tag : sig ... end

A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging.

Sourcemodule Sql : sig ... end

// A single Redshift SQL

Name/Value pair of a parameter to start execution of a SageMaker Model Building Pipeline.

Sourcemodule DimensionMapping : sig ... end

Maps source data to a dimension in the target Timestream for LiveAnalytics table. For more information, see Amazon Timestream for LiveAnalytics concepts

Sourcemodule MultiMeasureMapping : sig ... end

Maps multiple measures from the source event to the same Timestream for LiveAnalytics record. For more information, see Amazon Timestream for LiveAnalytics concepts

Sourcemodule SingleMeasureMapping : sig ... end

Maps a single source data field to a single record in the specified Timestream for LiveAnalytics table. For more information, see Amazon Timestream for LiveAnalytics concepts

Sourcemodule Filter : sig ... end

Filter events using an event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Sourcemodule SecretManagerArn : sig ... end

// Optional SecretManager ARN which stores the database credentials

Sourcemodule Arn : sig ... end
Sourcemodule SecurityGroupIds : sig ... end
Sourcemodule SubnetIds : sig ... end
Sourcemodule EndpointString : sig ... end
Sourcemodule ValidationExceptionField : sig ... end

Indicates that an error has occurred while performing a validate operation.

Sourcemodule HeaderParametersMap : sig ... end
Sourcemodule PathParameterList : sig ... end
Sourcemodule QueryStringParametersMap : sig ... end
Sourcemodule CloudwatchLogGroupArn : sig ... end
Sourcemodule FirehoseArn : sig ... end
Sourcemodule S3OutputFormat : sig ... end
Sourcemodule BatchArrayProperties : sig ... end

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.

Sourcemodule BatchContainerOverrides : sig ... end

The overrides that are sent to a container.

Sourcemodule BatchDependsOn : sig ... end
Sourcemodule BatchParametersMap : sig ... end
Sourcemodule BatchRetryStrategy : sig ... end

The retry strategy that's associated with a job. For more information, see Automated job retries in the Batch User Guide.

Sourcemodule JsonPath : sig ... end
Sourcemodule LogStreamName : sig ... end
Sourcemodule Boolean : sig ... end
Sourcemodule CapacityProviderStrategy : sig ... end
Sourcemodule EcsTaskOverride : sig ... end

The overrides that are associated with a task.

Sourcemodule LaunchType : sig ... end
Sourcemodule LimitMin1 : sig ... end
Sourcemodule NetworkConfiguration : sig ... end

This structure specifies the network configuration for an Amazon ECS task.

Sourcemodule PlacementConstraints : sig ... end
Sourcemodule PlacementStrategies : sig ... end
Sourcemodule PropagateTags : sig ... end
Sourcemodule ReferenceId : sig ... end
Sourcemodule TagList : sig ... end
Sourcemodule EventBridgeDetailType : sig ... end
Sourcemodule EventBridgeEndpointId : sig ... end
Sourcemodule EventBridgeEventSource : sig ... end
Sourcemodule KinesisPartitionKey : sig ... end
Sourcemodule PipeTargetInvocationType : sig ... end
Sourcemodule Database : sig ... end

// Redshift Database

Sourcemodule DbUser : sig ... end

// Database user name

// For targets, can either specify an ARN or a jsonpath pointing to the ARN.

Sourcemodule Sqls : sig ... end
Sourcemodule StatementName : sig ... end

// A name for Redshift DataAPI statement which can be used as filter of // ListStatement.

Sourcemodule MessageDeduplicationId : sig ... end
Sourcemodule MessageGroupId : sig ... end
Sourcemodule DimensionMappings : sig ... end
Sourcemodule EpochTimeUnit : sig ... end
Sourcemodule MultiMeasureMappings : sig ... end
Sourcemodule SingleMeasureMappings : sig ... end
Sourcemodule TimeFieldType : sig ... end
Sourcemodule TimeValue : sig ... end
Sourcemodule TimestampFormat : sig ... end
Sourcemodule VersionValue : sig ... end
Sourcemodule FilterList : sig ... end
Sourcemodule LimitMax10000 : sig ... end
Sourcemodule MQBrokerAccessCredentials : sig ... end

The Secrets Manager secret that stores your broker credentials.

Sourcemodule DeadLetterConfig : sig ... end

A DeadLetterConfig object that contains information about a dead-letter queue configuration.

Sourcemodule LimitMax10 : sig ... end
Sourcemodule MaximumRecordAgeInSeconds : sig ... end
Sourcemodule MaximumRetryAttemptsESM : sig ... end
Sourcemodule MSKAccessCredentials : sig ... end

The Secrets Manager secret that stores your stream credentials.

The Secrets Manager secret that stores your stream credentials.

This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.

Sourcemodule ArnOrUrl : sig ... end
Sourcemodule OptionalArn : sig ... end
Sourcemodule PipeArn : sig ... end
Sourcemodule PipeName : sig ... end
Sourcemodule PipeState : sig ... end
Sourcemodule PipeStateReason : sig ... end
Sourcemodule RequestedPipeState : sig ... end
Sourcemodule Timestamp : sig ... end
Sourcemodule MQBrokerQueueName : sig ... end
Sourcemodule KafkaTopicName : sig ... end
Sourcemodule MSKStartPosition : sig ... end
Sourcemodule URI : sig ... end
Sourcemodule KafkaBootstrapServers : sig ... end
Sourcemodule InputTemplate : sig ... end

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.

The Amazon CloudWatch Logs logging configuration settings for the pipe.

The Amazon Data Firehose logging configuration settings for the pipe.

Sourcemodule IncludeExecutionData : sig ... end
Sourcemodule LogLevel : sig ... end

The Amazon S3 logging configuration settings for the pipe.

The parameters for using an Batch job as a target.

The parameters for using an CloudWatch Logs log stream as a target.

The parameters for using an Amazon ECS task as a target.

The parameters for using an EventBridge event bus as a target.

Sourcemodule PipeTargetHttpParameters : sig ... end

These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.

The parameters for using a Kinesis stream as a target.

The parameters for using a Lambda function as a target.

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.

The parameters for using a SageMaker pipeline as a target.

The parameters for using a Amazon SQS stream as a target.

The parameters for using a Step Functions state machine as a target.

The parameters for using a Timestream for LiveAnalytics table as a target.

Sourcemodule FilterCriteria : sig ... end

The collection of event patterns used to filter events. To remove a filter, specify a FilterCriteria object with an empty array of Filter objects. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

The parameters for using an Active MQ broker as a source.

The parameters for using a DynamoDB stream as a source.

The parameters for using a Kinesis stream as a source.

The parameters for using an MSK stream as a source.

The parameters for using a Rabbit MQ broker as a source.

The parameters for using a self-managed Apache Kafka stream as a source. A self managed cluster refers to any Apache Kafka cluster not hosted by Amazon Web Services. This includes both clusters you manage yourself, as well as those hosted by a third-party provider, such as Confluent Cloud, CloudKarafka, or Redpanda. For more information, see Apache Kafka streams as a source in the Amazon EventBridge User Guide.

The parameters for using a Amazon SQS stream as a source.

Sourcemodule Pipe : sig ... end

An object that represents a pipe. Amazon EventBridgePipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

The Amazon CloudWatch Logs logging configuration settings for the pipe.

Sourcemodule FirehoseLogDestination : sig ... end

The Amazon Data Firehose logging configuration settings for the pipe.

Sourcemodule S3LogDestination : sig ... end

The Amazon S3 logging configuration settings for the pipe.

The parameters for using an Active MQ broker as a source.

The parameters for using a DynamoDB stream as a source.

The parameters for using a Kinesis stream as a source.

The parameters for using an MSK stream as a source.

The parameters for using a Rabbit MQ broker as a source.

The parameters for using a self-managed Apache Kafka stream as a source. A self managed cluster refers to any Apache Kafka cluster not hosted by Amazon Web Services. This includes both clusters you manage yourself, as well as those hosted by a third-party provider, such as Confluent Cloud, CloudKarafka, or Redpanda. For more information, see Apache Kafka streams as a source in the Amazon EventBridge User Guide.

The parameters for using a Amazon SQS stream as a source.

Sourcemodule ConflictException : sig ... end

An action you attempted resulted in an exception.

Sourcemodule InternalException : sig ... end

This exception occurs due to unexpected causes.

Sourcemodule NotFoundException : sig ... end

An entity that you specified does not exist.

Sourcemodule ThrottlingException : sig ... end

An action was throttled.

Sourcemodule ValidationException : sig ... end

Indicates that an error has occurred while performing a validate operation.

Sourcemodule KmsKeyIdentifier : sig ... end
Sourcemodule PipeDescription : sig ... end
Sourcemodule PipeEnrichmentParameters : sig ... end

The parameters required to set up enrichment on your pipe.

Specifies the logging configuration settings for the pipe. When you call UpdatePipe, EventBridge updates the fields in the PipeLogConfigurationParameters object atomically as one and overrides existing values. This is by design. If you don't specify an optional field in any of the Amazon Web Services service parameters objects (CloudwatchLogsLogDestinationParameters, FirehoseLogDestinationParameters, or S3LogDestinationParameters), EventBridge sets that field to its system-default value during the update. For example, suppose when you created the pipe you specified a Firehose stream log destination. You then update the pipe to add an Amazon S3 log destination. In addition to specifying the S3LogDestinationParameters for the new log destination, you must also specify the fields in the FirehoseLogDestinationParameters object in order to retain the Firehose stream log destination. For more information on generating pipe log records, see Log EventBridge Pipes in the Amazon EventBridge User Guide.

Sourcemodule PipeTargetParameters : sig ... end

The parameters required to set up a target for your pipe. For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.

Sourcemodule RoleArn : sig ... end

The parameters required to set up a source for your pipe.

Sourcemodule TagKeyList : sig ... end
Sourcemodule TagMap : sig ... end
Sourcemodule NextToken : sig ... end
Sourcemodule PipeList : sig ... end
Sourcemodule LimitMax100 : sig ... end
Sourcemodule ResourceArn : sig ... end
Sourcemodule PipeLogConfiguration : sig ... end

The logging configuration settings for the pipe.

Sourcemodule PipeSourceParameters : sig ... end

The parameters required to set up a source for your pipe.

A quota has been exceeded.

Sourcemodule UpdatePipeResponse : sig ... end

Update an existing pipe. When you call UpdatePipe, EventBridge only the updates fields you have specified in the request; the rest remain unchanged. The exception to this is if you modify any Amazon Web Services-service specific fields in the SourceParameters, EnrichmentParameters, or TargetParameters objects. For example, DynamoDBStreamParameters or EventBridgeEventBusParameters. EventBridge updates the fields in these objects atomically as one and overrides existing values. This is by design, and means that if you don't specify an optional field in one of these Parameters objects, EventBridge sets that field to its system-default value during the update. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

Sourcemodule UpdatePipeRequest : sig ... end

Update an existing pipe. When you call UpdatePipe, EventBridge only the updates fields you have specified in the request; the rest remain unchanged. The exception to this is if you modify any Amazon Web Services-service specific fields in the SourceParameters, EnrichmentParameters, or TargetParameters objects. For example, DynamoDBStreamParameters or EventBridgeEventBusParameters. EventBridge updates the fields in these objects atomically as one and overrides existing values. This is by design, and means that if you don't specify an optional field in one of these Parameters objects, EventBridge sets that field to its system-default value during the update. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

Sourcemodule UntagResourceResponse : sig ... end

Removes one or more tags from the specified pipes.

Sourcemodule UntagResourceRequest : sig ... end

Removes one or more tags from the specified pipes.

Sourcemodule TagResourceResponse : sig ... end

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.

Sourcemodule TagResourceRequest : sig ... end

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.

Sourcemodule StopPipeResponse : sig ... end

Stop an existing pipe.

Sourcemodule StopPipeRequest : sig ... end

Stop an existing pipe.

Sourcemodule StartPipeResponse : sig ... end

Start an existing pipe.

Sourcemodule StartPipeRequest : sig ... end

Start an existing pipe.

Displays the tags associated with a pipe.

Displays the tags associated with a pipe.

Sourcemodule ListPipesResponse : sig ... end

Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

Sourcemodule ListPipesRequest : sig ... end

Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

Sourcemodule DescribePipeResponse : sig ... end

Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

Sourcemodule DescribePipeRequest : sig ... end

Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

Sourcemodule DeletePipeResponse : sig ... end

Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

Sourcemodule DeletePipeRequest : sig ... end

Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

Sourcemodule CreatePipeResponse : sig ... end

Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

Sourcemodule CreatePipeRequest : sig ... end

Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.