OpenSearchServiceServerlessClient

Index > OpenSearchServiceServerless > OpenSearchServiceServerlessClient

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

OpenSearchServiceServerlessClient

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

# OpenSearchServiceServerlessClient usage example

from boto3.session import Session
from mypy_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 mypy_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 and the OpenSearch Dashboards endpoint.

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: BatchGetCollectionRequestRequestTypeDef = {  # (1)
    "ids": ...,
}

parent.batch_get_collection(**kwargs)

1. See BatchGetCollectionRequestRequestTypeDef

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 LifecyclePolicyResourceIdentifierTypeDef
2. See BatchGetEffectiveLifecyclePolicyResponseTypeDef

# batch_get_effective_lifecycle_policy method usage example with argument unpacking

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

parent.batch_get_effective_lifecycle_policy(**kwargs)

1. See BatchGetEffectiveLifecyclePolicyRequestRequestTypeDef

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 LifecyclePolicyIdentifierTypeDef
2. See BatchGetLifecyclePolicyResponseTypeDef

# batch_get_lifecycle_policy method usage example with argument unpacking

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

parent.batch_get_lifecycle_policy(**kwargs)

1. See BatchGetLifecyclePolicyRequestRequestTypeDef

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: BatchGetVpcEndpointRequestRequestTypeDef = {  # (1)
    "ids": ...,
}

parent.batch_get_vpc_endpoint(**kwargs)

1. See BatchGetVpcEndpointRequestRequestTypeDef

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,
    *,
    name: str,
    policy: str,
    type: AccessPolicyTypeType,  # (1)
    clientToken: str = ...,
    description: str = ...,
) -> CreateAccessPolicyResponseTypeDef:  # (2)
    ...

1. See AccessPolicyTypeType
2. See CreateAccessPolicyResponseTypeDef

# create_access_policy method usage example with argument unpacking

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

parent.create_access_policy(**kwargs)

1. See CreateAccessPolicyRequestRequestTypeDef

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,
    clientToken: str = ...,
    description: str = ...,
    standbyReplicas: StandbyReplicasType = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
    type: CollectionTypeType = ...,  # (3)
) -> CreateCollectionResponseTypeDef:  # (4)
    ...

1. See StandbyReplicasType
2. See TagTypeDef
3. See CollectionTypeType
4. See CreateCollectionResponseTypeDef

# create_collection method usage example with argument unpacking

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

parent.create_collection(**kwargs)

1. See CreateCollectionRequestRequestTypeDef

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,
    *,
    name: str,
    policy: str,
    type: LifecyclePolicyTypeType,  # (1)
    clientToken: str = ...,
    description: str = ...,
) -> CreateLifecyclePolicyResponseTypeDef:  # (2)
    ...

1. See LifecyclePolicyTypeType
2. See CreateLifecyclePolicyResponseTypeDef

# create_lifecycle_policy method usage example with argument unpacking

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

parent.create_lifecycle_policy(**kwargs)

1. See CreateLifecyclePolicyRequestRequestTypeDef

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,
    *,
    name: str,
    type: SecurityConfigTypeType,  # (1)
    clientToken: str = ...,
    description: str = ...,
    iamIdentityCenterOptions: CreateIamIdentityCenterConfigOptionsTypeDef = ...,  # (2)
    samlOptions: SamlConfigOptionsTypeDef = ...,  # (3)
) -> CreateSecurityConfigResponseTypeDef:  # (4)
    ...

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

# create_security_config method usage example with argument unpacking

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

parent.create_security_config(**kwargs)

1. See CreateSecurityConfigRequestRequestTypeDef

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,
    *,
    name: str,
    policy: str,
    type: SecurityPolicyTypeType,  # (1)
    clientToken: str = ...,
    description: str = ...,
) -> CreateSecurityPolicyResponseTypeDef:  # (2)
    ...

1. See SecurityPolicyTypeType
2. See CreateSecurityPolicyResponseTypeDef

# create_security_policy method usage example with argument unpacking

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

parent.create_security_policy(**kwargs)

1. See CreateSecurityPolicyRequestRequestTypeDef

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,
    subnetIds: Sequence[str],
    vpcId: str,
    clientToken: str = ...,
    securityGroupIds: Sequence[str] = ...,
) -> CreateVpcEndpointResponseTypeDef:  # (1)
    ...

