Module Smaws_Client_EventBridge

EventBridge client library built on EIO.

Types

type dead_letter_config = {
  1. arn : string option;
    (*

    The ARN of the SQS queue specified as the target for the dead-letter queue.

    *)
}

Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).

For more information, see Event retry policy and using dead-letter queues in the EventBridge User Guide.

type update_event_bus_response = {
  1. dead_letter_config : dead_letter_config option;
  2. description : string option;
    (*

    The event bus description.

    *)
  3. kms_key_identifier : string option;
    (*

    The identifier of the KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.

    For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

    *)
  4. name : string option;
    (*

    The event bus name.

    *)
  5. arn : string option;
    (*

    The event bus Amazon Resource Name (ARN).

    *)
}
type update_event_bus_request = {
  1. dead_letter_config : dead_letter_config option;
  2. description : string option;
    (*

    The event bus description.

    *)
  3. kms_key_identifier : string option;
    (*

    The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

    If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt events on the event bus.

    For more information, see Managing keys in the Key Management Service Developer Guide.

    Archives and schema discovery are not supported for event buses encrypted using a customer managed key. EventBridge returns an error if:

    • You call

      {{:https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateArchive.html}CreateArchive}

      on an event bus set to use a customer managed key for encryption.

    • You call

      {{:https://docs.aws.amazon.com/eventbridge/latest/schema-reference/v1-discoverers.html#CreateDiscoverer}CreateDiscoverer}

      on an event bus set to use a customer managed key for encryption.

    • You call

      {{:https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UpdatedEventBus.html}UpdatedEventBus}

      to set a customer managed key on an event bus with an archives or schema discovery enabled.

    To enable archives or schema discovery on an event bus, choose to use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

    *)
  4. name : string option;
    (*

    The name of the event bus.

    *)
}
type resource_not_found_exception = {
  1. message : string option;
}

An entity that you specified does not exist.

type operation_disabled_exception = {
  1. message : string option;
}

The operation you are attempting is not available in this region.

type internal_exception = {
  1. message : string option;
}

This exception occurs due to unexpected causes.

type concurrent_modification_exception = {
  1. message : string option;
}

There is concurrent modification on a rule, target, archive, or replay.

type primary = {
  1. health_check : string;
    (*

    The ARN of the health check used by the endpoint to determine whether failover is triggered.

    *)
}

The primary Region of the endpoint.

type secondary = {
  1. route : string;
    (*

    Defines the secondary Region.

    *)
}

The secondary Region that processes events when failover is triggered or replication is enabled.

type failover_config = {
  1. secondary : secondary;
    (*

    The Region that events are routed to when failover is triggered or event replication is enabled.

    *)
  2. primary : primary;
    (*

    The main Region of the endpoint.

    *)
}

The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.

type routing_config = {
  1. failover_config : failover_config;
    (*

    The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.

    *)
}

The routing configuration of the endpoint.

type replication_state =
  1. | DISABLED
  2. | ENABLED
type replication_config = {
  1. state : replication_state option;
    (*

    The state of event replication.

    *)
}

Endpoints can replicate all events to the secondary Region.

type endpoint_event_bus = {
  1. event_bus_arn : string;
    (*

    The ARN of the event bus the endpoint is associated with.

    *)
}

The event buses the endpoint is associated with.

type endpoint_state =
  1. | DELETE_FAILED
  2. | UPDATE_FAILED
  3. | CREATE_FAILED
  4. | DELETING
  5. | UPDATING
  6. | CREATING
  7. | ACTIVE
type update_endpoint_response = {
  1. state : endpoint_state option;
    (*

    The state of the endpoint you updated in this request.

    *)
  2. endpoint_url : string option;
    (*

    The URL of the endpoint you updated in this request.

    *)
  3. endpoint_id : string option;
    (*

    The ID of the endpoint you updated in this request.

    *)
  4. role_arn : string option;
    (*

    The ARN of the role used by event replication for the endpoint you updated in this request.

    *)
  5. event_buses : endpoint_event_bus list option;
    (*

    The event buses used for replication for the endpoint you updated in this request.

    *)
  6. replication_config : replication_config option;
    (*

    Whether event replication was enabled or disabled for the endpoint you updated in this request.

    *)
  7. routing_config : routing_config option;
    (*

    The routing configuration you updated in this request.

    *)
  8. arn : string option;
    (*

    The ARN of the endpoint you updated in this request.

    *)
  9. name : string option;
    (*

    The name of the endpoint you updated in this request.

    *)
}
type update_endpoint_request = {
  1. role_arn : string option;
    (*

    The ARN of the role used by event replication for this request.

    *)
  2. event_buses : endpoint_event_bus list option;
    (*

    Define event buses used for replication.

    *)
  3. replication_config : replication_config option;
    (*

    Whether event replication was enabled or disabled by this request.

    *)
  4. routing_config : routing_config option;
    (*

    Configure the routing policy, including the health check and secondary Region.

    *)
  5. description : string option;
    (*

    A description for the endpoint.

    *)
  6. name : string;
    (*

    The name of the endpoint you want to update.

    *)
}
type connection_state =
  1. | DEAUTHORIZING
  2. | AUTHORIZING
  3. | DEAUTHORIZED
  4. | AUTHORIZED
  5. | DELETING
  6. | UPDATING
  7. | CREATING
type update_connection_response = {
  1. last_authorized_time : float option;
    (*

    A time stamp for the time that the connection was last authorized.

    *)
  2. last_modified_time : float option;
    (*

    A time stamp for the time that the connection was last modified.

    *)
  3. creation_time : float option;
    (*

    A time stamp for the time that the connection was created.

    *)
  4. connection_state : connection_state option;
    (*

    The state of the connection that was updated.

    *)
  5. connection_arn : string option;
    (*

    The ARN of the connection that was updated.

    *)
}
type connection_authorization_type =
  1. | API_KEY
  2. | OAUTH_CLIENT_CREDENTIALS
  3. | BASIC
type update_connection_basic_auth_request_parameters = {
  1. password : string option;
    (*

    The password associated with the user name to use for Basic authorization.

    *)
  2. username : string option;
    (*

    The user name to use for Basic authorization.

    *)
}

Contains the Basic authorization parameters for the connection.

type update_connection_o_auth_client_request_parameters = {
  1. client_secret : string option;
    (*

    The client secret assciated with the client ID to use for OAuth authorization.

    *)
  2. client_i_d : string option;
    (*

    The client ID to use for OAuth authorization.

    *)
}

Contains the OAuth authorization parameters to use for the connection.

type connection_o_auth_http_method =
  1. | PUT
  2. | POST
  3. | GET
type connection_header_parameter = {
  1. is_value_secret : bool option;
    (*

    Specified whether the value is a secret.

    *)
  2. value : string option;
    (*

    The value associated with the key.

    *)
  3. key : string option;
    (*

    The key for the parameter.

    *)
}

Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB.

type connection_query_string_parameter = {
  1. is_value_secret : bool option;
    (*

    Specifies whether the value is secret.

    *)
  2. value : string option;
    (*

    The value associated with the key for the query string parameter.

    *)
  3. key : string option;
    (*

    The key for a query string parameter.

    *)
}

Additional query string parameter for the connection. You can include up to 100 additional query string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB.

type connection_body_parameter = {
  1. is_value_secret : bool option;
    (*

    Specified whether the value is secret.

    *)
  2. value : string option;
    (*

    The value associated with the key.

    *)
  3. key : string option;
    (*

    The key for the parameter.

    *)
}

Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB.

type connection_http_parameters = {
  1. body_parameters : connection_body_parameter list option;
    (*

    Contains additional body string parameters for the connection.

    *)
  2. query_string_parameters : connection_query_string_parameter list option;
    (*

    Contains additional query string parameters for the connection.

    *)
  3. header_parameters : connection_header_parameter list option;
    (*

    Contains additional header parameters for the connection.

    *)
}

Contains additional parameters for the connection.

type update_connection_o_auth_request_parameters = {
  1. o_auth_http_parameters : connection_http_parameters option;
    (*

    The additional HTTP parameters used for the OAuth authorization request.

    *)
  2. http_method : connection_o_auth_http_method option;
    (*

    The method used to connect to the HTTP endpoint.

    *)
  3. authorization_endpoint : string option;
    (*

    The URL to the authorization endpoint when OAuth is specified as the authorization type.

    *)
  4. client_parameters : update_connection_o_auth_client_request_parameters option;
    (*

    A UpdateConnectionOAuthClientRequestParameters object that contains the client parameters to use for the connection when OAuth is specified as the authorization type.

    *)
}

Contains the OAuth request parameters to use for the connection.

type update_connection_api_key_auth_request_parameters = {
  1. api_key_value : string option;
    (*

    The value associated with teh API key to use for authorization.

    *)
  2. api_key_name : string option;
    (*

    The name of the API key to use for authorization.

    *)
}

Contains the API key authorization parameters to use to update the connection.

type update_connection_auth_request_parameters = {
  1. invocation_http_parameters : connection_http_parameters option;
    (*

    A ConnectionHttpParameters object that contains the additional parameters to use for the connection.

    *)
  2. api_key_auth_parameters : update_connection_api_key_auth_request_parameters option;
    (*

    A UpdateConnectionApiKeyAuthRequestParameters object that contains the authorization parameters for API key authorization.

    *)
  3. o_auth_parameters : update_connection_o_auth_request_parameters option;
    (*

    A UpdateConnectionOAuthRequestParameters object that contains the authorization parameters for OAuth authorization.

    *)
  4. basic_auth_parameters : update_connection_basic_auth_request_parameters option;
    (*

    A UpdateConnectionBasicAuthRequestParameters object that contains the authorization parameters for Basic authorization.

    *)
}

Contains the additional parameters to use for the connection.

type update_connection_request = {
  1. auth_parameters : update_connection_auth_request_parameters option;
    (*

    The authorization parameters to use for the connection.

    *)
  2. authorization_type : connection_authorization_type option;
    (*

    The type of authorization to use for the connection.

    *)
  3. description : string option;
    (*

    A description for the connection.

    *)
  4. name : string;
    (*

    The name of the connection to update.

    *)
}
type limit_exceeded_exception = {
  1. message : string option;
}

The request failed because it attempted to create resource beyond the allowed service quota.

type archive_state =
  1. | UPDATE_FAILED
  2. | CREATE_FAILED
  3. | UPDATING
  4. | CREATING
  5. | DISABLED
  6. | ENABLED
type update_archive_response = {
  1. creation_time : float option;
    (*

    The time at which the archive was updated.

    *)
  2. state_reason : string option;
    (*

    The reason that the archive is in the current state.

    *)
  3. state : archive_state option;
    (*

    The state of the archive.

    *)
  4. archive_arn : string option;
    (*

    The ARN of the archive.

    *)
}
type update_archive_request = {
  1. retention_days : int option;
    (*

    The number of days to retain events in the archive.

    *)
  2. event_pattern : string option;
    (*

    The event pattern to use to filter events sent to the archive.

    *)
  3. description : string option;
    (*

    The description for the archive.

    *)
  4. archive_name : string;
    (*

    The name of the archive to update.

    *)
}
type invalid_event_pattern_exception = {
  1. message : string option;
}

The event pattern is not valid.

type api_destination_state =
  1. | INACTIVE
  2. | ACTIVE
type update_api_destination_response = {
  1. last_modified_time : float option;
    (*

    A time stamp for the time that the API destination was last modified.

    *)
  2. creation_time : float option;
    (*

    A time stamp for the time that the API destination was created.

    *)
  3. api_destination_state : api_destination_state option;
    (*

    The state of the API destination that was updated.

    *)
  4. api_destination_arn : string option;
    (*

    The ARN of the API destination that was updated.

    *)
}
type api_destination_http_method =
  1. | DELETE
  2. | PATCH
  3. | PUT
  4. | OPTIONS
  5. | HEAD
  6. | GET
  7. | POST
type update_api_destination_request = {
  1. invocation_rate_limit_per_second : int option;
    (*

    The maximum number of invocations per second to send to the API destination.

    *)
  2. http_method : api_destination_http_method option;
    (*

    The method to use for the API destination.

    *)
  3. invocation_endpoint : string option;
    (*

    The URL to the endpoint to use for the API destination.

    *)
  4. connection_arn : string option;
    (*

    The ARN of the connection to use for the API destination.

    *)
  5. description : string option;
    (*

    The name of the API destination to update.

    *)
  6. name : string;
    (*

    The name of the API destination to update.

    *)
}
type untag_resource_response = unit
type untag_resource_request = {
  1. tag_keys : string list;
    (*

    The list of tag keys to remove from the resource.

    *)
  2. resource_ar_n : string;
    (*

    The ARN of the EventBridge resource from which you are removing tags.

    *)
}
type managed_rule_exception = {
  1. message : string option;
}

This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that service. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, or UntagResource.

type test_event_pattern_response = {
  1. result : bool option;
    (*

    Indicates whether the event matches the event pattern.

    *)
}
type test_event_pattern_request = {
  1. event : string;
    (*

    The event, in JSON format, to test against the event pattern. The JSON must follow the format specified in Amazon Web Services Events, and the following fields are mandatory:

    • id
    • account
    • source
    • time
    • region
    • resources
    • detail-type
    *)
  2. event_pattern : string;
    (*

    The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

    *)
}
type input_transformer = {
  1. input_template : string;
    (*

    Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: <value>

    If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:

    • The placeholder cannot be used as an object key.

    The following example shows the syntax for using InputPathsMap and InputTemplate.

    "InputTransformer":

    {

    "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

    "InputTemplate": "is in state "

    }

    To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:

    "InputTransformer":

    {

    "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

    "InputTemplate": "is in state \"\""

    }

    The InputTemplate can also be valid JSON with varibles in quotes or out, as in the following example:

    "InputTransformer":

    {

    "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

    "InputTemplate": '\{"myInstance": ,"myStatus": "is in state \"\""\}'

    }

    *)
  2. input_paths_map : (string * string) list option;
    (*

    Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.

    InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 100 key-value pairs. You must use JSON dot notation, not bracket notation.

    The keys cannot start with "Amazon Web Services."

    *)
}

Contains the parameters needed for you to provide custom input to a target based on one or more pieces of data extracted from the event.

type kinesis_parameters = {
  1. partition_key_path : string;
    (*

    The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.

    *)
}

This object enables you to specify a JSON path to extract from the event and use as the partition key for the Amazon Kinesis data stream, so that you can control the shard to which the event goes. If you do not include this parameter, the default is to use the eventId as the partition key.

type run_command_target = {
  1. values : string list;
    (*

    If Key is tag: tag-key, Values is a list of tag values. If Key is InstanceIds, Values is a list of Amazon EC2 instance IDs.

    *)
  2. key : string;
    (*

    Can be either tag: tag-key or InstanceIds.

    *)
}

Information about the EC2 instances that are to be sent the command, specified as key-value pairs. Each RunCommandTarget block can include only one key, but this key may specify multiple values.

type run_command_parameters = {
  1. run_command_targets : run_command_target list;
    (*

    Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.

    *)
}

This parameter contains the criteria (either InstanceIds or a tag) used to specify which EC2 instances are to be sent the command.

type launch_type =
  1. | EXTERNAL
  2. | FARGATE
  3. | EC2
type assign_public_ip =
  1. | DISABLED
  2. | ENABLED
type aws_vpc_configuration = {
  1. assign_public_ip : assign_public_ip option;
    (*

    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.

    *)
  2. security_groups : string list option;
    (*

    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.

    *)
  3. subnets : string list;
    (*

    Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.

    *)
}

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.

type network_configuration = {
  1. awsvpc_configuration : aws_vpc_configuration option;
    (*

    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.

    *)
}

This structure specifies the network configuration for an ECS task.

type capacity_provider_strategy_item = {
  1. base : int option;
    (*

    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.

    *)
  2. weight : int option;
    (*

    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.

    *)
  3. capacity_provider : string;
    (*

    The short name of the capacity provider.

    *)
}

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

type placement_constraint_type =
  1. | MEMBER_OF
  2. | DISTINCT_INSTANCE
type placement_constraint = {
  1. expression : string option;
    (*

    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.

    *)
  2. type_ : placement_constraint_type option;
    (*

    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.

    *)
}

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

type placement_strategy_type =
  1. | BINPACK
  2. | SPREAD
  3. | RANDOM
type placement_strategy = {
  1. field : string option;
    (*

    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.

    *)
  2. type_ : placement_strategy_type option;
    (*

    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).

    *)
}

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.

type propagate_tags =
  1. | TASK_DEFINITION
type tag = {
  1. value : string;
    (*

    The value for the specified tag key.

    *)
  2. key : string;
    (*

    A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.

    *)
}

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

type ecs_parameters = {
  1. tags : tag list option;
    (*

    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.

    *)
  2. reference_id : string option;
    (*

    The reference ID to use for the task.

    *)
  3. propagate_tags : propagate_tags option;
    (*

    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.

    *)
  4. placement_strategy : placement_strategy list option;
    (*

    The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

    *)
  5. placement_constraints : placement_constraint list option;
    (*

    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).

    *)
  6. enable_execute_command : bool option;
    (*

    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.

    *)
  7. enable_ecs_managed_tags : bool option;
    (*

    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.

    *)
  8. capacity_provider_strategy : capacity_provider_strategy_item list option;
    (*

    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.

    *)
  9. group : string option;
    (*

    Specifies an ECS task group for the task. The maximum length is 255 characters.

    *)
  10. platform_version : string option;
    (*

    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.

    *)
  11. network_configuration : network_configuration option;
    (*

    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.

    *)
  12. launch_type : launch_type option;
    (*

    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.

    *)
  13. task_count : int option;
    (*

    The number of tasks to create based on TaskDefinition. The default is 1.

    *)
  14. task_definition_arn : string;
    (*

    The ARN of the task definition to use if the event target is an Amazon ECS task.

    *)
}

