applications
Creates, updates, deletes, gets or lists an applications resource.
Overview
| Name | applications |
| Type | Resource |
| Id | aws.appintegrations.applications |
Fields
The following fields are returned by SELECT queries:
- get_application
- list_applications
| Name | Datatype | Description |
|---|---|---|
application_config | object | The configuration settings for the application. |
application_source_config | object | The configuration for where the application should be loaded from. |
application_type | string | The type of application (STANDARD, SERVICE, MCP_SERVER) |
arn | string | The Amazon Resource Name (ARN) of the Application. (pattern: <code>^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$</code>) |
created_time | string (date-time) | The created time of the Application. |
description | string | The description of the application. (pattern: <code>.*</code>) |
id | string | A unique identifier for the Application. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>) |
iframe_config | object | The iframe configuration for the application. |
initialization_timeout | integer | The maximum time in milliseconds allowed to establish a connection with the workspace. |
is_service | boolean | Indicates whether the application is a service. |
last_modified_time | string (date-time) | The last modified time of the Application. |
name | string | The name of the application. (pattern: <code>^[a-zA-Z0-9/._ -]+$</code>) |
namespace | string | The namespace of the application. (pattern: <code>^[a-zA-Z0-9/._-]+$</code>) |
permissions | array | The configuration of events or requests that the application has access to. |
publications | array | The events that the application publishes. |
subscriptions | array | The events that the application subscribes. |
tags | object | The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. |
| Name | Datatype | Description |
|---|---|---|
application_type | string | The type of application (STANDARD, SERVICE, MCP_SERVER) |
arn | string | The Amazon Resource Name (ARN) of the Application. (pattern: <code>^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$</code>) |
created_time | string (date-time) | The time when the application was created. |
id | string | A unique identifier for the Application. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>) |
is_service | boolean | Indicates whether the application is a service. |
last_modified_time | string (date-time) | The time when the application was last modified. |
name | string | The name of the application. (pattern: <code>^[a-zA-Z0-9/._ -]+$</code>) |
namespace | string | The namespace of the application. (pattern: <code>^[a-zA-Z0-9/._-]+$</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_application | select | application_identifier, region | Get an Application resource. | |
list_applications | select | region | nextToken, maxResults, applicationType | Lists applications in the account. |
create_application | insert | region, ApplicationSourceConfig | Creates and persists an Application resource. | |
update_application | update | application_identifier, region | Updates and persists an Application resource. | |
delete_application | delete | application_identifier, region | Deletes the Application. Only Applications that don't have any Application Associations can be deleted. |
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 |
|---|---|---|
application_identifier | string | The Amazon Resource Name (ARN) of the Application. |
region | string | AWS region (default: us-east-1) |
applicationType | string | The type of application. |
maxResults | integer | The maximum number of results to return per page. |
nextToken | string | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. |
SELECT examples
- get_application
- list_applications
Get an Application resource.
SELECT
application_config,
application_source_config,
application_type,
arn,
created_time,
description,
id,
iframe_config,
initialization_timeout,
is_service,
last_modified_time,
name,
namespace,
permissions,
publications,
subscriptions,
tags
FROM aws.appintegrations.applications
WHERE application_identifier = '{{ application_identifier }}' -- required
AND region = '{{ region }}' -- required
;
Lists applications in the account.
SELECT
application_type,
arn,
created_time,
id,
is_service,
last_modified_time,
name,
namespace
FROM aws.appintegrations.applications
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND applicationType = '{{ applicationType }}'
;
INSERT examples
- create_application
- Manifest
Creates and persists an Application resource.
INSERT INTO aws.appintegrations.applications (
Name,
Namespace,
Description,
ApplicationSourceConfig,
Subscriptions,
Publications,
ClientToken,
Tags,
Permissions,
IsService,
InitializationTimeout,
ApplicationConfig,
IframeConfig,
ApplicationType,
region
)
SELECT
'{{ Name }}',
'{{ Namespace }}',
'{{ Description }}',
'{{ ApplicationSourceConfig }}' /* required */,
'{{ Subscriptions }}',
'{{ Publications }}',
'{{ ClientToken }}',
'{{ Tags }}',
'{{ Permissions }}',
{{ IsService }},
{{ InitializationTimeout }},
'{{ ApplicationConfig }}',
'{{ IframeConfig }}',
'{{ ApplicationType }}',
'{{ region }}'
RETURNING
arn,
id
;
# Description fields are for documentation purposes
- name: applications
props:
- name: region
value: "{{ region }}"
description: Required parameter for the applications resource.
- name: Name
value: "{{ Name }}"
- name: Namespace
value: "{{ Namespace }}"
- name: Description
value: "{{ Description }}"
- name: ApplicationSourceConfig
description: |
The configuration for where the application should be loaded from.
value:
ExternalUrlConfig:
AccessUrl: "{{ AccessUrl }}"
ApprovedOrigins:
- "{{ ApprovedOrigins }}"
- name: Subscriptions
value:
- Event: "{{ Event }}"
Description: "{{ Description }}"
- name: Publications
value:
- Event: "{{ Event }}"
Schema: "{{ Schema }}"
Description: "{{ Description }}"
- name: ClientToken
value: "{{ ClientToken }}"
- name: Tags
value: "{{ Tags }}"
- name: Permissions
value:
- "{{ Permissions }}"
- name: IsService
value: {{ IsService }}
- name: InitializationTimeout
value: {{ InitializationTimeout }}
- name: ApplicationConfig
description: |
The configuration settings for the application.
value:
ContactHandling:
Scope: "{{ Scope }}"
- name: IframeConfig
description: |
The iframe configuration for the application.
value:
Allow:
- "{{ Allow }}"
Sandbox:
- "{{ Sandbox }}"
- name: ApplicationType
value: "{{ ApplicationType }}"
description: |
The type of application
valid_values: ['STANDARD', 'SERVICE', 'MCP_SERVER']
UPDATE examples
- update_application
Updates and persists an Application resource.
UPDATE aws.appintegrations.applications
SET
Name = '{{ Name }}',
Description = '{{ Description }}',
ApplicationSourceConfig = '{{ ApplicationSourceConfig }}',
Subscriptions = '{{ Subscriptions }}',
Publications = '{{ Publications }}',
Permissions = '{{ Permissions }}',
IsService = {{ IsService }},
InitializationTimeout = {{ InitializationTimeout }},
ApplicationConfig = '{{ ApplicationConfig }}',
IframeConfig = '{{ IframeConfig }}',
ApplicationType = '{{ ApplicationType }}'
WHERE
application_identifier = '{{ application_identifier }}' --required
AND region = '{{ region }}' --required;
DELETE examples
- delete_application
Deletes the Application. Only Applications that don't have any Application Associations can be deleted.
DELETE FROM aws.appintegrations.applications
WHERE application_identifier = '{{ application_identifier }}' --required
AND region = '{{ region }}' --required
;