Module Smaws_Client_GlobalAccelerator.Types

type nonrec generic_string = string
type nonrec byoip_cidr_state =
  1. | FAILED_DEPROVISION
  2. | FAILED_WITHDRAW
  3. | FAILED_ADVERTISING
  4. | FAILED_PROVISION
  5. | DEPROVISIONED
  6. | PENDING_DEPROVISIONING
  7. | PENDING_WITHDRAWING
  8. | ADVERTISING
  9. | PENDING_ADVERTISING
  10. | READY
  11. | PENDING_PROVISIONING
type nonrec timestamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec byoip_cidr_event = {
  1. timestamp : timestamp option;
    (*

    A timestamp for when you make a status change for an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).

    *)
  2. message : generic_string option;
    (*

    A string that contains an Event message describing changes that you make in the status of an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).

    *)
}

A complex type that contains a Message and a Timestamp value for changes that you make in the status of an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).

type nonrec byoip_cidr_events = byoip_cidr_event list
type nonrec byoip_cidr = {
  1. events : byoip_cidr_events option;
    (*

    A history of status changes for an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).

    *)
  2. state : byoip_cidr_state option;
    (*

    The state of the address pool.

    *)
  3. cidr : generic_string option;
    (*

    The address range, in CIDR notation.

    For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

    *)
}

Information about an IP address range that is provisioned for use with your Amazon Web Services resources through bring your own IP address (BYOIP).

The following describes each BYOIP State that your IP address range can be in.

  • PENDING_PROVISIONING — You’ve submitted a request to provision an IP address range but it is not yet provisioned with Global Accelerator.
  • READY — The address range is provisioned with Global Accelerator and can be advertised.
  • PENDING_ADVERTISING — You’ve submitted a request for Global Accelerator to advertise an address range but it is not yet being advertised.
  • ADVERTISING — The address range is being advertised by Global Accelerator.
  • PENDING_WITHDRAWING — You’ve submitted a request to withdraw an address range from being advertised but it is still being advertised by Global Accelerator.
  • PENDING_DEPROVISIONING — You’ve submitted a request to deprovision an address range from Global Accelerator but it is still provisioned.
  • DEPROVISIONED — The address range is deprovisioned from Global Accelerator.
  • FAILED_PROVISION — The request to provision the address range from Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact Amazon Web Services support.
  • FAILED_ADVERTISING — The request for Global Accelerator to advertise the address range was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact Amazon Web Services support.
  • FAILED_WITHDRAW — The request to withdraw the address range from advertising by Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact Amazon Web Services support.
  • FAILED_DEPROVISION — The request to deprovision the address range from Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact Amazon Web Services support.
