Module Smaws_Client_OpenSearchServerless

OpenSearchServerless client library built on EIO.

Types

type nonrec vpc_endpoint_status =
  1. | PENDING
  2. | DELETING
  3. | ACTIVE
  4. | FAILED
type nonrec vpc_endpoint_summary = {
  1. status : vpc_endpoint_status option;
    (*

    The current status of the endpoint.

    *)
  2. name : string option;
    (*

    The name of the endpoint.

    *)
  3. id : string option;
    (*

    The unique identifier of the endpoint.

    *)
}

The VPC endpoint object.

type nonrec vpc_endpoint_filters = {
  1. status : vpc_endpoint_status option;
    (*

    The current status of the endpoint.

    *)
}

Filter the results of a ListVpcEndpoints request.

type nonrec vpc_endpoint_error_detail = {
  1. error_code : string option;
    (*

    The error code for the failed request.

    *)
  2. error_message : string option;
    (*

    An error message describing the reason for the failure.

    *)
  3. id : string option;
    (*

    The unique identifier of the VPC endpoint.

    *)
}

Error information for a failed BatchGetVpcEndpoint request.

type nonrec vpc_endpoint_detail = {
  1. created_date : int option;
    (*

    The date the endpoint was created.

    *)
  2. status : vpc_endpoint_status option;
    (*

    The current status of the endpoint.

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

    The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

    *)
  4. subnet_ids : string list option;
    (*

    The ID of the subnets from which you access OpenSearch Serverless.

    *)
  5. vpc_id : string option;
    (*

    The ID of the VPC from which you access OpenSearch Serverless.

    *)
  6. name : string option;
    (*

    The name of the endpoint.

    *)
  7. id : string option;
    (*

    The unique identifier of the endpoint.

    *)
}

Details about an OpenSearch Serverless-managed interface endpoint.

type nonrec validation_exception = {
  1. message : string option;
}

Thrown when the HTTP request contains invalid input or is missing required input.

type nonrec update_vpc_endpoint_detail = {
  1. last_modified_date : int option;
    (*

    The timestamp of when the endpoint was last modified.

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

    The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

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

    The ID of the subnets from which you access OpenSearch Serverless.

    *)
  4. status : vpc_endpoint_status option;
    (*

    The current status of the endpoint update process.

    *)
  5. name : string option;
    (*

    The name of the endpoint.

    *)
  6. id : string option;
    (*

    The unique identifier of the endpoint.

    *)
}

Update details for an OpenSearch Serverless-managed interface endpoint.

