opensearchserverless/aws.sdk.kotlin.services.opensearchserverless.model

Package-level declarations

Types

AccessPolicyDetail

class AccessPolicyDetail

Details about an OpenSearch Serverless access policy.

AccessPolicyStats

class AccessPolicyStats

Statistics for an OpenSearch Serverless access policy.

AccessPolicySummary

class AccessPolicySummary

A summary of the data access policy.

AccessPolicyType

sealed class AccessPolicyType

AccountSettingsDetail

class AccountSettingsDetail

OpenSearch Serverless-related information for the current account.

BatchGetCollectionRequest

class BatchGetCollectionRequest

BatchGetCollectionResponse

class BatchGetCollectionResponse

BatchGetEffectiveLifecyclePolicyRequest

class BatchGetEffectiveLifecyclePolicyRequest

BatchGetEffectiveLifecyclePolicyResponse

class BatchGetEffectiveLifecyclePolicyResponse

BatchGetLifecyclePolicyRequest

class BatchGetLifecyclePolicyRequest

BatchGetLifecyclePolicyResponse

class BatchGetLifecyclePolicyResponse

BatchGetVpcEndpointRequest

class BatchGetVpcEndpointRequest

BatchGetVpcEndpointResponse

class BatchGetVpcEndpointResponse

class CapacityLimits

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.

CollectionDetail

class CollectionDetail

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

CollectionErrorDetail

class CollectionErrorDetail

Error information for an OpenSearch Serverless request.

CollectionFilters

class CollectionFilters

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

CollectionStatus

sealed class CollectionStatus

CollectionSummary

class CollectionSummary

Details about each OpenSearch Serverless collection.

sealed class CollectionType

ConflictException

class ConflictException : OpenSearchServerlessException

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.

CreateAccessPolicyRequest

class CreateAccessPolicyRequest

CreateAccessPolicyResponse

class CreateAccessPolicyResponse

CreateCollectionDetail

class CreateCollectionDetail

Details about the created OpenSearch Serverless collection.

CreateCollectionRequest

class CreateCollectionRequest

CreateCollectionResponse

class CreateCollectionResponse

CreateLifecyclePolicyRequest

class CreateLifecyclePolicyRequest

CreateLifecyclePolicyResponse

class CreateLifecyclePolicyResponse

CreateSecurityConfigRequest

class CreateSecurityConfigRequest

CreateSecurityConfigResponse

class CreateSecurityConfigResponse

CreateSecurityPolicyRequest

class CreateSecurityPolicyRequest

CreateSecurityPolicyResponse

class CreateSecurityPolicyResponse

CreateVpcEndpointDetail

class CreateVpcEndpointDetail

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

CreateVpcEndpointRequest

class CreateVpcEndpointRequest

CreateVpcEndpointResponse

class CreateVpcEndpointResponse

DeleteAccessPolicyRequest

class DeleteAccessPolicyRequest

DeleteAccessPolicyResponse

class DeleteAccessPolicyResponse

DeleteCollectionDetail

class DeleteCollectionDetail

Details about a deleted OpenSearch Serverless collection.

DeleteCollectionRequest

class DeleteCollectionRequest

DeleteCollectionResponse

class DeleteCollectionResponse

DeleteLifecyclePolicyRequest

class DeleteLifecyclePolicyRequest

DeleteLifecyclePolicyResponse

class DeleteLifecyclePolicyResponse

DeleteSecurityConfigRequest

class DeleteSecurityConfigRequest

DeleteSecurityConfigResponse

class DeleteSecurityConfigResponse

DeleteSecurityPolicyRequest

class DeleteSecurityPolicyRequest

DeleteSecurityPolicyResponse

class DeleteSecurityPolicyResponse

DeleteVpcEndpointDetail

class DeleteVpcEndpointDetail

Deletion details for an OpenSearch Serverless-managed interface endpoint.

DeleteVpcEndpointRequest

class DeleteVpcEndpointRequest

DeleteVpcEndpointResponse

class DeleteVpcEndpointResponse

EffectiveLifecyclePolicyDetail

class EffectiveLifecyclePolicyDetail

Error information for an OpenSearch Serverless request.

EffectiveLifecyclePolicyErrorDetail

class EffectiveLifecyclePolicyErrorDetail

Error information for an OpenSearch Serverless request.

GetAccessPolicyRequest

class GetAccessPolicyRequest

GetAccessPolicyResponse

class GetAccessPolicyResponse

GetAccountSettingsRequest

class GetAccountSettingsRequest

GetAccountSettingsResponse

class GetAccountSettingsResponse

GetPoliciesStatsRequest

class GetPoliciesStatsRequest

GetPoliciesStatsResponse

class GetPoliciesStatsResponse

GetSecurityConfigRequest

class GetSecurityConfigRequest

GetSecurityConfigResponse

class GetSecurityConfigResponse

GetSecurityPolicyRequest

class GetSecurityPolicyRequest

GetSecurityPolicyResponse

class GetSecurityPolicyResponse

InternalServerException

class InternalServerException : OpenSearchServerlessException

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

LifecyclePolicyDetail

class LifecyclePolicyDetail

Details about an OpenSearch Serverless lifecycle policy.

