AssociateMergedGraphqlApi
Creates an association between a Merged API and source API using the source API's identifier.
Request Syntax
POST /sourceApis/sourceApiIdentifier
/mergedApiAssociations HTTP/1.1
Content-type: application/json
{
"description": "string
",
"mergedApiIdentifier": "string
",
"sourceApiAssociationConfig": {
"mergeType": "string
"
}
}
URI Request Parameters
The request uses the following URI parameters.
- sourceApiIdentifier
-
The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- description
-
The description field.
Type: String
Required: No
- mergedApiIdentifier
-
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.
Type: String
Required: Yes
- sourceApiAssociationConfig
-
The
SourceApiAssociationConfig
object data.Type: SourceApiAssociationConfig object
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"sourceApiAssociation": {
"associationArn": "string",
"associationId": "string",
"description": "string",
"lastSuccessfulMergeDate": number,
"mergedApiArn": "string",
"mergedApiId": "string",
"sourceApiArn": "string",
"sourceApiAssociationConfig": {
"mergeType": "string"
},
"sourceApiAssociationStatus": "string",
"sourceApiAssociationStatusDetail": "string",
"sourceApiId": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- sourceApiAssociation
-
The
SourceApiAssociation
object data.Type: SourceApiAssociation object
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.
HTTP Status Code: 400
- ConcurrentModificationException
-
Another modification is in progress at this time and it must complete before you can make your change.
HTTP Status Code: 409
- InternalFailureException
-
An internal Amazon AppSync error occurred. Try your request again.
HTTP Status Code: 500
- LimitExceededException
-
The request exceeded a limit. Try your request again.
HTTP Status Code: 429
- NotFoundException
-
The resource specified in the request was not found. Check the resource, and then try again.
HTTP Status Code: 404
- UnauthorizedException
-
You aren't authorized to perform this operation.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: