@datafire/amazonaws_schemas NPM

@datafire/amazonaws_schemas

Client library for Schemas

Installation and Usage

npm install --save @datafire/amazonaws_schemas

let amazonaws_schemas = require('@datafire/amazonaws_schemas').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Amazon EventBridge Schema Registry

Actions

ListTagsForResource

amazonaws_schemas.ListTagsForResource({
  "resource-arn": ""
}, context)

Input

input object
- resource-arn required string

Output

output ListTagsForResourceResponse

TagResource

amazonaws_schemas.TagResource({
  "resource-arn": "",
  "tags": {}
}, context)

Input

input object
- resource-arn required string
- tags required object: Key-value pairs associated with a resource.

Output

Output schema unknown

UntagResource

amazonaws_schemas.UntagResource({
  "resource-arn": "",
  "tagKeys": []
}, context)

Input

input object
- resource-arn required string
- tagKeys required array

Output

Output schema unknown

GetDiscoveredSchema

amazonaws_schemas.GetDiscoveredSchema({
  "Events": [],
  "Type": ""
}, context)

Input

input object
- Events required array: 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.
  - items GetDiscoveredSchemaVersionItemInput
- Type required string (values: OpenApi3, JSONSchemaDraft4): The type of event.

Output

output GetDiscoveredSchemaResponse

ListDiscoverers

amazonaws_schemas.ListDiscoverers({}, context)

Input

input object
- discovererIdPrefix string
- limit integer
- nextToken string
- sourceArnPrefix string
- Limit string
- NextToken string

Output

output ListDiscoverersResponse

CreateDiscoverer

amazonaws_schemas.CreateDiscoverer({
  "SourceArn": ""
}, context)

Input

input object
- tags object: Key-value pairs associated with a resource.
- Description string: A description for the discoverer.
- SourceArn required string: The ARN of the event bus.

Output

Output schema unknown

DeleteDiscoverer

amazonaws_schemas.DeleteDiscoverer({
  "discovererId": ""
}, context)

Input

input object
- discovererId required string

Output

Output schema unknown

DescribeDiscoverer

amazonaws_schemas.DescribeDiscoverer({
  "discovererId": ""
}, context)

Input

input object
- discovererId required string

Output

output DescribeDiscovererResponse

UpdateDiscoverer

amazonaws_schemas.UpdateDiscoverer({
  "discovererId": ""
}, context)

Input

input object
- discovererId required string
- Description string: The description of the discoverer to update.

Output

output UpdateDiscovererResponse

StartDiscoverer

amazonaws_schemas.StartDiscoverer({
  "discovererId": ""
}, context)

Input

input object
- discovererId required string

Output

output StartDiscovererResponse

StopDiscoverer

amazonaws_schemas.StopDiscoverer({
  "discovererId": ""
}, context)

Input

input object
- discovererId required string

Output

output StopDiscovererResponse

DeleteResourcePolicy

amazonaws_schemas.DeleteResourcePolicy({}, context)

Input

input object
- registryName string

Output

Output schema unknown

GetResourcePolicy

amazonaws_schemas.GetResourcePolicy({}, context)

Input

input object
- registryName string

Output

output GetResourcePolicyResponse

PutResourcePolicy

amazonaws_schemas.PutResourcePolicy({
  "Policy": ""
}, context)

Input

input object
- registryName string
- Policy required string: The resource-based policy.
- RevisionId string: The revision ID of the policy.

Output

output PutResourcePolicyResponse

ListRegistries

amazonaws_schemas.ListRegistries({}, context)

Input

input object
- limit integer
- nextToken string
- registryNamePrefix string
- scope string
- Limit string
- NextToken string

Output

output ListRegistriesResponse

DeleteRegistry

amazonaws_schemas.DeleteRegistry({
  "registryName": ""
}, context)

Input

input object
- registryName required string

Output

Output schema unknown

DescribeRegistry

amazonaws_schemas.DescribeRegistry({
  "registryName": ""
}, context)

Input

input object
- registryName required string

Output

output DescribeRegistryResponse

CreateRegistry

