apps

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

Overview

Name	apps
Type	Resource
Id	aws.pinpoint.apps

Fields

The following fields are returned by SELECT queries:

get_app

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the application.
creation_date	string	The date and time when the Application was created.
id	string	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
name	string	The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
tags	object	A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.

get_apps

Name	Datatype	Description
item	array	An array of responses, one for each application that was returned.
next_token	string	The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_app	select	application-id, region		Retrieves information about an application.
get_apps	select	region	page-size, token	Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
create_app	insert	region, CreateApplicationRequest		Creates an application.
delete_app	delete	application-id, region		Deletes 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-id	string	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
region	string	AWS region (default: us-east-1)
page-size	string	The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
token	string	The NextToken string that specifies which page of results to return in a paginated response.

SELECT examples

get_app

Retrieves information about an application.

SELECT
arn,
creation_date,
id,
name,
tags
FROM aws.pinpoint.apps
WHERE `application-id` = '{{ application-id }}' -- required
AND region = '{{ region }}' -- required
;

get_apps

Retrieves information about all the applications that are associated with your Amazon Pinpoint account.

SELECT
item,
next_token
FROM aws.pinpoint.apps
WHERE region = '{{ region }}' -- required
AND `page-size` = '{{ page-size }}'
AND token = '{{ token }}'
;

INSERT examples

create_app

Creates an application.

INSERT INTO aws.pinpoint.apps (
CreateApplicationRequest,
region
)
SELECT 
'{{ CreateApplicationRequest }}' /* required */,
'{{ region }}'
RETURNING
application_response
;

Manifest

# Description fields are for documentation purposes
- name: apps
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the apps resource.
  - name: CreateApplicationRequest
    description: |
      Specifies the display name of an application and the tags to associate with the application.
    value:
      Name: "{{ Name }}"
      tags: "{{ tags }}"

DELETE examples

delete_app

Deletes an application.

DELETE FROM aws.pinpoint.apps
WHERE `application-id` = '{{ application-id }}' --required
AND region = '{{ region }}' --required
;