Module Smaws_Client_Interconnect.Types

type nonrec connection_id = string
type nonrec amazon_resource_name = string
type nonrec connection_description = string
type nonrec connection_bandwidth = string
type nonrec direct_connect_gateway_attach_point = string
type nonrec attach_point =
  1. | Arn of amazon_resource_name
    (*

    Identifies an attach point by full ARN.

    *)
  2. | DirectConnectGateway of direct_connect_gateway_attach_point
    (*

    Identifies an DirectConnect Gateway attach point by DirectConnectGatewayID.

    *)

Identifies an attach point to use with a Connection.

type nonrec environment_id = string
type nonrec cloud_service_provider = string
type nonrec last_mile_provider = string
type nonrec provider =
  1. | LastMileProvider of last_mile_provider
    (*

    The provider's name. Specifically, connections to/from this Last Mile Provider will be considered LastMile connections.

    *)
  2. | CloudServiceProvider of cloud_service_provider
    (*

    The provider's name. Specifically, connections to/from this Cloud Service Provider will be considered Multicloud connections.

    *)

Describes the respective AWS Interconnect Partner organization.

type nonrec location = string
type nonrec product_type = string
type nonrec connection_state =
  1. | UPDATING
  2. | FAILED
  3. | DELETED
  4. | DELETING
  5. | DOWN
  6. | PENDING
  7. | REQUESTED
  8. | AVAILABLE
type nonrec connection_shared_id = string
type nonrec billing_tier = int
type nonrec owner_account_id = string
type nonrec activation_key = string
type nonrec tag_value = string
type nonrec tag_key = string
type nonrec tag_map = (tag_key * tag_value) list
type nonrec connection = {
  1. tags : tag_map option;
    (*

    The tags on the Connection

    *)
  2. activation_key : activation_key;
    (*

    The Activation Key associated to this connection.

    *)
  3. owner_account : owner_account_id;
    (*

    The account that owns this Connection

    *)
  4. billing_tier : billing_tier option;
    (*

    The billing tier this connection is currently assigned.

    *)
  5. shared_id : connection_shared_id;
    (*

    An identifier used by both AWS and the remote partner to identify the specific connection.

    *)
  6. state : connection_state;
    (*
    • requested: The initial state of a connection. The state will remain here until the Connection is accepted on the Partner portal.
    • pending: The connection has been accepted and is being provisioned between AWS and the Partner.
    • available: The connection has been fully provisioned between AWS and the Partner.
    • deleting: The connection is being deleted.
    • deleted: The connection has been deleted.
    • failed: The connection has failed to be created.
    • updating: The connection is being updated.
    *)
  7. type_ : product_type;
    (*

    The specific product type of this Connection.

    *)
  8. location : location;
    (*

    The provider specific location on the remote side of this Connection

    *)
  9. provider : provider;
    (*

    The provider on the remote side of this Connection.

    *)
  10. environment_id : environment_id;
    (*

    The specific Environment this connection is placed upon.

    *)
  11. attach_point : attach_point;
    (*

    The Attach Point to which the connection should be associated."

    *)
  12. bandwidth : connection_bandwidth;
    (*

    The specific selected bandwidth of this connection.

    *)
  13. description : connection_description;
    (*

    A descriptive name for the connection.

    *)
  14. arn : amazon_resource_name;
    (*

    An ARN of a Connection object.

    *)
  15. id : connection_id;
    (*

    The short identifier of the connection object.

    *)
}

The object describing the provided connectivity from the AWS region to the partner location.

type nonrec update_connection_response = {
  1. connection : connection option;
    (*

    The resulting updated Connection

    *)
}
type nonrec update_connection_request = {
  1. client_token : Smaws_Lib.Smithy_api.Types.string_ option;
    (*

    Idempotency token used for the request.

    *)
  2. bandwidth : connection_bandwidth option;
    (*

    Request a new bandwidth size on the given Connection.

    Note that changes to the size may be subject to additional policy, and does require the remote partner provider to acknowledge and permit this new bandwidth size.

    *)
  3. description : connection_description option;
    (*

    An updated description to apply to the Connection

    *)
  4. identifier : connection_id;
    (*

    The identifier of the Connection that should be updated.

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

    The list of tag keys that should be removed from the resource.

    *)
  2. arn : amazon_resource_name;
    (*

    The ARN of the resource from which the specified tags should be removed.

    *)
}
type nonrec throttling_exception = {
  1. message : Smaws_Lib.Smithy_api.Types.string_ option;
}