The custom parameters to be used when the target is an Amazon ECS task.

type batch_array_properties = {
  1. size : int option;
    (*

    The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.

    *)
}

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.

type batch_retry_strategy = {
  1. attempts : int option;
    (*

    The number of times to attempt to retry, if the job fails. Valid values are 1–10.

    *)
}

The retry strategy to use for failed jobs, if the target is an Batch job. If you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

type batch_parameters = {
  1. retry_strategy : batch_retry_strategy option;
    (*

    The retry strategy to use for failed jobs, if the target is an Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

    *)
  2. array_properties : batch_array_properties option;
    (*

    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.

    *)
  3. job_name : string;
    (*

    The name to use for this execution of the job, if the target is an Batch job.

    *)
  4. job_definition : string;
    (*

    The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.

    *)
}

The custom parameters to be used when the target is an Batch job.

type sqs_parameters = {
  1. message_group_id : string option;
    (*

    The FIFO message group ID to use as the target.

    *)
}

This structure includes the custom parameter to be used when the target is an SQS FIFO queue.

type http_parameters = {
  1. query_string_parameters : (string * string) list option;
    (*

    The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.

    *)
  2. header_parameters : (string * string) list option;
    (*

    The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.

    *)
  3. path_parameter_values : string list option;
    (*

    The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").

    *)
}

These are custom parameter to be used when the target is an API Gateway 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.

type redshift_data_parameters = {
  1. sqls : string list option;
    (*

    One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.

    *)
  2. with_event : bool option;
    (*

    Indicates whether to send an event back to EventBridge after the SQL statement runs.

    *)
  3. statement_name : string option;
    (*

    The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

    *)
  4. sql : string option;
    (*

    The SQL statement text to run.

    *)
  5. db_user : string option;
    (*

    The database user name. Required when authenticating using temporary credentials.

    *)
  6. database : string;
    (*

    The name of the database. Required when authenticating using temporary credentials.

    *)
  7. secret_manager_arn : string option;
    (*

    The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.

    *)
}

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.

type sage_maker_pipeline_parameter = {
  1. value : string;
    (*

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

    *)
  2. name : string;
    (*

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

    *)
}

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

type sage_maker_pipeline_parameters = {
  1. pipeline_parameter_list : sage_maker_pipeline_parameter list option;
    (*

    List of Parameter names and values for SageMaker Model Building Pipeline execution.

    *)
}

These are custom parameters to use when the target is a SageMaker Model Building Pipeline that starts based on EventBridge events.

type retry_policy = {
  1. maximum_event_age_in_seconds : int option;
    (*

    The maximum amount of time, in seconds, to continue to make retry attempts.

    *)
  2. maximum_retry_attempts : int option;
    (*

    The maximum number of retry attempts to make before the request fails. Retry attempts continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is met.

    *)
}

A RetryPolicy object that includes information about the retry policy settings.

type app_sync_parameters = {
  1. graph_ql_operation : string option;
    (*

    The GraphQL operation; that is, the query, mutation, or subscription to be parsed and executed by the GraphQL service.

    For more information, see Operations in the AppSync User Guide.

    *)
}

Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.

type target = {
  1. app_sync_parameters : app_sync_parameters option;
    (*

    Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.

    *)
  2. retry_policy : retry_policy option;
    (*

    The RetryPolicy object that contains the retry policy configuration to use for the dead-letter queue.

    *)
  3. dead_letter_config : dead_letter_config option;
    (*

    The DeadLetterConfig that defines the target queue to send dead-letter queue events to.

    *)
  4. sage_maker_pipeline_parameters : sage_maker_pipeline_parameters option;
    (*

    Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.

    If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.

    *)
  5. redshift_data_parameters : redshift_data_parameters option;
    (*

    Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.

    If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.

    *)
  6. http_parameters : http_parameters option;
    (*

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

    If you specify an API Gateway 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.

    *)
  7. sqs_parameters : sqs_parameters option;
    (*

    Contains the message group ID to use when the target is a FIFO queue.

    If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.

    *)
  8. batch_parameters : batch_parameters option;
    (*

    If the event target is an Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the Batch User Guide.

    *)
  9. ecs_parameters : ecs_parameters option;
    (*

    Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide.

    *)
  10. run_command_parameters : run_command_parameters option;
    (*

    Parameters used when you are using the rule to invoke Amazon EC2 Run Command.

    *)
  11. kinesis_parameters : kinesis_parameters option;
    (*

    The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream. If you do not include this parameter, the default is to use the eventId as the partition key.

    *)
  12. input_transformer : input_transformer option;
    (*

    Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.

    *)
  13. input_path : string option;
    (*

    The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You may use JSON dot notation or bracket notation. For more information about JSON paths, see JSONPath.

    *)
  14. input : string option;
    (*

    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.

    *)
  15. role_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target.

    *)
  16. arn : string;
    (*

    The Amazon Resource Name (ARN) of the target.

    *)
  17. id : string;
    (*

    The ID of the target within the specified rule. Use this ID to reference the target when updating the rule. We recommend using a memorable and unique string.

    *)
}

Targets are the resources to be invoked when a rule is triggered. For a complete list of services and resources that can be set as a target, see PutTargets.

If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide.

type tag_resource_response = unit
type tag_resource_request = {
  1. tags : tag list;
    (*

    The list of key-value pairs to associate with the resource.

    *)
  2. resource_ar_n : string;
    (*

    The ARN of the EventBridge resource that you're adding tags to.

    *)
}
type replay_state =
  1. | FAILED
  2. | CANCELLED
  3. | COMPLETED
  4. | CANCELLING
  5. | RUNNING
  6. | STARTING
type start_replay_response = {
  1. replay_start_time : float option;
    (*

    The time at which the replay started.

    *)
  2. state_reason : string option;
    (*

    The reason that the replay is in the state.

    *)
  3. state : replay_state option;
    (*

    The state of the replay.

    *)
  4. replay_arn : string option;
    (*

    The ARN of the replay.

    *)
}
type replay_destination = {
  1. filter_arns : string list option;
    (*

    A list of ARNs for rules to replay events to.

    *)
  2. arn : string;
    (*

    The ARN of the event bus to replay event to. You can replay events only to the event bus specified to create the archive.

    *)
}

A ReplayDestination object that contains details about a replay.

type start_replay_request = {
  1. destination : replay_destination;
    (*

    A ReplayDestination object that includes details about the destination for the replay.

    *)
  2. event_end_time : float;
    (*

    A time stamp for the time to stop replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.

    *)
  3. event_start_time : float;
    (*

    A time stamp for the time to start replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.

    *)
  4. event_source_arn : string;
    (*

    The ARN of the archive to replay events from.

    *)
  5. description : string option;
    (*

    A description for the replay to start.

    *)
  6. replay_name : string;
    (*

    The name of the replay to start.

    *)
}
type resource_already_exists_exception = {
  1. message : string option;
}

The resource you are trying to create already exists.

type rule_state =
  1. | ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS
  2. | DISABLED
  3. | ENABLED
type rule = {
  1. event_bus_name : string option;
    (*

    The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

    *)
  2. managed_by : string option;
    (*

    If the rule was created on behalf of your account by an Amazon Web Services service, this field displays the principal name of the service that created the rule.

    *)
  3. role_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the role that is used for target invocation.

    If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.

    *)
  4. schedule_expression : string option;
    (*

    The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.

    *)
  5. description : string option;
    (*

    The description of the rule.

    *)
  6. state : rule_state option;
    (*

    The state of the rule.

    Valid values include:

    • DISABLED: The rule is disabled. EventBridge does not match any events against the rule.
    • ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.

    • ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.

      Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide.

      This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.

    *)
  7. event_pattern : string option;
    (*

    The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

    *)
  8. arn : string option;
    (*

    The Amazon Resource Name (ARN) of the rule.

    *)
  9. name : string option;
    (*

    The name of the rule.

    *)
}

Contains information about a rule in Amazon EventBridge.

type replay = {
  1. replay_end_time : float option;
    (*

    A time stamp for the time that the replay completed.

    *)
  2. replay_start_time : float option;
    (*

    A time stamp for the time that the replay started.

    *)
  3. event_last_replayed_time : float option;
    (*

    A time stamp for the time that the last event was replayed.

    *)
  4. event_end_time : float option;
    (*

    A time stamp for the time to start replaying events. Any event with a creation time prior to the EventEndTime specified is replayed.

    *)
  5. event_start_time : float option;
    (*

    A time stamp for the time to start replaying events. This is determined by the time in the event as described in Time.

    *)
  6. state_reason : string option;
    (*

    A description of why the replay is in the current state.

    *)
  7. state : replay_state option;
    (*

    The current state of the replay.

    *)
  8. event_source_arn : string option;
    (*

    The ARN of the archive to replay event from.

    *)
  9. replay_name : string option;
    (*

    The name of the replay.

    *)
}

A Replay object that contains details about a replay.

type remove_targets_result_entry = {
  1. error_message : string option;
    (*

    The error message that explains why the target removal failed.

    *)
  2. error_code : string option;
    (*

    The error code that indicates why the target removal failed. If the value is ConcurrentModificationException, too many requests were made at the same time.

    *)
  3. target_id : string option;
    (*

    The ID of the target.

    *)
}

