data_source_attachments

Creates, updates, deletes, gets or lists a data_source_attachments resource.

Overview

Name	data_source_attachments
Type	Resource
Id	aws.opensearch.data_source_attachments

Fields

The following fields are returned by SELECT queries:

describe_data_source_attachment

Name	Datatype	Description
id	string	The unique identifier of the OpenSearch application. (pattern: <code>[a-z0-9]{3,30}</code>)
arn	string	The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using Amazon Web Services Identity and Access Management for more information. (pattern: <code>.*</code>)
attachment_id	string	The unique identifier assigned to the data source attachment.
data_source_arn	string	The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using Amazon Web Services Identity and Access Management for more information. (pattern: <code>.*</code>)
status	string	The status of the data source attachment. Valid values are PENDING, ATTACHED, and FAILED. (PENDING, ATTACHED, FAILED)

list_data_source_attachments

Name	Datatype	Description
attachments	array	A list of data source attachment summaries for the specified application.
next_token	string	The pagination token to use in a subsequent call to retrieve the next set of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_data_source_attachment	select	id, region		Returns the current status and details of a specific data source attachment for an OpenSearch application. Throws a ResourceNotFoundException if no attachment record exists for the specified application and data source combination.
list_data_source_attachments	select	id, region		Returns a paginated list of all data source attachments for an OpenSearch application, including attachments in all states (PENDING, ATTACHED, and FAILED).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The unique identifier or name of the OpenSearch application to list attachments for.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_data_source_attachment

Returns the current status and details of a specific data source attachment for an OpenSearch application. Throws a ResourceNotFoundException if no attachment record exists for the specified application and data source combination.

SELECT
id,
arn,
attachment_id,
data_source_arn,
status
FROM aws.opensearch.data_source_attachments
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_data_source_attachments

Returns a paginated list of all data source attachments for an OpenSearch application, including attachments in all states (PENDING, ATTACHED, and FAILED).

SELECT
attachments,
next_token
FROM aws.opensearch.data_source_attachments
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;