Module Smaws_Client_EventBridge.Types

type nonrec string_ = string
type nonrec event_bus_name = string
type nonrec kms_key_identifier = string
type nonrec event_bus_description = string
type nonrec resource_arn = string
type nonrec dead_letter_config = {
  1. arn : resource_arn 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 Using dead-letter queues to process undelivered events in the EventBridge User Guide.

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

    The event bus description.

    *)
  3. kms_key_identifier : kms_key_identifier 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 : event_bus_name option;
    (*

    The event bus name.

    *)
  5. arn : string_ option;
    (*

    The event bus Amazon Resource Name (ARN).

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

    The event bus description.

    *)
  3. kms_key_identifier : kms_key_identifier 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 Identify and view keys in the Key Management Service Developer Guide.

    Schema discovery is 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/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 schema discovery enabled.

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

    If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.

    For more information, see Encrypting archives in the Amazon EventBridge User Guide.

    *)
  4. name : event_bus_name option;
    (*

    The name of the event bus.

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

An entity that you specified does not exist.

type nonrec operation_disabled_exception = {
  1. message : error_message option;
}

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

type nonrec internal_exception = {
  1. message : error_message option;
}

This exception occurs due to unexpected causes.

type nonrec concurrent_modification_exception = {
  1. message : error_message option;
}

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

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

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

    *)
}

The primary Region of the endpoint.

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

    Defines the secondary Region.

    *)
}

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

type nonrec 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 nonrec 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 nonrec replication_state =
  1. | DISABLED
  2. | ENABLED
type nonrec replication_config = {
  1. state : replication_state option;
    (*

    The state of event replication.

    *)
}

Endpoints can replicate all events to the secondary Region.

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

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

    *)
}

The event buses the endpoint is associated with.

type nonrec endpoint_event_bus_list = endpoint_event_bus list
type nonrec iam_role_arn = string
type nonrec endpoint_id = string
type nonrec endpoint_url = string
type nonrec endpoint_state =
  1. | DELETE_FAILED
  2. | UPDATE_FAILED
  3. | CREATE_FAILED
  4. | DELETING
  5. | UPDATING
  6. | CREATING
  7. | ACTIVE
type nonrec update_endpoint_response = {
  1. state : endpoint_state option;
    (*

    The state of the endpoint you updated in this request.

    *)
  2. endpoint_url : endpoint_url option;
    (*

    The URL of the endpoint you updated in this request.

    *)
  3. endpoint_id : endpoint_id option;
    (*

    The ID of the endpoint you updated in this request.

    *)
  4. role_arn : iam_role_arn 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 : endpoint_arn option;
    (*

    The ARN of the endpoint you updated in this request.

    *)
  9. name : endpoint_name option;
    (*

    The name of the endpoint you updated in this request.

    *)
}
type nonrec endpoint_description = string
type nonrec update_endpoint_request = {
  1. role_arn : iam_role_arn 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 : endpoint_description option;
    (*

    A description for the endpoint.

    *)
  6. name : endpoint_name;
    (*

    The name of the endpoint you want to update.

    *)
}
type nonrec connection_arn = string
type nonrec connection_state =
  1. | FAILED_CONNECTIVITY
  2. | ACTIVE
  3. | DEAUTHORIZING
  4. | AUTHORIZING
  5. | DEAUTHORIZED
  6. | AUTHORIZED
  7. | DELETING
  8. | UPDATING
  9. | CREATING
type nonrec timestamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec update_connection_response = {
  1. last_authorized_time : timestamp option;
    (*

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

    *)
  2. last_modified_time : timestamp option;
    (*

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

    *)
  3. creation_time : timestamp 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 : connection_arn option;
    (*

    The ARN of the connection that was updated.

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

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

    *)
  2. username : auth_header_parameters option;
    (*

    The user name to use for Basic authorization.

    *)
}

The Basic authorization parameters for the connection.

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

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

    *)
  2. client_i_d : auth_header_parameters option;
    (*

    The client ID to use for OAuth authorization.

    *)
}

The OAuth authorization parameters to use for the connection.

type nonrec https_endpoint = string
type nonrec connection_o_auth_http_method =
  1. | PUT
  2. | POST
  3. | GET
type nonrec header_key = string
type nonrec header_value_sensitive = string
type nonrec boolean_ = bool
type nonrec connection_header_parameter = {
  1. is_value_secret : boolean_ option;
    (*

    Specifies whether the value is a secret.

    *)
  2. value : header_value_sensitive option;
    (*

    The value associated with the key.

    *)
  3. key : header_key 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 nonrec connection_header_parameters_list = connection_header_parameter list
type nonrec query_string_key = string
type nonrec query_string_value_sensitive = string
type nonrec connection_query_string_parameter = {
  1. is_value_secret : boolean_ option;
    (*

    Specifies whether the value is secret.

    *)
  2. value : query_string_value_sensitive option;
    (*

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

    *)
  3. key : query_string_key option;
    (*

    The key for a query string parameter.

    *)
}

Any 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 nonrec connection_query_string_parameters_list = connection_query_string_parameter list
type nonrec sensitive_string = string
type nonrec connection_body_parameter = {
  1. is_value_secret : boolean_ option;
    (*

    Specifies whether the value is secret.

    *)
  2. value : sensitive_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 nonrec connection_body_parameters_list = connection_body_parameter list
type nonrec connection_http_parameters = {
  1. body_parameters : connection_body_parameters_list option;
    (*

    Any additional body string parameters for the connection.

    *)
  2. query_string_parameters : connection_query_string_parameters_list option;
    (*

    Any additional query string parameters for the connection.

    *)
  3. header_parameters : connection_header_parameters_list option;
    (*

    Any additional header parameters for the connection.

    *)
}

Any additional parameters for the connection.

type nonrec 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 : https_endpoint 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;
    (*

    The client parameters to use for the connection when OAuth is specified as the authorization type.

    *)
}

The OAuth request parameters to use for the connection.

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

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

    *)
  2. api_key_name : auth_header_parameters option;
    (*

    The name of the API key to use for authorization.

    *)
}

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

