applications

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

Overview

Name	applications
Type	Resource
Id	aws.servicecatalog_appregistry.applications

Fields

The following fields are returned by SELECT queries:

get_application

Name	Datatype	Description
id	string	The identifier of the application. (pattern: <code>[a-z0-9]+</code>)
name	string	The name of the application. The name must be unique in the region in which you are creating the application. (pattern: <code>[-.\w]+</code>)
application_tag	object	A key-value pair that identifies an associated resource.
arn	string	The Amazon resource name (ARN) that specifies the application across services. (pattern: <code>arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[a-z0-9]+</code>)
associated_resource_count	integer	The number of top-level resources that were registered as part of this application.
creation_time	string (date-time)	The ISO-8601 formatted timestamp of the moment when the application was created.
description	string	The description of the application.
integrations	object	The information about the integration of the application with other services, such as Resource Groups.
last_update_time	string (date-time)	The ISO-8601 formatted timestamp of the moment when the application was last updated.
tags	object	Key-value pairs associated with the application.

list_applications

Name	Datatype	Description
id	string	The identifier of the application. (pattern: <code>[a-z0-9]+</code>)
name	string	The name of the application. The name must be unique in the region in which you are creating the application. (pattern: <code>[-.\w]+</code>)
arn	string	The Amazon resource name (ARN) that specifies the application across services. (pattern: <code>arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[a-z0-9]+</code>)
creation_time	string (date-time)	The ISO-8601 formatted timestamp of the moment when the application was created.
description	string	The description of the application.
last_update_time	string (date-time)	The ISO-8601 formatted timestamp of the moment when the application was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_application	select	application, region		Retrieves metadata information about one of your applications. The application can be specified by its ARN, ID, or name (which is unique within one account in one region at a given point in time). Specify by ARN or ID in automated workflows if you want to make sure that the exact same application is returned or a ResourceNotFoundException is thrown, avoiding the ABA addressing problem.
list_applications	select	region	nextToken, maxResults	Retrieves a list of all of your applications. Results are paginated.
create_application	insert	region, name, clientToken		Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.
update_application	update	application, region		Updates an existing application with new attributes.
delete_application	delete	application, region		Deletes an application that is specified either by its application ID, name, or ARN. All associated attribute groups and resources must be disassociated from it before deleting an application.

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	string	The name, ID, or ARN of the application.
region	string	AWS region (default: us-east-1)
maxResults	integer	The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.
nextToken	string	The token to use to get the next page of results after a previous API call.

SELECT examples

get_application

Retrieves metadata information about one of your applications. The application can be specified by its ARN, ID, or name (which is unique within one account in one region at a given point in time). Specify by ARN or ID in automated workflows if you want to make sure that the exact same application is returned or a ResourceNotFoundException is thrown, avoiding the ABA addressing problem.

SELECT
id,
name,
application_tag,
arn,
associated_resource_count,
creation_time,
description,
integrations,
last_update_time,
tags
FROM aws.servicecatalog_appregistry.applications
WHERE application = '{{ application }}' -- required
AND region = '{{ region }}' -- required
;

list_applications

Retrieves a list of all of your applications. Results are paginated.

SELECT
id,
name,
arn,
creation_time,
description,
last_update_time
FROM aws.servicecatalog_appregistry.applications
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_application

Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.

INSERT INTO aws.servicecatalog_appregistry.applications (
name,
description,
tags,
clientToken,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ tags }}',
'{{ clientToken }}' /* required */,
'{{ region }}'
RETURNING
application
;

Manifest

# 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: description
    value: "{{ description }}"
  - name: tags
    value: "{{ tags }}"
  - name: clientToken
    value: "{{ clientToken }}"

UPDATE examples

update_application

Updates an existing application with new attributes.

UPDATE aws.servicecatalog_appregistry.applications
SET 
name = '{{ name }}',
description = '{{ description }}'
WHERE 
application = '{{ application }}' --required
AND region = '{{ region }}' --required
RETURNING
application;

DELETE examples

delete_application

Deletes an application that is specified either by its application ID, name, or ARN. All associated attribute groups and resources must be disassociated from it before deleting an application.

DELETE FROM aws.servicecatalog_appregistry.applications
WHERE application = '{{ application }}' --required
AND region = '{{ region }}' --required
;