type nonrec withdraw_byoip_cidr_response = {
  1. byoip_cidr : byoip_cidr option;
    (*

    Information about the BYOIP address pool.

    *)
}
type nonrec withdraw_byoip_cidr_request = {
  1. cidr : generic_string;
    (*

    The address range, in CIDR notation.

    For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

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

An argument that you specified is invalid.

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

There was an internal error for Global Accelerator.

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

The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.

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

The CIDR that you specified was not found or is incorrect.

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

You don't have access permission.

type nonrec port_number = int
type nonrec port_range = {
  1. to_port : port_number option;
    (*

    The last port in the range of ports, inclusive.

    *)
  2. from_port : port_number option;
    (*

    The first port in the range of ports, inclusive.

    *)
}

A complex type for a range of ports for a listener.

type nonrec port_ranges = port_range list
type nonrec protocol =
  1. | UDP
  2. | TCP
type nonrec client_affinity =
  1. | SOURCE_IP
  2. | NONE
type nonrec listener = {
  1. client_affinity : client_affinity option;
    (*

    Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint.

    Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

    If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

    The default value is NONE.

    *)
  2. protocol : protocol option;
    (*

    The protocol for the connections from clients to the accelerator.

    *)
  3. port_ranges : port_ranges option;
    (*

    The list of port ranges for the connections from clients to the accelerator.

    *)
  4. listener_arn : generic_string option;
    (*

    The Amazon Resource Name (ARN) of the listener.

    *)
}

A complex type for a listener.

type nonrec update_listener_response = {
  1. listener : listener option;
    (*

    Information for the updated listener.

    *)
}
type nonrec update_listener_request = {
  1. client_affinity : client_affinity option;
    (*

    Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint.

    Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

    If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

    The default value is NONE.

    *)
  2. protocol : protocol option;
    (*

    The updated protocol for the connections from clients to the accelerator.

    *)
  3. port_ranges : port_ranges option;
    (*

    The updated list of port ranges for the connections from clients to the accelerator.

    *)
  4. listener_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the listener to update.

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

The listener that you specified doesn't exist.

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

Processing your request would cause you to exceed an Global Accelerator limit.

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

The port numbers that you specified are not valid numbers or are not unique for this accelerator.

type nonrec endpoint_weight = int
type nonrec health_state =
  1. | UNHEALTHY
  2. | HEALTHY
  3. | INITIAL
type nonrec generic_boolean = bool
type nonrec endpoint_description = {
  1. client_ip_preservation_enabled : generic_boolean option;
    (*

    Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for Application Load Balancers endpoints.

    If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the endpoint fronted by the accelerator.

    Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers, Amazon EC2 instances, and Network Load Balancers with security groups. IMPORTANT: You cannot use client IP address preservation with Network Load Balancers with TLS listeners.

    For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.

    *)
  2. health_reason : generic_string option;
    (*

    Returns a null result.

    *)
  3. health_state : health_state option;
    (*

    The health status of the endpoint.

    *)
  4. weight : endpoint_weight option;
    (*

    The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint weights in the Global Accelerator Developer Guide.

    *)
  5. endpoint_id : generic_string option;
    (*

    An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID.

    An Application Load Balancer can be either internal or internet-facing.

    *)
}

A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.

type nonrec endpoint_descriptions = endpoint_description list
type nonrec traffic_dial_percentage = float
type nonrec health_check_port = int
type nonrec health_check_protocol =
  1. | HTTPS
  2. | HTTP
  3. | TCP
type nonrec health_check_path = string
type nonrec health_check_interval_seconds = int
type nonrec threshold_count = int
type nonrec port_override = {
  1. endpoint_port : port_number option;
    (*

    The endpoint port that you want a listener port to be mapped to. This is the port on the endpoint, such as the Application Load Balancer or Amazon EC2 instance.

    *)
  2. listener_port : port_number option;
    (*

    The listener port that you want to map to a specific endpoint port. This is the port that user traffic arrives to the Global Accelerator on.

    *)
}

Override specific listener ports used to route traffic to endpoints that are part of an endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.

For more information, see Overriding listener ports in the Global Accelerator Developer Guide.

type nonrec port_overrides = port_override list
type nonrec endpoint_group = {
  1. port_overrides : port_overrides option;
    (*

    Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on.

    *)
  2. threshold_count : threshold_count option;
    (*

    The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

    *)
  3. health_check_interval_seconds : health_check_interval_seconds option;
    (*

    The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.

    *)
  4. health_check_path : health_check_path option;
    (*

    If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).

    *)
  5. health_check_protocol : health_check_protocol option;
    (*

    The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.

    *)
  6. health_check_port : health_check_port option;
    (*

    The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

    The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.

    *)
  7. traffic_dial_percentage : traffic_dial_percentage option;
    (*

    The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener.

    Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

    The default value is 100.

    *)
  8. endpoint_descriptions : endpoint_descriptions option;
    (*

    The list of endpoint objects.

    *)
  9. endpoint_group_region : generic_string option;
    (*

    The Amazon Web Services Region where the endpoint group is located.

    *)
  10. endpoint_group_arn : generic_string option;
    (*

    The Amazon Resource Name (ARN) of the endpoint group.

    *)
}

A complex type for the endpoint group. An Amazon Web Services Region can have only one endpoint group for a specific listener.

type nonrec update_endpoint_group_response = {
  1. endpoint_group : endpoint_group option;
    (*

    The information about the endpoint group that was updated.

    *)
}
type nonrec endpoint_configuration = {
  1. attachment_arn : generic_string option;
    (*

    The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.

    *)
  2. client_ip_preservation_enabled : generic_boolean option;
    (*

    Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for Application Load Balancer endpoints.

    If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the endpoint fronted by the accelerator.

    Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers, Amazon EC2 instances, and Network Load Balancers with security groups. IMPORTANT: You cannot use client IP address preservation with Network Load Balancers with TLS listeners.

    For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.

    *)
  3. weight : endpoint_weight option;
    (*

    The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint weights in the Global Accelerator Developer Guide.

    *)
  4. endpoint_id : generic_string option;
    (*

    An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. A resource must be valid and active when you add it as an endpoint.

    For cross-account endpoints, this must be the ARN of the resource.

    *)
}

A complex type for endpoints. A resource must be valid and active when you add it as an endpoint.

type nonrec endpoint_configurations = endpoint_configuration list
type nonrec update_endpoint_group_request = {
  1. port_overrides : port_overrides option;
    (*

    Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.

    For more information, see Overriding listener ports in the Global Accelerator Developer Guide.

    *)
  2. threshold_count : threshold_count option;
    (*

    The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

    *)
  3. health_check_interval_seconds : health_check_interval_seconds option;
    (*

    The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.

    *)
  4. health_check_path : health_check_path option;
    (*

    If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).

    *)
  5. health_check_protocol : health_check_protocol option;
    (*

    The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.

    *)
  6. health_check_port : health_check_port option;
    (*

    The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses the first port in the list.

    *)
  7. traffic_dial_percentage : traffic_dial_percentage option;
    (*

    The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener.

    Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

    The default value is 100.

    *)
  8. endpoint_configurations : endpoint_configurations option;
    (*

    The list of endpoint objects. A resource must be valid and active when you add it as an endpoint.

    *)
  9. endpoint_group_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the endpoint group.

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

The endpoint group that you specified doesn't exist.

type nonrec custom_routing_listener = {
  1. port_ranges : port_ranges option;
    (*

    The port range to support for connections from clients to your accelerator.

    Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators.

    *)
  2. listener_arn : generic_string option;
    (*

    The Amazon Resource Name (ARN) of the listener.

    *)
}

A complex type for a listener for a custom routing accelerator.

type nonrec update_custom_routing_listener_response = {
  1. listener : custom_routing_listener option;
    (*

    Information for the updated listener for a custom routing accelerator.

    *)
}
type nonrec update_custom_routing_listener_request = {
  1. port_ranges : port_ranges;
    (*

    The updated port range to support for connections from clients to your accelerator. If you remove ports that are currently being used by a subnet endpoint, the call fails.

    Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators.

    *)
  2. listener_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the listener to update.

    *)
}
type nonrec ip_address_type =
  1. | DUAL_STACK
  2. | IPV4
type nonrec ip_address = string
type nonrec ip_addresses = ip_address list
type nonrec ip_address_family =
  1. | IPv6
  2. | IPv4
type nonrec ip_set = {
  1. ip_address_family : ip_address_family option;
    (*

    The types of IP addresses included in this IP set.

    *)
  2. ip_addresses : ip_addresses option;
    (*

    The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.

    *)
  3. ip_family : generic_string option;
    (*

    IpFamily is deprecated and has been replaced by IpAddressFamily.

    *)
}

A complex type for the set of IP addresses for an accelerator.

type nonrec ip_sets = ip_set list
type nonrec custom_routing_accelerator_status =
  1. | IN_PROGRESS
  2. | DEPLOYED
type nonrec custom_routing_accelerator = {
  1. last_modified_time : timestamp option;
    (*

    The date and time that the accelerator was last modified.

    *)
  2. created_time : timestamp option;
    (*

    The date and time that the accelerator was created.

    *)
  3. status : custom_routing_accelerator_status option;
    (*

    Describes the deployment status of the accelerator.

    *)
  4. dns_name : generic_string option;
    (*

    The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.

    The naming convention for the DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.

    If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses.

    For more information about the default DNS name, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.

    *)
  5. ip_sets : ip_sets option;
    (*

    The static IP addresses that Global Accelerator associates with the accelerator.

    *)
  6. enabled : generic_boolean option;
    (*

    Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

    If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

    *)
  7. ip_address_type : ip_address_type option;
    (*

    The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

    *)
  8. name : generic_string option;
    (*

    The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

    *)
  9. accelerator_arn : generic_string option;
    (*

    The Amazon Resource Name (ARN) of the custom routing accelerator.

    *)
}

Attributes of a custom routing accelerator.

type nonrec update_custom_routing_accelerator_response = {
  1. accelerator : custom_routing_accelerator option;
    (*

    Information about the updated custom routing accelerator.

    *)
}
type nonrec update_custom_routing_accelerator_request = {
  1. enabled : generic_boolean option;
    (*

    Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

    If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.

    *)
  2. ip_addresses : ip_addresses option;
    (*

    The IP addresses for an accelerator.

    *)
  3. ip_address_type : ip_address_type option;
    (*

    The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

    *)
  4. name : generic_string option;
    (*

    The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.

    *)
  5. accelerator_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the accelerator to update.

    *)
}
type nonrec custom_routing_accelerator_attributes = {
  1. flow_logs_s3_prefix : generic_string option;
    (*

    The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true.

    If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:

    DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id

    *)
  2. flow_logs_s3_bucket : generic_string option;
    (*

    The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the bucket.

    *)
  3. flow_logs_enabled : generic_boolean option;
    (*

    Indicates whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.

    For more information, see Flow logs in the Global Accelerator Developer Guide.

    *)
}