type nonrec resource_configuration_arn = string
type nonrec connectivity_resource_configuration_arn = {
  1. resource_configuration_arn : resource_configuration_arn;
    (*

    The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint.

    *)
}

The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint.

type nonrec connectivity_resource_parameters = {
  1. resource_parameters : connectivity_resource_configuration_arn;
    (*

    The parameters for EventBridge to use when invoking the resource endpoint.

    *)
}

The parameters for EventBridge to use when invoking the resource endpoint.

type nonrec update_connection_auth_request_parameters = {
  1. connectivity_parameters : connectivity_resource_parameters option;
    (*

    If you specify a private OAuth endpoint, the parameters for EventBridge to use when authenticating against the endpoint.

    For more information, see Authorization methods for connections in the Amazon EventBridge User Guide.

    *)
  2. invocation_http_parameters : connection_http_parameters option;
    (*

    The additional parameters to use for the connection.

    *)
  3. api_key_auth_parameters : update_connection_api_key_auth_request_parameters option;
    (*

    The authorization parameters for API key authorization.

    *)
  4. o_auth_parameters : update_connection_o_auth_request_parameters option;
    (*

    The authorization parameters for OAuth authorization.

    *)
  5. basic_auth_parameters : update_connection_basic_auth_request_parameters option;
    (*

    The authorization parameters for Basic authorization.

    *)
}

Contains the additional parameters to use for the connection.

type nonrec update_connection_request = {
  1. kms_key_identifier : kms_key_identifier option;
    (*

    The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. 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 the connection.

    For more information, see Identify and view keys in the Key Management Service Developer Guide.

    *)
  2. invocation_connectivity_parameters : connectivity_resource_parameters option;
    (*

    For connections to private APIs, the parameters to use for invoking the API.

    For more information, see Connecting to private APIs in the Amazon EventBridge User Guide.

    *)
  3. auth_parameters : update_connection_auth_request_parameters option;
    (*

    The authorization parameters to use for the connection.

    *)
  4. authorization_type : connection_authorization_type option;
    (*

    The type of authorization to use for the connection.

    *)
  5. description : connection_description option;
    (*

    A description for the connection.

    *)
  6. name : connection_name;
    (*

    The name of the connection to update.

    *)
}
type nonrec throttling_exception = {
  1. message : error_message option;
}

This request cannot be completed due to throttling issues.

type nonrec limit_exceeded_exception = {
  1. message : error_message option;
}

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

type nonrec access_denied_exception = {
  1. message : error_message option;
}

