OpenSearchServiceServerlessClient

Index > OpenSearchServiceServerless > OpenSearchServiceServerlessClient

Auto-generated documentation for OpenSearchServiceServerless type annotations stubs module types-boto3-opensearchserverless.

OpenSearchServiceServerlessClient

Type annotations and code completion for boto3.client("opensearchserverless"). boto3 documentation

# OpenSearchServiceServerlessClient usage example

from boto3.session import Session
from types_boto3_opensearchserverless.client import OpenSearchServiceServerlessClient

def get_opensearchserverless_client() -> OpenSearchServiceServerlessClient:
    return Session().client("opensearchserverless")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("opensearchserverless").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("opensearchserverless")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.OcuLimitExceededException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_opensearchserverless.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("opensearchserverless").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("opensearchserverless").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

batch_get_collection

Returns attributes for one or more collections, including the collection endpoint, the OpenSearch Dashboards endpoint, and FIPS-compliant endpoints.

Type annotations and code completion for boto3.client("opensearchserverless").batch_get_collection method. boto3 documentation

# batch_get_collection method definition

def batch_get_collection(
    self,
    *,
    ids: Sequence[str] = ...,
    names: Sequence[str] = ...,
) -> BatchGetCollectionResponseTypeDef:  # (1)
    ...

1. See BatchGetCollectionResponseTypeDef

# batch_get_collection method usage example with argument unpacking

kwargs: BatchGetCollectionRequestTypeDef = {  # (1)
    "ids": ...,
}

parent.batch_get_collection(**kwargs)

1. See BatchGetCollectionRequestTypeDef

batch_get_effective_lifecycle_policy

Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes.

Type annotations and code completion for boto3.client("opensearchserverless").batch_get_effective_lifecycle_policy method. boto3 documentation

# batch_get_effective_lifecycle_policy method definition

def batch_get_effective_lifecycle_policy(
    self,
    *,
    resourceIdentifiers: Sequence[LifecyclePolicyResourceIdentifierTypeDef],  # (1)
) -> BatchGetEffectiveLifecyclePolicyResponseTypeDef:  # (2)
    ...

1. See Sequence[LifecyclePolicyResourceIdentifierTypeDef]
2. See BatchGetEffectiveLifecyclePolicyResponseTypeDef

# batch_get_effective_lifecycle_policy method usage example with argument unpacking

kwargs: BatchGetEffectiveLifecyclePolicyRequestTypeDef = {  # (1)
    "resourceIdentifiers": ...,
}

parent.batch_get_effective_lifecycle_policy(**kwargs)

1. See BatchGetEffectiveLifecyclePolicyRequestTypeDef

batch_get_lifecycle_policy

Returns one or more configured OpenSearch Serverless lifecycle policies.

Type annotations and code completion for boto3.client("opensearchserverless").batch_get_lifecycle_policy method. boto3 documentation

# batch_get_lifecycle_policy method definition

def batch_get_lifecycle_policy(
    self,
    *,
    identifiers: Sequence[LifecyclePolicyIdentifierTypeDef],  # (1)
) -> BatchGetLifecyclePolicyResponseTypeDef:  # (2)
    ...

1. See Sequence[LifecyclePolicyIdentifierTypeDef]
2. See BatchGetLifecyclePolicyResponseTypeDef

# batch_get_lifecycle_policy method usage example with argument unpacking

kwargs: BatchGetLifecyclePolicyRequestTypeDef = {  # (1)
    "identifiers": ...,
}

parent.batch_get_lifecycle_policy(**kwargs)

1. See BatchGetLifecyclePolicyRequestTypeDef

batch_get_vpc_endpoint

Returns attributes for one or more VPC endpoints associated with the current account.

Type annotations and code completion for boto3.client("opensearchserverless").batch_get_vpc_endpoint method. boto3 documentation

# batch_get_vpc_endpoint method definition

def batch_get_vpc_endpoint(
    self,
    *,
    ids: Sequence[str],
) -> BatchGetVpcEndpointResponseTypeDef:  # (1)
    ...

1. See BatchGetVpcEndpointResponseTypeDef

# batch_get_vpc_endpoint method usage example with argument unpacking

kwargs: BatchGetVpcEndpointRequestTypeDef = {  # (1)
    "ids": ...,
}

parent.batch_get_vpc_endpoint(**kwargs)