Represents a target that failed to be removed from a rule.

type remove_targets_response = {
  1. failed_entries : remove_targets_result_entry list option;
    (*

    The failed target entries.

    *)
  2. failed_entry_count : int option;
    (*

    The number of failed entries.

    *)
}
type remove_targets_request = {
  1. force : bool option;
    (*

    If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify Force as True to remove targets. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.

    *)
  2. ids : string list;
    (*

    The IDs of the targets to remove from the rule.

    *)
  3. event_bus_name : string option;
    (*

    The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

    *)
  4. rule : string;
    (*

    The name of the rule.

    *)
}
type remove_permission_request = {
  1. event_bus_name : string option;
    (*

    The name of the event bus to revoke permissions for. If you omit this, the default event bus is used.

    *)
  2. remove_all_permissions : bool option;
    (*

    Specifies whether to remove all permissions.

    *)
  3. statement_id : string option;
    (*

    The statement ID corresponding to the account that is no longer allowed to put events to the default event bus.

    *)
}
type put_targets_result_entry = {
  1. error_message : string option;
    (*

    The error message that explains why the target addition failed.

    *)
  2. error_code : string option;
    (*

    The error code that indicates why the target addition failed. If the value is ConcurrentModificationException, too many requests were made at the same time.

    *)
  3. target_id : string option;
    (*

    The ID of the target.

    *)
}

Represents a target that failed to be added to a rule.

type put_targets_response = {
  1. failed_entries : put_targets_result_entry list option;
    (*

    The failed target entries.

    *)
  2. failed_entry_count : int option;
    (*

    The number of failed entries.

    *)
}
type put_targets_request = {
  1. targets : target list;
    (*

    The targets to update or add to the rule.

    *)
  2. event_bus_name : string option;
    (*

    The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

    *)
  3. rule : string;
    (*

    The name of the rule.

    *)
}
type put_rule_response = {
  1. rule_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the rule.

    *)
}
type put_rule_request = {
  1. event_bus_name : string option;
    (*

    The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.

    *)
  2. tags : tag list option;
    (*

    The list of key-value pairs to associate with the rule.

    *)
  3. role_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the IAM role associated with the rule.

    If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.

    *)
  4. description : string option;
    (*

    A description of the rule.

    *)
  5. state : rule_state option;
    (*

    The state of the rule.

    Valid values include:

    • DISABLED: The rule is disabled. EventBridge does not match any events against the rule.
    • ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.

    • ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.

      Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide.

      This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.

    *)
  6. event_pattern : string option;
    (*

    The event pattern. For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

    *)
  7. schedule_expression : string option;
    (*

    The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".

    *)
  8. name : string;
    (*

    The name of the rule that you are creating or updating.

    *)
}

A JSON string which you can use to limit the event bus permissions you are granting to only accounts that fulfill the condition. Currently, the only supported condition is membership in a certain Amazon Web Services organization. The string must contain Type, Key, and Value fields. The Value field specifies the ID of the Amazon Web Services organization. Following is an example value for Condition:

'{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value": "o-1234567890"}'

type condition = {
  1. value : string;
    (*

    Specifies the value for the key. Currently, this must be the ID of the organization.

    *)
  2. key : string;
    (*

    Specifies the key for the condition. Currently the only supported key is aws:PrincipalOrgID.

    *)
  3. type_ : string;
    (*

    Specifies the type of condition. Currently the only supported value is StringEquals.

    *)
}
type put_permission_request = {
  1. policy : string option;
    (*

    A JSON string that describes the permission policy statement. You can include a Policy parameter in the request instead of using the StatementId, Action, Principal, or Condition parameters.

    *)
  2. condition : condition option;
    (*

    This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain Amazon Web Services organization. For more information about Amazon Web Services Organizations, see What Is Amazon Web Services Organizations in the Amazon Web Services Organizations User Guide.

    If you specify Condition with an Amazon Web Services organization ID, and specify "*" as the value for Principal, you grant permission to all the accounts in the named organization.

    The Condition is a JSON string which must contain Type, Key, and Value fields.

    *)
  3. statement_id : string option;
    (*

    An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission.

    Each StatementId must be unique.

    *)
  4. principal : string option;
    (*

    The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.

    If you specify "*" without specifying Condition, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.

    *)
  5. action : string option;
    (*

    The action that you are enabling the other account to perform.

    *)
  6. event_bus_name : string option;
    (*

    The name of the event bus associated with the rule. If you omit this, the default event bus is used.

    *)
}
type policy_length_exceeded_exception = {
  1. message : string option;
}

The event bus policy is too long. For more information, see the limits.

type put_partner_events_result_entry = {
  1. error_message : string option;
    (*

    The error message that explains why the event submission failed.

    *)
  2. error_code : string option;
    (*

    The error code that indicates why the event submission failed.

    *)
  3. event_id : string option;
    (*

    The ID of the event.

    *)
}

The result of an event entry the partner submitted in this request. If the event was successfully submitted, the entry has the event ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry.

type put_partner_events_response = {
  1. entries : put_partner_events_result_entry list option;
    (*

    The results for each event entry the partner submitted in this request. If the event was successfully submitted, the entry has the event ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry.

    For each record, the index of the response element is the same as the index in the request array.

    *)
  2. failed_entry_count : int option;
    (*

    The number of events from this operation that could not be written to the partner event bus.

    *)
}
type put_partner_events_request_entry = {
  1. detail : string option;
    (*

    A valid JSON string. There is no other schema imposed. The JSON string may contain fields and nested sub-objects.

    Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.

    *)
  2. detail_type : string option;
    (*

    A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.

    Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.

    *)
  3. resources : string list option;
    (*

    Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.

    *)
  4. source : string option;
    (*

    The event source that is generating the entry.

    Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.

    *)
  5. time : float option;
    (*

    The date and time of the event.

    *)
}

The details about an event generated by an SaaS partner.

type put_partner_events_request = {
  1. entries : put_partner_events_request_entry list;
    (*

    The list of events to write to the event bus.

    *)
}
type put_events_result_entry = {
  1. error_message : string option;
    (*

    The error message that explains why the event submission failed.

    *)
  2. error_code : string option;
    (*

    The error code that indicates why the event submission failed.

    Retryable errors include:

    • {{:https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html}InternalFailure}

      The request processing has failed because of an unknown error, exception or failure.

    • {{:https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html}ThrottlingException}

      The request was denied due to request throttling.

    Non-retryable errors include:

    • {{:https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html}AccessDeniedException}

      You do not have sufficient access to perform this action.

    • InvalidAccountIdException

      The account ID provided is not valid.

    • InvalidArgument

      A specified parameter is not valid.

    • MalformedDetail

      The JSON provided is not valid.

    • RedactionFailure

      Redacting the CloudTrail event failed.

    • NotAuthorizedForSourceException

      You do not have permissions to publish events with this source onto this event bus.

    • NotAuthorizedForDetailTypeException

      You do not have permissions to publish events with this detail type onto this event bus.

    *)
  3. event_id : string option;
    (*

    The ID of the event.

    *)
}

Represents the results of an event submitted to an event bus.

If the submission was successful, the entry has the event ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry.

For information about the errors that are common to all actions, see Common Errors.

type put_events_response = {
  1. entries : put_events_result_entry list option;
    (*

    The successfully and unsuccessfully ingested events results. If the ingestion was successful, the entry has the event ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry.

    For each record, the index of the response element is the same as the index in the request array.

    *)
  2. failed_entry_count : int option;
    (*

    The number of failed entries.

    *)
}
type put_events_request_entry = {
  1. trace_header : string option;
    (*

    An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the event.

    To learn more about X-Ray trace headers, see Tracing header in the X-Ray Developer Guide.

    *)
  2. event_bus_name : string option;
    (*

    The name or ARN of the event bus to receive the event. Only the rules that are associated with this event bus are used to match the event. If you omit this, the default event bus is used.

    If you're using a global endpoint with a custom bus, you can enter either the name or Amazon Resource Name (ARN) of the event bus in either the primary or secondary Region here. EventBridge then determines the corresponding event bus in the other Region based on the endpoint referenced by the EndpointId. Specifying the event bus ARN is preferred.

    *)
  3. detail : string option;
    (*

    A valid JSON object. There is no other schema imposed. The JSON object may contain fields and nested sub-objects.

    Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.

    *)
  4. detail_type : string option;
    (*

    Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.

    Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.

    *)
  5. resources : string list option;
    (*

    Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.

    *)
  6. source : string option;
    (*

    The source of the event.

    Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.

    *)
  7. time : float option;
    (*

    The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.

    *)
}

Represents an event to be submitted.

type put_events_request = {
  1. endpoint_id : string option;
    (*

    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.

    *)
  2. entries : put_events_request_entry list;
    (*

    The entry that defines an event in your system. You can specify several parameters for the entry such as the source and type of the event, resources associated with the event, and so on.

    *)
}
type partner_event_source = {
  1. name : string option;
    (*

    The name of the partner event source.

    *)
  2. arn : string option;
    (*

    The ARN of the partner event source.

    *)
}

A partner event source is created by an SaaS partner. If a customer creates a partner event bus that matches this event source, that Amazon Web Services account can receive events from the partner's applications or services.

type event_source_state =
  1. | DELETED
  2. | ACTIVE
  3. | PENDING
type partner_event_source_account = {
  1. state : event_source_state option;
    (*

    The state of the event source. If it is ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it is PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus, but the event source has since been deleted.

    *)
  2. expiration_time : float option;
    (*

    The date and time that the event source will expire, if the Amazon Web Services account doesn't create a matching event bus for it.

    *)
  3. creation_time : float option;
    (*

    The date and time the event source was created.

    *)
  4. account : string option;
    (*

    The Amazon Web Services account ID that the partner event source was offered to.

    *)
}

The Amazon Web Services account that a partner event source has been offered to.

type list_targets_by_rule_response = {
  1. next_token : string option;
    (*

    Indicates whether there are additional results to retrieve. If there are no more results, the value is null.

    *)
  2. targets : target list option;
    (*

    The targets assigned to the rule.

    *)
}
type list_targets_by_rule_request = {
  1. limit : int option;
    (*

    The maximum number of results to return.

    *)
  2. next_token : string option;
    (*

    The token returned by a previous call to retrieve the next set of results.

    *)
  3. event_bus_name : string option;
    (*

    The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

    *)
  4. rule : string;
    (*

    The name of the rule.

    *)
}
type list_tags_for_resource_response = {
  1. tags : tag list option;
    (*

    The list of tag keys and values associated with the resource you specified

    *)
}
type list_tags_for_resource_request = {
  1. resource_ar_n : string;
    (*

    The ARN of the EventBridge resource for which you want to view tags.

    *)
}
type list_rules_response = {
  1. next_token : string option;
    (*

    Indicates whether there are additional results to retrieve. If there are no more results, the value is null.

    *)
  2. rules : rule list option;
    (*

    The rules that match the specified criteria.

    *)
}
type list_rules_request = {
  1. limit : int option;
    (*

    The maximum number of results to return.

    *)
  2. next_token : string option;
    (*

    The token returned by a previous call to retrieve the next set of results.

    *)
  3. event_bus_name : string option;
    (*

    The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is used.

    *)
  4. name_prefix : string option;
    (*

    The prefix matching the rule name.

    *)
}
type list_rule_names_by_target_response = {
  1. next_token : string option;
    (*

    Indicates whether there are additional results to retrieve. If there are no more results, the value is null.

    *)
  2. rule_names : string list option;
    (*

    The names of the rules that can invoke the given target.

    *)
}
type list_rule_names_by_target_request = {
  1. limit : int option;
    (*

    The maximum number of results to return.

    *)
  2. next_token : string option;
    (*

    The token returned by a previous call to retrieve the next set of results.

    *)
  3. event_bus_name : string option;
    (*

    The name or ARN of the event bus to list rules for. If you omit this, the default event bus is used.

    *)
  4. target_arn : string;
    (*

    The Amazon Resource Name (ARN) of the target resource.

    *)
}
type list_replays_response = {
  1. next_token : string option;
    (*

    The token returned by a previous call to retrieve the next set of results.

    *)
  2. replays : replay list option;
    (*

    An array of Replay objects that contain information about the replay.

    *)
}
type list_replays_request = {
  1. limit : int option;
    (*

    The maximum number of replays to retrieve.

    *)
  2. next_token : string option;
    (*

    The token returned by a previous call to retrieve the next set of results.

    *)
  3. event_source_arn : string option;
    (*

    The ARN of the archive from which the events are replayed.

    *)
  4. state : replay_state option;
    (*

    The state of the replay.

    *)
  5. name_prefix : string option;
    (*

    A name prefix to filter the replays returned. Only replays with name that match the prefix are returned.

    *)
}
type list_partner_event_sources_response = {
  1. next_token : string option;
    (*

    A token you can use in a subsequent operation to retrieve the next set of results.

    *)
  2. partner_event_sources : partner_event_source list option;
    (*

    The list of partner event sources returned by the operation.

    *)
}
type list_partner_event_sources_request = {
  1. limit : int option;
    (*

    pecifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

    *)
  2. next_token : string option;
    (*

    The token returned by a previous call to this operation. Specifying this retrieves the next set of results.

    *)
  3. name_prefix : string;
    (*

    If you specify this, the results are limited to only those partner event sources that start with the string you specify.

    *)
}
type list_partner_event_source_accounts_response = {
  1. next_token : string option;
    (*

    A token you can use in a subsequent operation to retrieve the next set of results.

    *)
  2. partner_event_source_accounts : partner_event_source_account list option;
    (*

    The list of partner event sources returned by the operation.

    *)
}
type list_partner_event_source_accounts_request = {
  1. limit : int option;
    (*

    Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

    *)
  2. next_token : string option;
    (*

    The token returned by a previous call to this operation. Specifying this retrieves the next set of results.

    *)
  3. event_source_name : string;
    (*

    The name of the partner event source to display account information about.

    *)
}
type event_source = {
  1. state : event_source_state option;
    (*

    The state of the event source. If it is ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it is PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus, but the event source has since been deleted.

    *)
  2. name : string option;
    (*

    The name of the event source.

    *)
  3. expiration_time : float option;
    (*

    The date and time that the event source will expire, if the Amazon Web Services account doesn't create a matching event bus for it.

    *)
  4. creation_time : float option;
    (*

    The date and time the event source was created.

    *)
  5. created_by : string option;
    (*

    The name of the partner that created the event source.

    *)
  6. arn : string option;
    (*

    The ARN of the event source.

    *)
}

