Skip to content

AttachDataSourceRequest

Source code in docs_src/capo_opensearch/types/attach_data_source_request.py
class AttachDataSourceRequest(TypedDict, closed=True):
    id: "capo_opensearch.types.id.Id"
    """<p>The unique identifier or name of the OpenSearch application to attach the data source to. This is the same identifier used with <code>UpdateApplication</code>, <code>GetApplication</code>, and <code>DeleteApplication</code>.</p>"""
    data_source_arn: "capo_opensearch.types.arn.ARN"
    workspace_id: NotRequired["capo_opensearch.types.string.String"]
    """<p>The identifier of an existing workspace to update with the new data source. Mutually exclusive with <code>workspaceConfiguration</code>.</p>"""
    workspace_configuration: NotRequired[
        "capo_opensearch.types.workspace_configuration_input.WorkspaceConfigurationInput"
    ]
    """<p>Configuration for creating a new workspace during the attachment. If specified, a workspace is created and linked to the data source after the attachment completes. Mutually exclusive with <code>workspaceId</code>.</p>"""
    client_token: NotRequired["capo_opensearch.types.client_token.ClientToken"]
    """<p>A unique, case-sensitive identifier to ensure idempotency of the request. If you retry a request with the same client token and the same parameters, the retry succeeds without performing any further actions.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

A unique, case-sensitive identifier to ensure idempotency of the request. If you retry a request with the same client token and the same parameters, the retry succeeds without performing any further actions.

data_source_arn instance-attribute

data_source_arn: ARN

id instance-attribute

id: Id

The unique identifier or name of the OpenSearch application to attach the data source to. This is the same identifier used with UpdateApplication, GetApplication, and DeleteApplication.

workspace_configuration instance-attribute

workspace_configuration: NotRequired[WorkspaceConfigurationInput]

Configuration for creating a new workspace during the attachment. If specified, a workspace is created and linked to the data source after the attachment completes. Mutually exclusive with workspaceId.

workspace_id instance-attribute

workspace_id: NotRequired[String]

The identifier of an existing workspace to update with the new data source. Mutually exclusive with workspaceConfiguration.