type nonrec update_vpc_endpoint_response = {
  1. update_vpc_endpoint_detail : update_vpc_endpoint_detail option;
    (*

    Details about the updated VPC endpoint.

    *)
}
type nonrec update_vpc_endpoint_request = {
  1. client_token : string option;
    (*

    Unique, case-sensitive identifier to ensure idempotency of the request.

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

    The unique identifiers of the security groups to remove from the endpoint.

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

    The unique identifiers of the security groups to add to the endpoint. Security groups define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

    *)
  4. remove_subnet_ids : string list option;
    (*

    The unique identifiers of the subnets to remove from the endpoint.

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

    The ID of one or more subnets to add to the endpoint.

    *)
  6. id : string;
    (*

    The unique identifier of the interface endpoint to update.

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

Thrown when an error internal to the service occurs while processing a request.

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

When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.

type nonrec security_policy_type =
  1. | Encryption
  2. | Network
type nonrec security_policy_detail = {
  1. last_modified_date : int option;
    (*

    The timestamp of when the policy was last modified.

    *)
  2. created_date : int option;
    (*

    The date the policy was created.

    *)
  3. policy : Smaws_Lib.CoreTypes.Document.t option;
    (*

    The JSON policy document without any whitespaces.

    *)
  4. description : string option;
    (*

    The description of the security policy.

    *)
  5. policy_version : string option;
    (*

    The version of the policy.

    *)
  6. name : string option;
    (*

    The name of the policy.

    *)
  7. type_ : security_policy_type option;
    (*

    The type of security policy.

    *)
}

Details about an OpenSearch Serverless security policy.

type nonrec update_security_policy_response = {
  1. security_policy_detail : security_policy_detail option;
    (*

    Details about the updated security policy.

    *)
}
type nonrec update_security_policy_request = {
  1. client_token : string option;
    (*

    Unique, case-sensitive identifier to ensure idempotency of the request.

    *)
  2. policy : string option;
    (*

    The JSON policy document to use as the content for the new policy.

    *)
  3. description : string option;
    (*

    A description of the policy. Typically used to store information about the permissions defined in the policy.

    *)
  4. policy_version : string;
    (*

    The version of the policy being updated.

    *)
  5. name : string;
    (*

    The name of the policy.

    *)
  6. type_ : security_policy_type;
    (*

    The type of access policy.

    *)
}
type nonrec service_quota_exceeded_exception = {
  1. quota_code : string option;
    (*

    Service Quotas requirement to identify originating quota.

    *)
  2. service_code : string;
    (*

    Service Quotas requirement to identify originating service.

    *)
  3. resource_type : string option;
    (*

    Type of the resource affected.

    *)
  4. resource_id : string option;
    (*

    Identifier of the resource affected.

    *)
  5. message : string;
    (*

    Description of the error.

    *)
}

Thrown when you attempt to create more resources than the service allows based on service quotas.

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

Thrown when accessing or deleting a resource that does not exist.

type nonrec security_config_type =
  1. | Saml
type nonrec saml_config_options = {
  1. session_timeout : int option;
    (*

    The session timeout, in minutes. Default is 60 minutes (12 hours).

    *)
  2. group_attribute : string option;
    (*

    The group attribute for this SAML integration.

    *)
  3. user_attribute : string option;
    (*

    A user attribute for this SAML integration.

    *)
  4. metadata : string;
    (*

    The XML IdP metadata file generated from your identity provider.

    *)
}

Describes SAML options for an OpenSearch Serverless security configuration in the form of a key-value map.

type nonrec security_config_detail = {
  1. last_modified_date : int option;
    (*

    The timestamp of when the configuration was last modified.

    *)
  2. created_date : int option;
    (*

    The date the configuration was created.

    *)
  3. saml_options : saml_config_options option;
    (*

    SAML options for the security configuration in the form of a key-value map.

    *)
  4. description : string option;
    (*

    The description of the security configuration.

    *)
  5. config_version : string option;
    (*

    The version of the security configuration.

    *)
  6. type_ : security_config_type option;
    (*

    The type of security configuration.

    *)
  7. id : string option;
    (*

    The unique identifier of the security configuration.

    *)
}

Details about a security configuration for OpenSearch Serverless.

type nonrec update_security_config_response = {
  1. security_config_detail : security_config_detail option;
    (*

    Details about the updated security configuration.

    *)
}
type nonrec update_security_config_request = {
  1. client_token : string option;
    (*

    Unique, case-sensitive identifier to ensure idempotency of the request.

    *)
  2. saml_options : saml_config_options option;
    (*

    SAML options in in the form of a key-value map.

    *)
  3. description : string option;
    (*

    A description of the security configuration.

    *)
  4. config_version : string;
    (*

    The version of the security configuration to be updated. You can find the most recent version of a security configuration using the GetSecurityPolicy command.

    *)
  5. id : string;
    (*

    The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.

    *)
}
type nonrec lifecycle_policy_type =
  1. | Retention
type nonrec lifecycle_policy_detail = {
  1. last_modified_date : int option;
    (*

    The timestamp of when the lifecycle policy was last modified.

    *)
  2. created_date : int option;
    (*

    The date the lifecycle policy was created.

    *)
  3. policy : Smaws_Lib.CoreTypes.Document.t option;
    (*

    The JSON policy document without any whitespaces.

    *)
  4. description : string option;
    (*

    The description of the lifecycle policy.

    *)
  5. policy_version : string option;
    (*

    The version of the lifecycle policy.

    *)
  6. name : string option;
    (*

    The name of the lifecycle policy.

    *)
  7. type_ : lifecycle_policy_type option;
    (*

    The type of lifecycle policy.

    *)
}

Details about an OpenSearch Serverless lifecycle policy.

type nonrec update_lifecycle_policy_response = {
  1. lifecycle_policy_detail : lifecycle_policy_detail option;
    (*

    Details about the updated lifecycle policy.

    *)
}
type nonrec update_lifecycle_policy_request = {
  1. client_token : string option;
    (*

    A unique, case-sensitive identifier to ensure idempotency of the request.

    *)
  2. policy : string option;
    (*

    The JSON policy document to use as the content for the lifecycle policy.

    *)
  3. description : string option;
    (*

    A description of the lifecycle policy.

    *)
  4. policy_version : string;
    (*

    The version of the policy being updated.

    *)
  5. name : string;
    (*

    The name of the policy.

    *)
  6. type_ : lifecycle_policy_type;
    (*

    The type of lifecycle policy.

    *)
}
type nonrec collection_status =
  1. | CREATING
  2. | DELETING
  3. | ACTIVE
  4. | FAILED
type nonrec collection_type =
  1. | SEARCH
  2. | TIMESERIES
  3. | VECTORSEARCH
type nonrec update_collection_detail = {
  1. last_modified_date : int option;
    (*

    The date and time when the collection was last modified.

    *)
  2. created_date : int option;
    (*

    The date and time when the collection was created.

    *)
  3. arn : string option;
    (*

    The Amazon Resource Name (ARN) of the collection.

    *)
  4. description : string option;
    (*

    The description of the collection.

    *)
  5. type_ : collection_type option;
    (*

    The collection type.

    *)
  6. status : collection_status option;
    (*

    The current status of the collection.

    *)
  7. name : string option;
    (*

    The name of the collection.

    *)
  8. id : string option;
    (*

    The unique identifier of the collection.

    *)
}

Details about an updated OpenSearch Serverless collection.

type nonrec update_collection_response = {
  1. update_collection_detail : update_collection_detail option;
    (*

    Details about the updated collection.

    *)
}
type nonrec update_collection_request = {
  1. client_token : string option;
    (*

    Unique, case-sensitive identifier to ensure idempotency of the request.

    *)
  2. description : string option;
    (*

    A description of the collection.

    *)
  3. id : string;
    (*

    The unique identifier of the collection.

    *)
}
type nonrec capacity_limits = {
  1. max_search_capacity_in_oc_u : int option;
    (*

    The maximum search capacity for collections.

    *)
  2. max_indexing_capacity_in_oc_u : int option;
    (*

    The maximum indexing capacity for collections.

    *)
}

The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units (OCUs). These limits are used to scale your collections based on the current workload. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.

type nonrec account_settings_detail = {
  1. capacity_limits : capacity_limits option;
}

OpenSearch Serverless-related information for the current account.

type nonrec update_account_settings_response = {
  1. account_settings_detail : account_settings_detail option;
    (*

    OpenSearch Serverless-related settings for the current Amazon Web Services account.

    *)
}
type nonrec update_account_settings_request = {
  1. capacity_limits : capacity_limits option;
}
type nonrec access_policy_type =
  1. | Data
type nonrec access_policy_detail = {
  1. last_modified_date : int option;
    (*

    The timestamp of when the policy was last modified.

    *)
  2. created_date : int option;
    (*

    The date the policy was created.

    *)
  3. policy : Smaws_Lib.CoreTypes.Document.t option;
    (*

    The JSON policy document without any whitespaces.

    *)
  4. description : string option;
    (*

    The description of the policy.

    *)
  5. policy_version : string option;
    (*

    The version of the policy.

    *)
  6. name : string option;
    (*

    The name of the policy.

    *)
  7. type_ : access_policy_type option;
    (*

    The type of access policy.

    *)
}

Details about an OpenSearch Serverless access policy.

type nonrec update_access_policy_response = {
  1. access_policy_detail : access_policy_detail option;
    (*

    Details about the updated access policy.

    *)
}
type nonrec update_access_policy_request = {
  1. client_token : string option;
    (*

    Unique, case-sensitive identifier to ensure idempotency of the request.

    *)
  2. policy : string option;
    (*

    The JSON policy document to use as the content for the policy.

    *)
  3. description : string option;
    (*

    A description of the policy. Typically used to store information about the permissions defined in the policy.

    *)
  4. policy_version : string;
    (*

    The version of the policy being updated.

    *)
  5. name : string;
    (*

    The name of the policy.

    *)
  6. type_ : access_policy_type;
    (*

    The type of policy.

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

    The tag or set of tags to remove from the resource. All tag keys in the request must be unique.

    *)
  2. resource_arn : string;
    (*

    The Amazon Resource Name (ARN) of the resource to remove tags from. The resource must be active (not in the DELETING state), and must be owned by the account ID included in the request.

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

    The value of the tag.

    *)
  2. key : string;
    (*

    The key to use in the tag.

    *)
}

A map of key-value pairs associated to an OpenSearch Serverless resource.

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

    A list of tags (key-value pairs) to add to the resource. All tag keys in the request must be unique.

    *)
  2. resource_arn : string;
    (*

    The Amazon Resource Name (ARN) of the resource. The resource must be active (not in the DELETING state), and must be owned by the account ID included in the request.

    *)
}
type nonrec standby_replicas =
  1. | ENABLED
  2. | DISABLED
type nonrec security_policy_summary = {
  1. last_modified_date : int option;
    (*

    The timestamp of when the policy was last modified.

    *)
  2. created_date : int option;
    (*

    The date the policy was created.

    *)
  3. description : string option;
    (*

    The description of the security policy.

    *)
  4. policy_version : string option;
    (*

    The version of the policy.

    *)
  5. name : string option;
    (*

    The name of the policy.

    *)
  6. type_ : security_policy_type option;
    (*

    The type of security policy.

    *)
}

