Skip to content

associate_source_graphql_api async 

associate_source_graphql_api(
    merged_api_identifier: String,
    source_api_identifier: String,
    *,
    config_overrides: Optional[AsyncAppSyncClientConfig] = None,
    description: Optional[String] = None,
    source_api_association_config: Optional[SourceApiAssociationConfig] = None,
) -> AssociateSourceGraphqlApiResponse

Creates an association between a Merged API and source API using the Merged API's identifier.

Parameters:

  • 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.

  • source_api_identifier (String) –

    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.

  • description (Optional[String], default: None ) –

    The description field.

  • source_api_association_config (Optional[SourceApiAssociationConfig], default: None ) –

    The SourceApiAssociationConfig object data.

Raises:

Source code in docs_src/capo_appsync/_services/async_app_sync.py 
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
async def associate_source_graphql_api(
    self,
    merged_api_identifier: "capo_appsync.types.string.String",
    source_api_identifier: "capo_appsync.types.string.String",
    *,
    config_overrides: Optional[AsyncAppSyncClientConfig] = None,
    description: Optional["capo_appsync.types.string.String"] = None,
    source_api_association_config: Optional[
        "capo_appsync.types.source_api_association_config.SourceApiAssociationConfig"
    ] = None,
) -> "capo_appsync.types.associate_source_graphql_api_response.AssociateSourceGraphqlApiResponse":
    """<p>Creates an association between a Merged API and source API using the Merged API's identifier.</p>

    Args:
        merged_api_identifier: <p>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.</p>
        source_api_identifier: <p>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.</p>
        description: <p>The description field.</p>
        source_api_association_config: <p>The <code>SourceApiAssociationConfig</code> object data.</p>

    Raises:
        capo_appsync.errors.bad_request_exception.BadRequestException: <p>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.</p>
        capo_appsync.errors.concurrent_modification_exception.ConcurrentModificationException: <p>Another modification is in progress at this time and it must complete before you can make your change.</p>
        capo_appsync.errors.internal_failure_exception.InternalFailureException: <p>An internal AppSync error occurred. Try your request again.</p>
        capo_appsync.errors.limit_exceeded_exception.LimitExceededException: <p>The request exceeded a limit. Try your request again.</p>
        capo_appsync.errors.not_found_exception.NotFoundException: <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
        capo_appsync.errors.unauthorized_exception.UnauthorizedException: <p>You aren't authorized to perform this operation.</p>
        capo_appsync.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_appsync.types.associate_source_graphql_api_request.AssociateSourceGraphqlApiRequest]",
    ) -> AsyncOperationResponse[
        "capo_appsync.types.associate_source_graphql_api_response.AssociateSourceGraphqlApiResponse"
    ]:
        import capo_appsync._operations.aws_deepdish_control_plane_service.associate_source_graphql_api

        (
            output,
            http_response,
        ) = await capo_appsync._operations.aws_deepdish_control_plane_service.associate_source_graphql_api.async_associate_source_graphql_api(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("AssociateSourceGraphqlApi")
    )
    input_: capo_appsync.types.associate_source_graphql_api_request.AssociateSourceGraphqlApiRequest = {
        "merged_api_identifier": merged_api_identifier,
        "source_api_identifier": source_api_identifier,
    }
    if description is not None:
        input_["description"] = description
    if source_api_association_config is not None:
        input_["source_api_association_config"] = source_api_association_config

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output