start_schema_creation ¶

start_schema_creation(
    api_id: String,
    definition: Blob,
    *,
    config_overrides: Optional[AppSyncClientConfig] = None,
) -> StartSchemaCreationResponse

Adds a new schema to your GraphQL API.

This operation is asynchronous. Use to determine when it has completed.

Parameters:

api_id (String) –

The API ID.
definition (Blob) –

The schema definition, in GraphQL schema language format.

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 start_schema_creation(
    self,
    api_id: "capo_appsync.types.string.String",
    definition: "capo_appsync.types.blob.Blob",
    *,
    config_overrides: Optional[AppSyncClientConfig] = None,
) -> (
    "capo_appsync.types.start_schema_creation_response.StartSchemaCreationResponse"
):
    """<p>Adds a new schema to your GraphQL API.</p> <p>This operation is asynchronous. Use to determine when it has completed.</p>

    Args:
        api_id: <p>The API ID.</p>
        definition: <p>The schema definition, in GraphQL schema language format.</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.start_schema_creation_request.StartSchemaCreationRequest]",
    ) -> OperationResponse[
        "capo_appsync.types.start_schema_creation_response.StartSchemaCreationResponse"
    ]:
        import capo_appsync._operations.aws_deepdish_control_plane_service.start_schema_creation

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartSchemaCreation")
    )
    input_: capo_appsync.types.start_schema_creation_request.StartSchemaCreationRequest = {
        "api_id": api_id,
        "definition": definition,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output