1. See BatchGetVpcEndpointRequestTypeDef

create_access_policy

Creates a data access policy for OpenSearch Serverless.

Type annotations and code completion for boto3.client("opensearchserverless").create_access_policy method. boto3 documentation

# create_access_policy method definition

def create_access_policy(
    self,
    *,
    type: AccessPolicyTypeType,  # (1)
    name: str,
    policy: str,
    description: str = ...,
    clientToken: str = ...,
) -> CreateAccessPolicyResponseTypeDef:  # (2)
    ...

1. See AccessPolicyTypeType
2. See CreateAccessPolicyResponseTypeDef

# create_access_policy method usage example with argument unpacking

kwargs: CreateAccessPolicyRequestTypeDef = {  # (1)
    "type": ...,
    "name": ...,
    "policy": ...,
}

parent.create_access_policy(**kwargs)

1. See CreateAccessPolicyRequestTypeDef

create_collection

Creates a new OpenSearch Serverless collection.

Type annotations and code completion for boto3.client("opensearchserverless").create_collection method. boto3 documentation

# create_collection method definition

def create_collection(
    self,
    *,
    name: str,
    type: CollectionTypeType = ...,  # (1)
    description: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
    standbyReplicas: StandbyReplicasType = ...,  # (3)
    clientToken: str = ...,
) -> CreateCollectionResponseTypeDef:  # (4)
    ...

1. See CollectionTypeType
2. See Sequence[TagTypeDef]
3. See StandbyReplicasType
4. See CreateCollectionResponseTypeDef

# create_collection method usage example with argument unpacking

kwargs: CreateCollectionRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_collection(**kwargs)

1. See CreateCollectionRequestTypeDef

create_index

Creates an index within an OpenSearch Serverless collection.

Type annotations and code completion for boto3.client("opensearchserverless").create_index method. boto3 documentation

# create_index method definition

def create_index(
    self,
    *,
    id: str,
    indexName: str,
    indexSchema: Mapping[str, Any] = ...,
) -> Dict[str, Any]:
    ...

# create_index method usage example with argument unpacking

kwargs: CreateIndexRequestTypeDef = {  # (1)
    "id": ...,
    "indexName": ...,
}

parent.create_index(**kwargs)

1. See CreateIndexRequestTypeDef

create_lifecycle_policy

Creates a lifecyle policy to be applied to OpenSearch Serverless indexes.

Type annotations and code completion for boto3.client("opensearchserverless").create_lifecycle_policy method. boto3 documentation

# create_lifecycle_policy method definition

def create_lifecycle_policy(
    self,
    *,
    type: LifecyclePolicyTypeType,  # (1)
    name: str,
    policy: str,
    description: str = ...,
    clientToken: str = ...,
) -> CreateLifecyclePolicyResponseTypeDef:  # (2)
    ...

1. See LifecyclePolicyTypeType
2. See CreateLifecyclePolicyResponseTypeDef

# create_lifecycle_policy method usage example with argument unpacking

kwargs: CreateLifecyclePolicyRequestTypeDef = {  # (1)
    "type": ...,
    "name": ...,
    "policy": ...,
}

parent.create_lifecycle_policy(**kwargs)

1. See CreateLifecyclePolicyRequestTypeDef

create_security_config

Specifies a security configuration for OpenSearch Serverless.

Type annotations and code completion for boto3.client("opensearchserverless").create_security_config method. boto3 documentation

# create_security_config method definition

def create_security_config(
    self,
    *,
    type: SecurityConfigTypeType,  # (1)
    name: str,
    description: str = ...,
    samlOptions: SamlConfigOptionsTypeDef = ...,  # (2)
    iamIdentityCenterOptions: CreateIamIdentityCenterConfigOptionsTypeDef = ...,  # (3)
    iamFederationOptions: IamFederationConfigOptionsTypeDef = ...,  # (4)
    clientToken: str = ...,
) -> CreateSecurityConfigResponseTypeDef:  # (5)
    ...

1. See SecurityConfigTypeType
2. See SamlConfigOptionsTypeDef
3. See CreateIamIdentityCenterConfigOptionsTypeDef
4. See IamFederationConfigOptionsTypeDef
5. See CreateSecurityConfigResponseTypeDef

# create_security_config method usage example with argument unpacking