Attributes of a custom routing accelerator.

type nonrec update_custom_routing_accelerator_attributes_response = {
  1. accelerator_attributes : custom_routing_accelerator_attributes option;
    (*

    Updated custom routing accelerator.

    *)
}
type nonrec update_custom_routing_accelerator_attributes_request = {
  1. flow_logs_s3_prefix : generic_string option;
    (*

    Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true.

    If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:

    DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id

    *)
  2. flow_logs_s3_bucket : generic_string option;
    (*

    The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the bucket.

    *)
  3. flow_logs_enabled : generic_boolean option;
    (*

    Update whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.

    For more information, see Flow logs in the Global Accelerator Developer Guide.

    *)
  4. accelerator_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the custom routing accelerator to update attributes for.

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

There's already a transaction in progress. Another transaction can't be processed.

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

The accelerator that you specified doesn't exist.

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

You can't use both of those options.

type nonrec attachment_name = string
type nonrec principal = string
type nonrec principals = principal list
type nonrec resource = {
  1. region : generic_string option;
    (*

    The Amazon Web Services Region where a shared endpoint resource is located.

    *)
  2. cidr : generic_string option;
    (*

    An IP address range, in CIDR format, that is specified as resource. The address must be provisioned and advertised in Global Accelerator by following the bring your own IP address (BYOIP) process for Global Accelerator

    For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

    *)
  3. endpoint_id : generic_string option;
    (*

    The endpoint ID for the endpoint that is specified as a Amazon Web Services resource.

    An endpoint ID for the cross-account feature is the ARN of an Amazon Web Services resource, such as a Network Load Balancer, that Global Accelerator supports as an endpoint for an accelerator.

    *)
}

A resource is one of the following: the ARN for an Amazon Web Services resource that is supported by Global Accelerator to be added as an endpoint, or a CIDR range that specifies a bring your own IP (BYOIP) address pool.

type nonrec resources = resource list
type nonrec attachment = {
  1. created_time : timestamp option;
    (*

    The date and time that the cross-account attachment was created.

    *)
  2. last_modified_time : timestamp option;
    (*

    The date and time that the cross-account attachment was last modified.

    *)
  3. resources : resources option;
    (*

    The resources included in the cross-account attachment.

    *)
  4. principals : principals option;
    (*

    The principals included in the cross-account attachment.

    *)
  5. name : attachment_name option;
    (*

    The name of the cross-account attachment.

    *)
  6. attachment_arn : generic_string option;
    (*

    The Amazon Resource Name (ARN) of the cross-account attachment.

    *)
}

A cross-account attachment in Global Accelerator. A cross-account attachment specifies the principals who have permission to work with resources in your account, which you also list in the attachment.

type nonrec update_cross_account_attachment_response = {
  1. cross_account_attachment : attachment option;
    (*

    Information about the updated cross-account attachment.

    *)
}
type nonrec update_cross_account_attachment_request = {
  1. remove_resources : resources option;
    (*

    The resources to remove from the cross-account attachment. A resource listed in a cross-account attachment can be used with an accelerator by the principals that are listed in the attachment.

    To remove more than one resource, separate the resource ARNs with commas.

    *)
  2. add_resources : resources option;
    (*

    The resources to add to the cross-account attachment. A resource listed in a cross-account attachment can be used with an accelerator by the principals that are listed in the attachment.

    To add more than one resource, separate the resource ARNs with commas.

    *)
  3. remove_principals : principals option;
    (*

    The principals to remove from the cross-account attachment. A principal is an account or the Amazon Resource Name (ARN) of an accelerator that the attachment gives permission to work with resources from another account. The resources are also listed in the attachment.

    To remove more than one principal, separate the account numbers or accelerator ARNs, or both, with commas.

    *)
  4. add_principals : principals option;
    (*

    The principals to add to the cross-account attachment. A principal is an account or the Amazon Resource Name (ARN) of an accelerator that the attachment gives permission to work with resources from another account. The resources are also listed in the attachment.

    To add more than one principal, separate the account numbers or accelerator ARNs, or both, with commas.

    *)
  5. name : attachment_name option;
    (*

    The name of the cross-account attachment.

    *)
  6. attachment_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the cross-account attachment to update.

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

No cross-account attachment was found.

type nonrec accelerator_status =
  1. | IN_PROGRESS
  2. | DEPLOYED
type nonrec accelerator_event = {
  1. timestamp : timestamp option;
    (*

    A timestamp for when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.

    *)
  2. message : generic_string option;
    (*

    A string that contains an Event message describing changes or errors when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.

    *)
}

A complex type that contains a Timestamp value and Message for changes that you make to an accelerator in Global Accelerator. Messages stored here provide progress or error information when you update an accelerator from IPv4 to dual-stack, or from dual-stack to IPv4. Global Accelerator stores a maximum of ten event messages.

type nonrec accelerator_events = accelerator_event list
type nonrec accelerator = {
  1. events : accelerator_events option;
    (*

    A history of changes that you make to an accelerator in Global Accelerator.

    *)
  2. dual_stack_dns_name : generic_string option;
    (*

    The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses.

    The naming convention for the dual-stack DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .dualstack.awsglobalaccelerator.com. For example: a1234567890abcdef.dualstack.awsglobalaccelerator.com.

    Note: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points just to the static IPv4 addresses.

    For more information, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.

    *)
  3. last_modified_time : timestamp option;
    (*

    The date and time that the accelerator was last modified.

    *)
  4. created_time : timestamp option;
    (*

    The date and time that the accelerator was created.

    *)
  5. status : accelerator_status option;
    (*

    Describes the deployment status of the accelerator.

    *)
  6. dns_name : generic_string option;
    (*

    The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.

    The naming convention for the DNS name for an accelerator is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.

    If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses.

    For more information about the default DNS name, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.

    *)
  7. ip_sets : ip_sets option;
    (*

    The static IP addresses that Global Accelerator associates with the accelerator.

    *)
  8. enabled : generic_boolean option;
    (*

    Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

    If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

    *)
  9. ip_address_type : ip_address_type option;
    (*

    The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

    *)
  10. name : generic_string option;
    (*

    The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

    *)
  11. accelerator_arn : generic_string option;
    (*

    The Amazon Resource Name (ARN) of the accelerator.

    *)
}

An accelerator is a complex type that includes one or more listeners that process inbound connections and then direct traffic to one or more endpoint groups, each of which includes endpoints, such as load balancers.

type nonrec update_accelerator_response = {
  1. accelerator : accelerator option;
    (*

    Information about the updated accelerator.

    *)
}
type nonrec update_accelerator_request = {
  1. enabled : generic_boolean option;
    (*

    Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

    If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.

    *)
  2. ip_addresses : ip_addresses option;
    (*

    The IP addresses for an accelerator.

    *)
  3. ip_address_type : ip_address_type option;
    (*

    The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

    *)
  4. name : generic_string option;
    (*

    The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.

    *)
  5. accelerator_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the accelerator to update.

    *)
}
type nonrec accelerator_attributes = {
  1. flow_logs_s3_prefix : generic_string option;
    (*

    The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true.

    If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:

    s3-bucket_name//AWSLogs/aws_account_id

    *)
  2. flow_logs_s3_bucket : generic_string option;
    (*

    The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the bucket.

    *)
  3. flow_logs_enabled : generic_boolean option;
    (*

    Indicates whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.

    For more information, see Flow logs in the Global Accelerator Developer Guide.

    *)
}

Attributes of an accelerator.

type nonrec update_accelerator_attributes_response = {
  1. accelerator_attributes : accelerator_attributes option;
    (*

    Updated attributes for the accelerator.

    *)
}
type nonrec update_accelerator_attributes_request = {
  1. flow_logs_s3_prefix : generic_string option;
    (*

    Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true.

    If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:

    s3-bucket_name//AWSLogs/aws_account_id

    *)
  2. flow_logs_s3_bucket : generic_string option;
    (*

    The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the bucket.

    *)
  3. flow_logs_enabled : generic_boolean option;
    (*

    Update whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.

    For more information, see Flow Logs in the Global Accelerator Developer Guide.

    *)
  4. accelerator_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the accelerator that you want to update.

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

    The tag key pairs that you want to remove from the specified resources.

    *)
  2. resource_arn : resource_arn;
    (*

    The Amazon Resource Name (ARN) of the Global Accelerator resource to remove tags from. An ARN uniquely identifies a resource.

    *)
}
type nonrec tag_value = string
type nonrec tag = {
  1. value : tag_value;
    (*

    A string that contains a Tag value.

    *)
  2. key : tag_key;
    (*

    A string that contains a Tag key.

    *)
}

