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 |
Remove versions from the specified schema. A version number or range may
be supplied. If the compatibility mode forbids deleting of a version
that is necessary, such as BACKWARDS_FULL, an error is returned. Calling
the GetSchemaVersions
API after this call will list the status of the
deleted versions.
When the range of version numbers contain check pointed version, the API
will return a 409 conflict and will not proceed with the deletion. You
have to remove the checkpoint first using the DeleteSchemaCheckpoint
API before using this API.
You cannot use the DeleteSchemaVersions
API to delete the first schema
version in the schema set. The first schema version can only be deleted
by the DeleteSchema
API. This operation will also delete the attached
SchemaVersionMetadata
under the schema versions. Hard deletes will be
enforced on the database.
If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned.
Synopsis
- data DeleteSchemaVersions = DeleteSchemaVersions' {}
- newDeleteSchemaVersions :: SchemaId -> Text -> DeleteSchemaVersions
- deleteSchemaVersions_schemaId :: Lens' DeleteSchemaVersions SchemaId
- deleteSchemaVersions_versions :: Lens' DeleteSchemaVersions Text
- data DeleteSchemaVersionsResponse = DeleteSchemaVersionsResponse' {}
- newDeleteSchemaVersionsResponse :: Int -> DeleteSchemaVersionsResponse
- deleteSchemaVersionsResponse_schemaVersionErrors :: Lens' DeleteSchemaVersionsResponse (Maybe [SchemaVersionErrorItem])
- deleteSchemaVersionsResponse_httpStatus :: Lens' DeleteSchemaVersionsResponse Int
Creating a Request
data DeleteSchemaVersions Source #
See: newDeleteSchemaVersions
smart constructor.
Instances
newDeleteSchemaVersions Source #
:: SchemaId | |
-> Text | |
-> DeleteSchemaVersions |
Create a value of DeleteSchemaVersions
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:DeleteSchemaVersions'
, deleteSchemaVersions_schemaId
- This is a wrapper structure that may contain the schema name and Amazon
Resource Name (ARN).
$sel:versions:DeleteSchemaVersions'
, deleteSchemaVersions_versions
- A version range may be supplied which may be of the format:
- a single version number, 5
- a range, 5-8 : deletes versions 5, 6, 7, 8
Request Lenses
deleteSchemaVersions_schemaId :: Lens' DeleteSchemaVersions SchemaId Source #
This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
deleteSchemaVersions_versions :: Lens' DeleteSchemaVersions Text Source #
A version range may be supplied which may be of the format:
- a single version number, 5
- a range, 5-8 : deletes versions 5, 6, 7, 8
Destructuring the Response
data DeleteSchemaVersionsResponse Source #
See: newDeleteSchemaVersionsResponse
smart constructor.
DeleteSchemaVersionsResponse' | |
|
Instances
newDeleteSchemaVersionsResponse Source #
Create a value of DeleteSchemaVersionsResponse
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:schemaVersionErrors:DeleteSchemaVersionsResponse'
, deleteSchemaVersionsResponse_schemaVersionErrors
- A list of SchemaVersionErrorItem
objects, each containing an error and
schema version.
$sel:httpStatus:DeleteSchemaVersionsResponse'
, deleteSchemaVersionsResponse_httpStatus
- The response's http status code.
Response Lenses
deleteSchemaVersionsResponse_schemaVersionErrors :: Lens' DeleteSchemaVersionsResponse (Maybe [SchemaVersionErrorItem]) Source #
A list of SchemaVersionErrorItem
objects, each containing an error and
schema version.
deleteSchemaVersionsResponse_httpStatus :: Lens' DeleteSchemaVersionsResponse Int Source #
The response's http status code.