A partner event source is created by an SaaS partner. If a customer creates a partner event bus that matches this event source, that Amazon Web Services account can receive events from the partner's applications or services.

type list_event_sources_response = {
  1. next_token : string option;
    (*

    A token you can use in a subsequent operation to retrieve the next set of results.

    *)
  2. event_sources : event_source list option;
    (*

    The list of event sources.

    *)
}
type list_event_sources_request = {
  1. limit : int option;
    (*

    Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

    *)
  2. next_token : string option;
    (*

    The token returned by a previous call to retrieve the next set of results.

    *)
  3. name_prefix : string option;
    (*

    Specifying this limits the results to only those partner event sources with names that start with the specified prefix.

    *)
}
type event_bus = {
  1. last_modified_time : float option;
    (*

    The time the event bus was last modified.

    *)
  2. creation_time : float option;
    (*

    The time the event bus was created.

    *)
  3. policy : string option;
    (*

    The permissions policy of the event bus, describing which other Amazon Web Services accounts can write events to this event bus.

    *)
  4. description : string option;
    (*

    The event bus description.

    *)
  5. arn : string option;
    (*

    The ARN of the event bus.

    *)
  6. name : string option;
    (*

    The name of the event bus.

    *)
}

An event bus receives events from a source, uses rules to evaluate them, applies any configured input transformation, and routes them to the appropriate target(s). Your account's default event bus receives events from Amazon Web Services services. A custom event bus can receive events from your custom applications and services. A partner event bus receives events from an event source created by an SaaS partner. These events come from the partners services or applications.

type list_event_buses_response = {
  1. next_token : string option;
    (*

    A token you can use in a subsequent operation to retrieve the next set of results.

    *)
  2. event_buses : event_bus list option;
    (*

    This list of event buses.

    *)
}
type list_event_buses_request = {
  1. limit : int option;
    (*

    Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

    *)
  2. next_token : string option;
    (*

    The token returned by a previous call to retrieve the next set of results.

    *)
  3. name_prefix : string option;
    (*

    Specifying this limits the results to only those event buses with names that start with the specified prefix.

    *)
}
type endpoint = {
  1. last_modified_time : float option;
    (*

    The last time the endpoint was modified.

    *)
  2. creation_time : float option;
    (*

    The time the endpoint was created.

    *)
  3. state_reason : string option;
    (*

    The reason the endpoint is in its current state.

    *)
  4. state : endpoint_state option;
    (*

    The current state of the endpoint.

    *)
  5. endpoint_url : string option;
    (*

    The URL of the endpoint.

    *)
  6. endpoint_id : string option;
    (*

    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.

    *)
  7. role_arn : string option;
    (*

    The ARN of the role used by event replication for the endpoint.

    *)
  8. event_buses : endpoint_event_bus list option;
    (*

    The event buses being used by the endpoint.

    *)
  9. replication_config : replication_config option;
    (*

    Whether event replication was enabled or disabled for this endpoint. The default state is ENABLED which means you must supply a RoleArn. If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED.

    *)
  10. routing_config : routing_config option;
    (*

    The routing configuration of the endpoint.

    *)
  11. arn : string option;
    (*

    The ARN of the endpoint.

    *)
  12. description : string option;
    (*

    A description for the endpoint.

    *)
  13. name : string option;
    (*

    The name of the endpoint.

    *)
}

A global endpoint used to improve your application's availability by making it regional-fault tolerant. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.

type list_endpoints_response = {
  1. next_token : string option;
    (*

    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.

    *)
  2. endpoints : endpoint list option;
    (*

    The endpoints returned by the call.

    *)
}
type list_endpoints_request = {
  1. max_results : int option;
    (*

    The maximum number of results returned by the call.

    *)
  2. next_token : string option;
    (*

    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.

    *)
  3. home_region : string option;
    (*

    The primary Region of the endpoints associated with this account. For example "HomeRegion": "us-east-1".

    *)
  4. name_prefix : string option;
    (*

    A value that will return a subset of the endpoints associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

    *)
}
type connection = {
  1. last_authorized_time : float option;
    (*

    A time stamp for the time that the connection was last authorized.

    *)
  2. last_modified_time : float option;
    (*

    A time stamp for the time that the connection was last modified.

    *)
  3. creation_time : float option;
    (*

    A time stamp for the time that the connection was created.

    *)
  4. authorization_type : connection_authorization_type option;
    (*

    The authorization type specified for the connection.

    OAUTH tokens are refreshed when a 401 or 407 response is returned.

    *)
  5. state_reason : string option;
    (*

    The reason that the connection is in the connection state.

    *)
  6. connection_state : connection_state option;
    (*

    The state of the connection.

    *)
  7. name : string option;
    (*

    The name of the connection.

    *)
  8. connection_arn : string option;
    (*

    The ARN of the connection.

    *)
}

Contains information about a connection.

type list_connections_response = {
  1. next_token : string option;
    (*

    A token you can use in a subsequent request to retrieve the next set of results.

    *)
  2. connections : connection list option;
    (*

    An array of connections objects that include details about the connections.

    *)
}
type list_connections_request = {
  1. limit : int option;
    (*

    The maximum number of connections to return.

    *)
  2. next_token : string option;
    (*

    The token returned by a previous call to retrieve the next set of results.

    *)
  3. connection_state : connection_state option;
    (*

    The state of the connection.

    *)
  4. name_prefix : string option;
    (*

    A name prefix to filter results returned. Only connections with a name that starts with the prefix are returned.

    *)
}
type archive = {
  1. creation_time : float option;
    (*

    The time stamp for the time that the archive was created.

    *)
  2. event_count : int option;
    (*

    The number of events in the archive.

    *)
  3. size_bytes : int option;
    (*

    The size of the archive, in bytes.

    *)
  4. retention_days : int option;
    (*

    The number of days to retain events in the archive before they are deleted.

    *)
  5. state_reason : string option;
    (*

    A description for the reason that the archive is in the current state.

    *)
  6. state : archive_state option;
    (*

    The current state of the archive.

    *)
  7. event_source_arn : string option;
    (*

    The ARN of the event bus associated with the archive. Only events from this event bus are sent to the archive.

    *)
  8. archive_name : string option;
    (*

    The name of the archive.

    *)
}

An Archive object that contains details about an archive.

type list_archives_response = {
  1. next_token : string option;
    (*

    The token returned by a previous call to retrieve the next set of results.

    *)
  2. archives : archive list option;
    (*

    An array of Archive objects that include details about an archive.

    *)
}
type list_archives_request = {
  1. limit : int option;
    (*

    The maximum number of results to return.

    *)
  2. next_token : string option;
    (*

    The token returned by a previous call to retrieve the next set of results.

    *)
  3. state : archive_state option;
    (*

    The state of the archive.

    *)
  4. event_source_arn : string option;
    (*

    The ARN of the event source associated with the archive.

    *)
  5. name_prefix : string option;
    (*

    A name prefix to filter the archives returned. Only archives with name that match the prefix are returned.

    *)
}
type api_destination = {
  1. last_modified_time : float option;
    (*

    A time stamp for the time that the API destination was last modified.

    *)
  2. creation_time : float option;
    (*

    A time stamp for the time that the API destination was created.

    *)
  3. invocation_rate_limit_per_second : int option;
    (*

    The maximum number of invocations per second to send to the HTTP endpoint.

    *)
  4. http_method : api_destination_http_method option;
    (*

    The method to use to connect to the HTTP endpoint.

    *)
  5. invocation_endpoint : string option;
    (*

    The URL to the endpoint for the API destination.

    *)
  6. connection_arn : string option;
    (*

    The ARN of the connection specified for the API destination.

    *)
  7. api_destination_state : api_destination_state option;
    (*

    The state of the API destination.

    *)
  8. name : string option;
    (*

    The name of the API destination.

    *)
  9. api_destination_arn : string option;
    (*

    The ARN of the API destination.

    *)
}

Contains details about an API destination.

type list_api_destinations_response = {
  1. next_token : string option;
    (*

    A token you can use in a subsequent request to retrieve the next set of results.

    *)
  2. api_destinations : api_destination list option;
    (*

    An array of ApiDestination objects that include information about an API destination.

    *)
}
type list_api_destinations_request = {
  1. limit : int option;
    (*

    The maximum number of API destinations to include in the response.

    *)
  2. next_token : string option;
    (*

    The token returned by a previous call to retrieve the next set of results.

    *)
  3. connection_arn : string option;
    (*

    The ARN of the connection specified for the API destination.

    *)
  4. name_prefix : string option;
    (*

    A name prefix to filter results returned. Only API destinations with a name that starts with the prefix are returned.

    *)
}
type invalid_state_exception = {
  1. message : string option;
}

The specified state is not a valid state for an event source.

type illegal_status_exception = {
  1. message : string option;
}

An error occurred because a replay can be canceled only when the state is Running or Starting.

type enable_rule_request = {
  1. event_bus_name : string option;
    (*

    The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

    *)
  2. name : string;
    (*

    The name of the rule.

    *)
}
type disable_rule_request = {
  1. event_bus_name : string option;
    (*

    The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

    *)
  2. name : string;
    (*

    The name of the rule.

    *)
}
type describe_rule_response = {
  1. created_by : string option;
    (*

    The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.

    *)
  2. event_bus_name : string option;
    (*

    The name of the event bus associated with the rule.

    *)
  3. managed_by : string option;
    (*

    If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.

    *)
  4. role_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the IAM role associated with the rule.

    *)
  5. description : string option;
    (*

    The description of the rule.

    *)
  6. state : rule_state option;
    (*

    Specifies whether the rule is enabled or disabled.

    *)
  7. schedule_expression : string option;
    (*

    The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".

    *)
  8. event_pattern : string option;
    (*

    The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

    *)
  9. arn : string option;
    (*

    The Amazon Resource Name (ARN) of the rule.

    *)
  10. name : string option;
    (*

    The name of the rule.

    *)
}
type describe_rule_request = {
  1. event_bus_name : string option;
    (*

    The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

    *)
  2. name : string;
    (*

    The name of the rule.

    *)
}
type describe_replay_response = {
  1. replay_end_time : float option;
    (*

    A time stamp for the time that the replay stopped.

    *)
  2. replay_start_time : float option;
    (*

    A time stamp for the time that the replay started.

    *)
  3. event_last_replayed_time : float option;
    (*

    The time that the event was last replayed.

    *)
  4. event_end_time : float option;
    (*

    The time stamp for the last event that was replayed from the archive.

    *)
  5. event_start_time : float option;
    (*

    The time stamp of the first event that was last replayed from the archive.

    *)
  6. destination : replay_destination option;
    (*

    A ReplayDestination object that contains details about the replay.

    *)
  7. event_source_arn : string option;
    (*

    The ARN of the archive events were replayed from.

    *)
  8. state_reason : string option;
    (*

    The reason that the replay is in the current state.

    *)
  9. state : replay_state option;
    (*

    The current state of the replay.

    *)
  10. description : string option;
    (*

    The description of the replay.

    *)
  11. replay_arn : string option;
    (*

    The ARN of the replay.

    *)
  12. replay_name : string option;
    (*

    The name of the replay.

    *)
}
type describe_replay_request = {
  1. replay_name : string;
    (*

    The name of the replay to retrieve.

    *)
}
type describe_partner_event_source_response = {
  1. name : string option;
    (*

    The name of the event source.

    *)
  2. arn : string option;
    (*

    The ARN of the event source.

    *)
}
type describe_partner_event_source_request = {
  1. name : string;
    (*

    The name of the event source to display.

    *)
}
type describe_event_source_response = {
  1. state : event_source_state option;
    (*

    The state of the event source. If it is ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it is PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus, but the event source has since been deleted.

    *)
  2. name : string option;
    (*

    The name of the partner event source.

    *)
  3. expiration_time : float option;
    (*

    The date and time that the event source will expire if you do not create a matching event bus.

    *)
  4. creation_time : float option;
    (*

    The date and time that the event source was created.

    *)
  5. created_by : string option;
    (*

    The name of the SaaS partner that created the event source.

    *)
  6. arn : string option;
    (*

    The ARN of the partner event source.

    *)
}
type describe_event_source_request = {
  1. name : string;
    (*

    The name of the partner event source to display the details of.

    *)
}
type describe_event_bus_response = {
  1. last_modified_time : float option;
    (*

    The time the event bus was last modified.

    *)
  2. creation_time : float option;
    (*

    The time the event bus was created.

    *)
  3. policy : string option;
    (*

    The policy that enables the external account to send events to your account.

    *)
  4. dead_letter_config : dead_letter_config option;
  5. kms_key_identifier : string option;
    (*

    The identifier of the KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.

    For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

    *)
  6. description : string option;
    (*

    The event bus description.

    *)
  7. arn : string option;
    (*

    The Amazon Resource Name (ARN) of the account permitted to write events to the current account.

    *)
  8. name : string option;
    (*

    The name of the event bus. Currently, this is always default.

    *)
}
type describe_event_bus_request = {
  1. name : string option;
    (*

    The name or ARN of the event bus to show details for. If you omit this, the default event bus is displayed.

    *)
}
type describe_endpoint_response = {
  1. last_modified_time : float option;
    (*

    The last time the endpoint you asked for information about was modified.

    *)
  2. creation_time : float option;
    (*

    The time the endpoint you asked for information about was created.

    *)
  3. state_reason : string option;
    (*

    The reason the endpoint you asked for information about is in its current state.

    *)
  4. state : endpoint_state option;
    (*

    The current state of the endpoint you asked for information about.

    *)
  5. endpoint_url : string option;
    (*

    The URL of the endpoint you asked for information about.

    *)
  6. endpoint_id : string option;
    (*

    The ID of the endpoint you asked for information about.

    *)
  7. role_arn : string option;
    (*

    The ARN of the role used by the endpoint you asked for information about.

    *)
  8. event_buses : endpoint_event_bus list option;
    (*

    The event buses being used by the endpoint you asked for information about.

    *)
  9. replication_config : replication_config option;
    (*

    Whether replication is enabled or disabled for the endpoint you asked for information about.

    *)
  10. routing_config : routing_config option;
    (*

    The routing configuration of the endpoint you asked for information about.

    *)
  11. arn : string option;
    (*

    The ARN of the endpoint you asked for information about.

    *)
  12. description : string option;
    (*

    The description of the endpoint you asked for information about.

    *)
  13. name : string option;
    (*

    The name of the endpoint you asked for information about.

    *)
}
type describe_endpoint_request = {
  1. home_region : string option;
    (*

    The primary Region of the endpoint you want to get information about. For example "HomeRegion": "us-east-1".

    *)
  2. name : string;
    (*

    The name of the endpoint you want to get information about. For example, "Name":"us-east-2-custom_bus_A-endpoint".

    *)
}
type connection_basic_auth_response_parameters = {
  1. username : string option;
    (*

    The user name to use for Basic authorization.

    *)
}