A summary of a security policy for OpenSearch Serverless.

type nonrec security_policy_stats = {
  1. network_policy_count : int option;
    (*

    The number of network policies in the current account.

    *)
  2. encryption_policy_count : int option;
    (*

    The number of encryption policies in the current account.

    *)
}

Statistics for an OpenSearch Serverless security policy.

type nonrec security_config_summary = {
  1. last_modified_date : int option;
    (*

    The timestamp of when the configuration was last modified.

    *)
  2. created_date : int option;
    (*

    The Epoch time when the security configuration was created.

    *)
  3. description : string option;
    (*

    The description of the security configuration.

    *)
  4. config_version : string option;
    (*

    The version of the security configuration.

    *)
  5. type_ : security_config_type option;
    (*

    The type of security configuration.

    *)
  6. id : string option;
    (*

    The unique identifier of the security configuration.

    *)
}

A summary of a security configuration for OpenSearch Serverless.

type nonrec security_config_stats = {
  1. saml_config_count : int option;
    (*

    The number of security configurations in the current account.

    *)
}

Statistics for an OpenSearch Serverless security configuration.

type nonrec resource_type =
  1. | Index
type nonrec list_tags_for_resource_response = {
  1. tags : tag list option;
    (*

    The tags associated with the resource.

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

    The Amazon Resource Name (ARN) of the resource. The resource must be active (not in the DELETING state), and must be owned by the account ID included in the request.

    *)
}
type nonrec access_policy_stats = {
  1. data_policy_count : int option;
    (*

    The number of data access policies in the current account.

    *)
}

Statistics for an OpenSearch Serverless access policy.

type nonrec lifecycle_policy_stats = {
  1. retention_policy_count : int option;
    (*

    The number of retention lifecycle policies in the current account.

    *)
}

Statistics for an OpenSearch Serverless lifecycle policy.

type nonrec get_policies_stats_response = {
  1. total_policy_count : int option;
    (*

    The total number of OpenSearch Serverless security policies and configurations in your account.

    *)
  2. lifecycle_policy_stats : lifecycle_policy_stats option;
    (*

    Information about the lifecycle policies in your account.

    *)
  3. security_config_stats : security_config_stats option;
    (*

    Information about the security configurations in your account.

    *)
  4. security_policy_stats : security_policy_stats option;
    (*

    Information about the security policies in your account.

    *)
  5. access_policy_stats : access_policy_stats option;
    (*

    Information about the data access policies in your account.

    *)
}
type nonrec get_account_settings_response = {
  1. account_settings_detail : account_settings_detail option;
    (*

    OpenSearch Serverless-related details for the current account.

    *)
}
type nonrec create_security_policy_response = {
  1. security_policy_detail : security_policy_detail option;
    (*

    Details about the created security policy.

    *)
}
type nonrec create_security_policy_request = {
  1. client_token : string option;
    (*

    Unique, case-sensitive identifier to ensure idempotency of the request.

    *)
  2. policy : string;
    (*

    The JSON policy document to use as the content for the new policy.

    *)
  3. description : string option;
    (*

    A description of the policy. Typically used to store information about the permissions defined in the policy.

    *)
  4. name : string;
    (*

    The name of the policy.

    *)
  5. type_ : security_policy_type;
    (*

    The type of security policy.

    *)
}
type nonrec create_lifecycle_policy_response = {
  1. lifecycle_policy_detail : lifecycle_policy_detail option;
    (*

    Details about the created lifecycle policy.

    *)
}
type nonrec create_lifecycle_policy_request = {
  1. client_token : string option;
    (*

    A unique, case-sensitive identifier to ensure idempotency of the request.

    *)
  2. policy : string;
    (*

    The JSON policy document to use as the content for the lifecycle policy.

    *)
  3. description : string option;
    (*

    A description of the lifecycle policy.

    *)
  4. name : string;
    (*

    The name of the lifecycle policy.

    *)
  5. type_ : lifecycle_policy_type;
    (*

    The type of lifecycle policy.

    *)
}
type nonrec batch_get_vpc_endpoint_response = {
  1. vpc_endpoint_error_details : vpc_endpoint_error_detail list option;
    (*

    Error information for a failed request.

    *)
  2. vpc_endpoint_details : vpc_endpoint_detail list option;
    (*

    Details about the specified VPC endpoint.

    *)
}
type nonrec batch_get_vpc_endpoint_request = {
  1. ids : string list;
    (*

    A list of VPC endpoint identifiers.

    *)
}
type nonrec lifecycle_policy_error_detail = {
  1. error_code : string option;
    (*

    The error code for the request. For example, NOT_FOUND.

    *)
  2. error_message : string option;
    (*

    A description of the error. For example, The specified Lifecycle Policy is not found.

    *)
  3. name : string option;
    (*

    The name of the lifecycle policy.

    *)
  4. type_ : lifecycle_policy_type option;
    (*

    The type of lifecycle policy.

    *)
}

Error information for an OpenSearch Serverless request.

type nonrec batch_get_lifecycle_policy_response = {
  1. lifecycle_policy_error_details : lifecycle_policy_error_detail list option;
    (*

    A list of lifecycle policy names and policy types for which retrieval failed.

    *)
  2. lifecycle_policy_details : lifecycle_policy_detail list option;
    (*

    A list of lifecycle policies matched to the input policy name and policy type.

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

    The name of the lifecycle policy.

    *)
  2. type_ : lifecycle_policy_type;
    (*

    The type of lifecycle policy.

    *)
}

The unique identifiers of policy types and policy names.

type nonrec batch_get_lifecycle_policy_request = {
  1. identifiers : lifecycle_policy_identifier list;
    (*

    The unique identifiers of policy types and policy names.

    *)
}
type nonrec effective_lifecycle_policy_detail = {
  1. no_min_retention_period : bool option;
    (*

    The minimum number of index retention days set. That is an optional param that will return as true if the minimum number of days or hours is not set to a index resource.

    *)
  2. retention_period : string option;
    (*

    The minimum number of index retention in days or hours. This is an optional parameter that will return only if it’s set.

    *)
  3. resource_type : resource_type option;
    (*

    The type of OpenSearch Serverless resource. Currently, the only supported resource is index.

    *)
  4. policy_name : string option;
    (*

    The name of the lifecycle policy.

    *)
  5. resource : string option;
    (*

    The name of the OpenSearch Serverless index resource.

    *)
  6. type_ : lifecycle_policy_type option;
    (*

    The type of lifecycle policy.

    *)
}

Error information for an OpenSearch Serverless request.

type nonrec effective_lifecycle_policy_error_detail = {
  1. error_code : string option;
    (*

    The error code for the request.

    *)
  2. error_message : string option;
    (*

    A description of the error. For example, The specified Index resource is not found.

    *)
  3. resource : string option;
    (*

    The name of OpenSearch Serverless index resource.

    *)
  4. type_ : lifecycle_policy_type option;
    (*

    The type of lifecycle policy.

    *)
}