A complex type that contains a Tag key and Tag value.

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

    The tags to add to a resource. A tag consists of a key and a value that you define.

    *)
  2. resource_arn : resource_arn;
    (*

    The Amazon Resource Name (ARN) of the Global Accelerator resource to add tags to. An ARN uniquely identifies a resource.

    *)
}
type nonrec socket_address = {
  1. port : port_number option;
    (*

    The port for the socket address.

    *)
  2. ip_address : generic_string option;
    (*

    The IP address for the socket address.

    *)
}

An IP address/port combination.

type nonrec socket_addresses = socket_address list
type nonrec endpoint_identifier = {
  1. client_ip_preservation_enabled : generic_boolean option;
    (*

    Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false.

    If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the endpoint fronted by the accelerator.

    *)
  2. endpoint_id : generic_string;
    (*

    An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID.

    An Application Load Balancer can be either internal or internet-facing.

    *)
}

A complex type for an endpoint. Specifies information about the endpoint to remove from the endpoint group.

type nonrec endpoint_identifiers = endpoint_identifier list
type nonrec remove_endpoints_request = {
  1. endpoint_group_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the endpoint group.

    *)
  2. endpoint_identifiers : endpoint_identifiers;
    (*

    The identifiers of the endpoints that you want to remove.

    *)
}
type nonrec endpoint_ids = generic_string list
type nonrec remove_custom_routing_endpoints_request = {
  1. endpoint_group_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the endpoint group to remove endpoints from.

    *)
  2. endpoint_ids : endpoint_ids;
    (*

    The IDs for the endpoints. For custom routing accelerators, endpoint IDs are the virtual private cloud (VPC) subnet IDs.

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

The endpoint that you specified doesn't exist.

type nonrec provision_byoip_cidr_response = {
  1. byoip_cidr : byoip_cidr option;
    (*

    Information about the address range.

    *)
}
type nonrec cidr_authorization_context = {
  1. signature : generic_string;
    (*

    The signed authorization message for the prefix and account.

    *)
  2. message : generic_string;
    (*

    The plain-text authorization message for the prefix and account.

    *)
}

Provides authorization for Amazon to bring a specific IP address range to a specific Amazon Web Services account using bring your own IP addresses (BYOIP).

For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

type nonrec provision_byoip_cidr_request = {
  1. cidr_authorization_context : cidr_authorization_context;
    (*

    A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.

    *)
  2. cidr : generic_string;
    (*

    The public IPv4 address range, in CIDR notation. The most specific IP prefix that you can specify is /24. The address range cannot overlap with another address range that you've brought to this Amazon Web Services Region or another Region.

    For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

    *)
}
type nonrec protocols = protocol list
type nonrec port_mappings_max_results = int
type nonrec custom_routing_protocol =
  1. | UDP
  2. | TCP
type nonrec custom_routing_protocols = custom_routing_protocol list
type nonrec custom_routing_destination_traffic_state =
  1. | DENY
  2. | ALLOW
type nonrec port_mapping = {
  1. destination_traffic_state : custom_routing_destination_traffic_state option;
    (*

    Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.

    *)
  2. protocols : custom_routing_protocols option;
    (*

    The protocols supported by the endpoint group.

    *)
  3. destination_socket_address : socket_address option;
    (*

    The EC2 instance IP address and port number in the virtual private cloud (VPC) subnet.

    *)
  4. endpoint_id : generic_string option;
    (*

    The IP address of the VPC subnet (the subnet ID).

    *)
  5. endpoint_group_arn : generic_string option;
    (*

    The Amazon Resource Name (ARN) of the endpoint group.

    *)
  6. accelerator_port : port_number option;
    (*

    The accelerator port.

    *)
}

Returns the ports and associated IP addresses and ports of Amazon EC2 instances in your virtual private cloud (VPC) subnets. Custom routing is a port mapping protocol in Global Accelerator that statically associates port ranges with VPC subnets, which allows Global Accelerator to route to specific instances and ports within one or more subnets.

type nonrec port_mappings = port_mapping list
type nonrec max_results = int
type nonrec listeners = listener list
type nonrec list_tags_for_resource_response = {
  1. tags : tags option;
    (*

    Root level tag for the Tags parameters.

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

    The Amazon Resource Name (ARN) of the accelerator to list tags for. An ARN uniquely identifies an accelerator.

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

    The token for the next set of results. You receive this token from a previous call.

    *)
  2. listeners : listeners option;
    (*

    The list of listeners for an accelerator.

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

    The token for the next set of results. You receive this token from a previous call.

    *)
  2. max_results : max_results option;
    (*

    The number of listener objects that you want to return with this call. The default value is 10.

    *)
  3. accelerator_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the accelerator for which you want to list listener objects.

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

There isn't another item to return.

type nonrec endpoint_groups = endpoint_group list
type nonrec list_endpoint_groups_response = {
  1. next_token : generic_string option;
    (*

    The token for the next set of results. You receive this token from a previous call.

    *)
  2. endpoint_groups : endpoint_groups option;
    (*

    The list of the endpoint groups associated with a listener.

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

    The token for the next set of results. You receive this token from a previous call.

    *)
  2. max_results : max_results option;
    (*

    The number of endpoint group objects that you want to return with this call. The default value is 10.

    *)
  3. listener_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the listener.

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

    The token for the next set of results. You receive this token from a previous call.

    *)
  2. port_mappings : port_mappings option;
    (*

    The port mappings for a custom routing accelerator.

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

    The token for the next set of results. You receive this token from a previous call.

    *)
  2. max_results : port_mappings_max_results option;
    (*

    The number of destination port mappings that you want to return with this call. The default value is 10.

    *)
  3. endpoint_group_arn : generic_string option;
    (*

    The Amazon Resource Name (ARN) of the endpoint group to list the custom routing port mappings for.

    *)
  4. accelerator_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the accelerator to list the custom routing port mappings for.

    *)
}
type nonrec destination_port_mapping = {
  1. destination_traffic_state : custom_routing_destination_traffic_state option;
    (*

    Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.

    *)
  2. ip_address_type : ip_address_type option;
    (*

    The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

    *)
  3. destination_socket_address : socket_address option;
    (*

    The endpoint IP address/port combination for traffic received on the accelerator socket address.

    *)
  4. endpoint_group_region : generic_string option;
    (*

    The Amazon Web Services Region for the endpoint group.

    *)
  5. endpoint_id : generic_string option;
    (*

    The ID for the virtual private cloud (VPC) subnet.

    *)
  6. endpoint_group_arn : generic_string option;
    (*

    The Amazon Resource Name (ARN) of the endpoint group.

    *)
  7. accelerator_socket_addresses : socket_addresses option;
    (*

    The IP address/port combinations (sockets) that map to a given destination socket address.

    *)
  8. accelerator_arn : generic_string option;
    (*

    The Amazon Resource Name (ARN) of the custom routing accelerator that you have port mappings for.

    *)
}

