OpenSearchServerless

import { OpenSearchServerless } from "https://aws-api.deno.dev/v0.4/services/opensearchserverless.ts?docs=full";

class OpenSearchServerless {

constructor(apiFactory: client.ApiFactory);

async batchGetCollection(params?: BatchGetCollectionRequest, opts?: client.RequestOptions): Promise<BatchGetCollectionResponse>;

async batchGetVpcEndpoint(params: BatchGetVpcEndpointRequest, opts?: client.RequestOptions): Promise<BatchGetVpcEndpointResponse>;

async createAccessPolicy(params: CreateAccessPolicyRequest, opts?: client.RequestOptions): Promise<CreateAccessPolicyResponse>;

async createCollection(params: CreateCollectionRequest, opts?: client.RequestOptions): Promise<CreateCollectionResponse>;

async createSecurityConfig(params: CreateSecurityConfigRequest, opts?: client.RequestOptions): Promise<CreateSecurityConfigResponse>;

async createSecurityPolicy(params: CreateSecurityPolicyRequest, opts?: client.RequestOptions): Promise<CreateSecurityPolicyResponse>;

async createVpcEndpoint(params: CreateVpcEndpointRequest, opts?: client.RequestOptions): Promise<CreateVpcEndpointResponse>;

async deleteAccessPolicy(params: DeleteAccessPolicyRequest, opts?: client.RequestOptions): Promise<void>;

async deleteCollection(params: DeleteCollectionRequest, opts?: client.RequestOptions): Promise<DeleteCollectionResponse>;

async deleteSecurityConfig(params: DeleteSecurityConfigRequest, opts?: client.RequestOptions): Promise<void>;

async deleteSecurityPolicy(params: DeleteSecurityPolicyRequest, opts?: client.RequestOptions): Promise<void>;

async deleteVpcEndpoint(params: DeleteVpcEndpointRequest, opts?: client.RequestOptions): Promise<DeleteVpcEndpointResponse>;

async getAccessPolicy(params: GetAccessPolicyRequest, opts?: client.RequestOptions): Promise<GetAccessPolicyResponse>;

async getAccountSettings(opts?: client.RequestOptions): Promise<GetAccountSettingsResponse>;

async getPoliciesStats(opts?: client.RequestOptions): Promise<GetPoliciesStatsResponse>;

async getSecurityConfig(params: GetSecurityConfigRequest, opts?: client.RequestOptions): Promise<GetSecurityConfigResponse>;

async getSecurityPolicy(params: GetSecurityPolicyRequest, opts?: client.RequestOptions): Promise<GetSecurityPolicyResponse>;

async listAccessPolicies(params: ListAccessPoliciesRequest, opts?: client.RequestOptions): Promise<ListAccessPoliciesResponse>;

async listCollections(params?: ListCollectionsRequest, opts?: client.RequestOptions): Promise<ListCollectionsResponse>;

async listSecurityConfigs(params: ListSecurityConfigsRequest, opts?: client.RequestOptions): Promise<ListSecurityConfigsResponse>;

async listSecurityPolicies(params: ListSecurityPoliciesRequest, opts?: client.RequestOptions): Promise<ListSecurityPoliciesResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async listVpcEndpoints(params?: ListVpcEndpointsRequest, opts?: client.RequestOptions): Promise<ListVpcEndpointsResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateAccessPolicy(params: UpdateAccessPolicyRequest, opts?: client.RequestOptions): Promise<UpdateAccessPolicyResponse>;

async updateAccountSettings(params?: UpdateAccountSettingsRequest, opts?: client.RequestOptions): Promise<UpdateAccountSettingsResponse>;

async updateCollection(params: UpdateCollectionRequest, opts?: client.RequestOptions): Promise<UpdateCollectionResponse>;

async updateSecurityConfig(params: UpdateSecurityConfigRequest, opts?: client.RequestOptions): Promise<UpdateSecurityConfigResponse>;

async updateSecurityPolicy(params: UpdateSecurityPolicyRequest, opts?: client.RequestOptions): Promise<UpdateSecurityPolicyResponse>;

async updateVpcEndpoint(params: UpdateVpcEndpointRequest, opts?: client.RequestOptions): Promise<UpdateVpcEndpointResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new OpenSearchServerless(apiFactory: client.ApiFactory)

[src]

§Methods

batchGetCollection(params?: BatchGetCollectionRequest, opts?: client.RequestOptions): Promise<BatchGetCollectionResponse>

[src]

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

batchGetVpcEndpoint(params: BatchGetVpcEndpointRequest, opts?: client.RequestOptions): Promise<BatchGetVpcEndpointResponse>

[src]

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

createAccessPolicy(params: CreateAccessPolicyRequest, opts?: client.RequestOptions): Promise<CreateAccessPolicyResponse>

[src]

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

createCollection(params: CreateCollectionRequest, opts?: client.RequestOptions): Promise<CreateCollectionResponse>

[src]

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

createSecurityConfig(params: CreateSecurityConfigRequest, opts?: client.RequestOptions): Promise<CreateSecurityConfigResponse>

[src]

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

createSecurityPolicy(params: CreateSecurityPolicyRequest, opts?: client.RequestOptions): Promise<CreateSecurityPolicyResponse>

[src]

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

createVpcEndpoint(params: CreateVpcEndpointRequest, opts?: client.RequestOptions): Promise<CreateVpcEndpointResponse>

[src]

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

deleteAccessPolicy(params: DeleteAccessPolicyRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

deleteCollection(params: DeleteCollectionRequest, opts?: client.RequestOptions): Promise<DeleteCollectionResponse>

[src]

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

deleteSecurityConfig(params: DeleteSecurityConfigRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

deleteSecurityPolicy(params: DeleteSecurityPolicyRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes an OpenSearch Serverless security policy.

deleteVpcEndpoint(params: DeleteVpcEndpointRequest, opts?: client.RequestOptions): Promise<DeleteVpcEndpointResponse>

[src]

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

getAccessPolicy(params: GetAccessPolicyRequest, opts?: client.RequestOptions): Promise<GetAccessPolicyResponse>

[src]

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

getAccountSettings(opts?: client.RequestOptions): Promise<GetAccountSettingsResponse>

[src]

Returns account-level settings related to OpenSearch Serverless.

getPoliciesStats(opts?: client.RequestOptions): Promise<GetPoliciesStatsResponse>

[src]

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

getSecurityConfig(params: GetSecurityConfigRequest, opts?: client.RequestOptions): Promise<GetSecurityConfigResponse>

[src]

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

getSecurityPolicy(params: GetSecurityPolicyRequest, opts?: client.RequestOptions): Promise<GetSecurityPolicyResponse>

[src]

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

listAccessPolicies(params: ListAccessPoliciesRequest, opts?: client.RequestOptions): Promise<ListAccessPoliciesResponse>

[src]

Returns information about a list of OpenSearch Serverless access policies.

listCollections(params?: ListCollectionsRequest, opts?: client.RequestOptions): Promise<ListCollectionsResponse>

[src]

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

Note: Make sure to include an empty request body {} if you don't include any collection filters in the request.

listSecurityConfigs(params: ListSecurityConfigsRequest, opts?: client.RequestOptions): Promise<ListSecurityConfigsResponse>

[src]

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

listSecurityPolicies(params: ListSecurityPoliciesRequest, opts?: client.RequestOptions): Promise<ListSecurityPoliciesResponse>

[src]

Returns information about configured OpenSearch Serverless security policies.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

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

listVpcEndpoints(params?: ListVpcEndpointsRequest, opts?: client.RequestOptions): Promise<ListVpcEndpointsResponse>

[src]

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

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

updateAccessPolicy(params: UpdateAccessPolicyRequest, opts?: client.RequestOptions): Promise<UpdateAccessPolicyResponse>

[src]

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

updateAccountSettings(params?: UpdateAccountSettingsRequest, opts?: client.RequestOptions): Promise<UpdateAccountSettingsResponse>

[src]

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

updateCollection(params: UpdateCollectionRequest, opts?: client.RequestOptions): Promise<UpdateCollectionResponse>

[src]

Updates an OpenSearch Serverless collection.

updateSecurityConfig(params: UpdateSecurityConfigRequest, opts?: client.RequestOptions): Promise<UpdateSecurityConfigResponse>

[src]

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

updateSecurityPolicy(params: UpdateSecurityPolicyRequest, opts?: client.RequestOptions): Promise<UpdateSecurityPolicyResponse>

[src]

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

updateVpcEndpoint(params: UpdateVpcEndpointRequest, opts?: client.RequestOptions): Promise<UpdateVpcEndpointResponse>

[src]

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

§Static Properties

ApiMetadata: client.ApiMetadata

[src]