1. See CreateVpcEndpointResponseTypeDef

# create_vpc_endpoint method usage example with argument unpacking

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

parent.create_vpc_endpoint(**kwargs)

1. See CreateVpcEndpointRequestRequestTypeDef

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,
    *,
    name: str,
    type: AccessPolicyTypeType,  # (1)
    clientToken: str = ...,
) -> dict[str, Any]:
    ...

1. See AccessPolicyTypeType

# delete_access_policy method usage example with argument unpacking

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

parent.delete_access_policy(**kwargs)

1. See DeleteAccessPolicyRequestRequestTypeDef

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: DeleteCollectionRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_collection(**kwargs)

1. See DeleteCollectionRequestRequestTypeDef

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,
    *,
    name: str,
    type: LifecyclePolicyTypeType,  # (1)
    clientToken: str = ...,
) -> dict[str, Any]:
    ...

1. See LifecyclePolicyTypeType

# delete_lifecycle_policy method usage example with argument unpacking

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

parent.delete_lifecycle_policy(**kwargs)

1. See DeleteLifecyclePolicyRequestRequestTypeDef

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: DeleteSecurityConfigRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_security_config(**kwargs)

1. See DeleteSecurityConfigRequestRequestTypeDef

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,
    *,
    name: str,
    type: SecurityPolicyTypeType,  # (1)
    clientToken: str = ...,
) -> dict[str, Any]:
    ...

1. See SecurityPolicyTypeType

# delete_security_policy method usage example with argument unpacking

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

parent.delete_security_policy(**kwargs)

1. See DeleteSecurityPolicyRequestRequestTypeDef

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: DeleteVpcEndpointRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_vpc_endpoint(**kwargs)

1. See DeleteVpcEndpointRequestRequestTypeDef

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,
    *,
    name: str,
    type: AccessPolicyTypeType,  # (1)
) -> GetAccessPolicyResponseTypeDef:  # (2)
    ...

1. See AccessPolicyTypeType
2. See GetAccessPolicyResponseTypeDef

# get_access_policy method usage example with argument unpacking

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

parent.get_access_policy(**kwargs)

1. See GetAccessPolicyRequestRequestTypeDef

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_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: GetSecurityConfigRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_security_config(**kwargs)

1. See GetSecurityConfigRequestRequestTypeDef

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,
    *,
    name: str,
    type: SecurityPolicyTypeType,  # (1)
) -> GetSecurityPolicyResponseTypeDef:  # (2)
    ...

1. See SecurityPolicyTypeType
2. See GetSecurityPolicyResponseTypeDef

# get_security_policy method usage example with argument unpacking

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

parent.get_security_policy(**kwargs)

1. See GetSecurityPolicyRequestRequestTypeDef

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)
    maxResults: int = ...,
    nextToken: str = ...,
    resource: Sequence[str] = ...,
) -> ListAccessPoliciesResponseTypeDef:  # (2)
    ...

1. See AccessPolicyTypeType
2. See ListAccessPoliciesResponseTypeDef

# list_access_policies method usage example with argument unpacking

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

parent.list_access_policies(**kwargs)

1. See ListAccessPoliciesRequestRequestTypeDef

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)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListCollectionsResponseTypeDef:  # (2)
    ...

1. See CollectionFiltersTypeDef
2. See ListCollectionsResponseTypeDef

# list_collections method usage example with argument unpacking

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

parent.list_collections(**kwargs)

1. See ListCollectionsRequestRequestTypeDef

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)
    maxResults: int = ...,
    nextToken: str = ...,
    resources: Sequence[str] = ...,
) -> ListLifecyclePoliciesResponseTypeDef:  # (2)
    ...

1. See LifecyclePolicyTypeType
2. See ListLifecyclePoliciesResponseTypeDef

# list_lifecycle_policies method usage example with argument unpacking

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

parent.list_lifecycle_policies(**kwargs)

1. See ListLifecyclePoliciesRequestRequestTypeDef

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)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSecurityConfigsResponseTypeDef:  # (2)
    ...

1. See SecurityConfigTypeType
2. See ListSecurityConfigsResponseTypeDef

# list_security_configs method usage example with argument unpacking

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

parent.list_security_configs(**kwargs)

1. See ListSecurityConfigsRequestRequestTypeDef

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)
    maxResults: int = ...,
    nextToken: str = ...,
    resource: Sequence[str] = ...,
) -> ListSecurityPoliciesResponseTypeDef:  # (2)
    ...