amazonaws_schemas.CreateRegistry({
  "registryName": ""
}, context)

Input

input object
- registryName required string
- tags object: Key-value pairs associated with a resource.
- Description string: A description of the registry to be created.

Output

Output schema unknown

UpdateRegistry

amazonaws_schemas.UpdateRegistry({
  "registryName": ""
}, context)

Input

input object
- registryName required string
- Description string: The description of the registry to update.

Output

output UpdateRegistryResponse

ListSchemas

amazonaws_schemas.ListSchemas({
  "registryName": ""
}, context)

Input

input object
- limit integer
- nextToken string
- registryName required string
- schemaNamePrefix string
- Limit string
- NextToken string

Output

output ListSchemasResponse

DeleteSchema

amazonaws_schemas.DeleteSchema({
  "registryName": "",
  "schemaName": ""
}, context)

Input

input object
- registryName required string
- schemaName required string

Output

Output schema unknown

DescribeSchema

amazonaws_schemas.DescribeSchema({
  "registryName": "",
  "schemaName": ""
}, context)

Input

input object
- registryName required string
- schemaName required string
- schemaVersion string

Output

output DescribeSchemaResponse

CreateSchema

amazonaws_schemas.CreateSchema({
  "registryName": "",
  "schemaName": "",
  "Content": "",
  "Type": ""
}, context)

Input

input object
- registryName required string
- schemaName required string
- tags object: Key-value pairs associated with a resource.
- Content required string: The source of the schema definition.
- Description string: A description of the schema.
- Type required string (values: OpenApi3, JSONSchemaDraft4): The type of schema.

Output

Output schema unknown

UpdateSchema

amazonaws_schemas.UpdateSchema({
  "registryName": "",
  "schemaName": ""
}, context)

Input

input object
- registryName required string
- schemaName required string
- ClientTokenId string: The ID of the client token.
- Content string: The source of the schema definition.
- Description string: The description of the schema.
- Type string (values: OpenApi3, JSONSchemaDraft4): The schema type for the events schema.

Output

output UpdateSchemaResponse

ExportSchema

amazonaws_schemas.ExportSchema({
  "registryName": "",
  "schemaName": "",
  "type": ""
}, context)

Input

input object
- registryName required string
- schemaName required string
- schemaVersion string
- type required string

Output

output ExportSchemaResponse

DescribeCodeBinding

amazonaws_schemas.DescribeCodeBinding({
  "language": "",
  "registryName": "",
  "schemaName": ""
}, context)

Input

input object
- language required string
- registryName required string
- schemaName required string
- schemaVersion string

Output

output DescribeCodeBindingResponse

PutCodeBinding

amazonaws_schemas.PutCodeBinding({
  "language": "",
  "registryName": "",
  "schemaName": ""
}, context)

Input

input object
- language required string
- registryName required string
- schemaName required string
- schemaVersion string

Output

Output schema unknown

GetCodeBindingSource

amazonaws_schemas.GetCodeBindingSource({
  "language": "",
  "registryName": "",
  "schemaName": ""
}, context)

Input

input object
- language required string
- registryName required string
- schemaName required string
- schemaVersion string

Output

output GetCodeBindingSourceResponse

DeleteSchemaVersion

amazonaws_schemas.DeleteSchemaVersion({
  "registryName": "",
  "schemaName": "",
  "schemaVersion": ""
}, context)

Input

input object
- registryName required string
- schemaName required string
- schemaVersion required string

Output

Output schema unknown

ListSchemaVersions

amazonaws_schemas.ListSchemaVersions({
  "registryName": "",
  "schemaName": ""
}, context)

Input

input object
- limit integer
- nextToken string
- registryName required string
- schemaName required string
- Limit string
- NextToken string

Output

output ListSchemaVersionsResponse

SearchSchemas

amazonaws_schemas.SearchSchemas({
  "keywords": "",
  "registryName": ""
}, context)

Input

input object
- keywords required string
- limit integer
- nextToken string
- registryName required string
- Limit string
- NextToken string

Output

output SearchSchemasResponse

Definitions

BadRequestException

Body

Body string

CodeGenerationStatus