Contains the authorization parameters for the connection if Basic is specified as the authorization type.

type connection_o_auth_client_response_parameters = {
  1. client_i_d : string option;
    (*

    The client ID associated with the response to the connection request.

    *)
}

Contains the client response parameters for the connection when OAuth is specified as the authorization type.

type connection_o_auth_response_parameters = {
  1. o_auth_http_parameters : connection_http_parameters option;
    (*

    The additional HTTP parameters used for the OAuth authorization request.

    *)
  2. http_method : connection_o_auth_http_method option;
    (*

    The method used to connect to the HTTP endpoint.

    *)
  3. authorization_endpoint : string option;
    (*

    The URL to the HTTP endpoint that authorized the request.

    *)
  4. client_parameters : connection_o_auth_client_response_parameters option;
    (*

    A ConnectionOAuthClientResponseParameters object that contains details about the client parameters returned when OAuth is specified as the authorization type.

    *)
}

Contains the response parameters when OAuth is specified as the authorization type.

type connection_api_key_auth_response_parameters = {
  1. api_key_name : string option;
    (*

    The name of the header to use for the APIKeyValue used for authorization.

    *)
}

Contains the authorization parameters for the connection if API Key is specified as the authorization type.

type connection_auth_response_parameters = {
  1. invocation_http_parameters : connection_http_parameters option;
    (*

    Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.

    *)
  2. api_key_auth_parameters : connection_api_key_auth_response_parameters option;
    (*

    The API Key parameters to use for authorization.

    *)
  3. o_auth_parameters : connection_o_auth_response_parameters option;
    (*

    The OAuth parameters to use for authorization.

    *)
  4. basic_auth_parameters : connection_basic_auth_response_parameters option;
    (*

    The authorization parameters for Basic authorization.

    *)
}

Contains the authorization parameters to use for the connection.

