types_by_associations

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

Overview

Name	types_by_associations
Type	Resource
Id	aws.appsync.types_by_associations

Fields

The following fields are returned by SELECT queries:

list_types_by_association

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_by_association	select	merged_api_identifier, association_id, format, region	nextToken, maxResults	Lists Type objects by the source API association ID.

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
association_id	string	The ID generated by the AppSync service for the source API association.
format	string	The format type.
merged_api_identifier	string	The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
region	string	AWS region (default: us-east-1)
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_by_association

Lists Type objects by the source API association ID.

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