The port mappings for a specified endpoint IP address (destination).

type nonrec destination_port_mappings = destination_port_mapping list
type nonrec list_custom_routing_port_mappings_by_destination_response = {
  1. next_token : generic_string option;
    (*

    The token for the next set of results. You receive this token from a previous call.

    *)
  2. destination_port_mappings : destination_port_mappings option;
    (*

    The port mappings for the endpoint IP address that you specified in the request.

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

    The token for the next set of results. You receive this token from a previous call.

    *)
  2. max_results : port_mappings_max_results option;
    (*

    The number of destination port mappings that you want to return with this call. The default value is 10.

    *)
  3. destination_address : generic_string;
    (*

    The endpoint IP address in a virtual private cloud (VPC) subnet for which you want to receive back port mappings.

    *)
  4. endpoint_id : generic_string;
    (*

    The ID for the virtual private cloud (VPC) subnet.

    *)
}
type nonrec custom_routing_listeners = custom_routing_listener list
type nonrec list_custom_routing_listeners_response = {
  1. next_token : generic_string option;
    (*

    The token for the next set of results. You receive this token from a previous call.

    *)
  2. listeners : custom_routing_listeners option;
    (*

    The list of listeners for a custom routing accelerator.

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

    The token for the next set of results. You receive this token from a previous call.

    *)
  2. max_results : max_results option;
    (*

    The number of listener objects that you want to return with this call. The default value is 10.

    *)
  3. accelerator_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the accelerator to list listeners for.

    *)
}
type nonrec custom_routing_destination_description = {
  1. protocols : protocols option;
    (*

    The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP.

    *)
  2. to_port : port_number option;
    (*

    The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

    *)
  3. from_port : port_number option;
    (*

    The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

    *)
}

For a custom routing accelerator, describes the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.

type nonrec custom_routing_destination_descriptions = custom_routing_destination_description list
type nonrec custom_routing_endpoint_description = {
  1. endpoint_id : generic_string option;
    (*

    An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.

    *)
}

A complex type for an endpoint for a custom routing accelerator. Each endpoint group can include one or more endpoints, which are virtual private cloud (VPC) subnets.