kwargs: CreateSecurityConfigRequestTypeDef = {  # (1)
    "type": ...,
    "name": ...,
}

parent.create_security_config(**kwargs)

1. See CreateSecurityConfigRequestTypeDef

create_security_policy

Creates a security policy to be used by one or more OpenSearch Serverless collections.

Type annotations and code completion for boto3.client("opensearchserverless").create_security_policy method. boto3 documentation

# create_security_policy method definition

def create_security_policy(
    self,
    *,
    type: SecurityPolicyTypeType,  # (1)
    name: str,
    policy: str,
    description: str = ...,
    clientToken: str = ...,
) -> CreateSecurityPolicyResponseTypeDef:  # (2)
    ...

1. See SecurityPolicyTypeType
2. See CreateSecurityPolicyResponseTypeDef

# create_security_policy method usage example with argument unpacking

kwargs: CreateSecurityPolicyRequestTypeDef = {  # (1)
    "type": ...,
    "name": ...,
    "policy": ...,
}

parent.create_security_policy(**kwargs)

1. See CreateSecurityPolicyRequestTypeDef

create_vpc_endpoint

Creates an OpenSearch Serverless-managed interface VPC endpoint.

Type annotations and code completion for boto3.client("opensearchserverless").create_vpc_endpoint method. boto3 documentation

# create_vpc_endpoint method definition

def create_vpc_endpoint(
    self,
    *,
    name: str,
    vpcId: str,
    subnetIds: Sequence[str],
    securityGroupIds: Sequence[str] = ...,
    clientToken: str = ...,
) -> CreateVpcEndpointResponseTypeDef:  # (1)
    ...

1. See CreateVpcEndpointResponseTypeDef

# create_vpc_endpoint method usage example with argument unpacking

kwargs: CreateVpcEndpointRequestTypeDef = {  # (1)
    "name": ...,
    "vpcId": ...,
    "subnetIds": ...,
}

parent.create_vpc_endpoint(**kwargs)

1. See CreateVpcEndpointRequestTypeDef

delete_access_policy

Deletes an OpenSearch Serverless access policy.

Type annotations and code completion for boto3.client("opensearchserverless").delete_access_policy method. boto3 documentation

# delete_access_policy method definition