Error information for an OpenSearch Serverless request.

type nonrec batch_get_effective_lifecycle_policy_response = {
  1. effective_lifecycle_policy_error_details : effective_lifecycle_policy_error_detail list option;
    (*

    A list of resources for which retrieval failed.

    *)
  2. effective_lifecycle_policy_details : effective_lifecycle_policy_detail list option;
    (*

    A list of lifecycle policies applied to the OpenSearch Serverless indexes.

    *)
}
type nonrec lifecycle_policy_resource_identifier = {
  1. resource : string;
    (*

    The name of the OpenSearch Serverless ilndex resource.

    *)
  2. type_ : lifecycle_policy_type;
    (*

    The type of lifecycle policy.

    *)
}

The unique identifiers of policy types and resource names.

type nonrec batch_get_effective_lifecycle_policy_request = {
  1. resource_identifiers : lifecycle_policy_resource_identifier list;
    (*

    The unique identifiers of policy types and resource names.

    *)
}
type nonrec collection_detail = {
  1. dashboard_endpoint : string option;
    (*

    Collection-specific endpoint used to access OpenSearch Dashboards.

    *)
  2. collection_endpoint : string option;
    (*

    Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.

    *)
  3. last_modified_date : int option;
    (*

    The date and time when the collection was last modified.

    *)
  4. created_date : int option;
    (*

    The Epoch time when the collection was created.

    *)
  5. standby_replicas : standby_replicas option;
    (*

    Details about an OpenSearch Serverless collection.

    *)
  6. kms_key_arn : string option;
    (*

    The ARN of the Amazon Web Services KMS key used to encrypt the collection.

    *)
  7. arn : string option;
    (*

    The Amazon Resource Name (ARN) of the collection.

    *)
  8. description : string option;
    (*

    A description of the collection.

    *)
  9. type_ : collection_type option;
    (*

    The type of collection.

    *)
  10. status : collection_status option;
    (*

    The current status of the collection.

    *)
  11. name : string option;
    (*

    The name of the collection.

    *)
  12. id : string option;
    (*

    A unique identifier for the collection.

    *)
}

Details about each OpenSearch Serverless collection, including the collection endpoint and the OpenSearch Dashboards endpoint.

type nonrec collection_error_detail = {
  1. error_code : string option;
    (*

    The error code for the request. For example, NOT_FOUND.

    *)
  2. error_message : string option;
    (*

    A description of the error. For example, The specified Collection is not found.

    *)
  3. name : string option;
    (*

    If the request contains collection names, the response includes the names provided in the request.

    *)
  4. id : string option;
    (*

    If the request contains collection IDs, the response includes the IDs provided in the request.

    *)
}

Error information for an OpenSearch Serverless request.

type nonrec batch_get_collection_response = {
  1. collection_error_details : collection_error_detail list option;
    (*

    Error information for the request.

    *)
  2. collection_details : collection_detail list option;
    (*

    Details about each collection.

    *)
}
type nonrec batch_get_collection_request = {
  1. names : string list option;
    (*

    A list of collection names. You can't provide names and IDs in the same request.

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

    A list of collection IDs. You can't provide names and IDs in the same request. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.

    *)
}
type nonrec ocu_limit_exceeded_exception = {
  1. message : string;
    (*

    Description of the error.

    *)
}

Thrown when the collection you're attempting to create results in a number of search or indexing OCUs that exceeds the account limit.

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

    When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

    *)
  2. vpc_endpoint_summaries : vpc_endpoint_summary list option;
    (*

    Details about each VPC endpoint, including the name and current status.

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

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

    *)
  2. next_token : string option;
    (*

    If your initial ListVpcEndpoints operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpoints operations, which returns results in the next page.

    *)
  3. vpc_endpoint_filters : vpc_endpoint_filters option;
    (*

    Filter the results according to the current status of the VPC endpoint. Possible statuses are CREATING, DELETING, UPDATING, ACTIVE, and FAILED.

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

    When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

    *)
  2. security_policy_summaries : security_policy_summary list option;
    (*

    Details about the security policies in your account.

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

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

    *)
  2. next_token : string option;
    (*

    If your initial ListSecurityPolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListSecurityPolicies operations, which returns results in the next page.

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

    Resource filters (can be collection or indexes) that policies can apply to.

    *)
  4. type_ : security_policy_type;
    (*

    The type of policy.

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

    When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

    *)
  2. security_config_summaries : security_config_summary list option;
    (*

    Details about the security configurations in your account.

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

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

    *)
  2. next_token : string option;
    (*

    If your initial ListSecurityConfigs operation returns a nextToken, you can include the returned nextToken in subsequent ListSecurityConfigs operations, which returns results in the next page.

    *)
  3. type_ : security_config_type;
    (*

    The type of security configuration.

    *)
}
type nonrec lifecycle_policy_summary = {
  1. last_modified_date : int option;
    (*

    The date and time when the lifecycle policy was last modified.

    *)
  2. created_date : int option;
    (*

    The Epoch time when the lifecycle policy was created.

    *)
  3. description : string option;
    (*

    The description of the lifecycle policy.

    *)
  4. policy_version : string option;
    (*

    The version of the lifecycle policy.

    *)
  5. name : string option;
    (*

    The name of the lifecycle policy.

    *)
  6. type_ : lifecycle_policy_type option;
    (*

    The type of lifecycle policy.

    *)
}

A summary of the lifecycle policy.

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

    When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

    *)
  2. lifecycle_policy_summaries : lifecycle_policy_summary list option;
    (*

    Details about the requested lifecycle policies.

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

    An optional parameter that specifies the maximum number of results to return. You can use use nextToken to get the next page of results. The default is 10.

    *)
  2. next_token : string option;
    (*

    If your initial ListLifecyclePolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListLifecyclePolicies operations, which returns results in the next page.

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

    Resource filters that policies can apply to. Currently, the only supported resource type is index.

    *)
  4. type_ : lifecycle_policy_type;
    (*

    The type of lifecycle policy.

    *)
}
type nonrec collection_summary = {
  1. arn : string option;
    (*

    The Amazon Resource Name (ARN) of the collection.

    *)
  2. status : collection_status option;
    (*

    The current status of the collection.

    *)
  3. name : string option;
    (*

    The name of the collection.

    *)
  4. id : string option;
    (*

    The unique identifier of the collection.

    *)
}

Details about each OpenSearch Serverless collection.

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

    When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

    *)
  2. collection_summaries : collection_summary list option;
    (*

    Details about each collection.

    *)
}
type nonrec collection_filters = {
  1. status : collection_status option;
    (*

    The current status of the collection.

    *)
  2. name : string option;
    (*

    The name of the collection.

    *)
}

A list of filter keys that you can use for LIST, UPDATE, and DELETE requests to OpenSearch Serverless collections.

