types

Creates, updates, deletes, gets or lists a types resource.

Overview

Name	types
Type	Resource
Id	aws.appsync.types

Fields

The following fields are returned by SELECT queries:

list_types

Name	Datatype	Description
name	string	The type name. (pattern: <code>[_A-Za-z][_0-9A-Za-z]*</code>)
arn	string	The type Amazon Resource Name (ARN).
definition	string	The type definition.
description	string	The type description.
format_	string	The type format: SDL or JSON. (SDL, JSON)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_types	select	api_id, format, region	nextToken, maxResults	Lists the types for a given API.
create_type	insert	api_id, region, definition, format		Creates a Type object.
update_type	update	api_id, type_name, region, format		Updates a Type object.
delete_type	delete	api_id, type_name, region		Deletes a Type object.
get_type	exec	api_id, type_name, format, region		Retrieves a Type object.

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
api_id	string	The API ID.
format	string	The type format: SDL or JSON.
region	string	AWS region (default: us-east-1)
type_name	string	The type name.
maxResults	integer	The maximum number of results that you want the request to return.
nextToken	string	An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

SELECT examples

list_types

Lists the types for a given API.

SELECT
name,
arn,
definition,
description,
format_
FROM aws.appsync.types
WHERE api_id = '{{ api_id }}' -- required
AND format = '{{ format }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_type

Creates a Type object.

INSERT INTO aws.appsync.types (
definition,
format,
api_id,
region
)
SELECT 
'{{ definition }}' /* required */,
'{{ format }}' /* required */,
'{{ api_id }}',
'{{ region }}'
RETURNING
type_
;

Manifest

# Description fields are for documentation purposes
- name: types
props:
  - name: api_id
    value: "{{ api_id }}"
    description: Required parameter for the types resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the types resource.
  - name: definition
    value: "{{ definition }}"
  - name: format
    value: "{{ format }}"
    valid_values: ['SDL', 'JSON']

UPDATE examples

update_type

Updates a Type object.

UPDATE aws.appsync.types
SET 
definition = '{{ definition }}',
format = '{{ format }}'
WHERE 
api_id = '{{ api_id }}' --required
AND type_name = '{{ type_name }}' --required
AND region = '{{ region }}' --required
AND format = '{{ format }}' --required
RETURNING
type_;

DELETE examples

delete_type

Deletes a Type object.

DELETE FROM aws.appsync.types
WHERE api_id = '{{ api_id }}' --required
AND type_name = '{{ type_name }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

get_type

Retrieves a Type object.

EXEC aws.appsync.types.get_type 
@api_id='{{ api_id }}' --required, 
@type_name='{{ type_name }}' --required, 
@format='{{ format }}' --required, 
@region='{{ region }}' --required
;