api_associations

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

Overview

Name	api_associations
Type	Resource
Id	aws.appsync.api_associations

Fields

The following fields are returned by SELECT queries:

get_api_association

Name	Datatype	Description
api_id	string	The API ID.
association_status	string	Identifies the status of an association. PROCESSING: The API association is being created. You cannot modify association requests during processing. SUCCESS: The API association was successful. You can modify associations after success. FAILED: The API association has failed. You can modify associations after failure. (PROCESSING, FAILED, SUCCESS)
deployment_detail	string	Details about the last deployment status.
domain_name	string	The domain name. (pattern: <code>^(*[\w\d-]*.)?([\w\d-]+.)+[\w\d-]+$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_api_association	select	domain_name, region		Retrieves an ApiAssociation 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
domain_name	string	The domain name.
region	string	AWS region (default: us-east-1)

SELECT examples

get_api_association

Retrieves an ApiAssociation object.

SELECT
api_id,
association_status,
deployment_detail,
domain_name
FROM aws.appsync.api_associations
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
;