type describe_connection_response = {
  1. last_authorized_time : float option;
    (*

    A time stamp for the time that the connection was last authorized.

    *)
  2. last_modified_time : float option;
    (*

    A time stamp for the time that the connection was last modified.

    *)
  3. creation_time : float option;
    (*

    A time stamp for the time that the connection was created.

    *)
  4. auth_parameters : connection_auth_response_parameters option;
    (*

    The parameters to use for authorization for the connection.

    *)
  5. secret_arn : string option;
    (*

    The ARN of the secret created from the authorization parameters specified for the connection.

    *)
  6. authorization_type : connection_authorization_type option;
    (*

    The type of authorization specified for the connection.

    *)
  7. state_reason : string option;
    (*

    The reason that the connection is in the current connection state.

    *)
  8. connection_state : connection_state option;
    (*

    The state of the connection retrieved.

    *)
  9. description : string option;
    (*

    The description for the connection retrieved.

    *)
  10. name : string option;
    (*

    The name of the connection retrieved.

    *)
  11. connection_arn : string option;
    (*

    The ARN of the connection retrieved.

    *)
}
type describe_connection_request = {
  1. name : string;
    (*

    The name of the connection to retrieve.

    *)
}
type describe_archive_response = {
  1. creation_time : float option;
    (*

    The time at which the archive was created.

    *)
  2. event_count : int option;
    (*

    The number of events in the archive.

    *)
  3. size_bytes : int option;
    (*

    The size of the archive in bytes.

    *)
  4. retention_days : int option;
    (*

    The number of days to retain events for in the archive.

    *)
  5. state_reason : string option;
    (*

    The reason that the archive is in the state.

    *)
  6. state : archive_state option;
    (*

    The state of the archive.

    *)
  7. event_pattern : string option;
    (*

    The event pattern used to filter events sent to the archive.

    *)
  8. description : string option;
    (*

    The description of the archive.

    *)
  9. event_source_arn : string option;
    (*

    The ARN of the event source associated with the archive.

    *)
  10. archive_name : string option;
    (*

    The name of the archive.

    *)
  11. archive_arn : string option;
    (*

    The ARN of the archive.

    *)
}
type describe_archive_request = {
  1. archive_name : string;
    (*

    The name of the archive to retrieve.

    *)
}
type describe_api_destination_response = {
  1. last_modified_time : float option;
    (*

    A time stamp for the time that the API destination was last modified.

    *)
  2. creation_time : float option;
    (*

    A time stamp for the time that the API destination was created.

    *)
  3. invocation_rate_limit_per_second : int option;
    (*

    The maximum number of invocations per second to specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.

    *)
  4. http_method : api_destination_http_method option;
    (*

    The method to use to connect to the HTTP endpoint.

    *)
  5. invocation_endpoint : string option;
    (*

    The URL to use to connect to the HTTP endpoint.

    *)
  6. connection_arn : string option;
    (*

    The ARN of the connection specified for the API destination retrieved.

    *)
  7. api_destination_state : api_destination_state option;
    (*

    The state of the API destination retrieved.

    *)
  8. description : string option;
    (*

    The description for the API destination retrieved.

    *)
  9. name : string option;
    (*

    The name of the API destination retrieved.

    *)
  10. api_destination_arn : string option;
    (*

    The ARN of the API destination retrieved.

    *)
}
type describe_api_destination_request = {
  1. name : string;
    (*

    The name of the API destination to retrieve.

    *)
}
type delete_rule_request = {
  1. force : bool option;
    (*

    If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify Force as True to delete the rule. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.

    *)
  2. event_bus_name : string option;
    (*

    The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

    *)
  3. name : string;
    (*

    The name of the rule.

    *)
}
type delete_partner_event_source_request = {
  1. account : string;
    (*

    The Amazon Web Services account ID of the Amazon Web Services customer that the event source was created for.

    *)
  2. name : string;
    (*

    The name of the event source to delete.

    *)
}
type delete_event_bus_request = {
  1. name : string;
    (*

    The name of the event bus to delete.

    *)
}
type delete_endpoint_response = unit
type delete_endpoint_request = {
  1. name : string;
    (*

    The name of the endpoint you want to delete. For example, "Name":"us-east-2-custom_bus_A-endpoint"..

    *)
}
type delete_connection_response = {
  1. last_authorized_time : float option;
    (*

    A time stamp for the time that the connection was last authorized before it wa deleted.

    *)
  2. last_modified_time : float option;
    (*

    A time stamp for the time that the connection was last modified before it was deleted.

    *)
  3. creation_time : float option;
    (*

    A time stamp for the time that the connection was created.

    *)
  4. connection_state : connection_state option;
    (*

    The state of the connection before it was deleted.

    *)
  5. connection_arn : string option;
    (*

    The ARN of the connection that was deleted.

    *)
}
type delete_connection_request = {
  1. name : string;
    (*

    The name of the connection to delete.

    *)
}
type delete_archive_response = unit
type delete_archive_request = {
  1. archive_name : string;
    (*

    The name of the archive to delete.

    *)
}
type delete_api_destination_response = unit
type delete_api_destination_request = {
  1. name : string;
    (*

    The name of the destination to delete.

    *)
}
type deauthorize_connection_response = {
  1. last_authorized_time : float option;
    (*

    A time stamp for the time that the connection was last authorized.

    *)
  2. last_modified_time : float option;
    (*

    A time stamp for the time that the connection was last updated.

    *)
  3. creation_time : float option;
    (*

    A time stamp for the time that the connection was created.

    *)
  4. connection_state : connection_state option;
    (*

    The state of the connection.

    *)
  5. connection_arn : string option;
    (*

    The ARN of the connection that authorization was removed from.

    *)
}
type deauthorize_connection_request = {
  1. name : string;
    (*

    The name of the connection to remove authorization from.

    *)
}
type deactivate_event_source_request = {
  1. name : string;
    (*

    The name of the partner event source to deactivate.

    *)
}
type create_partner_event_source_response = {
  1. event_source_arn : string option;
    (*

    The ARN of the partner event source.

    *)
}
type create_partner_event_source_request = {
  1. account : string;
    (*

    The Amazon Web Services account ID that is permitted to create a matching partner event bus for this partner event source.

    *)
  2. name : string;
    (*

    The name of the partner event source. This name must be unique and must be in the format

    {i partner_name}/{i event_namespace}/{i event_name}

    . The Amazon Web Services account that wants to use this partner event source must create a partner event bus with a name that matches the name of the partner event source.

    *)
}
type create_event_bus_response = {
  1. dead_letter_config : dead_letter_config option;
  2. kms_key_identifier : string option;
    (*

    The identifier of the KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.

    For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

    *)
  3. description : string option;
    (*

    The event bus description.

    *)
  4. event_bus_arn : string option;
    (*

    The ARN of the new event bus.

    *)
}
type create_event_bus_request = {
  1. tags : tag list option;
    (*

    Tags to associate with the event bus.

    *)
  2. dead_letter_config : dead_letter_config option;
  3. kms_key_identifier : string option;
    (*

    The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

    If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt events on the event bus.

    For more information, see Managing keys in the Key Management Service Developer Guide.

    Archives and schema discovery are not supported for event buses encrypted using a customer managed key. EventBridge returns an error if:

    • You call

      {{:https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateArchive.html}CreateArchive}

      on an event bus set to use a customer managed key for encryption.

    • You call

      {{:https://docs.aws.amazon.com/eventbridge/latest/schema-reference/v1-discoverers.html#CreateDiscoverer}CreateDiscoverer}

      on an event bus set to use a customer managed key for encryption.

    • You call

      {{:https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UpdatedEventBus.html}UpdatedEventBus}

      to set a customer managed key on an event bus with an archives or schema discovery enabled.

    To enable archives or schema discovery on an event bus, choose to use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

    *)
  4. description : string option;
    (*

    The event bus description.

    *)
  5. event_source_name : string option;
    (*

    If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.

    *)
  6. name : string;
    (*

    The name of the new event bus.

    Custom event bus names can't contain the / character, but you can use the / character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to.

    You can't use the name default for a custom event bus, as this name is already used for your account's default event bus.

    *)
}
type create_endpoint_response = {
  1. state : endpoint_state option;
    (*

    The state of the endpoint that was created by this request.

    *)
  2. role_arn : string option;
    (*

    The ARN of the role used by event replication for this request.

    *)
  3. event_buses : endpoint_event_bus list option;
    (*

    The event buses used by this request.

    *)
  4. replication_config : replication_config option;
    (*

    Whether event replication was enabled or disabled by this request.

    *)
  5. routing_config : routing_config option;
    (*

    The routing configuration defined by this request.

    *)
  6. arn : string option;
    (*

    The ARN of the endpoint that was created by this request.

    *)
  7. name : string option;
    (*

    The name of the endpoint that was created by this request.

    *)
}
type create_endpoint_request = {
  1. role_arn : string option;
    (*

    The ARN of the role used for replication.

    *)
  2. event_buses : endpoint_event_bus list;
    (*

    Define the event buses used.

    The names of the event buses must be identical in each Region.

    *)
  3. replication_config : replication_config option;
    (*

    Enable or disable event replication. The default state is ENABLED which means you must supply a RoleArn. If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED.

    *)
  4. routing_config : routing_config;
    (*

    Configure the routing policy, including the health check and secondary Region..

    *)
  5. description : string option;
    (*

    A description of the global endpoint.

    *)
  6. name : string;
    (*

    The name of the global endpoint. For example, "Name":"us-east-2-custom_bus_A-endpoint".

    *)
}
type create_connection_response = {
  1. last_modified_time : float option;
    (*

    A time stamp for the time that the connection was last updated.

    *)
  2. creation_time : float option;
    (*

    A time stamp for the time that the connection was created.

    *)
  3. connection_state : connection_state option;
    (*

    The state of the connection that was created by the request.

    *)
  4. connection_arn : string option;
    (*

    The ARN of the connection that was created by the request.

    *)
}
type create_connection_basic_auth_request_parameters = {
  1. password : string;
    (*

    The password associated with the user name to use for Basic authorization.

    *)
  2. username : string;
    (*

    The user name to use for Basic authorization.

    *)
}

Contains the Basic authorization parameters to use for the connection.

type create_connection_o_auth_client_request_parameters = {
  1. client_secret : string;
    (*

    The client secret associated with the client ID to use for OAuth authorization for the connection.

    *)
  2. client_i_d : string;
    (*

    The client ID to use for OAuth authorization for the connection.

    *)
}

Contains the Basic authorization parameters to use for the connection.

type create_connection_o_auth_request_parameters = {
  1. o_auth_http_parameters : connection_http_parameters option;
    (*

    A ConnectionHttpParameters object that contains details about the additional parameters to use for the connection.

    *)
  2. http_method : connection_o_auth_http_method;
    (*

    The method to use for the authorization request.

    *)
  3. authorization_endpoint : string;
    (*

    The URL to the authorization endpoint when OAuth is specified as the authorization type.

    *)
  4. client_parameters : create_connection_o_auth_client_request_parameters;
    (*

    A CreateConnectionOAuthClientRequestParameters object that contains the client parameters for OAuth authorization.

    *)
}

Contains the OAuth authorization parameters to use for the connection.

type create_connection_api_key_auth_request_parameters = {
  1. api_key_value : string;
    (*

    The value for the API key to use for authorization.

    *)
  2. api_key_name : string;
    (*

    The name of the API key to use for authorization.

    *)
}

Contains the API key authorization parameters for the connection.

type create_connection_auth_request_parameters = {
  1. invocation_http_parameters : connection_http_parameters option;
    (*

    A ConnectionHttpParameters object that contains the API key authorization parameters to use for the connection. Note that if you include additional parameters for the target of a rule via HttpParameters, including query strings, the parameters added for the connection take precedence.

    *)
  2. api_key_auth_parameters : create_connection_api_key_auth_request_parameters option;
    (*

    A CreateConnectionApiKeyAuthRequestParameters object that contains the API key authorization parameters to use for the connection.

    *)
  3. o_auth_parameters : create_connection_o_auth_request_parameters option;
    (*

    A CreateConnectionOAuthRequestParameters object that contains the OAuth authorization parameters to use for the connection.

    *)
  4. basic_auth_parameters : create_connection_basic_auth_request_parameters option;
    (*

    A CreateConnectionBasicAuthRequestParameters object that contains the Basic authorization parameters to use for the connection.

    *)
}

Contains the authorization parameters for the connection.

type create_connection_request = {
  1. auth_parameters : create_connection_auth_request_parameters;
    (*

    A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.

    *)
  2. authorization_type : connection_authorization_type;
    (*

    The type of authorization to use for the connection.

    OAUTH tokens are refreshed when a 401 or 407 response is returned.

    *)
  3. description : string option;
    (*

    A description for the connection to create.

    *)
  4. name : string;
    (*

    The name for the connection to create.

    *)
}
type create_archive_response = {
  1. creation_time : float option;
    (*

    The time at which the archive was created.

    *)
  2. state_reason : string option;
    (*

    The reason that the archive is in the state.

    *)
  3. state : archive_state option;
    (*

    The state of the archive that was created.

    *)
  4. archive_arn : string option;
    (*

    The ARN of the archive that was created.

    *)
}
type create_archive_request = {
  1. retention_days : int option;
    (*

    The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely

    *)
  2. event_pattern : string option;
    (*

    An event pattern to use to filter events sent to the archive.

    *)
  3. description : string option;
    (*

    A description for the archive.

    *)
  4. event_source_arn : string;
    (*

    The ARN of the event bus that sends events to the archive.

    *)
  5. archive_name : string;
    (*

    The name for the archive to create.

    *)
}
type create_api_destination_response = {
  1. last_modified_time : float option;
    (*

    A time stamp indicating the time that the API destination was last modified.

    *)
  2. creation_time : float option;
    (*

    A time stamp indicating the time that the API destination was created.

    *)
  3. api_destination_state : api_destination_state option;
    (*

    The state of the API destination that was created by the request.

    *)
  4. api_destination_arn : string option;
    (*

    The ARN of the API destination that was created by the request.

    *)
}
type create_api_destination_request = {
  1. invocation_rate_limit_per_second : int option;
    (*

    The maximum number of requests per second to send to the HTTP invocation endpoint.

    *)
  2. http_method : api_destination_http_method;
    (*

    The method to use for the request to the HTTP invocation endpoint.

    *)
  3. invocation_endpoint : string;
    (*

    The URL to the HTTP invocation endpoint for the API destination.

    *)
  4. connection_arn : string;
    (*

    The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.

    *)
  5. description : string option;
    (*

    A description for the API destination to create.

    *)
  6. name : string;
    (*

    The name for the API destination to create.

    *)
}
type cancel_replay_response = {
  1. state_reason : string option;
    (*

    The reason that the replay is in the current state.

    *)
  2. state : replay_state option;
    (*

    The current state of the replay.

    *)
  3. replay_arn : string option;
    (*

    The ARN of the replay to cancel.

    *)
}
type cancel_replay_request = {
  1. replay_name : string;
    (*

    The name of the replay to cancel.

    *)
}
type activate_event_source_request = {
  1. name : string;
    (*

    The name of the partner event source to activate.

    *)
}

Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your resources change state, they automatically send events to an event stream. You can create rules that match selected events in the stream and route them to targets to take action. You can also use rules to take action on a predetermined schedule. For example, you can configure rules to:

For more information about the features of Amazon EventBridge, see the Amazon EventBridge User Guide.

type base_document = Smaws_Lib.Json.t

Builders

val make_dead_letter_config : ?arn:string -> unit -> dead_letter_config

Create a dead_letter_config type

val make_update_event_bus_response : ?dead_letter_config:dead_letter_config -> ?description:string -> ?kms_key_identifier:string -> ?name:string -> ?arn:string -> unit -> update_event_bus_response

Create a update_event_bus_response type

val make_update_event_bus_request : ?dead_letter_config:dead_letter_config -> ?description:string -> ?kms_key_identifier:string -> ?name:string -> unit -> update_event_bus_request

Create a update_event_bus_request type

val make_primary : health_check:string -> unit -> primary

Create a primary type

val make_secondary : route:string -> unit -> secondary

Create a secondary type

val make_failover_config : secondary:secondary -> primary:primary -> unit -> failover_config

Create a failover_config type

val make_routing_config : failover_config:failover_config -> unit -> routing_config

Create a routing_config type

val make_replication_config : ?state:replication_state -> unit -> replication_config

Create a replication_config type

val make_endpoint_event_bus : event_bus_arn:string -> unit -> endpoint_event_bus

Create a endpoint_event_bus type

val make_update_endpoint_response : ?state:endpoint_state -> ?endpoint_url:string -> ?endpoint_id:string -> ?role_arn:string -> ?event_buses:endpoint_event_bus list -> ?replication_config:replication_config -> ?routing_config:routing_config -> ?arn:string -> ?name:string -> unit -> update_endpoint_response

Create a update_endpoint_response type

val make_update_endpoint_request : ?role_arn:string -> ?event_buses:endpoint_event_bus list -> ?replication_config:replication_config -> ?routing_config:routing_config -> ?description:string -> name:string -> unit -> update_endpoint_request

Create a update_endpoint_request type

val make_update_connection_response : ?last_authorized_time:float -> ?last_modified_time:float -> ?creation_time:float -> ?connection_state:connection_state -> ?connection_arn:string -> unit -> update_connection_response

Create a update_connection_response type

val make_update_connection_basic_auth_request_parameters : ?password:string -> ?username:string -> unit -> update_connection_basic_auth_request_parameters

Create a update_connection_basic_auth_request_parameters type

val make_update_connection_o_auth_client_request_parameters : ?client_secret:string -> ?client_i_d:string -> unit -> update_connection_o_auth_client_request_parameters

Create a update_connection_o_auth_client_request_parameters type

val make_connection_header_parameter : ?is_value_secret:bool -> ?value:string -> ?key:string -> unit -> connection_header_parameter

Create a connection_header_parameter type

val make_connection_query_string_parameter : ?is_value_secret:bool -> ?value:string -> ?key:string -> unit -> connection_query_string_parameter

Create a connection_query_string_parameter type

val make_connection_body_parameter : ?is_value_secret:bool -> ?value:string -> ?key:string -> unit -> connection_body_parameter

Create a connection_body_parameter type

val make_connection_http_parameters : ?body_parameters:connection_body_parameter list -> ?query_string_parameters:connection_query_string_parameter list -> ?header_parameters:connection_header_parameter list -> unit -> connection_http_parameters

Create a connection_http_parameters type

val make_update_connection_o_auth_request_parameters : ?o_auth_http_parameters:connection_http_parameters -> ?http_method:connection_o_auth_http_method -> ?authorization_endpoint:string -> ?client_parameters:update_connection_o_auth_client_request_parameters -> unit -> update_connection_o_auth_request_parameters

Create a update_connection_o_auth_request_parameters type

val make_update_connection_api_key_auth_request_parameters : ?api_key_value:string -> ?api_key_name:string -> unit -> update_connection_api_key_auth_request_parameters

Create a update_connection_api_key_auth_request_parameters type

val make_update_connection_auth_request_parameters : ?invocation_http_parameters:connection_http_parameters -> ?api_key_auth_parameters:update_connection_api_key_auth_request_parameters -> ?o_auth_parameters:update_connection_o_auth_request_parameters -> ?basic_auth_parameters:update_connection_basic_auth_request_parameters -> unit -> update_connection_auth_request_parameters

Create a update_connection_auth_request_parameters type

val make_update_connection_request : ?auth_parameters:update_connection_auth_request_parameters -> ?authorization_type:connection_authorization_type -> ?description:string -> name:string -> unit -> update_connection_request

Create a update_connection_request type

val make_update_archive_response : ?creation_time:float -> ?state_reason:string -> ?state:archive_state -> ?archive_arn:string -> unit -> update_archive_response

Create a update_archive_response type

val make_update_archive_request : ?retention_days:int -> ?event_pattern:string -> ?description:string -> archive_name:string -> unit -> update_archive_request

Create a update_archive_request type

val make_update_api_destination_response : ?last_modified_time:float -> ?creation_time:float -> ?api_destination_state:api_destination_state -> ?api_destination_arn:string -> unit -> update_api_destination_response

Create a update_api_destination_response type

val make_update_api_destination_request : ?invocation_rate_limit_per_second:int -> ?http_method:api_destination_http_method -> ?invocation_endpoint:string -> ?connection_arn:string -> ?description:string -> name:string -> unit -> update_api_destination_request

Create a update_api_destination_request type

val make_untag_resource_response : unit -> untag_resource_response

Create a untag_resource_response type

val make_untag_resource_request : tag_keys:string list -> resource_ar_n:string -> unit -> untag_resource_request

Create a untag_resource_request type

val make_test_event_pattern_response : ?result:bool -> unit -> test_event_pattern_response

Create a test_event_pattern_response type

val make_test_event_pattern_request : event:string -> event_pattern:string -> unit -> test_event_pattern_request

Create a test_event_pattern_request type

val make_input_transformer : ?input_paths_map:(string * string) list -> input_template:string -> unit -> input_transformer

Create a input_transformer type

val make_kinesis_parameters : partition_key_path:string -> unit -> kinesis_parameters

Create a kinesis_parameters type

val make_run_command_target : values:string list -> key:string -> unit -> run_command_target

Create a run_command_target type

val make_run_command_parameters : run_command_targets:run_command_target list -> unit -> run_command_parameters

Create a run_command_parameters type

val make_aws_vpc_configuration : ?assign_public_ip:assign_public_ip -> ?security_groups:string list -> subnets:string list -> unit -> aws_vpc_configuration

Create a aws_vpc_configuration type

val make_network_configuration : ?awsvpc_configuration:aws_vpc_configuration -> unit -> network_configuration

Create a network_configuration type

val make_capacity_provider_strategy_item : ?base:int -> ?weight:int -> capacity_provider:string -> unit -> capacity_provider_strategy_item

Create a capacity_provider_strategy_item type

val make_placement_constraint : ?expression:string -> ?type_:placement_constraint_type -> unit -> placement_constraint

Create a placement_constraint type

val make_placement_strategy : ?field:string -> ?type_:placement_strategy_type -> unit -> placement_strategy

Create a placement_strategy type

val make_tag : value:string -> key:string -> unit -> tag

Create a tag type

val make_ecs_parameters : ?tags:tag list -> ?reference_id:string -> ?propagate_tags:propagate_tags -> ?placement_strategy:placement_strategy list -> ?placement_constraints:placement_constraint list -> ?enable_execute_command:bool -> ?enable_ecs_managed_tags:bool -> ?capacity_provider_strategy:capacity_provider_strategy_item list -> ?group:string -> ?platform_version:string -> ?network_configuration:network_configuration -> ?launch_type:launch_type -> ?task_count:int -> task_definition_arn:string -> unit -> ecs_parameters

Create a ecs_parameters type

val make_batch_array_properties : ?size:int -> unit -> batch_array_properties

Create a batch_array_properties type

val make_batch_retry_strategy : ?attempts:int -> unit -> batch_retry_strategy

Create a batch_retry_strategy type

val make_batch_parameters : ?retry_strategy:batch_retry_strategy -> ?array_properties:batch_array_properties -> job_name:string -> job_definition:string -> unit -> batch_parameters

Create a batch_parameters type

val make_sqs_parameters : ?message_group_id:string -> unit -> sqs_parameters

Create a sqs_parameters type

val make_http_parameters : ?query_string_parameters:(string * string) list -> ?header_parameters:(string * string) list -> ?path_parameter_values:string list -> unit -> http_parameters

Create a http_parameters type

val make_redshift_data_parameters : ?sqls:string list -> ?with_event:bool -> ?statement_name:string -> ?sql:string -> ?db_user:string -> ?secret_manager_arn:string -> database:string -> unit -> redshift_data_parameters

Create a redshift_data_parameters type

val make_sage_maker_pipeline_parameter : value:string -> name:string -> unit -> sage_maker_pipeline_parameter

Create a sage_maker_pipeline_parameter type

val make_sage_maker_pipeline_parameters : ?pipeline_parameter_list:sage_maker_pipeline_parameter list -> unit -> sage_maker_pipeline_parameters

Create a sage_maker_pipeline_parameters type

val make_retry_policy : ?maximum_event_age_in_seconds:int -> ?maximum_retry_attempts:int -> unit -> retry_policy

Create a retry_policy type

val make_app_sync_parameters : ?graph_ql_operation:string -> unit -> app_sync_parameters

Create a app_sync_parameters type

val make_target : ?app_sync_parameters:app_sync_parameters -> ?retry_policy:retry_policy -> ?dead_letter_config:dead_letter_config -> ?sage_maker_pipeline_parameters:sage_maker_pipeline_parameters -> ?redshift_data_parameters:redshift_data_parameters -> ?http_parameters:http_parameters -> ?sqs_parameters:sqs_parameters -> ?batch_parameters:batch_parameters -> ?ecs_parameters:ecs_parameters -> ?run_command_parameters:run_command_parameters -> ?kinesis_parameters:kinesis_parameters -> ?input_transformer:input_transformer -> ?input_path:string -> ?input:string -> ?role_arn:string -> arn:string -> id:string -> unit -> target

Create a target type

val make_tag_resource_response : unit -> tag_resource_response

Create a tag_resource_response type

val make_tag_resource_request : tags:tag list -> resource_ar_n:string -> unit -> tag_resource_request

Create a tag_resource_request type

val make_start_replay_response : ?replay_start_time:float -> ?state_reason:string -> ?state:replay_state -> ?replay_arn:string -> unit -> start_replay_response

Create a start_replay_response type

val make_replay_destination : ?filter_arns:string list -> arn:string -> unit -> replay_destination

Create a replay_destination type

val make_start_replay_request : ?description:string -> destination:replay_destination -> event_end_time:float -> event_start_time:float -> event_source_arn:string -> replay_name:string -> unit -> start_replay_request

Create a start_replay_request type

val make_rule : ?event_bus_name:string -> ?managed_by:string -> ?role_arn:string -> ?schedule_expression:string -> ?description:string -> ?state:rule_state -> ?event_pattern:string -> ?arn:string -> ?name:string -> unit -> rule

Create a rule type

val make_replay : ?replay_end_time:float -> ?replay_start_time:float -> ?event_last_replayed_time:float -> ?event_end_time:float -> ?event_start_time:float -> ?state_reason:string -> ?state:replay_state -> ?event_source_arn:string -> ?replay_name:string -> unit -> replay

Create a replay type

val make_remove_targets_result_entry : ?error_message:string -> ?error_code:string -> ?target_id:string -> unit -> remove_targets_result_entry

Create a remove_targets_result_entry type

val make_remove_targets_response : ?failed_entries:remove_targets_result_entry list -> ?failed_entry_count:int -> unit -> remove_targets_response

Create a remove_targets_response type

val make_remove_targets_request : ?force:bool -> ?event_bus_name:string -> ids:string list -> rule:string -> unit -> remove_targets_request

Create a remove_targets_request type

val make_remove_permission_request : ?event_bus_name:string -> ?remove_all_permissions:bool -> ?statement_id:string -> unit -> remove_permission_request

Create a remove_permission_request type

val make_put_targets_result_entry : ?error_message:string -> ?error_code:string -> ?target_id:string -> unit -> put_targets_result_entry

Create a put_targets_result_entry type

val make_put_targets_response : ?failed_entries:put_targets_result_entry list -> ?failed_entry_count:int -> unit -> put_targets_response

Create a put_targets_response type

val make_put_targets_request : ?event_bus_name:string -> targets:target list -> rule:string -> unit -> put_targets_request

Create a put_targets_request type

val make_put_rule_response : ?rule_arn:string -> unit -> put_rule_response

Create a put_rule_response type

val make_put_rule_request : ?event_bus_name:string -> ?tags:tag list -> ?role_arn:string -> ?description:string -> ?state:rule_state -> ?event_pattern:string -> ?schedule_expression:string -> name:string -> unit -> put_rule_request

Create a put_rule_request type

val make_condition : value:string -> key:string -> type_:string -> unit -> condition

Create a condition type

val make_put_permission_request : ?policy:string -> ?condition:condition -> ?statement_id:string -> ?principal:string -> ?action:string -> ?event_bus_name:string -> unit -> put_permission_request

Create a put_permission_request type

val make_put_partner_events_result_entry : ?error_message:string -> ?error_code:string -> ?event_id:string -> unit -> put_partner_events_result_entry

Create a put_partner_events_result_entry type

val make_put_partner_events_response : ?entries:put_partner_events_result_entry list -> ?failed_entry_count:int -> unit -> put_partner_events_response

Create a put_partner_events_response type

val make_put_partner_events_request_entry : ?detail:string -> ?detail_type:string -> ?resources:string list -> ?source:string -> ?time:float -> unit -> put_partner_events_request_entry

Create a put_partner_events_request_entry type

val make_put_partner_events_request : entries:put_partner_events_request_entry list -> unit -> put_partner_events_request

Create a put_partner_events_request type

val make_put_events_result_entry : ?error_message:string -> ?error_code:string -> ?event_id:string -> unit -> put_events_result_entry

Create a put_events_result_entry type

val make_put_events_response : ?entries:put_events_result_entry list -> ?failed_entry_count:int -> unit -> put_events_response

Create a put_events_response type

val make_put_events_request_entry : ?trace_header:string -> ?event_bus_name:string -> ?detail:string -> ?detail_type:string -> ?resources:string list -> ?source:string -> ?time:float -> unit -> put_events_request_entry

Create a put_events_request_entry type

val make_put_events_request : ?endpoint_id:string -> entries:put_events_request_entry list -> unit -> put_events_request

Create a put_events_request type

val make_partner_event_source : ?name:string -> ?arn:string -> unit -> partner_event_source

Create a partner_event_source type

val make_partner_event_source_account : ?state:event_source_state -> ?expiration_time:float -> ?creation_time:float -> ?account:string -> unit -> partner_event_source_account

Create a partner_event_source_account type

val make_list_targets_by_rule_response : ?next_token:string -> ?targets:target list -> unit -> list_targets_by_rule_response

Create a list_targets_by_rule_response type

val make_list_targets_by_rule_request : ?limit:int -> ?next_token:string -> ?event_bus_name:string -> rule:string -> unit -> list_targets_by_rule_request

Create a list_targets_by_rule_request type

val make_list_tags_for_resource_response : ?tags:tag list -> unit -> list_tags_for_resource_response

Create a list_tags_for_resource_response type

val make_list_tags_for_resource_request : resource_ar_n:string -> unit -> list_tags_for_resource_request

Create a list_tags_for_resource_request type

val make_list_rules_response : ?next_token:string -> ?rules:rule list -> unit -> list_rules_response

Create a list_rules_response type

val make_list_rules_request : ?limit:int -> ?next_token:string -> ?event_bus_name:string -> ?name_prefix:string -> unit -> list_rules_request

Create a list_rules_request type

val make_list_rule_names_by_target_response : ?next_token:string -> ?rule_names:string list -> unit -> list_rule_names_by_target_response

Create a list_rule_names_by_target_response type

val make_list_rule_names_by_target_request : ?limit:int -> ?next_token:string -> ?event_bus_name:string -> target_arn:string -> unit -> list_rule_names_by_target_request

Create a list_rule_names_by_target_request type

val make_list_replays_response : ?next_token:string -> ?replays:replay list -> unit -> list_replays_response

Create a list_replays_response type

val make_list_replays_request : ?limit:int -> ?next_token:string -> ?event_source_arn:string -> ?state:replay_state -> ?name_prefix:string -> unit -> list_replays_request

Create a list_replays_request type

val make_list_partner_event_sources_response : ?next_token:string -> ?partner_event_sources:partner_event_source list -> unit -> list_partner_event_sources_response

Create a list_partner_event_sources_response type

val make_list_partner_event_sources_request : ?limit:int -> ?next_token:string -> name_prefix:string -> unit -> list_partner_event_sources_request

Create a list_partner_event_sources_request type

val make_list_partner_event_source_accounts_response : ?next_token:string -> ?partner_event_source_accounts:partner_event_source_account list -> unit -> list_partner_event_source_accounts_response

Create a list_partner_event_source_accounts_response type

val make_list_partner_event_source_accounts_request : ?limit:int -> ?next_token:string -> event_source_name:string -> unit -> list_partner_event_source_accounts_request

Create a list_partner_event_source_accounts_request type

val make_event_source : ?state:event_source_state -> ?name:string -> ?expiration_time:float -> ?creation_time:float -> ?created_by:string -> ?arn:string -> unit -> event_source

Create a event_source type

val make_list_event_sources_response : ?next_token:string -> ?event_sources:event_source list -> unit -> list_event_sources_response

Create a list_event_sources_response type

val make_list_event_sources_request : ?limit:int -> ?next_token:string -> ?name_prefix:string -> unit -> list_event_sources_request

Create a list_event_sources_request type

val make_event_bus : ?last_modified_time:float -> ?creation_time:float -> ?policy:string -> ?description:string -> ?arn:string -> ?name:string -> unit -> event_bus

Create a event_bus type

val make_list_event_buses_response : ?next_token:string -> ?event_buses:event_bus list -> unit -> list_event_buses_response

Create a list_event_buses_response type

val make_list_event_buses_request : ?limit:int -> ?next_token:string -> ?name_prefix:string -> unit -> list_event_buses_request

Create a list_event_buses_request type

val make_endpoint : ?last_modified_time:float -> ?creation_time:float -> ?state_reason:string -> ?state:endpoint_state -> ?endpoint_url:string -> ?endpoint_id:string -> ?role_arn:string -> ?event_buses:endpoint_event_bus list -> ?replication_config:replication_config -> ?routing_config:routing_config -> ?arn:string -> ?description:string -> ?name:string -> unit -> endpoint

Create a endpoint type

val make_list_endpoints_response : ?next_token:string -> ?endpoints:endpoint list -> unit -> list_endpoints_response

Create a list_endpoints_response type

val make_list_endpoints_request : ?max_results:int -> ?next_token:string -> ?home_region:string -> ?name_prefix:string -> unit -> list_endpoints_request

Create a list_endpoints_request type

val make_connection : ?last_authorized_time:float -> ?last_modified_time:float -> ?creation_time:float -> ?authorization_type:connection_authorization_type -> ?state_reason:string -> ?connection_state:connection_state -> ?name:string -> ?connection_arn:string -> unit -> connection

Create a connection type

val make_list_connections_response : ?next_token:string -> ?connections:connection list -> unit -> list_connections_response

Create a list_connections_response type

val make_list_connections_request : ?limit:int -> ?next_token:string -> ?connection_state:connection_state -> ?name_prefix:string -> unit -> list_connections_request

Create a list_connections_request type

val make_archive : ?creation_time:float -> ?event_count:int -> ?size_bytes:int -> ?retention_days:int -> ?state_reason:string -> ?state:archive_state -> ?event_source_arn:string -> ?archive_name:string -> unit -> archive

Create a archive type

val make_list_archives_response : ?next_token:string -> ?archives:archive list -> unit -> list_archives_response

Create a list_archives_response type

val make_list_archives_request : ?limit:int -> ?next_token:string -> ?state:archive_state -> ?event_source_arn:string -> ?name_prefix:string -> unit -> list_archives_request

Create a list_archives_request type

val make_api_destination : ?last_modified_time:float -> ?creation_time:float -> ?invocation_rate_limit_per_second:int -> ?http_method:api_destination_http_method -> ?invocation_endpoint:string -> ?connection_arn:string -> ?api_destination_state:api_destination_state -> ?name:string -> ?api_destination_arn:string -> unit -> api_destination

Create a api_destination type

val make_list_api_destinations_response : ?next_token:string -> ?api_destinations:api_destination list -> unit -> list_api_destinations_response

Create a list_api_destinations_response type

val make_list_api_destinations_request : ?limit:int -> ?next_token:string -> ?connection_arn:string -> ?name_prefix:string -> unit -> list_api_destinations_request

Create a list_api_destinations_request type

val make_enable_rule_request : ?event_bus_name:string -> name:string -> unit -> enable_rule_request

Create a enable_rule_request type

val make_disable_rule_request : ?event_bus_name:string -> name:string -> unit -> disable_rule_request

Create a disable_rule_request type

val make_describe_rule_response : ?created_by:string -> ?event_bus_name:string -> ?managed_by:string -> ?role_arn:string -> ?description:string -> ?state:rule_state -> ?schedule_expression:string -> ?event_pattern:string -> ?arn:string -> ?name:string -> unit -> describe_rule_response

Create a describe_rule_response type

val make_describe_rule_request : ?event_bus_name:string -> name:string -> unit -> describe_rule_request

Create a describe_rule_request type

val make_describe_replay_response : ?replay_end_time:float -> ?replay_start_time:float -> ?event_last_replayed_time:float -> ?event_end_time:float -> ?event_start_time:float -> ?destination:replay_destination -> ?event_source_arn:string -> ?state_reason:string -> ?state:replay_state -> ?description:string -> ?replay_arn:string -> ?replay_name:string -> unit -> describe_replay_response

Create a describe_replay_response type

val make_describe_replay_request : replay_name:string -> unit -> describe_replay_request

Create a describe_replay_request type

val make_describe_partner_event_source_response : ?name:string -> ?arn:string -> unit -> describe_partner_event_source_response

Create a describe_partner_event_source_response type

val make_describe_partner_event_source_request : name:string -> unit -> describe_partner_event_source_request

Create a describe_partner_event_source_request type

val make_describe_event_source_response : ?state:event_source_state -> ?name:string -> ?expiration_time:float -> ?creation_time:float -> ?created_by:string -> ?arn:string -> unit -> describe_event_source_response

Create a describe_event_source_response type

val make_describe_event_source_request : name:string -> unit -> describe_event_source_request

Create a describe_event_source_request type

val make_describe_event_bus_response : ?last_modified_time:float -> ?creation_time:float -> ?policy:string -> ?dead_letter_config:dead_letter_config -> ?kms_key_identifier:string -> ?description:string -> ?arn:string -> ?name:string -> unit -> describe_event_bus_response

Create a describe_event_bus_response type

val make_describe_event_bus_request : ?name:string -> unit -> describe_event_bus_request

Create a describe_event_bus_request type

val make_describe_endpoint_response : ?last_modified_time:float -> ?creation_time:float -> ?state_reason:string -> ?state:endpoint_state -> ?endpoint_url:string -> ?endpoint_id:string -> ?role_arn:string -> ?event_buses:endpoint_event_bus list -> ?replication_config:replication_config -> ?routing_config:routing_config -> ?arn:string -> ?description:string -> ?name:string -> unit -> describe_endpoint_response

Create a describe_endpoint_response type

val make_describe_endpoint_request : ?home_region:string -> name:string -> unit -> describe_endpoint_request

Create a describe_endpoint_request type

val make_connection_basic_auth_response_parameters : ?username:string -> unit -> connection_basic_auth_response_parameters

Create a connection_basic_auth_response_parameters type

val make_connection_o_auth_client_response_parameters : ?client_i_d:string -> unit -> connection_o_auth_client_response_parameters

Create a connection_o_auth_client_response_parameters type

val make_connection_o_auth_response_parameters : ?o_auth_http_parameters:connection_http_parameters -> ?http_method:connection_o_auth_http_method -> ?authorization_endpoint:string -> ?client_parameters:connection_o_auth_client_response_parameters -> unit -> connection_o_auth_response_parameters

Create a connection_o_auth_response_parameters type

val make_connection_api_key_auth_response_parameters : ?api_key_name:string -> unit -> connection_api_key_auth_response_parameters

Create a connection_api_key_auth_response_parameters type

val make_connection_auth_response_parameters : ?invocation_http_parameters:connection_http_parameters -> ?api_key_auth_parameters:connection_api_key_auth_response_parameters -> ?o_auth_parameters:connection_o_auth_response_parameters -> ?basic_auth_parameters:connection_basic_auth_response_parameters -> unit -> connection_auth_response_parameters

Create a connection_auth_response_parameters type

val make_describe_connection_response : ?last_authorized_time:float -> ?last_modified_time:float -> ?creation_time:float -> ?auth_parameters:connection_auth_response_parameters -> ?secret_arn:string -> ?authorization_type:connection_authorization_type -> ?state_reason:string -> ?connection_state:connection_state -> ?description:string -> ?name:string -> ?connection_arn:string -> unit -> describe_connection_response

Create a describe_connection_response type

val make_describe_connection_request : name:string -> unit -> describe_connection_request

Create a describe_connection_request type

val make_describe_archive_response : ?creation_time:float -> ?event_count:int -> ?size_bytes:int -> ?retention_days:int -> ?state_reason:string -> ?state:archive_state -> ?event_pattern:string -> ?description:string -> ?event_source_arn:string -> ?archive_name:string -> ?archive_arn:string -> unit -> describe_archive_response

Create a describe_archive_response type

val make_describe_archive_request : archive_name:string -> unit -> describe_archive_request

Create a describe_archive_request type

val make_describe_api_destination_response : ?last_modified_time:float -> ?creation_time:float -> ?invocation_rate_limit_per_second:int -> ?http_method:api_destination_http_method -> ?invocation_endpoint:string -> ?connection_arn:string -> ?api_destination_state:api_destination_state -> ?description:string -> ?name:string -> ?api_destination_arn:string -> unit -> describe_api_destination_response

Create a describe_api_destination_response type

val make_describe_api_destination_request : name:string -> unit -> describe_api_destination_request

Create a describe_api_destination_request type

val make_delete_rule_request : ?force:bool -> ?event_bus_name:string -> name:string -> unit -> delete_rule_request

Create a delete_rule_request type

val make_delete_partner_event_source_request : account:string -> name:string -> unit -> delete_partner_event_source_request

Create a delete_partner_event_source_request type

val make_delete_event_bus_request : name:string -> unit -> delete_event_bus_request

Create a delete_event_bus_request type

val make_delete_endpoint_response : unit -> delete_endpoint_response

Create a delete_endpoint_response type

val make_delete_endpoint_request : name:string -> unit -> delete_endpoint_request

Create a delete_endpoint_request type

val make_delete_connection_response : ?last_authorized_time:float -> ?last_modified_time:float -> ?creation_time:float -> ?connection_state:connection_state -> ?connection_arn:string -> unit -> delete_connection_response

Create a delete_connection_response type

val make_delete_connection_request : name:string -> unit -> delete_connection_request

Create a delete_connection_request type

val make_delete_archive_response : unit -> delete_archive_response

Create a delete_archive_response type

val make_delete_archive_request : archive_name:string -> unit -> delete_archive_request

Create a delete_archive_request type

val make_delete_api_destination_response : unit -> delete_api_destination_response

Create a delete_api_destination_response type

val make_delete_api_destination_request : name:string -> unit -> delete_api_destination_request

Create a delete_api_destination_request type

val make_deauthorize_connection_response : ?last_authorized_time:float -> ?last_modified_time:float -> ?creation_time:float -> ?connection_state:connection_state -> ?connection_arn:string -> unit -> deauthorize_connection_response

Create a deauthorize_connection_response type

val make_deauthorize_connection_request : name:string -> unit -> deauthorize_connection_request

Create a deauthorize_connection_request type

val make_deactivate_event_source_request : name:string -> unit -> deactivate_event_source_request

Create a deactivate_event_source_request type

val make_create_partner_event_source_response : ?event_source_arn:string -> unit -> create_partner_event_source_response

Create a create_partner_event_source_response type

val make_create_partner_event_source_request : account:string -> name:string -> unit -> create_partner_event_source_request

Create a create_partner_event_source_request type

val make_create_event_bus_response : ?dead_letter_config:dead_letter_config -> ?kms_key_identifier:string -> ?description:string -> ?event_bus_arn:string -> unit -> create_event_bus_response

Create a create_event_bus_response type

val make_create_event_bus_request : ?tags:tag list -> ?dead_letter_config:dead_letter_config -> ?kms_key_identifier:string -> ?description:string -> ?event_source_name:string -> name:string -> unit -> create_event_bus_request

Create a create_event_bus_request type

val make_create_endpoint_response : ?state:endpoint_state -> ?role_arn:string -> ?event_buses:endpoint_event_bus list -> ?replication_config:replication_config -> ?routing_config:routing_config -> ?arn:string -> ?name:string -> unit -> create_endpoint_response

Create a create_endpoint_response type

val make_create_endpoint_request : ?role_arn:string -> ?replication_config:replication_config -> ?description:string -> event_buses:endpoint_event_bus list -> routing_config:routing_config -> name:string -> unit -> create_endpoint_request

Create a create_endpoint_request type

val make_create_connection_response : ?last_modified_time:float -> ?creation_time:float -> ?connection_state:connection_state -> ?connection_arn:string -> unit -> create_connection_response

Create a create_connection_response type

val make_create_connection_basic_auth_request_parameters : password:string -> username:string -> unit -> create_connection_basic_auth_request_parameters

Create a create_connection_basic_auth_request_parameters type

val make_create_connection_o_auth_client_request_parameters : client_secret:string -> client_i_d:string -> unit -> create_connection_o_auth_client_request_parameters

Create a create_connection_o_auth_client_request_parameters type

val make_create_connection_o_auth_request_parameters : ?o_auth_http_parameters:connection_http_parameters -> http_method:connection_o_auth_http_method -> authorization_endpoint:string -> client_parameters:create_connection_o_auth_client_request_parameters -> unit -> create_connection_o_auth_request_parameters

Create a create_connection_o_auth_request_parameters type

val make_create_connection_api_key_auth_request_parameters : api_key_value:string -> api_key_name:string -> unit -> create_connection_api_key_auth_request_parameters

Create a create_connection_api_key_auth_request_parameters type

val make_create_connection_auth_request_parameters : ?invocation_http_parameters:connection_http_parameters -> ?api_key_auth_parameters:create_connection_api_key_auth_request_parameters -> ?o_auth_parameters:create_connection_o_auth_request_parameters -> ?basic_auth_parameters:create_connection_basic_auth_request_parameters -> unit -> create_connection_auth_request_parameters

Create a create_connection_auth_request_parameters type

val make_create_connection_request : ?description:string -> auth_parameters:create_connection_auth_request_parameters -> authorization_type:connection_authorization_type -> name:string -> unit -> create_connection_request

Create a create_connection_request type

val make_create_archive_response : ?creation_time:float -> ?state_reason:string -> ?state:archive_state -> ?archive_arn:string -> unit -> create_archive_response

Create a create_archive_response type

val make_create_archive_request : ?retention_days:int -> ?event_pattern:string -> ?description:string -> event_source_arn:string -> archive_name:string -> unit -> create_archive_request

Create a create_archive_request type

val make_create_api_destination_response : ?last_modified_time:float -> ?creation_time:float -> ?api_destination_state:api_destination_state -> ?api_destination_arn:string -> unit -> create_api_destination_response

Create a create_api_destination_response type

val make_create_api_destination_request : ?invocation_rate_limit_per_second:int -> ?description:string -> http_method:api_destination_http_method -> invocation_endpoint:string -> connection_arn:string -> name:string -> unit -> create_api_destination_request

Create a create_api_destination_request type

val make_cancel_replay_response : ?state_reason:string -> ?state:replay_state -> ?replay_arn:string -> unit -> cancel_replay_response

Create a cancel_replay_response type

val make_cancel_replay_request : replay_name:string -> unit -> cancel_replay_request

Create a cancel_replay_request type

val make_activate_event_source_request : name:string -> unit -> activate_event_source_request

Create a activate_event_source_request type

Operations

module ActivateEventSource : sig ... end
module CancelReplay : sig ... end
module CreateApiDestination : sig ... end
module CreateArchive : sig ... end
module CreateConnection : sig ... end
module CreateEndpoint : sig ... end
module CreateEventBus : sig ... end
module CreatePartnerEventSource : sig ... end
module DeactivateEventSource : sig ... end
module DeauthorizeConnection : sig ... end
module DeleteApiDestination : sig ... end
module DeleteArchive : sig ... end
module DeleteConnection : sig ... end
module DeleteEndpoint : sig ... end
module DeleteEventBus : sig ... end
module DeletePartnerEventSource : sig ... end
module DeleteRule : sig ... end
module DescribeApiDestination : sig ... end
module DescribeArchive : sig ... end
module DescribeConnection : sig ... end
module DescribeEndpoint : sig ... end
module DescribeEventBus : sig ... end
module DescribeEventSource : sig ... end
module DescribePartnerEventSource : sig ... end
module DescribeReplay : sig ... end
module DescribeRule : sig ... end
module DisableRule : sig ... end
module EnableRule : sig ... end
module ListApiDestinations : sig ... end
module ListArchives : sig ... end
module ListConnections : sig ... end
module ListEndpoints : sig ... end
module ListEventBuses : sig ... end
module ListEventSources : sig ... end
module ListPartnerEventSourceAccounts : sig ... end
module ListPartnerEventSources : sig ... end
module ListReplays : sig ... end
module ListRuleNamesByTarget : sig ... end
module ListRules : sig ... end
module ListTagsForResource : sig ... end
module ListTargetsByRule : sig ... end
module PutEvents : sig ... end
module PutPartnerEvents : sig ... end
module PutPermission : sig ... end
module PutRule : sig ... end
module PutTargets : sig ... end
module RemovePermission : sig ... end
module RemoveTargets : sig ... end
module StartReplay : sig ... end
module TagResource : sig ... end
module TestEventPattern : sig ... end
module UntagResource : sig ... end
module UpdateApiDestination : sig ... end
module UpdateArchive : sig ... end
module UpdateConnection : sig ... end
module UpdateEndpoint : sig ... end
module UpdateEventBus : sig ... end