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 |
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_schemaVersionId :: Lens' GetSchemaVersion (Maybe Text)
- getSchemaVersion_schemaId :: Lens' GetSchemaVersion (Maybe SchemaId)
- getSchemaVersion_schemaVersionNumber :: Lens' GetSchemaVersion (Maybe SchemaVersionNumber)
- data GetSchemaVersionResponse = GetSchemaVersionResponse' {}
- newGetSchemaVersionResponse :: Int -> GetSchemaVersionResponse
- getSchemaVersionResponse_status :: Lens' GetSchemaVersionResponse (Maybe SchemaVersionStatus)
- getSchemaVersionResponse_schemaDefinition :: Lens' GetSchemaVersionResponse (Maybe Text)
- getSchemaVersionResponse_createdTime :: Lens' GetSchemaVersionResponse (Maybe Text)
- getSchemaVersionResponse_dataFormat :: Lens' GetSchemaVersionResponse (Maybe DataFormat)
- getSchemaVersionResponse_schemaVersionId :: Lens' GetSchemaVersionResponse (Maybe Text)
- getSchemaVersionResponse_versionNumber :: Lens' GetSchemaVersionResponse (Maybe Natural)
- getSchemaVersionResponse_schemaArn :: Lens' GetSchemaVersionResponse (Maybe Text)
- getSchemaVersionResponse_httpStatus :: Lens' GetSchemaVersionResponse Int
Creating a Request
data GetSchemaVersion Source #
See: newGetSchemaVersion
smart constructor.
GetSchemaVersion' | |
|
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:
$sel:schemaVersionId: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.
$sel:schemaId: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
SchemaArn
orSchemaName
andRegistryName
has to be provided. - SchemaId$SchemaName: The name of the schema. Either
SchemaArn
orSchemaName
andRegistryName
has to be provided.
$sel:schemaVersionNumber:GetSchemaVersion'
, getSchemaVersion_schemaVersionNumber
- The version number of the schema.
Request Lenses
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_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
SchemaArn
orSchemaName
andRegistryName
has to be provided. - SchemaId$SchemaName: The name of the schema. Either
SchemaArn
orSchemaName
andRegistryName
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.
GetSchemaVersionResponse' | |
|
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:
$sel:status:GetSchemaVersionResponse'
, getSchemaVersionResponse_status
- The status of the schema version.
$sel:schemaDefinition:GetSchemaVersionResponse'
, getSchemaVersionResponse_schemaDefinition
- The schema definition for the schema ID.
$sel:createdTime: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
and JSON
are supported.
$sel:schemaVersionId:GetSchemaVersion'
, getSchemaVersionResponse_schemaVersionId
- The SchemaVersionId
of the schema version.
$sel:versionNumber:GetSchemaVersionResponse'
, getSchemaVersionResponse_versionNumber
- The version number of the schema.
$sel:schemaArn:GetSchemaVersionResponse'
, getSchemaVersionResponse_schemaArn
- The Amazon Resource Name (ARN) of the schema.
$sel:httpStatus:GetSchemaVersionResponse'
, getSchemaVersionResponse_httpStatus
- The response's http status code.
Response Lenses
getSchemaVersionResponse_status :: Lens' GetSchemaVersionResponse (Maybe SchemaVersionStatus) Source #
The status of the schema version.
getSchemaVersionResponse_schemaDefinition :: Lens' GetSchemaVersionResponse (Maybe Text) Source #
The schema definition for the schema ID.
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
and JSON
are supported.
getSchemaVersionResponse_schemaVersionId :: Lens' GetSchemaVersionResponse (Maybe Text) Source #
The SchemaVersionId
of the schema version.
getSchemaVersionResponse_versionNumber :: Lens' GetSchemaVersionResponse (Maybe Natural) Source #
The version number of the schema.
getSchemaVersionResponse_schemaArn :: Lens' GetSchemaVersionResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the schema.
getSchemaVersionResponse_httpStatus :: Lens' GetSchemaVersionResponse Int Source #
The response's http status code.