applications

Creates, updates, deletes, gets or lists an applications resource.

Overview

Name	applications
Type	Resource
Id	aws.opensearch.applications

Fields

The following fields are returned by SELECT queries:

get_application

Name	Datatype	Description
id	string	The unique identifier of the OpenSearch application. (pattern: <code>[a-z0-9]{3,30}</code>)
name	string	The name of the OpenSearch application. (pattern: <code>[a-z][a-z0-9-]+</code>)
app_configs	array	The configuration settings of the OpenSearch application.
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>)
created_at	string (date-time)	The timestamp when the OpenSearch application was created.
data_sources	array	The data sources associated with the OpenSearch application.
endpoint	string	The endpoint URL of the OpenSearch application.
iam_identity_center_options	object	The IAM Identity Center settings configured for the OpenSearch application.
kms_key_arn	string	The Amazon Resource Name (ARN) of the KMS key used to encrypt the application's data at rest. (pattern: <code>^arn:aws[a-zA-Z-]*:kms:[a-z0-9-]+:[0-9]{12}:key/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$</code>)
last_updated_at	string (date-time)	The timestamp of the last update to the OpenSearch application.
status	string	The current status of the OpenSearch application. Possible values: CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED. (CREATING, UPDATING, DELETING, ACTIVE, FAILED)

list_applications

Name	Datatype	Description
id	string	The unique identifier of an OpenSearch application. (pattern: <code>[a-z0-9]{3,30}</code>)
name	string	The name of an OpenSearch application. (pattern: <code>[a-z][a-z0-9-]+</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>)
created_at	string (date-time)	The timestamp when an OpenSearch application was created.
endpoint	string	The endpoint URL of an OpenSearch application.
last_updated_at	string (date-time)	The timestamp of the last update to an OpenSearch application.
status	string	The current status of an OpenSearch application. Possible values: CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED. (CREATING, UPDATING, DELETING, ACTIVE, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_application	select	id, region		Retrieves the configuration and status of an existing OpenSearch application.
list_applications	select	region	nextToken, statuses, maxResults	Lists all OpenSearch applications under your account.
create_application	insert	region, name		Creates an OpenSearch UI application. For more information, see Using the OpenSearch user interface in Amazon OpenSearch Service.
update_application	update	id, region		Updates the configuration and settings of an existing OpenSearch application.
delete_application	delete	id, region		Deletes a specified OpenSearch application.
start_migration	exec	region, applicationId, migrationOptions		Initiates a migration job to migrate saved objects from a data source to an Amazon OpenSearch Service application workspace. Saved objects include dashboards, visualizations, index patterns, and searches. You can specify export filters to control the scope of the migration and a conflict resolution strategy for handling existing objects in the target workspace.

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 of the OpenSearch application to delete.
region	string	AWS region (default: us-east-1)
maxResults	integer
nextToken	string
statuses	array	Filters the list of OpenSearch applications by status. Possible values: CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.

SELECT examples

get_application

Retrieves the configuration and status of an existing OpenSearch application.

SELECT
id,
name,
app_configs,
arn,
created_at,
data_sources,
endpoint,
iam_identity_center_options,
kms_key_arn,
last_updated_at,
status
FROM aws.opensearch.applications
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_applications

Lists all OpenSearch applications under your account.

SELECT
id,
name,
arn,
created_at,
endpoint,
last_updated_at,
status
FROM aws.opensearch.applications
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND statuses = '{{ statuses }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_application

Creates an OpenSearch UI application. For more information, see Using the OpenSearch user interface in Amazon OpenSearch Service.

INSERT INTO aws.opensearch.applications (
clientToken,
name,
dataSources,
iamIdentityCenterOptions,
appConfigs,
tagList,
kmsKeyArn,
region
)
SELECT 
'{{ clientToken }}',
'{{ name }}' /* required */,
'{{ dataSources }}',
'{{ iamIdentityCenterOptions }}',
'{{ appConfigs }}',
'{{ tagList }}',
'{{ kmsKeyArn }}',
'{{ region }}'
RETURNING
id,
name,
app_configs,
arn,
created_at,
data_sources,
iam_identity_center_options,
kms_key_arn,
tag_list
;

Manifest

# Description fields are for documentation purposes
- name: applications
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the applications resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: name
    value: "{{ name }}"
  - name: dataSources
    value:
      - dataSourceArn: "{{ dataSourceArn }}"
        dataSourceDescription: "{{ dataSourceDescription }}"
        iamRoleForDataSourceArn: "{{ iamRoleForDataSourceArn }}"
  - name: iamIdentityCenterOptions
    description: |
      Configuration settings for enabling and managing IAM Identity Center.
    value:
      enabled: {{ enabled }}
      iamIdentityCenterInstanceArn: "{{ iamIdentityCenterInstanceArn }}"
      iamRoleForIdentityCenterApplicationArn: "{{ iamRoleForIdentityCenterApplicationArn }}"
  - name: appConfigs
    value:
      - key: "{{ key }}"
        value: "{{ value }}"
  - name: tagList
    description: |
      A list of tags attached to a domain.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: kmsKeyArn
    value: "{{ kmsKeyArn }}"

UPDATE examples

update_application

Updates the configuration and settings of an existing OpenSearch application.

UPDATE aws.opensearch.applications
SET 
dataSources = '{{ dataSources }}',
appConfigs = '{{ appConfigs }}',
iamIdentityCenterOptions = '{{ iamIdentityCenterOptions }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
RETURNING
id,
name,
app_configs,
arn,
created_at,
data_sources,
iam_identity_center_options,
last_updated_at;

DELETE examples

delete_application

Deletes a specified OpenSearch application.

DELETE FROM aws.opensearch.applications
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

start_migration

Initiates a migration job to migrate saved objects from a data source to an Amazon OpenSearch Service application workspace. Saved objects include dashboards, visualizations, index patterns, and searches. You can specify export filters to control the scope of the migration and a conflict resolution strategy for handling existing objects in the target workspace.

EXEC aws.opensearch.applications.start_migration 
@region='{{ region }}' --required 
@@json=
'{
"applicationId": "{{ applicationId }}", 
"migrationOptions": "{{ migrationOptions }}", 
"clientToken": "{{ clientToken }}"
}'
;