airflow.providers.amazon.aws.operators.opensearch_serverless¶

Amazon OpenSearch Serverless operators.

Classes¶

OpenSearchServerlessCreateCollectionOperator

Create an Amazon OpenSearch Serverless collection.

Module Contents¶

class airflow.providers.amazon.aws.operators.opensearch_serverless.OpenSearchServerlessCreateCollectionOperator(*, collection_name, collection_type='SEARCH', description=None, standby_replicas=None, tags=None, if_exists='skip', **kwargs)[source]¶

Bases: airflow.providers.amazon.aws.operators.base_aws.AwsBaseOperator[airflow.providers.amazon.aws.hooks.opensearch_serverless.OpenSearchServerlessHook]

Create an Amazon OpenSearch Serverless collection.

See also

For more information on how to use this operator, take a look at the guide: Create a Collection

Parameters:

collection_name (str) – The name of the collection. (templated)
collection_type (str) – The type of collection (SEARCH, TIMESERIES, VECTORSEARCH). (templated)
description (str | None) – Optional description. (templated)
standby_replicas (str | None) – Whether to use standby replicas (ENABLED or DISABLED).
tags (list[dict[str, str]] | None) – Optional list of tag dicts.
if_exists (Literal['fail', 'skip']) – Behavior when the collection already exists. "fail" raises an error, "skip" logs and returns.

aws_hook_class[source]¶

template_fields: collections.abc.Sequence[str][source]¶

collection_name[source]¶

collection_type = 'SEARCH'[source]¶

description = None[source]¶

standby_replicas = None[source]¶

tags = None[source]¶

if_exists = 'skip'[source]¶

execute(context)[source]¶

Derive when creating an operator.

The main method to execute the task. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.