Skip to content

update_source_api_association

update_source_api_association(
    association_id: String,
    merged_api_identifier: String,
    *,
    config_overrides: Optional[AppSyncClientConfig] = None,
    description: Optional[String] = None,
    source_api_association_config: Optional[SourceApiAssociationConfig] = None,
) -> UpdateSourceApiAssociationResponse

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

Parameters:

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

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

    The description field.

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

    The SourceApiAssociationConfig object data.

Raises:

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

  • ConcurrentModificationException –

    Another modification is in progress at this time and it must complete before you can make your change.

  • InternalFailureException –

    An internal AppSync error occurred. Try your request again.

  • NotFoundException –

    The resource specified in the request was not found. Check the resource, and then try again.

  • UnauthorizedException –

    You aren't authorized to perform this operation.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_appsync/_services/app_sync.py
def update_source_api_association(
    self,
    association_id: "capo_appsync.types.string.String",
    merged_api_identifier: "capo_appsync.types.string.String",
    *,
    config_overrides: Optional[AppSyncClientConfig] = 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.update_source_api_association_response.UpdateSourceApiAssociationResponse":
    """<p>Updates some of the configuration choices of a particular source API association.</p>

    Args:
        association_id: <p>The ID generated by the AppSync service for the source API association.</p>
        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>
        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.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.
    """

    def _handler(
        req: "OperationRequest[capo_appsync.types.update_source_api_association_request.UpdateSourceApiAssociationRequest]",
    ) -> OperationResponse[
        "capo_appsync.types.update_source_api_association_response.UpdateSourceApiAssociationResponse"
    ]:
        import capo_appsync._operations.aws_deepdish_control_plane_service.update_source_api_association

        output, http_response = (
            capo_appsync._operations.aws_deepdish_control_plane_service.update_source_api_association.update_source_api_association(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateSourceApiAssociation")
    )
    input_: capo_appsync.types.update_source_api_association_request.UpdateSourceApiAssociationRequest = {
        "association_id": association_id,
        "merged_api_identifier": merged_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 = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output