type nonrec custom_routing_endpoint_descriptions = custom_routing_endpoint_description list
type nonrec custom_routing_endpoint_group = {
  1. endpoint_descriptions : custom_routing_endpoint_descriptions option;
    (*

    For a custom routing accelerator, describes the endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.

    *)
  2. destination_descriptions : custom_routing_destination_descriptions option;
    (*

    For a custom routing accelerator, describes the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.

    *)
  3. endpoint_group_region : generic_string option;
    (*

    The Amazon Web Services Region where the endpoint group is located.

    *)
  4. endpoint_group_arn : generic_string option;
    (*

    The Amazon Resource Name (ARN) of the endpoint group.

    *)
}

A complex type for the endpoint group for a custom routing accelerator. An Amazon Web Services Region can have only one endpoint group for a specific listener.

type nonrec custom_routing_endpoint_groups = custom_routing_endpoint_group list
type nonrec list_custom_routing_endpoint_groups_response = {
  1. next_token : generic_string option;
    (*

    The token for the next set of results. You receive this token from a previous call.

    *)
  2. endpoint_groups : custom_routing_endpoint_groups option;
    (*

    The list of the endpoint groups associated with a listener for a custom routing accelerator.

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

    The token for the next set of results. You receive this token from a previous call.

    *)
  2. max_results : max_results option;
    (*

    The number of endpoint group objects that you want to return with this call. The default value is 10.

    *)
  3. listener_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the listener to list endpoint groups for.

    *)
}
type nonrec custom_routing_accelerators = custom_routing_accelerator list
type nonrec list_custom_routing_accelerators_response = {
  1. next_token : generic_string option;
    (*

    The token for the next set of results. You receive this token from a previous call.

    *)
  2. accelerators : custom_routing_accelerators option;
    (*

    The list of custom routing accelerators for a customer account.

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

    The token for the next set of results. You receive this token from a previous call.

    *)
  2. max_results : max_results option;
    (*

    The number of custom routing Global Accelerator objects that you want to return with this call. The default value is 10.

    *)
}
type nonrec cross_account_resource = {
  1. attachment_arn : generic_string option;
    (*

    The Amazon Resource Name (ARN) of the cross-account attachment that specifies the resources (endpoints or CIDR range) that can be added to accelerators and principals that have permission to add them.

    *)
  2. cidr : generic_string option;
    (*

    An IP address range, in CIDR format, that is specified as an Amazon Web Services resource. The address must be provisioned and advertised in Global Accelerator by following the bring your own IP address (BYOIP) process for Global Accelerator.

    For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

    *)
  3. endpoint_id : generic_string option;
    (*

    The endpoint ID for the endpoint that is listed in a cross-account attachment and can be added to an accelerator by specified principals.

    *)
}

An endpoint (Amazon Web Services resource) or an IP address range, in CIDR format, that is listed in a cross-account attachment. A cross-account resource can be added to an accelerator by specified principals, which are also listed in the attachment.

For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.