1. See SecurityPolicyTypeType
2. See ListSecurityPoliciesResponseTypeDef

# list_security_policies method usage example with argument unpacking

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

parent.list_security_policies(**kwargs)

1. See ListSecurityPoliciesRequestRequestTypeDef

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: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

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,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    vpcEndpointFilters: VpcEndpointFiltersTypeDef = ...,  # (1)
) -> ListVpcEndpointsResponseTypeDef:  # (2)
    ...

1. See VpcEndpointFiltersTypeDef
2. See ListVpcEndpointsResponseTypeDef

# list_vpc_endpoints method usage example with argument unpacking

kwargs: ListVpcEndpointsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_vpc_endpoints(**kwargs)

1. See ListVpcEndpointsRequestRequestTypeDef

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 TagTypeDef

# tag_resource method usage example with argument unpacking

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

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

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: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

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,
    *,
    name: str,
    policyVersion: str,
    type: AccessPolicyTypeType,  # (1)
    clientToken: str = ...,
    description: str = ...,
    policy: str = ...,
) -> UpdateAccessPolicyResponseTypeDef:  # (2)
    ...

1. See AccessPolicyTypeType
2. See UpdateAccessPolicyResponseTypeDef

# update_access_policy method usage example with argument unpacking

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

parent.update_access_policy(**kwargs)

1. See UpdateAccessPolicyRequestRequestTypeDef

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: UpdateAccountSettingsRequestRequestTypeDef = {  # (1)
    "capacityLimits": ...,
}

parent.update_account_settings(**kwargs)

1. See UpdateAccountSettingsRequestRequestTypeDef

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,
    clientToken: str = ...,
    description: str = ...,
) -> UpdateCollectionResponseTypeDef:  # (1)
    ...

1. See UpdateCollectionResponseTypeDef

# update_collection method usage example with argument unpacking

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

parent.update_collection(**kwargs)

1. See UpdateCollectionRequestRequestTypeDef

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,
    *,
    name: str,
    policyVersion: str,
    type: LifecyclePolicyTypeType,  # (1)
    clientToken: str = ...,
    description: str = ...,
    policy: str = ...,
) -> UpdateLifecyclePolicyResponseTypeDef:  # (2)
    ...

1. See LifecyclePolicyTypeType
2. See UpdateLifecyclePolicyResponseTypeDef

# update_lifecycle_policy method usage example with argument unpacking

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

parent.update_lifecycle_policy(**kwargs)

1. See UpdateLifecyclePolicyRequestRequestTypeDef

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,
    *,
    configVersion: str,
    id: str,
    clientToken: str = ...,
    description: str = ...,
    iamIdentityCenterOptionsUpdates: UpdateIamIdentityCenterConfigOptionsTypeDef = ...,  # (1)
    samlOptions: SamlConfigOptionsTypeDef = ...,  # (2)
) -> UpdateSecurityConfigResponseTypeDef:  # (3)
    ...

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

# update_security_config method usage example with argument unpacking

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

parent.update_security_config(**kwargs)

1. See UpdateSecurityConfigRequestRequestTypeDef

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,
    *,
    name: str,
    policyVersion: str,
    type: SecurityPolicyTypeType,  # (1)
    clientToken: str = ...,
    description: str = ...,
    policy: str = ...,
) -> UpdateSecurityPolicyResponseTypeDef:  # (2)
    ...

1. See SecurityPolicyTypeType
2. See UpdateSecurityPolicyResponseTypeDef

# update_security_policy method usage example with argument unpacking

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

parent.update_security_policy(**kwargs)

1. See UpdateSecurityPolicyRequestRequestTypeDef

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,
    addSecurityGroupIds: Sequence[str] = ...,
    addSubnetIds: Sequence[str] = ...,
    clientToken: str = ...,
    removeSecurityGroupIds: Sequence[str] = ...,
    removeSubnetIds: Sequence[str] = ...,
) -> UpdateVpcEndpointResponseTypeDef:  # (1)
    ...

1. See UpdateVpcEndpointResponseTypeDef

# update_vpc_endpoint method usage example with argument unpacking

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

parent.update_vpc_endpoint(**kwargs)

1. See UpdateVpcEndpointRequestRequestTypeDef