Client

opensearchserviceserverless

R Documentation

OpenSearch Service Serverless¶

Description¶

Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and security policies.

OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for Amazon OpenSearch Service. OpenSearch Serverless removes the operational complexities of provisioning, configuring, and tuning your OpenSearch clusters. It enables you to easily search and analyze petabytes of data without having to worry about the underlying infrastructure and data management.

To learn more about OpenSearch Serverless, see What is Amazon OpenSearch Serverless?

Usage¶

opensearchserviceserverless(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- opensearchserviceserverless(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

batch_get_collection: Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint
batch_get_effective_lifecycle_policy: Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes
batch_get_lifecycle_policy: Returns one or more configured OpenSearch Serverless lifecycle policies
batch_get_vpc_endpoint: Returns attributes for one or more VPC endpoints associated with the current account
create_access_policy: Creates a data access policy for OpenSearch Serverless
create_collection: Creates a new OpenSearch Serverless collection
create_lifecycle_policy: Creates a lifecyle policy to be applied to OpenSearch Serverless indexes
create_security_config: Specifies a security configuration for OpenSearch Serverless
create_security_policy: Creates a security policy to be used by one or more OpenSearch Serverless collections
create_vpc_endpoint: Creates an OpenSearch Serverless-managed interface VPC endpoint
delete_access_policy: Deletes an OpenSearch Serverless access policy
delete_collection: Deletes an OpenSearch Serverless collection
delete_lifecycle_policy: Deletes an OpenSearch Serverless lifecycle policy
delete_security_config: Deletes a security configuration for OpenSearch Serverless
delete_security_policy: Deletes an OpenSearch Serverless security policy
delete_vpc_endpoint: Deletes an OpenSearch Serverless-managed interface endpoint
get_access_policy: Returns an OpenSearch Serverless access policy
get_account_settings: Returns account-level settings related to OpenSearch Serverless
get_policies_stats: Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies
get_security_config: Returns information about an OpenSearch Serverless security configuration
get_security_policy: Returns information about a configured OpenSearch Serverless security policy
list_access_policies: Returns information about a list of OpenSearch Serverless access policies
list_collections: Lists all OpenSearch Serverless collections
list_lifecycle_policies: Returns a list of OpenSearch Serverless lifecycle policies
list_security_configs: Returns information about configured OpenSearch Serverless security configurations
list_security_policies: Returns information about configured OpenSearch Serverless security policies
list_tags_for_resource: Returns the tags for an OpenSearch Serverless resource
list_vpc_endpoints: Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account
tag_resource: Associates tags with an OpenSearch Serverless resource
untag_resource: Removes a tag or set of tags from an OpenSearch Serverless resource
update_access_policy: Updates an OpenSearch Serverless access policy
update_account_settings: Update the OpenSearch Serverless settings for the current Amazon Web Services account
update_collection: Updates an OpenSearch Serverless collection
update_lifecycle_policy: Updates an OpenSearch Serverless access policy
update_security_config: Updates a security configuration for OpenSearch Serverless
update_security_policy: Updates an OpenSearch Serverless security policy
update_vpc_endpoint: Updates an OpenSearch Serverless-managed interface endpoint

Examples¶

## Not run: 
svc <- opensearchserviceserverless()
svc$batch_get_collection(
  Foo = 123
)

## End(Not run)