type nonrec list_collections_request = {
  1. max_results : int option;
    (*

    The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.

    *)
  2. next_token : string option;
    (*

    If your initial ListCollections operation returns a nextToken, you can include the returned nextToken in subsequent ListCollections operations, which returns results in the next page.

    *)
  3. collection_filters : collection_filters option;
    (*

    A list of filter names and values that you can use for requests.

    *)
}
type nonrec access_policy_summary = {
  1. last_modified_date : int option;
    (*

    The date and time when the collection was last modified.

    *)
  2. created_date : int option;
    (*

    The Epoch time when the access policy was created.

    *)
  3. description : string option;
    (*

    The description of the access policy.

    *)
  4. policy_version : string option;
    (*

    The version of the policy.

    *)
  5. name : string option;
    (*

    The name of the access policy.

    *)
  6. type_ : access_policy_type option;
    (*

    The type of access policy. Currently, the only available type is data.

    *)
}

A summary of the data access policy.

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

    When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

    *)
  2. access_policy_summaries : access_policy_summary list option;
    (*

    Details about the requested access policies.

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

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

    *)
  2. next_token : string option;
    (*

    If your initial ListAccessPolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListAccessPolicies operations, which returns results in the next page.

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

    Resource filters (can be collections or indexes) that policies can apply to.

    *)
  4. type_ : access_policy_type;
    (*

    The type of access policy.

    *)
}
type nonrec get_security_policy_response = {
  1. security_policy_detail : security_policy_detail option;
    (*

    Details about the requested security policy.

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

    The name of the security policy.

    *)
  2. type_ : security_policy_type;
    (*

    The type of security policy.

    *)
}
type nonrec get_security_config_response = {
  1. security_config_detail : security_config_detail option;
    (*

    Details of the requested security configuration.

    *)
}
type nonrec get_security_config_request = {
  1. id : string;
    (*

    The unique identifier of the security configuration.

    *)
}
type nonrec get_access_policy_response = {
  1. access_policy_detail : access_policy_detail option;
    (*

    Details about the requested access policy.

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

    The name of the access policy.

    *)
  2. type_ : access_policy_type;
    (*

    Tye type of policy. Currently, the only supported value is data.

    *)
}
type nonrec delete_vpc_endpoint_detail = {
  1. status : vpc_endpoint_status option;
    (*

    The current status of the endpoint deletion process.

    *)
  2. name : string option;
    (*

    The name of the endpoint.

    *)
  3. id : string option;
    (*

    The unique identifier of the endpoint.

    *)
}

Deletion details for an OpenSearch Serverless-managed interface endpoint.

type nonrec delete_vpc_endpoint_response = {
  1. delete_vpc_endpoint_detail : delete_vpc_endpoint_detail option;
    (*

    Details about the deleted endpoint.

    *)
}
type nonrec delete_vpc_endpoint_request = {
  1. client_token : string option;
    (*

    Unique, case-sensitive identifier to ensure idempotency of the request.

    *)
  2. id : string;
    (*

    The VPC endpoint identifier.

    *)
}
type nonrec delete_security_policy_request = {
  1. client_token : string option;
    (*

    Unique, case-sensitive identifier to ensure idempotency of the request.

    *)
  2. name : string;
    (*

    The name of the policy to delete.

    *)
  3. type_ : security_policy_type;
    (*

    The type of policy.

    *)
}
type nonrec delete_security_config_request = {
  1. client_token : string option;
    (*

    Unique, case-sensitive identifier to ensure idempotency of the request.

    *)
  2. id : string;
    (*

    The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.

    *)
}
type nonrec delete_lifecycle_policy_request = {
  1. client_token : string option;
    (*

    Unique, case-sensitive identifier to ensure idempotency of the request.

    *)
  2. name : string;
    (*

    The name of the policy to delete.

    *)
  3. type_ : lifecycle_policy_type;
    (*

    The type of lifecycle policy.

    *)
}
type nonrec delete_collection_detail = {
  1. status : collection_status option;
    (*

    The current status of the collection.

    *)
  2. name : string option;
    (*

    The name of the collection.

    *)
  3. id : string option;
    (*

    The unique identifier of the collection.

    *)
}

Details about a deleted OpenSearch Serverless collection.

type nonrec delete_collection_response = {
  1. delete_collection_detail : delete_collection_detail option;
    (*

    Details of the deleted collection.

    *)
}
type nonrec delete_collection_request = {
  1. client_token : string option;
    (*

    A unique, case-sensitive identifier to ensure idempotency of the request.

    *)
  2. id : string;
    (*

    The unique identifier of the collection. For example, 1iu5usc406kd. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.

    *)
}
type nonrec delete_access_policy_request = {
  1. client_token : string option;
    (*

    Unique, case-sensitive identifier to ensure idempotency of the request.

    *)
  2. name : string;
    (*

    The name of the policy to delete.

    *)
  3. type_ : access_policy_type;
    (*

    The type of policy.

    *)
}
type nonrec create_vpc_endpoint_detail = {
  1. status : vpc_endpoint_status option;
    (*

    The current status in the endpoint creation process.

    *)
  2. name : string option;
    (*

    The name of the endpoint.

    *)
  3. id : string option;
    (*

    The unique identifier of the endpoint.

    *)
}

Creation details for an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

type nonrec create_vpc_endpoint_response = {
  1. create_vpc_endpoint_detail : create_vpc_endpoint_detail option;
    (*

    Details about the created interface VPC endpoint.

    *)
}
type nonrec create_vpc_endpoint_request = {
  1. client_token : string option;
    (*

    Unique, case-sensitive identifier to ensure idempotency of the request.

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

    The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

    *)
  3. subnet_ids : string list;
    (*

    The ID of one or more subnets from which you'll access OpenSearch Serverless.

    *)
  4. vpc_id : string;
    (*

    The ID of the VPC from which you'll access OpenSearch Serverless.

    *)
  5. name : string;
    (*

    The name of the interface endpoint.

    *)
}
type nonrec create_security_config_response = {
  1. security_config_detail : security_config_detail option;
    (*

    Details about the created security configuration.

    *)
}
type nonrec create_security_config_request = {
  1. client_token : string option;
    (*

    Unique, case-sensitive identifier to ensure idempotency of the request.

    *)
  2. saml_options : saml_config_options option;
    (*

    Describes SAML options in in the form of a key-value map. This field is required if you specify saml for the type parameter.

    *)
  3. description : string option;
    (*

    A description of the security configuration.

    *)
  4. name : string;
    (*

    The name of the security configuration.

    *)
  5. type_ : security_config_type;
    (*

    The type of security configuration.

    *)
}
type nonrec create_collection_detail = {
  1. last_modified_date : int option;
    (*

    The date and time when the collection was last modified.

    *)
  2. created_date : int option;
    (*

    The Epoch time when the collection was created.

    *)
  3. standby_replicas : standby_replicas option;
    (*

    Creates details about an OpenSearch Serverless collection.

    *)
  4. kms_key_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.

    *)
  5. arn : string option;
    (*

    The Amazon Resource Name (ARN) of the collection.

    *)
  6. description : string option;
    (*

    A description of the collection.

    *)
  7. type_ : collection_type option;
    (*

    The type of collection.

    *)
  8. status : collection_status option;
    (*

    The current status of the collection.

    *)
  9. name : string option;
    (*

    The name of the collection.

    *)
  10. id : string option;
    (*

    The unique identifier of the collection.

    *)
}

