get_schema_as_json ¶

get_schema_as_json(
    schema_arn: Arn, *, config_overrides: Optional[CloudDirectoryClientConfig] = None
) -> GetSchemaAsJsonResponse

Retrieves a JSON representation of the schema. See JSON Schema Format for more information.

Parameters:

schema_arn (Arn) –

The ARN of the schema to retrieve.

Raises:

AccessDeniedException –

Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
InternalServiceException –

Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
InvalidArnException –

Indicates that the provided ARN value is not valid.
LimitExceededException –

Indicates that limits are exceeded. See Limits for more information.
ResourceNotFoundException –

The specified resource could not be found.
RetryableConflictException –

Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
ValidationException –

Indicates that your request is malformed in some manner. See the exception message.
UnknownServiceError –

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

Examples:

To get schema information and display it in JSON format

>>> client.get_schema_as_json(schema_arn='arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1')

Source code in docs_src/capo_clouddirectory/_services/cloud_directory.py

def get_schema_as_json(
    self,
    schema_arn: "capo_clouddirectory.types.arn.Arn",
    *,
    config_overrides: Optional[CloudDirectoryClientConfig] = None,
) -> (
    "capo_clouddirectory.types.get_schema_as_json_response.GetSchemaAsJsonResponse"
):
    """<p>Retrieves a JSON representation of the schema. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_jsonformat.html#schemas_json">JSON Schema Format</a> for more information.</p>

    Args:
        schema_arn: <p>The ARN of the schema to retrieve.</p>

    Raises:
        capo_clouddirectory.errors.access_denied_exception.AccessDeniedException: <p>Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling <a>ListDirectories</a> and check your permissions.</p>
        capo_clouddirectory.errors.internal_service_exception.InternalServiceException: <p>Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the <a href="http://status.aws.amazon.com/">AWS Service Health Dashboard</a> site to see if there are any operational issues with the service.</p>
        capo_clouddirectory.errors.invalid_arn_exception.InvalidArnException: <p>Indicates that the provided ARN value is not valid.</p>
        capo_clouddirectory.errors.limit_exceeded_exception.LimitExceededException: <p>Indicates that limits are exceeded. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html">Limits</a> for more information.</p>
        capo_clouddirectory.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource could not be found.</p>
        capo_clouddirectory.errors.retryable_conflict_exception.RetryableConflictException: <p>Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.</p>
        capo_clouddirectory.errors.validation_exception.ValidationException: <p>Indicates that your request is malformed in some manner. See the exception message.</p>
        capo_clouddirectory.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To get schema information and display it in JSON format

        >>> client.get_schema_as_json(schema_arn='arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1')
    """

    def _handler(
        req: "OperationRequest[capo_clouddirectory.types.get_schema_as_json_request.GetSchemaAsJsonRequest]",
    ) -> OperationResponse[
        "capo_clouddirectory.types.get_schema_as_json_response.GetSchemaAsJsonResponse"
    ]:
        import capo_clouddirectory._operations.amazon_cloud_directory_20170111.get_schema_as_json

        output, http_response = (
            capo_clouddirectory._operations.amazon_cloud_directory_20170111.get_schema_as_json.get_schema_as_json(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetSchemaAsJson")
    )
    input_: capo_clouddirectory.types.get_schema_as_json_request.GetSchemaAsJsonRequest = {
        "schema_arn": schema_arn
    }

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