Skip to content

describe_schema

describe_schema(
    schema_arn: Arn, *, config_overrides: Optional[PersonalizeClientConfig] = None
) -> DescribeSchemaResponse

Describes a schema. For more information on schemas, see CreateSchema.

Parameters:

  • schema_arn (Arn) –

    The Amazon Resource Name (ARN) of the schema to retrieve.

Raises:

Source code in docs_src/capo_personalize/_services/personalize.py
def describe_schema(
    self,
    schema_arn: "capo_personalize.types.arn.Arn",
    *,
    config_overrides: Optional[PersonalizeClientConfig] = None,
) -> "capo_personalize.types.describe_schema_response.DescribeSchemaResponse":
    """<p>Describes a schema. For more information on schemas, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html">CreateSchema</a>.</p>

    Args:
        schema_arn: <p>The Amazon Resource Name (ARN) of the schema to retrieve.</p>

    Raises:
        capo_personalize.errors.invalid_input_exception.InvalidInputException: <p>Provide a valid value for the field or parameter.</p>
        capo_personalize.errors.resource_not_found_exception.ResourceNotFoundException: <p>Could not find the specified resource.</p>
        capo_personalize.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_personalize.types.describe_schema_request.DescribeSchemaRequest]",
    ) -> OperationResponse[
        "capo_personalize.types.describe_schema_response.DescribeSchemaResponse"
    ]:
        import capo_personalize._operations.amazon_personalize.describe_schema

        output, http_response = (
            capo_personalize._operations.amazon_personalize.describe_schema.describe_schema(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeSchema")
    )
    input_: capo_personalize.types.describe_schema_request.DescribeSchemaRequest = {
        "schema_arn": schema_arn
    }

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