def delete_access_policy(
    self,
    *,
    type: AccessPolicyTypeType,  # (1)
    name: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

1. See AccessPolicyTypeType

# delete_access_policy method usage example with argument unpacking

kwargs: DeleteAccessPolicyRequestTypeDef = {  # (1)
    "type": ...,
    "name": ...,
}

parent.delete_access_policy(**kwargs)

1. See DeleteAccessPolicyRequestTypeDef

delete_collection

Deletes an OpenSearch Serverless collection.

Type annotations and code completion for boto3.client("opensearchserverless").delete_collection method. boto3 documentation

# delete_collection method definition

def delete_collection(
    self,
    *,
    id: str,
    clientToken: str = ...,
) -> DeleteCollectionResponseTypeDef:  # (1)
    ...

1. See DeleteCollectionResponseTypeDef

# delete_collection method usage example with argument unpacking

kwargs: DeleteCollectionRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_collection(**kwargs)

1. See DeleteCollectionRequestTypeDef

delete_index

Deletes an index from an OpenSearch Serverless collection.

Type annotations and code completion for boto3.client("opensearchserverless").delete_index method. boto3 documentation

# delete_index method definition

def delete_index(
    self,
    *,
    id: str,
    indexName: str,
) -> Dict[str, Any]:
    ...

# delete_index method usage example with argument unpacking

kwargs: DeleteIndexRequestTypeDef = {  # (1)
    "id": ...,
    "indexName": ...,
}

parent.delete_index(**kwargs)

1. See DeleteIndexRequestTypeDef

delete_lifecycle_policy

Deletes an OpenSearch Serverless lifecycle policy.

Type annotations and code completion for boto3.client("opensearchserverless").delete_lifecycle_policy method. boto3 documentation

# delete_lifecycle_policy method definition

def delete_lifecycle_policy(
    self,
    *,
    type: LifecyclePolicyTypeType,  # (1)
    name: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

1. See LifecyclePolicyTypeType

# delete_lifecycle_policy method usage example with argument unpacking

kwargs: DeleteLifecyclePolicyRequestTypeDef = {  # (1)
    "type": ...,
    "name": ...,
}

parent.delete_lifecycle_policy(**kwargs)

1. See DeleteLifecyclePolicyRequestTypeDef

delete_security_config

Deletes a security configuration for OpenSearch Serverless.

Type annotations and code completion for boto3.client("opensearchserverless").delete_security_config method. boto3 documentation

# delete_security_config method definition

def delete_security_config(
    self,
    *,
    id: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

# delete_security_config method usage example with argument unpacking

kwargs: DeleteSecurityConfigRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_security_config(**kwargs)

1. See DeleteSecurityConfigRequestTypeDef

delete_security_policy

Deletes an OpenSearch Serverless security policy.

Type annotations and code completion for boto3.client("opensearchserverless").delete_security_policy method. boto3 documentation

# delete_security_policy method definition

def delete_security_policy(
    self,
    *,
    type: SecurityPolicyTypeType,  # (1)
    name: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

1. See SecurityPolicyTypeType

# delete_security_policy method usage example with argument unpacking

kwargs: DeleteSecurityPolicyRequestTypeDef = {  # (1)
    "type": ...,
    "name": ...,
}

parent.delete_security_policy(**kwargs)

1. See DeleteSecurityPolicyRequestTypeDef

delete_vpc_endpoint

Deletes an OpenSearch Serverless-managed interface endpoint.

Type annotations and code completion for boto3.client("opensearchserverless").delete_vpc_endpoint method. boto3 documentation

# delete_vpc_endpoint method definition

def delete_vpc_endpoint(
    self,
    *,
    id: str,
    clientToken: str = ...,
) -> DeleteVpcEndpointResponseTypeDef:  # (1)
    ...

1. See DeleteVpcEndpointResponseTypeDef

# delete_vpc_endpoint method usage example with argument unpacking

kwargs: DeleteVpcEndpointRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_vpc_endpoint(**kwargs)

1. See DeleteVpcEndpointRequestTypeDef

get_access_policy

Returns an OpenSearch Serverless access policy.

Type annotations and code completion for boto3.client("opensearchserverless").get_access_policy method. boto3 documentation

# get_access_policy method definition

def get_access_policy(
    self,
    *,
    type: AccessPolicyTypeType,  # (1)
    name: str,
) -> GetAccessPolicyResponseTypeDef:  # (2)
    ...

1. See AccessPolicyTypeType
2. See GetAccessPolicyResponseTypeDef

# get_access_policy method usage example with argument unpacking

kwargs: GetAccessPolicyRequestTypeDef = {  # (1)
    "type": ...,
    "name": ...,
}

parent.get_access_policy(**kwargs)

1. See GetAccessPolicyRequestTypeDef

get_account_settings

Returns account-level settings related to OpenSearch Serverless.

Type annotations and code completion for boto3.client("opensearchserverless").get_account_settings method. boto3 documentation

# get_account_settings method definition

def get_account_settings(
    self,
) -> GetAccountSettingsResponseTypeDef:  # (1)
    ...

1. See GetAccountSettingsResponseTypeDef

get_index

Retrieves information about an index in an OpenSearch Serverless collection, including its schema definition.

Type annotations and code completion for boto3.client("opensearchserverless").get_index method. boto3 documentation

# get_index method definition

def get_index(
    self,
    *,
    id: str,
    indexName: str,
) -> GetIndexResponseTypeDef:  # (1)
    ...

1. See GetIndexResponseTypeDef

# get_index method usage example with argument unpacking

kwargs: GetIndexRequestTypeDef = {  # (1)
    "id": ...,
    "indexName": ...,
}

parent.get_index(**kwargs)

1. See GetIndexRequestTypeDef

get_policies_stats

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

Type annotations and code completion for boto3.client("opensearchserverless").get_policies_stats method. boto3 documentation

# get_policies_stats method definition

def get_policies_stats(
    self,
) -> GetPoliciesStatsResponseTypeDef:  # (1)
    ...

1. See GetPoliciesStatsResponseTypeDef

get_security_config

Returns information about an OpenSearch Serverless security configuration.

Type annotations and code completion for boto3.client("opensearchserverless").get_security_config method. boto3 documentation

# get_security_config method definition

def get_security_config(
    self,
    *,
    id: str,
) -> GetSecurityConfigResponseTypeDef:  # (1)
    ...

1. See GetSecurityConfigResponseTypeDef

# get_security_config method usage example with argument unpacking

kwargs: GetSecurityConfigRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_security_config(**kwargs)

1. See GetSecurityConfigRequestTypeDef

get_security_policy

Returns information about a configured OpenSearch Serverless security policy.

Type annotations and code completion for boto3.client("opensearchserverless").get_security_policy method. boto3 documentation

# get_security_policy method definition

def get_security_policy(
    self,
    *,
    type: SecurityPolicyTypeType,  # (1)
    name: str,
) -> GetSecurityPolicyResponseTypeDef:  # (2)
    ...

1. See SecurityPolicyTypeType
2. See GetSecurityPolicyResponseTypeDef

# get_security_policy method usage example with argument unpacking

kwargs: GetSecurityPolicyRequestTypeDef = {  # (1)
    "type": ...,
    "name": ...,
}

parent.get_security_policy(**kwargs)

1. See GetSecurityPolicyRequestTypeDef

list_access_policies

Returns information about a list of OpenSearch Serverless access policies.

Type annotations and code completion for boto3.client("opensearchserverless").list_access_policies method. boto3 documentation

# list_access_policies method definition

def list_access_policies(
    self,
    *,
    type: AccessPolicyTypeType,  # (1)
    resource: Sequence[str] = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAccessPoliciesResponseTypeDef:  # (2)
    ...

1. See AccessPolicyTypeType
2. See ListAccessPoliciesResponseTypeDef

# list_access_policies method usage example with argument unpacking

kwargs: ListAccessPoliciesRequestTypeDef = {  # (1)
    "type": ...,
}

parent.list_access_policies(**kwargs)

1. See ListAccessPoliciesRequestTypeDef

list_collections

Lists all OpenSearch Serverless collections.

Type annotations and code completion for boto3.client("opensearchserverless").list_collections method. boto3 documentation

# list_collections method definition

def list_collections(
    self,
    *,
    collectionFilters: CollectionFiltersTypeDef = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListCollectionsResponseTypeDef:  # (2)
    ...

1. See CollectionFiltersTypeDef
2. See ListCollectionsResponseTypeDef

# list_collections method usage example with argument unpacking

kwargs: ListCollectionsRequestTypeDef = {  # (1)
    "collectionFilters": ...,
}

parent.list_collections(**kwargs)

1. See ListCollectionsRequestTypeDef

list_lifecycle_policies

Returns a list of OpenSearch Serverless lifecycle policies.

Type annotations and code completion for boto3.client("opensearchserverless").list_lifecycle_policies method. boto3 documentation

# list_lifecycle_policies method definition

def list_lifecycle_policies(
    self,
    *,
    type: LifecyclePolicyTypeType,  # (1)
    resources: Sequence[str] = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListLifecyclePoliciesResponseTypeDef:  # (2)
    ...

1. See LifecyclePolicyTypeType
2. See ListLifecyclePoliciesResponseTypeDef

# list_lifecycle_policies method usage example with argument unpacking

kwargs: ListLifecyclePoliciesRequestTypeDef = {  # (1)
    "type": ...,
}

parent.list_lifecycle_policies(**kwargs)

1. See ListLifecyclePoliciesRequestTypeDef

list_security_configs

Returns information about configured OpenSearch Serverless security configurations.

Type annotations and code completion for boto3.client("opensearchserverless").list_security_configs method. boto3 documentation

# list_security_configs method definition

def list_security_configs(
    self,
    *,
    type: SecurityConfigTypeType,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListSecurityConfigsResponseTypeDef:  # (2)
    ...

1. See SecurityConfigTypeType
2. See ListSecurityConfigsResponseTypeDef

# list_security_configs method usage example with argument unpacking

kwargs: ListSecurityConfigsRequestTypeDef = {  # (1)
    "type": ...,
}

parent.list_security_configs(**kwargs)

1. See ListSecurityConfigsRequestTypeDef

list_security_policies

Returns information about configured OpenSearch Serverless security policies.

Type annotations and code completion for boto3.client("opensearchserverless").list_security_policies method. boto3 documentation

# list_security_policies method definition

def list_security_policies(
    self,
    *,
    type: SecurityPolicyTypeType,  # (1)
    resource: Sequence[str] = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListSecurityPoliciesResponseTypeDef:  # (2)
    ...

1. See SecurityPolicyTypeType
2. See ListSecurityPoliciesResponseTypeDef

# list_security_policies method usage example with argument unpacking

kwargs: ListSecurityPoliciesRequestTypeDef = {  # (1)
    "type": ...,
}

parent.list_security_policies(**kwargs)

1. See ListSecurityPoliciesRequestTypeDef

list_tags_for_resource

Returns the tags for an OpenSearch Serverless resource.

Type annotations and code completion for boto3.client("opensearchserverless").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

list_vpc_endpoints

Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account.

Type annotations and code completion for boto3.client("opensearchserverless").list_vpc_endpoints method. boto3 documentation

# list_vpc_endpoints method definition

def list_vpc_endpoints(
    self,
    *,
    vpcEndpointFilters: VpcEndpointFiltersTypeDef = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListVpcEndpointsResponseTypeDef:  # (2)
    ...

1. See VpcEndpointFiltersTypeDef
2. See ListVpcEndpointsResponseTypeDef

# list_vpc_endpoints method usage example with argument unpacking

kwargs: ListVpcEndpointsRequestTypeDef = {  # (1)
    "vpcEndpointFilters": ...,
}

parent.list_vpc_endpoints(**kwargs)

1. See ListVpcEndpointsRequestTypeDef

tag_resource

Associates tags with an OpenSearch Serverless resource.

Type annotations and code completion for boto3.client("opensearchserverless").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See Sequence[TagTypeDef]

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Removes a tag or set of tags from an OpenSearch Serverless resource.

Type annotations and code completion for boto3.client("opensearchserverless").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_access_policy

Updates an OpenSearch Serverless access policy.

Type annotations and code completion for boto3.client("opensearchserverless").update_access_policy method. boto3 documentation

# update_access_policy method definition

def update_access_policy(
    self,
    *,
    type: AccessPolicyTypeType,  # (1)
    name: str,
    policyVersion: str,
    description: str = ...,
    policy: str = ...,
    clientToken: str = ...,
) -> UpdateAccessPolicyResponseTypeDef:  # (2)
    ...

1. See AccessPolicyTypeType
2. See UpdateAccessPolicyResponseTypeDef

# update_access_policy method usage example with argument unpacking

kwargs: UpdateAccessPolicyRequestTypeDef = {  # (1)
    "type": ...,
    "name": ...,
    "policyVersion": ...,
}

parent.update_access_policy(**kwargs)

1. See UpdateAccessPolicyRequestTypeDef

update_account_settings

Update the OpenSearch Serverless settings for the current Amazon Web Services account.

Type annotations and code completion for boto3.client("opensearchserverless").update_account_settings method. boto3 documentation

# update_account_settings method definition

def update_account_settings(
    self,
    *,
    capacityLimits: CapacityLimitsTypeDef = ...,  # (1)
) -> UpdateAccountSettingsResponseTypeDef:  # (2)
    ...

1. See CapacityLimitsTypeDef
2. See UpdateAccountSettingsResponseTypeDef

# update_account_settings method usage example with argument unpacking

kwargs: UpdateAccountSettingsRequestTypeDef = {  # (1)
    "capacityLimits": ...,
}

parent.update_account_settings(**kwargs)

1. See UpdateAccountSettingsRequestTypeDef

update_collection

Updates an OpenSearch Serverless collection.

Type annotations and code completion for boto3.client("opensearchserverless").update_collection method. boto3 documentation

# update_collection method definition

def update_collection(
    self,
    *,
    id: str,
    description: str = ...,
    clientToken: str = ...,
) -> UpdateCollectionResponseTypeDef:  # (1)
    ...

1. See UpdateCollectionResponseTypeDef

# update_collection method usage example with argument unpacking

kwargs: UpdateCollectionRequestTypeDef = {  # (1)
    "id": ...,
}

parent.update_collection(**kwargs)

1. See UpdateCollectionRequestTypeDef

update_index

Updates an existing index in an OpenSearch Serverless collection.

Type annotations and code completion for boto3.client("opensearchserverless").update_index method. boto3 documentation

# update_index method definition

def update_index(
    self,
    *,
    id: str,
    indexName: str,
    indexSchema: Mapping[str, Any] = ...,
) -> Dict[str, Any]:
    ...

# update_index method usage example with argument unpacking

kwargs: UpdateIndexRequestTypeDef = {  # (1)
    "id": ...,
    "indexName": ...,
}

parent.update_index(**kwargs)

1. See UpdateIndexRequestTypeDef

update_lifecycle_policy

Updates an OpenSearch Serverless access policy.

Type annotations and code completion for boto3.client("opensearchserverless").update_lifecycle_policy method. boto3 documentation

# update_lifecycle_policy method definition

def update_lifecycle_policy(
    self,
    *,
    type: LifecyclePolicyTypeType,  # (1)
    name: str,
    policyVersion: str,
    description: str = ...,
    policy: str = ...,
    clientToken: str = ...,
) -> UpdateLifecyclePolicyResponseTypeDef:  # (2)
    ...

1. See LifecyclePolicyTypeType
2. See UpdateLifecyclePolicyResponseTypeDef

# update_lifecycle_policy method usage example with argument unpacking

kwargs: UpdateLifecyclePolicyRequestTypeDef = {  # (1)
    "type": ...,
    "name": ...,
    "policyVersion": ...,
}

parent.update_lifecycle_policy(**kwargs)

1. See UpdateLifecyclePolicyRequestTypeDef

update_security_config

Updates a security configuration for OpenSearch Serverless.

Type annotations and code completion for boto3.client("opensearchserverless").update_security_config method. boto3 documentation

# update_security_config method definition

def update_security_config(
    self,
    *,
    id: str,
    configVersion: str,
    description: str = ...,
    samlOptions: SamlConfigOptionsTypeDef = ...,  # (1)
    iamIdentityCenterOptionsUpdates: UpdateIamIdentityCenterConfigOptionsTypeDef = ...,  # (2)
    iamFederationOptions: IamFederationConfigOptionsTypeDef = ...,  # (3)
    clientToken: str = ...,
) -> UpdateSecurityConfigResponseTypeDef:  # (4)
    ...

1. See SamlConfigOptionsTypeDef
2. See UpdateIamIdentityCenterConfigOptionsTypeDef
3. See IamFederationConfigOptionsTypeDef
4. See UpdateSecurityConfigResponseTypeDef

# update_security_config method usage example with argument unpacking

kwargs: UpdateSecurityConfigRequestTypeDef = {  # (1)
    "id": ...,
    "configVersion": ...,
}

parent.update_security_config(**kwargs)

1. See UpdateSecurityConfigRequestTypeDef

update_security_policy

Updates an OpenSearch Serverless security policy.

Type annotations and code completion for boto3.client("opensearchserverless").update_security_policy method. boto3 documentation

# update_security_policy method definition

def update_security_policy(
    self,
    *,
    type: SecurityPolicyTypeType,  # (1)
    name: str,
    policyVersion: str,
    description: str = ...,
    policy: str = ...,
    clientToken: str = ...,
) -> UpdateSecurityPolicyResponseTypeDef:  # (2)
    ...

1. See SecurityPolicyTypeType
2. See UpdateSecurityPolicyResponseTypeDef

# update_security_policy method usage example with argument unpacking

kwargs: UpdateSecurityPolicyRequestTypeDef = {  # (1)
    "type": ...,
    "name": ...,
    "policyVersion": ...,
}

parent.update_security_policy(**kwargs)

1. See UpdateSecurityPolicyRequestTypeDef

update_vpc_endpoint

Updates an OpenSearch Serverless-managed interface endpoint.

Type annotations and code completion for boto3.client("opensearchserverless").update_vpc_endpoint method. boto3 documentation

# update_vpc_endpoint method definition

def update_vpc_endpoint(
    self,
    *,
    id: str,
    addSubnetIds: Sequence[str] = ...,
    removeSubnetIds: Sequence[str] = ...,
    addSecurityGroupIds: Sequence[str] = ...,
    removeSecurityGroupIds: Sequence[str] = ...,
    clientToken: str = ...,
) -> UpdateVpcEndpointResponseTypeDef:  # (1)
    ...

1. See UpdateVpcEndpointResponseTypeDef

# update_vpc_endpoint method usage example with argument unpacking

kwargs: UpdateVpcEndpointRequestTypeDef = {  # (1)
    "id": ...,
}

parent.update_vpc_endpoint(**kwargs)

1. See UpdateVpcEndpointRequestTypeDef