type nonrec cross_account_resources = cross_account_resource list
type nonrec list_cross_account_resources_response = {
  1. next_token : generic_string option;
    (*

    The token for the next set of results. You receive this token from a previous call.

    *)
  2. cross_account_resources : cross_account_resources option;
    (*

    The cross-account resources used with an accelerator.

    *)
}
type nonrec aws_account_id = string
type nonrec list_cross_account_resources_request = {
  1. next_token : generic_string option;
    (*

    The token for the next set of results. You receive this token from a previous call.

    *)
  2. max_results : max_results option;
    (*

    The number of cross-account resource objects that you want to return with this call. The default value is 10.

    *)
  3. resource_owner_aws_account_id : aws_account_id;
    (*

    The account ID of a resource owner in a cross-account attachment.

    *)
  4. accelerator_arn : generic_string option;
    (*

    The Amazon Resource Name (ARN) of an accelerator in a cross-account attachment.

    *)
}
type nonrec aws_account_ids = aws_account_id list
type nonrec list_cross_account_resource_accounts_response = {
  1. resource_owner_aws_account_ids : aws_account_ids option;
    (*

    The account IDs of principals (resource owners) in a cross-account attachment who can work with resources listed in the same attachment.

    *)
}
type nonrec list_cross_account_resource_accounts_request = unit
type nonrec attachments = attachment list
type nonrec list_cross_account_attachments_response = {
  1. next_token : generic_string option;
    (*

    The token for the next set of results. You receive this token from a previous call.

    *)
  2. cross_account_attachments : attachments option;
    (*

    Information about the cross-account attachments.

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

    The token for the next set of results. You receive this token from a previous call.

    *)
  2. max_results : max_results option;
    (*

    The number of cross-account attachment objects that you want to return with this call. The default value is 10.

    *)
}
type nonrec byoip_cidrs = byoip_cidr list
type nonrec list_byoip_cidrs_response = {
  1. next_token : generic_string option;
    (*

    The token for the next page of results.

    *)
  2. byoip_cidrs : byoip_cidrs option;
    (*

    Information about your address ranges.

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

    The token for the next page of results.

    *)
  2. max_results : max_results option;
    (*

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    *)
}
type nonrec accelerators = accelerator list
type nonrec list_accelerators_response = {
  1. next_token : generic_string option;
    (*

    The token for the next set of results. You receive this token from a previous call.

    *)
  2. accelerators : accelerators option;
    (*

    The list of accelerators for a customer account.

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

    The token for the next set of results. You receive this token from a previous call.

    *)
  2. max_results : max_results option;
    (*

    The number of Global Accelerator objects that you want to return with this call. The default value is 10.

    *)
}
type nonrec idempotency_token = string
type nonrec describe_listener_response = {
  1. listener : listener option;
    (*

    The description of a listener.

    *)
}
type nonrec describe_listener_request = {
  1. listener_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the listener to describe.

    *)
}
type nonrec describe_endpoint_group_response = {
  1. endpoint_group : endpoint_group option;
    (*

    The description of an endpoint group.

    *)
}
type nonrec describe_endpoint_group_request = {
  1. endpoint_group_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the endpoint group to describe.

    *)
}
type nonrec describe_custom_routing_listener_response = {
  1. listener : custom_routing_listener option;
    (*

    The description of a listener for a custom routing accelerator.

    *)
}
type nonrec describe_custom_routing_listener_request = {
  1. listener_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the listener to describe.

    *)
}
type nonrec describe_custom_routing_endpoint_group_response = {
  1. endpoint_group : custom_routing_endpoint_group option;
    (*

    The description of an endpoint group for a custom routing accelerator.

    *)
}
type nonrec describe_custom_routing_endpoint_group_request = {
  1. endpoint_group_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the endpoint group to describe.

    *)
}
type nonrec describe_custom_routing_accelerator_attributes_response = {
  1. accelerator_attributes : custom_routing_accelerator_attributes option;
    (*

    The attributes of the custom routing accelerator.

    *)
}
type nonrec describe_custom_routing_accelerator_attributes_request = {
  1. accelerator_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the custom routing accelerator to describe the attributes for.

    *)
}
type nonrec describe_custom_routing_accelerator_response = {
  1. accelerator : custom_routing_accelerator option;
    (*

    The description of the custom routing accelerator.

    *)
}
type nonrec describe_custom_routing_accelerator_request = {
  1. accelerator_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the accelerator to describe.

    *)
}
type nonrec describe_cross_account_attachment_response = {
  1. cross_account_attachment : attachment option;
    (*

    Information about the cross-account attachment.

    *)
}
type nonrec describe_cross_account_attachment_request = {
  1. attachment_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) for the cross-account attachment to describe.

    *)
}
type nonrec describe_accelerator_attributes_response = {
  1. accelerator_attributes : accelerator_attributes option;
    (*

    The attributes of the accelerator.

    *)
}
type nonrec describe_accelerator_attributes_request = {
  1. accelerator_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the accelerator with the attributes that you want to describe.

    *)
}
type nonrec describe_accelerator_response = {
  1. accelerator : accelerator option;
    (*

    The description of the accelerator.

    *)
}
type nonrec describe_accelerator_request = {
  1. accelerator_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the accelerator to describe.

    *)
}
type nonrec deprovision_byoip_cidr_response = {
  1. byoip_cidr : byoip_cidr option;
    (*

    Information about the address range.

    *)
}
type nonrec deprovision_byoip_cidr_request = {
  1. cidr : generic_string;
    (*

    The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.

    For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

    *)
}
type nonrec destination_addresses = ip_address list
type nonrec destination_ports = port_number list
type nonrec deny_custom_routing_traffic_request = {
  1. deny_all_traffic_to_endpoint : generic_boolean option;
    (*

    Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint cannot receive traffic from a custom routing accelerator. The value is TRUE or FALSE.

    When set to TRUE, no destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE.

    When set to FALSE (or not specified), you must specify a list of destination IP addresses that cannot receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group.

    The default value is FALSE.

    *)
  2. destination_ports : destination_ports option;
    (*

    A list of specific Amazon EC2 instance ports (destination ports) in a subnet endpoint that you want to prevent from receiving traffic.

    *)
  3. destination_addresses : destination_addresses option;
    (*

    A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to prevent from receiving traffic. The IP addresses must be a subset of the IP addresses allowed for the VPC subnet associated with the endpoint group.

    *)
  4. endpoint_id : generic_string;
    (*

    An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.

    *)
  5. endpoint_group_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the endpoint group.

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

The listener that you specified has an endpoint group associated with it. You must remove all dependent resources from a listener before you can delete it.

type nonrec delete_listener_request = {
  1. listener_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the listener.

    *)
}
type nonrec delete_endpoint_group_request = {
  1. endpoint_group_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the endpoint group to delete.

    *)
}
type nonrec delete_custom_routing_listener_request = {
  1. listener_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the listener to delete.

    *)
}
type nonrec delete_custom_routing_endpoint_group_request = {
  1. endpoint_group_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the endpoint group to delete.

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

The accelerator that you specified has a listener associated with it. You must remove all dependent resources from an accelerator before you can delete it.

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

The accelerator that you specified could not be disabled.

type nonrec delete_custom_routing_accelerator_request = {
  1. accelerator_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the custom routing accelerator to delete.

    *)
}
type nonrec delete_cross_account_attachment_request = {
  1. attachment_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) for the cross-account attachment to delete.

    *)
}
type nonrec delete_accelerator_request = {
  1. accelerator_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of an accelerator.

    *)
}
type nonrec create_listener_response = {
  1. listener : listener option;
    (*

    The listener that you've created.

    *)
}
type nonrec create_listener_request = {
  1. idempotency_token : idempotency_token;
    (*

    A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

    *)
  2. client_affinity : client_affinity option;
    (*

    Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint.

    Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

    If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

    The default value is NONE.

    *)
  3. protocol : protocol;
    (*

    The protocol for connections from clients to your accelerator.

    *)
  4. port_ranges : port_ranges;
    (*

    The list of port ranges to support for connections from clients to your accelerator.

    *)
  5. accelerator_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of your accelerator.

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

The endpoint group that you specified already exists.

type nonrec create_endpoint_group_response = {
  1. endpoint_group : endpoint_group option;
    (*

    The information about the endpoint group that was created.

    *)
}
type nonrec create_endpoint_group_request = {
  1. port_overrides : port_overrides option;
    (*

    Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.

    For more information, see Overriding listener ports in the Global Accelerator Developer Guide.

    *)
  2. idempotency_token : idempotency_token;
    (*

    A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

    *)
  3. threshold_count : threshold_count option;
    (*

    The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

    *)
  4. health_check_interval_seconds : health_check_interval_seconds option;
    (*

    The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.

    *)
  5. health_check_path : health_check_path option;
    (*

    If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).

    *)
  6. health_check_protocol : health_check_protocol option;
    (*

    The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.

    *)
  7. health_check_port : health_check_port option;
    (*

    The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list.

    *)
  8. traffic_dial_percentage : traffic_dial_percentage option;
    (*

    The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener.

    Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

    The default value is 100.

    *)
  9. endpoint_configurations : endpoint_configurations option;
    (*

    The list of endpoint objects.

    *)
  10. endpoint_group_region : generic_string;
    (*

    The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.

    *)
  11. listener_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the listener.

    *)
}
type nonrec create_custom_routing_listener_response = {
  1. listener : custom_routing_listener option;
    (*

    The listener that you've created for a custom routing accelerator.

    *)
}
type nonrec create_custom_routing_listener_request = {
  1. idempotency_token : idempotency_token;
    (*

    A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

    *)
  2. port_ranges : port_ranges;
    (*

    The port range to support for connections from clients to your accelerator.

    Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators.

    *)
  3. accelerator_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the accelerator for a custom routing listener.

    *)
}
type nonrec create_custom_routing_endpoint_group_response = {
  1. endpoint_group : custom_routing_endpoint_group option;
    (*

    The information about the endpoint group created for a custom routing accelerator.

    *)
}
type nonrec custom_routing_destination_configuration = {
  1. protocols : custom_routing_protocols;
    (*

    The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP.

    *)
  2. to_port : port_number;
    (*

    The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

    *)
  3. from_port : port_number;
    (*

    The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

    *)
}

