Smaws_Client_OpenSearchServerless.Typestype nonrec vpc_endpoint_summary = {status : vpc_endpoint_status option;The current status of the endpoint.
*)name : vpc_endpoint_name option;The name of the endpoint.
*)id : vpc_endpoint_id option;The unique identifier of the endpoint.
*)}The VPC endpoint object.
type nonrec vpc_endpoint_summaries = vpc_endpoint_summary listtype nonrec vpc_endpoint_ids = vpc_endpoint_id listtype nonrec vpc_endpoint_filters = {status : vpc_endpoint_status option;The current status of the endpoint.
*)}Filter the results of a ListVpcEndpoints request.
type nonrec vpc_endpoint_error_detail = {error_code : Smaws_Lib.Smithy_api.Types.string_ option;The error code for the failed request.
*)error_message : Smaws_Lib.Smithy_api.Types.string_ option;An error message describing the reason for the failure.
*)id : vpc_endpoint_id option;The unique identifier of the VPC endpoint.
*)}Error information for a failed BatchGetVpcEndpoint request.
type nonrec vpc_endpoint_error_details = vpc_endpoint_error_detail listtype nonrec subnet_ids = subnet_id listtype nonrec security_group_ids = security_group_id listtype nonrec vpc_endpoint_detail = {failure_message : Smaws_Lib.Smithy_api.Types.string_ option;A message associated with the failure code.
*)failure_code : Smaws_Lib.Smithy_api.Types.string_ option;A failure code associated with the request.
*)created_date : Smaws_Lib.Smithy_api.Types.long option;The date the endpoint was created.
*)status : vpc_endpoint_status option;The current status of the endpoint.
*)security_group_ids : security_group_ids 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.
*)subnet_ids : subnet_ids option;The ID of the subnets from which you access OpenSearch Serverless.
*)vpc_id : vpc_id option;The ID of the VPC from which you access OpenSearch Serverless.
*)name : vpc_endpoint_name option;The name of the endpoint.
*)id : vpc_endpoint_id option;The unique identifier of the endpoint.
*)}Details about an OpenSearch Serverless-managed interface endpoint.
type nonrec vpc_endpoint_details = vpc_endpoint_detail listtype nonrec vpc_endpoint = Smaws_Lib.CoreTypes.Resource.tThrown when the HTTP request contains invalid input or is missing required input.
type nonrec update_vpc_endpoint_detail = {last_modified_date : Smaws_Lib.Smithy_api.Types.long option;The timestamp of when the endpoint was last modified.
*)security_group_ids : security_group_ids 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.
*)subnet_ids : subnet_ids option;The ID of the subnets from which you access OpenSearch Serverless.
*)status : vpc_endpoint_status option;The current status of the endpoint update process.
*)name : vpc_endpoint_name option;The name of the endpoint.
*)id : vpc_endpoint_id option;The unique identifier of the endpoint.
*)}Update details for an OpenSearch Serverless-managed interface endpoint.
type nonrec update_vpc_endpoint_response = {update_vpc_endpoint_detail : update_vpc_endpoint_detail option;Details about the updated VPC endpoint.
*)}type nonrec update_vpc_endpoint_request = {client_token : client_token option;Unique, case-sensitive identifier to ensure idempotency of the request.
*)remove_security_group_ids : security_group_ids option;The unique identifiers of the security groups to remove from the endpoint.
*)add_security_group_ids : security_group_ids 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.
*)remove_subnet_ids : subnet_ids option;The unique identifiers of the subnets to remove from the endpoint.
*)add_subnet_ids : subnet_ids option;The ID of one or more subnets to add to the endpoint.
*)id : vpc_endpoint_id;The unique identifier of the interface endpoint to update.
*)}Thrown when an error internal to the service occurs while processing a request.
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_detail = {last_modified_date : Smaws_Lib.Smithy_api.Types.long option;The timestamp of when the policy was last modified.
*)created_date : Smaws_Lib.Smithy_api.Types.long option;The date the policy was created.
*)policy : Smaws_Lib.Smithy_api.Types.document option;The JSON policy document without any whitespaces.
*)description : policy_description option;The description of the security policy.
*)policy_version : policy_version option;The version of the policy.
*)name : policy_name option;The name of the policy.
*)type_ : security_policy_type option;The type of security policy.
*)}Details about an OpenSearch Serverless security policy.
type nonrec update_security_policy_response = {security_policy_detail : security_policy_detail option;Details about the updated security policy.
*)}type nonrec update_security_policy_request = {client_token : client_token option;Unique, case-sensitive identifier to ensure idempotency of the request.
*)policy : policy_document option;The JSON policy document to use as the content for the new policy.
*)description : policy_description option;A description of the policy. Typically used to store information about the permissions defined in the policy.
*)policy_version : policy_version;The version of the policy being updated.
*)name : policy_name;The name of the policy.
*)type_ : security_policy_type;The type of access policy.
*)}type nonrec service_quota_exceeded_exception = {quota_code : Smaws_Lib.Smithy_api.Types.string_ option;Service Quotas requirement to identify originating quota.
*)service_code : Smaws_Lib.Smithy_api.Types.string_;Service Quotas requirement to identify originating service.
*)resource_type : Smaws_Lib.Smithy_api.Types.string_ option;Type of the resource affected.
*)resource_id : Smaws_Lib.Smithy_api.Types.string_ option;Identifier of the resource affected.
*)message : Smaws_Lib.Smithy_api.Types.string_;Description of the error.
*)}Thrown when you attempt to create more resources than the service allows based on service quotas.
Thrown when accessing or deleting a resource that does not exist.
type nonrec saml_config_options = {session_timeout : Smaws_Lib.Smithy_api.Types.integer option;The session timeout, in minutes. Default is 60 minutes (12 hours).
*)open_search_serverless_entity_id : open_search_serverless_entity_id option;Custom entity id attribute to override default entity id for this saml integration.
*)group_attribute : saml_group_attribute option;The group attribute for this SAML integration.
*)user_attribute : saml_user_attribute option;A user attribute for this SAML integration.
*)metadata : saml_metadata;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 iam_identity_center_config_options = {group_attribute : iam_identity_center_group_attribute option;The group attribute for this IAM Identity Center integration. Defaults to GroupId.
user_attribute : iam_identity_center_user_attribute option;The user attribute for this IAM Identity Center integration. Defaults to UserId
application_description : Smaws_Lib.Smithy_api.Types.string_ option;The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.
*)application_name : Smaws_Lib.Smithy_api.Types.string_ option;The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.
*)application_arn : iam_identity_center_application_arn option;The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.
*)instance_arn : iam_identity_center_instance_arn option;The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.
*)}Describes IAM Identity Center options for an OpenSearch Serverless security configuration in the form of a key-value map.
type nonrec security_config_detail = {last_modified_date : Smaws_Lib.Smithy_api.Types.long option;The timestamp of when the configuration was last modified.
*)created_date : Smaws_Lib.Smithy_api.Types.long option;The date the configuration was created.
*)iam_identity_center_options : iam_identity_center_config_options option;Describes IAM Identity Center options in the form of a key-value map.
*)saml_options : saml_config_options option;SAML options for the security configuration in the form of a key-value map.
*)description : config_description option;The description of the security configuration.
*)config_version : policy_version option;The version of the security configuration.
*)type_ : security_config_type option;The type of security configuration.
*)id : security_config_id option;The unique identifier of the security configuration.
*)}Details about a security configuration for OpenSearch Serverless.
type nonrec update_security_config_response = {security_config_detail : security_config_detail option;Details about the updated security configuration.
*)}type nonrec update_iam_identity_center_config_options = {group_attribute : iam_identity_center_group_attribute option;The group attribute for this IAM Identity Center integration. Defaults to GroupId.
user_attribute : iam_identity_center_user_attribute option;The user attribute for this IAM Identity Center integration. Defaults to UserId.
}Describes IAM Identity Center options for updating an OpenSearch Serverless security configuration in the form of a key-value map.
type nonrec update_security_config_request = {client_token : client_token option;Unique, case-sensitive identifier to ensure idempotency of the request.
*)iam_identity_center_options_updates : update_iam_identity_center_config_options
option;Describes IAM Identity Center options in the form of a key-value map.
*)saml_options : saml_config_options option;SAML options in in the form of a key-value map.
*)description : config_description option;A description of the security configuration.
*)config_version : policy_version;The version of the security configuration to be updated. You can find the most recent version of a security configuration using the GetSecurityPolicy command.
id : security_config_id;The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.
}type nonrec lifecycle_policy_detail = {last_modified_date : Smaws_Lib.Smithy_api.Types.long option;The timestamp of when the lifecycle policy was last modified.
*)created_date : Smaws_Lib.Smithy_api.Types.long option;The date the lifecycle policy was created.
*)policy : Smaws_Lib.Smithy_api.Types.document option;The JSON policy document without any whitespaces.
*)description : policy_description option;The description of the lifecycle policy.
*)policy_version : policy_version option;The version of the lifecycle policy.
*)name : policy_name option;The name of the lifecycle policy.
*)type_ : lifecycle_policy_type option;The type of lifecycle policy.
*)}Details about an OpenSearch Serverless lifecycle policy.
type nonrec update_lifecycle_policy_response = {lifecycle_policy_detail : lifecycle_policy_detail option;Details about the updated lifecycle policy.
*)}type nonrec update_lifecycle_policy_request = {client_token : client_token option;A unique, case-sensitive identifier to ensure idempotency of the request.
*)policy : policy_document option;The JSON policy document to use as the content for the lifecycle policy.
*)description : policy_description option;A description of the lifecycle policy.
*)policy_version : policy_version;The version of the policy being updated.
*)name : policy_name;The name of the policy.
*)type_ : lifecycle_policy_type;The type of lifecycle policy.
*)}type nonrec update_collection_detail = {last_modified_date : Smaws_Lib.Smithy_api.Types.long option;The date and time when the collection was last modified.
*)created_date : Smaws_Lib.Smithy_api.Types.long option;The date and time when the collection was created.
*)arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) of the collection.
*)description : Smaws_Lib.Smithy_api.Types.string_ option;The description of the collection.
*)type_ : collection_type option;The collection type.
*)status : collection_status option;The current status of the collection.
*)name : collection_name option;The name of the collection.
*)id : collection_id option;The unique identifier of the collection.
*)}Details about an updated OpenSearch Serverless collection.
type nonrec update_collection_response = {update_collection_detail : update_collection_detail option;Details about the updated collection.
*)}type nonrec update_collection_request = {client_token : client_token option;Unique, case-sensitive identifier to ensure idempotency of the request.
*)description : Smaws_Lib.Smithy_api.Types.string_ option;A description of the collection.
*)id : collection_id;The unique identifier of the collection.
*)}type nonrec capacity_limits = {max_search_capacity_in_oc_u : search_capacity_value option;The maximum search capacity for collections.
*)max_indexing_capacity_in_oc_u : indexing_capacity_value 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.
OpenSearch Serverless-related information for the current account.
type nonrec update_account_settings_response = {account_settings_detail : account_settings_detail option;OpenSearch Serverless-related settings for the current Amazon Web Services account.
*)}type nonrec access_policy_detail = {last_modified_date : Smaws_Lib.Smithy_api.Types.long option;The timestamp of when the policy was last modified.
*)created_date : Smaws_Lib.Smithy_api.Types.long option;The date the policy was created.
*)policy : Smaws_Lib.Smithy_api.Types.document option;The JSON policy document without any whitespaces.
*)description : policy_description option;The description of the policy.
*)policy_version : policy_version option;The version of the policy.
*)name : policy_name option;The name of the policy.
*)type_ : access_policy_type option;The type of access policy.
*)}Details about an OpenSearch Serverless access policy.
type nonrec update_access_policy_response = {access_policy_detail : access_policy_detail option;Details about the updated access policy.
*)}type nonrec update_access_policy_request = {client_token : client_token option;Unique, case-sensitive identifier to ensure idempotency of the request.
*)policy : policy_document option;The JSON policy document to use as the content for the policy.
*)description : policy_description option;A description of the policy. Typically used to store information about the permissions defined in the policy.
*)policy_version : policy_version;The version of the policy being updated.
*)name : policy_name;The name of the policy.
*)type_ : access_policy_type;The type of policy.
*)}type nonrec tag_keys = tag_key listtype nonrec untag_resource_request = {tag_keys : tag_keys;The tag or set of tags to remove from the resource. All tag keys in the request must be unique.
*)resource_arn : arn;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 tags = tag listtype nonrec tag_resource_request = {resource_arn : arn;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 security_policy_summary = {last_modified_date : Smaws_Lib.Smithy_api.Types.long option;The timestamp of when the policy was last modified.
*)created_date : Smaws_Lib.Smithy_api.Types.long option;The date the policy was created.
*)description : policy_description option;The description of the security policy.
*)policy_version : policy_version option;The version of the policy.
*)name : policy_name option;The name of the policy.
*)type_ : security_policy_type option;The type of security policy.
*)}A summary of a security policy for OpenSearch Serverless.
type nonrec security_policy_summaries = security_policy_summary listtype nonrec security_policy_stats = {network_policy_count : Smaws_Lib.Smithy_api.Types.long option;The number of network policies in the current account.
*)encryption_policy_count : Smaws_Lib.Smithy_api.Types.long option;The number of encryption policies in the current account.
*)}Statistics for an OpenSearch Serverless security policy.
type nonrec security_policy = Smaws_Lib.CoreTypes.Resource.ttype nonrec security_config_summary = {last_modified_date : Smaws_Lib.Smithy_api.Types.long option;The timestamp of when the configuration was last modified.
*)created_date : Smaws_Lib.Smithy_api.Types.long option;The Epoch time when the security configuration was created.
*)description : config_description option;The description of the security configuration.
*)config_version : policy_version option;The version of the security configuration.
*)type_ : security_config_type option;The type of security configuration.
*)id : security_config_id option;The unique identifier of the security configuration.
*)}A summary of a security configuration for OpenSearch Serverless.
type nonrec security_config_summaries = security_config_summary listtype nonrec security_config_stats = {saml_config_count : Smaws_Lib.Smithy_api.Types.long option;The number of security configurations in the current account.
*)}Statistics for an OpenSearch Serverless security configuration.
type nonrec security_config = Smaws_Lib.CoreTypes.Resource.ttype nonrec resource_filter = resource listtype nonrec access_policy_stats = {data_policy_count : Smaws_Lib.Smithy_api.Types.long option;The number of data access policies in the current account.
*)}Statistics for an OpenSearch Serverless access policy.
type nonrec lifecycle_policy_stats = {retention_policy_count : Smaws_Lib.Smithy_api.Types.long option;The number of retention lifecycle policies in the current account.
*)}Statistics for an OpenSearch Serverless lifecycle policy.
type nonrec get_policies_stats_response = {total_policy_count : Smaws_Lib.Smithy_api.Types.long option;The total number of OpenSearch Serverless security policies and configurations in your account.
*)lifecycle_policy_stats : lifecycle_policy_stats option;Information about the lifecycle policies in your account.
*)security_config_stats : security_config_stats option;Information about the security configurations in your account.
*)security_policy_stats : security_policy_stats option;Information about the security policies in your account.
*)access_policy_stats : access_policy_stats option;Information about the data access policies in your account.
*)}type nonrec get_account_settings_response = {account_settings_detail : account_settings_detail option;OpenSearch Serverless-related details for the current account.
*)}type nonrec create_security_policy_response = {security_policy_detail : security_policy_detail option;Details about the created security policy.
*)}type nonrec create_security_policy_request = {client_token : client_token option;Unique, case-sensitive identifier to ensure idempotency of the request.
*)policy : policy_document;The JSON policy document to use as the content for the new policy.
*)description : policy_description option;A description of the policy. Typically used to store information about the permissions defined in the policy.
*)name : policy_name;The name of the policy.
*)type_ : security_policy_type;The type of security policy.
*)}type nonrec create_lifecycle_policy_response = {lifecycle_policy_detail : lifecycle_policy_detail option;Details about the created lifecycle policy.
*)}type nonrec create_lifecycle_policy_request = {client_token : client_token option;A unique, case-sensitive identifier to ensure idempotency of the request.
*)policy : policy_document;The JSON policy document to use as the content for the lifecycle policy.
*)description : policy_description option;A description of the lifecycle policy.
*)name : policy_name;The name of the lifecycle policy.
*)type_ : lifecycle_policy_type;The type of lifecycle policy.
*)}type nonrec batch_get_vpc_endpoint_response = {vpc_endpoint_error_details : vpc_endpoint_error_details option;Error information for a failed request.
*)vpc_endpoint_details : vpc_endpoint_details option;Details about the specified VPC endpoint.
*)}type nonrec batch_get_vpc_endpoint_request = {ids : vpc_endpoint_ids;A list of VPC endpoint identifiers.
*)}type nonrec lifecycle_policy_details = lifecycle_policy_detail listtype nonrec lifecycle_policy_error_detail = {error_code : Smaws_Lib.Smithy_api.Types.string_ option;The error code for the request. For example, NOT_FOUND.
error_message : Smaws_Lib.Smithy_api.Types.string_ option;A description of the error. For example, The specified Lifecycle Policy is not found.
name : policy_name option;The name of the lifecycle policy.
*)type_ : lifecycle_policy_type option;The type of lifecycle policy.
*)}Error information for an OpenSearch Serverless request.
type nonrec lifecycle_policy_error_details = lifecycle_policy_error_detail listtype nonrec batch_get_lifecycle_policy_response = {lifecycle_policy_error_details : lifecycle_policy_error_details option;A list of lifecycle policy names and policy types for which retrieval failed.
*)lifecycle_policy_details : lifecycle_policy_details option;A list of lifecycle policies matched to the input policy name and policy type.
*)}type nonrec lifecycle_policy_identifier = {name : policy_name;The name of the lifecycle policy.
*)type_ : lifecycle_policy_type;The type of lifecycle policy.
*)}The unique identifiers of policy types and policy names.
type nonrec lifecycle_policy_identifiers = lifecycle_policy_identifier listtype nonrec batch_get_lifecycle_policy_request = {identifiers : lifecycle_policy_identifiers;The unique identifiers of policy types and policy names.
*)}type nonrec effective_lifecycle_policy_detail = {no_min_retention_period : Smaws_Lib.Smithy_api.Types.boolean_ 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.
retention_period : Smaws_Lib.Smithy_api.Types.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.
*)resource_type : resource_type option;The type of OpenSearch Serverless resource. Currently, the only supported resource is index.
policy_name : policy_name option;The name of the lifecycle policy.
*)resource : resource option;The name of the OpenSearch Serverless index resource.
*)type_ : lifecycle_policy_type option;The type of lifecycle policy.
*)}Error information for an OpenSearch Serverless request.
type nonrec effective_lifecycle_policy_details =
effective_lifecycle_policy_detail listtype nonrec effective_lifecycle_policy_error_detail = {error_code : Smaws_Lib.Smithy_api.Types.string_ option;The error code for the request.
*)error_message : Smaws_Lib.Smithy_api.Types.string_ option;A description of the error. For example, The specified Index resource is not found.
resource : resource option;The name of OpenSearch Serverless index resource.
*)type_ : lifecycle_policy_type option;The type of lifecycle policy.
*)}Error information for an OpenSearch Serverless request.
type nonrec effective_lifecycle_policy_error_details =
effective_lifecycle_policy_error_detail listtype nonrec batch_get_effective_lifecycle_policy_response = {effective_lifecycle_policy_error_details : effective_lifecycle_policy_error_details
option;A list of resources for which retrieval failed.
*)effective_lifecycle_policy_details : effective_lifecycle_policy_details option;A list of lifecycle policies applied to the OpenSearch Serverless indexes.
*)}type nonrec lifecycle_policy_resource_identifier = {resource : resource_name;The name of the OpenSearch Serverless ilndex resource.
*)type_ : lifecycle_policy_type;The type of lifecycle policy.
*)}The unique identifiers of policy types and resource names.
type nonrec lifecycle_policy_resource_identifiers =
lifecycle_policy_resource_identifier listtype nonrec batch_get_effective_lifecycle_policy_request = {resource_identifiers : lifecycle_policy_resource_identifiers;The unique identifiers of policy types and resource names.
*)}type nonrec collection_detail = {failure_message : Smaws_Lib.Smithy_api.Types.string_ option;A message associated with the failure code.
*)failure_code : Smaws_Lib.Smithy_api.Types.string_ option;A failure code associated with the request.
*)dashboard_endpoint : Smaws_Lib.Smithy_api.Types.string_ option;Collection-specific endpoint used to access OpenSearch Dashboards.
*)collection_endpoint : Smaws_Lib.Smithy_api.Types.string_ option;Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
*)last_modified_date : Smaws_Lib.Smithy_api.Types.long option;The date and time when the collection was last modified.
*)created_date : Smaws_Lib.Smithy_api.Types.long option;The Epoch time when the collection was created.
*)standby_replicas : standby_replicas option;Details about an OpenSearch Serverless collection.
*)kms_key_arn : Smaws_Lib.Smithy_api.Types.string_ option;The ARN of the Amazon Web Services KMS key used to encrypt the collection.
*)arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) of the collection.
*)description : Smaws_Lib.Smithy_api.Types.string_ option;A description of the collection.
*)type_ : collection_type option;The type of collection.
*)status : collection_status option;The current status of the collection.
*)name : collection_name option;The name of the collection.
*)id : collection_id 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_details = collection_detail listtype nonrec collection_error_detail = {error_code : Smaws_Lib.Smithy_api.Types.string_ option;The error code for the request. For example, NOT_FOUND.
error_message : Smaws_Lib.Smithy_api.Types.string_ option;A description of the error. For example, The specified Collection is not found.
name : collection_name option;If the request contains collection names, the response includes the names provided in the request.
*)id : collection_id 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 collection_error_details = collection_error_detail listtype nonrec batch_get_collection_response = {collection_error_details : collection_error_details option;Error information for the request.
*)collection_details : collection_details option;Details about each collection.
*)}type nonrec collection_ids = collection_id listtype nonrec collection_names = collection_name listtype nonrec batch_get_collection_request = {names : collection_names option;A list of collection names. You can't provide names and IDs in the same request.
*)ids : collection_ids 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 = {message : Smaws_Lib.Smithy_api.Types.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 = {next_token : Smaws_Lib.Smithy_api.Types.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.
vpc_endpoint_summaries : vpc_endpoint_summaries option;Details about each VPC endpoint, including the name and current status.
*)}type nonrec list_vpc_endpoints_request = {max_results : Smaws_Lib.Smithy_api.Types.integer 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.
next_token : Smaws_Lib.Smithy_api.Types.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.
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 = {next_token : Smaws_Lib.Smithy_api.Types.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.
security_policy_summaries : security_policy_summaries option;Details about the security policies in your account.
*)}type nonrec list_security_policies_request = {max_results : Smaws_Lib.Smithy_api.Types.integer 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.
next_token : Smaws_Lib.Smithy_api.Types.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.
resource : resource_filter option;Resource filters (can be collection or indexes) that policies can apply to.
*)type_ : security_policy_type;The type of policy.
*)}type nonrec list_security_configs_response = {next_token : Smaws_Lib.Smithy_api.Types.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.
security_config_summaries : security_config_summaries option;Details about the security configurations in your account.
*)}type nonrec list_security_configs_request = {max_results : Smaws_Lib.Smithy_api.Types.integer 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.
next_token : Smaws_Lib.Smithy_api.Types.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.
type_ : security_config_type;The type of security configuration.
*)}type nonrec lifecycle_policy_summary = {last_modified_date : Smaws_Lib.Smithy_api.Types.long option;The date and time when the lifecycle policy was last modified.
*)created_date : Smaws_Lib.Smithy_api.Types.long option;The Epoch time when the lifecycle policy was created.
*)description : policy_description option;The description of the lifecycle policy.
*)policy_version : policy_version option;The version of the lifecycle policy.
*)name : policy_name option;The name of the lifecycle policy.
*)type_ : lifecycle_policy_type option;The type of lifecycle policy.
*)}A summary of the lifecycle policy.
type nonrec lifecycle_policy_summaries = lifecycle_policy_summary listtype nonrec list_lifecycle_policies_response = {next_token : Smaws_Lib.Smithy_api.Types.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.
lifecycle_policy_summaries : lifecycle_policy_summaries option;Details about the requested lifecycle policies.
*)}type nonrec lifecycle_resource_filter = lifecycle_resource listtype nonrec list_lifecycle_policies_request = {max_results : Smaws_Lib.Smithy_api.Types.integer 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.
next_token : Smaws_Lib.Smithy_api.Types.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.
resources : lifecycle_resource_filter option;Resource filters that policies can apply to. Currently, the only supported resource type is index.
type_ : lifecycle_policy_type;The type of lifecycle policy.
*)}type nonrec collection_summary = {arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) of the collection.
*)status : collection_status option;The current status of the collection.
*)name : collection_name option;The name of the collection.
*)id : collection_id option;The unique identifier of the collection.
*)}Details about each OpenSearch Serverless collection.
type nonrec collection_summaries = collection_summary listtype nonrec list_collections_response = {next_token : Smaws_Lib.Smithy_api.Types.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.
collection_summaries : collection_summaries option;Details about each collection.
*)}type nonrec collection_filters = {status : collection_status option;The current status of the collection.
*)name : collection_name 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 = {max_results : Smaws_Lib.Smithy_api.Types.integer option;The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.
next_token : Smaws_Lib.Smithy_api.Types.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.
collection_filters : collection_filters option;A list of filter names and values that you can use for requests.
*)}type nonrec access_policy_summary = {last_modified_date : Smaws_Lib.Smithy_api.Types.long option;The date and time when the collection was last modified.
*)created_date : Smaws_Lib.Smithy_api.Types.long option;The Epoch time when the access policy was created.
*)description : policy_description option;The description of the access policy.
*)policy_version : policy_version option;The version of the policy.
*)name : policy_name option;The name of the access policy.
*)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 access_policy_summaries = access_policy_summary listtype nonrec list_access_policies_response = {next_token : Smaws_Lib.Smithy_api.Types.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.
access_policy_summaries : access_policy_summaries option;Details about the requested access policies.
*)}type nonrec list_access_policies_request = {max_results : Smaws_Lib.Smithy_api.Types.integer 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.
next_token : Smaws_Lib.Smithy_api.Types.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.
resource : resource_filter option;Resource filters (can be collections or indexes) that policies can apply to.
*)type_ : access_policy_type;The type of access policy.
*)}type nonrec lifecycle_policy = Smaws_Lib.CoreTypes.Resource.ttype nonrec get_security_policy_response = {security_policy_detail : security_policy_detail option;Details about the requested security policy.
*)}type nonrec get_security_policy_request = {name : policy_name;The name of the security policy.
*)type_ : security_policy_type;The type of security policy.
*)}type nonrec get_security_config_response = {security_config_detail : security_config_detail option;Details of the requested security configuration.
*)}type nonrec get_security_config_request = {id : security_config_id;The unique identifier of the security configuration.
*)}type nonrec get_access_policy_response = {access_policy_detail : access_policy_detail option;Details about the requested access policy.
*)}type nonrec get_access_policy_request = {name : policy_name;The name of the access policy.
*)type_ : access_policy_type;Tye type of policy. Currently, the only supported value is data.
}type nonrec delete_vpc_endpoint_detail = {status : vpc_endpoint_status option;The current status of the endpoint deletion process.
*)name : vpc_endpoint_name option;The name of the endpoint.
*)id : vpc_endpoint_id option;The unique identifier of the endpoint.
*)}Deletion details for an OpenSearch Serverless-managed interface endpoint.
type nonrec delete_vpc_endpoint_response = {delete_vpc_endpoint_detail : delete_vpc_endpoint_detail option;Details about the deleted endpoint.
*)}type nonrec delete_vpc_endpoint_request = {client_token : client_token option;Unique, case-sensitive identifier to ensure idempotency of the request.
*)id : vpc_endpoint_id;The VPC endpoint identifier.
*)}type nonrec delete_security_policy_request = {client_token : client_token option;Unique, case-sensitive identifier to ensure idempotency of the request.
*)name : policy_name;The name of the policy to delete.
*)type_ : security_policy_type;The type of policy.
*)}type nonrec delete_security_config_request = {client_token : client_token option;Unique, case-sensitive identifier to ensure idempotency of the request.
*)id : security_config_id;The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.
}type nonrec delete_lifecycle_policy_request = {client_token : client_token option;Unique, case-sensitive identifier to ensure idempotency of the request.
*)name : policy_name;The name of the policy to delete.
*)type_ : lifecycle_policy_type;The type of lifecycle policy.
*)}type nonrec delete_collection_detail = {status : collection_status option;The current status of the collection.
*)name : collection_name option;The name of the collection.
*)id : collection_id option;The unique identifier of the collection.
*)}Details about a deleted OpenSearch Serverless collection.
type nonrec delete_collection_response = {delete_collection_detail : delete_collection_detail option;Details of the deleted collection.
*)}type nonrec delete_collection_request = {client_token : client_token option;A unique, case-sensitive identifier to ensure idempotency of the request.
*)id : collection_id;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 = {client_token : client_token option;Unique, case-sensitive identifier to ensure idempotency of the request.
*)name : policy_name;The name of the policy to delete.
*)type_ : access_policy_type;The type of policy.
*)}type nonrec create_vpc_endpoint_detail = {status : vpc_endpoint_status option;The current status in the endpoint creation process.
*)name : vpc_endpoint_name option;The name of the endpoint.
*)id : vpc_endpoint_id 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 = {create_vpc_endpoint_detail : create_vpc_endpoint_detail option;Details about the created interface VPC endpoint.
*)}type nonrec create_vpc_endpoint_request = {client_token : client_token option;Unique, case-sensitive identifier to ensure idempotency of the request.
*)security_group_ids : security_group_ids 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.
*)subnet_ids : subnet_ids;The ID of one or more subnets from which you'll access OpenSearch Serverless.
*)vpc_id : vpc_id;The ID of the VPC from which you'll access OpenSearch Serverless.
*)name : vpc_endpoint_name;The name of the interface endpoint.
*)}type nonrec create_security_config_response = {security_config_detail : security_config_detail option;Details about the created security configuration.
*)}type nonrec create_iam_identity_center_config_options = {group_attribute : iam_identity_center_group_attribute option;The group attribute for this IAM Identity Center integration. Defaults to GroupId.
user_attribute : iam_identity_center_user_attribute option;The user attribute for this IAM Identity Center integration. Defaults to UserId.
instance_arn : iam_identity_center_instance_arn;The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.
*)}Describes IAM Identity Center options for creating an OpenSearch Serverless security configuration in the form of a key-value map.
type nonrec create_security_config_request = {client_token : client_token option;Unique, case-sensitive identifier to ensure idempotency of the request.
*)iam_identity_center_options : create_iam_identity_center_config_options option;Describes IAM Identity Center options in the form of a key-value map. This field is required if you specify iamidentitycenter for the type parameter.
*)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.
description : config_description option;A description of the security configuration.
*)name : config_name;The name of the security configuration.
*)type_ : security_config_type;The type of security configuration.
*)}type nonrec create_collection_detail = {last_modified_date : Smaws_Lib.Smithy_api.Types.long option;The date and time when the collection was last modified.
*)created_date : Smaws_Lib.Smithy_api.Types.long option;The Epoch time when the collection was created.
*)standby_replicas : standby_replicas option;Creates details about an OpenSearch Serverless collection.
*)kms_key_arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.
*)arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) of the collection.
*)description : Smaws_Lib.Smithy_api.Types.string_ option;A description of the collection.
*)type_ : collection_type option;The type of collection.
*)status : collection_status option;The current status of the collection.
*)name : collection_name option;The name of the collection.
*)id : collection_id option;The unique identifier of the collection.
*)}Details about the created OpenSearch Serverless collection.
type nonrec create_collection_response = {create_collection_detail : create_collection_detail option;Details about the collection.
*)}type nonrec create_collection_request = {client_token : client_token option;Unique, case-sensitive identifier to ensure idempotency of the request.
*)standby_replicas : standby_replicas option;Indicates whether standby replicas should be used for a collection.
*)description : Smaws_Lib.Smithy_api.Types.string_ option;Description of the collection.
*)type_ : collection_type option;The type of collection.
*)name : collection_name;Name of the collection.
*)}type nonrec create_access_policy_response = {access_policy_detail : access_policy_detail option;Details about the created access policy.
*)}type nonrec create_access_policy_request = {client_token : client_token option;Unique, case-sensitive identifier to ensure idempotency of the request.
*)policy : policy_document;The JSON policy document to use as the content for the policy.
*)description : policy_description option;A description of the policy. Typically used to store information about the permissions defined in the policy.
*)name : policy_name;The name of the policy.
*)type_ : access_policy_type;The type of policy.
*)}type nonrec collection = Smaws_Lib.CoreTypes.Resource.ttype nonrec access_policy = Smaws_Lib.CoreTypes.Resource.t