| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Glue.GetSchemaByDefinition
Description
Retrieves a schema by the SchemaDefinition. The schema definition is
sent to the Schema Registry, canonicalized, and hashed. If the hash is
matched within the scope of the SchemaName or ARN (or the default
registry, if none is supplied), that schema’s metadata is returned.
Otherwise, a 404 or NotFound error is returned. Schema versions in
Deleted statuses will not be included in the results.
Synopsis
- data GetSchemaByDefinition = GetSchemaByDefinition' {}
- newGetSchemaByDefinition :: SchemaId -> Text -> GetSchemaByDefinition
- getSchemaByDefinition_schemaId :: Lens' GetSchemaByDefinition SchemaId
- getSchemaByDefinition_schemaDefinition :: Lens' GetSchemaByDefinition Text
- data GetSchemaByDefinitionResponse = GetSchemaByDefinitionResponse' {}
- newGetSchemaByDefinitionResponse :: Int -> GetSchemaByDefinitionResponse
- getSchemaByDefinitionResponse_status :: Lens' GetSchemaByDefinitionResponse (Maybe SchemaVersionStatus)
- getSchemaByDefinitionResponse_createdTime :: Lens' GetSchemaByDefinitionResponse (Maybe Text)
- getSchemaByDefinitionResponse_dataFormat :: Lens' GetSchemaByDefinitionResponse (Maybe DataFormat)
- getSchemaByDefinitionResponse_schemaVersionId :: Lens' GetSchemaByDefinitionResponse (Maybe Text)
- getSchemaByDefinitionResponse_schemaArn :: Lens' GetSchemaByDefinitionResponse (Maybe Text)
- getSchemaByDefinitionResponse_httpStatus :: Lens' GetSchemaByDefinitionResponse Int
Creating a Request
data GetSchemaByDefinition Source #
See: newGetSchemaByDefinition smart constructor.
Constructors
| GetSchemaByDefinition' | |
Fields
| |
Instances
newGetSchemaByDefinition Source #
Arguments
| :: SchemaId | |
| -> Text | |
| -> GetSchemaByDefinition |
Create a value of GetSchemaByDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:schemaId:GetSchemaByDefinition', getSchemaByDefinition_schemaId - This is a wrapper structure to contain schema identity fields. The
structure contains:
- SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema.
One of
SchemaArnorSchemaNamehas to be provided. - SchemaId$SchemaName: The name of the schema. One of
SchemaArnorSchemaNamehas to be provided.
$sel:schemaDefinition:GetSchemaByDefinition', getSchemaByDefinition_schemaDefinition - The definition of the schema for which schema details are required.
Request Lenses
getSchemaByDefinition_schemaId :: Lens' GetSchemaByDefinition SchemaId Source #
This is a wrapper structure to contain schema identity fields. The structure contains:
- SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema.
One of
SchemaArnorSchemaNamehas to be provided. - SchemaId$SchemaName: The name of the schema. One of
SchemaArnorSchemaNamehas to be provided.
getSchemaByDefinition_schemaDefinition :: Lens' GetSchemaByDefinition Text Source #
The definition of the schema for which schema details are required.
Destructuring the Response
data GetSchemaByDefinitionResponse Source #
See: newGetSchemaByDefinitionResponse smart constructor.
Constructors
| GetSchemaByDefinitionResponse' | |
Fields
| |
Instances
newGetSchemaByDefinitionResponse Source #
Create a value of GetSchemaByDefinitionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:GetSchemaByDefinitionResponse', getSchemaByDefinitionResponse_status - The status of the schema version.
$sel:createdTime:GetSchemaByDefinitionResponse', getSchemaByDefinitionResponse_createdTime - The date and time the schema was created.
$sel:dataFormat:GetSchemaByDefinitionResponse', getSchemaByDefinitionResponse_dataFormat - The data format of the schema definition. Currently only AVRO and
JSON are supported.
$sel:schemaVersionId:GetSchemaByDefinitionResponse', getSchemaByDefinitionResponse_schemaVersionId - The schema ID of the schema version.
$sel:schemaArn:GetSchemaByDefinitionResponse', getSchemaByDefinitionResponse_schemaArn - The Amazon Resource Name (ARN) of the schema.
$sel:httpStatus:GetSchemaByDefinitionResponse', getSchemaByDefinitionResponse_httpStatus - The response's http status code.
Response Lenses
getSchemaByDefinitionResponse_status :: Lens' GetSchemaByDefinitionResponse (Maybe SchemaVersionStatus) Source #
The status of the schema version.
getSchemaByDefinitionResponse_createdTime :: Lens' GetSchemaByDefinitionResponse (Maybe Text) Source #
The date and time the schema was created.
getSchemaByDefinitionResponse_dataFormat :: Lens' GetSchemaByDefinitionResponse (Maybe DataFormat) Source #
The data format of the schema definition. Currently only AVRO and
JSON are supported.
getSchemaByDefinitionResponse_schemaVersionId :: Lens' GetSchemaByDefinitionResponse (Maybe Text) Source #
The schema ID of the schema version.
getSchemaByDefinitionResponse_schemaArn :: Lens' GetSchemaByDefinitionResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the schema.
getSchemaByDefinitionResponse_httpStatus :: Lens' GetSchemaByDefinitionResponse Int Source #
The response's http status code.