For a custom routing accelerator, sets the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.

type nonrec custom_routing_destination_configurations = custom_routing_destination_configuration list
type nonrec create_custom_routing_endpoint_group_request = {
  1. idempotency_token : idempotency_token;
    (*

    A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

    *)
  2. destination_configurations : custom_routing_destination_configurations;
    (*

    Sets the port range and protocol for all endpoints (virtual private cloud subnets) in a custom routing endpoint group to accept client traffic on.

    *)
  3. endpoint_group_region : generic_string;
    (*

    The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.

    *)
  4. listener_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the listener for a custom routing endpoint.

    *)
}
type nonrec create_custom_routing_accelerator_response = {
  1. accelerator : custom_routing_accelerator option;
    (*

    The accelerator that is created.

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

    Create tags for an accelerator.

    For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.

    *)
  2. idempotency_token : idempotency_token;
    (*

    A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

    *)
  3. enabled : generic_boolean option;
    (*

    Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

    If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.

    *)
  4. ip_addresses : ip_addresses option;
    (*

    Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator's static IPv4 address when you create an accelerator.

    After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability.

    You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

    Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.

    For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

    *)
  5. ip_address_type : ip_address_type option;
    (*

    The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

    *)
  6. name : generic_string;
    (*

    The name of a custom routing accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

    *)
}
type nonrec create_cross_account_attachment_response = {
  1. cross_account_attachment : attachment option;
    (*

    Information about the cross-account attachment.

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

    Add tags for a cross-account attachment.

    For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.

    *)
  2. idempotency_token : idempotency_token;
    (*

    A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

    *)
  3. resources : resources option;
    (*

    The Amazon Resource Names (ARNs) for the resources to include in the cross-account attachment. A resource can be any supported Amazon Web Services resource type for Global Accelerator or a CIDR range for a bring your own IP address (BYOIP) address pool.

    *)
  4. principals : principals option;
    (*

    The principals to include in the cross-account attachment. A principal can be an Amazon Web Services account number or the Amazon Resource Name (ARN) for an accelerator.

    *)
  5. name : attachment_name;
    (*

    The name of the cross-account attachment.

    *)
}
type nonrec create_accelerator_response = {
  1. accelerator : accelerator option;
    (*

    The accelerator that is created by specifying a listener and the supported IP address types.

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

    Create tags for an accelerator.

    For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.

    *)
  2. idempotency_token : idempotency_token;
    (*

    A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator.

    *)
  3. enabled : generic_boolean option;
    (*

    Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

    If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.

    *)
  4. ip_addresses : ip_addresses option;
    (*

    Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator's static IPv4 address when you create an accelerator.

    After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability.

    You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

    Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.

    For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

    *)
  5. ip_address_type : ip_address_type option;
    (*

    The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

    *)
  6. name : generic_string;
    (*

    The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.

    *)
}
type nonrec allow_custom_routing_traffic_request = {
  1. allow_all_traffic_to_endpoint : generic_boolean option;
    (*

    Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic from a custom routing accelerator. The value is TRUE or FALSE.

    When set to TRUE, all destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE.

    When set to FALSE (or not specified), you must specify a list of destination IP addresses that are allowed to receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group.

    The default value is FALSE.

    *)
  2. destination_ports : destination_ports option;
    (*

    A list of specific Amazon EC2 instance ports (destination ports) that you want to allow to receive traffic.

    *)
  3. destination_addresses : destination_addresses option;
    (*

    A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive traffic. The IP addresses must be a subset of the IP addresses that you specified for the endpoint group.

    DestinationAddresses is required if AllowAllTrafficToEndpoint is FALSE or is not specified.

    *)
  4. endpoint_id : generic_string;
    (*

    An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.

    *)
  5. endpoint_group_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the endpoint group.

    *)
}
type nonrec advertise_byoip_cidr_response = {
  1. byoip_cidr : byoip_cidr option;
    (*

    Information about the address range.

    *)
}
type nonrec advertise_byoip_cidr_request = {
  1. cidr : generic_string;
    (*

    The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range.

    For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

    *)
}
type nonrec add_endpoints_response = {
  1. endpoint_group_arn : generic_string option;
    (*

    The Amazon Resource Name (ARN) of the endpoint group.

    *)
  2. endpoint_descriptions : endpoint_descriptions option;
    (*

    The list of endpoint objects.

    *)
}
type nonrec add_endpoints_request = {
  1. endpoint_group_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the endpoint group.

    *)
  2. endpoint_configurations : endpoint_configurations;
    (*

    The list of endpoint objects.

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

The endpoint that you specified doesn't exist.

type nonrec add_custom_routing_endpoints_response = {
  1. endpoint_group_arn : generic_string option;
    (*

    The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.

    *)
  2. endpoint_descriptions : custom_routing_endpoint_descriptions option;
    (*

    The endpoint objects added to the custom routing accelerator.

    *)
}
type nonrec custom_routing_endpoint_configuration = {
  1. attachment_arn : generic_string option;
    (*

    The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.

    *)
  2. endpoint_id : generic_string option;
    (*

    An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.

    *)
}

The list of endpoint objects. For custom routing, this is a list of virtual private cloud (VPC) subnet IDs.

type nonrec custom_routing_endpoint_configurations = custom_routing_endpoint_configuration list
type nonrec add_custom_routing_endpoints_request = {
  1. endpoint_group_arn : generic_string;
    (*

    The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.

    *)
  2. endpoint_configurations : custom_routing_endpoint_configurations;
    (*

    The list of endpoint objects to add to a custom routing accelerator.

    *)
}