amazonka-schemas-2.0: Amazon Schemas SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Schemas.Lens

Description

 
Synopsis

Operations

CreateDiscoverer

createDiscoverer_crossAccount :: Lens' CreateDiscoverer (Maybe Bool) Source #

Support discovery of schemas in events sent to the bus from another account. (default: true).

createDiscoverer_description :: Lens' CreateDiscoverer (Maybe Text) Source #

A description for the discoverer.

createDiscoverer_tags :: Lens' CreateDiscoverer (Maybe (HashMap Text Text)) Source #

Tags associated with the resource.

createDiscovererResponse_crossAccount :: Lens' CreateDiscovererResponse (Maybe Bool) Source #

The Status if the discoverer will discover schemas from events sent from another account.

CreateRegistry

createRegistry_description :: Lens' CreateRegistry (Maybe Text) Source #

A description of the registry to be created.

createRegistry_tags :: Lens' CreateRegistry (Maybe (HashMap Text Text)) Source #

Tags to associate with the registry.

CreateSchema

createSchema_description :: Lens' CreateSchema (Maybe Text) Source #

A description of the schema.

createSchema_tags :: Lens' CreateSchema (Maybe (HashMap Text Text)) Source #

Tags associated with the schema.

createSchema_content :: Lens' CreateSchema Text Source #

The source of the schema definition.

createSchemaResponse_lastModified :: Lens' CreateSchemaResponse (Maybe UTCTime) Source #

The date and time that schema was modified.

DeleteDiscoverer

DeleteRegistry

DeleteResourcePolicy

DeleteSchema

DeleteSchemaVersion

DescribeCodeBinding

describeCodeBinding_schemaVersion :: Lens' DescribeCodeBinding (Maybe Text) Source #

Specifying this limits the results to only this schema version.

describeCodeBindingResponse_creationDate :: Lens' DescribeCodeBindingResponse (Maybe UTCTime) Source #

The time and date that the code binding was created.

describeCodeBindingResponse_lastModified :: Lens' DescribeCodeBindingResponse (Maybe UTCTime) Source #

The date and time that code bindings were modified.

DescribeDiscoverer

describeDiscovererResponse_crossAccount :: Lens' DescribeDiscovererResponse (Maybe Bool) Source #

The Status if the discoverer will discover schemas from events sent from another account.

DescribeRegistry

DescribeSchema

describeSchema_schemaVersion :: Lens' DescribeSchema (Maybe Text) Source #

Specifying this limits the results to only this schema version.

describeSchemaResponse_lastModified :: Lens' DescribeSchemaResponse (Maybe UTCTime) Source #

The date and time that schema was modified.

ExportSchema

exportSchema_schemaVersion :: Lens' ExportSchema (Maybe Text) Source #

Specifying this limits the results to only this schema version.

GetCodeBindingSource

getCodeBindingSource_schemaVersion :: Lens' GetCodeBindingSource (Maybe Text) Source #

Specifying this limits the results to only this schema version.

GetDiscoveredSchema

getDiscoveredSchema_events :: Lens' GetDiscoveredSchema (NonEmpty Text) Source #

An array of strings where each string is a JSON event. These are the events that were used to generate the schema. The array includes a single type of event and has a maximum size of 10 events.

GetResourcePolicy

ListDiscoverers

listDiscoverers_discovererIdPrefix :: Lens' ListDiscoverers (Maybe Text) Source #

Specifying this limits the results to only those discoverer IDs that start with the specified prefix.

listDiscoverers_nextToken :: Lens' ListDiscoverers (Maybe Text) Source #

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

listDiscoverers_sourceArnPrefix :: Lens' ListDiscoverers (Maybe Text) Source #

Specifying this limits the results to only those ARNs that start with the specified prefix.

listDiscoverersResponse_nextToken :: Lens' ListDiscoverersResponse (Maybe Text) Source #

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

ListRegistries

listRegistries_nextToken :: Lens' ListRegistries (Maybe Text) Source #

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

listRegistries_registryNamePrefix :: Lens' ListRegistries (Maybe Text) Source #

Specifying this limits the results to only those registry names that start with the specified prefix.

