AppSync / Client / start_schema_merge

start_schema_merge#

AppSync.Client.start_schema_merge(**kwargs)#

Initiates a merge operation. Returns a status that shows the result of the merge operation.

See also: AWS API Documentation

Request Syntax

response = client.start_schema_merge(
    associationId='string',
    mergedApiIdentifier='string'
)
Parameters:

  • associationId (string) –

    [REQUIRED]

    The ID generated by the AppSync service for the source API association.

  • mergedApiIdentifier (string) –

    [REQUIRED]

    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.

Return type:

dict

Returns:

Response Syntax

{
    'sourceApiAssociationStatus': 'MERGE_SCHEDULED'|'MERGE_FAILED'|'MERGE_SUCCESS'|'MERGE_IN_PROGRESS'|'AUTO_MERGE_SCHEDULE_FAILED'|'DELETION_SCHEDULED'|'DELETION_IN_PROGRESS'|'DELETION_FAILED'
}

Response Structure

  • (dict) –

    • sourceApiAssociationStatus (string) –

      The state of the source API association.

Exceptions

  • AppSync.Client.exceptions.UnauthorizedException

  • AppSync.Client.exceptions.BadRequestException

  • AppSync.Client.exceptions.InternalFailureException

  • AppSync.Client.exceptions.NotFoundException

  • AppSync.Client.exceptions.ConcurrentModificationException