| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Glue.GetSchemaVersion
Description
Get the specified schema by its unique ID assigned when a version of the schema is created or registered. Schema versions in Deleted status will not be included in the results.
Synopsis
- data GetSchemaVersion = GetSchemaVersion' {}
- newGetSchemaVersion :: GetSchemaVersion
- getSchemaVersion_schemaId :: Lens' GetSchemaVersion (Maybe SchemaId)
- getSchemaVersion_schemaVersionId :: Lens' GetSchemaVersion (Maybe Text)
- getSchemaVersion_schemaVersionNumber :: Lens' GetSchemaVersion (Maybe SchemaVersionNumber)
- data GetSchemaVersionResponse = GetSchemaVersionResponse' {}
- newGetSchemaVersionResponse :: Int -> GetSchemaVersionResponse
- getSchemaVersionResponse_createdTime :: Lens' GetSchemaVersionResponse (Maybe Text)
- getSchemaVersionResponse_dataFormat :: Lens' GetSchemaVersionResponse (Maybe DataFormat)
- getSchemaVersionResponse_schemaArn :: Lens' GetSchemaVersionResponse (Maybe Text)
- getSchemaVersionResponse_schemaDefinition :: Lens' GetSchemaVersionResponse (Maybe Text)
- getSchemaVersionResponse_schemaVersionId :: Lens' GetSchemaVersionResponse (Maybe Text)
- getSchemaVersionResponse_status :: Lens' GetSchemaVersionResponse (Maybe SchemaVersionStatus)
- getSchemaVersionResponse_versionNumber :: Lens' GetSchemaVersionResponse (Maybe Natural)
- getSchemaVersionResponse_httpStatus :: Lens' GetSchemaVersionResponse Int
Creating a Request
data GetSchemaVersion Source #
See: newGetSchemaVersion smart constructor.
Constructors
| GetSchemaVersion' | |
Fields
| |
Instances
newGetSchemaVersion :: GetSchemaVersion Source #
Create a value of GetSchemaVersion 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:
GetSchemaVersion, getSchemaVersion_schemaId - This is a wrapper structure to contain schema identity fields. The
structure contains:
- SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema.
Either
SchemaArnorSchemaNameandRegistryNamehas to be provided. - SchemaId$SchemaName: The name of the schema. Either
SchemaArnorSchemaNameandRegistryNamehas to be provided.
GetSchemaVersion, getSchemaVersion_schemaVersionId - The SchemaVersionId of the schema version. This field is required for
fetching by schema ID. Either this or the SchemaId wrapper has to be
provided.
GetSchemaVersion, getSchemaVersion_schemaVersionNumber - The version number of the schema.
Request Lenses
getSchemaVersion_schemaId :: Lens' GetSchemaVersion (Maybe 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.
Either
SchemaArnorSchemaNameandRegistryNamehas to be provided. - SchemaId$SchemaName: The name of the schema. Either
SchemaArnorSchemaNameandRegistryNamehas to be provided.
getSchemaVersion_schemaVersionId :: Lens' GetSchemaVersion (Maybe Text) Source #
The SchemaVersionId of the schema version. This field is required for
fetching by schema ID. Either this or the SchemaId wrapper has to be
provided.
getSchemaVersion_schemaVersionNumber :: Lens' GetSchemaVersion (Maybe SchemaVersionNumber) Source #
The version number of the schema.
Destructuring the Response
data GetSchemaVersionResponse Source #
See: newGetSchemaVersionResponse smart constructor.
Constructors
| GetSchemaVersionResponse' | |
Fields
| |
Instances
newGetSchemaVersionResponse Source #
Create a value of GetSchemaVersionResponse 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:
GetSchemaVersionResponse, getSchemaVersionResponse_createdTime - The date and time the schema version was created.
$sel:dataFormat:GetSchemaVersionResponse', getSchemaVersionResponse_dataFormat - The data format of the schema definition. Currently AVRO, JSON and
PROTOBUF are supported.
GetSchemaVersionResponse, getSchemaVersionResponse_schemaArn - The Amazon Resource Name (ARN) of the schema.
$sel:schemaDefinition:GetSchemaVersionResponse', getSchemaVersionResponse_schemaDefinition - The schema definition for the schema ID.
GetSchemaVersion, getSchemaVersionResponse_schemaVersionId - The SchemaVersionId of the schema version.
GetSchemaVersionResponse, getSchemaVersionResponse_status - The status of the schema version.
GetSchemaVersionResponse, getSchemaVersionResponse_versionNumber - The version number of the schema.
$sel:httpStatus:GetSchemaVersionResponse', getSchemaVersionResponse_httpStatus - The response's http status code.
Response Lenses
getSchemaVersionResponse_createdTime :: Lens' GetSchemaVersionResponse (Maybe Text) Source #
The date and time the schema version was created.
getSchemaVersionResponse_dataFormat :: Lens' GetSchemaVersionResponse (Maybe DataFormat) Source #
The data format of the schema definition. Currently AVRO, JSON and
PROTOBUF are supported.
getSchemaVersionResponse_schemaArn :: Lens' GetSchemaVersionResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the schema.
getSchemaVersionResponse_schemaDefinition :: Lens' GetSchemaVersionResponse (Maybe Text) Source #
The schema definition for the schema ID.
getSchemaVersionResponse_schemaVersionId :: Lens' GetSchemaVersionResponse (Maybe Text) Source #
The SchemaVersionId of the schema version.
getSchemaVersionResponse_status :: Lens' GetSchemaVersionResponse (Maybe SchemaVersionStatus) Source #
The status of the schema version.
getSchemaVersionResponse_versionNumber :: Lens' GetSchemaVersionResponse (Maybe Natural) Source #
The version number of the schema.
getSchemaVersionResponse_httpStatus :: Lens' GetSchemaVersionResponse Int Source #
The response's http status code.