CodeGenerationStatus string (values: CREATE_IN_PROGRESS, CREATE_COMPLETE, CREATE_FAILED)

ConflictException

CreateDiscovererRequest

CreateDiscovererRequest object
- Description
- SourceArn required
- Tags

CreateDiscovererResponse

CreateDiscovererResponse object
- Description
- DiscovererArn
- DiscovererId
- SourceArn
- State
- Tags

CreateRegistryRequest

CreateRegistryRequest object
- Description
- Tags

CreateRegistryResponse

CreateRegistryResponse object
- Description
- RegistryArn
- RegistryName
- Tags

CreateSchemaRequest

CreateSchemaRequest object
- Content required
- Description
- Tags
- Type required

CreateSchemaResponse

CreateSchemaResponse object
- Description
- LastModified
- SchemaArn
- SchemaName
- SchemaVersion
- Tags
- Type
- VersionCreatedDate

DeleteDiscovererRequest

DeleteDiscovererRequest object

DeleteRegistryRequest

DeleteRegistryRequest object

DeleteResourcePolicyRequest

DeleteResourcePolicyRequest object

DeleteSchemaRequest

DeleteSchemaRequest object

DeleteSchemaVersionRequest

DeleteSchemaVersionRequest object

DescribeCodeBindingRequest

DescribeCodeBindingRequest object

DescribeCodeBindingResponse

DescribeCodeBindingResponse object
- CreationDate
- LastModified
- SchemaVersion
- Status

DescribeDiscovererRequest

DescribeDiscovererRequest object

DescribeDiscovererResponse

DescribeDiscovererResponse object
- Description
- DiscovererArn
- DiscovererId
- SourceArn
- State
- Tags

DescribeRegistryRequest

DescribeRegistryRequest object

DescribeRegistryResponse

DescribeRegistryResponse object
- Description
- RegistryArn
- RegistryName
- Tags

DescribeSchemaRequest

DescribeSchemaRequest object

DescribeSchemaResponse

DescribeSchemaResponse object
- Content
- Description
- LastModified
- SchemaArn
- SchemaName
- SchemaVersion
- Tags
- Type
- VersionCreatedDate

DiscovererState

DiscovererState string (values: STARTED, STOPPED)

DiscovererSummary

DiscovererSummary object
- DiscovererArn
- DiscovererId
- SourceArn
- State
- Tags

ExportSchemaRequest

ExportSchemaRequest object

ExportSchemaResponse

ExportSchemaResponse object
- Content __string
- SchemaArn __string
- SchemaName __string
- SchemaVersion __string
- Type __string

ForbiddenException

GetCodeBindingSourceRequest

GetCodeBindingSourceRequest object

GetCodeBindingSourceResponse

GetCodeBindingSourceResponse object
- Body Body

GetDiscoveredSchemaRequest

GetDiscoveredSchemaRequest object
- Events required
  - items GetDiscoveredSchemaVersionItemInput
- Type required

GetDiscoveredSchemaResponse

GetDiscoveredSchemaResponse object
- Content

GetDiscoveredSchemaVersionItemInput

GetDiscoveredSchemaVersionItemInput string

GetResourcePolicyRequest

GetResourcePolicyRequest object

GetResourcePolicyResponse

GetResourcePolicyResponse object
- Policy
- RevisionId

GoneException

InternalServerErrorException

ListDiscoverersRequest

ListDiscoverersRequest object

ListDiscoverersResponse

ListDiscoverersResponse object
- Discoverers
  - items DiscovererSummary
- NextToken

ListRegistriesRequest

ListRegistriesRequest object

ListRegistriesResponse

ListRegistriesResponse object
- NextToken
- Registries
  - items RegistrySummary

ListSchemaVersionsRequest

ListSchemaVersionsRequest object

ListSchemaVersionsResponse

ListSchemaVersionsResponse object
- NextToken
- SchemaVersions
  - items SchemaVersionSummary

ListSchemasRequest

ListSchemasRequest object

ListSchemasResponse

ListSchemasResponse object
- NextToken
- Schemas
  - items SchemaSummary

ListTagsForResourceRequest