Details about the created OpenSearch Serverless collection.

type nonrec create_collection_response = {
  1. create_collection_detail : create_collection_detail option;
    (*

    Details about the collection.

    *)
}
type nonrec create_collection_request = {
  1. client_token : string option;
    (*

    Unique, case-sensitive identifier to ensure idempotency of the request.

    *)
  2. standby_replicas : standby_replicas option;
    (*

    Indicates whether standby replicas should be used for a collection.

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

    An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

    *)
  4. description : string option;
    (*

    Description of the collection.

    *)
  5. type_ : collection_type option;
    (*

    The type of collection.

    *)
  6. name : string;
    (*

    Name of the collection.

    *)
}
type nonrec create_access_policy_response = {
  1. access_policy_detail : access_policy_detail option;
    (*

    Details about the created access policy.

    *)
}
type nonrec create_access_policy_request = {
  1. client_token : string option;
    (*

    Unique, case-sensitive identifier to ensure idempotency of the request.

    *)
  2. policy : string;
    (*

    The JSON policy document to use as the content for the policy.

    *)
  3. description : string option;
    (*

    A description of the policy. Typically used to store information about the permissions defined in the policy.

    *)
  4. name : string;
    (*

    The name of the policy.

    *)
  5. type_ : access_policy_type;
    (*

    The type of policy.

    *)
}

Builders

val make_vpc_endpoint_summary : ?status:vpc_endpoint_status -> ?name:string -> ?id:string -> unit -> vpc_endpoint_summary
val make_vpc_endpoint_filters : ?status:vpc_endpoint_status -> unit -> vpc_endpoint_filters
val make_vpc_endpoint_error_detail : ?error_code:string -> ?error_message:string -> ?id:string -> unit -> vpc_endpoint_error_detail
val make_vpc_endpoint_detail : ?created_date:int -> ?status:vpc_endpoint_status -> ?security_group_ids:string list -> ?subnet_ids:string list -> ?vpc_id:string -> ?name:string -> ?id:string -> unit -> vpc_endpoint_detail
val make_update_vpc_endpoint_detail : ?last_modified_date:int -> ?security_group_ids:string list -> ?subnet_ids:string list -> ?status:vpc_endpoint_status -> ?name:string -> ?id:string -> unit -> update_vpc_endpoint_detail
val make_update_vpc_endpoint_response : ?update_vpc_endpoint_detail:update_vpc_endpoint_detail -> unit -> update_vpc_endpoint_response
val make_update_vpc_endpoint_request : ?client_token:string -> ?remove_security_group_ids:string list -> ?add_security_group_ids:string list -> ?remove_subnet_ids:string list -> ?add_subnet_ids:string list -> id:string -> unit -> update_vpc_endpoint_request
val make_security_policy_detail : ?last_modified_date:int -> ?created_date:int -> ?policy:Smaws_Lib.CoreTypes.Document.t -> ?description:string -> ?policy_version:string -> ?name:string -> ?type_:security_policy_type -> unit -> security_policy_detail
val make_update_security_policy_response : ?security_policy_detail:security_policy_detail -> unit -> update_security_policy_response
val make_update_security_policy_request : ?client_token:string -> ?policy:string -> ?description:string -> policy_version:string -> name:string -> type_:security_policy_type -> unit -> update_security_policy_request
val make_saml_config_options : ?session_timeout:int -> ?group_attribute:string -> ?user_attribute:string -> metadata:string -> unit -> saml_config_options
val make_security_config_detail : ?last_modified_date:int -> ?created_date:int -> ?saml_options:saml_config_options -> ?description:string -> ?config_version:string -> ?type_:security_config_type -> ?id:string -> unit -> security_config_detail
val make_update_security_config_response : ?security_config_detail:security_config_detail -> unit -> update_security_config_response
val make_update_security_config_request : ?client_token:string -> ?saml_options:saml_config_options -> ?description:string -> config_version:string -> id:string -> unit -> update_security_config_request
val make_lifecycle_policy_detail : ?last_modified_date:int -> ?created_date:int -> ?policy:Smaws_Lib.CoreTypes.Document.t -> ?description:string -> ?policy_version:string -> ?name:string -> ?type_:lifecycle_policy_type -> unit -> lifecycle_policy_detail
val make_update_lifecycle_policy_response : ?lifecycle_policy_detail:lifecycle_policy_detail -> unit -> update_lifecycle_policy_response
val make_update_lifecycle_policy_request : ?client_token:string -> ?policy:string -> ?description:string -> policy_version:string -> name:string -> type_:lifecycle_policy_type -> unit -> update_lifecycle_policy_request
val make_update_collection_detail : ?last_modified_date:int -> ?created_date:int -> ?arn:string -> ?description:string -> ?type_:collection_type -> ?status:collection_status -> ?name:string -> ?id:string -> unit -> update_collection_detail
val make_update_collection_response : ?update_collection_detail:update_collection_detail -> unit -> update_collection_response
val make_update_collection_request : ?client_token:string -> ?description:string -> id:string -> unit -> update_collection_request
val make_capacity_limits : ?max_search_capacity_in_oc_u:int -> ?max_indexing_capacity_in_oc_u:int -> unit -> capacity_limits
val make_account_settings_detail : ?capacity_limits:capacity_limits -> unit -> account_settings_detail
val make_update_account_settings_response : ?account_settings_detail:account_settings_detail -> unit -> update_account_settings_response
val make_update_account_settings_request : ?capacity_limits:capacity_limits -> unit -> update_account_settings_request
val make_access_policy_detail : ?last_modified_date:int -> ?created_date:int -> ?policy:Smaws_Lib.CoreTypes.Document.t -> ?description:string -> ?policy_version:string -> ?name:string -> ?type_:access_policy_type -> unit -> access_policy_detail
val make_update_access_policy_response : ?access_policy_detail:access_policy_detail -> unit -> update_access_policy_response
val make_update_access_policy_request : ?client_token:string -> ?policy:string -> ?description:string -> policy_version:string -> name:string -> type_:access_policy_type -> unit -> update_access_policy_request
val make_untag_resource_response : unit -> unit
val make_untag_resource_request : tag_keys:string list -> resource_arn:string -> unit -> untag_resource_request
val make_tag : value:string -> key:string -> unit -> tag
val make_tag_resource_response : unit -> unit
val make_tag_resource_request : tags:tag list -> resource_arn:string -> unit -> tag_resource_request
val make_security_policy_summary : ?last_modified_date:int -> ?created_date:int -> ?description:string -> ?policy_version:string -> ?name:string -> ?type_:security_policy_type -> unit -> security_policy_summary
val make_security_policy_stats : ?network_policy_count:int -> ?encryption_policy_count:int -> unit -> security_policy_stats
val make_security_config_summary : ?last_modified_date:int -> ?created_date:int -> ?description:string -> ?config_version:string -> ?type_:security_config_type -> ?id:string -> unit -> security_config_summary
val make_security_config_stats : ?saml_config_count:int -> unit -> security_config_stats
val make_list_tags_for_resource_response : ?tags:tag list -> unit -> list_tags_for_resource_response
val make_list_tags_for_resource_request : resource_arn:string -> unit -> list_tags_for_resource_request
val make_access_policy_stats : ?data_policy_count:int -> unit -> access_policy_stats
val make_lifecycle_policy_stats : ?retention_policy_count:int -> unit -> lifecycle_policy_stats
val make_get_policies_stats_response : ?total_policy_count:int -> ?lifecycle_policy_stats:lifecycle_policy_stats -> ?security_config_stats:security_config_stats -> ?security_policy_stats:security_policy_stats -> ?access_policy_stats:access_policy_stats -> unit -> get_policies_stats_response
val make_get_policies_stats_request : unit -> unit
val make_get_account_settings_response : ?account_settings_detail:account_settings_detail -> unit -> get_account_settings_response
val make_get_account_settings_request : unit -> unit
val make_create_security_policy_response : ?security_policy_detail:security_policy_detail -> unit -> create_security_policy_response
val make_create_security_policy_request : ?client_token:string -> ?description:string -> policy:string -> name:string -> type_:security_policy_type -> unit -> create_security_policy_request
val make_create_lifecycle_policy_response : ?lifecycle_policy_detail:lifecycle_policy_detail -> unit -> create_lifecycle_policy_response
val make_create_lifecycle_policy_request : ?client_token:string -> ?description:string -> policy:string -> name:string -> type_:lifecycle_policy_type -> unit -> create_lifecycle_policy_request
val make_batch_get_vpc_endpoint_response : ?vpc_endpoint_error_details:vpc_endpoint_error_detail list -> ?vpc_endpoint_details:vpc_endpoint_detail list -> unit -> batch_get_vpc_endpoint_response
val make_batch_get_vpc_endpoint_request : ids:string list -> unit -> batch_get_vpc_endpoint_request
val make_lifecycle_policy_error_detail : ?error_code:string -> ?error_message:string -> ?name:string -> ?type_:lifecycle_policy_type -> unit -> lifecycle_policy_error_detail
val make_batch_get_lifecycle_policy_response : ?lifecycle_policy_error_details:lifecycle_policy_error_detail list -> ?lifecycle_policy_details:lifecycle_policy_detail list -> unit -> batch_get_lifecycle_policy_response
val make_lifecycle_policy_identifier : name:string -> type_:lifecycle_policy_type -> unit -> lifecycle_policy_identifier
val make_batch_get_lifecycle_policy_request : identifiers:lifecycle_policy_identifier list -> unit -> batch_get_lifecycle_policy_request
val make_effective_lifecycle_policy_detail : ?no_min_retention_period:bool -> ?retention_period:string -> ?resource_type:resource_type -> ?policy_name:string -> ?resource:string -> ?type_:lifecycle_policy_type -> unit -> effective_lifecycle_policy_detail
val make_effective_lifecycle_policy_error_detail : ?error_code:string -> ?error_message:string -> ?resource:string -> ?type_:lifecycle_policy_type -> unit -> effective_lifecycle_policy_error_detail
val make_batch_get_effective_lifecycle_policy_response : ?effective_lifecycle_policy_error_details: effective_lifecycle_policy_error_detail list -> ?effective_lifecycle_policy_details:effective_lifecycle_policy_detail list -> unit -> batch_get_effective_lifecycle_policy_response
val make_lifecycle_policy_resource_identifier : resource:string -> type_:lifecycle_policy_type -> unit -> lifecycle_policy_resource_identifier
val make_batch_get_effective_lifecycle_policy_request : resource_identifiers:lifecycle_policy_resource_identifier list -> unit -> batch_get_effective_lifecycle_policy_request
val make_collection_detail : ?dashboard_endpoint:string -> ?collection_endpoint:string -> ?last_modified_date:int -> ?created_date:int -> ?standby_replicas:standby_replicas -> ?kms_key_arn:string -> ?arn:string -> ?description:string -> ?type_:collection_type -> ?status:collection_status -> ?name:string -> ?id:string -> unit -> collection_detail
val make_collection_error_detail : ?error_code:string -> ?error_message:string -> ?name:string -> ?id:string -> unit -> collection_error_detail
val make_batch_get_collection_response : ?collection_error_details:collection_error_detail list -> ?collection_details:collection_detail list -> unit -> batch_get_collection_response
val make_batch_get_collection_request : ?names:string list -> ?ids:string list -> unit -> batch_get_collection_request
val make_list_vpc_endpoints_response : ?next_token:string -> ?vpc_endpoint_summaries:vpc_endpoint_summary list -> unit -> list_vpc_endpoints_response
val make_list_vpc_endpoints_request : ?max_results:int -> ?next_token:string -> ?vpc_endpoint_filters:vpc_endpoint_filters -> unit -> list_vpc_endpoints_request
val make_list_security_policies_response : ?next_token:string -> ?security_policy_summaries:security_policy_summary list -> unit -> list_security_policies_response
val make_list_security_policies_request : ?max_results:int -> ?next_token:string -> ?resource:string list -> type_:security_policy_type -> unit -> list_security_policies_request
val make_list_security_configs_response : ?next_token:string -> ?security_config_summaries:security_config_summary list -> unit -> list_security_configs_response
val make_list_security_configs_request : ?max_results:int -> ?next_token:string -> type_:security_config_type -> unit -> list_security_configs_request
val make_lifecycle_policy_summary : ?last_modified_date:int -> ?created_date:int -> ?description:string -> ?policy_version:string -> ?name:string -> ?type_:lifecycle_policy_type -> unit -> lifecycle_policy_summary
val make_list_lifecycle_policies_response : ?next_token:string -> ?lifecycle_policy_summaries:lifecycle_policy_summary list -> unit -> list_lifecycle_policies_response
val make_list_lifecycle_policies_request : ?max_results:int -> ?next_token:string -> ?resources:string list -> type_:lifecycle_policy_type -> unit -> list_lifecycle_policies_request
val make_collection_summary : ?arn:string -> ?status:collection_status -> ?name:string -> ?id:string -> unit -> collection_summary
val make_list_collections_response : ?next_token:string -> ?collection_summaries:collection_summary list -> unit -> list_collections_response
val make_collection_filters : ?status:collection_status -> ?name:string -> unit -> collection_filters
val make_list_collections_request : ?max_results:int -> ?next_token:string -> ?collection_filters:collection_filters -> unit -> list_collections_request
val make_access_policy_summary : ?last_modified_date:int -> ?created_date:int -> ?description:string -> ?policy_version:string -> ?name:string -> ?type_:access_policy_type -> unit -> access_policy_summary
val make_list_access_policies_response : ?next_token:string -> ?access_policy_summaries:access_policy_summary list -> unit -> list_access_policies_response
val make_list_access_policies_request : ?max_results:int -> ?next_token:string -> ?resource:string list -> type_:access_policy_type -> unit -> list_access_policies_request
val make_get_security_policy_response : ?security_policy_detail:security_policy_detail -> unit -> get_security_policy_response
val make_get_security_policy_request : name:string -> type_:security_policy_type -> unit -> get_security_policy_request
val make_get_security_config_response : ?security_config_detail:security_config_detail -> unit -> get_security_config_response
val make_get_security_config_request : id:string -> unit -> get_security_config_request
val make_get_access_policy_response : ?access_policy_detail:access_policy_detail -> unit -> get_access_policy_response
val make_get_access_policy_request : name:string -> type_:access_policy_type -> unit -> get_access_policy_request
val make_delete_vpc_endpoint_detail : ?status:vpc_endpoint_status -> ?name:string -> ?id:string -> unit -> delete_vpc_endpoint_detail
val make_delete_vpc_endpoint_response : ?delete_vpc_endpoint_detail:delete_vpc_endpoint_detail -> unit -> delete_vpc_endpoint_response
val make_delete_vpc_endpoint_request : ?client_token:string -> id:string -> unit -> delete_vpc_endpoint_request
val make_delete_security_policy_response : unit -> unit
val make_delete_security_policy_request : ?client_token:string -> name:string -> type_:security_policy_type -> unit -> delete_security_policy_request
val make_delete_security_config_response : unit -> unit
val make_delete_security_config_request : ?client_token:string -> id:string -> unit -> delete_security_config_request
val make_delete_lifecycle_policy_response : unit -> unit
val make_delete_lifecycle_policy_request : ?client_token:string -> name:string -> type_:lifecycle_policy_type -> unit -> delete_lifecycle_policy_request
val make_delete_collection_detail : ?status:collection_status -> ?name:string -> ?id:string -> unit -> delete_collection_detail
val make_delete_collection_response : ?delete_collection_detail:delete_collection_detail -> unit -> delete_collection_response
val make_delete_collection_request : ?client_token:string -> id:string -> unit -> delete_collection_request
val make_delete_access_policy_response : unit -> unit
val make_delete_access_policy_request : ?client_token:string -> name:string -> type_:access_policy_type -> unit -> delete_access_policy_request
val make_create_vpc_endpoint_detail : ?status:vpc_endpoint_status -> ?name:string -> ?id:string -> unit -> create_vpc_endpoint_detail
val make_create_vpc_endpoint_response : ?create_vpc_endpoint_detail:create_vpc_endpoint_detail -> unit -> create_vpc_endpoint_response
val make_create_vpc_endpoint_request : ?client_token:string -> ?security_group_ids:string list -> subnet_ids:string list -> vpc_id:string -> name:string -> unit -> create_vpc_endpoint_request
val make_create_security_config_response : ?security_config_detail:security_config_detail -> unit -> create_security_config_response
val make_create_security_config_request : ?client_token:string -> ?saml_options:saml_config_options -> ?description:string -> name:string -> type_:security_config_type -> unit -> create_security_config_request
val make_create_collection_detail : ?last_modified_date:int -> ?created_date:int -> ?standby_replicas:standby_replicas -> ?kms_key_arn:string -> ?arn:string -> ?description:string -> ?type_:collection_type -> ?status:collection_status -> ?name:string -> ?id:string -> unit -> create_collection_detail
val make_create_collection_response : ?create_collection_detail:create_collection_detail -> unit -> create_collection_response
val make_create_collection_request : ?client_token:string -> ?standby_replicas:standby_replicas -> ?tags:tag list -> ?description:string -> ?type_:collection_type -> name:string -> unit -> create_collection_request
val make_create_access_policy_response : ?access_policy_detail:access_policy_detail -> unit -> create_access_policy_response
val make_create_access_policy_request : ?client_token:string -> ?description:string -> policy:string -> name:string -> type_:access_policy_type -> unit -> create_access_policy_request