The request was denied due to request throttling.

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

    A map of tags to apply to the specified resource.

    *)
  2. arn : amazon_resource_name;
    (*

    The ARN of the resource that should receive the new tags.

    *)
}
type nonrec service_quota_exceeded_exception = {
  1. message : Smaws_Lib.Smithy_api.Types.string_ option;
}

The requested operation would result in the calling principal exceeding their allotted quota.

type nonrec resource_not_found_exception = {
  1. message : Smaws_Lib.Smithy_api.Types.string_ option;
}

The request specifies a resource that does not exist on the server.

type nonrec remote_owner_account = string
type nonrec remote_account_identifier_type =
  1. | EMAIL
  2. | ACCOUNT
type nonrec remote_account_identifier =
  1. | Identifier of remote_owner_account
    (*

    A generic bit of identifying information. Can be used in place of any of the more specific types.

    *)

The types of identifiers that may be needed for remote account specification.

type nonrec next_token = string
type nonrec max_results = int
type nonrec list_tags_for_resource_response = {
  1. tags : tag_map option;
    (*

    The tags on the specified ARN.

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

    The resource ARN for which to list tags.

    *)
}
type nonrec environment_state =
  1. | UNAVAILABLE
  2. | LIMITED
  3. | AVAILABLE
type nonrec bandwidth_list = connection_bandwidth list
type nonrec bandwidths = {
  1. supported : bandwidth_list option;
    (*

    The list of all bandwidths that this environment plans to support

    *)
  2. available : bandwidth_list option;
    (*

    The list of currently available bandwidths.

    *)
}

Contains the details about the available and supported bandwidths.

type nonrec environment = {
  1. remote_identifier_type : remote_account_identifier_type option;
    (*

    The type of identifying information that should be supplied to the remoteAccount parameter of a CreateConnection call for this specific Environment.

    *)
  2. activation_page_url : Smaws_Lib.Smithy_api.Types.string_ option;
    (*

    An HTTPS URL on the remote partner portal where the Activation Key should be brought to complete the creation process.

    *)
  3. type_ : product_type;
    (*

    The specific product type of Connection objects provided by this Environment.

    *)
  4. bandwidths : bandwidths;
    (*

    The sets of bandwidths that are available and supported on this environment.

    *)
  5. state : environment_state;
    (*

    The state of the Environment. Possible values:

    • available: The environment is available and new Connection objects can be requested.
    • limited: The environment is available, but overall capacity is limited. The set of available bandwidths
    • unavailable: The environment is currently unavailable.
    *)
  6. environment_id : environment_id;
    (*

    The identifier of this Environment

    *)
  7. location : location;
    (*

    The provider specific location on the remote side of this Connection.

    *)
  8. provider : provider;
    (*

    The provider on the remote side of this Connection.

    *)
}

Defines the logical topology that an AWS Interconnect Connection is created upon.

Specifically, an Environment defines the partner The remote Cloud Service Provider of this resource. or The remote Last Mile Provider of this resource. and the region or location specification to which an AWS Interconnect Connection can be made.

