applications

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

Overview

Name	applications
Type	Resource
Id	aws.iotsitewise.applications

Fields

The following fields are returned by SELECT queries:

describe_application

Name	Datatype	Description
id	string	Unique identifier for the application (pattern: <code>[a-z0-9-]{36}</code>)
name	string	Name of the application (pattern: <code>[A-Za-z0-9](?:[A-Za-z0-9 .()-]*[A-Za-z0-9.()-])?</code>)
arn	string	ARN of the application (pattern: <code>^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:/_.]+$</code>)
created_at	string (date-time)	Timestamp when the application was created
description	string	Description of the application (pattern: <code>[a-zA-Z0-9_-]+</code>)
dns_subdomain	string	DNS subdomain for the application (pattern: <code>[a-z0-9]([a-z0-9-]*[a-z0-9])?</code>)
idc_application_arn	string	Identity Center Application ARN associated with this application (pattern: <code>^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:/_.]+$</code>)
status	string	Current status of the application (CREATING, ACTIVE, DELETING)
updated_at	string (date-time)	Timestamp when the application was last updated
workspace_name	string	Name of the workspace this application belongs to (pattern: <code>^[a-zA-Z0-9_-]+$</code>)

list_applications

Name	Datatype	Description
id	string	Unique identifier of the application (pattern: <code>[a-z0-9-]{36}</code>)
name	string	Name of the application (pattern: <code>[A-Za-z0-9](?:[A-Za-z0-9 .()-]*[A-Za-z0-9.()-])?</code>)
arn	string	ARN of the application (pattern: <code>^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:/_.]+$</code>)
created_at	string (date-time)	Timestamp when the application was created
status	string	Current status of the application (CREATING, ACTIVE, DELETING)
workspace_name	string	Name of the workspace this application belongs to (pattern: <code>^[a-zA-Z0-9_-]+$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_application	select	workspace_name, id, region		Retrieves Application details based on the ID
list_applications	select	region	maxResults, nextToken	Retrieves a paginated list of existing applications
create_application	insert	region, idcInstanceArn, workspaceName, name		Creates a new application for the workspace and IdC application provided
delete_application	delete	workspace_name, id, region		Deletes an application by ID

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	ID of the Application to delete
region	string	AWS region (default: us-east-1)
workspace_name	string	Name of the workspace to associate with the underlying Application
maxResults	integer	Maximum number of results to return
nextToken	string	Next Page Token

SELECT examples

describe_application

Retrieves Application details based on the ID

SELECT
id,
name,
arn,
created_at,
description,
dns_subdomain,
idc_application_arn,
status,
updated_at,
workspace_name
FROM aws.iotsitewise.applications
WHERE workspace_name = '{{ workspace_name }}' -- required
AND id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_applications

Retrieves a paginated list of existing applications

SELECT
id,
name,
arn,
created_at,
status,
workspace_name
FROM aws.iotsitewise.applications
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_application

Creates a new application for the workspace and IdC application provided

INSERT INTO aws.iotsitewise.applications (
clientToken,
idcInstanceArn,
workspaceName,
name,
description,
tags,
region
)
SELECT 
'{{ clientToken }}',
'{{ idcInstanceArn }}' /* required */,
'{{ workspaceName }}' /* required */,
'{{ name }}' /* required */,
'{{ description }}',
'{{ tags }}',
'{{ region }}'
RETURNING
id,
name,
arn,
dns_subdomain,
status
;

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: idcInstanceArn
    value: "{{ idcInstanceArn }}"
  - name: workspaceName
    value: "{{ workspaceName }}"
  - name: name
    value: "{{ name }}"
    description: |
      Name of the application
  - name: description
    value: "{{ description }}"
  - name: tags
    value: "{{ tags }}"

DELETE examples

delete_application

Deletes an application by ID

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