Operations

module CreateAccessPolicy : sig ... end

Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the resources within them, and allow a user to access that data irrespective of the access mechanism or network source. For more information, see Data access control for Amazon OpenSearch Serverless.

module CreateCollection : sig ... end

Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

module CreateSecurityConfig : sig ... end

Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

module CreateVpcEndpoint : sig ... end

Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

module DeleteAccessPolicy : sig ... end

Deletes an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.

module DeleteCollection : sig ... end

Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

module DeleteLifecyclePolicy : sig ... end

Deletes an OpenSearch Serverless lifecycle policy. For more information, see Deleting data lifecycle policies.

module DeleteSecurityConfig : sig ... end

Deletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

module DeleteSecurityPolicy : sig ... end

Deletes an OpenSearch Serverless security policy.

module DeleteVpcEndpoint : sig ... end

Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

module GetAccessPolicy : sig ... end

Returns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.

module GetSecurityConfig : sig ... end

Returns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless.

module GetSecurityPolicy : sig ... end

Returns information about a configured OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.

module ListAccessPolicies : sig ... end

Returns information about a list of OpenSearch Serverless access policies.

module ListCollections : sig ... end

Lists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

module ListLifecyclePolicies : sig ... end

Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.

module ListSecurityConfigs : sig ... end

Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless.

module ListSecurityPolicies : sig ... end

Returns information about configured OpenSearch Serverless security policies.

module ListVpcEndpoints : sig ... end

Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

module BatchGetCollection : sig ... end

Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information, see Viewing data lifecycle policies.

module BatchGetLifecyclePolicy : sig ... end

Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.

module BatchGetVpcEndpoint : sig ... end

Returns attributes for one or more VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

module CreateLifecyclePolicy : sig ... end

Creates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle policies define the number of days or hours to retain the data on an OpenSearch Serverless index. For more information, see Creating data lifecycle policies.

module CreateSecurityPolicy : sig ... end

Creates a security policy to be used by one or more OpenSearch Serverless collections. Security policies provide access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. They also allow you to secure a collection with a KMS encryption key. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.

module GetAccountSettings : sig ... end

Returns account-level settings related to OpenSearch Serverless.

module GetPoliciesStats : sig ... end

Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.

module ListTagsForResource : sig ... end

Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

module TagResource : sig ... end

Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

module UntagResource : sig ... end

Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

module UpdateAccessPolicy : sig ... end

Updates an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.

module UpdateAccountSettings : sig ... end

Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.

module UpdateCollection : sig ... end

Updates an OpenSearch Serverless collection.

module UpdateLifecyclePolicy : sig ... end

Updates an OpenSearch Serverless access policy. For more information, see Updating data lifecycle policies.

module UpdateSecurityConfig : sig ... end

Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

module UpdateSecurityPolicy : sig ... end

Updates an OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.

module UpdateVpcEndpoint : sig ... end

Updates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.