type nonrec environment_list = environment list
type nonrec list_environments_response = {
  1. next_token : Smaws_Lib.Smithy_api.Types.string_ option;
    (*

    A pagination token for use in subsequent calls to fetch the next page of results.

    *)
  2. environments : environment_list;
    (*

    The list of matching Environment objects.

    *)
}
type nonrec list_environments_request = {
  1. location : location option;
    (*

    Filter results to only include Environment objects that connect to a given location distiguisher.

    *)
  2. provider : provider option;
    (*

    Filter results to only include Environment objects that connect to the Provider.

    *)
  3. next_token : next_token option;
    (*

    A pagination token from a previous paginated response indicating you wish to get the next page of results.

    *)
  4. max_results : max_results option;
    (*

    The max number of list results in a single paginated response.

    *)
}
type nonrec connection_summary = {
  1. billing_tier : billing_tier option;
    (*

    The billing tier this connection is currently assigned.

    *)
  2. shared_id : connection_shared_id;
    (*

    An identifier used by both AWS and the remote partner to identify the specific connection.

    *)
  3. state : connection_state;
    (*
    • requested: The initial state of a connection. The state will remain here until the Connection is accepted on the Partner portal.
    • pending: The connection has been accepted and is being provisioned between AWS and the Partner.
    • available: The connection has been fully provisioned between AWS and the Partner.
    • deleting: The connection is being deleted.
    • deleted: The connection has been deleted.
    • failed: The connection has failed to be created.
    • updating: The connection is being updated.
    *)
  4. type_ : product_type;
    (*

    The product variant supplied by this resource.

    *)
  5. location : location;
    (*

    The provider specific location at the remote end of this Connection

    *)
  6. provider : provider;
    (*

    The provider on the remote end of this Connection

    *)
  7. environment_id : environment_id;
    (*

    The Environment that this Connection is created on.

    *)
  8. attach_point : attach_point;
    (*

    The Attach Point to which the connection should be associated.

    *)
  9. bandwidth : connection_bandwidth;
    (*

    The bandwidth of the Connection

    *)
  10. description : connection_description;
    (*

    A descriptive name of the Connection

    *)
  11. arn : amazon_resource_name;
    (*

    The ARN of the Connection

    *)
  12. id : connection_id;
    (*

    The identifier of the requested Connection

    *)
}

Summarized view of a Connection object.

type nonrec connection_summaries_list = connection_summary list
type nonrec list_connections_response = {
  1. next_token : next_token option;
    (*

    A pagination token for use in subsequent calls to fetch the next page of results.

    *)
  2. connections : connection_summaries_list option;
    (*

    The resulting list of Connection objects.

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

    Filter results to only include Connection objects attached to the given AttachPoint.

    *)
  2. provider : provider option;
    (*

    Filter the results to only include Connection objects to the given Provider.

    *)
  3. environment_id : environment_id option;
    (*

    Filter the results to only include Connection objects on the given Environment.

    *)
  4. state : connection_state option;
    (*

    Filter the results to only include Connection objects in the given Connection$state.

    *)
  5. next_token : next_token option;
    (*

    A pagination token from a previous paginated response indicating you wish to get the next page of results.

    *)
  6. max_results : max_results option;
    (*

    The max number of list results in a single paginated response.

    *)
}
type nonrec attach_point_type =
  1. | DirectConnectGateway
type nonrec attach_point_descriptor = {
  1. name : Smaws_Lib.Smithy_api.Types.string_;
    (*

    The descriptive name of the identifier attach point.

    *)
  2. identifier : Smaws_Lib.Smithy_api.Types.string_;
    (*

    The identifier for the specific type of the AttachPoint.

    *)
  3. type_ : attach_point_type;
    (*

    The type of this AttachPoint, which will dictate the syntax of the identifier.

    Current types include:

    • ARN
    • DirectConnect Gateway
    *)
}

Describes a possible Attach Point for a Connection.

type nonrec attach_point_descriptor_list = attach_point_descriptor list
type nonrec list_attach_points_response = {
  1. next_token : next_token option;
    (*

    A pagination token indicating that there are more results that can be fetched.

    *)
  2. attach_points : attach_point_descriptor_list;
    (*

    The valid AttachPoint

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

    A pagination token from a previous paginated response indicating you wish to get the next page.

    *)
  2. max_results : max_results option;
    (*

    The max number of list results in a single paginated response.

    *)
  3. environment_id : environment_id;
    (*

    The identifier of the Environment for which to list valid Attach Points.

    *)
}
type nonrec interconnect_validation_exception = {
  1. message : Smaws_Lib.Smithy_api.Types.string_;
}