ListTagsForResourceRequest object

ListTagsForResourceResponse

ListTagsForResourceResponse object
- Tags

NotFoundException

PreconditionFailedException

PutCodeBindingRequest

PutCodeBindingRequest object

PutCodeBindingResponse

PutCodeBindingResponse object
- CreationDate
- LastModified
- SchemaVersion
- Status

PutResourcePolicyRequest

PutResourcePolicyRequest object: The name of the policy.
- Policy required
- RevisionId

PutResourcePolicyResponse

PutResourcePolicyResponse object
- Policy
- RevisionId

RegistrySummary

RegistrySummary object
- RegistryArn
- RegistryName
- Tags

SchemaSummary

SchemaSummary object: A summary of schema details.
- LastModified
- SchemaArn
- SchemaName
- Tags
- VersionCount

SchemaVersionSummary

SchemaVersionSummary object
- SchemaArn
- SchemaName
- SchemaVersion
- Type

SearchSchemaSummary

SearchSchemaSummary object
- RegistryName
- SchemaArn
- SchemaName
- SchemaVersions
  - items SearchSchemaVersionSummary

SearchSchemaVersionSummary

SearchSchemaVersionSummary object
- CreatedDate
- SchemaVersion
- Type

SearchSchemasRequest

SearchSchemasRequest object

SearchSchemasResponse

SearchSchemasResponse object
- NextToken
- Schemas
  - items SearchSchemaSummary

ServiceUnavailableException

StartDiscovererRequest

StartDiscovererRequest object

StartDiscovererResponse

StartDiscovererResponse object
- DiscovererId
- State

StopDiscovererRequest

StopDiscovererRequest object

StopDiscovererResponse

StopDiscovererResponse object
- DiscovererId
- State

TagResourceRequest

TagResourceRequest object
- Tags required

TooManyRequestsException

Type

Type string (values: OpenApi3, JSONSchemaDraft4)

UnauthorizedException

UntagResourceRequest

UntagResourceRequest object

UpdateDiscovererRequest

UpdateDiscovererRequest object
- Description

UpdateDiscovererResponse

UpdateDiscovererResponse object
- Description
- DiscovererArn
- DiscovererId
- SourceArn
- State
- Tags

UpdateRegistryRequest

UpdateRegistryRequest object: Updates the registry.
- Description

UpdateRegistryResponse

UpdateRegistryResponse object
- Description
- RegistryArn
- RegistryName
- Tags

UpdateSchemaRequest

UpdateSchemaRequest object
- ClientTokenId
- Content
- Description
- Type

UpdateSchemaResponse

UpdateSchemaResponse object
- Description
- LastModified
- SchemaArn
- SchemaName
- SchemaVersion
- Tags
- Type
- VersionCreatedDate

__integer

__integer integer

__listOfDiscovererSummary

__listOfDiscovererSummary array
- items DiscovererSummary

__listOfGetDiscoveredSchemaVersionItemInput

__listOfGetDiscoveredSchemaVersionItemInput array
- items GetDiscoveredSchemaVersionItemInput

__listOfRegistrySummary

__listOfRegistrySummary array
- items RegistrySummary

__listOfSchemaSummary

__listOfSchemaSummary array
- items SchemaSummary

__listOfSchemaVersionSummary

__listOfSchemaVersionSummary array
- items SchemaVersionSummary

__listOfSearchSchemaSummary

__listOfSearchSchemaSummary array
- items SearchSchemaSummary

__listOfSearchSchemaVersionSummary

__listOfSearchSchemaVersionSummary array
- items SearchSchemaVersionSummary

listOfstring

listOfstring array
- items __string

__long

__long integer

__string

__string string

__stringMin0Max256

__stringMin0Max256 string

__stringMin0Max36

__stringMin0Max36 string

__stringMin1Max100000

__stringMin1Max100000 string

__stringMin20Max1600

__stringMin20Max1600 string

__timestampIso8601

__timestampIso8601 string

datafire aws-sdk

@infinitebrahmanuniverse/nolb-_datafire_am @everything-registry/sub-chunk-220

5.0.0

5 years ago