source_api_associations

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

Overview

Name	source_api_associations
Type	Resource
Id	aws.appsync.source_api_associations

Fields

The following fields are returned by SELECT queries:

get_source_api_association

Name	Datatype	Description
association_arn	string	The Amazon Resource Name (ARN) of the source API association.
association_id	string	The ID generated by the AppSync service for the source API association.
description	string	The description field.
last_successful_merge_date	string (date-time)	The datetime value of the last successful merge of the source API association. The result will be in UTC format and your local time zone.
merged_api_arn	string	The Amazon Resource Name (ARN) of the AppSync Merged API.
merged_api_id	string	The ID of the AppSync Merged API.
source_api_arn	string	The Amazon Resource Name (ARN) of the AppSync source API.
source_api_association_config	object	Describes properties used to specify configurations related to a source API.
source_api_association_status	string	The state of the source API association. (MERGE_SCHEDULED, MERGE_FAILED, MERGE_SUCCESS, MERGE_IN_PROGRESS, AUTO_MERGE_SCHEDULE_FAILED, DELETION_SCHEDULED, DELETION_IN_PROGRESS, DELETION_FAILED)
source_api_association_status_detail	string	The detailed message related to the current state of the source API association.
source_api_id	string	The ID of the AppSync source API.

list_source_api_associations

Name	Datatype	Description
association_arn	string	The Amazon Resource Name (ARN) of the source API association.
association_id	string	The ID generated by the AppSync service for the source API association.
description	string	The description field.
merged_api_arn	string	The Amazon Resource Name (ARN) of the AppSync Merged API.
merged_api_id	string	The ID of the AppSync Merged API.
source_api_arn	string	The Amazon Resource Name (ARN) of the AppSync Source API.
source_api_id	string	The ID of the AppSync source API.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_source_api_association	select	merged_api_identifier, association_id, region		Retrieves a SourceApiAssociation object.
list_source_api_associations	select	api_id, region	nextToken, maxResults	Lists the SourceApiAssociationSummary data.
update_source_api_association	update	association_id, merged_api_identifier, region		Updates some of the configuration choices of a particular source API association.

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.
association_id	string	The ID generated by the AppSync service for the source API association.
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

get_source_api_association

Retrieves a SourceApiAssociation object.

SELECT
association_arn,
association_id,
description,
last_successful_merge_date,
merged_api_arn,
merged_api_id,
source_api_arn,
source_api_association_config,
source_api_association_status,
source_api_association_status_detail,
source_api_id
FROM aws.appsync.source_api_associations
WHERE merged_api_identifier = '{{ merged_api_identifier }}' -- required
AND association_id = '{{ association_id }}' -- required
AND region = '{{ region }}' -- required
;

list_source_api_associations

Lists the SourceApiAssociationSummary data.

SELECT
association_arn,
association_id,
description,
merged_api_arn,
merged_api_id,
source_api_arn,
source_api_id
FROM aws.appsync.source_api_associations
WHERE api_id = '{{ api_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

UPDATE examples

update_source_api_association

Updates some of the configuration choices of a particular source API association.

UPDATE aws.appsync.source_api_associations
SET 
description = '{{ description }}',
sourceApiAssociationConfig = '{{ sourceApiAssociationConfig }}'
WHERE 
association_id = '{{ association_id }}' --required
AND merged_api_identifier = '{{ merged_api_identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
source_api_association;