The input fails to satisfy the constraints specified.

type nonrec interconnect_server_exception = {
  1. message : Smaws_Lib.Smithy_api.Types.string_;
}

The request resulted in an exception internal to the service.

type nonrec interconnect_client_exception = {
  1. message : Smaws_Lib.Smithy_api.Types.string_;
}

The request was denied due to incorrect client supplied parameters.

type nonrec describe_connection_proposal_response = {
  1. location : location;
    (*

    The partner specific location distinguisher of the specific Environment of the proposal.

    *)
  2. provider : provider;
    (*

    The partner provider of the specific Environment of the proposal.

    *)
  3. environment_id : environment_id;
    (*

    The identifier of the Environment upon which the Connection would be placed if this proposal were accepted.

    *)
  4. bandwidth : connection_bandwidth;
    (*

    The bandwidth of the proposed Connection.

    *)
}
type nonrec describe_connection_proposal_request = {
  1. activation_key : activation_key;
    (*

    An Activation Key that was generated on a supported partner's portal. This key captures the desired parameters from the initial creation request.

    *)
}
type nonrec accept_connection_proposal_response = {
  1. connection : connection option;
    (*

    The created Connection object.

    *)
}
type nonrec accept_connection_proposal_request = {
  1. client_token : Smaws_Lib.Smithy_api.Types.string_ option;
    (*

    Idempotency token used for the request.

    *)
  2. tags : tag_map option;
    (*

    The tags to associate with the resulting Connection.

    *)
  3. description : connection_description option;
    (*

    A description to distinguish this Connection.

    *)
  4. activation_key : activation_key;
    (*

    An Activation Key that was generated on a supported partner's portal. This key captures the desired parameters from the initial creation request.

    The details of this request can be described using with DescribeConnectionProposal.

    *)
  5. attach_point : attach_point;
    (*

    The Attach Point to which the connection should be associated.

    *)
}
type nonrec get_environment_response = {
  1. environment : environment;
    (*

    The requested Environment structure.

    *)
}
type nonrec get_environment_request = {
  1. id : environment_id;
    (*

    The identifier of the specific Environment to describe.

    *)
}
type nonrec get_connection_response = {
  1. connection : connection option;
    (*

    The existing Connection resource.

    *)
}
type nonrec get_connection_request = {
  1. identifier : connection_id;
    (*

    The identifier of the requested Connection

    *)
}
type nonrec environment_resource = Smaws_Lib.CoreTypes.Resource.t
type nonrec delete_connection_response = {
  1. connection : connection;
    (*

    The Connection object that has been marked for deletion.

    *)
}
type nonrec delete_connection_request = {
  1. client_token : Smaws_Lib.Smithy_api.Types.string_ option;
    (*

    Idempotency token used for the request.

    *)
  2. identifier : connection_id;
    (*

    The identifier of the Connection to be deleted.

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

    The resulting Connection.

    *)
}
type nonrec create_connection_request = {
  1. client_token : Smaws_Lib.Smithy_api.Types.string_ option;
    (*

    Idempotency token used for the request.

    *)
  2. tags : tag_map option;
    (*

    The tag to associate with the resulting Connection.

    *)
  3. remote_account : remote_account_identifier option;
    (*

    Account and/or principal identifying information that can be verified by the partner of this specific Environment.

    *)
  4. environment_id : environment_id;
    (*

    The identifier of the Environment across which this Connection should be created.

    The available Environment objects can be determined using ListEnvironments.

    *)
  5. attach_point : attach_point;
    (*

    The Attach Point to which the connection should be associated."

    *)
  6. bandwidth : connection_bandwidth;
    (*

    The desired bandwidth of the requested Connection

    *)
  7. description : connection_description option;
    (*

    A description to distinguish this Connection.

    *)
}
type nonrec connection_resource = Smaws_Lib.CoreTypes.Resource.t
type nonrec access_denied_exception = {
  1. message : Smaws_Lib.Smithy_api.Types.string_ option;
}

The calling principal is not allowed to access the specified resource, or the resource does not exist.