listRegistries_scope :: Lens' ListRegistries (Maybe Text) Source #

Can be set to Local or AWS to limit responses to your custom registries, or the ones provided by AWS.

listRegistriesResponse_nextToken :: Lens' ListRegistriesResponse (Maybe Text) Source #

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

ListSchemaVersions

listSchemaVersions_nextToken :: Lens' ListSchemaVersions (Maybe Text) Source #

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

listSchemaVersionsResponse_nextToken :: Lens' ListSchemaVersionsResponse (Maybe Text) Source #

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

ListSchemas

listSchemas_nextToken :: Lens' ListSchemas (Maybe Text) Source #

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

listSchemas_schemaNamePrefix :: Lens' ListSchemas (Maybe Text) Source #

Specifying this limits the results to only those schema names that start with the specified prefix.

listSchemasResponse_nextToken :: Lens' ListSchemasResponse (Maybe Text) Source #

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

ListTagsForResource

PutCodeBinding

putCodeBinding_schemaVersion :: Lens' PutCodeBinding (Maybe Text) Source #

Specifying this limits the results to only this schema version.

putCodeBinding_language :: Lens' PutCodeBinding Text Source #

The language of the code binding.

putCodeBindingResponse_creationDate :: Lens' PutCodeBindingResponse (Maybe UTCTime) Source #

The time and date that the code binding was created.

putCodeBindingResponse_lastModified :: Lens' PutCodeBindingResponse (Maybe UTCTime) Source #

The date and time that code bindings were modified.

PutResourcePolicy

SearchSchemas

searchSchemas_nextToken :: Lens' SearchSchemas (Maybe Text) Source #

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

searchSchemas_keywords :: Lens' SearchSchemas Text Source #

Specifying this limits the results to only schemas that include the provided keywords.

searchSchemasResponse_nextToken :: Lens' SearchSchemasResponse (Maybe Text) Source #

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

StartDiscoverer

StopDiscoverer

TagResource

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

Tags associated with the resource.

UntagResource

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

Keys of key-value pairs.

UpdateDiscoverer

updateDiscoverer_crossAccount :: Lens' UpdateDiscoverer (Maybe Bool) Source #

Support discovery of schemas in events sent to the bus from another account. (default: true)

updateDiscoverer_description :: Lens' UpdateDiscoverer (Maybe Text) Source #

The description of the discoverer to update.

updateDiscovererResponse_crossAccount :: Lens' UpdateDiscovererResponse (Maybe Bool) Source #

The Status if the discoverer will discover schemas from events sent from another account.

UpdateRegistry

updateRegistry_description :: Lens' UpdateRegistry (Maybe Text) Source #

The description of the registry to update.

UpdateSchema

updateSchema_content :: Lens' UpdateSchema (Maybe Text) Source #

The source of the schema definition.

updateSchema_description :: Lens' UpdateSchema (Maybe Text) Source #

The description of the schema.

updateSchema_type :: Lens' UpdateSchema (Maybe Type) Source #

The schema type for the events schema.

updateSchemaResponse_lastModified :: Lens' UpdateSchemaResponse (Maybe UTCTime) Source #

The date and time that schema was modified.

Types

DiscovererSummary

discovererSummary_crossAccount :: Lens' DiscovererSummary (Maybe Bool) Source #

The Status if the discoverer will discover schemas from events sent from another account.

discovererSummary_tags :: Lens' DiscovererSummary (Maybe (HashMap Text Text)) Source #

Tags associated with the resource.

RegistrySummary

registrySummary_tags :: Lens' RegistrySummary (Maybe (HashMap Text Text)) Source #

Tags associated with the registry.

SchemaSummary

schemaSummary_lastModified :: Lens' SchemaSummary (Maybe UTCTime) Source #

The date and time that schema was modified.

schemaSummary_tags :: Lens' SchemaSummary (Maybe (HashMap Text Text)) Source #

Tags associated with the schema.

schemaSummary_versionCount :: Lens' SchemaSummary (Maybe Integer) Source #

The number of versions available for the schema.

SchemaVersionSummary

SearchSchemaSummary

SearchSchemaVersionSummary