You do not have the necessary permissions for this action.

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

    The time at which the archive was updated.

    *)
  2. state_reason : archive_state_reason option;
    (*

    The reason that the archive is in the current state.

    *)
  3. state : archive_state option;
    (*

    The state of the archive.

    *)
  4. archive_arn : archive_arn option;
    (*

    The ARN of the archive.

    *)
}
type nonrec archive_name = string
type nonrec archive_description = string
type nonrec event_pattern = string
type nonrec retention_days = int
type nonrec update_archive_request = {
  1. kms_key_identifier : kms_key_identifier option;
    (*

    The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. 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 the archive.

    For more information, see Identify and view keys in the Key Management Service Developer Guide.

    If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.

    For more information, see Encrypting archives in the Amazon EventBridge User Guide.

    *)
  2. retention_days : retention_days option;
    (*

    The number of days to retain events in the archive.

    *)
  3. event_pattern : event_pattern option;
    (*

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

    *)
  4. description : archive_description option;
    (*

    The description for the archive.

    *)
  5. archive_name : archive_name;
    (*

    The name of the archive to update.

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

The event pattern is not valid.

type nonrec api_destination_arn = string
type nonrec api_destination_state =
  1. | INACTIVE
  2. | ACTIVE
type nonrec update_api_destination_response = {
  1. last_modified_time : timestamp option;
    (*

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

    *)
  2. creation_time : timestamp 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 : api_destination_arn option;
    (*

    The ARN of the API destination that was updated.

    *)
}
type nonrec api_destination_name = string
type nonrec api_destination_description = string
type nonrec api_destination_http_method =
  1. | DELETE
  2. | PATCH
  3. | PUT
  4. | OPTIONS
  5. | HEAD
  6. | GET
  7. | POST
type nonrec api_destination_invocation_rate_limit_per_second = int
type nonrec update_api_destination_request = {
  1. invocation_rate_limit_per_second : api_destination_invocation_rate_limit_per_second 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 : https_endpoint option;
    (*

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

    *)
  4. connection_arn : connection_arn option;
    (*

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

    *)
  5. description : api_destination_description option;
    (*

    The name of the API destination to update.

    *)
  6. name : api_destination_name;
    (*

    The name of the API destination to update.

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

    The list of tag keys to remove from the resource.

    *)
  2. resource_ar_n : arn;
    (*

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

    *)
}
type nonrec managed_rule_exception = {
  1. message : error_message 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 nonrec target_input_path = string
type nonrec input_transformer_path_key = string
type nonrec transformer_paths = (input_transformer_path_key * target_input_path) list
type nonrec transformer_input = string
type nonrec trace_header = string
type nonrec test_event_pattern_response = {
  1. result : boolean_ option;
    (*

    Indicates whether the event matches the event pattern.

    *)
}
type nonrec 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 : event_pattern;
    (*

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

    *)
}
type nonrec target_partition_key_path = string
type nonrec target_id = string
type nonrec target_arn = string
type nonrec role_arn = string
type nonrec target_input = string
type nonrec input_transformer = {
  1. input_template : transformer_input;
    (*

    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 : transformer_paths 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 nonrec kinesis_parameters = {
  1. partition_key_path : target_partition_key_path;
    (*

    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 nonrec run_command_target_key = string
type nonrec run_command_target_value = string
type nonrec run_command_target_values = run_command_target_value list
type nonrec run_command_target = {
  1. values : run_command_target_values;
    (*

    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 : run_command_target_key;
    (*

    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 nonrec run_command_targets = run_command_target list
type nonrec run_command_parameters = {
  1. run_command_targets : run_command_targets;
    (*

    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 nonrec limit_min1 = int
type nonrec launch_type =
  1. | EXTERNAL
  2. | FARGATE
  3. | EC2
type nonrec string_list = string_ list
type nonrec assign_public_ip =
  1. | DISABLED
  2. | ENABLED
type nonrec 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 nonrec 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 nonrec capacity_provider = string
type nonrec capacity_provider_strategy_item_weight = int
type nonrec capacity_provider_strategy_item_base = int
type nonrec capacity_provider_strategy_item = {
  1. base : capacity_provider_strategy_item_base 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 : capacity_provider_strategy_item_weight 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 : capacity_provider;
    (*

    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 nonrec capacity_provider_strategy = capacity_provider_strategy_item list
type nonrec placement_constraint_type =
  1. | MEMBER_OF
  2. | DISTINCT_INSTANCE
type nonrec placement_constraint_expression = string
type nonrec placement_constraint = {
  1. expression : placement_constraint_expression 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 nonrec placement_constraints = placement_constraint list
type nonrec placement_strategy_type =
  1. | BINPACK
  2. | SPREAD
  3. | RANDOM
type nonrec placement_strategy_field = string
type nonrec placement_strategy = {
  1. field : placement_strategy_field 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 nonrec placement_strategies = placement_strategy list
type nonrec propagate_tags =
  1. | TASK_DEFINITION
type nonrec reference_id = string
type nonrec tag_value = string
type nonrec tag = {
  1. value : tag_value;
    (*

    The value for the specified tag key.

    *)
  2. key : tag_key;
    (*

    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 nonrec tag_list = tag list
type nonrec 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 : reference_id 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_strategies 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_constraints 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 : boolean_ 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 : boolean_ 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 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 : limit_min1 option;
    (*

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

    *)
  14. task_definition_arn : arn;
    (*

    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 nonrec integer = int
type nonrec batch_array_properties = {
  1. size : integer 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 nonrec batch_retry_strategy = {
  1. attempts : integer 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 nonrec 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 nonrec message_group_id = string
type nonrec sqs_parameters = {
  1. message_group_id : message_group_id 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 nonrec path_parameter = string
type nonrec path_parameter_list = path_parameter list
type nonrec header_value = string
type nonrec header_parameters_map = (header_key * header_value) list
type nonrec query_string_value = string
type nonrec query_string_parameters_map = (query_string_key * query_string_value) list
type nonrec http_parameters = {
  1. query_string_parameters : query_string_parameters_map 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 : header_parameters_map option;
    (*

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

    *)
  3. path_parameter_values : path_parameter_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 nonrec redshift_secret_manager_arn = string
type nonrec database = string
type nonrec db_user = string
type nonrec sql = string
type nonrec statement_name = string
type nonrec sqls = sql list
type nonrec redshift_data_parameters = {
  1. sqls : sqls 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 : boolean_ option;
    (*

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

    *)
  3. statement_name : statement_name option;
    (*

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

    *)
  4. sql : sql option;
    (*

    The SQL statement text to run.

    *)
  5. db_user : db_user option;
    (*

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

    *)
  6. database : database;
    (*

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

    *)
  7. secret_manager_arn : redshift_secret_manager_arn 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 nonrec sage_maker_pipeline_parameter_name = string
type nonrec sage_maker_pipeline_parameter_value = string
type nonrec sage_maker_pipeline_parameter = {
  1. value : sage_maker_pipeline_parameter_value;
    (*

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

    *)
  2. name : sage_maker_pipeline_parameter_name;
    (*

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

    *)
}

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

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

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

    *)
}

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

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

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

    *)
  2. maximum_retry_attempts : maximum_retry_attempts 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 nonrec graph_ql_operation = string
type nonrec app_sync_parameters = {
  1. graph_ql_operation : graph_ql_operation 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 nonrec 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 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 AI Model Building Pipeline parameters to start execution of a SageMaker AI Model Building Pipeline.

    If you specify a SageMaker AI 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 : target_input_path 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 : target_input 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 : role_arn 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 : target_arn;
    (*

    The Amazon Resource Name (ARN) of the target.

    *)
  17. id : target_id;
    (*

    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 nonrec target_list = target list
type nonrec target_id_list = target_id list
type nonrec tag_resource_response = unit
type nonrec tag_resource_request = {
  1. tags : tag_list;
    (*

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

    *)
  2. resource_ar_n : arn;
    (*

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

    *)
}
type nonrec statement_id = string
type nonrec replay_arn = string
type nonrec replay_state =
  1. | FAILED
  2. | CANCELLED
  3. | COMPLETED
  4. | CANCELLING
  5. | RUNNING
  6. | STARTING
type nonrec replay_state_reason = string
type nonrec start_replay_response = {
  1. replay_start_time : timestamp option;
    (*

    The time at which the replay started.

    *)
  2. state_reason : replay_state_reason option;
    (*

    The reason that the replay is in the state.

    *)
  3. state : replay_state option;
    (*

    The state of the replay.

    *)
  4. replay_arn : replay_arn option;
    (*

    The ARN of the replay.

    *)
}
type nonrec replay_name = string
type nonrec replay_description = string
type nonrec replay_destination_filters = arn list
type nonrec replay_destination = {
  1. filter_arns : replay_destination_filters option;
    (*

    A list of ARNs for rules to replay events to.

    *)
  2. arn : arn;
    (*

    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 nonrec start_replay_request = {
  1. destination : replay_destination;
    (*

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

    *)
  2. event_end_time : timestamp;
    (*

    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 : timestamp;
    (*

    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 : archive_arn;
    (*

    The ARN of the archive to replay events from.

    *)
  5. description : replay_description option;
    (*

    A description for the replay to start.

    *)
  6. replay_name : replay_name;
    (*

    The name of the replay to start.

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

The resource you are trying to create already exists.

type nonrec secrets_manager_secret_arn = string
type nonrec schedule_expression = string
type nonrec rule_state =
  1. | ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS
  2. | DISABLED
  3. | ENABLED
type nonrec rule_name = string
type nonrec rule_arn = string
type nonrec rule_description = string
type nonrec managed_by = string
type nonrec rule = {
  1. event_bus_name : event_bus_name 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 : managed_by 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 : role_arn 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 : schedule_expression 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 : rule_description 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 : event_pattern option;
    (*

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

    *)
  8. arn : rule_arn option;
    (*

    The Amazon Resource Name (ARN) of the rule.

    *)
  9. name : rule_name option;
    (*

    The name of the rule.

    *)
}

Contains information about a rule in Amazon EventBridge.

type nonrec rule_response_list = rule list
type nonrec rule_name_list = rule_name list
type nonrec resource_association_arn = string
type nonrec replay = {
  1. replay_end_time : timestamp option;
    (*

    A time stamp for the time that the replay completed.

    *)
  2. replay_start_time : timestamp option;
    (*

    A time stamp for the time that the replay started.

    *)
  3. event_last_replayed_time : timestamp option;
    (*

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

    *)
  4. event_end_time : timestamp 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 : timestamp 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 : replay_state_reason 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 : archive_arn option;
    (*

    The ARN of the archive to replay event from.

    *)
  9. replay_name : replay_name option;
    (*

    The name of the replay.

    *)
}

A Replay object that contains details about a replay.

type nonrec replay_list = replay list
type nonrec error_code = string
type nonrec remove_targets_result_entry = {
  1. error_message : error_message option;
    (*

    The error message that explains why the target removal failed.

    *)
  2. error_code : error_code 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 : target_id option;
    (*

    The ID of the target.

    *)
}

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

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

    The failed target entries.

    *)
  2. failed_entry_count : integer option;
    (*

    The number of failed entries.

    *)
}
type nonrec event_bus_name_or_arn = string
type nonrec remove_targets_request = {
  1. force : boolean_ 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 : target_id_list;
    (*

    The IDs of the targets to remove from the rule.

    *)
  3. event_bus_name : event_bus_name_or_arn 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 : rule_name;
    (*

    The name of the rule.

    *)
}
type nonrec non_partner_event_bus_name = string
type nonrec remove_permission_request = {
  1. event_bus_name : non_partner_event_bus_name 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 : boolean_ option;
    (*

    Specifies whether to remove all permissions.

    *)
  3. statement_id : statement_id option;
    (*

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

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

    The error message that explains why the target addition failed.

    *)
  2. error_code : error_code 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 : target_id option;
    (*

    The ID of the target.

    *)
}

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

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

    The failed target entries.

    *)
  2. failed_entry_count : integer option;
    (*

    The number of failed entries.

    *)
}
type nonrec put_targets_request = {
  1. targets : target_list;
    (*

    The targets to update or add to the rule.

    *)
  2. event_bus_name : event_bus_name_or_arn 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 : rule_name;
    (*

    The name of the rule.

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

    The Amazon Resource Name (ARN) of the rule.

    *)
}
type nonrec put_rule_request = {
  1. event_bus_name : event_bus_name_or_arn 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 : role_arn 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 : rule_description 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 : event_pattern option;
    (*

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

    *)
  7. schedule_expression : schedule_expression option;
    (*

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

    *)
  8. name : rule_name;
    (*

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

    *)
}
type nonrec action = string
type nonrec principal = string
type nonrec 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.

    *)
}

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 nonrec 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 : statement_id 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 : principal 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 : action option;
    (*

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

    *)
  6. event_bus_name : non_partner_event_bus_name option;
    (*

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

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

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

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

    The error message that explains why the event submission failed.

    *)
  2. error_code : error_code option;
    (*

    The error code that indicates why the event submission failed.

    *)
  3. event_id : event_id 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 nonrec put_partner_events_result_entry_list = put_partner_events_result_entry list
type nonrec 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 : integer option;
    (*

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

    *)
}
type nonrec event_time = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec event_source_name = string
type nonrec event_resource = string
type nonrec event_resource_list = event_resource list
type nonrec 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 : event_resource_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 : event_source_name 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 : event_time option;
    (*

    The date and time of the event.

    *)
}

The details about an event generated by an SaaS partner.

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

    The list of events to write to the event bus.

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

    The error message that explains why the event submission failed.

    *)
  2. error_code : error_code 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 : event_id 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 nonrec put_events_result_entry_list = put_events_result_entry list
type nonrec 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 : integer option;
    (*

    The number of failed entries.

    *)
}
type nonrec non_partner_event_bus_name_or_arn = string
type nonrec put_events_request_entry = {
  1. trace_header : trace_header 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 : non_partner_event_bus_name_or_arn 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 : event_resource_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 : event_time 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 nonrec put_events_request_entry_list = put_events_request_entry list
type nonrec put_events_request = {
  1. endpoint_id : endpoint_id 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 nonrec partner_event_source_name_prefix = string
type nonrec 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 nonrec partner_event_source_list = partner_event_source list
type nonrec account_id = string
type nonrec event_source_state =
  1. | DELETED
  2. | ACTIVE
  3. | PENDING
type nonrec 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 : timestamp 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 : timestamp option;
    (*

    The date and time the event source was created.

    *)
  4. account : account_id 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 nonrec partner_event_source_account_list = partner_event_source_account list
type nonrec next_token = string
type nonrec long = int
type nonrec list_targets_by_rule_response = {
  1. next_token : next_token option;
    (*

    A token indicating there are more results available. If there are no more results, no token is included in the response.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  2. targets : target_list option;
    (*

    The targets assigned to the rule.

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

    The maximum number of results to return.

    *)
  2. next_token : next_token option;
    (*

    The token returned by a previous call, which you can use to retrieve the next set of results.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  3. event_bus_name : event_bus_name_or_arn 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 : rule_name;
    (*

    The name of the rule.

    *)
}
type nonrec list_tags_for_resource_response = {
  1. tags : tag_list option;
    (*

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

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

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

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

    A token indicating there are more results available. If there are no more results, no token is included in the response.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  2. rules : rule_response_list option;
    (*

    The rules that match the specified criteria.

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

    The maximum number of results to return.

    *)
  2. next_token : next_token option;
    (*

    The token returned by a previous call, which you can use to retrieve the next set of results.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  3. event_bus_name : event_bus_name_or_arn 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 : rule_name option;
    (*

    The prefix matching the rule name.

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

    A token indicating there are more results available. If there are no more results, no token is included in the response.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  2. rule_names : rule_name_list option;
    (*

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

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

    The maximum number of results to return.

    *)
  2. next_token : next_token option;
    (*

    The token returned by a previous call, which you can use to retrieve the next set of results.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  3. event_bus_name : event_bus_name_or_arn 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 : target_arn;
    (*

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

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

    A token indicating there are more results available. If there are no more results, no token is included in the response.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  2. replays : replay_list option;
    (*

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

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

    The maximum number of replays to retrieve.

    *)
  2. next_token : next_token option;
    (*

    The token returned by a previous call, which you can use to retrieve the next set of results.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  3. event_source_arn : archive_arn 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 : replay_name option;
    (*

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

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

    A token indicating there are more results available. If there are no more results, no token is included in the response.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  2. partner_event_sources : partner_event_source_list option;
    (*

    The list of partner event sources returned by the operation.

    *)
}
type nonrec list_partner_event_sources_request = {
  1. limit : limit_max100 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 : next_token option;
    (*

    The token returned by a previous call, which you can use to retrieve the next set of results.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  3. name_prefix : partner_event_source_name_prefix;
    (*

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

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

    A token indicating there are more results available. If there are no more results, no token is included in the response.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  2. partner_event_source_accounts : partner_event_source_account_list option;
    (*

    The list of partner event sources returned by the operation.

    *)
}
type nonrec list_partner_event_source_accounts_request = {
  1. limit : limit_max100 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 : next_token option;
    (*

    The token returned by a previous call, which you can use to retrieve the next set of results.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  3. event_source_name : event_source_name;
    (*

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

    *)
}
type nonrec 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 : timestamp 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 : timestamp 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 nonrec event_source_list = event_source list
type nonrec list_event_sources_response = {
  1. next_token : next_token option;
    (*

    A token indicating there are more results available. If there are no more results, no token is included in the response.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  2. event_sources : event_source_list option;
    (*

    The list of event sources.

    *)
}
type nonrec event_source_name_prefix = string
type nonrec list_event_sources_request = {
  1. limit : limit_max100 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 : next_token option;
    (*

    The token returned by a previous call, which you can use to retrieve the next set of results.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  3. name_prefix : event_source_name_prefix option;
    (*

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

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

    The time the event bus was last modified.

    *)
  2. creation_time : timestamp 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 : event_bus_description 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 nonrec event_bus_list = event_bus list
type nonrec list_event_buses_response = {
  1. next_token : next_token option;
    (*

    A token indicating there are more results available. If there are no more results, no token is included in the response.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  2. event_buses : event_bus_list option;
    (*

    This list of event buses.

    *)
}
type nonrec list_event_buses_request = {
  1. limit : limit_max100 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 : next_token option;
    (*

    The token returned by a previous call, which you can use to retrieve the next set of results.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  3. name_prefix : event_bus_name option;
    (*

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

    *)
}
type nonrec endpoint_state_reason = string
type nonrec endpoint = {
  1. last_modified_time : timestamp option;
    (*

    The last time the endpoint was modified.

    *)
  2. creation_time : timestamp option;
    (*

    The time the endpoint was created.

    *)
  3. state_reason : endpoint_state_reason option;
    (*

    The reason the endpoint is in its current state.

    *)
  4. state : endpoint_state option;
    (*

    The current state of the endpoint.

    *)
  5. endpoint_url : endpoint_url option;
    (*

    The URL of the endpoint.

    *)
  6. endpoint_id : endpoint_id 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 : iam_role_arn 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 : endpoint_arn option;
    (*

    The ARN of the endpoint.

    *)
  12. description : endpoint_description option;
    (*

    A description for the endpoint.

    *)
  13. name : endpoint_name 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 nonrec endpoint_list = endpoint list
type nonrec list_endpoints_response = {
  1. next_token : next_token option;
    (*

    A token indicating there are more results available. If there are no more results, no token is included in the response.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  2. endpoints : endpoint_list option;
    (*

    The endpoints returned by the call.

    *)
}
type nonrec home_region = string
type nonrec list_endpoints_request = {
  1. max_results : limit_max100 option;
    (*

    The maximum number of results returned by the call.

    *)
  2. next_token : next_token option;
    (*

    The token returned by a previous call, which you can use to retrieve the next set of results.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  3. home_region : home_region option;
    (*

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

    *)
  4. name_prefix : endpoint_name 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 nonrec connection_state_reason = string
type nonrec connection = {
  1. last_authorized_time : timestamp option;
    (*

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

    *)
  2. last_modified_time : timestamp option;
    (*

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

    *)
  3. creation_time : timestamp 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 : connection_state_reason option;
    (*

    The reason that the connection is in the connection state.

    *)
  6. connection_state : connection_state option;
    (*

    The state of the connection.

    *)
  7. name : connection_name option;
    (*

    The name of the connection.

    *)
  8. connection_arn : connection_arn option;
    (*

    The ARN of the connection.

    *)
}

Contains information about a connection.

type nonrec connection_response_list = connection list
type nonrec list_connections_response = {
  1. next_token : next_token option;
    (*

    A token indicating there are more results available. If there are no more results, no token is included in the response.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  2. connections : connection_response_list option;
    (*

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

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

    The maximum number of connections to return.

    *)
  2. next_token : next_token option;
    (*

    The token returned by a previous call, which you can use to retrieve the next set of results.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  3. connection_state : connection_state option;
    (*

    The state of the connection.

    *)
  4. name_prefix : connection_name option;
    (*

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

    *)
}
type nonrec event_bus_arn = string
type nonrec archive = {
  1. creation_time : timestamp option;
    (*

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

    *)
  2. event_count : long option;
    (*

    The number of events in the archive.

    *)
  3. size_bytes : long option;
    (*

    The size of the archive, in bytes.

    *)
  4. retention_days : retention_days option;
    (*

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

    *)
  5. state_reason : archive_state_reason 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 : event_bus_arn 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 : archive_name option;
    (*

    The name of the archive.

    *)
}

An Archive object that contains details about an archive.

type nonrec archive_response_list = archive list
type nonrec list_archives_response = {
  1. next_token : next_token option;
    (*

    A token indicating there are more results available. If there are no more results, no token is included in the response.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  2. archives : archive_response_list option;
    (*

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

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

    The maximum number of results to return.

    *)
  2. next_token : next_token option;
    (*

    The token returned by a previous call, which you can use to retrieve the next set of results.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  3. state : archive_state option;
    (*

    The state of the archive.

    *)
  4. event_source_arn : event_bus_arn option;
    (*

    The ARN of the event source associated with the archive.

    *)
  5. name_prefix : archive_name option;
    (*

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

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

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

    *)
  2. creation_time : timestamp option;
    (*

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

    *)
  3. invocation_rate_limit_per_second : api_destination_invocation_rate_limit_per_second 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 : https_endpoint option;
    (*

    The URL to the endpoint for the API destination.

    *)
  6. connection_arn : connection_arn 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 : api_destination_name option;
    (*

    The name of the API destination.

    *)
  9. api_destination_arn : api_destination_arn option;
    (*

    The ARN of the API destination.

    *)
}

Contains details about an API destination.

type nonrec api_destination_response_list = api_destination list
type nonrec list_api_destinations_response = {
  1. next_token : next_token option;
    (*

    A token indicating there are more results available. If there are no more results, no token is included in the response.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  2. api_destinations : api_destination_response_list option;
    (*

    An array that includes information about each API destination.

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

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

    *)
  2. next_token : next_token option;
    (*

    The token returned by a previous call, which you can use to retrieve the next set of results.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

    *)
  3. connection_arn : connection_arn option;
    (*

    The ARN of the connection specified for the API destination.

    *)
  4. name_prefix : api_destination_name option;
    (*

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

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

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

type nonrec illegal_status_exception = {
  1. message : error_message option;
}

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

type nonrec enable_rule_request = {
  1. event_bus_name : event_bus_name_or_arn 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 : rule_name;
    (*

    The name of the rule.

    *)
}
type nonrec disable_rule_request = {
  1. event_bus_name : event_bus_name_or_arn 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 : rule_name;
    (*

    The name of the rule.

    *)
}
type nonrec created_by = string
type nonrec describe_rule_response = {
  1. created_by : created_by 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 : event_bus_name option;
    (*

    The name of the event bus associated with the rule.

    *)
  3. managed_by : managed_by 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 : role_arn option;
    (*

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

    *)
  5. description : rule_description option;
    (*

    The description of the rule.

    *)
  6. state : rule_state option;
    (*

    Specifies whether the rule is enabled or disabled.

    *)
  7. schedule_expression : schedule_expression option;
    (*

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

    *)
  8. event_pattern : event_pattern option;
    (*

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

    *)
  9. arn : rule_arn option;
    (*

    The Amazon Resource Name (ARN) of the rule.

    *)
  10. name : rule_name option;
    (*

    The name of the rule.

    *)
}
type nonrec describe_rule_request = {
  1. event_bus_name : event_bus_name_or_arn 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 : rule_name;
    (*

    The name of the rule.

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

    A time stamp for the time that the replay stopped.

    *)
  2. replay_start_time : timestamp option;
    (*

    A time stamp for the time that the replay started.

    *)
  3. event_last_replayed_time : timestamp option;
    (*

    The time that the event was last replayed.

    *)
  4. event_end_time : timestamp option;
    (*

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

    *)
  5. event_start_time : timestamp 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 : archive_arn option;
    (*

    The ARN of the archive events were replayed from.

    *)
  8. state_reason : replay_state_reason option;
    (*

    The reason that the replay is in the current state.

    *)
  9. state : replay_state option;
    (*

    The current state of the replay.

    *)
  10. description : replay_description option;
    (*

    The description of the replay.

    *)
  11. replay_arn : replay_arn option;
    (*

    The ARN of the replay.

    *)
  12. replay_name : replay_name option;
    (*

    The name of the replay.

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

    The name of the replay to retrieve.

    *)
}
type nonrec 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 nonrec describe_partner_event_source_request = {
  1. name : event_source_name;
    (*

    The name of the event source to display.

    *)
}
type nonrec 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 : timestamp option;
    (*

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

    *)
  4. creation_time : timestamp 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 nonrec describe_event_source_request = {
  1. name : event_source_name;
    (*

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

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

    The time the event bus was last modified.

    *)
  2. creation_time : timestamp 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 : kms_key_identifier 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 : event_bus_description 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 nonrec describe_event_bus_request = {
  1. name : event_bus_name_or_arn option;
    (*

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

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

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

    *)
  2. creation_time : timestamp option;
    (*

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

    *)
  3. state_reason : endpoint_state_reason 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 : endpoint_url option;
    (*

    The URL of the endpoint you asked for information about.

    *)
  6. endpoint_id : endpoint_id option;
    (*

    The ID of the endpoint you asked for information about.

    *)
  7. role_arn : iam_role_arn 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 : endpoint_arn option;
    (*

    The ARN of the endpoint you asked for information about.

    *)
  12. description : endpoint_description option;
    (*

    The description of the endpoint you asked for information about.

    *)
  13. name : endpoint_name option;
    (*

    The name of the endpoint you asked for information about.

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

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

    *)
  2. name : endpoint_name;
    (*

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

    *)
}
type nonrec describe_connection_resource_parameters = {
  1. resource_association_arn : resource_association_arn;
    (*

    For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.

    For more information, see Managing service network resource associations for connections in the Amazon EventBridge User Guide.

    *)
  2. resource_configuration_arn : resource_configuration_arn;
    (*

    The Amazon Resource Name (ARN) of the resource configuration for the private API.

    *)
}

The parameters for EventBridge to use when invoking the resource endpoint.

type nonrec describe_connection_connectivity_parameters = {
  1. resource_parameters : describe_connection_resource_parameters;
    (*

    The parameters for EventBridge to use when invoking the resource endpoint.

    *)
}

If the connection uses a private OAuth endpoint, the parameters for EventBridge to use when authenticating against the endpoint.

For more information, see Authorization methods for connections in the Amazon EventBridge User Guide.

type nonrec connection_basic_auth_response_parameters = {
  1. username : auth_header_parameters option;
    (*

    The user name to use for Basic authorization.

    *)
}

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

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

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

    *)
}

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

type nonrec 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 : https_endpoint option;
    (*

    The URL to the HTTP endpoint that authorized the request.

    *)
  4. client_parameters : connection_o_auth_client_response_parameters option;
    (*

    Details about the client parameters returned when OAuth is specified as the authorization type.

    *)
}

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

type nonrec connection_api_key_auth_response_parameters = {
  1. api_key_name : auth_header_parameters 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 nonrec connection_auth_response_parameters = {
  1. connectivity_parameters : describe_connection_connectivity_parameters option;
    (*

    For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint.

    For more information, see Authorization methods for connections in the Amazon EventBridge User Guide.

    *)
  2. invocation_http_parameters : connection_http_parameters option;
    (*

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

    *)
  3. api_key_auth_parameters : connection_api_key_auth_response_parameters option;
    (*

    The API Key parameters to use for authorization.

    *)
  4. o_auth_parameters : connection_o_auth_response_parameters option;
    (*

    The OAuth parameters to use for authorization.

    *)
  5. basic_auth_parameters : connection_basic_auth_response_parameters option;
    (*

    The authorization parameters for Basic authorization.

    *)
}

Tthe authorization parameters to use for the connection.

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

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

    *)
  2. last_modified_time : timestamp option;
    (*

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

    *)
  3. creation_time : timestamp 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. kms_key_identifier : kms_key_identifier option;
    (*

    The identifier of the KMS customer managed key for EventBridge to use to encrypt the connection, if one has been specified.

    For more information, see Encrypting connections in the Amazon EventBridge User Guide.

    *)
  6. secret_arn : secrets_manager_secret_arn option;
    (*

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

    *)
  7. authorization_type : connection_authorization_type option;
    (*

    The type of authorization specified for the connection.

    *)
  8. state_reason : connection_state_reason option;
    (*

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

    *)
  9. connection_state : connection_state option;
    (*

    The state of the connection retrieved.

    *)
  10. invocation_connectivity_parameters : describe_connection_connectivity_parameters option;
    (*

    For connections to private APIs The parameters EventBridge uses to invoke the resource endpoint.

    For more information, see Connecting to private APIs in the Amazon EventBridge User Guide.

    *)
  11. description : connection_description option;
    (*

    The description for the connection retrieved.

    *)
  12. name : connection_name option;
    (*

    The name of the connection retrieved.

    *)
  13. connection_arn : connection_arn option;
    (*

    The ARN of the connection retrieved.

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

    The name of the connection to retrieve.

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

    The time at which the archive was created.

    *)
  2. event_count : long option;
    (*

    The number of events in the archive.

    *)
  3. size_bytes : long option;
    (*

    The size of the archive in bytes.

    *)
  4. retention_days : retention_days option;
    (*

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

    *)
  5. kms_key_identifier : kms_key_identifier option;
    (*

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

    For more information, see Encrypting archives in the Amazon EventBridge User Guide.

    *)
  6. state_reason : archive_state_reason option;
    (*

    The reason that the archive is in the state.

    *)
  7. state : archive_state option;
    (*

    The state of the archive.

    *)
  8. event_pattern : event_pattern option;
    (*

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

    *)
  9. description : archive_description option;
    (*

    The description of the archive.

    *)
  10. event_source_arn : event_bus_arn option;
    (*

    The ARN of the event source associated with the archive.

    *)
  11. archive_name : archive_name option;
    (*

    The name of the archive.

    *)
  12. archive_arn : archive_arn option;
    (*

    The ARN of the archive.

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

    The name of the archive to retrieve.

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

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

    *)
  2. creation_time : timestamp option;
    (*

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

    *)
  3. invocation_rate_limit_per_second : api_destination_invocation_rate_limit_per_second 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 : https_endpoint option;
    (*

    The URL to use to connect to the HTTP endpoint.

    *)
  6. connection_arn : connection_arn 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 : api_destination_description option;
    (*

    The description for the API destination retrieved.

    *)
  9. name : api_destination_name option;
    (*

    The name of the API destination retrieved.

    *)
  10. api_destination_arn : api_destination_arn option;
    (*

    The ARN of the API destination retrieved.

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

    The name of the API destination to retrieve.

    *)
}
type nonrec delete_rule_request = {
  1. force : boolean_ 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 : event_bus_name_or_arn 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 : rule_name;
    (*

    The name of the rule.

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

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

    *)
  2. name : event_source_name;
    (*

    The name of the event source to delete.

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

    The name of the event bus to delete.

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

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

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

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

    *)
  2. last_modified_time : timestamp option;
    (*

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

    *)
  3. creation_time : timestamp 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 : connection_arn option;
    (*

    The ARN of the connection that was deleted.

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

    The name of the connection to delete.

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

    The name of the archive to delete.

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

    The name of the destination to delete.

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

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

    *)
  2. last_modified_time : timestamp option;
    (*

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

    *)
  3. creation_time : timestamp 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 : connection_arn option;
    (*

    The ARN of the connection that authorization was removed from.

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

    The name of the connection to remove authorization from.

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

    The name of the partner event source to deactivate.

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

    The ARN of the partner event source.

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

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

    *)
  2. name : event_source_name;
    (*

    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 nonrec create_event_bus_response = {
  1. dead_letter_config : dead_letter_config option;
  2. kms_key_identifier : kms_key_identifier 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 : event_bus_description option;
    (*

    The event bus description.

    *)
  4. event_bus_arn : string_ option;
    (*

    The ARN of the new event bus.

    *)
}
type nonrec 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 : kms_key_identifier 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 Identify and view keys in the Key Management Service Developer Guide.

    Schema discovery is 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/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 schema discovery enabled.

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

    If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.

    For more information, see Encrypting archives in the Amazon EventBridge User Guide.

    *)
  4. description : event_bus_description option;
    (*

    The event bus description.

    *)
  5. event_source_name : event_source_name 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 : event_bus_name;
    (*

    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 nonrec create_endpoint_response = {
  1. state : endpoint_state option;
    (*

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

    *)
  2. role_arn : iam_role_arn 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 : endpoint_arn option;
    (*

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

    *)
  7. name : endpoint_name option;
    (*

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

    *)
}
type nonrec create_endpoint_request = {
  1. role_arn : iam_role_arn 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 : endpoint_description option;
    (*

    A description of the global endpoint.

    *)
  6. name : endpoint_name;
    (*

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

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

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

    *)
  2. creation_time : timestamp 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 : connection_arn option;
    (*

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

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

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

    *)
  2. username : auth_header_parameters;
    (*

    The user name to use for Basic authorization.

    *)
}

Contains the Basic authorization parameters to use for the connection.

type nonrec create_connection_o_auth_client_request_parameters = {
  1. client_secret : auth_header_parameters_sensitive;
    (*

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

    *)
  2. client_i_d : auth_header_parameters;
    (*

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

    *)
}

The Basic authorization parameters to use for the connection.

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

    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 : https_endpoint;
    (*

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

    *)
  4. client_parameters : create_connection_o_auth_client_request_parameters;
    (*

    The client parameters for OAuth authorization.

    *)
}

Contains the OAuth authorization parameters to use for the connection.

type nonrec create_connection_api_key_auth_request_parameters = {
  1. api_key_value : auth_header_parameters_sensitive;
    (*

    The value for the API key to use for authorization.

    *)
  2. api_key_name : auth_header_parameters;
    (*

    The name of the API key to use for authorization.

    *)
}

The API key authorization parameters for the connection.

type nonrec create_connection_auth_request_parameters = {
  1. connectivity_parameters : connectivity_resource_parameters option;
    (*

    If you specify a private OAuth endpoint, the parameters for EventBridge to use when authenticating against the endpoint.

    For more information, see Authorization methods for connections in the Amazon EventBridge User Guide.

    *)
  2. invocation_http_parameters : connection_http_parameters option;
    (*

    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.

    *)
  3. api_key_auth_parameters : create_connection_api_key_auth_request_parameters option;
    (*

    The API key authorization parameters to use for the connection.

    *)
  4. o_auth_parameters : create_connection_o_auth_request_parameters option;
    (*

    The OAuth authorization parameters to use for the connection.

    *)
  5. basic_auth_parameters : create_connection_basic_auth_request_parameters option;
    (*

    The Basic authorization parameters to use for the connection.

    *)
}

The authorization parameters for the connection.

You must include only authorization parameters for the AuthorizationType you specify.

type nonrec create_connection_request = {
  1. kms_key_identifier : kms_key_identifier option;
    (*

    The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. 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 the connection.

    For more information, see Identify and view keys in the Key Management Service Developer Guide.

    *)
  2. invocation_connectivity_parameters : connectivity_resource_parameters option;
    (*

    For connections to private APIs, the parameters to use for invoking the API.

    For more information, see Connecting to private APIs in the Amazon EventBridge User Guide.

    *)
  3. auth_parameters : create_connection_auth_request_parameters;
    (*

    The authorization parameters to use to authorize with the endpoint.

    You must include only authorization parameters for the AuthorizationType you specify.

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

    *)
  5. description : connection_description option;
    (*

    A description for the connection to create.

    *)
  6. name : connection_name;
    (*

    The name for the connection to create.

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

    The time at which the archive was created.

    *)
  2. state_reason : archive_state_reason 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 : archive_arn option;
    (*

    The ARN of the archive that was created.

    *)
}
type nonrec create_archive_request = {
  1. kms_key_identifier : kms_key_identifier option;
    (*

    The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. 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 the archive.

    For more information, see Identify and view keys in the Key Management Service Developer Guide.

    If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.

    For more information, see Encrypting archives in the Amazon EventBridge User Guide.

    *)
  2. retention_days : retention_days option;
    (*

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

    *)
  3. event_pattern : event_pattern option;
    (*

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

    *)
  4. description : archive_description option;
    (*

    A description for the archive.

    *)
  5. event_source_arn : event_bus_arn;
    (*

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

    *)
  6. archive_name : archive_name;
    (*

    The name for the archive to create.

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

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

    *)
  2. creation_time : timestamp 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 : api_destination_arn option;
    (*

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

    *)
}
type nonrec create_api_destination_request = {
  1. invocation_rate_limit_per_second : api_destination_invocation_rate_limit_per_second 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 : https_endpoint;
    (*

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

    *)
  4. connection_arn : connection_arn;
    (*

    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 : api_destination_description option;
    (*

    A description for the API destination to create.

    *)
  6. name : api_destination_name;
    (*

    The name for the API destination to create.

    *)
}
type nonrec cancel_replay_response = {
  1. state_reason : replay_state_reason 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 : replay_arn option;
    (*

    The ARN of the replay to cancel.

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

    The name of the replay to cancel.

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

    The name of the partner event source to activate.

    *)
}