Skip to main content

applications

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

Overview

Nameapplications
TypeResource
Idaws.appintegrations.applications

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
application_configobjectThe configuration settings for the application.
application_source_configobjectThe configuration for where the application should be loaded from.
application_typestringThe type of application (STANDARD, SERVICE, MCP_SERVER)
arnstringThe 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_timestring (date-time)The created time of the Application.
descriptionstringThe description of the application. (pattern: <code>.*</code>)
idstringA 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_configobjectThe iframe configuration for the application.
initialization_timeoutintegerThe maximum time in milliseconds allowed to establish a connection with the workspace.
is_servicebooleanIndicates whether the application is a service.
last_modified_timestring (date-time)The last modified time of the Application.
namestringThe name of the application. (pattern: <code>^[a-zA-Z0-9/._ -]+$</code>)
namespacestringThe namespace of the application. (pattern: <code>^[a-zA-Z0-9/._-]+$</code>)
permissionsarrayThe configuration of events or requests that the application has access to.
publicationsarrayThe events that the application publishes.
subscriptionsarrayThe events that the application subscribes.
tagsobjectThe tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_applicationselectapplication_identifier, regionGet an Application resource.
list_applicationsselectregionnextToken, maxResults, applicationTypeLists applications in the account.
create_applicationinsertregion, ApplicationSourceConfigCreates and persists an Application resource.
update_applicationupdateapplication_identifier, regionUpdates and persists an Application resource.
delete_applicationdeleteapplication_identifier, regionDeletes 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.

NameDatatypeDescription
application_identifierstringThe Amazon Resource Name (ARN) of the Application.
regionstringAWS region (default: us-east-1)
applicationTypestringThe type of application.
maxResultsintegerThe maximum number of results to return per page.
nextTokenstringThe 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 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
;

INSERT examples

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
;

UPDATE examples

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

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
;