LifecyclePolicyErrorDetail

class LifecyclePolicyErrorDetail

Error information for an OpenSearch Serverless request.

LifecyclePolicyIdentifier

class LifecyclePolicyIdentifier

The unique identifiers of policy types and policy names.

LifecyclePolicyResourceIdentifier

class LifecyclePolicyResourceIdentifier

The unique identifiers of policy types and resource names.

LifecyclePolicyStats

class LifecyclePolicyStats

Statistics for an OpenSearch Serverless lifecycle policy.

LifecyclePolicySummary

class LifecyclePolicySummary

A summary of the lifecycle policy.

LifecyclePolicyType

sealed class LifecyclePolicyType

ListAccessPoliciesRequest

class ListAccessPoliciesRequest

ListAccessPoliciesResponse

class ListAccessPoliciesResponse

ListCollectionsRequest

class ListCollectionsRequest

ListCollectionsResponse

class ListCollectionsResponse

ListLifecyclePoliciesRequest

class ListLifecyclePoliciesRequest

ListLifecyclePoliciesResponse

class ListLifecyclePoliciesResponse

ListSecurityConfigsRequest

class ListSecurityConfigsRequest

ListSecurityConfigsResponse

class ListSecurityConfigsResponse

ListSecurityPoliciesRequest

class ListSecurityPoliciesRequest

ListSecurityPoliciesResponse

class ListSecurityPoliciesResponse

ListTagsForResourceRequest

class ListTagsForResourceRequest

ListTagsForResourceResponse

class ListTagsForResourceResponse

ListVpcEndpointsRequest

class ListVpcEndpointsRequest

ListVpcEndpointsResponse

class ListVpcEndpointsResponse

OcuLimitExceededException

class OcuLimitExceededException : OpenSearchServerlessException

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

OpenSearchServerlessException

open class OpenSearchServerlessException : AwsServiceException

Base class for all service related exceptions thrown by the OpenSearchServerless client

ResourceNotFoundException

class ResourceNotFoundException : OpenSearchServerlessException

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

sealed class ResourceType

SamlConfigOptions

class SamlConfigOptions

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

SecurityConfigDetail

class SecurityConfigDetail

Details about a security configuration for OpenSearch Serverless.

SecurityConfigStats

class SecurityConfigStats

Statistics for an OpenSearch Serverless security configuration.

SecurityConfigSummary

class SecurityConfigSummary

A summary of a security configuration for OpenSearch Serverless.

SecurityConfigType

sealed class SecurityConfigType

SecurityPolicyDetail

class SecurityPolicyDetail

Details about an OpenSearch Serverless security policy.

SecurityPolicyStats

class SecurityPolicyStats

Statistics for an OpenSearch Serverless security policy.

SecurityPolicySummary

class SecurityPolicySummary

A summary of a security policy for OpenSearch Serverless.

SecurityPolicyType

sealed class SecurityPolicyType

ServiceQuotaExceededException

class ServiceQuotaExceededException : OpenSearchServerlessException

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

StandbyReplicas

sealed class StandbyReplicas

class Tag

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

TagResourceRequest

class TagResourceRequest

TagResourceResponse

class TagResourceResponse

UntagResourceRequest

class UntagResourceRequest

UntagResourceResponse

class UntagResourceResponse

UpdateAccessPolicyRequest

class UpdateAccessPolicyRequest

UpdateAccessPolicyResponse

class UpdateAccessPolicyResponse

UpdateAccountSettingsRequest

class UpdateAccountSettingsRequest

UpdateAccountSettingsResponse

class UpdateAccountSettingsResponse

UpdateCollectionDetail

class UpdateCollectionDetail

Details about an updated OpenSearch Serverless collection.

UpdateCollectionRequest

class UpdateCollectionRequest

UpdateCollectionResponse

class UpdateCollectionResponse

UpdateLifecyclePolicyRequest

class UpdateLifecyclePolicyRequest

UpdateLifecyclePolicyResponse

class UpdateLifecyclePolicyResponse

UpdateSecurityConfigRequest

class UpdateSecurityConfigRequest

UpdateSecurityConfigResponse

class UpdateSecurityConfigResponse

UpdateSecurityPolicyRequest

class UpdateSecurityPolicyRequest

UpdateSecurityPolicyResponse

class UpdateSecurityPolicyResponse

UpdateVpcEndpointDetail

class UpdateVpcEndpointDetail

Update details for an OpenSearch Serverless-managed interface endpoint.

UpdateVpcEndpointRequest

class UpdateVpcEndpointRequest

UpdateVpcEndpointResponse

class UpdateVpcEndpointResponse

ValidationException

class ValidationException : OpenSearchServerlessException

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

VpcEndpointDetail

class VpcEndpointDetail

Details about an OpenSearch Serverless-managed interface endpoint.

VpcEndpointErrorDetail

class VpcEndpointErrorDetail

Error information for a failed BatchGetVpcEndpoint request.

VpcEndpointFilters

class VpcEndpointFilters

Filter the results of a ListVpcEndpoints request.

VpcEndpointStatus

sealed class VpcEndpointStatus

VpcEndpointSummary

class VpcEndpointSummary

The VPC endpoint object.