From 56e1867d356de505171319a5d38f4cb7bca80254 Mon Sep 17 00:00:00 2001 From: Sung-Kyu Yoo Date: Sat, 5 Sep 2026 14:46:39 +0900 Subject: [PATCH 1/5] test: add reproducer for imports.go regeneration emitting an empty import block MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit TestGenerateImportsReproducesCommittedFile runs scripts/generate-imports.sh against a scratch tree and compares the result with the committed cmd/devcloud/imports.go. RED: the generator emits 'import ()' because it skips every service directory lacking register.go, and no service has one — registration lives in an init() inside provider.go. The weekly Smithy sync runs this generator, so the job has been gutting service registration. TestImportsCoverEveryRegisteredService locks imports.go against drift in either direction. It passes today; it is a regression lock, not a RED case. --- cmd/devcloud/imports_test.go | 133 +++++++++++++++++++++++++++++++++++ 1 file changed, 133 insertions(+) create mode 100644 cmd/devcloud/imports_test.go diff --git a/cmd/devcloud/imports_test.go b/cmd/devcloud/imports_test.go new file mode 100644 index 00000000..3f2bb0ce --- /dev/null +++ b/cmd/devcloud/imports_test.go @@ -0,0 +1,133 @@ +// SPDX-License-Identifier: Apache-2.0 + +package main + +import ( + "go/parser" + "go/token" + "os" + "os/exec" + "path/filepath" + "sort" + "strconv" + "strings" + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +// repoRoot resolves the repository root from this package's directory so the +// tests can reach scripts/ and internal/services/ without a hardcoded path. +func repoRoot(t *testing.T) string { + t.Helper() + root, err := filepath.Abs("../..") + require.NoError(t, err) + return root +} + +// registeringServiceDirs returns the internal/services package names that +// register a service. Registration lives in an init() inside provider.go rather +// than a dedicated file, so scanning the directory's sources is the only +// reliable signal for which packages must be imported. +func registeringServiceDirs(t *testing.T) []string { + t.Helper() + servicesDir := filepath.Join(repoRoot(t), "internal", "services") + entries, err := os.ReadDir(servicesDir) + require.NoError(t, err) + + var pkgs []string + for _, entry := range entries { + if !entry.IsDir() { + continue + } + files, err := os.ReadDir(filepath.Join(servicesDir, entry.Name())) + require.NoError(t, err) + for _, f := range files { + name := f.Name() + if f.IsDir() || !strings.HasSuffix(name, ".go") || strings.HasSuffix(name, "_test.go") { + continue + } + src, err := os.ReadFile(filepath.Join(servicesDir, entry.Name(), name)) + require.NoError(t, err) + if strings.Contains(string(src), "DefaultRegistry.Register(") { + pkgs = append(pkgs, entry.Name()) + break + } + } + } + sort.Strings(pkgs) + return pkgs +} + +// importedServicePackages reads the blank service imports out of imports.go. +func importedServicePackages(t *testing.T) []string { + t.Helper() + const prefix = "github.com/skyoo2003/devcloud/internal/services/" + + path := filepath.Join(repoRoot(t), "cmd", "devcloud", "imports.go") + file, err := parser.ParseFile(token.NewFileSet(), path, nil, parser.ImportsOnly) + require.NoError(t, err) + + var pkgs []string + for _, spec := range file.Imports { + imported, err := strconv.Unquote(spec.Path.Value) + require.NoError(t, err) + if after, found := strings.CutPrefix(imported, prefix); found { + pkgs = append(pkgs, after) + } + } + sort.Strings(pkgs) + return pkgs +} + +// TestGenerateImportsReproducesCommittedFile is the guard on the generator +// itself: regenerating imports.go must produce exactly what is committed. The +// weekly Smithy sync runs this generator before its test step, so a generator +// that silently writes a shorter file takes every service out of the binary. +// +// It runs against a scratch tree rather than the repository, so a broken +// generator cannot overwrite the committed file while proving that it is broken. +func TestGenerateImportsReproducesCommittedFile(t *testing.T) { + root := repoRoot(t) + + work := t.TempDir() + require.NoError(t, os.MkdirAll(filepath.Join(work, "cmd", "devcloud"), 0o755)) + require.NoError(t, os.MkdirAll(filepath.Join(work, "internal"), 0o755)) + require.NoError(t, os.Symlink( + filepath.Join(root, "internal", "services"), + filepath.Join(work, "internal", "services"), + )) + + cmd := exec.Command("bash", filepath.Join(root, "scripts", "generate-imports.sh")) + cmd.Dir = work + out, err := cmd.CombinedOutput() + require.NoError(t, err, "generator exited non-zero:\n%s", out) + + got, err := os.ReadFile(filepath.Join(work, "cmd", "devcloud", "imports.go")) + require.NoError(t, err) + want, err := os.ReadFile(filepath.Join(root, "cmd", "devcloud", "imports.go")) + require.NoError(t, err) + + assert.Equal(t, string(want), string(got), + "regenerating imports.go must reproduce the committed file byte for byte") +} + +// TestImportsCoverEveryRegisteredService locks imports.go against drift in +// either direction. A service package that is not imported never runs its +// init(), so it is registered nowhere and unreachable at runtime — silently, and +// only in the built binary. +func TestImportsCoverEveryRegisteredService(t *testing.T) { + registered := registeringServiceDirs(t) + imported := importedServicePackages(t) + + // Conservative floor, mirroring conformance_test.go: a collapse in the + // service surface should fail here loudly rather than pass an empty + // comparison against an equally empty imports.go. + const minServices = 50 + require.GreaterOrEqual(t, len(registered), minServices, + "found %d registering service packages, want >= %d", len(registered), minServices) + + assert.Equal(t, registered, imported, + "every service package that registers must be blank-imported in imports.go, and nothing else") +} From 9a53664a76fb97a707d4566408977a0d391a8192 Mon Sep 17 00:00:00 2001 From: Sung-Kyu Yoo Date: Sat, 5 Sep 2026 14:48:32 +0900 Subject: [PATCH 2/5] fix: generate-imports.sh emitted an empty import block MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Gate on the package actually calling DefaultRegistry.Register instead of on a register.go filename that no service has ever had. Registration lives in an init() inside provider.go, so the old gate skipped all 103 packages and wrote 'import ()' — which empties the binary rather than degrading it, since an unimported package never runs its init(). Three supporting changes, each with a failure it prevents: - build into a temp file and mv on success, so a refusal cannot truncate a good imports.go (mirrors download-smithy-models.sh) - refuse and exit non-zero below MIN_SERVICES (default 50), so the weekly sync cannot regenerate an empty file and report success - delegate the SPDX line to add-spdx-header.sh rather than restating the rule GREEN: TestGenerateImportsReproducesCommittedFile passes; a real run reproduces the committed imports.go byte for byte (103 services). --- scripts/generate-imports.sh | 61 ++++++++++++++++++++++++++++++++----- 1 file changed, 53 insertions(+), 8 deletions(-) diff --git a/scripts/generate-imports.sh b/scripts/generate-imports.sh index f3bb8ec4..cb2e4bd5 100755 --- a/scripts/generate-imports.sh +++ b/scripts/generate-imports.sh @@ -1,28 +1,73 @@ #!/usr/bin/env bash # scripts/generate-imports.sh # Generates cmd/devcloud/imports.go with blank imports for all services. +# +# A service package is only registered if this file imports it: registration +# happens in an init(), which never runs for a package nothing imports. So a +# short or empty imports.go does not degrade the binary, it empties it — and +# only in the built artefact, where nothing else notices. set -euo pipefail +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" SERVICES_DIR="./internal/services" OUTPUT="./cmd/devcloud/imports.go" -cat > "$OUTPUT" << 'HEADER' +# Build into a temp file first: the floor check below has to be able to refuse +# without having already truncated a good imports.go. Same reasoning as +# download-smithy-models.sh — a failed run must leave the committed file alone. +tmp="$(mktemp)" +trap 'rm -f "$tmp"' EXIT + +cat > "$tmp" << 'HEADER' // Code generated by scripts/generate-imports.sh. DO NOT EDIT. package main import ( HEADER +count=0 for dir in "$SERVICES_DIR"/*/; do pkg=$(basename "$dir") - # Skip directories without register.go - if [ ! -f "${dir}register.go" ]; then - continue - fi - echo " _ \"github.com/skyoo2003/devcloud/internal/services/${pkg}\"" >> "$OUTPUT" + + # Gate on the package actually calling Register, not on a filename. + # Registration lives in an init() inside provider.go; no service has ever had + # a register.go, so gating on that filename skipped all of them and emitted an + # empty import block. _test.go is excluded so a test that merely mentions + # Register cannot qualify a package that does not register. + registers=0 + for f in "$dir"*.go; do + [ -f "$f" ] || continue + case "$f" in *_test.go) continue ;; esac + if grep -q 'DefaultRegistry\.Register(' "$f"; then + registers=1 + break + fi + done + [ "$registers" -eq 1 ] || continue + + echo " _ \"github.com/skyoo2003/devcloud/internal/services/${pkg}\"" >> "$tmp" + count=$((count + 1)) done -echo ")" >> "$OUTPUT" +echo ")" >> "$tmp" + +# Every service package is committed, so a run that finds almost none has a +# broken gate rather than a shrunken fleet. Exiting non-zero is the point: the +# weekly sync workflow regenerates this file, and a silent green run that wrote +# an empty import block is exactly the failure this check exists to stop. +MIN_SERVICES="${MIN_SERVICES:-50}" +if [ "$count" -lt "$MIN_SERVICES" ]; then + echo "ERROR: found ${count} registering service package(s) under ${SERVICES_DIR}, expected at least ${MIN_SERVICES}." >&2 + echo "Refusing to write a gutted ${OUTPUT}; it is unchanged." >&2 + exit 1 +fi + +mv "$tmp" "$OUTPUT" +trap - EXIT gofmt -w "$OUTPUT" -echo "Generated $OUTPUT" +# Reuse the repo's SPDX rule rather than restating it here: that script already +# knows to keep the "Code generated" marker on line 1 and insert SPDX on line 2. +bash "${SCRIPT_DIR}/add-spdx-header.sh" "$OUTPUT" + +echo "Generated $OUTPUT with ${count} services" From 48817723b22b620864ae444a8a13572f152b93b1 Mon Sep 17 00:00:00 2001 From: Sung-Kyu Yoo Date: Sat, 5 Sep 2026 14:55:05 +0900 Subject: [PATCH 3/5] fix: scaffolded services served nothing while the manifest called them auto-crud MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Scaffold (internal/codegen/templates/scaffold_provider.go.tmpl): HandleRequest returned generated.ErrNotImplemented, a plain refusal the gateway never routes to the CRUD engine (internal/gateway/router.go:61), so a freshly scaffolded service was registered, routed, and served zero operations. It now returns plugin.ErrUnhandledOp, and Init keeps cfg.DataDir instead of dropping it. Manifest (gen_fidelity.go, scan_handverified.go): tierFor labelled an operation auto-crud from CRUD-registry membership alone. Registry membership means classifiable, not reachable — so the manifest would have advertised every scaffolded service's CRUD operations as served while the binary refused them. ProviderScan now reports EngineWired, detected by a receiver-scoped AST walk for plugin.ErrUnhandledOp, and only a wired provider can produce an auto-crud label. BuildFidelityData takes the ProviderScan map directly, which also drops an intermediate map in cmd/codegen. RED (executed, before the fix): --- FAIL: TestGenerateScaffoldOptsIntoCRUDEngine rendered scaffold does not contain "plugin.ErrUnhandledOp" --- FAIL: TestGenerateScaffoldKeepsDataDir rendered scaffold does not contain "cfg.DataDir" build failed: unknown field EngineWired in struct literal of type ProviderScan build failed: cannot use providers (map[string]ProviderScan) as map[string][]string in argument to BuildFidelityData GREEN: all five tests pass; go build and the full go test ./... suite are green across 110 packages. Key validation — 'make codegen' produces NO diff under internal/generated/. The manifest is byte-identical, which proves the wiring detection agrees with today's 46 engine-wired JSON services and demoted no live operation. No separate RED checkpoint commit: the repo's go-vet pre-commit hook refuses a tree that does not compile, and the fidelity RED was a compile failure. The RED output is preserved above and in the evidence report. --- cmd/codegen/main.go | 7 +- internal/codegen/gen_fidelity.go | 36 +++++++-- internal/codegen/gen_fidelity_test.go | 79 +++++++++++++++++++ internal/codegen/gen_scaffold_test.go | 50 ++++++++++++ internal/codegen/scan_handverified.go | 47 ++++++++++- internal/codegen/scan_handverified_test.go | 20 +++++ .../templates/scaffold_provider.go.tmpl | 13 ++- 7 files changed, 236 insertions(+), 16 deletions(-) create mode 100644 internal/codegen/gen_fidelity_test.go create mode 100644 internal/codegen/gen_scaffold_test.go diff --git a/cmd/codegen/main.go b/cmd/codegen/main.go index 0d93e9a4..680abfe1 100644 --- a/cmd/codegen/main.go +++ b/cmd/codegen/main.go @@ -168,13 +168,8 @@ func writeFidelityManifest( providers map[string]codegen.ProviderScan, crudServices []codegen.CRUDServiceData, ) error { - handVerified := make(map[string][]string, len(providers)) - for id, scan := range providers { - handVerified[id] = scan.Operations - } - content, err := gen.GenerateFidelityManifest( - codegen.BuildFidelityData(modelOps, handVerified, crudServices), + codegen.BuildFidelityData(modelOps, providers, crudServices), ) if err != nil { return err diff --git a/internal/codegen/gen_fidelity.go b/internal/codegen/gen_fidelity.go index 3054c4a2..3433cb76 100644 --- a/internal/codegen/gen_fidelity.go +++ b/internal/codegen/gen_fidelity.go @@ -40,9 +40,15 @@ type FidelityOpData struct { // Precedence is hand-verified > auto-crud > unimplemented, mirroring the runtime: // the CRUD engine is reached only when a provider's dispatch falls through, so a // hand-written implementation always wins. See docs/crud-engine.md. +// +// Registry membership alone does not earn the auto-crud label. It says an +// operation is *classifiable*, while the engine is reached at runtime only for +// providers that return plugin.ErrUnhandledOp — so an unwired provider's +// CRUD-shaped operations are refused, and calling them auto-crud would publish +// coverage the binary does not serve. func BuildFidelityData( modelOps map[string][]string, - handVerified map[string][]string, + providers map[string]ProviderScan, autoCRUD []CRUDServiceData, ) FidelityData { crudOps := make(map[string]map[string]bool, len(autoCRUD)) @@ -55,10 +61,20 @@ func BuildFidelityData( } data := FidelityData{} - for _, serviceID := range sortedKeys(handVerified) { - hand := make(map[string]bool, len(handVerified[serviceID])) + for _, serviceID := range sortedKeys(providers) { + provider := providers[serviceID] + + // Reachable, not merely classifiable: an unwired provider serves none of + // the registry's operations, so its served set is empty and its + // CRUD-shaped operations fall through to unimplemented. + var served map[string]bool + if provider.EngineWired { + served = crudOps[serviceID] + } + + hand := make(map[string]bool, len(provider.Operations)) universe := make(map[string]bool) - for _, op := range handVerified[serviceID] { + for _, op := range provider.Operations { hand[op] = true universe[op] = true } @@ -79,7 +95,7 @@ func BuildFidelityData( for _, name := range names { ops = append(ops, FidelityOpData{ Name: name, - TierConst: tierFor(name, hand, crudOps[serviceID]), + TierConst: tierFor(name, hand, served), }) } @@ -92,18 +108,22 @@ func BuildFidelityData( return data } -func tierFor(op string, hand, crud map[string]bool) string { +// tierFor labels one operation. served holds the engine-servable operations of +// an engine-wired provider, and is empty for a provider the engine never +// reaches — so an unwired service can only produce hand-verified or +// unimplemented, never auto-crud. +func tierFor(op string, hand, served map[string]bool) string { switch { case hand[op]: return "HandVerified" - case crud[op]: + case served[op]: return "AutoCRUD" default: return "Unimplemented" } } -func sortedKeys(m map[string][]string) []string { +func sortedKeys[V any](m map[string]V) []string { keys := make([]string, 0, len(m)) for k := range m { keys = append(keys, k) diff --git a/internal/codegen/gen_fidelity_test.go b/internal/codegen/gen_fidelity_test.go new file mode 100644 index 00000000..acc96c49 --- /dev/null +++ b/internal/codegen/gen_fidelity_test.go @@ -0,0 +1,79 @@ +// SPDX-License-Identifier: Apache-2.0 + +// internal/codegen/gen_fidelity_test.go +package codegen + +import ( + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +// tierOf finds one operation's tier in the built data. +func tierOf(t *testing.T, data FidelityData, serviceID, op string) string { + t.Helper() + for _, svc := range data.Services { + if svc.ServiceID != serviceID { + continue + } + for _, o := range svc.Ops { + if o.Name == op { + return o.TierConst + } + } + require.Failf(t, "operation missing", "%s/%s is absent from the manifest", serviceID, op) + } + require.Failf(t, "service missing", "%s is absent from the manifest", serviceID) + return "" +} + +// TestBuildFidelityDataRequiresEngineWiring is the guard against the manifest +// overstating coverage. +// +// Being in the CRUD registry only means an operation is *classifiable* — the +// engine is reached at runtime only for providers that return +// plugin.ErrUnhandledOp. Labelling an operation auto-crud on registry +// membership alone publishes "this is served" for a provider that refuses it, +// which is exactly what a freshly scaffolded service would look like. +func TestBuildFidelityDataRequiresEngineWiring(t *testing.T) { + modelOps := map[string][]string{ + "wired": {"CreateThing"}, + "unwired": {"CreateThing"}, + } + // Neither service hand-implements anything; the only difference is whether + // its dispatch reaches the engine. + providers := map[string]ProviderScan{ + "wired": {EngineWired: true}, + "unwired": {EngineWired: false}, + } + autoCRUD := []CRUDServiceData{ + {ServiceID: "wired", Ops: []crudOpData{{Op: "CreateThing", Verb: "Create"}}}, + {ServiceID: "unwired", Ops: []crudOpData{{Op: "CreateThing", Verb: "Create"}}}, + } + + data := BuildFidelityData(modelOps, providers, autoCRUD) + + assert.Equal(t, "AutoCRUD", tierOf(t, data, "wired", "CreateThing"), + "an engine-wired provider's CRUD-shaped operation is served, so auto-crud is truthful") + assert.Equal(t, "Unimplemented", tierOf(t, data, "unwired", "CreateThing"), + "a provider that never reaches the engine serves nothing, whatever the CRUD registry says") +} + +// TestBuildFidelityDataHandVerifiedBeatsWiring keeps the documented precedence: +// a hand-written implementation always wins, and it does not depend on engine +// wiring because such an operation never falls through to the engine at all. +func TestBuildFidelityDataHandVerifiedBeatsWiring(t *testing.T) { + modelOps := map[string][]string{"svc": {"CreateThing"}} + providers := map[string]ProviderScan{ + "svc": {Operations: []string{"CreateThing"}, EngineWired: false}, + } + autoCRUD := []CRUDServiceData{ + {ServiceID: "svc", Ops: []crudOpData{{Op: "CreateThing", Verb: "Create"}}}, + } + + data := BuildFidelityData(modelOps, providers, autoCRUD) + + assert.Equal(t, "HandVerified", tierOf(t, data, "svc", "CreateThing"), + "hand-verified outranks both auto-crud and unimplemented") +} diff --git a/internal/codegen/gen_scaffold_test.go b/internal/codegen/gen_scaffold_test.go new file mode 100644 index 00000000..5937e831 --- /dev/null +++ b/internal/codegen/gen_scaffold_test.go @@ -0,0 +1,50 @@ +// SPDX-License-Identifier: Apache-2.0 + +// internal/codegen/gen_scaffold_test.go +package codegen + +import ( + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +// TestGenerateScaffoldOptsIntoCRUDEngine pins the one line that decides whether +// a newly scaffolded service serves anything at all. +// +// The gateway routes to the generic CRUD engine only when a provider returns +// plugin.ErrUnhandledOp (internal/gateway/router.go). Any other error is a plain +// refusal, so a scaffold that declines differently is registered, routed, and +// serves zero operations — while the fidelity manifest still advertises its +// CRUD-shaped operations as auto-crud. +func TestGenerateScaffoldOptsIntoCRUDEngine(t *testing.T) { + model := loadTestModel(t) + gen := NewGenerator("templates") + + output, err := gen.GenerateScaffold("s3", model) + require.NoError(t, err) + + // Assert on the return statement, not on the string anywhere in the file: + // the scaffold's doc comment names the wrong-way error on purpose, to say + // why declining that way serves nothing. + assert.Contains(t, output, "return nil, plugin.ErrUnhandledOp", + "a scaffolded provider must opt into the CRUD engine, or it serves nothing") + assert.NotContains(t, output, "return nil, generated.ErrNotImplemented", + "ErrNotImplemented is a refusal the gateway never routes to the CRUD engine") +} + +// TestGenerateScaffoldKeepsDataDir checks the scaffold carries the data +// directory it is handed, matching what hand-written providers do in Init. A +// scaffold that drops it forces the first contributor who needs persistence to +// rewrite Init before writing any behaviour. +func TestGenerateScaffoldKeepsDataDir(t *testing.T) { + model := loadTestModel(t) + gen := NewGenerator("templates") + + output, err := gen.GenerateScaffold("s3", model) + require.NoError(t, err) + + assert.Contains(t, output, "cfg.DataDir", + "Init must keep the configured data directory, as hand-written providers do") +} diff --git a/internal/codegen/scan_handverified.go b/internal/codegen/scan_handverified.go index ab9d70fc..246782b8 100644 --- a/internal/codegen/scan_handverified.go +++ b/internal/codegen/scan_handverified.go @@ -70,6 +70,12 @@ var pathRoutedOps = map[string][]string{ type ProviderScan struct { // Operations are the operation names the provider dispatches by hand. Operations []string + // EngineWired reports whether the provider hands the operations it does not + // implement to the generic CRUD engine, by returning plugin.ErrUnhandledOp. + // Only a wired provider's CRUD-shaped operations are actually served, so + // this is what separates a truthful auto-crud label from a claim: the CRUD + // registry says an operation is *classifiable*, never that it is reachable. + EngineWired bool } // ScanProviders returns, per registered service ID, the operations its provider @@ -104,7 +110,10 @@ func ScanProviders(servicesDir string) (map[string]ProviderScan, error) { return nil, err } for id, recvType := range pkg.serviceTypes { - result[id] = ProviderScan{Operations: opsFor(id, pkg.dispatchedOps(recvType))} + result[id] = ProviderScan{ + Operations: opsFor(id, pkg.dispatchedOps(recvType)), + EngineWired: pkg.wiresCRUDEngine(recvType), + } } } return result, nil @@ -203,6 +212,42 @@ func (p packageScan) dispatchedOps(recvType string) map[string]bool { return ops } +// wiresCRUDEngine reports whether a provider type opts into the generic CRUD +// engine, by returning plugin.ErrUnhandledOp anywhere in its dispatch. +// +// It walks the same methods as dispatchedOps, and for the same reason: scoping +// to one receiver's dispatch is what stops a package registering two services +// (iam also registers sts) from crediting one with the other's wiring. +func (p packageScan) wiresCRUDEngine(recvType string) bool { + visited := make(map[string]bool) + wired := false + + var walk func(name string) + walk = func(name string) { + fn := p.methods[recvType][name] + if fn == nil || fn.Body == nil || visited[name] || wired { + return + } + visited[name] = true + + ast.Inspect(fn.Body, func(n ast.Node) bool { + sel, ok := n.(*ast.SelectorExpr) + if !ok || sel.Sel.Name != "ErrUnhandledOp" { + return true + } + if ident, isIdent := sel.X.(*ast.Ident); isIdent && ident.Name == "plugin" { + wired = true + } + return true + }) + for _, delegate := range delegateCalls(fn) { + walk(delegate) + } + } + walk("HandleRequest") + return wired +} + // collectCaseLiterals reads the case literals of every keyed switch in a body. // Keyed is the point: `switch op { case "GetItem": }` dispatches, whereas a // tagless `switch { case remaining == 0: }` is control flow whose cases are diff --git a/internal/codegen/scan_handverified_test.go b/internal/codegen/scan_handverified_test.go index e418c5b9..0fbb77e9 100644 --- a/internal/codegen/scan_handverified_test.go +++ b/internal/codegen/scan_handverified_test.go @@ -165,6 +165,26 @@ func TestPathRoutedOverridesAreReal(t *testing.T) { } } +// TestScanProvidersDetectsEngineWiring checks the scan reports whether a +// provider reaches the generic CRUD engine. Only a provider that returns +// plugin.ErrUnhandledOp does; the rest decline in their own vocabulary and are +// served by nothing, so the fidelity manifest must not call their CRUD-shaped +// operations auto-crud. +func TestScanProvidersDetectsEngineWiring(t *testing.T) { + scans, err := ScanProviders("../services") + require.NoError(t, err) + + for _, id := range []string{"codebuild", "organizations", "kinesis"} { + assert.True(t, scans[id].EngineWired, + "%s returns plugin.ErrUnhandledOp, so it must be reported as engine-wired", id) + } + // Path-routed and Query-protocol providers that answer their own default. + for _, id := range []string{"s3", "iam", "route53"} { + assert.False(t, scans[id].EngineWired, + "%s never returns plugin.ErrUnhandledOp, so it must not be reported as engine-wired", id) + } +} + // TestScanProvidersIsDeterministic keeps generated output stable across runs. func TestScanProvidersIsDeterministic(t *testing.T) { first, err := ScanProviders("../services") diff --git a/internal/codegen/templates/scaffold_provider.go.tmpl b/internal/codegen/templates/scaffold_provider.go.tmpl index 3caceafa..23932f38 100644 --- a/internal/codegen/templates/scaffold_provider.go.tmpl +++ b/internal/codegen/templates/scaffold_provider.go.tmpl @@ -13,6 +13,7 @@ import ( // Provider implements the {{ .ServiceName }} service. type Provider struct { generated.BaseProvider + dataDir string } func (p *Provider) ServiceID() string { return "{{ .ServiceID }}" } @@ -20,6 +21,7 @@ func (p *Provider) ServiceName() string { return "{{ .ServiceName }}" } func (p *Provider) Protocol() plugin.ProtocolType { return plugin.{{ .ProtocolConst }} } func (p *Provider) Init(cfg plugin.PluginConfig) error { + p.dataDir = cfg.DataDir return nil } @@ -27,8 +29,17 @@ func (p *Provider) Shutdown(ctx context.Context) error { return nil } +// HandleRequest implements nothing by hand and says so, which is what hands the +// request to the generic CRUD engine (see docs/crud-engine.md). A scaffolded +// service therefore serves its CRUD-shaped operations from the moment it is +// generated; anything the engine cannot classify still returns an honest +// InvalidAction rather than a fabricated success. +// +// Declining any other way — including generated.ErrNotImplemented — is a plain +// refusal the gateway never routes to the engine, leaving the service +// registered, routed, and serving zero operations. func (p *Provider) HandleRequest(ctx context.Context, op string, req *http.Request) (*plugin.Response, error) { - return nil, generated.ErrNotImplemented + return nil, plugin.ErrUnhandledOp } func (p *Provider) ListResources(ctx context.Context) ([]plugin.Resource, error) { From 113ac220b5330c2904f318de7ebd5ba6ee8996b2 Mon Sep 17 00:00:00 2001 From: Sung-Kyu Yoo Date: Sat, 5 Sep 2026 15:03:19 +0900 Subject: [PATCH 4/5] test: add generic service smoke coverage and measure onboarding cost MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Task 5 — one parameterized boto3 fixture (service_client) plus a smoke test that picks a parameterless List*/Describe* operation from the service model and asserts it returns 200. Adding a service now means adding its name to a list, not writing a fixture; the 104 existing named fixtures are untouched because they back real tests rather than scaffolding. Verified in both directions: - comprehend, scaffolded with zero hand-written code, PASSES - reverting the provider to generated.ErrNotImplemented makes it FAIL with 'routed but not served', and the response is HTTP 500 InternalError — so before the template fix a scaffolded service also broke the project's 'unimplemented operations return a clean AWS error' guarantee Task 6 — measured baseline. comprehend, end to end: download 0s | codegen 2s | imports 0s | build 1s = 3s total 53 generated lines in internal/services/comprehend/provider.go 0 hand-written lines Manifest reports it honestly: 49 auto-crud, 36 unimplemented, 0 hand-verified. Two existing invariants required updating, both encoding 'every service is hand-written': TestScanProviders and TestFidelityManifestCoverage asserted every service has at least one hand-verified operation. A scaffolded service legitimately has none. The invariant is now 'every service serves something — hand-verified or engine-served', which is stronger: zero of both is the real defect and is what these checks now catch. go test ./... green across 110 packages; make test-compat 776 passed (775 baseline + 1 smoke); codegen verified idempotent by hash. --- cmd/devcloud/fidelity_test.go | 22 +- cmd/devcloud/imports.go | 1 + internal/codegen/scan_handverified_test.go | 9 +- .../generated/comprehend/base_provider.go | 352 + internal/generated/comprehend/errors.go | 277 + internal/generated/comprehend/router.go | 238 + internal/generated/comprehend/types.go | 1862 +++ .../generated/crudregistry/registry_gen.go | 51 + internal/generated/fidelity/manifest_gen.go | 87 + internal/services/comprehend/provider.go | 53 + smithy-models/comprehend.json | 13893 ++++++++++++++++ tests/compatibility/conftest.py | 11 + tests/compatibility/test_service_smoke.py | 61 + 13 files changed, 16907 insertions(+), 10 deletions(-) create mode 100644 internal/generated/comprehend/base_provider.go create mode 100644 internal/generated/comprehend/errors.go create mode 100644 internal/generated/comprehend/router.go create mode 100644 internal/generated/comprehend/types.go create mode 100644 internal/services/comprehend/provider.go create mode 100644 smithy-models/comprehend.json create mode 100644 tests/compatibility/test_service_smoke.py diff --git a/cmd/devcloud/fidelity_test.go b/cmd/devcloud/fidelity_test.go index 1b4e1085..dc26d620 100644 --- a/cmd/devcloud/fidelity_test.go +++ b/cmd/devcloud/fidelity_test.go @@ -42,20 +42,26 @@ func TestFidelityManifestCoverage(t *testing.T) { } operations += len(svc.Operations) - handVerified := 0 + served := 0 for op, tier := range svc.Operations { if !validTiers[tier] { t.Errorf("%s/%s: tier %q is not a declared tier", id, op, tier) } - if tier == fidelity.TierHandVerified { - handVerified++ + if tier == fidelity.TierHandVerified || tier == fidelity.TierAutoCRUD { + served++ } } - // A service with nothing hand-verified means the scan lost its provider — - // most likely a new path-routing provider that needs a pathRoutedOps - // entry in internal/codegen/scan_handverified.go. - if handVerified == 0 { - t.Errorf("%s: no hand-verified operations; the dispatch scan probably missed this provider", id) + // Every routed service must serve something. Hand-verified operations and + // engine-served ones both count: a scaffolded service legitimately + // implements nothing by hand and is served entirely by the CRUD engine. + // + // Zero of both is the real defect — a service registered and routed that + // answers nothing. That happens when the dispatch scan loses a provider + // (a new path-routing provider needs a pathRoutedOps entry in + // internal/codegen/scan_handverified.go) or when a provider declines + // without returning plugin.ErrUnhandledOp, so it never reaches the engine. + if served == 0 { + t.Errorf("%s: serves no operations — neither hand-verified nor engine-served", id) } } if operations < minOperations { diff --git a/cmd/devcloud/imports.go b/cmd/devcloud/imports.go index 275c0e4a..33de98b9 100644 --- a/cmd/devcloud/imports.go +++ b/cmd/devcloud/imports.go @@ -31,6 +31,7 @@ import ( _ "github.com/skyoo2003/devcloud/internal/services/codepipeline" _ "github.com/skyoo2003/devcloud/internal/services/cognitoidentity" _ "github.com/skyoo2003/devcloud/internal/services/cognitoidentityprovider" + _ "github.com/skyoo2003/devcloud/internal/services/comprehend" _ "github.com/skyoo2003/devcloud/internal/services/configservice" _ "github.com/skyoo2003/devcloud/internal/services/costexplorer" _ "github.com/skyoo2003/devcloud/internal/services/dms" diff --git a/internal/codegen/scan_handverified_test.go b/internal/codegen/scan_handverified_test.go index 0fbb77e9..bef430ba 100644 --- a/internal/codegen/scan_handverified_test.go +++ b/internal/codegen/scan_handverified_test.go @@ -66,9 +66,14 @@ func TestScanProviders(t *testing.T) { assert.Contains(t, got["s3"], "PutObject") assert.Contains(t, got["bedrock"], "InvokeModel") - // No service is silently empty — an empty set means the scan lost a provider. + // No service is silently empty — an empty set means the scan lost a + // provider, unless the provider hand-implements nothing on purpose and is + // served entirely by the CRUD engine, which is what a scaffolded service is. for id, ops := range got { - assert.NotEmpty(t, ops, "%s resolved no hand-verified operations", id) + if scans[id].EngineWired { + continue + } + assert.NotEmpty(t, ops, "%s resolved no hand-verified operations and is not engine-wired, so it serves nothing", id) } } diff --git a/internal/generated/comprehend/base_provider.go b/internal/generated/comprehend/base_provider.go new file mode 100644 index 00000000..28f2b96c --- /dev/null +++ b/internal/generated/comprehend/base_provider.go @@ -0,0 +1,352 @@ +// Code generated by devcloud codegen. DO NOT EDIT. +// SPDX-License-Identifier: Apache-2.0 +package comprehend + +import ( + "context" + "fmt" +) + +var ErrNotImplemented = fmt.Errorf("operation not implemented") + +type BaseProvider struct{} + +func (b *BaseProvider) BatchDetectDominantLanguage(ctx context.Context, input *BatchDetectDominantLanguageRequest) (*BatchDetectDominantLanguageResponse, error) { + return nil, fmt.Errorf("BatchDetectDominantLanguage: %w", ErrNotImplemented) +} + +func (b *BaseProvider) BatchDetectEntities(ctx context.Context, input *BatchDetectEntitiesRequest) (*BatchDetectEntitiesResponse, error) { + return nil, fmt.Errorf("BatchDetectEntities: %w", ErrNotImplemented) +} + +func (b *BaseProvider) BatchDetectKeyPhrases(ctx context.Context, input *BatchDetectKeyPhrasesRequest) (*BatchDetectKeyPhrasesResponse, error) { + return nil, fmt.Errorf("BatchDetectKeyPhrases: %w", ErrNotImplemented) +} + +func (b *BaseProvider) BatchDetectSentiment(ctx context.Context, input *BatchDetectSentimentRequest) (*BatchDetectSentimentResponse, error) { + return nil, fmt.Errorf("BatchDetectSentiment: %w", ErrNotImplemented) +} + +func (b *BaseProvider) BatchDetectSyntax(ctx context.Context, input *BatchDetectSyntaxRequest) (*BatchDetectSyntaxResponse, error) { + return nil, fmt.Errorf("BatchDetectSyntax: %w", ErrNotImplemented) +} + +func (b *BaseProvider) BatchDetectTargetedSentiment(ctx context.Context, input *BatchDetectTargetedSentimentRequest) (*BatchDetectTargetedSentimentResponse, error) { + return nil, fmt.Errorf("BatchDetectTargetedSentiment: %w", ErrNotImplemented) +} + +func (b *BaseProvider) ClassifyDocument(ctx context.Context, input *ClassifyDocumentRequest) (*ClassifyDocumentResponse, error) { + return nil, fmt.Errorf("ClassifyDocument: %w", ErrNotImplemented) +} + +func (b *BaseProvider) ContainsPiiEntities(ctx context.Context, input *ContainsPiiEntitiesRequest) (*ContainsPiiEntitiesResponse, error) { + return nil, fmt.Errorf("ContainsPiiEntities: %w", ErrNotImplemented) +} + +func (b *BaseProvider) CreateDataset(ctx context.Context, input *CreateDatasetRequest) (*CreateDatasetResponse, error) { + return nil, fmt.Errorf("CreateDataset: %w", ErrNotImplemented) +} + +func (b *BaseProvider) CreateDocumentClassifier(ctx context.Context, input *CreateDocumentClassifierRequest) (*CreateDocumentClassifierResponse, error) { + return nil, fmt.Errorf("CreateDocumentClassifier: %w", ErrNotImplemented) +} + +func (b *BaseProvider) CreateEndpoint(ctx context.Context, input *CreateEndpointRequest) (*CreateEndpointResponse, error) { + return nil, fmt.Errorf("CreateEndpoint: %w", ErrNotImplemented) +} + +func (b *BaseProvider) CreateEntityRecognizer(ctx context.Context, input *CreateEntityRecognizerRequest) (*CreateEntityRecognizerResponse, error) { + return nil, fmt.Errorf("CreateEntityRecognizer: %w", ErrNotImplemented) +} + +func (b *BaseProvider) CreateFlywheel(ctx context.Context, input *CreateFlywheelRequest) (*CreateFlywheelResponse, error) { + return nil, fmt.Errorf("CreateFlywheel: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DeleteDocumentClassifier(ctx context.Context, input *DeleteDocumentClassifierRequest) (*DeleteDocumentClassifierResponse, error) { + return nil, fmt.Errorf("DeleteDocumentClassifier: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DeleteEndpoint(ctx context.Context, input *DeleteEndpointRequest) (*DeleteEndpointResponse, error) { + return nil, fmt.Errorf("DeleteEndpoint: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DeleteEntityRecognizer(ctx context.Context, input *DeleteEntityRecognizerRequest) (*DeleteEntityRecognizerResponse, error) { + return nil, fmt.Errorf("DeleteEntityRecognizer: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DeleteFlywheel(ctx context.Context, input *DeleteFlywheelRequest) (*DeleteFlywheelResponse, error) { + return nil, fmt.Errorf("DeleteFlywheel: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DeleteResourcePolicy(ctx context.Context, input *DeleteResourcePolicyRequest) (*DeleteResourcePolicyResponse, error) { + return nil, fmt.Errorf("DeleteResourcePolicy: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DescribeDataset(ctx context.Context, input *DescribeDatasetRequest) (*DescribeDatasetResponse, error) { + return nil, fmt.Errorf("DescribeDataset: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DescribeDocumentClassificationJob(ctx context.Context, input *DescribeDocumentClassificationJobRequest) (*DescribeDocumentClassificationJobResponse, error) { + return nil, fmt.Errorf("DescribeDocumentClassificationJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DescribeDocumentClassifier(ctx context.Context, input *DescribeDocumentClassifierRequest) (*DescribeDocumentClassifierResponse, error) { + return nil, fmt.Errorf("DescribeDocumentClassifier: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DescribeDominantLanguageDetectionJob(ctx context.Context, input *DescribeDominantLanguageDetectionJobRequest) (*DescribeDominantLanguageDetectionJobResponse, error) { + return nil, fmt.Errorf("DescribeDominantLanguageDetectionJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DescribeEndpoint(ctx context.Context, input *DescribeEndpointRequest) (*DescribeEndpointResponse, error) { + return nil, fmt.Errorf("DescribeEndpoint: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DescribeEntitiesDetectionJob(ctx context.Context, input *DescribeEntitiesDetectionJobRequest) (*DescribeEntitiesDetectionJobResponse, error) { + return nil, fmt.Errorf("DescribeEntitiesDetectionJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DescribeEntityRecognizer(ctx context.Context, input *DescribeEntityRecognizerRequest) (*DescribeEntityRecognizerResponse, error) { + return nil, fmt.Errorf("DescribeEntityRecognizer: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DescribeEventsDetectionJob(ctx context.Context, input *DescribeEventsDetectionJobRequest) (*DescribeEventsDetectionJobResponse, error) { + return nil, fmt.Errorf("DescribeEventsDetectionJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DescribeFlywheel(ctx context.Context, input *DescribeFlywheelRequest) (*DescribeFlywheelResponse, error) { + return nil, fmt.Errorf("DescribeFlywheel: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DescribeFlywheelIteration(ctx context.Context, input *DescribeFlywheelIterationRequest) (*DescribeFlywheelIterationResponse, error) { + return nil, fmt.Errorf("DescribeFlywheelIteration: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DescribeKeyPhrasesDetectionJob(ctx context.Context, input *DescribeKeyPhrasesDetectionJobRequest) (*DescribeKeyPhrasesDetectionJobResponse, error) { + return nil, fmt.Errorf("DescribeKeyPhrasesDetectionJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DescribePiiEntitiesDetectionJob(ctx context.Context, input *DescribePiiEntitiesDetectionJobRequest) (*DescribePiiEntitiesDetectionJobResponse, error) { + return nil, fmt.Errorf("DescribePiiEntitiesDetectionJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DescribeResourcePolicy(ctx context.Context, input *DescribeResourcePolicyRequest) (*DescribeResourcePolicyResponse, error) { + return nil, fmt.Errorf("DescribeResourcePolicy: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DescribeSentimentDetectionJob(ctx context.Context, input *DescribeSentimentDetectionJobRequest) (*DescribeSentimentDetectionJobResponse, error) { + return nil, fmt.Errorf("DescribeSentimentDetectionJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DescribeTargetedSentimentDetectionJob(ctx context.Context, input *DescribeTargetedSentimentDetectionJobRequest) (*DescribeTargetedSentimentDetectionJobResponse, error) { + return nil, fmt.Errorf("DescribeTargetedSentimentDetectionJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DescribeTopicsDetectionJob(ctx context.Context, input *DescribeTopicsDetectionJobRequest) (*DescribeTopicsDetectionJobResponse, error) { + return nil, fmt.Errorf("DescribeTopicsDetectionJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DetectDominantLanguage(ctx context.Context, input *DetectDominantLanguageRequest) (*DetectDominantLanguageResponse, error) { + return nil, fmt.Errorf("DetectDominantLanguage: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DetectEntities(ctx context.Context, input *DetectEntitiesRequest) (*DetectEntitiesResponse, error) { + return nil, fmt.Errorf("DetectEntities: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DetectKeyPhrases(ctx context.Context, input *DetectKeyPhrasesRequest) (*DetectKeyPhrasesResponse, error) { + return nil, fmt.Errorf("DetectKeyPhrases: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DetectPiiEntities(ctx context.Context, input *DetectPiiEntitiesRequest) (*DetectPiiEntitiesResponse, error) { + return nil, fmt.Errorf("DetectPiiEntities: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DetectSentiment(ctx context.Context, input *DetectSentimentRequest) (*DetectSentimentResponse, error) { + return nil, fmt.Errorf("DetectSentiment: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DetectSyntax(ctx context.Context, input *DetectSyntaxRequest) (*DetectSyntaxResponse, error) { + return nil, fmt.Errorf("DetectSyntax: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DetectTargetedSentiment(ctx context.Context, input *DetectTargetedSentimentRequest) (*DetectTargetedSentimentResponse, error) { + return nil, fmt.Errorf("DetectTargetedSentiment: %w", ErrNotImplemented) +} + +func (b *BaseProvider) DetectToxicContent(ctx context.Context, input *DetectToxicContentRequest) (*DetectToxicContentResponse, error) { + return nil, fmt.Errorf("DetectToxicContent: %w", ErrNotImplemented) +} + +func (b *BaseProvider) ImportModel(ctx context.Context, input *ImportModelRequest) (*ImportModelResponse, error) { + return nil, fmt.Errorf("ImportModel: %w", ErrNotImplemented) +} + +func (b *BaseProvider) ListDatasets(ctx context.Context, input *ListDatasetsRequest) (*ListDatasetsResponse, error) { + return nil, fmt.Errorf("ListDatasets: %w", ErrNotImplemented) +} + +func (b *BaseProvider) ListDocumentClassificationJobs(ctx context.Context, input *ListDocumentClassificationJobsRequest) (*ListDocumentClassificationJobsResponse, error) { + return nil, fmt.Errorf("ListDocumentClassificationJobs: %w", ErrNotImplemented) +} + +func (b *BaseProvider) ListDocumentClassifierSummaries(ctx context.Context, input *ListDocumentClassifierSummariesRequest) (*ListDocumentClassifierSummariesResponse, error) { + return nil, fmt.Errorf("ListDocumentClassifierSummaries: %w", ErrNotImplemented) +} + +func (b *BaseProvider) ListDocumentClassifiers(ctx context.Context, input *ListDocumentClassifiersRequest) (*ListDocumentClassifiersResponse, error) { + return nil, fmt.Errorf("ListDocumentClassifiers: %w", ErrNotImplemented) +} + +func (b *BaseProvider) ListDominantLanguageDetectionJobs(ctx context.Context, input *ListDominantLanguageDetectionJobsRequest) (*ListDominantLanguageDetectionJobsResponse, error) { + return nil, fmt.Errorf("ListDominantLanguageDetectionJobs: %w", ErrNotImplemented) +} + +func (b *BaseProvider) ListEndpoints(ctx context.Context, input *ListEndpointsRequest) (*ListEndpointsResponse, error) { + return nil, fmt.Errorf("ListEndpoints: %w", ErrNotImplemented) +} + +func (b *BaseProvider) ListEntitiesDetectionJobs(ctx context.Context, input *ListEntitiesDetectionJobsRequest) (*ListEntitiesDetectionJobsResponse, error) { + return nil, fmt.Errorf("ListEntitiesDetectionJobs: %w", ErrNotImplemented) +} + +func (b *BaseProvider) ListEntityRecognizerSummaries(ctx context.Context, input *ListEntityRecognizerSummariesRequest) (*ListEntityRecognizerSummariesResponse, error) { + return nil, fmt.Errorf("ListEntityRecognizerSummaries: %w", ErrNotImplemented) +} + +func (b *BaseProvider) ListEntityRecognizers(ctx context.Context, input *ListEntityRecognizersRequest) (*ListEntityRecognizersResponse, error) { + return nil, fmt.Errorf("ListEntityRecognizers: %w", ErrNotImplemented) +} + +func (b *BaseProvider) ListEventsDetectionJobs(ctx context.Context, input *ListEventsDetectionJobsRequest) (*ListEventsDetectionJobsResponse, error) { + return nil, fmt.Errorf("ListEventsDetectionJobs: %w", ErrNotImplemented) +} + +func (b *BaseProvider) ListFlywheelIterationHistory(ctx context.Context, input *ListFlywheelIterationHistoryRequest) (*ListFlywheelIterationHistoryResponse, error) { + return nil, fmt.Errorf("ListFlywheelIterationHistory: %w", ErrNotImplemented) +} + +func (b *BaseProvider) ListFlywheels(ctx context.Context, input *ListFlywheelsRequest) (*ListFlywheelsResponse, error) { + return nil, fmt.Errorf("ListFlywheels: %w", ErrNotImplemented) +} + +func (b *BaseProvider) ListKeyPhrasesDetectionJobs(ctx context.Context, input *ListKeyPhrasesDetectionJobsRequest) (*ListKeyPhrasesDetectionJobsResponse, error) { + return nil, fmt.Errorf("ListKeyPhrasesDetectionJobs: %w", ErrNotImplemented) +} + +func (b *BaseProvider) ListPiiEntitiesDetectionJobs(ctx context.Context, input *ListPiiEntitiesDetectionJobsRequest) (*ListPiiEntitiesDetectionJobsResponse, error) { + return nil, fmt.Errorf("ListPiiEntitiesDetectionJobs: %w", ErrNotImplemented) +} + +func (b *BaseProvider) ListSentimentDetectionJobs(ctx context.Context, input *ListSentimentDetectionJobsRequest) (*ListSentimentDetectionJobsResponse, error) { + return nil, fmt.Errorf("ListSentimentDetectionJobs: %w", ErrNotImplemented) +} + +func (b *BaseProvider) ListTagsForResource(ctx context.Context, input *ListTagsForResourceRequest) (*ListTagsForResourceResponse, error) { + return nil, fmt.Errorf("ListTagsForResource: %w", ErrNotImplemented) +} + +func (b *BaseProvider) ListTargetedSentimentDetectionJobs(ctx context.Context, input *ListTargetedSentimentDetectionJobsRequest) (*ListTargetedSentimentDetectionJobsResponse, error) { + return nil, fmt.Errorf("ListTargetedSentimentDetectionJobs: %w", ErrNotImplemented) +} + +func (b *BaseProvider) ListTopicsDetectionJobs(ctx context.Context, input *ListTopicsDetectionJobsRequest) (*ListTopicsDetectionJobsResponse, error) { + return nil, fmt.Errorf("ListTopicsDetectionJobs: %w", ErrNotImplemented) +} + +func (b *BaseProvider) PutResourcePolicy(ctx context.Context, input *PutResourcePolicyRequest) (*PutResourcePolicyResponse, error) { + return nil, fmt.Errorf("PutResourcePolicy: %w", ErrNotImplemented) +} + +func (b *BaseProvider) StartDocumentClassificationJob(ctx context.Context, input *StartDocumentClassificationJobRequest) (*StartDocumentClassificationJobResponse, error) { + return nil, fmt.Errorf("StartDocumentClassificationJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) StartDominantLanguageDetectionJob(ctx context.Context, input *StartDominantLanguageDetectionJobRequest) (*StartDominantLanguageDetectionJobResponse, error) { + return nil, fmt.Errorf("StartDominantLanguageDetectionJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) StartEntitiesDetectionJob(ctx context.Context, input *StartEntitiesDetectionJobRequest) (*StartEntitiesDetectionJobResponse, error) { + return nil, fmt.Errorf("StartEntitiesDetectionJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) StartEventsDetectionJob(ctx context.Context, input *StartEventsDetectionJobRequest) (*StartEventsDetectionJobResponse, error) { + return nil, fmt.Errorf("StartEventsDetectionJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) StartFlywheelIteration(ctx context.Context, input *StartFlywheelIterationRequest) (*StartFlywheelIterationResponse, error) { + return nil, fmt.Errorf("StartFlywheelIteration: %w", ErrNotImplemented) +} + +func (b *BaseProvider) StartKeyPhrasesDetectionJob(ctx context.Context, input *StartKeyPhrasesDetectionJobRequest) (*StartKeyPhrasesDetectionJobResponse, error) { + return nil, fmt.Errorf("StartKeyPhrasesDetectionJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) StartPiiEntitiesDetectionJob(ctx context.Context, input *StartPiiEntitiesDetectionJobRequest) (*StartPiiEntitiesDetectionJobResponse, error) { + return nil, fmt.Errorf("StartPiiEntitiesDetectionJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) StartSentimentDetectionJob(ctx context.Context, input *StartSentimentDetectionJobRequest) (*StartSentimentDetectionJobResponse, error) { + return nil, fmt.Errorf("StartSentimentDetectionJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) StartTargetedSentimentDetectionJob(ctx context.Context, input *StartTargetedSentimentDetectionJobRequest) (*StartTargetedSentimentDetectionJobResponse, error) { + return nil, fmt.Errorf("StartTargetedSentimentDetectionJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) StartTopicsDetectionJob(ctx context.Context, input *StartTopicsDetectionJobRequest) (*StartTopicsDetectionJobResponse, error) { + return nil, fmt.Errorf("StartTopicsDetectionJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) StopDominantLanguageDetectionJob(ctx context.Context, input *StopDominantLanguageDetectionJobRequest) (*StopDominantLanguageDetectionJobResponse, error) { + return nil, fmt.Errorf("StopDominantLanguageDetectionJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) StopEntitiesDetectionJob(ctx context.Context, input *StopEntitiesDetectionJobRequest) (*StopEntitiesDetectionJobResponse, error) { + return nil, fmt.Errorf("StopEntitiesDetectionJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) StopEventsDetectionJob(ctx context.Context, input *StopEventsDetectionJobRequest) (*StopEventsDetectionJobResponse, error) { + return nil, fmt.Errorf("StopEventsDetectionJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) StopKeyPhrasesDetectionJob(ctx context.Context, input *StopKeyPhrasesDetectionJobRequest) (*StopKeyPhrasesDetectionJobResponse, error) { + return nil, fmt.Errorf("StopKeyPhrasesDetectionJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) StopPiiEntitiesDetectionJob(ctx context.Context, input *StopPiiEntitiesDetectionJobRequest) (*StopPiiEntitiesDetectionJobResponse, error) { + return nil, fmt.Errorf("StopPiiEntitiesDetectionJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) StopSentimentDetectionJob(ctx context.Context, input *StopSentimentDetectionJobRequest) (*StopSentimentDetectionJobResponse, error) { + return nil, fmt.Errorf("StopSentimentDetectionJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) StopTargetedSentimentDetectionJob(ctx context.Context, input *StopTargetedSentimentDetectionJobRequest) (*StopTargetedSentimentDetectionJobResponse, error) { + return nil, fmt.Errorf("StopTargetedSentimentDetectionJob: %w", ErrNotImplemented) +} + +func (b *BaseProvider) StopTrainingDocumentClassifier(ctx context.Context, input *StopTrainingDocumentClassifierRequest) (*StopTrainingDocumentClassifierResponse, error) { + return nil, fmt.Errorf("StopTrainingDocumentClassifier: %w", ErrNotImplemented) +} + +func (b *BaseProvider) StopTrainingEntityRecognizer(ctx context.Context, input *StopTrainingEntityRecognizerRequest) (*StopTrainingEntityRecognizerResponse, error) { + return nil, fmt.Errorf("StopTrainingEntityRecognizer: %w", ErrNotImplemented) +} + +func (b *BaseProvider) TagResource(ctx context.Context, input *TagResourceRequest) (*TagResourceResponse, error) { + return nil, fmt.Errorf("TagResource: %w", ErrNotImplemented) +} + +func (b *BaseProvider) UntagResource(ctx context.Context, input *UntagResourceRequest) (*UntagResourceResponse, error) { + return nil, fmt.Errorf("UntagResource: %w", ErrNotImplemented) +} + +func (b *BaseProvider) UpdateEndpoint(ctx context.Context, input *UpdateEndpointRequest) (*UpdateEndpointResponse, error) { + return nil, fmt.Errorf("UpdateEndpoint: %w", ErrNotImplemented) +} + +func (b *BaseProvider) UpdateFlywheel(ctx context.Context, input *UpdateFlywheelRequest) (*UpdateFlywheelResponse, error) { + return nil, fmt.Errorf("UpdateFlywheel: %w", ErrNotImplemented) +} diff --git a/internal/generated/comprehend/errors.go b/internal/generated/comprehend/errors.go new file mode 100644 index 00000000..184d6656 --- /dev/null +++ b/internal/generated/comprehend/errors.go @@ -0,0 +1,277 @@ +// Code generated by devcloud codegen. DO NOT EDIT. +// SPDX-License-Identifier: Apache-2.0 +package comprehend + +import "fmt" + +// BatchSizeLimitExceededException is returned with HTTP status 400. +type BatchSizeLimitExceededException struct { + Message string +} + +func (e *BatchSizeLimitExceededException) Error() string { + return fmt.Sprintf("BatchSizeLimitExceededException: %s", e.Message) +} + +func (e *BatchSizeLimitExceededException) ErrorCode() string { + return "BatchSizeLimitExceededException" +} + +func (e *BatchSizeLimitExceededException) HTTPStatus() int { + return 400 +} + +// ConcurrentModificationException is returned with HTTP status 400. +type ConcurrentModificationException struct { + Message string +} + +func (e *ConcurrentModificationException) Error() string { + return fmt.Sprintf("ConcurrentModificationException: %s", e.Message) +} + +func (e *ConcurrentModificationException) ErrorCode() string { + return "ConcurrentModificationException" +} + +func (e *ConcurrentModificationException) HTTPStatus() int { + return 400 +} + +// InternalServerException is returned with HTTP status 500. +type InternalServerException struct { + Message string +} + +func (e *InternalServerException) Error() string { + return fmt.Sprintf("InternalServerException: %s", e.Message) +} + +func (e *InternalServerException) ErrorCode() string { + return "InternalServerException" +} + +func (e *InternalServerException) HTTPStatus() int { + return 500 +} + +// InvalidFilterException is returned with HTTP status 400. +type InvalidFilterException struct { + Message string +} + +func (e *InvalidFilterException) Error() string { + return fmt.Sprintf("InvalidFilterException: %s", e.Message) +} + +func (e *InvalidFilterException) ErrorCode() string { + return "InvalidFilterException" +} + +func (e *InvalidFilterException) HTTPStatus() int { + return 400 +} + +// InvalidRequestException is returned with HTTP status 400. +type InvalidRequestException struct { + Message string +} + +func (e *InvalidRequestException) Error() string { + return fmt.Sprintf("InvalidRequestException: %s", e.Message) +} + +func (e *InvalidRequestException) ErrorCode() string { + return "InvalidRequestException" +} + +func (e *InvalidRequestException) HTTPStatus() int { + return 400 +} + +// JobNotFoundException is returned with HTTP status 404. +type JobNotFoundException struct { + Message string +} + +func (e *JobNotFoundException) Error() string { + return fmt.Sprintf("JobNotFoundException: %s", e.Message) +} + +func (e *JobNotFoundException) ErrorCode() string { + return "JobNotFoundException" +} + +func (e *JobNotFoundException) HTTPStatus() int { + return 404 +} + +// KmsKeyValidationException is returned with HTTP status 400. +type KmsKeyValidationException struct { + Message string +} + +func (e *KmsKeyValidationException) Error() string { + return fmt.Sprintf("KmsKeyValidationException: %s", e.Message) +} + +func (e *KmsKeyValidationException) ErrorCode() string { + return "KmsKeyValidationException" +} + +func (e *KmsKeyValidationException) HTTPStatus() int { + return 400 +} + +// ResourceInUseException is returned with HTTP status 400. +type ResourceInUseException struct { + Message string +} + +func (e *ResourceInUseException) Error() string { + return fmt.Sprintf("ResourceInUseException: %s", e.Message) +} + +func (e *ResourceInUseException) ErrorCode() string { + return "ResourceInUseException" +} + +func (e *ResourceInUseException) HTTPStatus() int { + return 400 +} + +// ResourceLimitExceededException is returned with HTTP status 400. +type ResourceLimitExceededException struct { + Message string +} + +func (e *ResourceLimitExceededException) Error() string { + return fmt.Sprintf("ResourceLimitExceededException: %s", e.Message) +} + +func (e *ResourceLimitExceededException) ErrorCode() string { + return "ResourceLimitExceededException" +} + +func (e *ResourceLimitExceededException) HTTPStatus() int { + return 400 +} + +// ResourceNotFoundException is returned with HTTP status 404. +type ResourceNotFoundException struct { + Message string +} + +func (e *ResourceNotFoundException) Error() string { + return fmt.Sprintf("ResourceNotFoundException: %s", e.Message) +} + +func (e *ResourceNotFoundException) ErrorCode() string { + return "ResourceNotFoundException" +} + +func (e *ResourceNotFoundException) HTTPStatus() int { + return 404 +} + +// ResourceUnavailableException is returned with HTTP status 404. +type ResourceUnavailableException struct { + Message string +} + +func (e *ResourceUnavailableException) Error() string { + return fmt.Sprintf("ResourceUnavailableException: %s", e.Message) +} + +func (e *ResourceUnavailableException) ErrorCode() string { + return "ResourceUnavailableException" +} + +func (e *ResourceUnavailableException) HTTPStatus() int { + return 404 +} + +// TextSizeLimitExceededException is returned with HTTP status 400. +type TextSizeLimitExceededException struct { + Message string +} + +func (e *TextSizeLimitExceededException) Error() string { + return fmt.Sprintf("TextSizeLimitExceededException: %s", e.Message) +} + +func (e *TextSizeLimitExceededException) ErrorCode() string { + return "TextSizeLimitExceededException" +} + +func (e *TextSizeLimitExceededException) HTTPStatus() int { + return 400 +} + +// TooManyRequestsException is returned with HTTP status 429. +type TooManyRequestsException struct { + Message string +} + +func (e *TooManyRequestsException) Error() string { + return fmt.Sprintf("TooManyRequestsException: %s", e.Message) +} + +func (e *TooManyRequestsException) ErrorCode() string { + return "TooManyRequestsException" +} + +func (e *TooManyRequestsException) HTTPStatus() int { + return 429 +} + +// TooManyTagKeysException is returned with HTTP status 400. +type TooManyTagKeysException struct { + Message string +} + +func (e *TooManyTagKeysException) Error() string { + return fmt.Sprintf("TooManyTagKeysException: %s", e.Message) +} + +func (e *TooManyTagKeysException) ErrorCode() string { + return "TooManyTagKeysException" +} + +func (e *TooManyTagKeysException) HTTPStatus() int { + return 400 +} + +// TooManyTagsException is returned with HTTP status 400. +type TooManyTagsException struct { + Message string +} + +func (e *TooManyTagsException) Error() string { + return fmt.Sprintf("TooManyTagsException: %s", e.Message) +} + +func (e *TooManyTagsException) ErrorCode() string { + return "TooManyTagsException" +} + +func (e *TooManyTagsException) HTTPStatus() int { + return 400 +} + +// UnsupportedLanguageException is returned with HTTP status 400. +type UnsupportedLanguageException struct { + Message string +} + +func (e *UnsupportedLanguageException) Error() string { + return fmt.Sprintf("UnsupportedLanguageException: %s", e.Message) +} + +func (e *UnsupportedLanguageException) ErrorCode() string { + return "UnsupportedLanguageException" +} + +func (e *UnsupportedLanguageException) HTTPStatus() int { + return 400 +} diff --git a/internal/generated/comprehend/router.go b/internal/generated/comprehend/router.go new file mode 100644 index 00000000..0a804368 --- /dev/null +++ b/internal/generated/comprehend/router.go @@ -0,0 +1,238 @@ +// Code generated by devcloud codegen. DO NOT EDIT. +// SPDX-License-Identifier: Apache-2.0 +package comprehend + +import ( + "net/url" + "strings" +) + +// PathParams holds the URL path parameters extracted by the router. +type PathParams map[string]string + +// OperationRoute maps an HTTP method and URI pattern to an operation name. +type OperationRoute struct { + Method string + Pattern string + Operation string +} + +// OperationRoutes is the list of all routes for this service. +var OperationRoutes = []OperationRoute{ + {Method: "", Pattern: "", Operation: "BatchDetectDominantLanguage"}, + {Method: "", Pattern: "", Operation: "BatchDetectEntities"}, + {Method: "", Pattern: "", Operation: "BatchDetectKeyPhrases"}, + {Method: "", Pattern: "", Operation: "BatchDetectSentiment"}, + {Method: "", Pattern: "", Operation: "BatchDetectSyntax"}, + {Method: "", Pattern: "", Operation: "BatchDetectTargetedSentiment"}, + {Method: "", Pattern: "", Operation: "ClassifyDocument"}, + {Method: "", Pattern: "", Operation: "ContainsPiiEntities"}, + {Method: "", Pattern: "", Operation: "CreateDataset"}, + {Method: "", Pattern: "", Operation: "CreateDocumentClassifier"}, + {Method: "", Pattern: "", Operation: "CreateEndpoint"}, + {Method: "", Pattern: "", Operation: "CreateEntityRecognizer"}, + {Method: "", Pattern: "", Operation: "CreateFlywheel"}, + {Method: "", Pattern: "", Operation: "DeleteDocumentClassifier"}, + {Method: "", Pattern: "", Operation: "DeleteEndpoint"}, + {Method: "", Pattern: "", Operation: "DeleteEntityRecognizer"}, + {Method: "", Pattern: "", Operation: "DeleteFlywheel"}, + {Method: "", Pattern: "", Operation: "DeleteResourcePolicy"}, + {Method: "", Pattern: "", Operation: "DescribeDataset"}, + {Method: "", Pattern: "", Operation: "DescribeDocumentClassificationJob"}, + {Method: "", Pattern: "", Operation: "DescribeDocumentClassifier"}, + {Method: "", Pattern: "", Operation: "DescribeDominantLanguageDetectionJob"}, + {Method: "", Pattern: "", Operation: "DescribeEndpoint"}, + {Method: "", Pattern: "", Operation: "DescribeEntitiesDetectionJob"}, + {Method: "", Pattern: "", Operation: "DescribeEntityRecognizer"}, + {Method: "", Pattern: "", Operation: "DescribeEventsDetectionJob"}, + {Method: "", Pattern: "", Operation: "DescribeFlywheel"}, + {Method: "", Pattern: "", Operation: "DescribeFlywheelIteration"}, + {Method: "", Pattern: "", Operation: "DescribeKeyPhrasesDetectionJob"}, + {Method: "", Pattern: "", Operation: "DescribePiiEntitiesDetectionJob"}, + {Method: "", Pattern: "", Operation: "DescribeResourcePolicy"}, + {Method: "", Pattern: "", Operation: "DescribeSentimentDetectionJob"}, + {Method: "", Pattern: "", Operation: "DescribeTargetedSentimentDetectionJob"}, + {Method: "", Pattern: "", Operation: "DescribeTopicsDetectionJob"}, + {Method: "", Pattern: "", Operation: "DetectDominantLanguage"}, + {Method: "", Pattern: "", Operation: "DetectEntities"}, + {Method: "", Pattern: "", Operation: "DetectKeyPhrases"}, + {Method: "", Pattern: "", Operation: "DetectPiiEntities"}, + {Method: "", Pattern: "", Operation: "DetectSentiment"}, + {Method: "", Pattern: "", Operation: "DetectSyntax"}, + {Method: "", Pattern: "", Operation: "DetectTargetedSentiment"}, + {Method: "", Pattern: "", Operation: "DetectToxicContent"}, + {Method: "", Pattern: "", Operation: "ImportModel"}, + {Method: "", Pattern: "", Operation: "ListDatasets"}, + {Method: "", Pattern: "", Operation: "ListDocumentClassificationJobs"}, + {Method: "", Pattern: "", Operation: "ListDocumentClassifierSummaries"}, + {Method: "", Pattern: "", Operation: "ListDocumentClassifiers"}, + {Method: "", Pattern: "", Operation: "ListDominantLanguageDetectionJobs"}, + {Method: "", Pattern: "", Operation: "ListEndpoints"}, + {Method: "", Pattern: "", Operation: "ListEntitiesDetectionJobs"}, + {Method: "", Pattern: "", Operation: "ListEntityRecognizerSummaries"}, + {Method: "", Pattern: "", Operation: "ListEntityRecognizers"}, + {Method: "", Pattern: "", Operation: "ListEventsDetectionJobs"}, + {Method: "", Pattern: "", Operation: "ListFlywheelIterationHistory"}, + {Method: "", Pattern: "", Operation: "ListFlywheels"}, + {Method: "", Pattern: "", Operation: "ListKeyPhrasesDetectionJobs"}, + {Method: "", Pattern: "", Operation: "ListPiiEntitiesDetectionJobs"}, + {Method: "", Pattern: "", Operation: "ListSentimentDetectionJobs"}, + {Method: "", Pattern: "", Operation: "ListTagsForResource"}, + {Method: "", Pattern: "", Operation: "ListTargetedSentimentDetectionJobs"}, + {Method: "", Pattern: "", Operation: "ListTopicsDetectionJobs"}, + {Method: "", Pattern: "", Operation: "PutResourcePolicy"}, + {Method: "", Pattern: "", Operation: "StartDocumentClassificationJob"}, + {Method: "", Pattern: "", Operation: "StartDominantLanguageDetectionJob"}, + {Method: "", Pattern: "", Operation: "StartEntitiesDetectionJob"}, + {Method: "", Pattern: "", Operation: "StartEventsDetectionJob"}, + {Method: "", Pattern: "", Operation: "StartFlywheelIteration"}, + {Method: "", Pattern: "", Operation: "StartKeyPhrasesDetectionJob"}, + {Method: "", Pattern: "", Operation: "StartPiiEntitiesDetectionJob"}, + {Method: "", Pattern: "", Operation: "StartSentimentDetectionJob"}, + {Method: "", Pattern: "", Operation: "StartTargetedSentimentDetectionJob"}, + {Method: "", Pattern: "", Operation: "StartTopicsDetectionJob"}, + {Method: "", Pattern: "", Operation: "StopDominantLanguageDetectionJob"}, + {Method: "", Pattern: "", Operation: "StopEntitiesDetectionJob"}, + {Method: "", Pattern: "", Operation: "StopEventsDetectionJob"}, + {Method: "", Pattern: "", Operation: "StopKeyPhrasesDetectionJob"}, + {Method: "", Pattern: "", Operation: "StopPiiEntitiesDetectionJob"}, + {Method: "", Pattern: "", Operation: "StopSentimentDetectionJob"}, + {Method: "", Pattern: "", Operation: "StopTargetedSentimentDetectionJob"}, + {Method: "", Pattern: "", Operation: "StopTrainingDocumentClassifier"}, + {Method: "", Pattern: "", Operation: "StopTrainingEntityRecognizer"}, + {Method: "", Pattern: "", Operation: "TagResource"}, + {Method: "", Pattern: "", Operation: "UntagResource"}, + {Method: "", Pattern: "", Operation: "UpdateEndpoint"}, + {Method: "", Pattern: "", Operation: "UpdateFlywheel"}, +} + +// MatchOperation returns the operation name and extracted path parameters for +// the given HTTP method and request URI. It returns ("", nil) if no route +// matches. +// +// Pass req.URL.RequestURI(), not req.URL.Path: some AWS operations are +// distinguished only by a query string (".../tagging?Operation=Tag"), and a +// bare path can never satisfy those routes. +func MatchOperation(method, uri string) (string, PathParams) { + // Two passes. A route that constrains the query is more specific than one + // that does not, and OperationRoutes is ordered by operation name rather + // than specificity — so trying constrained routes first keeps + // ".../distribution" from shadowing ".../distribution?WithTags". + for _, constrained := range []bool{true, false} { + for _, route := range OperationRoutes { + if route.Method != method || strings.Contains(route.Pattern, "?") != constrained { + continue + } + if params, ok := matchURI(route.Pattern, uri); ok { + return route.Operation, params + } + } + } + return "", nil +} + +// matchURI matches a request URI against a pattern that may contain {Label} and +// {Label+} (greedy) segments, and may constrain the query string after a "?". +// Returns the extracted parameters and true on match, or nil and false +// otherwise. +func matchURI(pattern, uri string) (PathParams, bool) { + patPath, patQuery, _ := strings.Cut(pattern, "?") + uriPath, uriQuery, _ := strings.Cut(uri, "?") + if !matchQuery(patQuery, uriQuery) { + return nil, false + } + + patParts := splitPath(patPath) + pathParts := splitPath(uriPath) + + params := PathParams{} + pi := 0 + for i, pat := range patParts { + if strings.HasPrefix(pat, "{") && strings.HasSuffix(pat, "+}") { + // Greedy label: consumes all remaining path segments. + label := pat[1 : len(pat)-2] + if pi >= len(pathParts) { + return nil, false + } + params[label] = joinPath(pathParts[pi:]) + pi = len(pathParts) + // Greedy must be the last pattern segment. + if i != len(patParts)-1 { + return nil, false + } + } else if strings.HasPrefix(pat, "{") && strings.HasSuffix(pat, "}") { + // Single-segment label. + label := pat[1 : len(pat)-1] + if pi >= len(pathParts) { + return nil, false + } + params[label] = pathParts[pi] + pi++ + } else { + // Literal segment. + if pi >= len(pathParts) || pathParts[pi] != pat { + return nil, false + } + pi++ + } + } + if pi != len(pathParts) { + return nil, false + } + return params, true +} + +// matchQuery reports whether a request's query string satisfies the constraint +// a route pattern carries after its "?". Each "&"-separated term is either a +// bare key that must be present ("?WithTags") or a key=value that must be +// present with that value ("?Operation=Tag"). An empty constraint matches +// anything, which is every route that has no "?". +func matchQuery(constraint, query string) bool { + if constraint == "" { + return true + } + // ParseQuery returns what it could parse alongside any error, so a + // malformed tail cannot hide a valid term earlier in the string. + values, _ := url.ParseQuery(query) + for _, term := range strings.Split(constraint, "&") { + if term == "" { + continue + } + key, want, hasValue := strings.Cut(term, "=") + got, present := values[key] + if !present { + return false + } + if !hasValue { + continue + } + matched := false + for _, v := range got { + if v == want { + matched = true + break + } + } + if !matched { + return false + } + } + return true +} + +// splitPath splits a URI path into non-empty segments. +func splitPath(path string) []string { + parts := strings.Split(strings.Trim(path, "/"), "/") + out := parts[:0] + for _, p := range parts { + if p != "" { + out = append(out, p) + } + } + return out +} + +// joinPath joins path segments back with "/" separators. +func joinPath(parts []string) string { + return strings.Join(parts, "/") +} diff --git a/internal/generated/comprehend/types.go b/internal/generated/comprehend/types.go new file mode 100644 index 00000000..8b82ad11 --- /dev/null +++ b/internal/generated/comprehend/types.go @@ -0,0 +1,1862 @@ +// Code generated by devcloud codegen. DO NOT EDIT. +// SPDX-License-Identifier: Apache-2.0 +package comprehend + +import ( + "time" +) + +type AugmentedManifestsListItem struct { + AnnotationDataS3Uri string `json:"annotationDataS3Uri" xml:"AnnotationDataS3Uri"` + AttributeNames AttributeNamesList `json:"attributeNames" xml:"AttributeNames"` + DocumentType string `json:"documentType" xml:"DocumentType"` + S3Uri string `json:"s3Uri" xml:"S3Uri"` + SourceDocumentsS3Uri string `json:"sourceDocumentsS3Uri" xml:"SourceDocumentsS3Uri"` + Split string `json:"split" xml:"Split"` +} + +type BatchDetectDominantLanguageItemResult struct { + Index int32 `json:"index" xml:"Index"` + Languages ListOfDominantLanguages `json:"languages" xml:"Languages"` +} + +type BatchDetectDominantLanguageRequest struct { + TextList CustomerInputStringList `json:"textList" xml:"TextList"` +} + +type BatchDetectDominantLanguageResponse struct { + ErrorList BatchItemErrorList `json:"errorList" xml:"ErrorList"` + ResultList ListOfDetectDominantLanguageResult `json:"resultList" xml:"ResultList"` +} + +type BatchDetectEntitiesItemResult struct { + Entities ListOfEntities `json:"entities" xml:"Entities"` + Index int32 `json:"index" xml:"Index"` +} + +type BatchDetectEntitiesRequest struct { + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + TextList CustomerInputStringList `json:"textList" xml:"TextList"` +} + +type BatchDetectEntitiesResponse struct { + ErrorList BatchItemErrorList `json:"errorList" xml:"ErrorList"` + ResultList ListOfDetectEntitiesResult `json:"resultList" xml:"ResultList"` +} + +type BatchDetectKeyPhrasesItemResult struct { + Index int32 `json:"index" xml:"Index"` + KeyPhrases ListOfKeyPhrases `json:"keyPhrases" xml:"KeyPhrases"` +} + +type BatchDetectKeyPhrasesRequest struct { + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + TextList CustomerInputStringList `json:"textList" xml:"TextList"` +} + +type BatchDetectKeyPhrasesResponse struct { + ErrorList BatchItemErrorList `json:"errorList" xml:"ErrorList"` + ResultList ListOfDetectKeyPhrasesResult `json:"resultList" xml:"ResultList"` +} + +type BatchDetectSentimentItemResult struct { + Index int32 `json:"index" xml:"Index"` + Sentiment string `json:"sentiment" xml:"Sentiment"` + SentimentScore *SentimentScore `json:"sentimentScore" xml:"SentimentScore"` +} + +type BatchDetectSentimentRequest struct { + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + TextList CustomerInputStringList `json:"textList" xml:"TextList"` +} + +type BatchDetectSentimentResponse struct { + ErrorList BatchItemErrorList `json:"errorList" xml:"ErrorList"` + ResultList ListOfDetectSentimentResult `json:"resultList" xml:"ResultList"` +} + +type BatchDetectSyntaxItemResult struct { + Index int32 `json:"index" xml:"Index"` + SyntaxTokens ListOfSyntaxTokens `json:"syntaxTokens" xml:"SyntaxTokens"` +} + +type BatchDetectSyntaxRequest struct { + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + TextList CustomerInputStringList `json:"textList" xml:"TextList"` +} + +type BatchDetectSyntaxResponse struct { + ErrorList BatchItemErrorList `json:"errorList" xml:"ErrorList"` + ResultList ListOfDetectSyntaxResult `json:"resultList" xml:"ResultList"` +} + +type BatchDetectTargetedSentimentItemResult struct { + Entities ListOfTargetedSentimentEntities `json:"entities" xml:"Entities"` + Index int32 `json:"index" xml:"Index"` +} + +type BatchDetectTargetedSentimentRequest struct { + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + TextList CustomerInputStringList `json:"textList" xml:"TextList"` +} + +type BatchDetectTargetedSentimentResponse struct { + ErrorList BatchItemErrorList `json:"errorList" xml:"ErrorList"` + ResultList ListOfDetectTargetedSentimentResult `json:"resultList" xml:"ResultList"` +} + +type BatchItemError struct { + ErrorCode string `json:"errorCode" xml:"ErrorCode"` + ErrorMessage string `json:"errorMessage" xml:"ErrorMessage"` + Index int32 `json:"index" xml:"Index"` +} + +type Block struct { + BlockType string `json:"blockType" xml:"BlockType"` + Geometry *Geometry `json:"geometry" xml:"Geometry"` + Id string `json:"id" xml:"Id"` + Page int32 `json:"page" xml:"Page"` + Relationships ListOfRelationships `json:"relationships" xml:"Relationships"` + Text string `json:"text" xml:"Text"` +} + +type BlockReference struct { + BeginOffset int32 `json:"beginOffset" xml:"BeginOffset"` + BlockId string `json:"blockId" xml:"BlockId"` + ChildBlocks ListOfChildBlocks `json:"childBlocks" xml:"ChildBlocks"` + EndOffset int32 `json:"endOffset" xml:"EndOffset"` +} + +type BoundingBox struct { + Height float32 `json:"height" xml:"Height"` + Left float32 `json:"left" xml:"Left"` + Top float32 `json:"top" xml:"Top"` + Width float32 `json:"width" xml:"Width"` +} + +type ChildBlock struct { + BeginOffset int32 `json:"beginOffset" xml:"BeginOffset"` + ChildBlockId string `json:"childBlockId" xml:"ChildBlockId"` + EndOffset int32 `json:"endOffset" xml:"EndOffset"` +} + +type ClassifierEvaluationMetrics struct { + Accuracy float64 `json:"accuracy" xml:"Accuracy"` + F1Score float64 `json:"f1Score" xml:"F1Score"` + HammingLoss float64 `json:"hammingLoss" xml:"HammingLoss"` + MicroF1Score float64 `json:"microF1Score" xml:"MicroF1Score"` + MicroPrecision float64 `json:"microPrecision" xml:"MicroPrecision"` + MicroRecall float64 `json:"microRecall" xml:"MicroRecall"` + Precision float64 `json:"precision" xml:"Precision"` + Recall float64 `json:"recall" xml:"Recall"` +} + +type ClassifierMetadata struct { + EvaluationMetrics *ClassifierEvaluationMetrics `json:"evaluationMetrics" xml:"EvaluationMetrics"` + NumberOfLabels int32 `json:"numberOfLabels" xml:"NumberOfLabels"` + NumberOfTestDocuments int32 `json:"numberOfTestDocuments" xml:"NumberOfTestDocuments"` + NumberOfTrainedDocuments int32 `json:"numberOfTrainedDocuments" xml:"NumberOfTrainedDocuments"` +} + +type ClassifyDocumentRequest struct { + Bytes []byte `json:"bytes" xml:"Bytes"` + DocumentReaderConfig *DocumentReaderConfig `json:"documentReaderConfig" xml:"DocumentReaderConfig"` + EndpointArn string `json:"endpointArn" xml:"EndpointArn"` + Text string `json:"text" xml:"Text"` +} + +type ClassifyDocumentResponse struct { + Classes ListOfClasses `json:"classes" xml:"Classes"` + DocumentMetadata *DocumentMetadata `json:"documentMetadata" xml:"DocumentMetadata"` + DocumentType ListOfDocumentType `json:"documentType" xml:"DocumentType"` + Errors ListOfErrors `json:"errors" xml:"Errors"` + Labels ListOfLabels `json:"labels" xml:"Labels"` + Warnings ListOfWarnings `json:"warnings" xml:"Warnings"` +} + +type ContainsPiiEntitiesRequest struct { + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + Text string `json:"text" xml:"Text"` +} + +type ContainsPiiEntitiesResponse struct { + Labels ListOfEntityLabels `json:"labels" xml:"Labels"` +} + +type CreateDatasetRequest struct { + ClientRequestToken string `json:"clientRequestToken" xml:"ClientRequestToken"` + DatasetName string `json:"datasetName" xml:"DatasetName"` + DatasetType string `json:"datasetType" xml:"DatasetType"` + Description string `json:"description" xml:"Description"` + FlywheelArn string `json:"flywheelArn" xml:"FlywheelArn"` + InputDataConfig *DatasetInputDataConfig `json:"inputDataConfig" xml:"InputDataConfig"` + Tags TagList `json:"tags" xml:"Tags"` +} + +type CreateDatasetResponse struct { + DatasetArn string `json:"datasetArn" xml:"DatasetArn"` +} + +type CreateDocumentClassifierRequest struct { + ClientRequestToken string `json:"clientRequestToken" xml:"ClientRequestToken"` + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + DocumentClassifierName string `json:"documentClassifierName" xml:"DocumentClassifierName"` + InputDataConfig *DocumentClassifierInputDataConfig `json:"inputDataConfig" xml:"InputDataConfig"` + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + Mode string `json:"mode" xml:"Mode"` + ModelKmsKeyId string `json:"modelKmsKeyId" xml:"ModelKmsKeyId"` + ModelPolicy string `json:"modelPolicy" xml:"ModelPolicy"` + OutputDataConfig *DocumentClassifierOutputDataConfig `json:"outputDataConfig" xml:"OutputDataConfig"` + Tags TagList `json:"tags" xml:"Tags"` + VersionName string `json:"versionName" xml:"VersionName"` + VolumeKmsKeyId string `json:"volumeKmsKeyId" xml:"VolumeKmsKeyId"` + VpcConfig *VpcConfig `json:"vpcConfig" xml:"VpcConfig"` +} + +type CreateDocumentClassifierResponse struct { + DocumentClassifierArn string `json:"documentClassifierArn" xml:"DocumentClassifierArn"` +} + +type CreateEndpointRequest struct { + ClientRequestToken string `json:"clientRequestToken" xml:"ClientRequestToken"` + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + DesiredInferenceUnits int32 `json:"desiredInferenceUnits" xml:"DesiredInferenceUnits"` + EndpointName string `json:"endpointName" xml:"EndpointName"` + FlywheelArn string `json:"flywheelArn" xml:"FlywheelArn"` + ModelArn string `json:"modelArn" xml:"ModelArn"` + Tags TagList `json:"tags" xml:"Tags"` +} + +type CreateEndpointResponse struct { + EndpointArn string `json:"endpointArn" xml:"EndpointArn"` + ModelArn string `json:"modelArn" xml:"ModelArn"` +} + +type CreateEntityRecognizerRequest struct { + ClientRequestToken string `json:"clientRequestToken" xml:"ClientRequestToken"` + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + InputDataConfig *EntityRecognizerInputDataConfig `json:"inputDataConfig" xml:"InputDataConfig"` + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + ModelKmsKeyId string `json:"modelKmsKeyId" xml:"ModelKmsKeyId"` + ModelPolicy string `json:"modelPolicy" xml:"ModelPolicy"` + RecognizerName string `json:"recognizerName" xml:"RecognizerName"` + Tags TagList `json:"tags" xml:"Tags"` + VersionName string `json:"versionName" xml:"VersionName"` + VolumeKmsKeyId string `json:"volumeKmsKeyId" xml:"VolumeKmsKeyId"` + VpcConfig *VpcConfig `json:"vpcConfig" xml:"VpcConfig"` +} + +type CreateEntityRecognizerResponse struct { + EntityRecognizerArn string `json:"entityRecognizerArn" xml:"EntityRecognizerArn"` +} + +type CreateFlywheelRequest struct { + ActiveModelArn string `json:"activeModelArn" xml:"ActiveModelArn"` + ClientRequestToken string `json:"clientRequestToken" xml:"ClientRequestToken"` + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + DataLakeS3Uri string `json:"dataLakeS3Uri" xml:"DataLakeS3Uri"` + DataSecurityConfig *DataSecurityConfig `json:"dataSecurityConfig" xml:"DataSecurityConfig"` + FlywheelName string `json:"flywheelName" xml:"FlywheelName"` + ModelType string `json:"modelType" xml:"ModelType"` + Tags TagList `json:"tags" xml:"Tags"` + TaskConfig *TaskConfig `json:"taskConfig" xml:"TaskConfig"` +} + +type CreateFlywheelResponse struct { + ActiveModelArn string `json:"activeModelArn" xml:"ActiveModelArn"` + FlywheelArn string `json:"flywheelArn" xml:"FlywheelArn"` +} + +type DataSecurityConfig struct { + DataLakeKmsKeyId string `json:"dataLakeKmsKeyId" xml:"DataLakeKmsKeyId"` + ModelKmsKeyId string `json:"modelKmsKeyId" xml:"ModelKmsKeyId"` + VolumeKmsKeyId string `json:"volumeKmsKeyId" xml:"VolumeKmsKeyId"` + VpcConfig *VpcConfig `json:"vpcConfig" xml:"VpcConfig"` +} + +type DatasetAugmentedManifestsListItem struct { + AnnotationDataS3Uri string `json:"annotationDataS3Uri" xml:"AnnotationDataS3Uri"` + AttributeNames AttributeNamesList `json:"attributeNames" xml:"AttributeNames"` + DocumentType string `json:"documentType" xml:"DocumentType"` + S3Uri string `json:"s3Uri" xml:"S3Uri"` + SourceDocumentsS3Uri string `json:"sourceDocumentsS3Uri" xml:"SourceDocumentsS3Uri"` +} + +type DatasetDocumentClassifierInputDataConfig struct { + LabelDelimiter string `json:"labelDelimiter" xml:"LabelDelimiter"` + S3Uri string `json:"s3Uri" xml:"S3Uri"` +} + +type DatasetEntityRecognizerAnnotations struct { + S3Uri string `json:"s3Uri" xml:"S3Uri"` +} + +type DatasetEntityRecognizerDocuments struct { + InputFormat string `json:"inputFormat" xml:"InputFormat"` + S3Uri string `json:"s3Uri" xml:"S3Uri"` +} + +type DatasetEntityRecognizerEntityList struct { + S3Uri string `json:"s3Uri" xml:"S3Uri"` +} + +type DatasetEntityRecognizerInputDataConfig struct { + Annotations *DatasetEntityRecognizerAnnotations `json:"annotations" xml:"Annotations"` + Documents *DatasetEntityRecognizerDocuments `json:"documents" xml:"Documents"` + EntityList *DatasetEntityRecognizerEntityList `json:"entityList" xml:"EntityList"` +} + +type DatasetFilter struct { + CreationTimeAfter time.Time `json:"creationTimeAfter" xml:"CreationTimeAfter"` + CreationTimeBefore time.Time `json:"creationTimeBefore" xml:"CreationTimeBefore"` + DatasetType string `json:"datasetType" xml:"DatasetType"` + Status string `json:"status" xml:"Status"` +} + +type DatasetInputDataConfig struct { + AugmentedManifests DatasetAugmentedManifestsList `json:"augmentedManifests" xml:"AugmentedManifests"` + DataFormat string `json:"dataFormat" xml:"DataFormat"` + DocumentClassifierInputDataConfig *DatasetDocumentClassifierInputDataConfig `json:"documentClassifierInputDataConfig" xml:"DocumentClassifierInputDataConfig"` + EntityRecognizerInputDataConfig *DatasetEntityRecognizerInputDataConfig `json:"entityRecognizerInputDataConfig" xml:"EntityRecognizerInputDataConfig"` +} + +type DatasetProperties struct { + CreationTime time.Time `json:"creationTime" xml:"CreationTime"` + DatasetArn string `json:"datasetArn" xml:"DatasetArn"` + DatasetName string `json:"datasetName" xml:"DatasetName"` + DatasetS3Uri string `json:"datasetS3Uri" xml:"DatasetS3Uri"` + DatasetType string `json:"datasetType" xml:"DatasetType"` + Description string `json:"description" xml:"Description"` + EndTime time.Time `json:"endTime" xml:"EndTime"` + Message string `json:"message" xml:"Message"` + NumberOfDocuments int64 `json:"numberOfDocuments" xml:"NumberOfDocuments"` + Status string `json:"status" xml:"Status"` +} + +type DeleteDocumentClassifierRequest struct { + DocumentClassifierArn string `json:"documentClassifierArn" xml:"DocumentClassifierArn"` +} + +type DeleteDocumentClassifierResponse struct { +} + +type DeleteEndpointRequest struct { + EndpointArn string `json:"endpointArn" xml:"EndpointArn"` +} + +type DeleteEndpointResponse struct { +} + +type DeleteEntityRecognizerRequest struct { + EntityRecognizerArn string `json:"entityRecognizerArn" xml:"EntityRecognizerArn"` +} + +type DeleteEntityRecognizerResponse struct { +} + +type DeleteFlywheelRequest struct { + FlywheelArn string `json:"flywheelArn" xml:"FlywheelArn"` +} + +type DeleteFlywheelResponse struct { +} + +type DeleteResourcePolicyRequest struct { + PolicyRevisionId string `json:"policyRevisionId" xml:"PolicyRevisionId"` + ResourceArn string `json:"resourceArn" xml:"ResourceArn"` +} + +type DeleteResourcePolicyResponse struct { +} + +type DescribeDatasetRequest struct { + DatasetArn string `json:"datasetArn" xml:"DatasetArn"` +} + +type DescribeDatasetResponse struct { + DatasetProperties *DatasetProperties `json:"datasetProperties" xml:"DatasetProperties"` +} + +type DescribeDocumentClassificationJobRequest struct { + JobId string `json:"jobId" xml:"JobId"` +} + +type DescribeDocumentClassificationJobResponse struct { + DocumentClassificationJobProperties *DocumentClassificationJobProperties `json:"documentClassificationJobProperties" xml:"DocumentClassificationJobProperties"` +} + +type DescribeDocumentClassifierRequest struct { + DocumentClassifierArn string `json:"documentClassifierArn" xml:"DocumentClassifierArn"` +} + +type DescribeDocumentClassifierResponse struct { + DocumentClassifierProperties *DocumentClassifierProperties `json:"documentClassifierProperties" xml:"DocumentClassifierProperties"` +} + +type DescribeDominantLanguageDetectionJobRequest struct { + JobId string `json:"jobId" xml:"JobId"` +} + +type DescribeDominantLanguageDetectionJobResponse struct { + DominantLanguageDetectionJobProperties *DominantLanguageDetectionJobProperties `json:"dominantLanguageDetectionJobProperties" xml:"DominantLanguageDetectionJobProperties"` +} + +type DescribeEndpointRequest struct { + EndpointArn string `json:"endpointArn" xml:"EndpointArn"` +} + +type DescribeEndpointResponse struct { + EndpointProperties *EndpointProperties `json:"endpointProperties" xml:"EndpointProperties"` +} + +type DescribeEntitiesDetectionJobRequest struct { + JobId string `json:"jobId" xml:"JobId"` +} + +type DescribeEntitiesDetectionJobResponse struct { + EntitiesDetectionJobProperties *EntitiesDetectionJobProperties `json:"entitiesDetectionJobProperties" xml:"EntitiesDetectionJobProperties"` +} + +type DescribeEntityRecognizerRequest struct { + EntityRecognizerArn string `json:"entityRecognizerArn" xml:"EntityRecognizerArn"` +} + +type DescribeEntityRecognizerResponse struct { + EntityRecognizerProperties *EntityRecognizerProperties `json:"entityRecognizerProperties" xml:"EntityRecognizerProperties"` +} + +type DescribeEventsDetectionJobRequest struct { + JobId string `json:"jobId" xml:"JobId"` +} + +type DescribeEventsDetectionJobResponse struct { + EventsDetectionJobProperties *EventsDetectionJobProperties `json:"eventsDetectionJobProperties" xml:"EventsDetectionJobProperties"` +} + +type DescribeFlywheelIterationRequest struct { + FlywheelArn string `json:"flywheelArn" xml:"FlywheelArn"` + FlywheelIterationId string `json:"flywheelIterationId" xml:"FlywheelIterationId"` +} + +type DescribeFlywheelIterationResponse struct { + FlywheelIterationProperties *FlywheelIterationProperties `json:"flywheelIterationProperties" xml:"FlywheelIterationProperties"` +} + +type DescribeFlywheelRequest struct { + FlywheelArn string `json:"flywheelArn" xml:"FlywheelArn"` +} + +type DescribeFlywheelResponse struct { + FlywheelProperties *FlywheelProperties `json:"flywheelProperties" xml:"FlywheelProperties"` +} + +type DescribeKeyPhrasesDetectionJobRequest struct { + JobId string `json:"jobId" xml:"JobId"` +} + +type DescribeKeyPhrasesDetectionJobResponse struct { + KeyPhrasesDetectionJobProperties *KeyPhrasesDetectionJobProperties `json:"keyPhrasesDetectionJobProperties" xml:"KeyPhrasesDetectionJobProperties"` +} + +type DescribePiiEntitiesDetectionJobRequest struct { + JobId string `json:"jobId" xml:"JobId"` +} + +type DescribePiiEntitiesDetectionJobResponse struct { + PiiEntitiesDetectionJobProperties *PiiEntitiesDetectionJobProperties `json:"piiEntitiesDetectionJobProperties" xml:"PiiEntitiesDetectionJobProperties"` +} + +type DescribeResourcePolicyRequest struct { + ResourceArn string `json:"resourceArn" xml:"ResourceArn"` +} + +type DescribeResourcePolicyResponse struct { + CreationTime time.Time `json:"creationTime" xml:"CreationTime"` + LastModifiedTime time.Time `json:"lastModifiedTime" xml:"LastModifiedTime"` + PolicyRevisionId string `json:"policyRevisionId" xml:"PolicyRevisionId"` + ResourcePolicy string `json:"resourcePolicy" xml:"ResourcePolicy"` +} + +type DescribeSentimentDetectionJobRequest struct { + JobId string `json:"jobId" xml:"JobId"` +} + +type DescribeSentimentDetectionJobResponse struct { + SentimentDetectionJobProperties *SentimentDetectionJobProperties `json:"sentimentDetectionJobProperties" xml:"SentimentDetectionJobProperties"` +} + +type DescribeTargetedSentimentDetectionJobRequest struct { + JobId string `json:"jobId" xml:"JobId"` +} + +type DescribeTargetedSentimentDetectionJobResponse struct { + TargetedSentimentDetectionJobProperties *TargetedSentimentDetectionJobProperties `json:"targetedSentimentDetectionJobProperties" xml:"TargetedSentimentDetectionJobProperties"` +} + +type DescribeTopicsDetectionJobRequest struct { + JobId string `json:"jobId" xml:"JobId"` +} + +type DescribeTopicsDetectionJobResponse struct { + TopicsDetectionJobProperties *TopicsDetectionJobProperties `json:"topicsDetectionJobProperties" xml:"TopicsDetectionJobProperties"` +} + +type DetectDominantLanguageRequest struct { + Text string `json:"text" xml:"Text"` +} + +type DetectDominantLanguageResponse struct { + Languages ListOfDominantLanguages `json:"languages" xml:"Languages"` +} + +type DetectEntitiesRequest struct { + Bytes []byte `json:"bytes" xml:"Bytes"` + DocumentReaderConfig *DocumentReaderConfig `json:"documentReaderConfig" xml:"DocumentReaderConfig"` + EndpointArn string `json:"endpointArn" xml:"EndpointArn"` + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + Text string `json:"text" xml:"Text"` +} + +type DetectEntitiesResponse struct { + Blocks ListOfBlocks `json:"blocks" xml:"Blocks"` + DocumentMetadata *DocumentMetadata `json:"documentMetadata" xml:"DocumentMetadata"` + DocumentType ListOfDocumentType `json:"documentType" xml:"DocumentType"` + Entities ListOfEntities `json:"entities" xml:"Entities"` + Errors ListOfErrors `json:"errors" xml:"Errors"` +} + +type DetectKeyPhrasesRequest struct { + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + Text string `json:"text" xml:"Text"` +} + +type DetectKeyPhrasesResponse struct { + KeyPhrases ListOfKeyPhrases `json:"keyPhrases" xml:"KeyPhrases"` +} + +type DetectPiiEntitiesRequest struct { + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + Text string `json:"text" xml:"Text"` +} + +type DetectPiiEntitiesResponse struct { + Entities ListOfPiiEntities `json:"entities" xml:"Entities"` +} + +type DetectSentimentRequest struct { + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + Text string `json:"text" xml:"Text"` +} + +type DetectSentimentResponse struct { + Sentiment string `json:"sentiment" xml:"Sentiment"` + SentimentScore *SentimentScore `json:"sentimentScore" xml:"SentimentScore"` +} + +type DetectSyntaxRequest struct { + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + Text string `json:"text" xml:"Text"` +} + +type DetectSyntaxResponse struct { + SyntaxTokens ListOfSyntaxTokens `json:"syntaxTokens" xml:"SyntaxTokens"` +} + +type DetectTargetedSentimentRequest struct { + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + Text string `json:"text" xml:"Text"` +} + +type DetectTargetedSentimentResponse struct { + Entities ListOfTargetedSentimentEntities `json:"entities" xml:"Entities"` +} + +type DetectToxicContentRequest struct { + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + TextSegments ListOfTextSegments `json:"textSegments" xml:"TextSegments"` +} + +type DetectToxicContentResponse struct { + ResultList ListOfToxicLabels `json:"resultList" xml:"ResultList"` +} + +type DocumentClass struct { + Name string `json:"name" xml:"Name"` + Page int32 `json:"page" xml:"Page"` + Score float32 `json:"score" xml:"Score"` +} + +type DocumentClassificationConfig struct { + Labels LabelsList `json:"labels" xml:"Labels"` + Mode string `json:"mode" xml:"Mode"` +} + +type DocumentClassificationJobFilter struct { + JobName string `json:"jobName" xml:"JobName"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` + SubmitTimeAfter time.Time `json:"submitTimeAfter" xml:"SubmitTimeAfter"` + SubmitTimeBefore time.Time `json:"submitTimeBefore" xml:"SubmitTimeBefore"` +} + +type DocumentClassificationJobProperties struct { + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + DocumentClassifierArn string `json:"documentClassifierArn" xml:"DocumentClassifierArn"` + EndTime time.Time `json:"endTime" xml:"EndTime"` + FlywheelArn string `json:"flywheelArn" xml:"FlywheelArn"` + InputDataConfig *InputDataConfig `json:"inputDataConfig" xml:"InputDataConfig"` + JobArn string `json:"jobArn" xml:"JobArn"` + JobId string `json:"jobId" xml:"JobId"` + JobName string `json:"jobName" xml:"JobName"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` + Message string `json:"message" xml:"Message"` + OutputDataConfig *OutputDataConfig `json:"outputDataConfig" xml:"OutputDataConfig"` + SubmitTime time.Time `json:"submitTime" xml:"SubmitTime"` + VolumeKmsKeyId string `json:"volumeKmsKeyId" xml:"VolumeKmsKeyId"` + VpcConfig *VpcConfig `json:"vpcConfig" xml:"VpcConfig"` +} + +type DocumentClassifierDocuments struct { + S3Uri string `json:"s3Uri" xml:"S3Uri"` + TestS3Uri string `json:"testS3Uri" xml:"TestS3Uri"` +} + +type DocumentClassifierFilter struct { + DocumentClassifierName string `json:"documentClassifierName" xml:"DocumentClassifierName"` + Status string `json:"status" xml:"Status"` + SubmitTimeAfter time.Time `json:"submitTimeAfter" xml:"SubmitTimeAfter"` + SubmitTimeBefore time.Time `json:"submitTimeBefore" xml:"SubmitTimeBefore"` +} + +type DocumentClassifierInputDataConfig struct { + AugmentedManifests DocumentClassifierAugmentedManifestsList `json:"augmentedManifests" xml:"AugmentedManifests"` + DataFormat string `json:"dataFormat" xml:"DataFormat"` + DocumentReaderConfig *DocumentReaderConfig `json:"documentReaderConfig" xml:"DocumentReaderConfig"` + DocumentType string `json:"documentType" xml:"DocumentType"` + Documents *DocumentClassifierDocuments `json:"documents" xml:"Documents"` + LabelDelimiter string `json:"labelDelimiter" xml:"LabelDelimiter"` + S3Uri string `json:"s3Uri" xml:"S3Uri"` + TestS3Uri string `json:"testS3Uri" xml:"TestS3Uri"` +} + +type DocumentClassifierOutputDataConfig struct { + FlywheelStatsS3Prefix string `json:"flywheelStatsS3Prefix" xml:"FlywheelStatsS3Prefix"` + KmsKeyId string `json:"kmsKeyId" xml:"KmsKeyId"` + S3Uri string `json:"s3Uri" xml:"S3Uri"` +} + +type DocumentClassifierProperties struct { + ClassifierMetadata *ClassifierMetadata `json:"classifierMetadata" xml:"ClassifierMetadata"` + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + DocumentClassifierArn string `json:"documentClassifierArn" xml:"DocumentClassifierArn"` + EndTime time.Time `json:"endTime" xml:"EndTime"` + FlywheelArn string `json:"flywheelArn" xml:"FlywheelArn"` + InputDataConfig *DocumentClassifierInputDataConfig `json:"inputDataConfig" xml:"InputDataConfig"` + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + Message string `json:"message" xml:"Message"` + Mode string `json:"mode" xml:"Mode"` + ModelKmsKeyId string `json:"modelKmsKeyId" xml:"ModelKmsKeyId"` + OutputDataConfig *DocumentClassifierOutputDataConfig `json:"outputDataConfig" xml:"OutputDataConfig"` + SourceModelArn string `json:"sourceModelArn" xml:"SourceModelArn"` + Status string `json:"status" xml:"Status"` + SubmitTime time.Time `json:"submitTime" xml:"SubmitTime"` + TrainingEndTime time.Time `json:"trainingEndTime" xml:"TrainingEndTime"` + TrainingStartTime time.Time `json:"trainingStartTime" xml:"TrainingStartTime"` + VersionName string `json:"versionName" xml:"VersionName"` + VolumeKmsKeyId string `json:"volumeKmsKeyId" xml:"VolumeKmsKeyId"` + VpcConfig *VpcConfig `json:"vpcConfig" xml:"VpcConfig"` +} + +type DocumentClassifierSummary struct { + DocumentClassifierName string `json:"documentClassifierName" xml:"DocumentClassifierName"` + LatestVersionCreatedAt time.Time `json:"latestVersionCreatedAt" xml:"LatestVersionCreatedAt"` + LatestVersionName string `json:"latestVersionName" xml:"LatestVersionName"` + LatestVersionStatus string `json:"latestVersionStatus" xml:"LatestVersionStatus"` + NumberOfVersions int32 `json:"numberOfVersions" xml:"NumberOfVersions"` +} + +type DocumentLabel struct { + Name string `json:"name" xml:"Name"` + Page int32 `json:"page" xml:"Page"` + Score float32 `json:"score" xml:"Score"` +} + +type DocumentMetadata struct { + ExtractedCharacters ListOfExtractedCharacters `json:"extractedCharacters" xml:"ExtractedCharacters"` + Pages int32 `json:"pages" xml:"Pages"` +} + +type DocumentReaderConfig struct { + DocumentReadAction string `json:"documentReadAction" xml:"DocumentReadAction"` + DocumentReadMode string `json:"documentReadMode" xml:"DocumentReadMode"` + FeatureTypes ListOfDocumentReadFeatureTypes `json:"featureTypes" xml:"FeatureTypes"` +} + +type DocumentTypeListItem struct { + Page int32 `json:"page" xml:"Page"` + Type string `json:"type" xml:"Type"` +} + +type DominantLanguage struct { + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + Score float32 `json:"score" xml:"Score"` +} + +type DominantLanguageDetectionJobFilter struct { + JobName string `json:"jobName" xml:"JobName"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` + SubmitTimeAfter time.Time `json:"submitTimeAfter" xml:"SubmitTimeAfter"` + SubmitTimeBefore time.Time `json:"submitTimeBefore" xml:"SubmitTimeBefore"` +} + +type DominantLanguageDetectionJobProperties struct { + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + EndTime time.Time `json:"endTime" xml:"EndTime"` + InputDataConfig *InputDataConfig `json:"inputDataConfig" xml:"InputDataConfig"` + JobArn string `json:"jobArn" xml:"JobArn"` + JobId string `json:"jobId" xml:"JobId"` + JobName string `json:"jobName" xml:"JobName"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` + Message string `json:"message" xml:"Message"` + OutputDataConfig *OutputDataConfig `json:"outputDataConfig" xml:"OutputDataConfig"` + SubmitTime time.Time `json:"submitTime" xml:"SubmitTime"` + VolumeKmsKeyId string `json:"volumeKmsKeyId" xml:"VolumeKmsKeyId"` + VpcConfig *VpcConfig `json:"vpcConfig" xml:"VpcConfig"` +} + +type EndpointFilter struct { + CreationTimeAfter time.Time `json:"creationTimeAfter" xml:"CreationTimeAfter"` + CreationTimeBefore time.Time `json:"creationTimeBefore" xml:"CreationTimeBefore"` + ModelArn string `json:"modelArn" xml:"ModelArn"` + Status string `json:"status" xml:"Status"` +} + +type EndpointProperties struct { + CreationTime time.Time `json:"creationTime" xml:"CreationTime"` + CurrentInferenceUnits int32 `json:"currentInferenceUnits" xml:"CurrentInferenceUnits"` + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + DesiredDataAccessRoleArn string `json:"desiredDataAccessRoleArn" xml:"DesiredDataAccessRoleArn"` + DesiredInferenceUnits int32 `json:"desiredInferenceUnits" xml:"DesiredInferenceUnits"` + DesiredModelArn string `json:"desiredModelArn" xml:"DesiredModelArn"` + EndpointArn string `json:"endpointArn" xml:"EndpointArn"` + FlywheelArn string `json:"flywheelArn" xml:"FlywheelArn"` + LastModifiedTime time.Time `json:"lastModifiedTime" xml:"LastModifiedTime"` + Message string `json:"message" xml:"Message"` + ModelArn string `json:"modelArn" xml:"ModelArn"` + Status string `json:"status" xml:"Status"` +} + +type EntitiesDetectionJobFilter struct { + JobName string `json:"jobName" xml:"JobName"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` + SubmitTimeAfter time.Time `json:"submitTimeAfter" xml:"SubmitTimeAfter"` + SubmitTimeBefore time.Time `json:"submitTimeBefore" xml:"SubmitTimeBefore"` +} + +type EntitiesDetectionJobProperties struct { + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + EndTime time.Time `json:"endTime" xml:"EndTime"` + EntityRecognizerArn string `json:"entityRecognizerArn" xml:"EntityRecognizerArn"` + FlywheelArn string `json:"flywheelArn" xml:"FlywheelArn"` + InputDataConfig *InputDataConfig `json:"inputDataConfig" xml:"InputDataConfig"` + JobArn string `json:"jobArn" xml:"JobArn"` + JobId string `json:"jobId" xml:"JobId"` + JobName string `json:"jobName" xml:"JobName"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + Message string `json:"message" xml:"Message"` + OutputDataConfig *OutputDataConfig `json:"outputDataConfig" xml:"OutputDataConfig"` + SubmitTime time.Time `json:"submitTime" xml:"SubmitTime"` + VolumeKmsKeyId string `json:"volumeKmsKeyId" xml:"VolumeKmsKeyId"` + VpcConfig *VpcConfig `json:"vpcConfig" xml:"VpcConfig"` +} + +type Entity struct { + BeginOffset int32 `json:"beginOffset" xml:"BeginOffset"` + BlockReferences ListOfBlockReferences `json:"blockReferences" xml:"BlockReferences"` + EndOffset int32 `json:"endOffset" xml:"EndOffset"` + Score float32 `json:"score" xml:"Score"` + Text string `json:"text" xml:"Text"` + Type string `json:"type" xml:"Type"` +} + +type EntityLabel struct { + Name string `json:"name" xml:"Name"` + Score float32 `json:"score" xml:"Score"` +} + +type EntityRecognitionConfig struct { + EntityTypes EntityTypesList `json:"entityTypes" xml:"EntityTypes"` +} + +type EntityRecognizerAnnotations struct { + S3Uri string `json:"s3Uri" xml:"S3Uri"` + TestS3Uri string `json:"testS3Uri" xml:"TestS3Uri"` +} + +type EntityRecognizerDocuments struct { + InputFormat string `json:"inputFormat" xml:"InputFormat"` + S3Uri string `json:"s3Uri" xml:"S3Uri"` + TestS3Uri string `json:"testS3Uri" xml:"TestS3Uri"` +} + +type EntityRecognizerEntityList struct { + S3Uri string `json:"s3Uri" xml:"S3Uri"` +} + +type EntityRecognizerEvaluationMetrics struct { + F1Score float64 `json:"f1Score" xml:"F1Score"` + Precision float64 `json:"precision" xml:"Precision"` + Recall float64 `json:"recall" xml:"Recall"` +} + +type EntityRecognizerFilter struct { + RecognizerName string `json:"recognizerName" xml:"RecognizerName"` + Status string `json:"status" xml:"Status"` + SubmitTimeAfter time.Time `json:"submitTimeAfter" xml:"SubmitTimeAfter"` + SubmitTimeBefore time.Time `json:"submitTimeBefore" xml:"SubmitTimeBefore"` +} + +type EntityRecognizerInputDataConfig struct { + Annotations *EntityRecognizerAnnotations `json:"annotations" xml:"Annotations"` + AugmentedManifests EntityRecognizerAugmentedManifestsList `json:"augmentedManifests" xml:"AugmentedManifests"` + DataFormat string `json:"dataFormat" xml:"DataFormat"` + Documents *EntityRecognizerDocuments `json:"documents" xml:"Documents"` + EntityList *EntityRecognizerEntityList `json:"entityList" xml:"EntityList"` + EntityTypes EntityTypesList `json:"entityTypes" xml:"EntityTypes"` +} + +type EntityRecognizerMetadata struct { + EntityTypes EntityRecognizerMetadataEntityTypesList `json:"entityTypes" xml:"EntityTypes"` + EvaluationMetrics *EntityRecognizerEvaluationMetrics `json:"evaluationMetrics" xml:"EvaluationMetrics"` + NumberOfTestDocuments int32 `json:"numberOfTestDocuments" xml:"NumberOfTestDocuments"` + NumberOfTrainedDocuments int32 `json:"numberOfTrainedDocuments" xml:"NumberOfTrainedDocuments"` +} + +type EntityRecognizerMetadataEntityTypesListItem struct { + EvaluationMetrics *EntityTypesEvaluationMetrics `json:"evaluationMetrics" xml:"EvaluationMetrics"` + NumberOfTrainMentions int32 `json:"numberOfTrainMentions" xml:"NumberOfTrainMentions"` + Type string `json:"type" xml:"Type"` +} + +type EntityRecognizerOutputDataConfig struct { + FlywheelStatsS3Prefix string `json:"flywheelStatsS3Prefix" xml:"FlywheelStatsS3Prefix"` +} + +type EntityRecognizerProperties struct { + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + EndTime time.Time `json:"endTime" xml:"EndTime"` + EntityRecognizerArn string `json:"entityRecognizerArn" xml:"EntityRecognizerArn"` + FlywheelArn string `json:"flywheelArn" xml:"FlywheelArn"` + InputDataConfig *EntityRecognizerInputDataConfig `json:"inputDataConfig" xml:"InputDataConfig"` + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + Message string `json:"message" xml:"Message"` + ModelKmsKeyId string `json:"modelKmsKeyId" xml:"ModelKmsKeyId"` + OutputDataConfig *EntityRecognizerOutputDataConfig `json:"outputDataConfig" xml:"OutputDataConfig"` + RecognizerMetadata *EntityRecognizerMetadata `json:"recognizerMetadata" xml:"RecognizerMetadata"` + SourceModelArn string `json:"sourceModelArn" xml:"SourceModelArn"` + Status string `json:"status" xml:"Status"` + SubmitTime time.Time `json:"submitTime" xml:"SubmitTime"` + TrainingEndTime time.Time `json:"trainingEndTime" xml:"TrainingEndTime"` + TrainingStartTime time.Time `json:"trainingStartTime" xml:"TrainingStartTime"` + VersionName string `json:"versionName" xml:"VersionName"` + VolumeKmsKeyId string `json:"volumeKmsKeyId" xml:"VolumeKmsKeyId"` + VpcConfig *VpcConfig `json:"vpcConfig" xml:"VpcConfig"` +} + +type EntityRecognizerSummary struct { + LatestVersionCreatedAt time.Time `json:"latestVersionCreatedAt" xml:"LatestVersionCreatedAt"` + LatestVersionName string `json:"latestVersionName" xml:"LatestVersionName"` + LatestVersionStatus string `json:"latestVersionStatus" xml:"LatestVersionStatus"` + NumberOfVersions int32 `json:"numberOfVersions" xml:"NumberOfVersions"` + RecognizerName string `json:"recognizerName" xml:"RecognizerName"` +} + +type EntityTypesEvaluationMetrics struct { + F1Score float64 `json:"f1Score" xml:"F1Score"` + Precision float64 `json:"precision" xml:"Precision"` + Recall float64 `json:"recall" xml:"Recall"` +} + +type EntityTypesListItem struct { + Type string `json:"type" xml:"Type"` +} + +type ErrorsListItem struct { + ErrorCode string `json:"errorCode" xml:"ErrorCode"` + ErrorMessage string `json:"errorMessage" xml:"ErrorMessage"` + Page int32 `json:"page" xml:"Page"` +} + +type EventsDetectionJobFilter struct { + JobName string `json:"jobName" xml:"JobName"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` + SubmitTimeAfter time.Time `json:"submitTimeAfter" xml:"SubmitTimeAfter"` + SubmitTimeBefore time.Time `json:"submitTimeBefore" xml:"SubmitTimeBefore"` +} + +type EventsDetectionJobProperties struct { + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + EndTime time.Time `json:"endTime" xml:"EndTime"` + InputDataConfig *InputDataConfig `json:"inputDataConfig" xml:"InputDataConfig"` + JobArn string `json:"jobArn" xml:"JobArn"` + JobId string `json:"jobId" xml:"JobId"` + JobName string `json:"jobName" xml:"JobName"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + Message string `json:"message" xml:"Message"` + OutputDataConfig *OutputDataConfig `json:"outputDataConfig" xml:"OutputDataConfig"` + SubmitTime time.Time `json:"submitTime" xml:"SubmitTime"` + TargetEventTypes TargetEventTypes `json:"targetEventTypes" xml:"TargetEventTypes"` +} + +type ExtractedCharactersListItem struct { + Count int32 `json:"count" xml:"Count"` + Page int32 `json:"page" xml:"Page"` +} + +type FlywheelFilter struct { + CreationTimeAfter time.Time `json:"creationTimeAfter" xml:"CreationTimeAfter"` + CreationTimeBefore time.Time `json:"creationTimeBefore" xml:"CreationTimeBefore"` + Status string `json:"status" xml:"Status"` +} + +type FlywheelIterationFilter struct { + CreationTimeAfter time.Time `json:"creationTimeAfter" xml:"CreationTimeAfter"` + CreationTimeBefore time.Time `json:"creationTimeBefore" xml:"CreationTimeBefore"` +} + +type FlywheelIterationProperties struct { + CreationTime time.Time `json:"creationTime" xml:"CreationTime"` + EndTime time.Time `json:"endTime" xml:"EndTime"` + EvaluatedModelArn string `json:"evaluatedModelArn" xml:"EvaluatedModelArn"` + EvaluatedModelMetrics *FlywheelModelEvaluationMetrics `json:"evaluatedModelMetrics" xml:"EvaluatedModelMetrics"` + EvaluationManifestS3Prefix string `json:"evaluationManifestS3Prefix" xml:"EvaluationManifestS3Prefix"` + FlywheelArn string `json:"flywheelArn" xml:"FlywheelArn"` + FlywheelIterationId string `json:"flywheelIterationId" xml:"FlywheelIterationId"` + Message string `json:"message" xml:"Message"` + Status string `json:"status" xml:"Status"` + TrainedModelArn string `json:"trainedModelArn" xml:"TrainedModelArn"` + TrainedModelMetrics *FlywheelModelEvaluationMetrics `json:"trainedModelMetrics" xml:"TrainedModelMetrics"` +} + +type FlywheelModelEvaluationMetrics struct { + AverageAccuracy float64 `json:"averageAccuracy" xml:"AverageAccuracy"` + AverageF1Score float64 `json:"averageF1Score" xml:"AverageF1Score"` + AveragePrecision float64 `json:"averagePrecision" xml:"AveragePrecision"` + AverageRecall float64 `json:"averageRecall" xml:"AverageRecall"` +} + +type FlywheelProperties struct { + ActiveModelArn string `json:"activeModelArn" xml:"ActiveModelArn"` + CreationTime time.Time `json:"creationTime" xml:"CreationTime"` + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + DataLakeS3Uri string `json:"dataLakeS3Uri" xml:"DataLakeS3Uri"` + DataSecurityConfig *DataSecurityConfig `json:"dataSecurityConfig" xml:"DataSecurityConfig"` + FlywheelArn string `json:"flywheelArn" xml:"FlywheelArn"` + LastModifiedTime time.Time `json:"lastModifiedTime" xml:"LastModifiedTime"` + LatestFlywheelIteration string `json:"latestFlywheelIteration" xml:"LatestFlywheelIteration"` + Message string `json:"message" xml:"Message"` + ModelType string `json:"modelType" xml:"ModelType"` + Status string `json:"status" xml:"Status"` + TaskConfig *TaskConfig `json:"taskConfig" xml:"TaskConfig"` +} + +type FlywheelSummary struct { + ActiveModelArn string `json:"activeModelArn" xml:"ActiveModelArn"` + CreationTime time.Time `json:"creationTime" xml:"CreationTime"` + DataLakeS3Uri string `json:"dataLakeS3Uri" xml:"DataLakeS3Uri"` + FlywheelArn string `json:"flywheelArn" xml:"FlywheelArn"` + LastModifiedTime time.Time `json:"lastModifiedTime" xml:"LastModifiedTime"` + LatestFlywheelIteration string `json:"latestFlywheelIteration" xml:"LatestFlywheelIteration"` + Message string `json:"message" xml:"Message"` + ModelType string `json:"modelType" xml:"ModelType"` + Status string `json:"status" xml:"Status"` +} + +type Geometry struct { + BoundingBox *BoundingBox `json:"boundingBox" xml:"BoundingBox"` + Polygon Polygon `json:"polygon" xml:"Polygon"` +} + +type ImportModelRequest struct { + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + ModelKmsKeyId string `json:"modelKmsKeyId" xml:"ModelKmsKeyId"` + ModelName string `json:"modelName" xml:"ModelName"` + SourceModelArn string `json:"sourceModelArn" xml:"SourceModelArn"` + Tags TagList `json:"tags" xml:"Tags"` + VersionName string `json:"versionName" xml:"VersionName"` +} + +type ImportModelResponse struct { + ModelArn string `json:"modelArn" xml:"ModelArn"` +} + +type InputDataConfig struct { + DocumentReaderConfig *DocumentReaderConfig `json:"documentReaderConfig" xml:"DocumentReaderConfig"` + InputFormat string `json:"inputFormat" xml:"InputFormat"` + S3Uri string `json:"s3Uri" xml:"S3Uri"` +} + +type InvalidRequestDetail struct { + Reason string `json:"reason" xml:"Reason"` +} + +type KeyPhrase struct { + BeginOffset int32 `json:"beginOffset" xml:"BeginOffset"` + EndOffset int32 `json:"endOffset" xml:"EndOffset"` + Score float32 `json:"score" xml:"Score"` + Text string `json:"text" xml:"Text"` +} + +type KeyPhrasesDetectionJobFilter struct { + JobName string `json:"jobName" xml:"JobName"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` + SubmitTimeAfter time.Time `json:"submitTimeAfter" xml:"SubmitTimeAfter"` + SubmitTimeBefore time.Time `json:"submitTimeBefore" xml:"SubmitTimeBefore"` +} + +type KeyPhrasesDetectionJobProperties struct { + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + EndTime time.Time `json:"endTime" xml:"EndTime"` + InputDataConfig *InputDataConfig `json:"inputDataConfig" xml:"InputDataConfig"` + JobArn string `json:"jobArn" xml:"JobArn"` + JobId string `json:"jobId" xml:"JobId"` + JobName string `json:"jobName" xml:"JobName"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + Message string `json:"message" xml:"Message"` + OutputDataConfig *OutputDataConfig `json:"outputDataConfig" xml:"OutputDataConfig"` + SubmitTime time.Time `json:"submitTime" xml:"SubmitTime"` + VolumeKmsKeyId string `json:"volumeKmsKeyId" xml:"VolumeKmsKeyId"` + VpcConfig *VpcConfig `json:"vpcConfig" xml:"VpcConfig"` +} + +type ListDatasetsRequest struct { + Filter *DatasetFilter `json:"filter" xml:"Filter"` + FlywheelArn string `json:"flywheelArn" xml:"FlywheelArn"` + MaxResults int32 `json:"maxResults" xml:"MaxResults"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListDatasetsResponse struct { + DatasetPropertiesList DatasetPropertiesList `json:"datasetPropertiesList" xml:"DatasetPropertiesList"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListDocumentClassificationJobsRequest struct { + Filter *DocumentClassificationJobFilter `json:"filter" xml:"Filter"` + MaxResults int32 `json:"maxResults" xml:"MaxResults"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListDocumentClassificationJobsResponse struct { + DocumentClassificationJobPropertiesList DocumentClassificationJobPropertiesList `json:"documentClassificationJobPropertiesList" xml:"DocumentClassificationJobPropertiesList"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListDocumentClassifierSummariesRequest struct { + MaxResults int32 `json:"maxResults" xml:"MaxResults"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListDocumentClassifierSummariesResponse struct { + DocumentClassifierSummariesList DocumentClassifierSummariesList `json:"documentClassifierSummariesList" xml:"DocumentClassifierSummariesList"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListDocumentClassifiersRequest struct { + Filter *DocumentClassifierFilter `json:"filter" xml:"Filter"` + MaxResults int32 `json:"maxResults" xml:"MaxResults"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListDocumentClassifiersResponse struct { + DocumentClassifierPropertiesList DocumentClassifierPropertiesList `json:"documentClassifierPropertiesList" xml:"DocumentClassifierPropertiesList"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListDominantLanguageDetectionJobsRequest struct { + Filter *DominantLanguageDetectionJobFilter `json:"filter" xml:"Filter"` + MaxResults int32 `json:"maxResults" xml:"MaxResults"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListDominantLanguageDetectionJobsResponse struct { + DominantLanguageDetectionJobPropertiesList DominantLanguageDetectionJobPropertiesList `json:"dominantLanguageDetectionJobPropertiesList" xml:"DominantLanguageDetectionJobPropertiesList"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListEndpointsRequest struct { + Filter *EndpointFilter `json:"filter" xml:"Filter"` + MaxResults int32 `json:"maxResults" xml:"MaxResults"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListEndpointsResponse struct { + EndpointPropertiesList EndpointPropertiesList `json:"endpointPropertiesList" xml:"EndpointPropertiesList"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListEntitiesDetectionJobsRequest struct { + Filter *EntitiesDetectionJobFilter `json:"filter" xml:"Filter"` + MaxResults int32 `json:"maxResults" xml:"MaxResults"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListEntitiesDetectionJobsResponse struct { + EntitiesDetectionJobPropertiesList EntitiesDetectionJobPropertiesList `json:"entitiesDetectionJobPropertiesList" xml:"EntitiesDetectionJobPropertiesList"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListEntityRecognizerSummariesRequest struct { + MaxResults int32 `json:"maxResults" xml:"MaxResults"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListEntityRecognizerSummariesResponse struct { + EntityRecognizerSummariesList EntityRecognizerSummariesList `json:"entityRecognizerSummariesList" xml:"EntityRecognizerSummariesList"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListEntityRecognizersRequest struct { + Filter *EntityRecognizerFilter `json:"filter" xml:"Filter"` + MaxResults int32 `json:"maxResults" xml:"MaxResults"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListEntityRecognizersResponse struct { + EntityRecognizerPropertiesList EntityRecognizerPropertiesList `json:"entityRecognizerPropertiesList" xml:"EntityRecognizerPropertiesList"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListEventsDetectionJobsRequest struct { + Filter *EventsDetectionJobFilter `json:"filter" xml:"Filter"` + MaxResults int32 `json:"maxResults" xml:"MaxResults"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListEventsDetectionJobsResponse struct { + EventsDetectionJobPropertiesList EventsDetectionJobPropertiesList `json:"eventsDetectionJobPropertiesList" xml:"EventsDetectionJobPropertiesList"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListFlywheelIterationHistoryRequest struct { + Filter *FlywheelIterationFilter `json:"filter" xml:"Filter"` + FlywheelArn string `json:"flywheelArn" xml:"FlywheelArn"` + MaxResults int32 `json:"maxResults" xml:"MaxResults"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListFlywheelIterationHistoryResponse struct { + FlywheelIterationPropertiesList FlywheelIterationPropertiesList `json:"flywheelIterationPropertiesList" xml:"FlywheelIterationPropertiesList"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListFlywheelsRequest struct { + Filter *FlywheelFilter `json:"filter" xml:"Filter"` + MaxResults int32 `json:"maxResults" xml:"MaxResults"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListFlywheelsResponse struct { + FlywheelSummaryList FlywheelSummaryList `json:"flywheelSummaryList" xml:"FlywheelSummaryList"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListKeyPhrasesDetectionJobsRequest struct { + Filter *KeyPhrasesDetectionJobFilter `json:"filter" xml:"Filter"` + MaxResults int32 `json:"maxResults" xml:"MaxResults"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListKeyPhrasesDetectionJobsResponse struct { + KeyPhrasesDetectionJobPropertiesList KeyPhrasesDetectionJobPropertiesList `json:"keyPhrasesDetectionJobPropertiesList" xml:"KeyPhrasesDetectionJobPropertiesList"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListPiiEntitiesDetectionJobsRequest struct { + Filter *PiiEntitiesDetectionJobFilter `json:"filter" xml:"Filter"` + MaxResults int32 `json:"maxResults" xml:"MaxResults"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListPiiEntitiesDetectionJobsResponse struct { + NextToken string `json:"nextToken" xml:"NextToken"` + PiiEntitiesDetectionJobPropertiesList PiiEntitiesDetectionJobPropertiesList `json:"piiEntitiesDetectionJobPropertiesList" xml:"PiiEntitiesDetectionJobPropertiesList"` +} + +type ListSentimentDetectionJobsRequest struct { + Filter *SentimentDetectionJobFilter `json:"filter" xml:"Filter"` + MaxResults int32 `json:"maxResults" xml:"MaxResults"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListSentimentDetectionJobsResponse struct { + NextToken string `json:"nextToken" xml:"NextToken"` + SentimentDetectionJobPropertiesList SentimentDetectionJobPropertiesList `json:"sentimentDetectionJobPropertiesList" xml:"SentimentDetectionJobPropertiesList"` +} + +type ListTagsForResourceRequest struct { + ResourceArn string `json:"resourceArn" xml:"ResourceArn"` +} + +type ListTagsForResourceResponse struct { + ResourceArn string `json:"resourceArn" xml:"ResourceArn"` + Tags TagList `json:"tags" xml:"Tags"` +} + +type ListTargetedSentimentDetectionJobsRequest struct { + Filter *TargetedSentimentDetectionJobFilter `json:"filter" xml:"Filter"` + MaxResults int32 `json:"maxResults" xml:"MaxResults"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListTargetedSentimentDetectionJobsResponse struct { + NextToken string `json:"nextToken" xml:"NextToken"` + TargetedSentimentDetectionJobPropertiesList TargetedSentimentDetectionJobPropertiesList `json:"targetedSentimentDetectionJobPropertiesList" xml:"TargetedSentimentDetectionJobPropertiesList"` +} + +type ListTopicsDetectionJobsRequest struct { + Filter *TopicsDetectionJobFilter `json:"filter" xml:"Filter"` + MaxResults int32 `json:"maxResults" xml:"MaxResults"` + NextToken string `json:"nextToken" xml:"NextToken"` +} + +type ListTopicsDetectionJobsResponse struct { + NextToken string `json:"nextToken" xml:"NextToken"` + TopicsDetectionJobPropertiesList TopicsDetectionJobPropertiesList `json:"topicsDetectionJobPropertiesList" xml:"TopicsDetectionJobPropertiesList"` +} + +type MentionSentiment struct { + Sentiment string `json:"sentiment" xml:"Sentiment"` + SentimentScore *SentimentScore `json:"sentimentScore" xml:"SentimentScore"` +} + +type OutputDataConfig struct { + KmsKeyId string `json:"kmsKeyId" xml:"KmsKeyId"` + S3Uri string `json:"s3Uri" xml:"S3Uri"` +} + +type PartOfSpeechTag struct { + Score float32 `json:"score" xml:"Score"` + Tag string `json:"tag" xml:"Tag"` +} + +type PiiEntitiesDetectionJobFilter struct { + JobName string `json:"jobName" xml:"JobName"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` + SubmitTimeAfter time.Time `json:"submitTimeAfter" xml:"SubmitTimeAfter"` + SubmitTimeBefore time.Time `json:"submitTimeBefore" xml:"SubmitTimeBefore"` +} + +type PiiEntitiesDetectionJobProperties struct { + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + EndTime time.Time `json:"endTime" xml:"EndTime"` + InputDataConfig *InputDataConfig `json:"inputDataConfig" xml:"InputDataConfig"` + JobArn string `json:"jobArn" xml:"JobArn"` + JobId string `json:"jobId" xml:"JobId"` + JobName string `json:"jobName" xml:"JobName"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + Message string `json:"message" xml:"Message"` + Mode string `json:"mode" xml:"Mode"` + OutputDataConfig *PiiOutputDataConfig `json:"outputDataConfig" xml:"OutputDataConfig"` + RedactionConfig *RedactionConfig `json:"redactionConfig" xml:"RedactionConfig"` + SubmitTime time.Time `json:"submitTime" xml:"SubmitTime"` +} + +type PiiEntity struct { + BeginOffset int32 `json:"beginOffset" xml:"BeginOffset"` + EndOffset int32 `json:"endOffset" xml:"EndOffset"` + Score float32 `json:"score" xml:"Score"` + Type string `json:"type" xml:"Type"` +} + +type PiiOutputDataConfig struct { + KmsKeyId string `json:"kmsKeyId" xml:"KmsKeyId"` + S3Uri string `json:"s3Uri" xml:"S3Uri"` +} + +type Point struct { + X float32 `json:"x" xml:"X"` + Y float32 `json:"y" xml:"Y"` +} + +type PutResourcePolicyRequest struct { + PolicyRevisionId string `json:"policyRevisionId" xml:"PolicyRevisionId"` + ResourceArn string `json:"resourceArn" xml:"ResourceArn"` + ResourcePolicy string `json:"resourcePolicy" xml:"ResourcePolicy"` +} + +type PutResourcePolicyResponse struct { + PolicyRevisionId string `json:"policyRevisionId" xml:"PolicyRevisionId"` +} + +type RedactionConfig struct { + MaskCharacter string `json:"maskCharacter" xml:"MaskCharacter"` + MaskMode string `json:"maskMode" xml:"MaskMode"` + PiiEntityTypes ListOfPiiEntityTypes `json:"piiEntityTypes" xml:"PiiEntityTypes"` +} + +type RelationshipsListItem struct { + Ids StringList `json:"ids" xml:"Ids"` + Type string `json:"type" xml:"Type"` +} + +type SentimentDetectionJobFilter struct { + JobName string `json:"jobName" xml:"JobName"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` + SubmitTimeAfter time.Time `json:"submitTimeAfter" xml:"SubmitTimeAfter"` + SubmitTimeBefore time.Time `json:"submitTimeBefore" xml:"SubmitTimeBefore"` +} + +type SentimentDetectionJobProperties struct { + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + EndTime time.Time `json:"endTime" xml:"EndTime"` + InputDataConfig *InputDataConfig `json:"inputDataConfig" xml:"InputDataConfig"` + JobArn string `json:"jobArn" xml:"JobArn"` + JobId string `json:"jobId" xml:"JobId"` + JobName string `json:"jobName" xml:"JobName"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + Message string `json:"message" xml:"Message"` + OutputDataConfig *OutputDataConfig `json:"outputDataConfig" xml:"OutputDataConfig"` + SubmitTime time.Time `json:"submitTime" xml:"SubmitTime"` + VolumeKmsKeyId string `json:"volumeKmsKeyId" xml:"VolumeKmsKeyId"` + VpcConfig *VpcConfig `json:"vpcConfig" xml:"VpcConfig"` +} + +type SentimentScore struct { + Mixed float32 `json:"mixed" xml:"Mixed"` + Negative float32 `json:"negative" xml:"Negative"` + Neutral float32 `json:"neutral" xml:"Neutral"` + Positive float32 `json:"positive" xml:"Positive"` +} + +type StartDocumentClassificationJobRequest struct { + ClientRequestToken string `json:"clientRequestToken" xml:"ClientRequestToken"` + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + DocumentClassifierArn string `json:"documentClassifierArn" xml:"DocumentClassifierArn"` + FlywheelArn string `json:"flywheelArn" xml:"FlywheelArn"` + InputDataConfig *InputDataConfig `json:"inputDataConfig" xml:"InputDataConfig"` + JobName string `json:"jobName" xml:"JobName"` + OutputDataConfig *OutputDataConfig `json:"outputDataConfig" xml:"OutputDataConfig"` + Tags TagList `json:"tags" xml:"Tags"` + VolumeKmsKeyId string `json:"volumeKmsKeyId" xml:"VolumeKmsKeyId"` + VpcConfig *VpcConfig `json:"vpcConfig" xml:"VpcConfig"` +} + +type StartDocumentClassificationJobResponse struct { + DocumentClassifierArn string `json:"documentClassifierArn" xml:"DocumentClassifierArn"` + JobArn string `json:"jobArn" xml:"JobArn"` + JobId string `json:"jobId" xml:"JobId"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` +} + +type StartDominantLanguageDetectionJobRequest struct { + ClientRequestToken string `json:"clientRequestToken" xml:"ClientRequestToken"` + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + InputDataConfig *InputDataConfig `json:"inputDataConfig" xml:"InputDataConfig"` + JobName string `json:"jobName" xml:"JobName"` + OutputDataConfig *OutputDataConfig `json:"outputDataConfig" xml:"OutputDataConfig"` + Tags TagList `json:"tags" xml:"Tags"` + VolumeKmsKeyId string `json:"volumeKmsKeyId" xml:"VolumeKmsKeyId"` + VpcConfig *VpcConfig `json:"vpcConfig" xml:"VpcConfig"` +} + +type StartDominantLanguageDetectionJobResponse struct { + JobArn string `json:"jobArn" xml:"JobArn"` + JobId string `json:"jobId" xml:"JobId"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` +} + +type StartEntitiesDetectionJobRequest struct { + ClientRequestToken string `json:"clientRequestToken" xml:"ClientRequestToken"` + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + EntityRecognizerArn string `json:"entityRecognizerArn" xml:"EntityRecognizerArn"` + FlywheelArn string `json:"flywheelArn" xml:"FlywheelArn"` + InputDataConfig *InputDataConfig `json:"inputDataConfig" xml:"InputDataConfig"` + JobName string `json:"jobName" xml:"JobName"` + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + OutputDataConfig *OutputDataConfig `json:"outputDataConfig" xml:"OutputDataConfig"` + Tags TagList `json:"tags" xml:"Tags"` + VolumeKmsKeyId string `json:"volumeKmsKeyId" xml:"VolumeKmsKeyId"` + VpcConfig *VpcConfig `json:"vpcConfig" xml:"VpcConfig"` +} + +type StartEntitiesDetectionJobResponse struct { + EntityRecognizerArn string `json:"entityRecognizerArn" xml:"EntityRecognizerArn"` + JobArn string `json:"jobArn" xml:"JobArn"` + JobId string `json:"jobId" xml:"JobId"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` +} + +type StartEventsDetectionJobRequest struct { + ClientRequestToken string `json:"clientRequestToken" xml:"ClientRequestToken"` + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + InputDataConfig *InputDataConfig `json:"inputDataConfig" xml:"InputDataConfig"` + JobName string `json:"jobName" xml:"JobName"` + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + OutputDataConfig *OutputDataConfig `json:"outputDataConfig" xml:"OutputDataConfig"` + Tags TagList `json:"tags" xml:"Tags"` + TargetEventTypes TargetEventTypes `json:"targetEventTypes" xml:"TargetEventTypes"` +} + +type StartEventsDetectionJobResponse struct { + JobArn string `json:"jobArn" xml:"JobArn"` + JobId string `json:"jobId" xml:"JobId"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` +} + +type StartFlywheelIterationRequest struct { + ClientRequestToken string `json:"clientRequestToken" xml:"ClientRequestToken"` + FlywheelArn string `json:"flywheelArn" xml:"FlywheelArn"` +} + +type StartFlywheelIterationResponse struct { + FlywheelArn string `json:"flywheelArn" xml:"FlywheelArn"` + FlywheelIterationId string `json:"flywheelIterationId" xml:"FlywheelIterationId"` +} + +type StartKeyPhrasesDetectionJobRequest struct { + ClientRequestToken string `json:"clientRequestToken" xml:"ClientRequestToken"` + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + InputDataConfig *InputDataConfig `json:"inputDataConfig" xml:"InputDataConfig"` + JobName string `json:"jobName" xml:"JobName"` + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + OutputDataConfig *OutputDataConfig `json:"outputDataConfig" xml:"OutputDataConfig"` + Tags TagList `json:"tags" xml:"Tags"` + VolumeKmsKeyId string `json:"volumeKmsKeyId" xml:"VolumeKmsKeyId"` + VpcConfig *VpcConfig `json:"vpcConfig" xml:"VpcConfig"` +} + +type StartKeyPhrasesDetectionJobResponse struct { + JobArn string `json:"jobArn" xml:"JobArn"` + JobId string `json:"jobId" xml:"JobId"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` +} + +type StartPiiEntitiesDetectionJobRequest struct { + ClientRequestToken string `json:"clientRequestToken" xml:"ClientRequestToken"` + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + InputDataConfig *InputDataConfig `json:"inputDataConfig" xml:"InputDataConfig"` + JobName string `json:"jobName" xml:"JobName"` + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + Mode string `json:"mode" xml:"Mode"` + OutputDataConfig *OutputDataConfig `json:"outputDataConfig" xml:"OutputDataConfig"` + RedactionConfig *RedactionConfig `json:"redactionConfig" xml:"RedactionConfig"` + Tags TagList `json:"tags" xml:"Tags"` +} + +type StartPiiEntitiesDetectionJobResponse struct { + JobArn string `json:"jobArn" xml:"JobArn"` + JobId string `json:"jobId" xml:"JobId"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` +} + +type StartSentimentDetectionJobRequest struct { + ClientRequestToken string `json:"clientRequestToken" xml:"ClientRequestToken"` + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + InputDataConfig *InputDataConfig `json:"inputDataConfig" xml:"InputDataConfig"` + JobName string `json:"jobName" xml:"JobName"` + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + OutputDataConfig *OutputDataConfig `json:"outputDataConfig" xml:"OutputDataConfig"` + Tags TagList `json:"tags" xml:"Tags"` + VolumeKmsKeyId string `json:"volumeKmsKeyId" xml:"VolumeKmsKeyId"` + VpcConfig *VpcConfig `json:"vpcConfig" xml:"VpcConfig"` +} + +type StartSentimentDetectionJobResponse struct { + JobArn string `json:"jobArn" xml:"JobArn"` + JobId string `json:"jobId" xml:"JobId"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` +} + +type StartTargetedSentimentDetectionJobRequest struct { + ClientRequestToken string `json:"clientRequestToken" xml:"ClientRequestToken"` + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + InputDataConfig *InputDataConfig `json:"inputDataConfig" xml:"InputDataConfig"` + JobName string `json:"jobName" xml:"JobName"` + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + OutputDataConfig *OutputDataConfig `json:"outputDataConfig" xml:"OutputDataConfig"` + Tags TagList `json:"tags" xml:"Tags"` + VolumeKmsKeyId string `json:"volumeKmsKeyId" xml:"VolumeKmsKeyId"` + VpcConfig *VpcConfig `json:"vpcConfig" xml:"VpcConfig"` +} + +type StartTargetedSentimentDetectionJobResponse struct { + JobArn string `json:"jobArn" xml:"JobArn"` + JobId string `json:"jobId" xml:"JobId"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` +} + +type StartTopicsDetectionJobRequest struct { + ClientRequestToken string `json:"clientRequestToken" xml:"ClientRequestToken"` + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + InputDataConfig *InputDataConfig `json:"inputDataConfig" xml:"InputDataConfig"` + JobName string `json:"jobName" xml:"JobName"` + NumberOfTopics int32 `json:"numberOfTopics" xml:"NumberOfTopics"` + OutputDataConfig *OutputDataConfig `json:"outputDataConfig" xml:"OutputDataConfig"` + Tags TagList `json:"tags" xml:"Tags"` + VolumeKmsKeyId string `json:"volumeKmsKeyId" xml:"VolumeKmsKeyId"` + VpcConfig *VpcConfig `json:"vpcConfig" xml:"VpcConfig"` +} + +type StartTopicsDetectionJobResponse struct { + JobArn string `json:"jobArn" xml:"JobArn"` + JobId string `json:"jobId" xml:"JobId"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` +} + +type StopDominantLanguageDetectionJobRequest struct { + JobId string `json:"jobId" xml:"JobId"` +} + +type StopDominantLanguageDetectionJobResponse struct { + JobId string `json:"jobId" xml:"JobId"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` +} + +type StopEntitiesDetectionJobRequest struct { + JobId string `json:"jobId" xml:"JobId"` +} + +type StopEntitiesDetectionJobResponse struct { + JobId string `json:"jobId" xml:"JobId"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` +} + +type StopEventsDetectionJobRequest struct { + JobId string `json:"jobId" xml:"JobId"` +} + +type StopEventsDetectionJobResponse struct { + JobId string `json:"jobId" xml:"JobId"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` +} + +type StopKeyPhrasesDetectionJobRequest struct { + JobId string `json:"jobId" xml:"JobId"` +} + +type StopKeyPhrasesDetectionJobResponse struct { + JobId string `json:"jobId" xml:"JobId"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` +} + +type StopPiiEntitiesDetectionJobRequest struct { + JobId string `json:"jobId" xml:"JobId"` +} + +type StopPiiEntitiesDetectionJobResponse struct { + JobId string `json:"jobId" xml:"JobId"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` +} + +type StopSentimentDetectionJobRequest struct { + JobId string `json:"jobId" xml:"JobId"` +} + +type StopSentimentDetectionJobResponse struct { + JobId string `json:"jobId" xml:"JobId"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` +} + +type StopTargetedSentimentDetectionJobRequest struct { + JobId string `json:"jobId" xml:"JobId"` +} + +type StopTargetedSentimentDetectionJobResponse struct { + JobId string `json:"jobId" xml:"JobId"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` +} + +type StopTrainingDocumentClassifierRequest struct { + DocumentClassifierArn string `json:"documentClassifierArn" xml:"DocumentClassifierArn"` +} + +type StopTrainingDocumentClassifierResponse struct { +} + +type StopTrainingEntityRecognizerRequest struct { + EntityRecognizerArn string `json:"entityRecognizerArn" xml:"EntityRecognizerArn"` +} + +type StopTrainingEntityRecognizerResponse struct { +} + +type SyntaxToken struct { + BeginOffset int32 `json:"beginOffset" xml:"BeginOffset"` + EndOffset int32 `json:"endOffset" xml:"EndOffset"` + PartOfSpeech *PartOfSpeechTag `json:"partOfSpeech" xml:"PartOfSpeech"` + Text string `json:"text" xml:"Text"` + TokenId int32 `json:"tokenId" xml:"TokenId"` +} + +type Tag struct { + Key string `json:"key" xml:"Key"` + Value string `json:"value" xml:"Value"` +} + +type TagResourceRequest struct { + ResourceArn string `json:"resourceArn" xml:"ResourceArn"` + Tags TagList `json:"tags" xml:"Tags"` +} + +type TagResourceResponse struct { +} + +type TargetedSentimentDetectionJobFilter struct { + JobName string `json:"jobName" xml:"JobName"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` + SubmitTimeAfter time.Time `json:"submitTimeAfter" xml:"SubmitTimeAfter"` + SubmitTimeBefore time.Time `json:"submitTimeBefore" xml:"SubmitTimeBefore"` +} + +type TargetedSentimentDetectionJobProperties struct { + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + EndTime time.Time `json:"endTime" xml:"EndTime"` + InputDataConfig *InputDataConfig `json:"inputDataConfig" xml:"InputDataConfig"` + JobArn string `json:"jobArn" xml:"JobArn"` + JobId string `json:"jobId" xml:"JobId"` + JobName string `json:"jobName" xml:"JobName"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` + LanguageCode string `json:"languageCode" xml:"LanguageCode"` + Message string `json:"message" xml:"Message"` + OutputDataConfig *OutputDataConfig `json:"outputDataConfig" xml:"OutputDataConfig"` + SubmitTime time.Time `json:"submitTime" xml:"SubmitTime"` + VolumeKmsKeyId string `json:"volumeKmsKeyId" xml:"VolumeKmsKeyId"` + VpcConfig *VpcConfig `json:"vpcConfig" xml:"VpcConfig"` +} + +type TargetedSentimentEntity struct { + DescriptiveMentionIndex ListOfDescriptiveMentionIndices `json:"descriptiveMentionIndex" xml:"DescriptiveMentionIndex"` + Mentions ListOfMentions `json:"mentions" xml:"Mentions"` +} + +type TargetedSentimentMention struct { + BeginOffset int32 `json:"beginOffset" xml:"BeginOffset"` + EndOffset int32 `json:"endOffset" xml:"EndOffset"` + GroupScore float32 `json:"groupScore" xml:"GroupScore"` + MentionSentiment *MentionSentiment `json:"mentionSentiment" xml:"MentionSentiment"` + Score float32 `json:"score" xml:"Score"` + Text string `json:"text" xml:"Text"` + Type string `json:"type" xml:"Type"` +} + +type TaskConfig struct { + DocumentClassificationConfig *DocumentClassificationConfig `json:"documentClassificationConfig" xml:"DocumentClassificationConfig"` + EntityRecognitionConfig *EntityRecognitionConfig `json:"entityRecognitionConfig" xml:"EntityRecognitionConfig"` + LanguageCode string `json:"languageCode" xml:"LanguageCode"` +} + +type TextSegment struct { + Text string `json:"text" xml:"Text"` +} + +type TopicsDetectionJobFilter struct { + JobName string `json:"jobName" xml:"JobName"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` + SubmitTimeAfter time.Time `json:"submitTimeAfter" xml:"SubmitTimeAfter"` + SubmitTimeBefore time.Time `json:"submitTimeBefore" xml:"SubmitTimeBefore"` +} + +type TopicsDetectionJobProperties struct { + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + EndTime time.Time `json:"endTime" xml:"EndTime"` + InputDataConfig *InputDataConfig `json:"inputDataConfig" xml:"InputDataConfig"` + JobArn string `json:"jobArn" xml:"JobArn"` + JobId string `json:"jobId" xml:"JobId"` + JobName string `json:"jobName" xml:"JobName"` + JobStatus string `json:"jobStatus" xml:"JobStatus"` + Message string `json:"message" xml:"Message"` + NumberOfTopics int32 `json:"numberOfTopics" xml:"NumberOfTopics"` + OutputDataConfig *OutputDataConfig `json:"outputDataConfig" xml:"OutputDataConfig"` + SubmitTime time.Time `json:"submitTime" xml:"SubmitTime"` + VolumeKmsKeyId string `json:"volumeKmsKeyId" xml:"VolumeKmsKeyId"` + VpcConfig *VpcConfig `json:"vpcConfig" xml:"VpcConfig"` +} + +type ToxicContent struct { + Name string `json:"name" xml:"Name"` + Score float32 `json:"score" xml:"Score"` +} + +type ToxicLabels struct { + Labels ListOfToxicContent `json:"labels" xml:"Labels"` + Toxicity float32 `json:"toxicity" xml:"Toxicity"` +} + +type UntagResourceRequest struct { + ResourceArn string `json:"resourceArn" xml:"ResourceArn"` + TagKeys TagKeyList `json:"tagKeys" xml:"TagKeys"` +} + +type UntagResourceResponse struct { +} + +type UpdateDataSecurityConfig struct { + ModelKmsKeyId string `json:"modelKmsKeyId" xml:"ModelKmsKeyId"` + VolumeKmsKeyId string `json:"volumeKmsKeyId" xml:"VolumeKmsKeyId"` + VpcConfig *VpcConfig `json:"vpcConfig" xml:"VpcConfig"` +} + +type UpdateEndpointRequest struct { + DesiredDataAccessRoleArn string `json:"desiredDataAccessRoleArn" xml:"DesiredDataAccessRoleArn"` + DesiredInferenceUnits int32 `json:"desiredInferenceUnits" xml:"DesiredInferenceUnits"` + DesiredModelArn string `json:"desiredModelArn" xml:"DesiredModelArn"` + EndpointArn string `json:"endpointArn" xml:"EndpointArn"` + FlywheelArn string `json:"flywheelArn" xml:"FlywheelArn"` +} + +type UpdateEndpointResponse struct { + DesiredModelArn string `json:"desiredModelArn" xml:"DesiredModelArn"` +} + +type UpdateFlywheelRequest struct { + ActiveModelArn string `json:"activeModelArn" xml:"ActiveModelArn"` + DataAccessRoleArn string `json:"dataAccessRoleArn" xml:"DataAccessRoleArn"` + DataSecurityConfig *UpdateDataSecurityConfig `json:"dataSecurityConfig" xml:"DataSecurityConfig"` + FlywheelArn string `json:"flywheelArn" xml:"FlywheelArn"` +} + +type UpdateFlywheelResponse struct { + FlywheelProperties *FlywheelProperties `json:"flywheelProperties" xml:"FlywheelProperties"` +} + +type VpcConfig struct { + SecurityGroupIds SecurityGroupIds `json:"securityGroupIds" xml:"SecurityGroupIds"` + Subnets Subnets `json:"subnets" xml:"Subnets"` +} + +type WarningsListItem struct { + Page int32 `json:"page" xml:"Page"` + WarnCode string `json:"warnCode" xml:"WarnCode"` + WarnMessage string `json:"warnMessage" xml:"WarnMessage"` +} + +type AttributeNamesList []string + +type BatchItemErrorList []*BatchItemError + +type CustomerInputStringList []string + +type DatasetAugmentedManifestsList []*DatasetAugmentedManifestsListItem + +type DatasetPropertiesList []*DatasetProperties + +type DocumentClassificationJobPropertiesList []*DocumentClassificationJobProperties + +type DocumentClassifierAugmentedManifestsList []*AugmentedManifestsListItem + +type DocumentClassifierPropertiesList []*DocumentClassifierProperties + +type DocumentClassifierSummariesList []*DocumentClassifierSummary + +type DominantLanguageDetectionJobPropertiesList []*DominantLanguageDetectionJobProperties + +type EndpointPropertiesList []*EndpointProperties + +type EntitiesDetectionJobPropertiesList []*EntitiesDetectionJobProperties + +type EntityRecognizerAugmentedManifestsList []*AugmentedManifestsListItem + +type EntityRecognizerMetadataEntityTypesList []*EntityRecognizerMetadataEntityTypesListItem + +type EntityRecognizerPropertiesList []*EntityRecognizerProperties + +type EntityRecognizerSummariesList []*EntityRecognizerSummary + +type EntityTypesList []*EntityTypesListItem + +type EventsDetectionJobPropertiesList []*EventsDetectionJobProperties + +type FlywheelIterationPropertiesList []*FlywheelIterationProperties + +type FlywheelSummaryList []*FlywheelSummary + +type KeyPhrasesDetectionJobPropertiesList []*KeyPhrasesDetectionJobProperties + +type LabelsList []string + +type ListOfBlockReferences []*BlockReference + +type ListOfBlocks []*Block + +type ListOfChildBlocks []*ChildBlock + +type ListOfClasses []*DocumentClass + +type ListOfDescriptiveMentionIndices []int32 + +type ListOfDetectDominantLanguageResult []*BatchDetectDominantLanguageItemResult + +type ListOfDetectEntitiesResult []*BatchDetectEntitiesItemResult + +type ListOfDetectKeyPhrasesResult []*BatchDetectKeyPhrasesItemResult + +type ListOfDetectSentimentResult []*BatchDetectSentimentItemResult + +type ListOfDetectSyntaxResult []*BatchDetectSyntaxItemResult + +type ListOfDetectTargetedSentimentResult []*BatchDetectTargetedSentimentItemResult + +type ListOfDocumentReadFeatureTypes []string + +type ListOfDocumentType []*DocumentTypeListItem + +type ListOfDominantLanguages []*DominantLanguage + +type ListOfEntities []*Entity + +type ListOfEntityLabels []*EntityLabel + +type ListOfErrors []*ErrorsListItem + +type ListOfExtractedCharacters []*ExtractedCharactersListItem + +type ListOfKeyPhrases []*KeyPhrase + +type ListOfLabels []*DocumentLabel + +type ListOfMentions []*TargetedSentimentMention + +type ListOfPiiEntities []*PiiEntity + +type ListOfPiiEntityTypes []string + +type ListOfRelationships []*RelationshipsListItem + +type ListOfSyntaxTokens []*SyntaxToken + +type ListOfTargetedSentimentEntities []*TargetedSentimentEntity + +type ListOfTextSegments []*TextSegment + +type ListOfToxicContent []*ToxicContent + +type ListOfToxicLabels []*ToxicLabels + +type ListOfWarnings []*WarningsListItem + +type PiiEntitiesDetectionJobPropertiesList []*PiiEntitiesDetectionJobProperties + +type Polygon []*Point + +type SecurityGroupIds []string + +type SentimentDetectionJobPropertiesList []*SentimentDetectionJobProperties + +type StringList []string + +type Subnets []string + +type TagKeyList []string + +type TagList []*Tag + +type TargetEventTypes []string + +type TargetedSentimentDetectionJobPropertiesList []*TargetedSentimentDetectionJobProperties + +type TopicsDetectionJobPropertiesList []*TopicsDetectionJobProperties diff --git a/internal/generated/crudregistry/registry_gen.go b/internal/generated/crudregistry/registry_gen.go index a1d13e83..e690e32d 100644 --- a/internal/generated/crudregistry/registry_gen.go +++ b/internal/generated/crudregistry/registry_gen.go @@ -587,6 +587,57 @@ func init() { "UpdateUserPoolClient": {Verb: "Update", Resource: "UserPoolClient", OutputListKey: "", OutputItemKey: "UserPoolClient"}, "UpdateUserPoolDomain": {Verb: "Update", Resource: "UserPoolDomain", OutputListKey: "", OutputItemKey: ""}, }) + crud.Register("comprehend", map[string]crud.OpMeta{ + "CreateDataset": {Verb: "Create", Resource: "Dataset", OutputListKey: "", OutputItemKey: ""}, + "CreateDocumentClassifier": {Verb: "Create", Resource: "DocumentClassifier", OutputListKey: "", OutputItemKey: ""}, + "CreateEndpoint": {Verb: "Create", Resource: "Endpoint", OutputListKey: "", OutputItemKey: ""}, + "CreateEntityRecognizer": {Verb: "Create", Resource: "EntityRecognizer", OutputListKey: "", OutputItemKey: ""}, + "CreateFlywheel": {Verb: "Create", Resource: "Flywheel", OutputListKey: "", OutputItemKey: ""}, + "DeleteDocumentClassifier": {Verb: "Delete", Resource: "DocumentClassifier", OutputListKey: "", OutputItemKey: ""}, + "DeleteEndpoint": {Verb: "Delete", Resource: "Endpoint", OutputListKey: "", OutputItemKey: ""}, + "DeleteEntityRecognizer": {Verb: "Delete", Resource: "EntityRecognizer", OutputListKey: "", OutputItemKey: ""}, + "DeleteFlywheel": {Verb: "Delete", Resource: "Flywheel", OutputListKey: "", OutputItemKey: ""}, + "DeleteResourcePolicy": {Verb: "Delete", Resource: "ResourcePolicy", OutputListKey: "", OutputItemKey: ""}, + "DescribeDataset": {Verb: "Get", Resource: "Dataset", OutputListKey: "", OutputItemKey: "DatasetProperties"}, + "DescribeDocumentClassificationJob": {Verb: "Get", Resource: "DocumentClassificationJob", OutputListKey: "", OutputItemKey: "DocumentClassificationJobProperties"}, + "DescribeDocumentClassifier": {Verb: "Get", Resource: "DocumentClassifier", OutputListKey: "", OutputItemKey: "DocumentClassifierProperties"}, + "DescribeDominantLanguageDetectionJob": {Verb: "Get", Resource: "DominantLanguageDetectionJob", OutputListKey: "", OutputItemKey: "DominantLanguageDetectionJobProperties"}, + "DescribeEndpoint": {Verb: "Get", Resource: "Endpoint", OutputListKey: "", OutputItemKey: "EndpointProperties"}, + "DescribeEntitiesDetectionJob": {Verb: "Get", Resource: "EntitiesDetectionJob", OutputListKey: "", OutputItemKey: "EntitiesDetectionJobProperties"}, + "DescribeEntityRecognizer": {Verb: "Get", Resource: "EntityRecognizer", OutputListKey: "", OutputItemKey: "EntityRecognizerProperties"}, + "DescribeEventsDetectionJob": {Verb: "Get", Resource: "EventsDetectionJob", OutputListKey: "", OutputItemKey: "EventsDetectionJobProperties"}, + "DescribeFlywheel": {Verb: "Get", Resource: "Flywheel", OutputListKey: "", OutputItemKey: "FlywheelProperties"}, + "DescribeFlywheelIteration": {Verb: "Get", Resource: "FlywheelIteration", OutputListKey: "", OutputItemKey: "FlywheelIterationProperties"}, + "DescribeKeyPhrasesDetectionJob": {Verb: "Get", Resource: "KeyPhrasesDetectionJob", OutputListKey: "", OutputItemKey: "KeyPhrasesDetectionJobProperties"}, + "DescribePiiEntitiesDetectionJob": {Verb: "Get", Resource: "PiiEntitiesDetectionJob", OutputListKey: "", OutputItemKey: "PiiEntitiesDetectionJobProperties"}, + "DescribeResourcePolicy": {Verb: "Get", Resource: "ResourcePolicy", OutputListKey: "", OutputItemKey: ""}, + "DescribeSentimentDetectionJob": {Verb: "Get", Resource: "SentimentDetectionJob", OutputListKey: "", OutputItemKey: "SentimentDetectionJobProperties"}, + "DescribeTargetedSentimentDetectionJob": {Verb: "Get", Resource: "TargetedSentimentDetectionJob", OutputListKey: "", OutputItemKey: "TargetedSentimentDetectionJobProperties"}, + "DescribeTopicsDetectionJob": {Verb: "Get", Resource: "TopicsDetectionJob", OutputListKey: "", OutputItemKey: "TopicsDetectionJobProperties"}, + "ListDatasets": {Verb: "List", Resource: "Dataset", OutputListKey: "DatasetPropertiesList", OutputItemKey: ""}, + "ListDocumentClassificationJobs": {Verb: "List", Resource: "DocumentClassificationJob", OutputListKey: "DocumentClassificationJobPropertiesList", OutputItemKey: ""}, + "ListDocumentClassifierSummaries": {Verb: "List", Resource: "DocumentClassifierSummary", OutputListKey: "DocumentClassifierSummariesList", OutputItemKey: ""}, + "ListDocumentClassifiers": {Verb: "List", Resource: "DocumentClassifier", OutputListKey: "DocumentClassifierPropertiesList", OutputItemKey: ""}, + "ListDominantLanguageDetectionJobs": {Verb: "List", Resource: "DominantLanguageDetectionJob", OutputListKey: "DominantLanguageDetectionJobPropertiesList", OutputItemKey: ""}, + "ListEndpoints": {Verb: "List", Resource: "Endpoint", OutputListKey: "EndpointPropertiesList", OutputItemKey: ""}, + "ListEntitiesDetectionJobs": {Verb: "List", Resource: "EntitiesDetectionJob", OutputListKey: "EntitiesDetectionJobPropertiesList", OutputItemKey: ""}, + "ListEntityRecognizerSummaries": {Verb: "List", Resource: "EntityRecognizerSummary", OutputListKey: "EntityRecognizerSummariesList", OutputItemKey: ""}, + "ListEntityRecognizers": {Verb: "List", Resource: "EntityRecognizer", OutputListKey: "EntityRecognizerPropertiesList", OutputItemKey: ""}, + "ListEventsDetectionJobs": {Verb: "List", Resource: "EventsDetectionJob", OutputListKey: "EventsDetectionJobPropertiesList", OutputItemKey: ""}, + "ListFlywheelIterationHistory": {Verb: "List", Resource: "FlywheelIterationHistory", OutputListKey: "FlywheelIterationPropertiesList", OutputItemKey: ""}, + "ListFlywheels": {Verb: "List", Resource: "Flywheel", OutputListKey: "FlywheelSummaryList", OutputItemKey: ""}, + "ListKeyPhrasesDetectionJobs": {Verb: "List", Resource: "KeyPhrasesDetectionJob", OutputListKey: "KeyPhrasesDetectionJobPropertiesList", OutputItemKey: ""}, + "ListPiiEntitiesDetectionJobs": {Verb: "List", Resource: "PiiEntitiesDetectionJob", OutputListKey: "PiiEntitiesDetectionJobPropertiesList", OutputItemKey: ""}, + "ListSentimentDetectionJobs": {Verb: "List", Resource: "SentimentDetectionJob", OutputListKey: "SentimentDetectionJobPropertiesList", OutputItemKey: ""}, + "ListTagsForResource": {Verb: "List", Resource: "TagsForResource", OutputListKey: "Tags", OutputItemKey: ""}, + "ListTargetedSentimentDetectionJobs": {Verb: "List", Resource: "TargetedSentimentDetectionJob", OutputListKey: "TargetedSentimentDetectionJobPropertiesList", OutputItemKey: ""}, + "ListTopicsDetectionJobs": {Verb: "List", Resource: "TopicsDetectionJob", OutputListKey: "TopicsDetectionJobPropertiesList", OutputItemKey: ""}, + "PutResourcePolicy": {Verb: "Update", Resource: "ResourcePolicy", OutputListKey: "", OutputItemKey: ""}, + "TagResource": {Verb: "Tag", Resource: "Resource", OutputListKey: "", OutputItemKey: ""}, + "UntagResource": {Verb: "Untag", Resource: "Resource", OutputListKey: "", OutputItemKey: ""}, + "UpdateEndpoint": {Verb: "Update", Resource: "Endpoint", OutputListKey: "", OutputItemKey: ""}, + "UpdateFlywheel": {Verb: "Update", Resource: "Flywheel", OutputListKey: "", OutputItemKey: "FlywheelProperties"}, + }) crud.Register("configservice", map[string]crud.OpMeta{ "BatchGetAggregateResourceConfig": {Verb: "List", Resource: "AggregateResourceConfig", OutputListKey: "BaseConfigurationItems", OutputItemKey: ""}, "BatchGetResourceConfig": {Verb: "List", Resource: "ResourceConfig", OutputListKey: "baseConfigurationItems", OutputItemKey: ""}, diff --git a/internal/generated/fidelity/manifest_gen.go b/internal/generated/fidelity/manifest_gen.go index a28cfb62..7e59d5da 100644 --- a/internal/generated/fidelity/manifest_gen.go +++ b/internal/generated/fidelity/manifest_gen.go @@ -1861,6 +1861,93 @@ var Services = map[string]Service{ "VerifySoftwareToken": TierUnimplemented, "VerifyUserAttribute": TierUnimplemented, }}, + "comprehend": {ModelBacked: true, Operations: map[string]Tier{ + "BatchDetectDominantLanguage": TierUnimplemented, + "BatchDetectEntities": TierUnimplemented, + "BatchDetectKeyPhrases": TierUnimplemented, + "BatchDetectSentiment": TierUnimplemented, + "BatchDetectSyntax": TierUnimplemented, + "BatchDetectTargetedSentiment": TierUnimplemented, + "ClassifyDocument": TierUnimplemented, + "ContainsPiiEntities": TierUnimplemented, + "CreateDataset": TierAutoCRUD, + "CreateDocumentClassifier": TierAutoCRUD, + "CreateEndpoint": TierAutoCRUD, + "CreateEntityRecognizer": TierAutoCRUD, + "CreateFlywheel": TierAutoCRUD, + "DeleteDocumentClassifier": TierAutoCRUD, + "DeleteEndpoint": TierAutoCRUD, + "DeleteEntityRecognizer": TierAutoCRUD, + "DeleteFlywheel": TierAutoCRUD, + "DeleteResourcePolicy": TierAutoCRUD, + "DescribeDataset": TierAutoCRUD, + "DescribeDocumentClassificationJob": TierAutoCRUD, + "DescribeDocumentClassifier": TierAutoCRUD, + "DescribeDominantLanguageDetectionJob": TierAutoCRUD, + "DescribeEndpoint": TierAutoCRUD, + "DescribeEntitiesDetectionJob": TierAutoCRUD, + "DescribeEntityRecognizer": TierAutoCRUD, + "DescribeEventsDetectionJob": TierAutoCRUD, + "DescribeFlywheel": TierAutoCRUD, + "DescribeFlywheelIteration": TierAutoCRUD, + "DescribeKeyPhrasesDetectionJob": TierAutoCRUD, + "DescribePiiEntitiesDetectionJob": TierAutoCRUD, + "DescribeResourcePolicy": TierAutoCRUD, + "DescribeSentimentDetectionJob": TierAutoCRUD, + "DescribeTargetedSentimentDetectionJob": TierAutoCRUD, + "DescribeTopicsDetectionJob": TierAutoCRUD, + "DetectDominantLanguage": TierUnimplemented, + "DetectEntities": TierUnimplemented, + "DetectKeyPhrases": TierUnimplemented, + "DetectPiiEntities": TierUnimplemented, + "DetectSentiment": TierUnimplemented, + "DetectSyntax": TierUnimplemented, + "DetectTargetedSentiment": TierUnimplemented, + "DetectToxicContent": TierUnimplemented, + "ImportModel": TierUnimplemented, + "ListDatasets": TierAutoCRUD, + "ListDocumentClassificationJobs": TierAutoCRUD, + "ListDocumentClassifierSummaries": TierAutoCRUD, + "ListDocumentClassifiers": TierAutoCRUD, + "ListDominantLanguageDetectionJobs": TierAutoCRUD, + "ListEndpoints": TierAutoCRUD, + "ListEntitiesDetectionJobs": TierAutoCRUD, + "ListEntityRecognizerSummaries": TierAutoCRUD, + "ListEntityRecognizers": TierAutoCRUD, + "ListEventsDetectionJobs": TierAutoCRUD, + "ListFlywheelIterationHistory": TierAutoCRUD, + "ListFlywheels": TierAutoCRUD, + "ListKeyPhrasesDetectionJobs": TierAutoCRUD, + "ListPiiEntitiesDetectionJobs": TierAutoCRUD, + "ListSentimentDetectionJobs": TierAutoCRUD, + "ListTagsForResource": TierAutoCRUD, + "ListTargetedSentimentDetectionJobs": TierAutoCRUD, + "ListTopicsDetectionJobs": TierAutoCRUD, + "PutResourcePolicy": TierAutoCRUD, + "StartDocumentClassificationJob": TierUnimplemented, + "StartDominantLanguageDetectionJob": TierUnimplemented, + "StartEntitiesDetectionJob": TierUnimplemented, + "StartEventsDetectionJob": TierUnimplemented, + "StartFlywheelIteration": TierUnimplemented, + "StartKeyPhrasesDetectionJob": TierUnimplemented, + "StartPiiEntitiesDetectionJob": TierUnimplemented, + "StartSentimentDetectionJob": TierUnimplemented, + "StartTargetedSentimentDetectionJob": TierUnimplemented, + "StartTopicsDetectionJob": TierUnimplemented, + "StopDominantLanguageDetectionJob": TierUnimplemented, + "StopEntitiesDetectionJob": TierUnimplemented, + "StopEventsDetectionJob": TierUnimplemented, + "StopKeyPhrasesDetectionJob": TierUnimplemented, + "StopPiiEntitiesDetectionJob": TierUnimplemented, + "StopSentimentDetectionJob": TierUnimplemented, + "StopTargetedSentimentDetectionJob": TierUnimplemented, + "StopTrainingDocumentClassifier": TierUnimplemented, + "StopTrainingEntityRecognizer": TierUnimplemented, + "TagResource": TierAutoCRUD, + "UntagResource": TierAutoCRUD, + "UpdateEndpoint": TierAutoCRUD, + "UpdateFlywheel": TierAutoCRUD, + }}, "configservice": {ModelBacked: true, Operations: map[string]Tier{ "AssociateResourceTypes": TierUnimplemented, "BatchGetAggregateResourceConfig": TierAutoCRUD, diff --git a/internal/services/comprehend/provider.go b/internal/services/comprehend/provider.go new file mode 100644 index 00000000..11bf076a --- /dev/null +++ b/internal/services/comprehend/provider.go @@ -0,0 +1,53 @@ +// SPDX-License-Identifier: Apache-2.0 + +package comprehend + +import ( + "context" + "net/http" + + generated "github.com/skyoo2003/devcloud/internal/generated/comprehend" + "github.com/skyoo2003/devcloud/internal/plugin" +) + +// Provider implements the Comprehend_20171127 service. +type Provider struct { + generated.BaseProvider + dataDir string +} + +func (p *Provider) ServiceID() string { return "comprehend" } +func (p *Provider) ServiceName() string { return "Comprehend_20171127" } +func (p *Provider) Protocol() plugin.ProtocolType { return plugin.ProtocolJSON11 } + +func (p *Provider) Init(cfg plugin.PluginConfig) error { + p.dataDir = cfg.DataDir + return nil +} + +func (p *Provider) Shutdown(ctx context.Context) error { + return nil +} + +// HandleRequest implements nothing by hand and says so, which is what hands the +// request to the generic CRUD engine (see docs/crud-engine.md). A scaffolded +// service therefore serves its CRUD-shaped operations from the moment it is +// generated; anything the engine cannot classify still returns an honest +// InvalidAction rather than a fabricated success. +// +// Declining any other way — including generated.ErrNotImplemented — is a plain +// refusal the gateway never routes to the engine, leaving the service +// registered, routed, and serving zero operations. +func (p *Provider) HandleRequest(ctx context.Context, op string, req *http.Request) (*plugin.Response, error) { + return nil, plugin.ErrUnhandledOp +} + +func (p *Provider) ListResources(ctx context.Context) ([]plugin.Resource, error) { + return []plugin.Resource{}, nil +} + +func init() { + plugin.DefaultRegistry.Register("comprehend", func() plugin.ServicePlugin { + return &Provider{} + }) +} diff --git a/smithy-models/comprehend.json b/smithy-models/comprehend.json new file mode 100644 index 00000000..09e3be8d --- /dev/null +++ b/smithy-models/comprehend.json @@ -0,0 +1,13893 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.comprehend#AnyLengthString": { + "type": "string" + }, + "com.amazonaws.comprehend#AttributeNamesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#AttributeNamesListItem" + } + }, + "com.amazonaws.comprehend#AttributeNamesListItem": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.comprehend#AugmentedManifestsDocumentTypeFormat": { + "type": "enum", + "members": { + "PLAIN_TEXT_DOCUMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLAIN_TEXT_DOCUMENT" + } + }, + "SEMI_STRUCTURED_DOCUMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEMI_STRUCTURED_DOCUMENT" + } + } + } + }, + "com.amazonaws.comprehend#AugmentedManifestsListItem": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 location of the augmented manifest file.

", + "smithy.api#required": {} + } + }, + "Split": { + "target": "com.amazonaws.comprehend#Split", + "traits": { + "smithy.api#documentation": "

The purpose of the data you've provided in the augmented manifest. You can either train or\n test this data. If you don't specify, the default is train.

\n

TRAIN - all of the documents in the manifest will be used for training. If no test\n documents are provided, Amazon Comprehend will automatically reserve a portion of the training\n documents for testing.

\n

TEST - all of the documents in the manifest will be used for testing.

" + } + }, + "AttributeNames": { + "target": "com.amazonaws.comprehend#AttributeNamesList", + "traits": { + "smithy.api#documentation": "

The JSON attribute that contains the annotations for your training documents. The number\n of attribute names that you specify depends on whether your augmented manifest file is the\n output of a single labeling job or a chained labeling job.

\n

If your file is the output of a single labeling job, specify the LabelAttributeName key\n that was used when the job was created in Ground Truth.

\n

If your file is the output of a chained labeling job, specify the LabelAttributeName key\n for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from\n an individual job.

", + "smithy.api#required": {} + } + }, + "AnnotationDataS3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

The S3 prefix to the annotation files that are referred in the augmented manifest\n file.

" + } + }, + "SourceDocumentsS3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest\n file.

" + } + }, + "DocumentType": { + "target": "com.amazonaws.comprehend#AugmentedManifestsDocumentTypeFormat", + "traits": { + "smithy.api#documentation": "

The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't\n specify, the default is PlainTextDocument.

\n
    \n
  • \n

    \n PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that\n is encoded in UTF-8.

    \n
    • \n
  • \n

    \n SEMI_STRUCTURED_DOCUMENT A document type with positional and structural\n context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For\n inference, Amazon Comprehend support PDFs, DOCX and TXT.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

An augmented manifest file that provides training data for your custom model. An augmented\n manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

" + } + }, + "com.amazonaws.comprehend#BatchDetectDominantLanguage": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#BatchDetectDominantLanguageRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#BatchDetectDominantLanguageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#BatchSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Determines the dominant language of the input text for a batch of documents. For a list\n of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.\n

" + } + }, + "com.amazonaws.comprehend#BatchDetectDominantLanguageItemResult": { + "type": "structure", + "members": { + "Index": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The zero-based index of the document in the input list.

" + } + }, + "Languages": { + "target": "com.amazonaws.comprehend#ListOfDominantLanguages", + "traits": { + "smithy.api#documentation": "

One or more DominantLanguage objects describing the dominant\n languages in the document.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The result of calling the operation.\n The operation returns one object for each document that is successfully processed by the\n operation.

" + } + }, + "com.amazonaws.comprehend#BatchDetectDominantLanguageRequest": { + "type": "structure", + "members": { + "TextList": { + "target": "com.amazonaws.comprehend#CustomerInputStringList", + "traits": { + "smithy.api#documentation": "

A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25\n documents. Each document should contain at least 20 characters. The maximum size of each document is 5 KB.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#BatchDetectDominantLanguageResponse": { + "type": "structure", + "members": { + "ResultList": { + "target": "com.amazonaws.comprehend#ListOfDetectDominantLanguageResult", + "traits": { + "smithy.api#documentation": "

A list of objects\n containing the results of the operation. The results are sorted in ascending order by the\n Index field and match the order of the documents in the input list. If all of\n the documents contain an error, the ResultList is empty.

", + "smithy.api#required": {} + } + }, + "ErrorList": { + "target": "com.amazonaws.comprehend#BatchItemErrorList", + "traits": { + "smithy.api#documentation": "

A list containing one object for each document\n that contained an error. The results are sorted in ascending order by the Index\n field and match the order of the documents in the input list. If there are no errors in the\n batch, the ErrorList is empty.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.comprehend#BatchDetectEntities": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#BatchDetectEntitiesRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#BatchDetectEntitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#BatchSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + } + ], + "traits": { + "smithy.api#documentation": "

Inspects the text of a batch of documents for named entities and returns information\n about them. For more information about named entities, see\n Entities in the Comprehend Developer Guide.\n

" + } + }, + "com.amazonaws.comprehend#BatchDetectEntitiesItemResult": { + "type": "structure", + "members": { + "Index": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The zero-based index of the document in the input list.

" + } + }, + "Entities": { + "target": "com.amazonaws.comprehend#ListOfEntities", + "traits": { + "smithy.api#documentation": "

One or more Entity objects, one for each entity detected in the\n document.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The result of calling the operation. The\n operation returns one object for each document that is successfully processed by the\n operation.

" + } + }, + "com.amazonaws.comprehend#BatchDetectEntitiesRequest": { + "type": "structure", + "members": { + "TextList": { + "target": "com.amazonaws.comprehend#CustomerInputStringList", + "traits": { + "smithy.api#documentation": "

A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25\n documents. The maximum size of each document is 5 KB.

", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#BatchDetectEntitiesResponse": { + "type": "structure", + "members": { + "ResultList": { + "target": "com.amazonaws.comprehend#ListOfDetectEntitiesResult", + "traits": { + "smithy.api#documentation": "

A list of objects containing the\n results of the operation. The results are sorted in ascending order by the Index\n field and match the order of the documents in the input list. If all of the documents contain\n an error, the ResultList is empty.

", + "smithy.api#required": {} + } + }, + "ErrorList": { + "target": "com.amazonaws.comprehend#BatchItemErrorList", + "traits": { + "smithy.api#documentation": "

A list containing one object for each document\n that contained an error. The results are sorted in ascending order by the Index\n field and match the order of the documents in the input list. If there are no errors in the\n batch, the ErrorList is empty.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.comprehend#BatchDetectKeyPhrases": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#BatchDetectKeyPhrasesRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#BatchDetectKeyPhrasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#BatchSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + } + ], + "traits": { + "smithy.api#documentation": "

Detects the key noun phrases found in a batch of documents.

" + } + }, + "com.amazonaws.comprehend#BatchDetectKeyPhrasesItemResult": { + "type": "structure", + "members": { + "Index": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The zero-based index of the document in the input list.

" + } + }, + "KeyPhrases": { + "target": "com.amazonaws.comprehend#ListOfKeyPhrases", + "traits": { + "smithy.api#documentation": "

One or more KeyPhrase objects, one for each key phrase detected in\n the document.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The result of calling the operation. The\n operation returns one object for each document that is successfully processed by the\n operation.

" + } + }, + "com.amazonaws.comprehend#BatchDetectKeyPhrasesRequest": { + "type": "structure", + "members": { + "TextList": { + "target": "com.amazonaws.comprehend#CustomerInputStringList", + "traits": { + "smithy.api#documentation": "

A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25\n documents. The maximum size of each document is 5 KB.

", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#BatchDetectKeyPhrasesResponse": { + "type": "structure", + "members": { + "ResultList": { + "target": "com.amazonaws.comprehend#ListOfDetectKeyPhrasesResult", + "traits": { + "smithy.api#documentation": "

A list of objects containing the\n results of the operation. The results are sorted in ascending order by the Index\n field and match the order of the documents in the input list. If all of the documents contain\n an error, the ResultList is empty.

", + "smithy.api#required": {} + } + }, + "ErrorList": { + "target": "com.amazonaws.comprehend#BatchItemErrorList", + "traits": { + "smithy.api#documentation": "

A list containing one object for each document\n that contained an error. The results are sorted in ascending order by the Index\n field and match the order of the documents in the input list. If there are no errors in the\n batch, the ErrorList is empty.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.comprehend#BatchDetectSentiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#BatchDetectSentimentRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#BatchDetectSentimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#BatchSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + } + ], + "traits": { + "smithy.api#documentation": "

Inspects a batch of documents and returns an inference of the prevailing sentiment,\n POSITIVE, NEUTRAL, MIXED, or NEGATIVE,\n in each one.

" + } + }, + "com.amazonaws.comprehend#BatchDetectSentimentItemResult": { + "type": "structure", + "members": { + "Index": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The zero-based index of the document in the input list.

" + } + }, + "Sentiment": { + "target": "com.amazonaws.comprehend#SentimentType", + "traits": { + "smithy.api#documentation": "

The sentiment detected in the document.

" + } + }, + "SentimentScore": { + "target": "com.amazonaws.comprehend#SentimentScore", + "traits": { + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of its sentiment\n detection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The result of calling the operation. The\n operation returns one object for each document that is successfully processed by the\n operation.

" + } + }, + "com.amazonaws.comprehend#BatchDetectSentimentRequest": { + "type": "structure", + "members": { + "TextList": { + "target": "com.amazonaws.comprehend#CustomerInputStringList", + "traits": { + "smithy.api#documentation": "

A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25\n documents. The maximum size of each document is 5 KB.

", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#BatchDetectSentimentResponse": { + "type": "structure", + "members": { + "ResultList": { + "target": "com.amazonaws.comprehend#ListOfDetectSentimentResult", + "traits": { + "smithy.api#documentation": "

A list of objects containing the\n results of the operation. The results are sorted in ascending order by the Index\n field and match the order of the documents in the input list. If all of the documents contain\n an error, the ResultList is empty.

", + "smithy.api#required": {} + } + }, + "ErrorList": { + "target": "com.amazonaws.comprehend#BatchItemErrorList", + "traits": { + "smithy.api#documentation": "

A list containing one object for each document\n that contained an error. The results are sorted in ascending order by the Index\n field and match the order of the documents in the input list. If there are no errors in the\n batch, the ErrorList is empty.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.comprehend#BatchDetectSyntax": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#BatchDetectSyntaxRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#BatchDetectSyntaxResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#BatchSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + } + ], + "traits": { + "smithy.api#documentation": "

Inspects the text of a batch of documents for the syntax and part of speech of the words\n in the document and returns information about them. For more information, see\n Syntax in the Comprehend Developer Guide.\n

" + } + }, + "com.amazonaws.comprehend#BatchDetectSyntaxItemResult": { + "type": "structure", + "members": { + "Index": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The zero-based index of the document in the input list.

" + } + }, + "SyntaxTokens": { + "target": "com.amazonaws.comprehend#ListOfSyntaxTokens", + "traits": { + "smithy.api#documentation": "

The syntax tokens for the words in the document, one token for each word.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The result of calling the operation. The\n operation returns one object that is successfully processed by the operation.

" + } + }, + "com.amazonaws.comprehend#BatchDetectSyntaxRequest": { + "type": "structure", + "members": { + "TextList": { + "target": "com.amazonaws.comprehend#CustomerInputStringList", + "traits": { + "smithy.api#documentation": "

A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25\n documents. The maximum size for each document is 5 KB.

", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#SyntaxLanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input documents. You can specify any of the following languages\n supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"),\n Italian (\"it\"), or Portuguese (\"pt\"). All documents must be in the same language.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#BatchDetectSyntaxResponse": { + "type": "structure", + "members": { + "ResultList": { + "target": "com.amazonaws.comprehend#ListOfDetectSyntaxResult", + "traits": { + "smithy.api#documentation": "

A list of objects containing the\n results of the operation. The results are sorted in ascending order by the Index\n field and match the order of the documents in the input list. If all of the documents contain\n an error, the ResultList is empty.

", + "smithy.api#required": {} + } + }, + "ErrorList": { + "target": "com.amazonaws.comprehend#BatchItemErrorList", + "traits": { + "smithy.api#documentation": "

A list containing one object for each document that\n contained an error. The results are sorted in ascending order by the Index field\n and match the order of the documents in the input list. If there are no errors in the batch,\n the ErrorList is empty.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.comprehend#BatchDetectTargetedSentiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#BatchDetectTargetedSentimentRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#BatchDetectTargetedSentimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#BatchSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + } + ], + "traits": { + "smithy.api#documentation": "

Inspects a batch of documents and returns a sentiment analysis\n for each entity identified in the documents.

\n

For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.

" + } + }, + "com.amazonaws.comprehend#BatchDetectTargetedSentimentItemResult": { + "type": "structure", + "members": { + "Index": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The zero-based index of this result in the input list.

" + } + }, + "Entities": { + "target": "com.amazonaws.comprehend#ListOfTargetedSentimentEntities", + "traits": { + "smithy.api#documentation": "

An array of targeted sentiment entities.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Analysis results for one of the documents in the batch.

" + } + }, + "com.amazonaws.comprehend#BatchDetectTargetedSentimentRequest": { + "type": "structure", + "members": { + "TextList": { + "target": "com.amazonaws.comprehend#CustomerInputStringList", + "traits": { + "smithy.api#documentation": "

A list containing the UTF-8 encoded text of the input documents.\n The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.

", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input documents. Currently, English is the only supported language.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#BatchDetectTargetedSentimentResponse": { + "type": "structure", + "members": { + "ResultList": { + "target": "com.amazonaws.comprehend#ListOfDetectTargetedSentimentResult", + "traits": { + "smithy.api#documentation": "

A list of objects containing the results of the operation.\n The results are sorted in ascending order by the Index field and match the order of the documents in the input list.\n If all of the documents contain an error, the ResultList is empty.

", + "smithy.api#required": {} + } + }, + "ErrorList": { + "target": "com.amazonaws.comprehend#BatchItemErrorList", + "traits": { + "smithy.api#documentation": "

List of errors that the operation can return.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.comprehend#BatchItemError": { + "type": "structure", + "members": { + "Index": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The zero-based index of the document in the input list.

" + } + }, + "ErrorCode": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

The numeric error code of the error.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

A text description of the error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an error that occurred while processing a document in a batch. The operation\n returns on BatchItemError object for each document that contained an\n error.

" + } + }, + "com.amazonaws.comprehend#BatchItemErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#BatchItemError" + } + }, + "com.amazonaws.comprehend#BatchSizeLimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.comprehend#String" + } + }, + "traits": { + "smithy.api#documentation": "

The number of documents in the request exceeds the limit of 25. Try your request again\n with fewer documents.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.comprehend#Block": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Unique identifier for the block.

" + } + }, + "BlockType": { + "target": "com.amazonaws.comprehend#BlockType", + "traits": { + "smithy.api#documentation": "

The block represents a line of text or one word of text.

\n
    \n
  • \n

    WORD - A word that's detected on a document page.\n A word is one or more ISO basic Latin script characters that aren't separated by spaces.

    \n
    • \n
  • \n

    LINE - A string of tab-delimited, contiguous words\n that are detected on a document page

    \n
    • \n
" + } + }, + "Text": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

The word or line of text extracted from the block.

" + } + }, + "Page": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Page number where the block appears.

" + } + }, + "Geometry": { + "target": "com.amazonaws.comprehend#Geometry", + "traits": { + "smithy.api#documentation": "

Co-ordinates of the rectangle or polygon that contains the text.

" + } + }, + "Relationships": { + "target": "com.amazonaws.comprehend#ListOfRelationships", + "traits": { + "smithy.api#documentation": "

A list of child blocks of the current block.\n For example, a LINE object has child blocks for each WORD block that's part of the line of text.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about each word or line of text in the input document.

\n

For additional information, see Block in the Amazon Textract API reference.

" + } + }, + "com.amazonaws.comprehend#BlockReference": { + "type": "structure", + "members": { + "BlockId": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Unique identifier for the block.

" + } + }, + "BeginOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Offset of the start of the block within its parent block.

" + } + }, + "EndOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Offset of the end of the block within its parent block.

" + } + }, + "ChildBlocks": { + "target": "com.amazonaws.comprehend#ListOfChildBlocks", + "traits": { + "smithy.api#documentation": "

List of child blocks within this block.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A reference to a block.

" + } + }, + "com.amazonaws.comprehend#BlockType": { + "type": "enum", + "members": { + "LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINE" + } + }, + "WORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WORD" + } + } + } + }, + "com.amazonaws.comprehend#BoundingBox": { + "type": "structure", + "members": { + "Height": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The height of the bounding box as a ratio of the overall document page height.

" + } + }, + "Left": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The left coordinate of the bounding box as a ratio of overall document page width.

" + } + }, + "Top": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The top coordinate of the bounding box as a ratio of overall document page height.

" + } + }, + "Width": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The width of the bounding box as a ratio of the overall document page width.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The bounding box around the detected page\n or around an element on a document page.\n The left (x-coordinate) and top (y-coordinate) are coordinates that\n represent the top and left sides of the bounding box. Note that the upper-left\n corner of the image is the origin (0,0).

\n

For additional information, see BoundingBox in the Amazon Textract API reference.

" + } + }, + "com.amazonaws.comprehend#ChildBlock": { + "type": "structure", + "members": { + "ChildBlockId": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Unique identifier for the child block.

" + } + }, + "BeginOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Offset of the start of the child block within its parent block.

" + } + }, + "EndOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Offset of the end of the child block within its parent block.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Nested block contained within a block.

" + } + }, + "com.amazonaws.comprehend#ClassifierEvaluationMetrics": { + "type": "structure", + "members": { + "Accuracy": { + "target": "com.amazonaws.comprehend#Double", + "traits": { + "smithy.api#documentation": "

The fraction of the labels that were correct recognized. It is computed by dividing the\n number of labels in the test documents that were correctly recognized by the total number of\n labels in the test documents.

" + } + }, + "Precision": { + "target": "com.amazonaws.comprehend#Double", + "traits": { + "smithy.api#documentation": "

A measure of the usefulness of the classifier results in the test data. High precision\n means that the classifier returned substantially more relevant results than irrelevant\n ones.

" + } + }, + "Recall": { + "target": "com.amazonaws.comprehend#Double", + "traits": { + "smithy.api#documentation": "

A measure of how complete the classifier results are for the test data. High recall means\n that the classifier returned most of the relevant results.

" + } + }, + "F1Score": { + "target": "com.amazonaws.comprehend#Double", + "traits": { + "smithy.api#documentation": "

A measure of how accurate the classifier results are for the test data. It is derived from\n the Precision and Recall values. The F1Score is the\n harmonic average of the two scores. The highest score is 1, and the worst score is 0.

" + } + }, + "MicroPrecision": { + "target": "com.amazonaws.comprehend#Double", + "traits": { + "smithy.api#documentation": "

A measure of the usefulness of the recognizer results in the test data. High precision\n means that the recognizer returned substantially more relevant results than irrelevant ones.\n Unlike the Precision metric which comes from averaging the precision of all available labels,\n this is based on the overall score of all precision scores added together.

" + } + }, + "MicroRecall": { + "target": "com.amazonaws.comprehend#Double", + "traits": { + "smithy.api#documentation": "

A measure of how complete the classifier results are for the test data. High recall means\n that the classifier returned most of the relevant results. Specifically, this indicates how\n many of the correct categories in the text that the model can predict. It is a percentage of\n correct categories in the text that can found. Instead of averaging the recall scores of all\n labels (as with Recall), micro Recall is based on the overall score of all recall scores added\n together.

" + } + }, + "MicroF1Score": { + "target": "com.amazonaws.comprehend#Double", + "traits": { + "smithy.api#documentation": "

A measure of how accurate the classifier results are for the test data. It is a\n combination of the Micro Precision and Micro Recall values. The\n Micro F1Score is the harmonic mean of the two scores. The highest score is 1,\n and the worst score is 0.

" + } + }, + "HammingLoss": { + "target": "com.amazonaws.comprehend#Double", + "traits": { + "smithy.api#documentation": "

Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction\n of wrong labels compared to the total number of labels. Scores closer to zero are\n better.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the result metrics for the test data associated with an documentation\n classifier.

" + } + }, + "com.amazonaws.comprehend#ClassifierMetadata": { + "type": "structure", + "members": { + "NumberOfLabels": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The number of labels in the input data.

" + } + }, + "NumberOfTrainedDocuments": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The number of documents in the input data that were used to train the classifier.\n Typically this is 80 to 90 percent of the input documents.

" + } + }, + "NumberOfTestDocuments": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The number of documents in the input data that were used to test the classifier. Typically\n this is 10 to 20 percent of the input documents, up to 10,000 documents.

" + } + }, + "EvaluationMetrics": { + "target": "com.amazonaws.comprehend#ClassifierEvaluationMetrics", + "traits": { + "smithy.api#documentation": "

Describes the result metrics for the test data associated with an documentation\n classifier.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a document classifier.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.comprehend#ClassifyDocument": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ClassifyDocumentRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ClassifyDocumentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a classification request to analyze a single document in real-time. ClassifyDocument \n supports the following model types:

\n
    \n
  • \n

    Custom classifier - a custom model that you have created and trained. \n For input, you can provide plain text, a single-page document (PDF, Word, or image), or \n Amazon Textract API output. For more information, see Custom classification in the Amazon Comprehend Developer Guide.

    \n
    • \n
  • \n

    Prompt safety classifier - Amazon Comprehend provides a pre-trained model for classifying \n input prompts for generative AI applications. \n For input, you provide English plain text input.\n For prompt safety classification, the response includes only the Classes field.\n For more information about prompt safety classifiers, see Prompt safety classification in the Amazon Comprehend Developer Guide.

    \n
    • \n
\n

If the system detects errors while processing a page in the input document,\n the API response includes an Errors field that describes the errors.

\n

If the system detects a document-level error in your input document, the API returns an\n InvalidRequestException error response.\n For details about this exception, see\n \n Errors in semi-structured documents in the Comprehend Developer Guide.\n

" + } + }, + "com.amazonaws.comprehend#ClassifyDocumentRequest": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.comprehend#CustomerInputString", + "traits": { + "smithy.api#documentation": "

The document text to be analyzed. If you enter text using this parameter,\n do not use the Bytes parameter.

" + } + }, + "EndpointArn": { + "target": "com.amazonaws.comprehend#DocumentClassifierEndpointArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the endpoint.

\n

For prompt safety classification, Amazon Comprehend provides the endpoint ARN. For more information about prompt safety classifiers, see Prompt safety classification in the Amazon Comprehend Developer Guide\n

\n

For custom classification, you create an endpoint for your custom model. For more information, \n see Using Amazon Comprehend endpoints.

", + "smithy.api#required": {} + } + }, + "Bytes": { + "target": "com.amazonaws.comprehend#SemiStructuredDocumentBlob", + "traits": { + "smithy.api#documentation": "

Use the Bytes parameter to input a text, PDF, Word or image file.

\n

When you classify a document using a custom model, you can also use the Bytes parameter to input an Amazon Textract DetectDocumentText\n or AnalyzeDocument output file.

\n

To classify a document using the prompt safety classifier, use the Text parameter for input.

\n

Provide the input document as a sequence of base64-encoded bytes.\n If your code uses an Amazon Web Services SDK to classify documents, the SDK may encode\n the document file bytes for you.

\n

The maximum length of this field depends on the input document type. For details, see\n \n Inputs for real-time custom analysis in the Comprehend Developer Guide.

\n

If you use the Bytes parameter, do not use the Text parameter.

" + } + }, + "DocumentReaderConfig": { + "target": "com.amazonaws.comprehend#DocumentReaderConfig", + "traits": { + "smithy.api#documentation": "

Provides configuration parameters to override the default actions for extracting text\n from PDF documents and image files.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ClassifyDocumentResponse": { + "type": "structure", + "members": { + "Classes": { + "target": "com.amazonaws.comprehend#ListOfClasses", + "traits": { + "smithy.api#documentation": "

The classes used by the document being analyzed. These are used for models trained in multi-class mode.\n Individual classes are mutually exclusive and each document is expected to have only a\n single class assigned to it. For example, an animal can be a dog or a cat, but not both at the\n same time.

\n

For prompt safety classification, the response includes only two classes (SAFE_PROMPT and UNSAFE_PROMPT), \n along with a confidence score for each class. The value range of the score is zero to one, where one is the highest confidence.

" + } + }, + "Labels": { + "target": "com.amazonaws.comprehend#ListOfLabels", + "traits": { + "smithy.api#documentation": "

The labels used in the document being analyzed. These are used for multi-label trained\n models. Individual labels represent different categories that are related in some manner and\n are not mutually exclusive. For example, a movie can be just an action movie, or it can be an\n action movie, a science fiction movie, and a comedy, all at the same time.

" + } + }, + "DocumentMetadata": { + "target": "com.amazonaws.comprehend#DocumentMetadata", + "traits": { + "smithy.api#documentation": "

Extraction information about the document. This field is present\n in the response only if your request includes the Byte parameter.

" + } + }, + "DocumentType": { + "target": "com.amazonaws.comprehend#ListOfDocumentType", + "traits": { + "smithy.api#documentation": "

The document type for each page in the input document. This field is present\n in the response only if your request includes the Byte parameter.

" + } + }, + "Errors": { + "target": "com.amazonaws.comprehend#ListOfErrors", + "traits": { + "smithy.api#documentation": "

Page-level errors that the system detected while processing the input document.\n The field is empty if the system encountered no errors.

" + } + }, + "Warnings": { + "target": "com.amazonaws.comprehend#ListOfWarnings", + "traits": { + "smithy.api#documentation": "

Warnings detected while processing the input document.\n The response includes a warning if there is a mismatch between the input document type \n and the model type associated with the endpoint that you specified. The response can also include\n warnings for individual pages that have a mismatch.

\n

The field is empty if the system generated no warnings.

" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.comprehend#ClientRequestTokenString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.comprehend#ComprehendArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-]{1,64}/[a-zA-Z0-9](-*[a-zA-Z0-9])*((/dataset/[a-zA-Z0-9](-*[a-zA-Z0-9])*)|(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*))?$" + } + }, + "com.amazonaws.comprehend#ComprehendArnName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.comprehend#ComprehendDatasetArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel/[a-zA-Z0-9](-*[a-zA-Z0-9])*/dataset/[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.comprehend#ComprehendEndpointArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document-classifier-endpoint|entity-recognizer-endpoint)/[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.comprehend#ComprehendEndpointName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 40 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.comprehend#ComprehendFlywheelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel/[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.comprehend#ComprehendModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document-classifier|entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?$" + } + }, + "com.amazonaws.comprehend#Comprehend_20171127": { + "type": "service", + "version": "2017-11-27", + "operations": [ + { + "target": "com.amazonaws.comprehend#BatchDetectDominantLanguage" + }, + { + "target": "com.amazonaws.comprehend#BatchDetectEntities" + }, + { + "target": "com.amazonaws.comprehend#BatchDetectKeyPhrases" + }, + { + "target": "com.amazonaws.comprehend#BatchDetectSentiment" + }, + { + "target": "com.amazonaws.comprehend#BatchDetectSyntax" + }, + { + "target": "com.amazonaws.comprehend#BatchDetectTargetedSentiment" + }, + { + "target": "com.amazonaws.comprehend#ClassifyDocument" + }, + { + "target": "com.amazonaws.comprehend#ContainsPiiEntities" + }, + { + "target": "com.amazonaws.comprehend#CreateDataset" + }, + { + "target": "com.amazonaws.comprehend#CreateDocumentClassifier" + }, + { + "target": "com.amazonaws.comprehend#CreateEndpoint" + }, + { + "target": "com.amazonaws.comprehend#CreateEntityRecognizer" + }, + { + "target": "com.amazonaws.comprehend#CreateFlywheel" + }, + { + "target": "com.amazonaws.comprehend#DeleteDocumentClassifier" + }, + { + "target": "com.amazonaws.comprehend#DeleteEndpoint" + }, + { + "target": "com.amazonaws.comprehend#DeleteEntityRecognizer" + }, + { + "target": "com.amazonaws.comprehend#DeleteFlywheel" + }, + { + "target": "com.amazonaws.comprehend#DeleteResourcePolicy" + }, + { + "target": "com.amazonaws.comprehend#DescribeDataset" + }, + { + "target": "com.amazonaws.comprehend#DescribeDocumentClassificationJob" + }, + { + "target": "com.amazonaws.comprehend#DescribeDocumentClassifier" + }, + { + "target": "com.amazonaws.comprehend#DescribeDominantLanguageDetectionJob" + }, + { + "target": "com.amazonaws.comprehend#DescribeEndpoint" + }, + { + "target": "com.amazonaws.comprehend#DescribeEntitiesDetectionJob" + }, + { + "target": "com.amazonaws.comprehend#DescribeEntityRecognizer" + }, + { + "target": "com.amazonaws.comprehend#DescribeEventsDetectionJob" + }, + { + "target": "com.amazonaws.comprehend#DescribeFlywheel" + }, + { + "target": "com.amazonaws.comprehend#DescribeFlywheelIteration" + }, + { + "target": "com.amazonaws.comprehend#DescribeKeyPhrasesDetectionJob" + }, + { + "target": "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJob" + }, + { + "target": "com.amazonaws.comprehend#DescribeResourcePolicy" + }, + { + "target": "com.amazonaws.comprehend#DescribeSentimentDetectionJob" + }, + { + "target": "com.amazonaws.comprehend#DescribeTargetedSentimentDetectionJob" + }, + { + "target": "com.amazonaws.comprehend#DescribeTopicsDetectionJob" + }, + { + "target": "com.amazonaws.comprehend#DetectDominantLanguage" + }, + { + "target": "com.amazonaws.comprehend#DetectEntities" + }, + { + "target": "com.amazonaws.comprehend#DetectKeyPhrases" + }, + { + "target": "com.amazonaws.comprehend#DetectPiiEntities" + }, + { + "target": "com.amazonaws.comprehend#DetectSentiment" + }, + { + "target": "com.amazonaws.comprehend#DetectSyntax" + }, + { + "target": "com.amazonaws.comprehend#DetectTargetedSentiment" + }, + { + "target": "com.amazonaws.comprehend#DetectToxicContent" + }, + { + "target": "com.amazonaws.comprehend#ImportModel" + }, + { + "target": "com.amazonaws.comprehend#ListDatasets" + }, + { + "target": "com.amazonaws.comprehend#ListDocumentClassificationJobs" + }, + { + "target": "com.amazonaws.comprehend#ListDocumentClassifiers" + }, + { + "target": "com.amazonaws.comprehend#ListDocumentClassifierSummaries" + }, + { + "target": "com.amazonaws.comprehend#ListDominantLanguageDetectionJobs" + }, + { + "target": "com.amazonaws.comprehend#ListEndpoints" + }, + { + "target": "com.amazonaws.comprehend#ListEntitiesDetectionJobs" + }, + { + "target": "com.amazonaws.comprehend#ListEntityRecognizers" + }, + { + "target": "com.amazonaws.comprehend#ListEntityRecognizerSummaries" + }, + { + "target": "com.amazonaws.comprehend#ListEventsDetectionJobs" + }, + { + "target": "com.amazonaws.comprehend#ListFlywheelIterationHistory" + }, + { + "target": "com.amazonaws.comprehend#ListFlywheels" + }, + { + "target": "com.amazonaws.comprehend#ListKeyPhrasesDetectionJobs" + }, + { + "target": "com.amazonaws.comprehend#ListPiiEntitiesDetectionJobs" + }, + { + "target": "com.amazonaws.comprehend#ListSentimentDetectionJobs" + }, + { + "target": "com.amazonaws.comprehend#ListTagsForResource" + }, + { + "target": "com.amazonaws.comprehend#ListTargetedSentimentDetectionJobs" + }, + { + "target": "com.amazonaws.comprehend#ListTopicsDetectionJobs" + }, + { + "target": "com.amazonaws.comprehend#PutResourcePolicy" + }, + { + "target": "com.amazonaws.comprehend#StartDocumentClassificationJob" + }, + { + "target": "com.amazonaws.comprehend#StartDominantLanguageDetectionJob" + }, + { + "target": "com.amazonaws.comprehend#StartEntitiesDetectionJob" + }, + { + "target": "com.amazonaws.comprehend#StartEventsDetectionJob" + }, + { + "target": "com.amazonaws.comprehend#StartFlywheelIteration" + }, + { + "target": "com.amazonaws.comprehend#StartKeyPhrasesDetectionJob" + }, + { + "target": "com.amazonaws.comprehend#StartPiiEntitiesDetectionJob" + }, + { + "target": "com.amazonaws.comprehend#StartSentimentDetectionJob" + }, + { + "target": "com.amazonaws.comprehend#StartTargetedSentimentDetectionJob" + }, + { + "target": "com.amazonaws.comprehend#StartTopicsDetectionJob" + }, + { + "target": "com.amazonaws.comprehend#StopDominantLanguageDetectionJob" + }, + { + "target": "com.amazonaws.comprehend#StopEntitiesDetectionJob" + }, + { + "target": "com.amazonaws.comprehend#StopEventsDetectionJob" + }, + { + "target": "com.amazonaws.comprehend#StopKeyPhrasesDetectionJob" + }, + { + "target": "com.amazonaws.comprehend#StopPiiEntitiesDetectionJob" + }, + { + "target": "com.amazonaws.comprehend#StopSentimentDetectionJob" + }, + { + "target": "com.amazonaws.comprehend#StopTargetedSentimentDetectionJob" + }, + { + "target": "com.amazonaws.comprehend#StopTrainingDocumentClassifier" + }, + { + "target": "com.amazonaws.comprehend#StopTrainingEntityRecognizer" + }, + { + "target": "com.amazonaws.comprehend#TagResource" + }, + { + "target": "com.amazonaws.comprehend#UntagResource" + }, + { + "target": "com.amazonaws.comprehend#UpdateEndpoint" + }, + { + "target": "com.amazonaws.comprehend#UpdateFlywheel" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Comprehend", + "arnNamespace": "comprehend", + "cloudFormationName": "Comprehend", + "cloudTrailEventSource": "comprehend.amazonaws.com", + "endpointPrefix": "comprehend" + }, + "aws.auth#sigv4": { + "name": "comprehend" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

Amazon Comprehend is an Amazon Web Services service for gaining insight into the content of documents.\n Use these actions to determine the topics contained in your documents, the topics they\n discuss, the predominant sentiment expressed in them, the predominant language used, and\n more.

", + "smithy.api#title": "Amazon Comprehend", + "smithy.rules#endpointBdd": { + "version": "1.1", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "string" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "string" + } + }, + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + }, + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "results": [ + { + "conditions": [], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://comprehend-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "https://comprehend-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "https://comprehend.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "https://comprehend.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "root": 2, + "nodeCount": 13, + "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "string" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "string" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://comprehend-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://comprehend-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://comprehend.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://comprehend.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.comprehend#ConcurrentModificationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.comprehend#String" + } + }, + "traits": { + "smithy.api#documentation": "

Concurrent modification of the tags associated with an Amazon Comprehend resource is not\n supported.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.comprehend#ContainsPiiEntities": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ContainsPiiEntitiesRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ContainsPiiEntitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + } + ], + "traits": { + "smithy.api#documentation": "

Analyzes input text for the presence of personally identifiable information (PII) and\n returns the labels of identified PII entity types such as name, address, bank account number,\n or phone number.

" + } + }, + "com.amazonaws.comprehend#ContainsPiiEntitiesRequest": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

A UTF-8 text string. The maximum string size is 100 KB.

", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input documents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ContainsPiiEntitiesResponse": { + "type": "structure", + "members": { + "Labels": { + "target": "com.amazonaws.comprehend#ListOfEntityLabels", + "traits": { + "smithy.api#documentation": "

The labels used in the document being analyzed. Individual labels represent personally\n identifiable information (PII) entity types.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#CreateDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#CreateDatasetRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#CreateDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a dataset to upload training or test data for a model associated with a flywheel.\n For more information about datasets, see \n Flywheel overview in the Amazon Comprehend Developer Guide.

" + } + }, + "com.amazonaws.comprehend#CreateDatasetRequest": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the flywheel of the flywheel to receive the data.

", + "smithy.api#required": {} + } + }, + "DatasetName": { + "target": "com.amazonaws.comprehend#ComprehendArnName", + "traits": { + "smithy.api#documentation": "

Name of the dataset.

", + "smithy.api#required": {} + } + }, + "DatasetType": { + "target": "com.amazonaws.comprehend#DatasetType", + "traits": { + "smithy.api#documentation": "

The dataset type. You can specify that the data in a dataset is for training\n the model or for testing the model.

" + } + }, + "Description": { + "target": "com.amazonaws.comprehend#Description", + "traits": { + "smithy.api#documentation": "

Description of the dataset.

" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#DatasetInputDataConfig", + "traits": { + "smithy.api#documentation": "

Information about the input data configuration. The type of input data varies based\n on the format of the input and whether the data is for a classifier model or an entity recognition model.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.

", + "smithy.api#idempotencyToken": {} + } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags for the dataset.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#CreateDatasetResponse": { + "type": "structure", + "members": { + "DatasetArn": { + "target": "com.amazonaws.comprehend#ComprehendDatasetArn", + "traits": { + "smithy.api#documentation": "

The ARN of the dataset.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#CreateDocumentClassifier": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#CreateDocumentClassifierRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#CreateDocumentClassifierResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#KmsKeyValidationException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new document classifier that you can use to categorize documents. To create a\n classifier, you provide a set of training documents that are labeled with the categories that you\n want to use. For more information, see\n Training classifier models \n in the Comprehend Developer Guide.\n

" + } + }, + "com.amazonaws.comprehend#CreateDocumentClassifierRequest": { + "type": "structure", + "members": { + "DocumentClassifierName": { + "target": "com.amazonaws.comprehend#ComprehendArnName", + "traits": { + "smithy.api#documentation": "

The name of the document classifier.

", + "smithy.api#required": {} + } + }, + "VersionName": { + "target": "com.amazonaws.comprehend#VersionName", + "traits": { + "smithy.api#documentation": "

The version name given to the newly created classifier. Version names can have a maximum\n of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The\n version name must be unique among all models with the same classifier name in the Amazon Web Services account/Amazon Web Services Region.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to your input data.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags to associate with the document classifier. A tag is a key-value\n pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with\n \"Sales\" as the key might be added to a resource to indicate its use by the sales department.\n

" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#DocumentClassifierInputDataConfig", + "traits": { + "smithy.api#documentation": "

Specifies the format and location of the input data for the job.

", + "smithy.api#required": {} + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#DocumentClassifierOutputDataConfig", + "traits": { + "smithy.api#documentation": "

Specifies the location for the output files from a custom classifier job.\n This parameter is required for a request that creates a native document model.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.

", + "smithy.api#idempotencyToken": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input documents. You can specify any of the languages\n supported by Amazon Comprehend. All documents must be in the same language.

", + "smithy.api#required": {} + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", + "traits": { + "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your custom classifier. For more information, see Amazon\n VPC.

" + } + }, + "Mode": { + "target": "com.amazonaws.comprehend#DocumentClassifierMode", + "traits": { + "smithy.api#documentation": "

Indicates the mode in which the classifier will be trained. The classifier can be trained\n in multi-class (single-label) mode or multi-label mode. \n Multi-class mode identifies a single class label for each document and\n multi-label mode identifies one or more class labels for each document. Multiple\n labels for an individual document are separated by a delimiter. The default delimiter between\n labels is a pipe (|).

" + } + }, + "ModelKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the KMS key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "ModelPolicy": { + "target": "com.amazonaws.comprehend#Policy", + "traits": { + "smithy.api#documentation": "

The resource-based policy to attach to your custom document classifier model. You can use\n this policy to allow another Amazon Web Services account to import your custom model.

\n

Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line\n breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the\n JSON body is also enclosed in double quotes, then you must escape the double quotes that are\n inside the policy:

\n

\n \"{\\\"attribute\\\": \\\"value\\\", \\\"attribute\\\": [\\\"value\\\"]}\"\n

\n

To avoid escaping quotes, you can use single quotes to enclose the policy and double\n quotes to enclose the JSON names and values:

\n

\n '{\"attribute\": \"value\", \"attribute\": [\"value\"]}'\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#CreateDocumentClassifierResponse": { + "type": "structure", + "members": { + "DocumentClassifierArn": { + "target": "com.amazonaws.comprehend#DocumentClassifierArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the document classifier.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#CreateEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#CreateEndpointRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#CreateEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a model-specific endpoint for synchronous inference for a previously trained\n custom model \n For information about endpoints, see Managing endpoints.

" + } + }, + "com.amazonaws.comprehend#CreateEndpointRequest": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.comprehend#ComprehendEndpointName", + "traits": { + "smithy.api#documentation": "

This is the descriptive suffix that becomes part of the EndpointArn used for\n all subsequent requests to this resource.

", + "smithy.api#required": {} + } + }, + "ModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the model to which the endpoint will be\n attached.

" + } + }, + "DesiredInferenceUnits": { + "target": "com.amazonaws.comprehend#InferenceUnitsInteger", + "traits": { + "smithy.api#documentation": "

The desired number of inference units to be used by the model using this endpoint.\n \n Each inference unit represents of a throughput of 100 characters per second.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "

An idempotency token provided by the customer. If this token matches a previous endpoint\n creation request, Amazon Comprehend will not return a ResourceInUseException.\n

", + "smithy.api#idempotencyToken": {} + } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags to associate with the endpoint. A tag is a key-value pair that adds\n metadata to the endpoint. For example, a tag with \"Sales\" as the key might be added to an\n endpoint to indicate its use by the sales department.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to trained custom models encrypted with a customer\n managed key (ModelKmsKeyId).

" + } + }, + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be\n attached.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#CreateEndpointResponse": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.comprehend#ComprehendEndpointArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the endpoint being created.

" + } + }, + "ModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the model to which the endpoint is\n attached.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#CreateEntityRecognizer": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#CreateEntityRecognizerRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#CreateEntityRecognizerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#KmsKeyValidationException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an entity recognizer using submitted files. After your\n CreateEntityRecognizer request is submitted, you can check job status using the\n DescribeEntityRecognizer API.

" + } + }, + "com.amazonaws.comprehend#CreateEntityRecognizerRequest": { + "type": "structure", + "members": { + "RecognizerName": { + "target": "com.amazonaws.comprehend#ComprehendArnName", + "traits": { + "smithy.api#documentation": "

The name given to the newly created recognizer. Recognizer names can be a maximum of 256\n characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name\n must be unique in the account/Region.

", + "smithy.api#required": {} + } + }, + "VersionName": { + "target": "com.amazonaws.comprehend#VersionName", + "traits": { + "smithy.api#documentation": "

The version name given to the newly created recognizer. Version names can be a maximum of\n 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The\n version name must be unique among all models with the same recognizer name in the account/Region.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to your input data.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags to associate with the entity recognizer. A tag is a key-value pair\n that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with\n \"Sales\" as the key might be added to a resource to indicate its use by the sales department.\n

" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#EntityRecognizerInputDataConfig", + "traits": { + "smithy.api#documentation": "

Specifies the format and location of the input data. The S3 bucket containing the input\n data must be located in the same Region as the entity recognizer being created.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.

", + "smithy.api#idempotencyToken": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

You can specify any of the following languages: English\n (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), German (\"de\"), or Portuguese (\"pt\").\n If you plan to use this entity recognizer with PDF, Word, or image input files, you must\n specify English as the language.\n All training documents must be in the same language.

", + "smithy.api#required": {} + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", + "traits": { + "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your custom entity recognizer. For more information, see\n Amazon\n VPC.

" + } + }, + "ModelKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the KMS key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "ModelPolicy": { + "target": "com.amazonaws.comprehend#Policy", + "traits": { + "smithy.api#documentation": "

The JSON resource-based policy to attach to your custom entity recognizer model. You can\n use this policy to allow another Amazon Web Services account to import your custom model.

\n

Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for\n your policy, enclose the attribute names and values in double quotes. If the JSON body is also\n enclosed in double quotes, then you must escape the double quotes that are inside the\n policy:

\n

\n \"{\\\"attribute\\\": \\\"value\\\", \\\"attribute\\\": [\\\"value\\\"]}\"\n

\n

To avoid escaping quotes, you can use single quotes to enclose the policy and double\n quotes to enclose the JSON names and values:

\n

\n '{\"attribute\": \"value\", \"attribute\": [\"value\"]}'\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#CreateEntityRecognizerResponse": { + "type": "structure", + "members": { + "EntityRecognizerArn": { + "target": "com.amazonaws.comprehend#EntityRecognizerArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the entity recognizer.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#CreateFlywheel": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#CreateFlywheelRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#CreateFlywheelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#KmsKeyValidationException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + } + ], + "traits": { + "smithy.api#documentation": "

A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification\n or custom entity recognition. You can create a flywheel to start with an existing trained model, or\n Comprehend can create and train a new model.

\n

When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training\n data and test data for all versions of the model.

\n

To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's\n training data and test data into the flywheel's data lake.

\n

To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data)\n when you create the flywheel.

\n

For more information about flywheels, see \n Flywheel overview in the Amazon Comprehend Developer Guide.

" + } + }, + "com.amazonaws.comprehend#CreateFlywheelRequest": { + "type": "structure", + "members": { + "FlywheelName": { + "target": "com.amazonaws.comprehend#ComprehendArnName", + "traits": { + "smithy.api#documentation": "

Name for the flywheel.

", + "smithy.api#required": {} + } + }, + "ActiveModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version.\n Do not set TaskConfig or ModelType if you specify an ActiveModelArn.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend the permissions required to access the flywheel data in the data lake.

", + "smithy.api#required": {} + } + }, + "TaskConfig": { + "target": "com.amazonaws.comprehend#TaskConfig", + "traits": { + "smithy.api#documentation": "

Configuration about the model associated with the flywheel.\n You need to set TaskConfig if you are creating a flywheel for a new model.

" + } + }, + "ModelType": { + "target": "com.amazonaws.comprehend#ModelType", + "traits": { + "smithy.api#documentation": "

The model type. You need to set ModelType if you are creating a flywheel for a new model.

" + } + }, + "DataLakeS3Uri": { + "target": "com.amazonaws.comprehend#FlywheelS3Uri", + "traits": { + "smithy.api#documentation": "

Enter the S3 location for the data lake. You can specify a new S3 bucket or a new folder of an\n existing S3 bucket. The flywheel creates the data lake at this location.

", + "smithy.api#required": {} + } + }, + "DataSecurityConfig": { + "target": "com.amazonaws.comprehend#DataSecurityConfig", + "traits": { + "smithy.api#documentation": "

Data security configurations.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.

", + "smithy.api#idempotencyToken": {} + } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

The tags to associate with this flywheel.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#CreateFlywheelResponse": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the flywheel.

" + } + }, + "ActiveModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the active model version.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#CustomerInputString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.comprehend#CustomerInputStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#CustomerInputString" + }, + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.comprehend#DataSecurityConfig": { + "type": "structure", + "members": { + "ModelKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the KMS key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the KMS key that Amazon Comprehend uses to encrypt the volume.

" + } + }, + "DataLakeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the KMS key that Amazon Comprehend uses to encrypt the data in the data lake.

" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig" + } + }, + "traits": { + "smithy.api#documentation": "

Data security configuration.

" + } + }, + "com.amazonaws.comprehend#DatasetAugmentedManifestsList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#DatasetAugmentedManifestsListItem" + } + }, + "com.amazonaws.comprehend#DatasetAugmentedManifestsListItem": { + "type": "structure", + "members": { + "AttributeNames": { + "target": "com.amazonaws.comprehend#AttributeNamesList", + "traits": { + "smithy.api#documentation": "

The JSON attribute that contains the annotations for your training documents. The number\n of attribute names that you specify depends on whether your augmented manifest file is the\n output of a single labeling job or a chained labeling job.

\n

If your file is the output of a single labeling job, specify the LabelAttributeName key\n that was used when the job was created in Ground Truth.

\n

If your file is the output of a chained labeling job, specify the LabelAttributeName key\n for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from\n an individual job.

", + "smithy.api#required": {} + } + }, + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 location of the augmented manifest file.

", + "smithy.api#required": {} + } + }, + "AnnotationDataS3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

The S3 prefix to the annotation files that are referred in the augmented manifest\n file.

" + } + }, + "SourceDocumentsS3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest\n file.

" + } + }, + "DocumentType": { + "target": "com.amazonaws.comprehend#AugmentedManifestsDocumentTypeFormat", + "traits": { + "smithy.api#documentation": "

The type of augmented manifest. If you don't specify, the default is PlainTextDocument.

\n

\n PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that\n is encoded in UTF-8.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An augmented manifest file that provides training data for your custom model.\n An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

" + } + }, + "com.amazonaws.comprehend#DatasetDataFormat": { + "type": "enum", + "members": { + "COMPREHEND_CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPREHEND_CSV" + } + }, + "AUGMENTED_MANIFEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUGMENTED_MANIFEST" + } + } + } + }, + "com.amazonaws.comprehend#DatasetDocumentClassifierInputDataConfig": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI for the input data. The S3 bucket must be in the same Region as the API\n endpoint that you are calling. The URI can point to a single input file or it can provide the\n prefix for a collection of input files.

\n

For example, if you use the URI S3://bucketName/prefix, if the prefix is a\n single file, Amazon Comprehend uses that file as input. If more than one file begins with the\n prefix, Amazon Comprehend uses all of them as input.

\n

This parameter is required if you set DataFormat to\n COMPREHEND_CSV.

", + "smithy.api#required": {} + } + }, + "LabelDelimiter": { + "target": "com.amazonaws.comprehend#LabelDelimiter", + "traits": { + "smithy.api#documentation": "

Indicates the delimiter used to separate each label for training a multi-label classifier.\n The default delimiter between labels is a pipe (|). You can use a different character as a\n delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the\n training documents use a delimiter other than the default or the delimiter you specify, the\n labels on that line will be combined to make a single unique label, such as\n LABELLABELLABEL.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the dataset input data configuration for a document classifier model.

\n

For more information on how the input file is formatted, see Preparing training data\n in the Comprehend Developer Guide.

" + } + }, + "com.amazonaws.comprehend#DatasetEntityRecognizerAnnotations": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 location where the training documents for an entity recognizer\n are located. The URI must be in the same Region as the API endpoint that you are\n calling.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the annotations associated with a entity recognizer.

" + } + }, + "com.amazonaws.comprehend#DatasetEntityRecognizerDocuments": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 location where the documents for the dataset\n are located.

", + "smithy.api#required": {} + } + }, + "InputFormat": { + "target": "com.amazonaws.comprehend#InputFormat", + "traits": { + "smithy.api#documentation": "

Specifies how the text in an input file should be processed. This is optional, and the\n default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document.\n Use this option when you are processing large documents, such as newspaper articles or\n scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document.\n Use this option when you are processing many short documents, such as text messages.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the documents submitted with a dataset for an entity recognizer model.

" + } + }, + "com.amazonaws.comprehend#DatasetEntityRecognizerEntityList": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 location where the entity list is located.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the dataset entity list for an entity recognizer model.

\n

For more information on how the input file is formatted, see Preparing training data\n in the Comprehend Developer Guide.

" + } + }, + "com.amazonaws.comprehend#DatasetEntityRecognizerInputDataConfig": { + "type": "structure", + "members": { + "Annotations": { + "target": "com.amazonaws.comprehend#DatasetEntityRecognizerAnnotations", + "traits": { + "smithy.api#documentation": "

The S3 location of the annotation documents for your custom entity recognizer.

" + } + }, + "Documents": { + "target": "com.amazonaws.comprehend#DatasetEntityRecognizerDocuments", + "traits": { + "smithy.api#documentation": "

The format and location of the training documents for your custom entity\n recognizer.

", + "smithy.api#required": {} + } + }, + "EntityList": { + "target": "com.amazonaws.comprehend#DatasetEntityRecognizerEntityList", + "traits": { + "smithy.api#documentation": "

The S3 location of the entity list for your custom entity recognizer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the format and location of the input data. You must provide either the\n Annotations parameter or the EntityList parameter.

" + } + }, + "com.amazonaws.comprehend#DatasetFilter": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.comprehend#DatasetStatus", + "traits": { + "smithy.api#documentation": "

Filter the datasets based on the dataset status.

" + } + }, + "DatasetType": { + "target": "com.amazonaws.comprehend#DatasetType", + "traits": { + "smithy.api#documentation": "

Filter the datasets based on the dataset type.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filter the datasets to include datasets created after the specified time.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filter the datasets to include datasets created before the specified time.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Filter the datasets based on creation time or dataset status.

" + } + }, + "com.amazonaws.comprehend#DatasetInputDataConfig": { + "type": "structure", + "members": { + "AugmentedManifests": { + "target": "com.amazonaws.comprehend#DatasetAugmentedManifestsList", + "traits": { + "smithy.api#documentation": "

A list of augmented manifest files that provide training data for your custom model. An\n augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground\n Truth.

" + } + }, + "DataFormat": { + "target": "com.amazonaws.comprehend#DatasetDataFormat", + "traits": { + "smithy.api#documentation": "

\n COMPREHEND_CSV: The data format is a two-column CSV file, where the\n first column contains labels and the second column contains documents.

\n

\n AUGMENTED_MANIFEST: The data format

" + } + }, + "DocumentClassifierInputDataConfig": { + "target": "com.amazonaws.comprehend#DatasetDocumentClassifierInputDataConfig", + "traits": { + "smithy.api#documentation": "

The input properties for training a document classifier model.

\n

For more information on how the input file is formatted, see Preparing training data\n in the Comprehend Developer Guide.

" + } + }, + "EntityRecognizerInputDataConfig": { + "target": "com.amazonaws.comprehend#DatasetEntityRecognizerInputDataConfig", + "traits": { + "smithy.api#documentation": "

The input properties for training an entity recognizer model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the format and location of the input data for the dataset.

" + } + }, + "com.amazonaws.comprehend#DatasetProperties": { + "type": "structure", + "members": { + "DatasetArn": { + "target": "com.amazonaws.comprehend#ComprehendDatasetArn", + "traits": { + "smithy.api#documentation": "

The ARN of the dataset.

" + } + }, + "DatasetName": { + "target": "com.amazonaws.comprehend#ComprehendArnName", + "traits": { + "smithy.api#documentation": "

The name of the dataset.

" + } + }, + "DatasetType": { + "target": "com.amazonaws.comprehend#DatasetType", + "traits": { + "smithy.api#documentation": "

The dataset type (training data or test data).

" + } + }, + "DatasetS3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

The S3 URI where the dataset is stored.

" + } + }, + "Description": { + "target": "com.amazonaws.comprehend#Description", + "traits": { + "smithy.api#documentation": "

Description of the dataset.

" + } + }, + "Status": { + "target": "com.amazonaws.comprehend#DatasetStatus", + "traits": { + "smithy.api#documentation": "

The dataset status. While the system creates the dataset, the status is CREATING.\n When the dataset is ready to use, the status changes to COMPLETED.

" + } + }, + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", + "traits": { + "smithy.api#documentation": "

A description of the status of the dataset.

" + } + }, + "NumberOfDocuments": { + "target": "com.amazonaws.comprehend#NumberOfDocuments", + "traits": { + "smithy.api#documentation": "

The number of documents in the dataset.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Creation time of the dataset.

" + } + }, + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Time when the data from the dataset becomes available in the data lake.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Properties associated with the dataset.

" + } + }, + "com.amazonaws.comprehend#DatasetPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#DatasetProperties" + } + }, + "com.amazonaws.comprehend#DatasetStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.comprehend#DatasetType": { + "type": "enum", + "members": { + "TRAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAIN" + } + }, + "TEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEST" + } + } + } + }, + "com.amazonaws.comprehend#DeleteDocumentClassifier": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DeleteDocumentClassifierRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DeleteDocumentClassifierResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a previously created document classifier

\n

Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted.\n If an active inference job is using the model, a ResourceInUseException will be\n returned.

\n

This is an asynchronous action that puts the classifier into a DELETING state, and it is\n then removed by a background job. Once removed, the classifier disappears from your account\n and is no longer available for use.

" + } + }, + "com.amazonaws.comprehend#DeleteDocumentClassifierRequest": { + "type": "structure", + "members": { + "DocumentClassifierArn": { + "target": "com.amazonaws.comprehend#DocumentClassifierArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the document classifier.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DeleteDocumentClassifierResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DeleteEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DeleteEndpointRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DeleteEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a model-specific endpoint for a previously-trained custom model. All endpoints\n must be deleted in order for the model to be deleted.\n For information about endpoints, see Managing endpoints.

" + } + }, + "com.amazonaws.comprehend#DeleteEndpointRequest": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.comprehend#ComprehendEndpointArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the endpoint being deleted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DeleteEndpointResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DeleteEntityRecognizer": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DeleteEntityRecognizerRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DeleteEntityRecognizerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an entity recognizer.

\n

Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted.\n If an active inference job is using the model, a ResourceInUseException will be\n returned.

\n

This is an asynchronous action that puts the recognizer into a DELETING state, and it is\n then removed by a background job. Once removed, the recognizer disappears from your account\n and is no longer available for use.

" + } + }, + "com.amazonaws.comprehend#DeleteEntityRecognizerRequest": { + "type": "structure", + "members": { + "EntityRecognizerArn": { + "target": "com.amazonaws.comprehend#EntityRecognizerArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the entity recognizer.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DeleteEntityRecognizerResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DeleteFlywheel": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DeleteFlywheelRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DeleteFlywheelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a flywheel. When you delete the flywheel, Amazon Comprehend\n does not delete the data lake or the model associated with the flywheel.

\n

For more information about flywheels, see \n Flywheel overview in the Amazon Comprehend Developer Guide.

" + } + }, + "com.amazonaws.comprehend#DeleteFlywheelRequest": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the flywheel to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DeleteFlywheelResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DeleteResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DeleteResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a resource-based policy that is attached to a custom model.

" + } + }, + "com.amazonaws.comprehend#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom model version that has the policy to delete.

", + "smithy.api#required": {} + } + }, + "PolicyRevisionId": { + "target": "com.amazonaws.comprehend#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "

The revision ID of the policy to delete.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DeleteResourcePolicyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DescribeDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DescribeDatasetRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DescribeDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the dataset that you specify. \n For more information about datasets, see \n Flywheel overview in the Amazon Comprehend Developer Guide.

" + } + }, + "com.amazonaws.comprehend#DescribeDatasetRequest": { + "type": "structure", + "members": { + "DatasetArn": { + "target": "com.amazonaws.comprehend#ComprehendDatasetArn", + "traits": { + "smithy.api#documentation": "

The ARN of the dataset.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DescribeDatasetResponse": { + "type": "structure", + "members": { + "DatasetProperties": { + "target": "com.amazonaws.comprehend#DatasetProperties", + "traits": { + "smithy.api#documentation": "

The dataset properties.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DescribeDocumentClassificationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DescribeDocumentClassificationJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DescribeDocumentClassificationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#JobNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the properties associated with a document classification job. Use this operation to\n get the status of a classification job.

" + } + }, + "com.amazonaws.comprehend#DescribeDocumentClassificationJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier that Amazon Comprehend generated for the job. The \n StartDocumentClassificationJob operation returns this identifier in its response.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DescribeDocumentClassificationJobResponse": { + "type": "structure", + "members": { + "DocumentClassificationJobProperties": { + "target": "com.amazonaws.comprehend#DocumentClassificationJobProperties", + "traits": { + "smithy.api#documentation": "

An object that describes the properties associated with the document classification\n job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DescribeDocumentClassifier": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DescribeDocumentClassifierRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DescribeDocumentClassifierResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the properties associated with a document classifier.

" + } + }, + "com.amazonaws.comprehend#DescribeDocumentClassifierRequest": { + "type": "structure", + "members": { + "DocumentClassifierArn": { + "target": "com.amazonaws.comprehend#DocumentClassifierArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the document classifier. The \n CreateDocumentClassifier operation returns this identifier in its response.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DescribeDocumentClassifierResponse": { + "type": "structure", + "members": { + "DocumentClassifierProperties": { + "target": "com.amazonaws.comprehend#DocumentClassifierProperties", + "traits": { + "smithy.api#documentation": "

An object that contains the properties associated with a document classifier.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DescribeDominantLanguageDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DescribeDominantLanguageDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DescribeDominantLanguageDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#JobNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the properties associated with a dominant language detection job. Use this operation\n to get the status of a detection job.

" + } + }, + "com.amazonaws.comprehend#DescribeDominantLanguageDetectionJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier that Amazon Comprehend generated for the job. The \n StartDominantLanguageDetectionJob operation returns this identifier in its response.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DescribeDominantLanguageDetectionJobResponse": { + "type": "structure", + "members": { + "DominantLanguageDetectionJobProperties": { + "target": "com.amazonaws.comprehend#DominantLanguageDetectionJobProperties", + "traits": { + "smithy.api#documentation": "

An object that contains the properties associated with a dominant language detection\n job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DescribeEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DescribeEndpointRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DescribeEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the properties associated with a specific endpoint. Use this operation to get the\n status of an endpoint.\n For information about endpoints, see Managing endpoints.

" + } + }, + "com.amazonaws.comprehend#DescribeEndpointRequest": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.comprehend#ComprehendEndpointArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the endpoint being described.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DescribeEndpointResponse": { + "type": "structure", + "members": { + "EndpointProperties": { + "target": "com.amazonaws.comprehend#EndpointProperties", + "traits": { + "smithy.api#documentation": "

Describes information associated with the specific endpoint.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DescribeEntitiesDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DescribeEntitiesDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DescribeEntitiesDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#JobNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the properties associated with an entities detection job. Use this operation to get\n the status of a detection job.

" + } + }, + "com.amazonaws.comprehend#DescribeEntitiesDetectionJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier that Amazon Comprehend generated for the job. The \n StartEntitiesDetectionJob operation returns this identifier in its response.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DescribeEntitiesDetectionJobResponse": { + "type": "structure", + "members": { + "EntitiesDetectionJobProperties": { + "target": "com.amazonaws.comprehend#EntitiesDetectionJobProperties", + "traits": { + "smithy.api#documentation": "

An object that contains the properties associated with an entities detection job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DescribeEntityRecognizer": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DescribeEntityRecognizerRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DescribeEntityRecognizerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides details about an entity recognizer including status, S3 buckets containing\n training data, recognizer metadata, metrics, and so on.

" + } + }, + "com.amazonaws.comprehend#DescribeEntityRecognizerRequest": { + "type": "structure", + "members": { + "EntityRecognizerArn": { + "target": "com.amazonaws.comprehend#EntityRecognizerArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the entity recognizer.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DescribeEntityRecognizerResponse": { + "type": "structure", + "members": { + "EntityRecognizerProperties": { + "target": "com.amazonaws.comprehend#EntityRecognizerProperties", + "traits": { + "smithy.api#documentation": "

Describes information associated with an entity recognizer.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DescribeEventsDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DescribeEventsDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DescribeEventsDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#JobNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the status and details of an events detection job.

" + } + }, + "com.amazonaws.comprehend#DescribeEventsDetectionJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier of the events detection job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DescribeEventsDetectionJobResponse": { + "type": "structure", + "members": { + "EventsDetectionJobProperties": { + "target": "com.amazonaws.comprehend#EventsDetectionJobProperties", + "traits": { + "smithy.api#documentation": "

An object that contains the properties associated with an event detection job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DescribeFlywheel": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DescribeFlywheelRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DescribeFlywheelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides configuration information about the flywheel. For more information about flywheels, see \n Flywheel overview in the Amazon Comprehend Developer Guide.

" + } + }, + "com.amazonaws.comprehend#DescribeFlywheelIteration": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DescribeFlywheelIterationRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DescribeFlywheelIterationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieve the configuration properties of a flywheel iteration.\n For more information about flywheels, see \n Flywheel overview in the Amazon Comprehend Developer Guide.

" + } + }, + "com.amazonaws.comprehend#DescribeFlywheelIterationRequest": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "FlywheelIterationId": { + "target": "com.amazonaws.comprehend#FlywheelIterationId", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DescribeFlywheelIterationResponse": { + "type": "structure", + "members": { + "FlywheelIterationProperties": { + "target": "com.amazonaws.comprehend#FlywheelIterationProperties", + "traits": { + "smithy.api#documentation": "

The configuration properties of a flywheel iteration.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DescribeFlywheelRequest": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the flywheel.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DescribeFlywheelResponse": { + "type": "structure", + "members": { + "FlywheelProperties": { + "target": "com.amazonaws.comprehend#FlywheelProperties", + "traits": { + "smithy.api#documentation": "

The flywheel properties.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DescribeKeyPhrasesDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DescribeKeyPhrasesDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DescribeKeyPhrasesDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#JobNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the properties associated with a key phrases detection job. Use this operation to get\n the status of a detection job.

" + } + }, + "com.amazonaws.comprehend#DescribeKeyPhrasesDetectionJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier that Amazon Comprehend generated for the job. The \n StartKeyPhrasesDetectionJob operation returns this identifier in its\n response.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DescribeKeyPhrasesDetectionJobResponse": { + "type": "structure", + "members": { + "KeyPhrasesDetectionJobProperties": { + "target": "com.amazonaws.comprehend#KeyPhrasesDetectionJobProperties", + "traits": { + "smithy.api#documentation": "

An object that contains the properties associated with a key phrases detection job.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#JobNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the properties associated with a PII entities detection job. For example, you can use\n this operation to get the job status.

" + } + }, + "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its\n response.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJobResponse": { + "type": "structure", + "members": { + "PiiEntitiesDetectionJobProperties": { + "target": "com.amazonaws.comprehend#PiiEntitiesDetectionJobProperties" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DescribeResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DescribeResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DescribeResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the details of a resource-based policy that is attached to a custom model, including\n the JSON body of the policy.

" + } + }, + "com.amazonaws.comprehend#DescribeResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom model version that has the resource policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DescribeResourcePolicyResponse": { + "type": "structure", + "members": { + "ResourcePolicy": { + "target": "com.amazonaws.comprehend#Policy", + "traits": { + "smithy.api#documentation": "

The JSON body of the resource-based policy.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the policy was created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the policy was last modified.

" + } + }, + "PolicyRevisionId": { + "target": "com.amazonaws.comprehend#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "

The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a\n new revision ID, and it deletes the prior version of the policy.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DescribeSentimentDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DescribeSentimentDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DescribeSentimentDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#JobNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the properties associated with a sentiment detection job. Use this operation to get\n the status of a detection job.

" + } + }, + "com.amazonaws.comprehend#DescribeSentimentDetectionJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its\n response.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DescribeSentimentDetectionJobResponse": { + "type": "structure", + "members": { + "SentimentDetectionJobProperties": { + "target": "com.amazonaws.comprehend#SentimentDetectionJobProperties", + "traits": { + "smithy.api#documentation": "

An object that contains the properties associated with a sentiment detection job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DescribeTargetedSentimentDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DescribeTargetedSentimentDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DescribeTargetedSentimentDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#JobNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the properties associated with a targeted sentiment detection job. Use this operation\n to get the status of the job.

" + } + }, + "com.amazonaws.comprehend#DescribeTargetedSentimentDetectionJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier that Amazon Comprehend generated for the job. The \n StartTargetedSentimentDetectionJob operation returns this identifier in its\n response.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DescribeTargetedSentimentDetectionJobResponse": { + "type": "structure", + "members": { + "TargetedSentimentDetectionJobProperties": { + "target": "com.amazonaws.comprehend#TargetedSentimentDetectionJobProperties", + "traits": { + "smithy.api#documentation": "

An object that contains the properties associated with a targeted sentiment detection job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DescribeTopicsDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DescribeTopicsDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DescribeTopicsDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#JobNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the properties associated with a topic detection job. Use this operation to get\n the status of a detection job.

" + } + }, + "com.amazonaws.comprehend#DescribeTopicsDetectionJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier assigned by the user to the detection job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DescribeTopicsDetectionJobResponse": { + "type": "structure", + "members": { + "TopicsDetectionJobProperties": { + "target": "com.amazonaws.comprehend#TopicsDetectionJobProperties", + "traits": { + "smithy.api#documentation": "

The list of properties for the requested job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^([a-zA-Z0-9_])[\\\\a-zA-Z0-9_@#%*+=:?./!\\s-]*$" + } + }, + "com.amazonaws.comprehend#DetectDominantLanguage": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DetectDominantLanguageRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DetectDominantLanguageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Determines the dominant language of the input text. For a list of languages that Amazon\n Comprehend can detect, see Amazon Comprehend Supported Languages.

" + } + }, + "com.amazonaws.comprehend#DetectDominantLanguageRequest": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.comprehend#CustomerInputString", + "traits": { + "smithy.api#documentation": "

A UTF-8 text string. The string must contain at least 20 characters. The maximum string size is 100 KB.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DetectDominantLanguageResponse": { + "type": "structure", + "members": { + "Languages": { + "target": "com.amazonaws.comprehend#ListOfDominantLanguages", + "traits": { + "smithy.api#documentation": "

Array of languages that Amazon Comprehend detected in the input text. \n The array is sorted in descending order of the score \n (the dominant language is always the first element in the array).

\n

For each language, the\n response returns the RFC 5646 language code and the level of confidence that Amazon Comprehend\n has in the accuracy of its inference. For more information about RFC 5646, see Tags for Identifying Languages on the\n IETF Tools web site.

" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.comprehend#DetectEntities": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DetectEntitiesRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DetectEntitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + } + ], + "traits": { + "smithy.api#documentation": "

Detects named entities in input text when you use the pre-trained model.\n Detects custom entities if you have a custom entity recognition model.

\n

\n When detecting named entities using the pre-trained model, use plain text as the input.\n For more information about named entities, see\n Entities in the Comprehend Developer Guide.

\n

When you use a custom entity recognition model,\n you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).

\n

If the system detects errors while processing a page in the input document, the API response\n includes an entry in Errors for each error.

\n

If the system detects a document-level error in your input document, the API returns an\n InvalidRequestException error response.\n For details about this exception, see\n \n Errors in semi-structured documents in the Comprehend Developer Guide.\n

" + } + }, + "com.amazonaws.comprehend#DetectEntitiesRequest": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.comprehend#CustomerInputString", + "traits": { + "smithy.api#documentation": "

A UTF-8 text string. The maximum string size is 100 KB. If you enter text using this parameter,\n do not use the Bytes parameter.

" + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. If your request includes the endpoint for a custom entity recognition model, Amazon\n Comprehend uses the language of your custom model, and it ignores any language code that you\n specify here.

\n

All input documents must be in the same language.

" + } + }, + "EndpointArn": { + "target": "com.amazonaws.comprehend#EntityRecognizerEndpointArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name of an endpoint that is associated with a custom entity\n recognition model. Provide an endpoint if you want to detect entities by using your own custom\n model instead of the default model that is used by Amazon Comprehend.

\n

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and\n it ignores any language code that you provide in your request.

\n

For information about endpoints, see Managing endpoints.

" + } + }, + "Bytes": { + "target": "com.amazonaws.comprehend#SemiStructuredDocumentBlob", + "traits": { + "smithy.api#documentation": "

This field applies only when you use a custom entity recognition model that\n was trained with PDF annotations. For other cases,\n enter your text input in the Text field.

\n

\n Use the Bytes parameter to input a text, PDF, Word or image file.\n Using a plain-text file in the Bytes parameter is equivelent to using the\n Text parameter (the Entities field in the response is identical).

\n

You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText\n or AnalyzeDocument output file.

\n

Provide the input document as a sequence of base64-encoded bytes.\n If your code uses an Amazon Web Services SDK to detect entities, the SDK may encode\n the document file bytes for you.

\n

The maximum length of this field depends on the input document type. For details, see\n \n Inputs for real-time custom analysis in the Comprehend Developer Guide.

\n

If you use the Bytes parameter, do not use the Text parameter.

" + } + }, + "DocumentReaderConfig": { + "target": "com.amazonaws.comprehend#DocumentReaderConfig", + "traits": { + "smithy.api#documentation": "

Provides configuration parameters to override the default actions for extracting text\n from PDF documents and image files.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DetectEntitiesResponse": { + "type": "structure", + "members": { + "Entities": { + "target": "com.amazonaws.comprehend#ListOfEntities", + "traits": { + "smithy.api#documentation": "

A collection of entities identified in the input text. For each entity, the response\n provides the entity text, entity type, where the entity text begins and ends, and the level of\n confidence that Amazon Comprehend has in the detection.

\n

If your request uses a custom entity recognition model, Amazon Comprehend detects the\n entities that the model is trained to recognize. Otherwise, it detects the default entity\n types. For a list of default entity types, see\n Entities in the Comprehend Developer Guide.\n

" + } + }, + "DocumentMetadata": { + "target": "com.amazonaws.comprehend#DocumentMetadata", + "traits": { + "smithy.api#documentation": "

Information about the document, discovered during text extraction. This field is present\n in the response only if your request used the Byte parameter.

" + } + }, + "DocumentType": { + "target": "com.amazonaws.comprehend#ListOfDocumentType", + "traits": { + "smithy.api#documentation": "

The document type for each page in the input document. This field is present\n in the response only if your request used the Byte parameter.

" + } + }, + "Blocks": { + "target": "com.amazonaws.comprehend#ListOfBlocks", + "traits": { + "smithy.api#documentation": "

Information about each block of text in the input document.\n Blocks are nested. A page block contains a block for each line of text,\n which contains a block for each word.

\n

The Block content for a Word input document does not include a Geometry field.

\n

The Block field is not present in the response for plain-text inputs.

" + } + }, + "Errors": { + "target": "com.amazonaws.comprehend#ListOfErrors", + "traits": { + "smithy.api#documentation": "

Page-level errors that the system detected while processing the input document.\n The field is empty if the system encountered no errors.

" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.comprehend#DetectKeyPhrases": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DetectKeyPhrasesRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DetectKeyPhrasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + } + ], + "traits": { + "smithy.api#documentation": "

Detects the key noun phrases found in the text.

" + } + }, + "com.amazonaws.comprehend#DetectKeyPhrasesRequest": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.comprehend#CustomerInputString", + "traits": { + "smithy.api#documentation": "

A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded\n characters.

", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DetectKeyPhrasesResponse": { + "type": "structure", + "members": { + "KeyPhrases": { + "target": "com.amazonaws.comprehend#ListOfKeyPhrases", + "traits": { + "smithy.api#documentation": "

A collection of key phrases that Amazon Comprehend identified in the input text. For\n each key phrase, the response provides the text of the key phrase, where the key phrase begins\n and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the\n detection.

" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.comprehend#DetectPiiEntities": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DetectPiiEntitiesRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DetectPiiEntitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + } + ], + "traits": { + "smithy.api#documentation": "

Inspects the input text for entities that contain personally identifiable information\n (PII) and returns information about them.

" + } + }, + "com.amazonaws.comprehend#DetectPiiEntitiesRequest": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

A UTF-8 text string. The maximum string size is 100 KB.

", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input text. \n Enter the language code for English (en) or Spanish (es).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DetectPiiEntitiesResponse": { + "type": "structure", + "members": { + "Entities": { + "target": "com.amazonaws.comprehend#ListOfPiiEntities", + "traits": { + "smithy.api#documentation": "

A collection of PII entities identified in the input text. For each entity, the response\n provides the entity type, where the entity text begins and ends, and the level of confidence\n that Amazon Comprehend has in the detection.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DetectSentiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DetectSentimentRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DetectSentimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + } + ], + "traits": { + "smithy.api#documentation": "

Inspects text and returns an inference of the prevailing sentiment\n (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).

" + } + }, + "com.amazonaws.comprehend#DetectSentimentRequest": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.comprehend#CustomerInputString", + "traits": { + "smithy.api#documentation": "

A UTF-8 text string. The maximum string size is 5 KB.

", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DetectSentimentResponse": { + "type": "structure", + "members": { + "Sentiment": { + "target": "com.amazonaws.comprehend#SentimentType", + "traits": { + "smithy.api#documentation": "

The inferred sentiment that Amazon Comprehend has the highest level of confidence\n in.

" + } + }, + "SentimentScore": { + "target": "com.amazonaws.comprehend#SentimentScore", + "traits": { + "smithy.api#documentation": "

An object that lists the sentiments, and their corresponding confidence\n levels.

" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.comprehend#DetectSyntax": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DetectSyntaxRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DetectSyntaxResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + } + ], + "traits": { + "smithy.api#documentation": "

Inspects text for syntax and the part of speech of words in the document. For more\n information, see\n Syntax in the Comprehend Developer Guide.\n

" + } + }, + "com.amazonaws.comprehend#DetectSyntaxRequest": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.comprehend#CustomerInputString", + "traits": { + "smithy.api#documentation": "

A UTF-8 string. The maximum string size is 5 KB.

", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#SyntaxLanguageCode", + "traits": { + "smithy.api#documentation": "

The language code of the input documents. You can specify any of the following languages\n supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"),\n Italian (\"it\"), or Portuguese (\"pt\").

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DetectSyntaxResponse": { + "type": "structure", + "members": { + "SyntaxTokens": { + "target": "com.amazonaws.comprehend#ListOfSyntaxTokens", + "traits": { + "smithy.api#documentation": "

A collection of syntax tokens describing the text. For each token, the response provides\n the text, the token type, where the text begins and ends, and the level of confidence that\n Amazon Comprehend has that the token is correct. For a list of token types, see\n Syntax in the Comprehend Developer Guide.\n

" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.comprehend#DetectTargetedSentiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DetectTargetedSentimentRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DetectTargetedSentimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + } + ], + "traits": { + "smithy.api#documentation": "

Inspects the input text and returns a sentiment analysis for each entity identified in the text.

\n

For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.

" + } + }, + "com.amazonaws.comprehend#DetectTargetedSentimentRequest": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.comprehend#CustomerInputString", + "traits": { + "smithy.api#documentation": "

A UTF-8 text string. The maximum string length is 5 KB.

", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input documents. Currently, English is the only supported language.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DetectTargetedSentimentResponse": { + "type": "structure", + "members": { + "Entities": { + "target": "com.amazonaws.comprehend#ListOfTargetedSentimentEntities", + "traits": { + "smithy.api#documentation": "

Targeted sentiment analysis for each of the entities identified in the input text.

" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.comprehend#DetectToxicContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DetectToxicContentRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DetectToxicContentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + } + ], + "traits": { + "smithy.api#documentation": "

Performs toxicity analysis on the list of text strings that you provide as input.\n The API response contains a results list that matches the size of the input list.\n For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide.\n

" + } + }, + "com.amazonaws.comprehend#DetectToxicContentRequest": { + "type": "structure", + "members": { + "TextSegments": { + "target": "com.amazonaws.comprehend#ListOfTextSegments", + "traits": { + "smithy.api#documentation": "

A list of up to 10 text strings. Each string has a maximum size of 1 KB, and\n the maximum size of the list is 10 KB.

", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input text. Currently, English is the only supported language.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DetectToxicContentResponse": { + "type": "structure", + "members": { + "ResultList": { + "target": "com.amazonaws.comprehend#ListOfToxicLabels", + "traits": { + "smithy.api#documentation": "

Results of the content moderation analysis.\n Each entry in the results list contains a list of toxic content types identified in \n the text, along with a confidence score for each content type. \n The results list also includes a toxicity score for each entry in the results list.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DocumentClass": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

The name of the class.

" + } + }, + "Score": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The confidence score that Amazon Comprehend has this class correctly attributed.

" + } + }, + "Page": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Page number in the input document. This field is present\n in the response only if your request includes the Byte parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the class that categorizes the document being analyzed

" + } + }, + "com.amazonaws.comprehend#DocumentClassificationConfig": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.comprehend#DocumentClassifierMode", + "traits": { + "smithy.api#documentation": "

Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.

", + "smithy.api#required": {} + } + }, + "Labels": { + "target": "com.amazonaws.comprehend#LabelsList", + "traits": { + "smithy.api#documentation": "

One or more labels to associate with the custom classifier.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration required for a document classification model.

" + } + }, + "com.amazonaws.comprehend#DocumentClassificationJobFilter": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

Filters on the name of the job.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

Filters the list based on job status. Returns only jobs with the specified status.

" + } + }, + "SubmitTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.

" + } + }, + "SubmitTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information for filtering a list of document classification jobs. For more\n information, see the operation. You can\n provide only one filter parameter in each request.

" + } + }, + "com.amazonaws.comprehend#DocumentClassificationJobProperties": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier assigned to the document classification job.

" + } + }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully\n qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::document-classification-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

The name that you assigned to the document classification job.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the document classification job. If the status is\n FAILED, the Message field shows the reason for the failure.

" + } + }, + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", + "traits": { + "smithy.api#documentation": "

A description of the status of the job.

" + } + }, + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the document classification job was submitted for processing.

" + } + }, + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the document classification job completed.

" + } + }, + "DocumentClassifierArn": { + "target": "com.amazonaws.comprehend#DocumentClassifierArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the document classifier.

" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", + "traits": { + "smithy.api#documentation": "

The input data configuration that you supplied when you created the document\n classification job.

" + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

The output data configuration that you supplied when you created the document\n classification job.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to your input data.

" + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", + "traits": { + "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your document classification job. For more information, see Amazon\n VPC.

" + } + }, + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the flywheel

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a document classification job.

" + } + }, + "com.amazonaws.comprehend#DocumentClassificationJobPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#DocumentClassificationJobProperties" + } + }, + "com.amazonaws.comprehend#DocumentClassifierArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document-classifier/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?$" + } + }, + "com.amazonaws.comprehend#DocumentClassifierAugmentedManifestsList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#AugmentedManifestsListItem" + } + }, + "com.amazonaws.comprehend#DocumentClassifierDataFormat": { + "type": "enum", + "members": { + "COMPREHEND_CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPREHEND_CSV" + } + }, + "AUGMENTED_MANIFEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUGMENTED_MANIFEST" + } + } + } + }, + "com.amazonaws.comprehend#DocumentClassifierDocumentTypeFormat": { + "type": "enum", + "members": { + "PLAIN_TEXT_DOCUMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLAIN_TEXT_DOCUMENT" + } + }, + "SEMI_STRUCTURED_DOCUMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEMI_STRUCTURED_DOCUMENT" + } + } + } + }, + "com.amazonaws.comprehend#DocumentClassifierDocuments": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

The S3 URI location of the training documents specified in the S3Uri CSV file.

", + "smithy.api#required": {} + } + }, + "TestS3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

The S3 URI location of the test documents included in the TestS3Uri CSV file.\n This field is not required if you do not specify a test CSV file.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The location of the training documents. This parameter is required in a request to create a semi-structured document classification model.

" + } + }, + "com.amazonaws.comprehend#DocumentClassifierEndpointArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:([0-9]{12}|aws):document-classifier-endpoint/[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.comprehend#DocumentClassifierFilter": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.comprehend#ModelStatus", + "traits": { + "smithy.api#documentation": "

Filters the list of classifiers based on status.

" + } + }, + "DocumentClassifierName": { + "target": "com.amazonaws.comprehend#ComprehendArnName", + "traits": { + "smithy.api#documentation": "

The name that you assigned to the document classifier

" + } + }, + "SubmitTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of classifiers based on the time that the classifier was submitted for\n processing. Returns only classifiers submitted before the specified time. Classifiers are\n returned in ascending order, oldest to newest.

" + } + }, + "SubmitTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of classifiers based on the time that the classifier was submitted for\n processing. Returns only classifiers submitted after the specified time. Classifiers are\n returned in descending order, newest to oldest.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information for filtering a list of document classifiers. You can only specify\n one filtering parameter in a request. For more information, see the \n ListDocumentClassifiers operation.

" + } + }, + "com.amazonaws.comprehend#DocumentClassifierInputDataConfig": { + "type": "structure", + "members": { + "DataFormat": { + "target": "com.amazonaws.comprehend#DocumentClassifierDataFormat", + "traits": { + "smithy.api#documentation": "

The format of your training data:

\n
    \n
  • \n

    \n COMPREHEND_CSV: A two-column CSV file, where labels are provided in the\n first column, and documents are provided in the second. If you use this value, you must\n provide the S3Uri parameter in your request.

    \n
    • \n
  • \n

    \n AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon\n SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON\n object that contains a training document and its associated labels.

    \n

    If you use this value, you must provide the AugmentedManifests parameter\n in your request.

    \n
    • \n
\n

If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the\n default.

" + } + }, + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI for the input data. The S3 bucket must be in the same Region as the API\n endpoint that you are calling. The URI can point to a single input file or it can provide the\n prefix for a collection of input files.

\n

For example, if you use the URI S3://bucketName/prefix, if the prefix is a\n single file, Amazon Comprehend uses that file as input. If more than one file begins with the\n prefix, Amazon Comprehend uses all of them as input.

\n

This parameter is required if you set DataFormat to\n COMPREHEND_CSV.

" + } + }, + "TestS3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

This specifies the Amazon S3 location that contains the test annotations for the document classifier. \n The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling.

" + } + }, + "LabelDelimiter": { + "target": "com.amazonaws.comprehend#LabelDelimiter", + "traits": { + "smithy.api#documentation": "

Indicates the delimiter used to separate each label for training a multi-label classifier.\n The default delimiter between labels is a pipe (|). You can use a different character as a\n delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the\n training documents use a delimiter other than the default or the delimiter you specify, the\n labels on that line will be combined to make a single unique label, such as\n LABELLABELLABEL.

" + } + }, + "AugmentedManifests": { + "target": "com.amazonaws.comprehend#DocumentClassifierAugmentedManifestsList", + "traits": { + "smithy.api#documentation": "

A list of augmented manifest files that provide training data for your custom model. An\n augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground\n Truth.

\n

This parameter is required if you set DataFormat to\n AUGMENTED_MANIFEST.

" + } + }, + "DocumentType": { + "target": "com.amazonaws.comprehend#DocumentClassifierDocumentTypeFormat", + "traits": { + "smithy.api#documentation": "

The type of input documents for training the model. Provide plain-text documents to create a plain-text model, and\n provide semi-structured documents to create a native document model.

" + } + }, + "Documents": { + "target": "com.amazonaws.comprehend#DocumentClassifierDocuments", + "traits": { + "smithy.api#documentation": "

The S3 location of the training documents. \n This parameter is required in a request to create a native document model.

" + } + }, + "DocumentReaderConfig": { + "target": "com.amazonaws.comprehend#DocumentReaderConfig" + } + }, + "traits": { + "smithy.api#documentation": "

The input properties for training a document classifier.

\n

For more information on how the input file is formatted, see\n Preparing training data in the Comprehend Developer Guide.\n

" + } + }, + "com.amazonaws.comprehend#DocumentClassifierMode": { + "type": "enum", + "members": { + "MULTI_CLASS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTI_CLASS" + } + }, + "MULTI_LABEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTI_LABEL" + } + } + } + }, + "com.amazonaws.comprehend#DocumentClassifierOutputDataConfig": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

When you use the OutputDataConfig object while creating a custom\n classifier, you specify the Amazon S3 location where you want to write the confusion matrix\n and other output files.\n The URI must be in the same Region as the API endpoint that you are calling. The location is\n used as the prefix for the actual location of this output file.

\n

When the custom classifier job is finished, the service creates the output file in a\n directory specific to the job. The S3Uri field contains the location of the\n output file, called output.tar.gz. It is a compressed archive that contains the\n confusion matrix.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the\n output results from an analysis job. The KmsKeyId can be one of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    KMS Key Alias: \"alias/ExampleAlias\"\n

    \n
    • \n
  • \n

    ARN of a KMS Key Alias:\n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n

    \n
    • \n
" + } + }, + "FlywheelStatsS3Prefix": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 prefix for the data lake location of the flywheel statistics.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provide the location for output data from a custom classifier job. This field is mandatory \n if you are training a native document model.

" + } + }, + "com.amazonaws.comprehend#DocumentClassifierProperties": { + "type": "structure", + "members": { + "DocumentClassifierArn": { + "target": "com.amazonaws.comprehend#DocumentClassifierArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the document classifier.

" + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language code for the language of the documents that the classifier was trained\n on.

" + } + }, + "Status": { + "target": "com.amazonaws.comprehend#ModelStatus", + "traits": { + "smithy.api#documentation": "

The status of the document classifier. If the status is TRAINED the\n classifier is ready to use. If the status is TRAINED_WITH_WARNINGS the\n classifier training succeeded, but you should review the warnings returned in the \n CreateDocumentClassifier response.

\n

If the status is FAILED you can see additional\n information about why the classifier wasn't trained in the Message field.

" + } + }, + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", + "traits": { + "smithy.api#documentation": "

Additional information about the status of the classifier.

" + } + }, + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the document classifier was submitted for training.

" + } + }, + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that training the document classifier completed.

" + } + }, + "TrainingStartTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Indicates the time when the training starts on documentation classifiers. You are billed\n for the time interval between this time and the value of TrainingEndTime.

" + } + }, + "TrainingEndTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that training of the document classifier was completed. Indicates the time when\n the training completes on documentation classifiers. You are billed for the time interval\n between this time and the value of TrainingStartTime.

" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#DocumentClassifierInputDataConfig", + "traits": { + "smithy.api#documentation": "

The input data configuration that you supplied when you created the document classifier\n for training.

" + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#DocumentClassifierOutputDataConfig", + "traits": { + "smithy.api#documentation": "

Provides output results configuration parameters for custom classifier jobs.

" + } + }, + "ClassifierMetadata": { + "target": "com.amazonaws.comprehend#ClassifierMetadata", + "traits": { + "smithy.api#documentation": "

Information about the document classifier, including the number of documents used for\n training the classifier, the number of documents used for test the classifier, and an accuracy\n rating.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to your input data.

" + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", + "traits": { + "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your custom classifier. For more information, see Amazon\n VPC.

" + } + }, + "Mode": { + "target": "com.amazonaws.comprehend#DocumentClassifierMode", + "traits": { + "smithy.api#documentation": "

Indicates the mode in which the specific classifier was trained. This also indicates the\n format of input documents and the format of the confusion matrix. Each classifier can only be\n trained in one mode and this cannot be changed once the classifier is trained.

" + } + }, + "ModelKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the KMS key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VersionName": { + "target": "com.amazonaws.comprehend#VersionName", + "traits": { + "smithy.api#documentation": "

The version name that you assigned to the document classifier.

" + } + }, + "SourceModelArn": { + "target": "com.amazonaws.comprehend#DocumentClassifierArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source model. This model was imported from a\n different Amazon Web Services account to create the document classifier model in your Amazon Web Services account.

" + } + }, + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the flywheel

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a document classifier.

" + } + }, + "com.amazonaws.comprehend#DocumentClassifierPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#DocumentClassifierProperties" + } + }, + "com.amazonaws.comprehend#DocumentClassifierSummariesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#DocumentClassifierSummary" + } + }, + "com.amazonaws.comprehend#DocumentClassifierSummary": { + "type": "structure", + "members": { + "DocumentClassifierName": { + "target": "com.amazonaws.comprehend#ComprehendArnName", + "traits": { + "smithy.api#documentation": "

The name that you assigned the document classifier.

" + } + }, + "NumberOfVersions": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The number of versions you created.

" + } + }, + "LatestVersionCreatedAt": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the latest document classifier version was submitted for processing.

" + } + }, + "LatestVersionName": { + "target": "com.amazonaws.comprehend#VersionName", + "traits": { + "smithy.api#documentation": "

The version name you assigned to the latest document classifier version.

" + } + }, + "LatestVersionStatus": { + "target": "com.amazonaws.comprehend#ModelStatus", + "traits": { + "smithy.api#documentation": "

Provides the status of the latest document classifier version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes information about a document classifier and its versions.

" + } + }, + "com.amazonaws.comprehend#DocumentLabel": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

The name of the label.

" + } + }, + "Score": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The confidence score that Amazon Comprehend has this label correctly attributed.

" + } + }, + "Page": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Page number where the label occurs. This field is present\n in the response only if your request includes the Byte parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies one of the label or labels that categorize the document being analyzed.

" + } + }, + "com.amazonaws.comprehend#DocumentMetadata": { + "type": "structure", + "members": { + "Pages": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Number of pages in the document.

" + } + }, + "ExtractedCharacters": { + "target": "com.amazonaws.comprehend#ListOfExtractedCharacters", + "traits": { + "smithy.api#documentation": "

List of pages in the document, with the number of characters extracted from each page.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the document, discovered during text extraction.

" + } + }, + "com.amazonaws.comprehend#DocumentReadAction": { + "type": "enum", + "members": { + "TEXTRACT_DETECT_DOCUMENT_TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXTRACT_DETECT_DOCUMENT_TEXT" + } + }, + "TEXTRACT_ANALYZE_DOCUMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXTRACT_ANALYZE_DOCUMENT" + } + } + } + }, + "com.amazonaws.comprehend#DocumentReadFeatureTypes": { + "type": "enum", + "members": { + "TABLES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TABLES" + } + }, + "FORMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORMS" + } + } + }, + "traits": { + "smithy.api#documentation": "

TABLES or FORMS

" + } + }, + "com.amazonaws.comprehend#DocumentReadMode": { + "type": "enum", + "members": { + "SERVICE_DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE_DEFAULT" + } + }, + "FORCE_DOCUMENT_READ_ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORCE_DOCUMENT_READ_ACTION" + } + } + } + }, + "com.amazonaws.comprehend#DocumentReaderConfig": { + "type": "structure", + "members": { + "DocumentReadAction": { + "target": "com.amazonaws.comprehend#DocumentReadAction", + "traits": { + "smithy.api#documentation": "

This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files.\n Enter one of the following values:

\n
    \n
  • \n

    \n TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText\n API operation.

    \n
    • \n
  • \n

    \n TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument\n API operation.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "DocumentReadMode": { + "target": "com.amazonaws.comprehend#DocumentReadMode", + "traits": { + "smithy.api#documentation": "

Determines the text extraction actions for PDF files. Enter one of the following values:

\n
    \n
  • \n

    \n SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.

    \n
    • \n
  • \n

    \n FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by\n DocumentReadAction for all PDF files, including digital PDF files.

    \n
    • \n
" + } + }, + "FeatureTypes": { + "target": "com.amazonaws.comprehend#ListOfDocumentReadFeatureTypes", + "traits": { + "smithy.api#documentation": "

Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT\n as the read action, you must specify one or both of the following values:

\n
    \n
  • \n

    \n TABLES - Returns additional information about any tables that are detected in the input document.

    \n
    • \n
  • \n

    \n FORMS - Returns additional information about any forms that are detected in the input document.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

\n

By default, Amazon Comprehend performs the following actions to extract text from files, based on the input file type:

\n
    \n
  • \n

    \n Word files - Amazon Comprehend parser extracts the text.

    \n
    • \n
  • \n

    \n Digital PDF files - Amazon Comprehend parser extracts the text.

    \n
    • \n
  • \n

    \n Image files and scanned PDF files - Amazon Comprehend uses the Amazon Textract DetectDocumentText\n API to extract the text.

    \n
    • \n
\n

\n DocumentReaderConfig does not apply to plain text files or Word files.

\n

\n For image files and PDF documents, you can override these default actions using the fields listed below.\n For more information, see \n Setting text extraction options in the Comprehend Developer Guide.\n

" + } + }, + "com.amazonaws.comprehend#DocumentType": { + "type": "enum", + "members": { + "NATIVE_PDF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NATIVE_PDF" + } + }, + "SCANNED_PDF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCANNED_PDF" + } + }, + "MS_WORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MS_WORD" + } + }, + "IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE" + } + }, + "PLAIN_TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLAIN_TEXT" + } + }, + "TEXTRACT_DETECT_DOCUMENT_TEXT_JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXTRACT_DETECT_DOCUMENT_TEXT_JSON" + } + }, + "TEXTRACT_ANALYZE_DOCUMENT_JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXTRACT_ANALYZE_DOCUMENT_JSON" + } + } + } + }, + "com.amazonaws.comprehend#DocumentTypeListItem": { + "type": "structure", + "members": { + "Page": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Page number.

" + } + }, + "Type": { + "target": "com.amazonaws.comprehend#DocumentType", + "traits": { + "smithy.api#documentation": "

Document type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Document type for each page in the document.

" + } + }, + "com.amazonaws.comprehend#DominantLanguage": { + "type": "structure", + "members": { + "LanguageCode": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

The RFC 5646 language code for the dominant language. For more information about RFC\n 5646, see Tags for Identifying\n Languages on the IETF Tools web site.

" + } + }, + "Score": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of the\n detection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns the code for the dominant language in the input text and the level of\n confidence that Amazon Comprehend has in the accuracy of the detection.

" + } + }, + "com.amazonaws.comprehend#DominantLanguageDetectionJobFilter": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

Filters on the name of the job.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on job status. Returns only jobs with the specified\n status.

" + } + }, + "SubmitTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.

" + } + }, + "SubmitTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information for filtering a list of dominant language detection jobs. For more\n information, see the \n operation.

" + } + }, + "com.amazonaws.comprehend#DominantLanguageDetectionJobProperties": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier assigned to the dominant language detection job.

" + } + }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique,\n fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID.\n The format of the ARN is as follows:

\n

\n arn::comprehend:::dominant-language-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

The name that you assigned to the dominant language detection job.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the dominant language detection job. If the status is\n FAILED, the Message field shows the reason for the failure.

" + } + }, + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", + "traits": { + "smithy.api#documentation": "

A description for the status of a job.

" + } + }, + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the dominant language detection job was submitted for processing.

" + } + }, + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the dominant language detection job completed.

" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", + "traits": { + "smithy.api#documentation": "

The input data configuration that you supplied when you created the dominant language\n detection job.

" + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

The output data configuration that you supplied when you created the dominant language\n detection job.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to your input data.

" + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", + "traits": { + "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your dominant language detection job. For more information, see\n Amazon\n VPC.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a dominant language detection job.

" + } + }, + "com.amazonaws.comprehend#DominantLanguageDetectionJobPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#DominantLanguageDetectionJobProperties" + } + }, + "com.amazonaws.comprehend#Double": { + "type": "double" + }, + "com.amazonaws.comprehend#EndpointFilter": { + "type": "structure", + "members": { + "ModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the model to which the endpoint is attached.

" + } + }, + "Status": { + "target": "com.amazonaws.comprehend#EndpointStatus", + "traits": { + "smithy.api#documentation": "

Specifies the status of the endpoint being returned. Possible values are: Creating, Ready,\n Updating, Deleting, Failed.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Specifies a date before which the returned endpoint or endpoints were created.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Specifies a date after which the returned endpoint or endpoints were created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The filter used to determine which endpoints are returned. You can filter jobs on their\n name, model, status, or the date and time that they were created. You can only set one filter\n at a time.

" + } + }, + "com.amazonaws.comprehend#EndpointProperties": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.comprehend#ComprehendEndpointArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the endpoint.

" + } + }, + "Status": { + "target": "com.amazonaws.comprehend#EndpointStatus", + "traits": { + "smithy.api#documentation": "

Specifies the status of the endpoint. Because the endpoint updates and creation are\n asynchronous, so customers will need to wait for the endpoint to be Ready status\n before making inference requests.

" + } + }, + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", + "traits": { + "smithy.api#documentation": "

Specifies a reason for failure in cases of Failed status.

" + } + }, + "ModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the model to which the endpoint is attached.

" + } + }, + "DesiredModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

ARN of the new model to use for updating an existing endpoint. This ARN is going to be\n different from the model ARN when the update is in progress

" + } + }, + "DesiredInferenceUnits": { + "target": "com.amazonaws.comprehend#InferenceUnitsInteger", + "traits": { + "smithy.api#documentation": "

The desired number of inference units to be used by the model using this endpoint.\n \n Each inference unit represents of a throughput of 100 characters per second.

" + } + }, + "CurrentInferenceUnits": { + "target": "com.amazonaws.comprehend#InferenceUnitsInteger", + "traits": { + "smithy.api#documentation": "

The number of inference units currently used by the model using this endpoint.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation date and time of the endpoint.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the endpoint was last modified.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to trained custom models encrypted with a customer\n managed key (ModelKmsKeyId).

" + } + }, + "DesiredDataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

Data access role ARN to use in case the new model is encrypted with a customer KMS\n key.

" + } + }, + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the flywheel

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies information about the specified endpoint.\n For information about endpoints, see Managing endpoints.

" + } + }, + "com.amazonaws.comprehend#EndpointPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#EndpointProperties" + } + }, + "com.amazonaws.comprehend#EndpointStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "IN_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_SERVICE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } + } + }, + "com.amazonaws.comprehend#EntitiesDetectionJobFilter": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

Filters on the name of the job.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on job status. Returns only jobs with the specified\n status.

" + } + }, + "SubmitTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.

" + } + }, + "SubmitTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information for filtering a list of dominant language detection jobs. For more\n information, see the operation.

" + } + }, + "com.amazonaws.comprehend#EntitiesDetectionJobProperties": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier assigned to the entities detection job.

" + } + }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully\n qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::entities-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

The name that you assigned the entities detection job.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the entities detection job. If the status is FAILED,\n the Message field shows the reason for the failure.

" + } + }, + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", + "traits": { + "smithy.api#documentation": "

A description of the status of a job.

" + } + }, + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the entities detection job was submitted for processing.

" + } + }, + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the entities detection job completed

" + } + }, + "EntityRecognizerArn": { + "target": "com.amazonaws.comprehend#EntityRecognizerArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the entity recognizer.

" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", + "traits": { + "smithy.api#documentation": "

The input data configuration that you supplied when you created the entities detection\n job.

" + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

The output data configuration that you supplied when you created the entities detection\n job.

" + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language code of the input documents.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to your input data.

" + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", + "traits": { + "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your entity detection job. For more information, see Amazon\n VPC.

" + } + }, + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the flywheel associated with this job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an entities detection job.

" + } + }, + "com.amazonaws.comprehend#EntitiesDetectionJobPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#EntitiesDetectionJobProperties" + } + }, + "com.amazonaws.comprehend#Entity": { + "type": "structure", + "members": { + "Score": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of the\n detection.

" + } + }, + "Type": { + "target": "com.amazonaws.comprehend#EntityType", + "traits": { + "smithy.api#documentation": "

The entity type. For entity detection using the built-in model, this field contains one of the\n standard entity types listed below.

\n

For custom entity detection, this field contains one of the\n entity types that you specified when you trained your custom model.

" + } + }, + "Text": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

The text of the entity.

" + } + }, + "BeginOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The zero-based offset from the beginning of the source text to the first character in the\n entity.

\n

This field is empty for non-text input.

" + } + }, + "EndOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The zero-based offset from the beginning of the source text to the last character in the\n entity.

\n

This field is empty for non-text input.

" + } + }, + "BlockReferences": { + "target": "com.amazonaws.comprehend#ListOfBlockReferences", + "traits": { + "smithy.api#documentation": "

A reference to each block for this entity. This field is empty for plain-text input.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an entity.

\n

" + } + }, + "com.amazonaws.comprehend#EntityLabel": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.comprehend#PiiEntityType", + "traits": { + "smithy.api#documentation": "

The name of the label.

" + } + }, + "Score": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of the\n detection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies one of the label or labels that categorize the personally identifiable\n information (PII) entity being analyzed.

" + } + }, + "com.amazonaws.comprehend#EntityRecognitionConfig": { + "type": "structure", + "members": { + "EntityTypes": { + "target": "com.amazonaws.comprehend#EntityTypesList", + "traits": { + "smithy.api#documentation": "

Up to 25 entity types that the model is trained to recognize.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration required for an entity recognition model.

" + } + }, + "com.amazonaws.comprehend#EntityRecognizerAnnotations": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 location where the annotations for an entity recognizer are\n located. The URI must be in the same Region as the API endpoint that you are calling.

", + "smithy.api#required": {} + } + }, + "TestS3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 location where the test annotations for an entity recognizer are\n located. The URI must be in the same Region as the API endpoint that you are calling.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the annotations associated with a entity recognizer.

" + } + }, + "com.amazonaws.comprehend#EntityRecognizerArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity-recognizer/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?$" + } + }, + "com.amazonaws.comprehend#EntityRecognizerAugmentedManifestsList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#AugmentedManifestsListItem" + } + }, + "com.amazonaws.comprehend#EntityRecognizerDataFormat": { + "type": "enum", + "members": { + "COMPREHEND_CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPREHEND_CSV" + } + }, + "AUGMENTED_MANIFEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUGMENTED_MANIFEST" + } + } + } + }, + "com.amazonaws.comprehend#EntityRecognizerDocuments": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 location where the training documents for an entity recognizer\n are located. The URI must be in the same Region as the API endpoint that you are\n calling.

", + "smithy.api#required": {} + } + }, + "TestS3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 location where the test documents for an entity recognizer are\n located. The URI must be in the same Amazon Web Services Region as the API endpoint that you are\n calling.

" + } + }, + "InputFormat": { + "target": "com.amazonaws.comprehend#InputFormat", + "traits": { + "smithy.api#documentation": "

Specifies how the text in an input file should be processed. This is optional, and the\n default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document.\n Use this option when you are processing large documents, such as newspaper articles or\n scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document.\n Use this option when you are processing many short documents, such as text messages.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the training documents submitted with an entity recognizer.

" + } + }, + "com.amazonaws.comprehend#EntityRecognizerEndpointArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity-recognizer-endpoint/[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.comprehend#EntityRecognizerEntityList": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 location where the entity list is located. The URI must be in the\n same Region as the API endpoint that you are calling.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the entity list submitted with an entity recognizer.

" + } + }, + "com.amazonaws.comprehend#EntityRecognizerEvaluationMetrics": { + "type": "structure", + "members": { + "Precision": { + "target": "com.amazonaws.comprehend#Double", + "traits": { + "smithy.api#documentation": "

A measure of the usefulness of the recognizer results in the test data. High precision\n means that the recognizer returned substantially more relevant results than irrelevant ones.\n

" + } + }, + "Recall": { + "target": "com.amazonaws.comprehend#Double", + "traits": { + "smithy.api#documentation": "

A measure of how complete the recognizer results are for the test data. High recall means\n that the recognizer returned most of the relevant results.

" + } + }, + "F1Score": { + "target": "com.amazonaws.comprehend#Double", + "traits": { + "smithy.api#documentation": "

A measure of how accurate the recognizer results are for the test data. It is derived from\n the Precision and Recall values. The F1Score is the\n harmonic average of the two scores. For plain text entity recognizer models, the range is 0 to 100,\n where 100 is the best score. For PDF/Word entity recognizer models, the range is 0 to 1,\n where 1 is the best score.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Detailed information about the accuracy of an entity recognizer.

" + } + }, + "com.amazonaws.comprehend#EntityRecognizerFilter": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.comprehend#ModelStatus", + "traits": { + "smithy.api#documentation": "

The status of an entity recognizer.

" + } + }, + "RecognizerName": { + "target": "com.amazonaws.comprehend#ComprehendArnName", + "traits": { + "smithy.api#documentation": "

The name that you assigned the entity recognizer.

" + } + }, + "SubmitTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of entities based on the time that the list was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in descending order,\n newest to oldest.

" + } + }, + "SubmitTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of entities based on the time that the list was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in ascending order,\n oldest to newest.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information for filtering a list of entity recognizers. You can only specify one\n filtering parameter in a request. For more information, see the \n ListEntityRecognizers operation./>

" + } + }, + "com.amazonaws.comprehend#EntityRecognizerInputDataConfig": { + "type": "structure", + "members": { + "DataFormat": { + "target": "com.amazonaws.comprehend#EntityRecognizerDataFormat", + "traits": { + "smithy.api#documentation": "

The format of your training data:

\n
    \n
  • \n

    \n COMPREHEND_CSV: A CSV file that supplements your training documents. The\n CSV file contains information about the custom entities that your trained model will\n detect. The required format of the file depends on whether you are providing annotations\n or an entity list.

    \n

    If you use this value, you must provide your CSV file by using either the\n Annotations or EntityList parameters. You must provide your\n training documents by using the Documents parameter.

    \n
    • \n
  • \n

    \n AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon\n SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON\n object that contains a training document and its labels. Each label annotates a named\n entity in the training document.

    \n

    If you use this value, you must provide the AugmentedManifests parameter\n in your request.

    \n
    • \n
\n

If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the\n default.

" + } + }, + "EntityTypes": { + "target": "com.amazonaws.comprehend#EntityTypesList", + "traits": { + "smithy.api#documentation": "

The entity types in the labeled training data that Amazon Comprehend uses to train the\n custom entity recognizer. Any entity types that you don't specify are ignored.

\n

A maximum of 25 entity types can be used at one time to train an entity recognizer. Entity\n types must not contain the following invalid characters: \\n (line break), \\\\n (escaped line\n break), \\r (carriage return), \\\\r (escaped carriage return), \\t (tab), \\\\t (escaped tab),\n space, and , (comma).

", + "smithy.api#required": {} + } + }, + "Documents": { + "target": "com.amazonaws.comprehend#EntityRecognizerDocuments", + "traits": { + "smithy.api#documentation": "

The S3 location of the folder that contains the training documents for your custom entity\n recognizer.

\n

This parameter is required if you set DataFormat to\n COMPREHEND_CSV.

" + } + }, + "Annotations": { + "target": "com.amazonaws.comprehend#EntityRecognizerAnnotations", + "traits": { + "smithy.api#documentation": "

The S3 location of the CSV file that annotates your training documents.

" + } + }, + "EntityList": { + "target": "com.amazonaws.comprehend#EntityRecognizerEntityList", + "traits": { + "smithy.api#documentation": "

The S3 location of the CSV file that has the entity list for your custom entity\n recognizer.

" + } + }, + "AugmentedManifests": { + "target": "com.amazonaws.comprehend#EntityRecognizerAugmentedManifestsList", + "traits": { + "smithy.api#documentation": "

A list of augmented manifest files that provide training data for your custom model. An\n augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground\n Truth.

\n

This parameter is required if you set DataFormat to\n AUGMENTED_MANIFEST.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the format and location of the input data.

" + } + }, + "com.amazonaws.comprehend#EntityRecognizerMetadata": { + "type": "structure", + "members": { + "NumberOfTrainedDocuments": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The number of documents in the input data that were used to train the entity recognizer.\n Typically this is 80 to 90 percent of the input documents.

" + } + }, + "NumberOfTestDocuments": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The number of documents in the input data that were used to test the entity recognizer.\n Typically this is 10 to 20 percent of the input documents.

" + } + }, + "EvaluationMetrics": { + "target": "com.amazonaws.comprehend#EntityRecognizerEvaluationMetrics", + "traits": { + "smithy.api#documentation": "

Detailed information about the accuracy of an entity recognizer.

" + } + }, + "EntityTypes": { + "target": "com.amazonaws.comprehend#EntityRecognizerMetadataEntityTypesList", + "traits": { + "smithy.api#documentation": "

Entity types from the metadata of an entity recognizer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Detailed information about an entity recognizer.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.comprehend#EntityRecognizerMetadataEntityTypesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#EntityRecognizerMetadataEntityTypesListItem" + } + }, + "com.amazonaws.comprehend#EntityRecognizerMetadataEntityTypesListItem": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.comprehend#AnyLengthString", + "traits": { + "smithy.api#documentation": "

Type of entity from the list of entity types in the metadata of an entity recognizer.\n

" + } + }, + "EvaluationMetrics": { + "target": "com.amazonaws.comprehend#EntityTypesEvaluationMetrics", + "traits": { + "smithy.api#documentation": "

Detailed information about the accuracy of the entity recognizer for a specific item on\n the list of entity types.

" + } + }, + "NumberOfTrainMentions": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Indicates the number of times the given entity type was seen in the training data.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Individual item from the list of entity types in the metadata of an entity\n recognizer.

" + } + }, + "com.amazonaws.comprehend#EntityRecognizerOutputDataConfig": { + "type": "structure", + "members": { + "FlywheelStatsS3Prefix": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 prefix for the data lake location of the flywheel statistics.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Output data configuration.

" + } + }, + "com.amazonaws.comprehend#EntityRecognizerProperties": { + "type": "structure", + "members": { + "EntityRecognizerArn": { + "target": "com.amazonaws.comprehend#EntityRecognizerArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the entity recognizer.

" + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input documents. All documents must be in the same language. Only\n English (\"en\") is currently supported.

" + } + }, + "Status": { + "target": "com.amazonaws.comprehend#ModelStatus", + "traits": { + "smithy.api#documentation": "

Provides the status of the entity recognizer.

" + } + }, + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", + "traits": { + "smithy.api#documentation": "

A description of the status of the recognizer.

" + } + }, + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the recognizer was submitted for processing.

" + } + }, + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the recognizer creation completed.

" + } + }, + "TrainingStartTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that training of the entity recognizer started.

" + } + }, + "TrainingEndTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that training of the entity recognizer was completed.

" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#EntityRecognizerInputDataConfig", + "traits": { + "smithy.api#documentation": "

The input data properties of an entity recognizer.

" + } + }, + "RecognizerMetadata": { + "target": "com.amazonaws.comprehend#EntityRecognizerMetadata", + "traits": { + "smithy.api#documentation": "

Provides information about an entity recognizer.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to your input data.

" + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", + "traits": { + "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your custom entity recognizer. For more information, see Amazon\n VPC.

" + } + }, + "ModelKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the KMS key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VersionName": { + "target": "com.amazonaws.comprehend#VersionName", + "traits": { + "smithy.api#documentation": "

The version name you assigned to the entity recognizer.

" + } + }, + "SourceModelArn": { + "target": "com.amazonaws.comprehend#EntityRecognizerArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source model. This model was imported from a\n different Amazon Web Services account to create the entity recognizer model in your Amazon Web Services account.

" + } + }, + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the flywheel

" + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#EntityRecognizerOutputDataConfig", + "traits": { + "smithy.api#documentation": "

Output data configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes information about an entity recognizer.

" + } + }, + "com.amazonaws.comprehend#EntityRecognizerPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#EntityRecognizerProperties" + } + }, + "com.amazonaws.comprehend#EntityRecognizerSummariesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#EntityRecognizerSummary" + } + }, + "com.amazonaws.comprehend#EntityRecognizerSummary": { + "type": "structure", + "members": { + "RecognizerName": { + "target": "com.amazonaws.comprehend#ComprehendArnName", + "traits": { + "smithy.api#documentation": "

The name that you assigned the entity recognizer.

" + } + }, + "NumberOfVersions": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The number of versions you created.

" + } + }, + "LatestVersionCreatedAt": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the latest entity recognizer version was submitted for processing.

" + } + }, + "LatestVersionName": { + "target": "com.amazonaws.comprehend#VersionName", + "traits": { + "smithy.api#documentation": "

The version name you assigned to the latest entity recognizer version.

" + } + }, + "LatestVersionStatus": { + "target": "com.amazonaws.comprehend#ModelStatus", + "traits": { + "smithy.api#documentation": "

Provides the status of the latest entity recognizer version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the information about an entity recognizer and its versions.

" + } + }, + "com.amazonaws.comprehend#EntityType": { + "type": "enum", + "members": { + "PERSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERSON" + } + }, + "LOCATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOCATION" + } + }, + "ORGANIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORGANIZATION" + } + }, + "COMMERCIAL_ITEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMMERCIAL_ITEM" + } + }, + "EVENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVENT" + } + }, + "DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE" + } + }, + "QUANTITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUANTITY" + } + }, + "TITLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TITLE" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER" + } + } + } + }, + "com.amazonaws.comprehend#EntityTypeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^(?![^\\n\\r\\t,]*\\\\n|\\\\r|\\\\t)[^\\n\\r\\t,]+$" + } + }, + "com.amazonaws.comprehend#EntityTypesEvaluationMetrics": { + "type": "structure", + "members": { + "Precision": { + "target": "com.amazonaws.comprehend#Double", + "traits": { + "smithy.api#documentation": "

A measure of the usefulness of the recognizer results for a specific entity type in the\n test data. High precision means that the recognizer returned substantially more relevant\n results than irrelevant ones.

" + } + }, + "Recall": { + "target": "com.amazonaws.comprehend#Double", + "traits": { + "smithy.api#documentation": "

A measure of how complete the recognizer results are for a specific entity type in the\n test data. High recall means that the recognizer returned most of the relevant results.

" + } + }, + "F1Score": { + "target": "com.amazonaws.comprehend#Double", + "traits": { + "smithy.api#documentation": "

A measure of how accurate the recognizer results are for a specific entity type in the\n test data. It is derived from the Precision and Recall values. The\n F1Score is the harmonic average of the two scores. The highest score is 1, and\n the worst score is 0.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Detailed information about the accuracy of an entity recognizer for a specific entity\n type.

" + } + }, + "com.amazonaws.comprehend#EntityTypesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#EntityTypesListItem" + } + }, + "com.amazonaws.comprehend#EntityTypesListItem": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.comprehend#EntityTypeName", + "traits": { + "smithy.api#documentation": "

An entity type within a labeled training dataset that Amazon Comprehend uses to train a\n custom entity recognizer.

\n

Entity types must not contain the following invalid characters: \\n (line break), \\\\n\n (escaped line break, \\r (carriage return), \\\\r (escaped carriage return), \\t (tab), \\\\t\n (escaped tab), and , (comma).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An entity type within a labeled training dataset that Amazon Comprehend uses to train a\n custom entity recognizer.

" + } + }, + "com.amazonaws.comprehend#ErrorsListItem": { + "type": "structure", + "members": { + "Page": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Page number where the error occurred.

" + } + }, + "ErrorCode": { + "target": "com.amazonaws.comprehend#PageBasedErrorCode", + "traits": { + "smithy.api#documentation": "

Error code for the cause of the error.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Text message explaining the reason for the error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Text extraction encountered one or more page-level errors in the input document.

\n

The ErrorCode contains one of the following values:

\n
    \n
  • \n

    TEXTRACT_BAD_PAGE - Amazon Textract cannot read the page. For more information\n about page limits in Amazon Textract, see \n Page Quotas in Amazon Textract.

    \n
    • \n
  • \n

    TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED - The number of requests exceeded your throughput limit.\n For more information about throughput quotas in Amazon Textract, see \n Default quotas in Amazon Textract.

    \n
    • \n
  • \n

    PAGE_CHARACTERS_EXCEEDED - Too many text characters on the page (10,000 characters maximum).

    \n
    • \n
  • \n

    PAGE_SIZE_EXCEEDED - The maximum page size is 10 MB.

    \n
    • \n
  • \n

    INTERNAL_SERVER_ERROR - The request encountered a service issue. Try the API request again.

    \n
    • \n
" + } + }, + "com.amazonaws.comprehend#EventTypeString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 40 + }, + "smithy.api#pattern": "^[A-Z_]*$" + } + }, + "com.amazonaws.comprehend#EventsDetectionJobFilter": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

Filters on the name of the events detection job.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on job status. Returns only jobs with the specified\n status.

" + } + }, + "SubmitTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.

" + } + }, + "SubmitTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information for filtering a list of event detection jobs.

" + } + }, + "com.amazonaws.comprehend#EventsDetectionJobProperties": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier assigned to the events detection job.

" + } + }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully\n qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::events-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

The name you assigned the events detection job.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the events detection job.

" + } + }, + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", + "traits": { + "smithy.api#documentation": "

A description of the status of the events detection job.

" + } + }, + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the events detection job was submitted for processing.

" + } + }, + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the events detection job completed.

" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", + "traits": { + "smithy.api#documentation": "

The input data configuration that you supplied when you created the events detection\n job.

" + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

The output data configuration that you supplied when you created the events detection\n job.

" + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language code of the input documents.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to your input data.

" + } + }, + "TargetEventTypes": { + "target": "com.amazonaws.comprehend#TargetEventTypes", + "traits": { + "smithy.api#documentation": "

The types of events that are detected by the job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an events detection job.

" + } + }, + "com.amazonaws.comprehend#EventsDetectionJobPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#EventsDetectionJobProperties" + } + }, + "com.amazonaws.comprehend#ExtractedCharactersListItem": { + "type": "structure", + "members": { + "Page": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Page number.

" + } + }, + "Count": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Number of characters extracted from each page.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Array of the number of characters extracted from each page.

" + } + }, + "com.amazonaws.comprehend#Float": { + "type": "float" + }, + "com.amazonaws.comprehend#FlywheelFilter": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.comprehend#FlywheelStatus", + "traits": { + "smithy.api#documentation": "

Filter the flywheels based on the flywheel status.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filter the flywheels to include flywheels created after the specified time.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filter the flywheels to include flywheels created before the specified time.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Filter the flywheels based on creation time or flywheel status.

" + } + }, + "com.amazonaws.comprehend#FlywheelIterationFilter": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filter the flywheel iterations to include iterations created after the specified time.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filter the flywheel iterations to include iterations created before the specified time.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Filter the flywheel iterations based on creation time.

" + } + }, + "com.amazonaws.comprehend#FlywheelIterationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[0-9]{8}T[0-9]{6}Z$" + } + }, + "com.amazonaws.comprehend#FlywheelIterationProperties": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "

" + } + }, + "FlywheelIterationId": { + "target": "com.amazonaws.comprehend#FlywheelIterationId", + "traits": { + "smithy.api#documentation": "

" + } + }, + "CreationTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation start time of the flywheel iteration.

" + } + }, + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The completion time of this flywheel iteration.

" + } + }, + "Status": { + "target": "com.amazonaws.comprehend#FlywheelIterationStatus", + "traits": { + "smithy.api#documentation": "

The status of the flywheel iteration.

" + } + }, + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", + "traits": { + "smithy.api#documentation": "

A description of the status of the flywheel iteration.

" + } + }, + "EvaluatedModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

The ARN of the evaluated model associated with this flywheel iteration.

" + } + }, + "EvaluatedModelMetrics": { + "target": "com.amazonaws.comprehend#FlywheelModelEvaluationMetrics" + }, + "TrainedModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

The ARN of the trained model associated with this flywheel iteration.

" + } + }, + "TrainedModelMetrics": { + "target": "com.amazonaws.comprehend#FlywheelModelEvaluationMetrics", + "traits": { + "smithy.api#documentation": "

The metrics associated with the trained model.

" + } + }, + "EvaluationManifestS3Prefix": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration properties of a flywheel iteration.

" + } + }, + "com.amazonaws.comprehend#FlywheelIterationPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#FlywheelIterationProperties" + } + }, + "com.amazonaws.comprehend#FlywheelIterationStatus": { + "type": "enum", + "members": { + "TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAINING" + } + }, + "EVALUATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVALUATING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "STOP_REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOP_REQUESTED" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.comprehend#FlywheelModelEvaluationMetrics": { + "type": "structure", + "members": { + "AverageF1Score": { + "target": "com.amazonaws.comprehend#Double", + "traits": { + "smithy.api#documentation": "

The average F1 score from the evaluation metrics.

" + } + }, + "AveragePrecision": { + "target": "com.amazonaws.comprehend#Double", + "traits": { + "smithy.api#documentation": "

Average precision metric for the model.

" + } + }, + "AverageRecall": { + "target": "com.amazonaws.comprehend#Double", + "traits": { + "smithy.api#documentation": "

Average recall metric for the model.

" + } + }, + "AverageAccuracy": { + "target": "com.amazonaws.comprehend#Double", + "traits": { + "smithy.api#documentation": "

Average accuracy metric for the model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The evaluation metrics associated with the evaluated model.

" + } + }, + "com.amazonaws.comprehend#FlywheelProperties": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the flywheel.

" + } + }, + "ActiveModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the active model version.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend permission to access the flywheel data.

" + } + }, + "TaskConfig": { + "target": "com.amazonaws.comprehend#TaskConfig", + "traits": { + "smithy.api#documentation": "

Configuration about the model associated with a flywheel.

" + } + }, + "DataLakeS3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

Amazon S3 URI of the data lake location.

" + } + }, + "DataSecurityConfig": { + "target": "com.amazonaws.comprehend#DataSecurityConfig", + "traits": { + "smithy.api#documentation": "

Data security configuration.

" + } + }, + "Status": { + "target": "com.amazonaws.comprehend#FlywheelStatus", + "traits": { + "smithy.api#documentation": "

The status of the flywheel.

" + } + }, + "ModelType": { + "target": "com.amazonaws.comprehend#ModelType", + "traits": { + "smithy.api#documentation": "

Model type of the flywheel's model.

" + } + }, + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", + "traits": { + "smithy.api#documentation": "

A description of the status of the flywheel.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Creation time of the flywheel.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Last modified time for the flywheel.

" + } + }, + "LatestFlywheelIteration": { + "target": "com.amazonaws.comprehend#FlywheelIterationId", + "traits": { + "smithy.api#documentation": "

The most recent flywheel iteration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The flywheel properties.

" + } + }, + "com.amazonaws.comprehend#FlywheelS3Uri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?$" + } + }, + "com.amazonaws.comprehend#FlywheelStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.comprehend#FlywheelSummary": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the flywheel

" + } + }, + "ActiveModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

ARN of the active model version for the flywheel.

" + } + }, + "DataLakeS3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

Amazon S3 URI of the data lake location.

" + } + }, + "Status": { + "target": "com.amazonaws.comprehend#FlywheelStatus", + "traits": { + "smithy.api#documentation": "

The status of the flywheel.

" + } + }, + "ModelType": { + "target": "com.amazonaws.comprehend#ModelType", + "traits": { + "smithy.api#documentation": "

Model type of the flywheel's model.

" + } + }, + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", + "traits": { + "smithy.api#documentation": "

A description of the status of the flywheel.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Creation time of the flywheel.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Last modified time for the flywheel.

" + } + }, + "LatestFlywheelIteration": { + "target": "com.amazonaws.comprehend#FlywheelIterationId", + "traits": { + "smithy.api#documentation": "

The most recent flywheel iteration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Flywheel summary information.

" + } + }, + "com.amazonaws.comprehend#FlywheelSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#FlywheelSummary" + } + }, + "com.amazonaws.comprehend#Geometry": { + "type": "structure", + "members": { + "BoundingBox": { + "target": "com.amazonaws.comprehend#BoundingBox", + "traits": { + "smithy.api#documentation": "

An axis-aligned coarse representation of the location of the recognized item on the\n document page.

" + } + }, + "Polygon": { + "target": "com.amazonaws.comprehend#Polygon", + "traits": { + "smithy.api#documentation": "

Within the bounding box, a fine-grained polygon around the recognized item.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the location of items on a document page.

\n

For additional information, see Geometry in the Amazon Textract API reference.

" + } + }, + "com.amazonaws.comprehend#IamRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+$" + } + }, + "com.amazonaws.comprehend#ImportModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ImportModelRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ImportModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#KmsKeyValidationException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new custom model that replicates a source custom model that you import. The\n source model can be in your Amazon Web Services account or another one.

\n

If the source model is in another Amazon Web Services account, then it must have a resource-based policy\n that authorizes you to import it.

\n

The source model must be in the same Amazon Web Services Region that you're using when you import. You\n can't import a model that's in a different Region.

" + } + }, + "com.amazonaws.comprehend#ImportModelRequest": { + "type": "structure", + "members": { + "SourceModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom model to import.

", + "smithy.api#required": {} + } + }, + "ModelName": { + "target": "com.amazonaws.comprehend#ComprehendArnName", + "traits": { + "smithy.api#documentation": "

The name to assign to the custom model that is created in Amazon Comprehend by this\n import.

" + } + }, + "VersionName": { + "target": "com.amazonaws.comprehend#VersionName", + "traits": { + "smithy.api#documentation": "

The version name given to the custom model that is created by this import. Version names\n can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_)\n are allowed. The version name must be unique among all models with the same classifier name in\n the account/Region.

" + } + }, + "ModelKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the KMS key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend permission to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom\n model.

" + } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags to associate with the custom model that is created by this import. A tag is a\n key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a\n tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales\n department.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ImportModelResponse": { + "type": "structure", + "members": { + "ModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom model being imported.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#InferenceUnitsInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.comprehend#InputDataConfig": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI for the input data. The URI must be in same Region as the API\n endpoint that you are calling. The URI can point to a single input file or it can provide the\n prefix for a collection of data files.

\n

For example, if you use the URI S3://bucketName/prefix, if the prefix is a\n single file, Amazon Comprehend uses that file as input. If more than one file begins with the\n prefix, Amazon Comprehend uses all of them as input.

", + "smithy.api#required": {} + } + }, + "InputFormat": { + "target": "com.amazonaws.comprehend#InputFormat", + "traits": { + "smithy.api#documentation": "

Specifies how the text in an input file should be processed:

\n
    \n
  • \n

    \n ONE_DOC_PER_FILE - Each file is considered a separate document. Use\n this option when you are processing large documents, such as newspaper articles or\n scientific papers.

    \n
    • \n
  • \n

    \n ONE_DOC_PER_LINE - Each line in a file is considered a separate\n document. Use this option when you are processing many short documents, such as text\n messages.

    \n
    • \n
" + } + }, + "DocumentReaderConfig": { + "target": "com.amazonaws.comprehend#DocumentReaderConfig", + "traits": { + "smithy.api#documentation": "

Provides configuration parameters to override the default actions for extracting text\n from PDF documents and image files.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The input properties for an inference job. The document reader config field applies\n only to non-text inputs for custom analysis.

" + } + }, + "com.amazonaws.comprehend#InputFormat": { + "type": "enum", + "members": { + "ONE_DOC_PER_FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONE_DOC_PER_FILE" + } + }, + "ONE_DOC_PER_LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONE_DOC_PER_LINE" + } + } + } + }, + "com.amazonaws.comprehend#Integer": { + "type": "integer" + }, + "com.amazonaws.comprehend#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.comprehend#String" + } + }, + "traits": { + "smithy.api#documentation": "

An internal server error occurred. Retry your request.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.comprehend#InvalidFilterException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.comprehend#String" + } + }, + "traits": { + "smithy.api#documentation": "

The filter specified for the operation is invalid. Specify a different\n filter.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.comprehend#InvalidRequestDetail": { + "type": "structure", + "members": { + "Reason": { + "target": "com.amazonaws.comprehend#InvalidRequestDetailReason", + "traits": { + "smithy.api#documentation": "

Reason codes include the following values:

\n
    \n
  • \n

    DOCUMENT_SIZE_EXCEEDED - Document size is too large. Check the size of your file and resubmit the request.

    \n
    • \n
  • \n

    UNSUPPORTED_DOC_TYPE - Document type is not supported. Check the file type and resubmit the request.

    \n
    • \n
  • \n

    PAGE_LIMIT_EXCEEDED - Too many pages in the document. Check the number of pages in your file and resubmit the request.

    \n
    • \n
  • \n

    TEXTRACT_ACCESS_DENIED - Access denied to Amazon Textract. Verify that your account has permission to use Amazon Textract API operations and resubmit the request.

    \n
    • \n
  • \n

    NOT_TEXTRACT_JSON - Document is not Amazon Textract JSON format. Verify the format and resubmit the request.

    \n
    • \n
  • \n

    MISMATCHED_TOTAL_PAGE_COUNT - Check the number of pages in your file and resubmit the request.

    \n
    • \n
  • \n

    INVALID_DOCUMENT - Invalid document. Check the file and resubmit the request.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides additional detail about why the request failed.

" + } + }, + "com.amazonaws.comprehend#InvalidRequestDetailReason": { + "type": "enum", + "members": { + "DOCUMENT_SIZE_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCUMENT_SIZE_EXCEEDED" + } + }, + "UNSUPPORTED_DOC_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSUPPORTED_DOC_TYPE" + } + }, + "PAGE_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAGE_LIMIT_EXCEEDED" + } + }, + "TEXTRACT_ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXTRACT_ACCESS_DENIED" + } + } + } + }, + "com.amazonaws.comprehend#InvalidRequestException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.comprehend#String" + }, + "Reason": { + "target": "com.amazonaws.comprehend#InvalidRequestReason" + }, + "Detail": { + "target": "com.amazonaws.comprehend#InvalidRequestDetail" + } + }, + "traits": { + "smithy.api#documentation": "

The request is invalid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.comprehend#InvalidRequestReason": { + "type": "enum", + "members": { + "INVALID_DOCUMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_DOCUMENT" + } + } + } + }, + "com.amazonaws.comprehend#JobId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" + } + }, + "com.amazonaws.comprehend#JobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" + } + }, + "com.amazonaws.comprehend#JobNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.comprehend#String" + } + }, + "traits": { + "smithy.api#documentation": "

The specified job was not found. Check the job ID and try again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.comprehend#JobStatus": { + "type": "enum", + "members": { + "SUBMITTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBMITTED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "STOP_REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOP_REQUESTED" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.comprehend#KeyPhrase": { + "type": "structure", + "members": { + "Score": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of the\n detection.

" + } + }, + "Text": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

The text of a key noun phrase.

" + } + }, + "BeginOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The zero-based offset from the beginning of the source text to the first character in the\n key phrase.

" + } + }, + "EndOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The zero-based offset from the beginning of the source text to the last character in the\n key phrase.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a key noun phrase.

" + } + }, + "com.amazonaws.comprehend#KeyPhrasesDetectionJobFilter": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

Filters on the name of the job.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on job status. Returns only jobs with the specified\n status.

" + } + }, + "SubmitTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.

" + } + }, + "SubmitTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information for filtering a list of dominant language detection jobs. For more\n information, see the operation.

" + } + }, + "com.amazonaws.comprehend#KeyPhrasesDetectionJobProperties": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier assigned to the key phrases detection job.

" + } + }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the key phrases detection job. It is a unique, fully\n qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::key-phrases-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

The name that you assigned the key phrases detection job.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the key phrases detection job. If the status is FAILED,\n the Message field shows the reason for the failure.

" + } + }, + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", + "traits": { + "smithy.api#documentation": "

A description of the status of a job.

" + } + }, + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the key phrases detection job was submitted for processing.

" + } + }, + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the key phrases detection job completed.

" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", + "traits": { + "smithy.api#documentation": "

The input data configuration that you supplied when you created the key phrases detection\n job.

" + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

The output data configuration that you supplied when you created the key phrases detection\n job.

" + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language code of the input documents.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to your input data.

" + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the KMS key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", + "traits": { + "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your key phrases detection job. For more information, see Amazon\n VPC.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a key phrases detection job.

" + } + }, + "com.amazonaws.comprehend#KeyPhrasesDetectionJobPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#KeyPhrasesDetectionJobProperties" + } + }, + "com.amazonaws.comprehend#KmsKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^\\p{ASCII}+$" + } + }, + "com.amazonaws.comprehend#KmsKeyValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.comprehend#String" + } + }, + "traits": { + "smithy.api#documentation": "

The KMS customer managed key (CMK) entered cannot be validated. Verify the key and\n re-enter it.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.comprehend#LabelDelimiter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#pattern": "^[ ~!@#$%^*\\-_+=|\\\\:;\\t>?/]$" + } + }, + "com.amazonaws.comprehend#LabelListItem": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5000 + }, + "smithy.api#pattern": "^\\P{C}*$" + } + }, + "com.amazonaws.comprehend#LabelsList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#LabelListItem" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.comprehend#LanguageCode": { + "type": "enum", + "members": { + "EN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en" + } + }, + "ES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "es" + } + }, + "FR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fr" + } + }, + "DE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "de" + } + }, + "IT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "it" + } + }, + "PT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pt" + } + }, + "AR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ar" + } + }, + "HI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hi" + } + }, + "JA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ja" + } + }, + "KO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ko" + } + }, + "ZH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zh" + } + }, + "ZH_TW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zh-TW" + } + } + } + }, + "com.amazonaws.comprehend#ListDatasets": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListDatasetsRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListDatasetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidFilterException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

List the datasets that you have configured in this Region. For more information about datasets, see \n Flywheel overview in the Amazon Comprehend Developer Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.comprehend#ListDatasetsRequest": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the flywheel.

" + } + }, + "Filter": { + "target": "com.amazonaws.comprehend#DatasetFilter", + "traits": { + "smithy.api#documentation": "

Filters the datasets to be returned in the response.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

Maximum number of results to return in a response. The default is 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ListDatasetsResponse": { + "type": "structure", + "members": { + "DatasetPropertiesList": { + "target": "com.amazonaws.comprehend#DatasetPropertiesList", + "traits": { + "smithy.api#documentation": "

The dataset properties list.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#ListDocumentClassificationJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListDocumentClassificationJobsRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListDocumentClassificationJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidFilterException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of the documentation classification jobs that you have submitted.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.comprehend#ListDocumentClassificationJobsRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.comprehend#DocumentClassificationJobFilter", + "traits": { + "smithy.api#documentation": "

Filters the jobs that are returned. You can filter jobs on their names, status, or the\n date and time that they were submitted. You can only set one filter at a time.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in each page. The default is 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ListDocumentClassificationJobsResponse": { + "type": "structure", + "members": { + "DocumentClassificationJobPropertiesList": { + "target": "com.amazonaws.comprehend#DocumentClassificationJobPropertiesList", + "traits": { + "smithy.api#documentation": "

A list containing the properties of each job returned.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#ListDocumentClassifierSummaries": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListDocumentClassifierSummariesRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListDocumentClassifierSummariesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of summaries of the document classifiers that you have created

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.comprehend#ListDocumentClassifierSummariesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return on each page. The default is 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ListDocumentClassifierSummariesResponse": { + "type": "structure", + "members": { + "DocumentClassifierSummariesList": { + "target": "com.amazonaws.comprehend#DocumentClassifierSummariesList", + "traits": { + "smithy.api#documentation": "

The list of summaries of document classifiers.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#ListDocumentClassifiers": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListDocumentClassifiersRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListDocumentClassifiersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidFilterException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of the document classifiers that you have created.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.comprehend#ListDocumentClassifiersRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.comprehend#DocumentClassifierFilter", + "traits": { + "smithy.api#documentation": "

Filters the jobs that are returned. You can filter jobs on their name, status, or the date\n and time that they were submitted. You can only set one filter at a time.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in each page. The default is 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ListDocumentClassifiersResponse": { + "type": "structure", + "members": { + "DocumentClassifierPropertiesList": { + "target": "com.amazonaws.comprehend#DocumentClassifierPropertiesList", + "traits": { + "smithy.api#documentation": "

A list containing the properties of each job returned.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#ListDominantLanguageDetectionJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListDominantLanguageDetectionJobsRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListDominantLanguageDetectionJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidFilterException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of the dominant language detection jobs that you have submitted.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.comprehend#ListDominantLanguageDetectionJobsRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.comprehend#DominantLanguageDetectionJobFilter", + "traits": { + "smithy.api#documentation": "

Filters that jobs that are returned. You can filter jobs on their name, status, or the\n date and time that they were submitted. You can only set one filter at a time.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in each page. The default is 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ListDominantLanguageDetectionJobsResponse": { + "type": "structure", + "members": { + "DominantLanguageDetectionJobPropertiesList": { + "target": "com.amazonaws.comprehend#DominantLanguageDetectionJobPropertiesList", + "traits": { + "smithy.api#documentation": "

A list containing the properties of each job that is returned.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#ListEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListEndpointsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of all existing endpoints that you've created.\n For information about endpoints, see Managing endpoints.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "EndpointPropertiesList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.comprehend#ListEndpointsRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.comprehend#EndpointFilter", + "traits": { + "smithy.api#documentation": "

Filters the endpoints that are returned. You can filter endpoints on their name, model,\n status, or the date and time that they were created. You can only set one filter at a time.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in each page. The default is 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ListEndpointsResponse": { + "type": "structure", + "members": { + "EndpointPropertiesList": { + "target": "com.amazonaws.comprehend#EndpointPropertiesList", + "traits": { + "smithy.api#documentation": "

Displays a list of endpoint properties being retrieved by the service in response to the\n request.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#ListEntitiesDetectionJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListEntitiesDetectionJobsRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListEntitiesDetectionJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidFilterException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of the entity detection jobs that you have submitted.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.comprehend#ListEntitiesDetectionJobsRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.comprehend#EntitiesDetectionJobFilter", + "traits": { + "smithy.api#documentation": "

Filters the jobs that are returned. You can filter jobs on their name, status, or the date\n and time that they were submitted. You can only set one filter at a time.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in each page. The default is 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ListEntitiesDetectionJobsResponse": { + "type": "structure", + "members": { + "EntitiesDetectionJobPropertiesList": { + "target": "com.amazonaws.comprehend#EntitiesDetectionJobPropertiesList", + "traits": { + "smithy.api#documentation": "

A list containing the properties of each job that is returned.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#ListEntityRecognizerSummaries": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListEntityRecognizerSummariesRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListEntityRecognizerSummariesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of summaries for the entity recognizers that you have created.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.comprehend#ListEntityRecognizerSummariesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return on each page. The default is 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ListEntityRecognizerSummariesResponse": { + "type": "structure", + "members": { + "EntityRecognizerSummariesList": { + "target": "com.amazonaws.comprehend#EntityRecognizerSummariesList", + "traits": { + "smithy.api#documentation": "

The list entity recognizer summaries.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#ListEntityRecognizers": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListEntityRecognizersRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListEntityRecognizersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidFilterException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of the properties of all entity recognizers that you created, including\n recognizers currently in training. Allows you to filter the list of recognizers based on\n criteria such as status and submission time. This call returns up to 500 entity recognizers in\n the list, with a default number of 100 recognizers in the list.

\n

The results of this list are not in any particular order. Please get the list and sort\n locally if needed.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.comprehend#ListEntityRecognizersRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.comprehend#EntityRecognizerFilter", + "traits": { + "smithy.api#documentation": "

Filters the list of entities returned. You can filter on Status,\n SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter\n at a time.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return on each page. The default is 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ListEntityRecognizersResponse": { + "type": "structure", + "members": { + "EntityRecognizerPropertiesList": { + "target": "com.amazonaws.comprehend#EntityRecognizerPropertiesList", + "traits": { + "smithy.api#documentation": "

The list of properties of an entity recognizer.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#ListEventsDetectionJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListEventsDetectionJobsRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListEventsDetectionJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidFilterException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of the events detection jobs that you have submitted.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.comprehend#ListEventsDetectionJobsRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.comprehend#EventsDetectionJobFilter", + "traits": { + "smithy.api#documentation": "

Filters the jobs that are returned. You can filter jobs on their name, status, or the date\n and time that they were submitted. You can only set one filter at a time.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in each page.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ListEventsDetectionJobsResponse": { + "type": "structure", + "members": { + "EventsDetectionJobPropertiesList": { + "target": "com.amazonaws.comprehend#EventsDetectionJobPropertiesList", + "traits": { + "smithy.api#documentation": "

A list containing the properties of each job that is returned.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#ListFlywheelIterationHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListFlywheelIterationHistoryRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListFlywheelIterationHistoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidFilterException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Information about the history of a flywheel iteration.\n For more information about flywheels, see \n Flywheel overview in the Amazon Comprehend Developer Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.comprehend#ListFlywheelIterationHistoryRequest": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "

The ARN of the flywheel.

", + "smithy.api#required": {} + } + }, + "Filter": { + "target": "com.amazonaws.comprehend#FlywheelIterationFilter", + "traits": { + "smithy.api#documentation": "

Filter the flywheel iteration history based on creation time.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Next token

" + } + }, + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

Maximum number of iteration history results to return

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ListFlywheelIterationHistoryResponse": { + "type": "structure", + "members": { + "FlywheelIterationPropertiesList": { + "target": "com.amazonaws.comprehend#FlywheelIterationPropertiesList", + "traits": { + "smithy.api#documentation": "

List of flywheel iteration properties

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Next token

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#ListFlywheels": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListFlywheelsRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListFlywheelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidFilterException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of the flywheels that you have created.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.comprehend#ListFlywheelsRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.comprehend#FlywheelFilter", + "traits": { + "smithy.api#documentation": "

Filters the flywheels that are returned. You can filter flywheels on their status,\n or the date and time that they were submitted. You can only set one filter at a time.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

Maximum number of results to return in a response. The default is 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ListFlywheelsResponse": { + "type": "structure", + "members": { + "FlywheelSummaryList": { + "target": "com.amazonaws.comprehend#FlywheelSummaryList", + "traits": { + "smithy.api#documentation": "

A list of flywheel properties retrieved by the service in response to the request.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#ListKeyPhrasesDetectionJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListKeyPhrasesDetectionJobsRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListKeyPhrasesDetectionJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidFilterException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Get a list of key phrase detection jobs that you have submitted.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.comprehend#ListKeyPhrasesDetectionJobsRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.comprehend#KeyPhrasesDetectionJobFilter", + "traits": { + "smithy.api#documentation": "

Filters the jobs that are returned. You can filter jobs on their name, status, or the date\n and time that they were submitted. You can only set one filter at a time.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in each page. The default is 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ListKeyPhrasesDetectionJobsResponse": { + "type": "structure", + "members": { + "KeyPhrasesDetectionJobPropertiesList": { + "target": "com.amazonaws.comprehend#KeyPhrasesDetectionJobPropertiesList", + "traits": { + "smithy.api#documentation": "

A list containing the properties of each job that is returned.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#ListOfBlockReferences": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#BlockReference" + } + }, + "com.amazonaws.comprehend#ListOfBlocks": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#Block" + } + }, + "com.amazonaws.comprehend#ListOfChildBlocks": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#ChildBlock" + } + }, + "com.amazonaws.comprehend#ListOfClasses": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#DocumentClass" + } + }, + "com.amazonaws.comprehend#ListOfDescriptiveMentionIndices": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#Integer" + } + }, + "com.amazonaws.comprehend#ListOfDetectDominantLanguageResult": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#BatchDetectDominantLanguageItemResult" + } + }, + "com.amazonaws.comprehend#ListOfDetectEntitiesResult": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#BatchDetectEntitiesItemResult" + } + }, + "com.amazonaws.comprehend#ListOfDetectKeyPhrasesResult": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#BatchDetectKeyPhrasesItemResult" + } + }, + "com.amazonaws.comprehend#ListOfDetectSentimentResult": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#BatchDetectSentimentItemResult" + } + }, + "com.amazonaws.comprehend#ListOfDetectSyntaxResult": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#BatchDetectSyntaxItemResult" + } + }, + "com.amazonaws.comprehend#ListOfDetectTargetedSentimentResult": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#BatchDetectTargetedSentimentItemResult" + } + }, + "com.amazonaws.comprehend#ListOfDocumentReadFeatureTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#DocumentReadFeatureTypes" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.comprehend#ListOfDocumentType": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#DocumentTypeListItem" + } + }, + "com.amazonaws.comprehend#ListOfDominantLanguages": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#DominantLanguage" + } + }, + "com.amazonaws.comprehend#ListOfEntities": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#Entity" + } + }, + "com.amazonaws.comprehend#ListOfEntityLabels": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#EntityLabel" + } + }, + "com.amazonaws.comprehend#ListOfErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#ErrorsListItem" + } + }, + "com.amazonaws.comprehend#ListOfExtractedCharacters": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#ExtractedCharactersListItem" + } + }, + "com.amazonaws.comprehend#ListOfKeyPhrases": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#KeyPhrase" + } + }, + "com.amazonaws.comprehend#ListOfLabels": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#DocumentLabel" + } + }, + "com.amazonaws.comprehend#ListOfMentions": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#TargetedSentimentMention" + } + }, + "com.amazonaws.comprehend#ListOfPiiEntities": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#PiiEntity" + } + }, + "com.amazonaws.comprehend#ListOfPiiEntityTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#PiiEntityType" + } + }, + "com.amazonaws.comprehend#ListOfRelationships": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#RelationshipsListItem" + } + }, + "com.amazonaws.comprehend#ListOfSyntaxTokens": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#SyntaxToken" + } + }, + "com.amazonaws.comprehend#ListOfTargetedSentimentEntities": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#TargetedSentimentEntity" + } + }, + "com.amazonaws.comprehend#ListOfTextSegments": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#TextSegment" + }, + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.comprehend#ListOfToxicContent": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#ToxicContent" + } + }, + "com.amazonaws.comprehend#ListOfToxicLabels": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#ToxicLabels" + } + }, + "com.amazonaws.comprehend#ListOfWarnings": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#WarningsListItem" + } + }, + "com.amazonaws.comprehend#ListPiiEntitiesDetectionJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListPiiEntitiesDetectionJobsRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListPiiEntitiesDetectionJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidFilterException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of the PII entity detection jobs that you have submitted.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PiiEntitiesDetectionJobPropertiesList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.comprehend#ListPiiEntitiesDetectionJobsRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.comprehend#PiiEntitiesDetectionJobFilter", + "traits": { + "smithy.api#documentation": "

Filters the jobs that are returned. You can filter jobs on their name, status, or the date\n and time that they were submitted. You can only set one filter at a time.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in each page.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ListPiiEntitiesDetectionJobsResponse": { + "type": "structure", + "members": { + "PiiEntitiesDetectionJobPropertiesList": { + "target": "com.amazonaws.comprehend#PiiEntitiesDetectionJobPropertiesList", + "traits": { + "smithy.api#documentation": "

A list containing the properties of each job that is returned.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#ListSentimentDetectionJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListSentimentDetectionJobsRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListSentimentDetectionJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidFilterException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of sentiment detection jobs that you have submitted.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.comprehend#ListSentimentDetectionJobsRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.comprehend#SentimentDetectionJobFilter", + "traits": { + "smithy.api#documentation": "

Filters the jobs that are returned. You can filter jobs on their name, status, or the date\n and time that they were submitted. You can only set one filter at a time.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in each page. The default is 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ListSentimentDetectionJobsResponse": { + "type": "structure", + "members": { + "SentimentDetectionJobPropertiesList": { + "target": "com.amazonaws.comprehend#SentimentDetectionJobPropertiesList", + "traits": { + "smithy.api#documentation": "

A list containing the properties of each job that is returned.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all tags associated with a given Amazon Comprehend resource.

" + } + }, + "com.amazonaws.comprehend#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are\n querying.

" + } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags associated with the Amazon Comprehend resource being queried. A tag is a key-value\n pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with\n \"Sales\" as the key might be added to a resource to indicate its use by the sales department.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#ListTargetedSentimentDetectionJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListTargetedSentimentDetectionJobsRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListTargetedSentimentDetectionJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidFilterException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of targeted sentiment detection jobs that you have submitted.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.comprehend#ListTargetedSentimentDetectionJobsRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.comprehend#TargetedSentimentDetectionJobFilter", + "traits": { + "smithy.api#documentation": "

Filters the jobs that are returned. You can filter jobs on their name, status, or the date\n and time that they were submitted. You can only set one filter at a time.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in each page. The default is 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ListTargetedSentimentDetectionJobsResponse": { + "type": "structure", + "members": { + "TargetedSentimentDetectionJobPropertiesList": { + "target": "com.amazonaws.comprehend#TargetedSentimentDetectionJobPropertiesList", + "traits": { + "smithy.api#documentation": "

A list containing the properties of each job that is returned.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#ListTopicsDetectionJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListTopicsDetectionJobsRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListTopicsDetectionJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidFilterException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of the topic detection jobs that you have submitted.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.comprehend#ListTopicsDetectionJobsRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.comprehend#TopicsDetectionJobFilter", + "traits": { + "smithy.api#documentation": "

Filters the jobs that are returned. Jobs can be filtered on their name, status, or the\n date and time that they were submitted. You can set only one filter at a time.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in each page. The default is 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ListTopicsDetectionJobsResponse": { + "type": "structure", + "members": { + "TopicsDetectionJobPropertiesList": { + "target": "com.amazonaws.comprehend#TopicsDetectionJobPropertiesList", + "traits": { + "smithy.api#documentation": "

A list containing the properties of each job that is returned.

" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#MaskCharacter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#pattern": "^[!@#$%&*]$" + } + }, + "com.amazonaws.comprehend#MaxResultsInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.comprehend#MentionSentiment": { + "type": "structure", + "members": { + "Sentiment": { + "target": "com.amazonaws.comprehend#SentimentType", + "traits": { + "smithy.api#documentation": "

The sentiment of the mention.

" + } + }, + "SentimentScore": { + "target": "com.amazonaws.comprehend#SentimentScore" + } + }, + "traits": { + "smithy.api#documentation": "

Contains the sentiment and sentiment score for one mention of an entity.

\n

For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.

" + } + }, + "com.amazonaws.comprehend#ModelStatus": { + "type": "enum", + "members": { + "SUBMITTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBMITTED" + } + }, + "TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAINING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "STOP_REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOP_REQUESTED" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "IN_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_ERROR" + } + }, + "TRAINED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAINED" + } + }, + "TRAINED_WITH_WARNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAINED_WITH_WARNING" + } + } + } + }, + "com.amazonaws.comprehend#ModelType": { + "type": "enum", + "members": { + "DOCUMENT_CLASSIFIER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCUMENT_CLASSIFIER" + } + }, + "ENTITY_RECOGNIZER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENTITY_RECOGNIZER" + } + } + } + }, + "com.amazonaws.comprehend#NumberOfDocuments": { + "type": "long" + }, + "com.amazonaws.comprehend#NumberOfTopicsInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.comprehend#OutputDataConfig": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

When you use the OutputDataConfig object with asynchronous operations, you\n specify the Amazon S3 location where you want to write the output data. The URI must be in the\n same Region as the API endpoint that you are calling. The location is used as the prefix for\n the actual location of the output file.

\n

When the topic detection job is finished, the service creates an output file in a\n directory specific to the job. The S3Uri field contains the location of the\n output file, called output.tar.gz. It is a compressed archive that contains the\n ouput of the operation.

\n

\n For a PII entity detection job, the output file is plain text, not a compressed archive.\n The output file name is the same as the input file, with .out appended at the end.\n

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the\n output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric\n key for uploading data to S3.

\n

The KmsKeyId can be one of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    KMS Key Alias: \"alias/ExampleAlias\"\n

    \n
    • \n
  • \n

    ARN of a KMS Key Alias:\n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides configuration parameters for the output of inference jobs.

\n

" + } + }, + "com.amazonaws.comprehend#PageBasedErrorCode": { + "type": "enum", + "members": { + "TEXTRACT_BAD_PAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXTRACT_BAD_PAGE" + } + }, + "TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED" + } + }, + "PAGE_CHARACTERS_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAGE_CHARACTERS_EXCEEDED" + } + }, + "PAGE_SIZE_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAGE_SIZE_EXCEEDED" + } + }, + "INTERNAL_SERVER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVER_ERROR" + } + } + } + }, + "com.amazonaws.comprehend#PageBasedWarningCode": { + "type": "enum", + "members": { + "INFERENCING_PLAINTEXT_WITH_NATIVE_TRAINED_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFERENCING_PLAINTEXT_WITH_NATIVE_TRAINED_MODEL" + } + }, + "INFERENCING_NATIVE_DOCUMENT_WITH_PLAINTEXT_TRAINED_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFERENCING_NATIVE_DOCUMENT_WITH_PLAINTEXT_TRAINED_MODEL" + } + } + } + }, + "com.amazonaws.comprehend#PartOfSpeechTag": { + "type": "structure", + "members": { + "Tag": { + "target": "com.amazonaws.comprehend#PartOfSpeechTagType", + "traits": { + "smithy.api#documentation": "

Identifies the part of speech that the token represents.

" + } + }, + "Score": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The confidence that Amazon Comprehend has that the part of speech was correctly\n identified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Identifies the part of speech represented by the token and gives the confidence that\n Amazon Comprehend has that the part of speech was correctly identified. For more information\n about the parts of speech that Amazon Comprehend can identify, see\n Syntax in the Comprehend Developer Guide.\n

" + } + }, + "com.amazonaws.comprehend#PartOfSpeechTagType": { + "type": "enum", + "members": { + "ADJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADJ" + } + }, + "ADP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADP" + } + }, + "ADV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADV" + } + }, + "AUX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUX" + } + }, + "CONJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONJ" + } + }, + "CCONJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CCONJ" + } + }, + "DET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DET" + } + }, + "INTJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTJ" + } + }, + "NOUN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOUN" + } + }, + "NUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUM" + } + }, + "O": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "O" + } + }, + "PART": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PART" + } + }, + "PRON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRON" + } + }, + "PROPN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROPN" + } + }, + "PUNCT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUNCT" + } + }, + "SCONJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCONJ" + } + }, + "SYM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYM" + } + }, + "VERB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERB" + } + } + } + }, + "com.amazonaws.comprehend#PiiEntitiesDetectionJobFilter": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

Filters on the name of the job.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on job status. Returns only jobs with the specified\n status.

" + } + }, + "SubmitTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.

" + } + }, + "SubmitTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information for filtering a list of PII entity detection jobs.

" + } + }, + "com.amazonaws.comprehend#PiiEntitiesDetectionJobProperties": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier assigned to the PII entities detection job.

" + } + }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully\n qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::pii-entities-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

The name that you assigned the PII entities detection job.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the PII entities detection job. If the status is\n FAILED, the Message field shows the reason for the failure.

" + } + }, + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", + "traits": { + "smithy.api#documentation": "

A description of the status of a job.

" + } + }, + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the PII entities detection job was submitted for processing.

" + } + }, + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the PII entities detection job completed.

" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", + "traits": { + "smithy.api#documentation": "

The input properties for a PII entities detection job.

" + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#PiiOutputDataConfig", + "traits": { + "smithy.api#documentation": "

The output data configuration that you supplied when you created the PII entities\n detection job.

" + } + }, + "RedactionConfig": { + "target": "com.amazonaws.comprehend#RedactionConfig", + "traits": { + "smithy.api#documentation": "

Provides configuration parameters for PII entity redaction.

\n

This parameter is required if you set the Mode parameter to\n ONLY_REDACTION. In that case, you must provide a RedactionConfig\n definition that includes the PiiEntityTypes parameter.

" + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language code of the input documents.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to your input data.

" + } + }, + "Mode": { + "target": "com.amazonaws.comprehend#PiiEntitiesDetectionMode", + "traits": { + "smithy.api#documentation": "

Specifies whether the output provides the locations (offsets) of PII entities or a file in\n which PII entities are redacted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a PII entities detection job.

" + } + }, + "com.amazonaws.comprehend#PiiEntitiesDetectionJobPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#PiiEntitiesDetectionJobProperties" + } + }, + "com.amazonaws.comprehend#PiiEntitiesDetectionMaskMode": { + "type": "enum", + "members": { + "MASK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MASK" + } + }, + "REPLACE_WITH_PII_ENTITY_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLACE_WITH_PII_ENTITY_TYPE" + } + } + } + }, + "com.amazonaws.comprehend#PiiEntitiesDetectionMode": { + "type": "enum", + "members": { + "ONLY_REDACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONLY_REDACTION" + } + }, + "ONLY_OFFSETS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONLY_OFFSETS" + } + } + } + }, + "com.amazonaws.comprehend#PiiEntity": { + "type": "structure", + "members": { + "Score": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of the\n detection.

" + } + }, + "Type": { + "target": "com.amazonaws.comprehend#PiiEntityType", + "traits": { + "smithy.api#documentation": "

The entity's type.

" + } + }, + "BeginOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The zero-based offset from the beginning of the source text to the first character in the\n entity.

" + } + }, + "EndOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The zero-based offset from the beginning of the source text to the last character in the\n entity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a PII entity.

" + } + }, + "com.amazonaws.comprehend#PiiEntityType": { + "type": "enum", + "members": { + "BANK_ACCOUNT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BANK_ACCOUNT_NUMBER" + } + }, + "BANK_ROUTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BANK_ROUTING" + } + }, + "CREDIT_DEBIT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREDIT_DEBIT_NUMBER" + } + }, + "CREDIT_DEBIT_CVV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREDIT_DEBIT_CVV" + } + }, + "CREDIT_DEBIT_EXPIRY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREDIT_DEBIT_EXPIRY" + } + }, + "PIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PIN" + } + }, + "EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL" + } + }, + "ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADDRESS" + } + }, + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + }, + "PHONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PHONE" + } + }, + "SSN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSN" + } + }, + "DATE_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE_TIME" + } + }, + "PASSPORT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSPORT_NUMBER" + } + }, + "DRIVER_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRIVER_ID" + } + }, + "URL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "URL" + } + }, + "AGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGE" + } + }, + "USERNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USERNAME" + } + }, + "PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSWORD" + } + }, + "AWS_ACCESS_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_ACCESS_KEY" + } + }, + "AWS_SECRET_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_SECRET_KEY" + } + }, + "IP_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_ADDRESS" + } + }, + "MAC_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAC_ADDRESS" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "LICENSE_PLATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LICENSE_PLATE" + } + }, + "VEHICLE_IDENTIFICATION_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VEHICLE_IDENTIFICATION_NUMBER" + } + }, + "UK_NATIONAL_INSURANCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_NATIONAL_INSURANCE_NUMBER" + } + }, + "CA_SOCIAL_INSURANCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_SOCIAL_INSURANCE_NUMBER" + } + }, + "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" + } + }, + "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" + } + }, + "IN_PERMANENT_ACCOUNT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PERMANENT_ACCOUNT_NUMBER" + } + }, + "IN_NREGA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_NREGA" + } + }, + "INTERNATIONAL_BANK_ACCOUNT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNATIONAL_BANK_ACCOUNT_NUMBER" + } + }, + "SWIFT_CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SWIFT_CODE" + } + }, + "UK_NATIONAL_HEALTH_SERVICE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_NATIONAL_HEALTH_SERVICE_NUMBER" + } + }, + "CA_HEALTH_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_HEALTH_NUMBER" + } + }, + "IN_AADHAAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_AADHAAR" + } + }, + "IN_VOTER_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_VOTER_NUMBER" + } + } + } + }, + "com.amazonaws.comprehend#PiiOutputDataConfig": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

When you use the PiiOutputDataConfig object with asynchronous operations,\n you specify the Amazon S3 location where you want to write the output data.

\n

\n For a PII entity detection job, the output file is plain text, not a compressed archive.\n The output file name is the same as the input file, with .out appended at the end.\n

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the\n output results from an analysis job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides configuration parameters for the output of PII entity detection jobs.

" + } + }, + "com.amazonaws.comprehend#Point": { + "type": "structure", + "members": { + "X": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The value of the X coordinate for a point on a polygon

" + } + }, + "Y": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The value of the Y coordinate for a point on a polygon

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The X and Y coordinates of a point on a document page.

\n

For additional information, see Point in the Amazon Textract API reference.

" + } + }, + "com.amazonaws.comprehend#Policy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20000 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.comprehend#PolicyRevisionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[0-9A-Fa-f]+$" + } + }, + "com.amazonaws.comprehend#Polygon": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#Point" + } + }, + "com.amazonaws.comprehend#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#PutResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#PutResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches a resource-based policy to a custom model. You can use this policy to authorize\n an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon\n Comprehend in their account.

" + } + }, + "com.amazonaws.comprehend#PutResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom model to attach the policy to.

", + "smithy.api#required": {} + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.comprehend#Policy", + "traits": { + "smithy.api#documentation": "

The JSON resource-based policy to attach to your custom model. Provide your JSON as a\n UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the\n attribute names and values in double quotes. If the JSON body is also enclosed in double\n quotes, then you must escape the double quotes that are inside the policy:

\n

\n \"{\\\"attribute\\\": \\\"value\\\", \\\"attribute\\\": [\\\"value\\\"]}\"\n

\n

To avoid escaping quotes, you can use single quotes to enclose the policy and double\n quotes to enclose the JSON names and values:

\n

\n '{\"attribute\": \"value\", \"attribute\": [\"value\"]}'\n

", + "smithy.api#required": {} + } + }, + "PolicyRevisionId": { + "target": "com.amazonaws.comprehend#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "

The revision ID that Amazon Comprehend assigned to the policy that you are updating. If\n you are creating a new policy that has no prior version, don't use this parameter. Amazon\n Comprehend creates the revision ID for you.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#PutResourcePolicyResponse": { + "type": "structure", + "members": { + "PolicyRevisionId": { + "target": "com.amazonaws.comprehend#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "

The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a\n new revision ID, and it deletes the prior version of the policy.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#RedactionConfig": { + "type": "structure", + "members": { + "PiiEntityTypes": { + "target": "com.amazonaws.comprehend#ListOfPiiEntityTypes", + "traits": { + "smithy.api#documentation": "

An array of the types of PII entities that Amazon Comprehend detects in the input text for\n your request.

" + } + }, + "MaskMode": { + "target": "com.amazonaws.comprehend#PiiEntitiesDetectionMaskMode", + "traits": { + "smithy.api#documentation": "

Specifies whether the PII entity is redacted with the mask character or the entity\n type.

" + } + }, + "MaskCharacter": { + "target": "com.amazonaws.comprehend#MaskCharacter", + "traits": { + "smithy.api#documentation": "

A character that replaces each character in the redacted PII entity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides configuration parameters for PII entity redaction.

" + } + }, + "com.amazonaws.comprehend#RelationshipType": { + "type": "enum", + "members": { + "CHILD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHILD" + } + } + } + }, + "com.amazonaws.comprehend#RelationshipsListItem": { + "type": "structure", + "members": { + "Ids": { + "target": "com.amazonaws.comprehend#StringList", + "traits": { + "smithy.api#documentation": "

Identifers of the child blocks.

" + } + }, + "Type": { + "target": "com.amazonaws.comprehend#RelationshipType", + "traits": { + "smithy.api#documentation": "

Only supported relationship is a child relationship.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

List of child blocks for the current block.

" + } + }, + "com.amazonaws.comprehend#ResourceInUseException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.comprehend#String" + } + }, + "traits": { + "smithy.api#documentation": "

The specified resource name is already in use. Use a different name and try your request\n again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.comprehend#ResourceLimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.comprehend#String" + } + }, + "traits": { + "smithy.api#documentation": "

The maximum number of resources per account has been exceeded. Review the resources, and\n then try your request again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.comprehend#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.comprehend#String" + } + }, + "traits": { + "smithy.api#documentation": "

The specified resource ARN was not found. Check the ARN and try your request again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.comprehend#ResourceUnavailableException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.comprehend#String" + } + }, + "traits": { + "smithy.api#documentation": "

The specified resource is not available. Check the resource and try your request\n again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.comprehend#S3Uri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?$" + } + }, + "com.amazonaws.comprehend#SecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.comprehend#SecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#SecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.comprehend#SemiStructuredDocumentBlob": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.comprehend#SentimentDetectionJobFilter": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

Filters on the name of the job.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on job status. Returns only jobs with the specified\n status.

" + } + }, + "SubmitTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.

" + } + }, + "SubmitTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information for filtering a list of dominant language detection jobs. For more\n information, see the operation.

" + } + }, + "com.amazonaws.comprehend#SentimentDetectionJobProperties": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier assigned to the sentiment detection job.

" + } + }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully\n qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::sentiment-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

The name that you assigned to the sentiment detection job

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the sentiment detection job. If the status is FAILED,\n the Messages field shows the reason for the failure.

" + } + }, + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", + "traits": { + "smithy.api#documentation": "

A description of the status of a job.

" + } + }, + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the sentiment detection job was submitted for processing.

" + } + }, + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the sentiment detection job ended.

" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", + "traits": { + "smithy.api#documentation": "

The input data configuration that you supplied when you created the sentiment detection\n job.

" + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

The output data configuration that you supplied when you created the sentiment detection\n job.

" + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language code of the input documents.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to your input data.

" + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", + "traits": { + "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your sentiment detection job. For more information, see Amazon\n VPC.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a sentiment detection job.

" + } + }, + "com.amazonaws.comprehend#SentimentDetectionJobPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#SentimentDetectionJobProperties" + } + }, + "com.amazonaws.comprehend#SentimentScore": { + "type": "structure", + "members": { + "Positive": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of its detection of\n the POSITIVE sentiment.

" + } + }, + "Negative": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of its detection of\n the NEGATIVE sentiment.

" + } + }, + "Neutral": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of its detection of\n the NEUTRAL sentiment.

" + } + }, + "Mixed": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of its detection of\n the MIXED sentiment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the level of confidence that Amazon Comprehend has in the accuracy of its\n detection of sentiments.

" + } + }, + "com.amazonaws.comprehend#SentimentType": { + "type": "enum", + "members": { + "POSITIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSITIVE" + } + }, + "NEGATIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEGATIVE" + } + }, + "NEUTRAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEUTRAL" + } + }, + "MIXED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIXED" + } + } + } + }, + "com.amazonaws.comprehend#Split": { + "type": "enum", + "members": { + "TRAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAIN" + } + }, + "TEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEST" + } + } + } + }, + "com.amazonaws.comprehend#StartDocumentClassificationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StartDocumentClassificationJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StartDocumentClassificationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#KmsKeyValidationException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an asynchronous document classification job using a custom classification model. Use the \n DescribeDocumentClassificationJob\n operation to track the progress of the job.

" + } + }, + "com.amazonaws.comprehend#StartDocumentClassificationJobRequest": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

The identifier of the job.

" + } + }, + "DocumentClassifierArn": { + "target": "com.amazonaws.comprehend#DocumentClassifierArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the document classifier to use to process the\n job.

" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", + "traits": { + "smithy.api#documentation": "

Specifies the format and location of the input data for the job.

", + "smithy.api#required": {} + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

Specifies where to send the output files.

", + "smithy.api#required": {} + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to your input data.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "

A unique identifier for the request. If you do not set the client request token, Amazon\n Comprehend generates one.

", + "smithy.api#idempotencyToken": {} + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", + "traits": { + "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your document classification job. For more information, see\n Amazon\n VPC.

" + } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags to associate with the document classification job. A tag is a key-value pair that\n adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the\n key might be added to a resource to indicate its use by the sales department.

" + } + }, + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the flywheel associated with the model to use.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#StartDocumentClassificationJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier generated for the job. To get the status of the job, use this identifier\n with the DescribeDocumentClassificationJob operation.

" + } + }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully\n qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::document-classification-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The status of the job:

\n
    \n
  • \n

    SUBMITTED - The job has been received and queued for processing.

    \n
    • \n
  • \n

    IN_PROGRESS - Amazon Comprehend is processing the job.

    \n
    • \n
  • \n

    COMPLETED - The job was successfully completed and the output is available.

    \n
    • \n
  • \n

    FAILED - The job did not complete. For details, use the \n DescribeDocumentClassificationJob operation.

    \n
    • \n
  • \n

    STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is\n processing the request.

    \n
    • \n
  • \n

    STOPPED - The job was successfully stopped without completing.

    \n
    • \n
" + } + }, + "DocumentClassifierArn": { + "target": "com.amazonaws.comprehend#DocumentClassifierArn", + "traits": { + "smithy.api#documentation": "

The ARN of the custom classification model.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#StartDominantLanguageDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StartDominantLanguageDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StartDominantLanguageDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#KmsKeyValidationException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an asynchronous dominant language detection job for a collection of documents. Use\n the operation to track the status\n of a job.

" + } + }, + "com.amazonaws.comprehend#StartDominantLanguageDetectionJobRequest": { + "type": "structure", + "members": { + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", + "traits": { + "smithy.api#documentation": "

Specifies the format and location of the input data for the job.

", + "smithy.api#required": {} + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

Specifies where to send the output files.

", + "smithy.api#required": {} + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

", + "smithy.api#required": {} + } + }, + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

An identifier for the job.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "

A unique identifier for the request. If you do not set the client request token, Amazon\n Comprehend generates one.

", + "smithy.api#idempotencyToken": {} + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", + "traits": { + "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your dominant language detection job. For more information,\n see Amazon VPC.

" + } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags to associate with the dominant language detection job. A tag is a key-value pair\n that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as\n the key might be added to a resource to indicate its use by the sales department.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#StartDominantLanguageDetectionJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier generated for the job. To get the status of a job, use this identifier with\n the operation.

" + } + }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique,\n fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID.\n The format of the ARN is as follows:

\n

\n arn::comprehend:::dominant-language-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The status of the job.

\n
    \n
  • \n

    SUBMITTED - The job has been received and is queued for processing.

    \n
    • \n
  • \n

    IN_PROGRESS - Amazon Comprehend is processing the job.

    \n
    • \n
  • \n

    COMPLETED - The job was successfully completed and the output is available.

    \n
    • \n
  • \n

    FAILED - The job did not complete. To get details, use the operation.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#StartEntitiesDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StartEntitiesDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StartEntitiesDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#KmsKeyValidationException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.

\n

This API can be used for either standard entity detection or custom entity recognition. In\n order to be used for custom entity recognition, the optional EntityRecognizerArn\n must be used in order to provide access to the recognizer being used to detect the custom\n entity.

" + } + }, + "com.amazonaws.comprehend#StartEntitiesDetectionJobRequest": { + "type": "structure", + "members": { + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", + "traits": { + "smithy.api#documentation": "

Specifies the format and location of the input data for the job.

", + "smithy.api#required": {} + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

Specifies where to send the output files.

", + "smithy.api#required": {} + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

", + "smithy.api#required": {} + } + }, + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

The identifier of the job.

" + } + }, + "EntityRecognizerArn": { + "target": "com.amazonaws.comprehend#EntityRecognizerArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used\n by the StartEntitiesDetectionJob. This ARN is optional and is only used for a\n custom entity recognition job.

" + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input documents. All documents must be in the same language. You can\n specify any of the languages supported by Amazon Comprehend. If custom entities recognition is\n used, this parameter is ignored and the language used for training the model is used\n instead.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.

", + "smithy.api#idempotencyToken": {} + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", + "traits": { + "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your entity detection job. For more information, see Amazon\n VPC.

" + } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags to associate with the entities detection job. A tag is a key-value pair that adds\n metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key\n might be added to a resource to indicate its use by the sales department.

" + } + }, + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the flywheel associated with the model to use.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#StartEntitiesDetectionJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier generated for the job. To get the status of job, use this identifier with\n the operation.

" + } + }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully\n qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::entities-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The status of the job.

\n
    \n
  • \n

    SUBMITTED - The job has been received and is queued for processing.

    \n
    • \n
  • \n

    IN_PROGRESS - Amazon Comprehend is processing the job.

    \n
    • \n
  • \n

    COMPLETED - The job was successfully completed and the output is available.

    \n
    • \n
  • \n

    FAILED - The job did not complete. To get details, use the operation.

    \n
    • \n
  • \n

    STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is\n processing the request.

    \n
    • \n
  • \n

    STOPPED - The job was successfully stopped without completing.

    \n
    • \n
" + } + }, + "EntityRecognizerArn": { + "target": "com.amazonaws.comprehend#EntityRecognizerArn", + "traits": { + "smithy.api#documentation": "

The ARN of the custom entity recognition model.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#StartEventsDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StartEventsDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StartEventsDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#KmsKeyValidationException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an asynchronous event detection job for a collection of documents.

" + } + }, + "com.amazonaws.comprehend#StartEventsDetectionJobRequest": { + "type": "structure", + "members": { + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", + "traits": { + "smithy.api#documentation": "

Specifies the format and location of the input data for the job.

", + "smithy.api#required": {} + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

Specifies where to send the output files.

", + "smithy.api#required": {} + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to your input data.

", + "smithy.api#required": {} + } + }, + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

The identifier of the events detection job.

" + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language code of the input documents.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "

An unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.

", + "smithy.api#idempotencyToken": {} + } + }, + "TargetEventTypes": { + "target": "com.amazonaws.comprehend#TargetEventTypes", + "traits": { + "smithy.api#documentation": "

The types of events to detect in the input documents.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags to associate with the events detection job. A tag is a key-value pair that adds\n metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key\n might be added to a resource to indicate its use by the sales department.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#StartEventsDetectionJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

An unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.

" + } + }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully\n qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::events-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The status of the events detection job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#StartFlywheelIteration": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StartFlywheelIterationRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StartFlywheelIterationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Start the flywheel iteration.This operation uses any new datasets to train a new model version.\n For more information about flywheels, see \n Flywheel overview in the Amazon Comprehend Developer Guide.

" + } + }, + "com.amazonaws.comprehend#StartFlywheelIterationRequest": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "

The ARN of the flywheel.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#StartFlywheelIterationResponse": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "

" + } + }, + "FlywheelIterationId": { + "target": "com.amazonaws.comprehend#FlywheelIterationId", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#StartKeyPhrasesDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StartKeyPhrasesDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StartKeyPhrasesDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#KmsKeyValidationException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an asynchronous key phrase detection job for a collection of documents. Use the\n operation to track the status of a\n job.

" + } + }, + "com.amazonaws.comprehend#StartKeyPhrasesDetectionJobRequest": { + "type": "structure", + "members": { + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", + "traits": { + "smithy.api#documentation": "

Specifies the format and location of the input data for the job.

", + "smithy.api#required": {} + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

Specifies where to send the output files.

", + "smithy.api#required": {} + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

", + "smithy.api#required": {} + } + }, + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

The identifier of the job.

" + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.

", + "smithy.api#idempotencyToken": {} + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", + "traits": { + "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your key phrases detection job. For more information, see\n Amazon\n VPC.

" + } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags to associate with the key phrases detection job. A tag is a key-value pair that\n adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the\n key might be added to a resource to indicate its use by the sales department.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#StartKeyPhrasesDetectionJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier generated for the job. To get the status of a job, use this identifier with\n the operation.

" + } + }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the key phrase detection job. It is a unique, fully\n qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::key-phrases-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The status of the job.

\n
    \n
  • \n

    SUBMITTED - The job has been received and is queued for processing.

    \n
    • \n
  • \n

    IN_PROGRESS - Amazon Comprehend is processing the job.

    \n
    • \n
  • \n

    COMPLETED - The job was successfully completed and the output is available.

    \n
    • \n
  • \n

    FAILED - The job did not complete. To get details, use the operation.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#StartPiiEntitiesDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StartPiiEntitiesDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StartPiiEntitiesDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#KmsKeyValidationException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an asynchronous PII entity detection job for a collection of documents.

" + } + }, + "com.amazonaws.comprehend#StartPiiEntitiesDetectionJobRequest": { + "type": "structure", + "members": { + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", + "traits": { + "smithy.api#documentation": "

The input properties for a PII entities detection job.

", + "smithy.api#required": {} + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

Provides configuration parameters for the output of PII entity detection jobs.

", + "smithy.api#required": {} + } + }, + "Mode": { + "target": "com.amazonaws.comprehend#PiiEntitiesDetectionMode", + "traits": { + "smithy.api#documentation": "

Specifies whether the output provides the locations (offsets) of PII entities or a file in\n which PII entities are redacted.

", + "smithy.api#required": {} + } + }, + "RedactionConfig": { + "target": "com.amazonaws.comprehend#RedactionConfig", + "traits": { + "smithy.api#documentation": "

Provides configuration parameters for PII entity redaction.

\n

This parameter is required if you set the Mode parameter to\n ONLY_REDACTION. In that case, you must provide a RedactionConfig\n definition that includes the PiiEntityTypes parameter.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to your input data.

", + "smithy.api#required": {} + } + }, + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

The identifier of the job.

" + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input documents. \n Enter the language code for English (en) or Spanish (es).

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.

", + "smithy.api#idempotencyToken": {} + } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags to associate with the PII entities detection job. A tag is a key-value pair that\n adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the\n key might be added to a resource to indicate its use by the sales department.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#StartPiiEntitiesDetectionJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier generated for the job.

" + } + }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the PII entity detection job. It is a unique, fully\n qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::pii-entities-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The status of the job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#StartSentimentDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StartSentimentDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StartSentimentDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#KmsKeyValidationException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an asynchronous sentiment detection job for a collection of documents. Use the\n operation to track the status of a\n job.

" + } + }, + "com.amazonaws.comprehend#StartSentimentDetectionJobRequest": { + "type": "structure", + "members": { + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", + "traits": { + "smithy.api#documentation": "

Specifies the format and location of the input data for the job.

", + "smithy.api#required": {} + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

Specifies where to send the output files.

", + "smithy.api#required": {} + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

", + "smithy.api#required": {} + } + }, + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

The identifier of the job.

" + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.

", + "smithy.api#idempotencyToken": {} + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", + "traits": { + "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your sentiment detection job. For more information, see Amazon\n VPC.

" + } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags to associate with the sentiment detection job. A tag is a key-value pair that\n adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the\n key might be added to a resource to indicate its use by the sales department.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#StartSentimentDetectionJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier generated for the job. To get the status of a job, use this identifier with\n the operation.

" + } + }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully\n qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::sentiment-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The status of the job.

\n
    \n
  • \n

    SUBMITTED - The job has been received and is queued for processing.

    \n
    • \n
  • \n

    IN_PROGRESS - Amazon Comprehend is processing the job.

    \n
    • \n
  • \n

    COMPLETED - The job was successfully completed and the output is available.

    \n
    • \n
  • \n

    FAILED - The job did not complete. To get details, use the operation.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#StartTargetedSentimentDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StartTargetedSentimentDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StartTargetedSentimentDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#KmsKeyValidationException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the\n DescribeTargetedSentimentDetectionJob operation to track the status of a\n job.

" + } + }, + "com.amazonaws.comprehend#StartTargetedSentimentDetectionJobRequest": { + "type": "structure", + "members": { + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", + "traits": { + "smithy.api#required": {} + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

Specifies where to send the output files.

", + "smithy.api#required": {} + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

", + "smithy.api#required": {} + } + }, + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

The identifier of the job.

" + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input documents. Currently, English is the only supported language.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.

", + "smithy.api#idempotencyToken": {} + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the KMS key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig" + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags to associate with the targeted sentiment detection job. A tag is a key-value pair that\n adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the\n key might be added to a resource to indicate its use by the sales department.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#StartTargetedSentimentDetectionJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier generated for the job. To get the status of a job, use this identifier with\n the DescribeTargetedSentimentDetectionJob operation.

" + } + }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully\n qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::targeted-sentiment-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The status of the job.

\n
    \n
  • \n

    SUBMITTED - The job has been received and is queued for processing.

    \n
    • \n
  • \n

    IN_PROGRESS - Amazon Comprehend is processing the job.

    \n
    • \n
  • \n

    COMPLETED - The job was successfully completed and the output is available.

    \n
    • \n
  • \n

    FAILED - The job did not complete. To get details, use the \n DescribeTargetedSentimentDetectionJob operation.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#StartTopicsDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StartTopicsDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StartTopicsDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#KmsKeyValidationException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an asynchronous topic detection job. Use the\n DescribeTopicDetectionJob operation to track the status of a job.

" + } + }, + "com.amazonaws.comprehend#StartTopicsDetectionJobRequest": { + "type": "structure", + "members": { + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", + "traits": { + "smithy.api#documentation": "

Specifies the format and location of the input data for the job.

", + "smithy.api#required": {} + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

Specifies where to send the output files. The output is a compressed archive with two\n files, topic-terms.csv that lists the terms associated with each topic, and\n doc-topics.csv that lists the documents associated with each topic

", + "smithy.api#required": {} + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

", + "smithy.api#required": {} + } + }, + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

The identifier of the job.

" + } + }, + "NumberOfTopics": { + "target": "com.amazonaws.comprehend#NumberOfTopicsInteger", + "traits": { + "smithy.api#documentation": "

The number of topics to detect.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "

A unique identifier for the request. If you do not set the client request token, Amazon\n Comprehend generates one.

", + "smithy.api#idempotencyToken": {} + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", + "traits": { + "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your topic detection job. For more information, see Amazon\n VPC.

" + } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags to associate with the topics detection job. A tag is a key-value pair that adds\n metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key\n might be added to a resource to indicate its use by the sales department.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#StartTopicsDetectionJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier generated for the job. To get the status of the job, use this identifier\n with the DescribeTopicDetectionJob operation.

" + } + }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully\n qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::topics-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The status of the job:

\n
    \n
  • \n

    SUBMITTED - The job has been received and is queued for processing.

    \n
    • \n
  • \n

    IN_PROGRESS - Amazon Comprehend is processing the job.

    \n
    • \n
  • \n

    COMPLETED - The job was successfully completed and the output is\n available.

    \n
    • \n
  • \n

    FAILED - The job did not complete. To get details, use the\n DescribeTopicDetectionJob operation.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#StopDominantLanguageDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StopDominantLanguageDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StopDominantLanguageDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#JobNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a dominant language detection job in progress.

\n

If the job state is IN_PROGRESS the job is marked for termination and put\n into the STOP_REQUESTED state. If the job completes before it can be stopped, it\n is put into the COMPLETED state; otherwise the job is stopped and put into the\n STOPPED state.

\n

If the job is in the COMPLETED or FAILED state when you call the\n StopDominantLanguageDetectionJob operation, the operation returns a 400\n Internal Request Exception.

\n

When a job is stopped, any documents already processed are written to the output\n location.

" + } + }, + "com.amazonaws.comprehend#StopDominantLanguageDetectionJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier of the dominant language detection job to stop.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#StopDominantLanguageDetectionJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier of the dominant language detection job to stop.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

Either STOP_REQUESTED if the job is currently running, or\n STOPPED if the job was previously stopped with the\n StopDominantLanguageDetectionJob operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#StopEntitiesDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StopEntitiesDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StopEntitiesDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#JobNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops an entities detection job in progress.

\n

If the job state is IN_PROGRESS the job is marked for termination and put\n into the STOP_REQUESTED state. If the job completes before it can be stopped, it\n is put into the COMPLETED state; otherwise the job is stopped and put into the\n STOPPED state.

\n

If the job is in the COMPLETED or FAILED state when you call the\n StopDominantLanguageDetectionJob operation, the operation returns a 400\n Internal Request Exception.

\n

When a job is stopped, any documents already processed are written to the output\n location.

" + } + }, + "com.amazonaws.comprehend#StopEntitiesDetectionJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier of the entities detection job to stop.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#StopEntitiesDetectionJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier of the entities detection job to stop.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

Either STOP_REQUESTED if the job is currently running, or\n STOPPED if the job was previously stopped with the\n StopEntitiesDetectionJob operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#StopEventsDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StopEventsDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StopEventsDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#JobNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops an events detection job in progress.

" + } + }, + "com.amazonaws.comprehend#StopEventsDetectionJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier of the events detection job to stop.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#StopEventsDetectionJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier of the events detection job to stop.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The status of the events detection job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#StopKeyPhrasesDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StopKeyPhrasesDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StopKeyPhrasesDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#JobNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a key phrases detection job in progress.

\n

If the job state is IN_PROGRESS the job is marked for termination and put\n into the STOP_REQUESTED state. If the job completes before it can be stopped, it\n is put into the COMPLETED state; otherwise the job is stopped and put into the\n STOPPED state.

\n

If the job is in the COMPLETED or FAILED state when you call the\n StopDominantLanguageDetectionJob operation, the operation returns a 400\n Internal Request Exception.

\n

When a job is stopped, any documents already processed are written to the output\n location.

" + } + }, + "com.amazonaws.comprehend#StopKeyPhrasesDetectionJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier of the key phrases detection job to stop.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#StopKeyPhrasesDetectionJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier of the key phrases detection job to stop.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

Either STOP_REQUESTED if the job is currently running, or\n STOPPED if the job was previously stopped with the\n StopKeyPhrasesDetectionJob operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#StopPiiEntitiesDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StopPiiEntitiesDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StopPiiEntitiesDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#JobNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a PII entities detection job in progress.

" + } + }, + "com.amazonaws.comprehend#StopPiiEntitiesDetectionJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier of the PII entities detection job to stop.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#StopPiiEntitiesDetectionJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier of the PII entities detection job to stop.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The status of the PII entities detection job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#StopSentimentDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StopSentimentDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StopSentimentDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#JobNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a sentiment detection job in progress.

\n

If the job state is IN_PROGRESS, the job is marked for termination and put\n into the STOP_REQUESTED state. If the job completes before it can be stopped, it\n is put into the COMPLETED state; otherwise the job is be stopped and put into the\n STOPPED state.

\n

If the job is in the COMPLETED or FAILED state when you call the\n StopDominantLanguageDetectionJob operation, the operation returns a 400\n Internal Request Exception.

\n

When a job is stopped, any documents already processed are written to the output\n location.

" + } + }, + "com.amazonaws.comprehend#StopSentimentDetectionJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier of the sentiment detection job to stop.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#StopSentimentDetectionJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier of the sentiment detection job to stop.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

Either STOP_REQUESTED if the job is currently running, or\n STOPPED if the job was previously stopped with the\n StopSentimentDetectionJob operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#StopTargetedSentimentDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StopTargetedSentimentDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StopTargetedSentimentDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#JobNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a targeted sentiment detection job in progress.

\n

If the job state is IN_PROGRESS, the job is marked for termination and put\n into the STOP_REQUESTED state. If the job completes before it can be stopped, it\n is put into the COMPLETED state; otherwise the job is be stopped and put into the\n STOPPED state.

\n

If the job is in the COMPLETED or FAILED state when you call the\n StopDominantLanguageDetectionJob operation, the operation returns a 400\n Internal Request Exception.

\n

When a job is stopped, any documents already processed are written to the output\n location.

" + } + }, + "com.amazonaws.comprehend#StopTargetedSentimentDetectionJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier of the targeted sentiment detection job to stop.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#StopTargetedSentimentDetectionJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier of the targeted sentiment detection job to stop.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

Either STOP_REQUESTED if the job is currently running, or\n STOPPED if the job was previously stopped with the\n StopSentimentDetectionJob operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#StopTrainingDocumentClassifier": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StopTrainingDocumentClassifierRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StopTrainingDocumentClassifierResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a document classifier training job while in progress.

\n

If the training job state is TRAINING, the job is marked for termination and\n put into the STOP_REQUESTED state. If the training job completes before it can be\n stopped, it is put into the TRAINED; otherwise the training job is stopped and\n put into the STOPPED state and the service sends back an HTTP 200 response with\n an empty HTTP body.

" + } + }, + "com.amazonaws.comprehend#StopTrainingDocumentClassifierRequest": { + "type": "structure", + "members": { + "DocumentClassifierArn": { + "target": "com.amazonaws.comprehend#DocumentClassifierArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the document classifier currently being\n trained.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#StopTrainingDocumentClassifierResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#StopTrainingEntityRecognizer": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StopTrainingEntityRecognizerRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StopTrainingEntityRecognizerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops an entity recognizer training job while in progress.

\n

If the training job state is TRAINING, the job is marked for termination and\n put into the STOP_REQUESTED state. If the training job completes before it can be\n stopped, it is put into the TRAINED; otherwise the training job is stopped and\n putted into the STOPPED state and the service sends back an HTTP 200 response\n with an empty HTTP body.

" + } + }, + "com.amazonaws.comprehend#StopTrainingEntityRecognizerRequest": { + "type": "structure", + "members": { + "EntityRecognizerArn": { + "target": "com.amazonaws.comprehend#EntityRecognizerArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the entity recognizer currently being\n trained.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#StopTrainingEntityRecognizerResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#String": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.comprehend#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#String" + } + }, + "com.amazonaws.comprehend#SubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.comprehend#Subnets": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#SubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.comprehend#SyntaxLanguageCode": { + "type": "enum", + "members": { + "EN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en" + } + }, + "ES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "es" + } + }, + "FR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fr" + } + }, + "DE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "de" + } + }, + "IT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "it" + } + }, + "PT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pt" + } + } + } + }, + "com.amazonaws.comprehend#SyntaxToken": { + "type": "structure", + "members": { + "TokenId": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

A unique identifier for a token.

" + } + }, + "Text": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

The word that was recognized in the source text.

" + } + }, + "BeginOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The zero-based offset from the beginning of the source text to the first character in the\n word.

" + } + }, + "EndOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The zero-based offset from the beginning of the source text to the last character in the\n word.

" + } + }, + "PartOfSpeech": { + "target": "com.amazonaws.comprehend#PartOfSpeechTag", + "traits": { + "smithy.api#documentation": "

Provides the part of speech label and the confidence level that Amazon Comprehend has that\n the part of speech was correctly identified. For more information, see\n Syntax in the Comprehend Developer Guide.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a work in the input text that was recognized and assigned a part of speech.\n There is one syntax token record for each word in the source text.

" + } + }, + "com.amazonaws.comprehend#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.comprehend#TagKey", + "traits": { + "smithy.api#documentation": "

The initial part of a key-value pair that forms a tag associated with a given resource.\n For instance, if you want to show which resources are used by which departments, you might use\n “Department” as the key portion of the pair, with multiple possible values such as “sales,”\n “legal,” and “administration.”

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.comprehend#TagValue", + "traits": { + "smithy.api#documentation": "

The second part of a key-value pair that forms a tag associated with a given resource.\n For instance, if you want to show which resources are used by which departments, you might use\n “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the\n sales department.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For\n example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to\n indicate its use by a particular department.

" + } + }, + "com.amazonaws.comprehend#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.comprehend#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#TagKey" + } + }, + "com.amazonaws.comprehend#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#Tag" + } + }, + "com.amazonaws.comprehend#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair\n that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with\n \"Sales\" as the key might be added to a resource to indicate its use by the sales department.\n

" + } + }, + "com.amazonaws.comprehend#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want\n to associate the tags.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags being associated with a specific Amazon Comprehend resource. There can be a maximum\n of 50 tags (both existing and pending) associated with a specific resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.comprehend#TargetEventTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#EventTypeString" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.comprehend#TargetedSentimentDetectionJobFilter": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

Filters on the name of the job.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on job status. Returns only jobs with the specified\n status.

" + } + }, + "SubmitTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.

" + } + }, + "SubmitTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information for filtering a list of dominant language detection jobs. For more\n information, see the ListTargetedSentimentDetectionJobs operation.

" + } + }, + "com.amazonaws.comprehend#TargetedSentimentDetectionJobProperties": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier assigned to the targeted sentiment detection job.

" + } + }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully\n qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::targeted-sentiment-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

The name that you assigned to the targeted sentiment detection job.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the targeted sentiment detection job. If the status is FAILED,\n the Messages field shows the reason for the failure.

" + } + }, + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", + "traits": { + "smithy.api#documentation": "

A description of the status of a job.

" + } + }, + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the targeted sentiment detection job was submitted for processing.

" + } + }, + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the targeted sentiment detection job ended.

" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig" + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig" + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language code of the input documents.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to your input data.

" + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the KMS key that Amazon Comprehend uses to encrypt the\n data on the storage volume attached to the ML compute instance(s) that process the\n targeted sentiment detection job. The VolumeKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig" + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a targeted sentiment detection job.

" + } + }, + "com.amazonaws.comprehend#TargetedSentimentDetectionJobPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#TargetedSentimentDetectionJobProperties" + } + }, + "com.amazonaws.comprehend#TargetedSentimentEntity": { + "type": "structure", + "members": { + "DescriptiveMentionIndex": { + "target": "com.amazonaws.comprehend#ListOfDescriptiveMentionIndices", + "traits": { + "smithy.api#documentation": "

One or more index into the Mentions array that provides the best name for the entity group.

" + } + }, + "Mentions": { + "target": "com.amazonaws.comprehend#ListOfMentions", + "traits": { + "smithy.api#documentation": "

An array of mentions of the entity in the document. The array represents a co-reference group.\n See \n Co-reference group for an example.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about one of the entities found by targeted sentiment analysis.

\n

For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.

" + } + }, + "com.amazonaws.comprehend#TargetedSentimentEntityType": { + "type": "enum", + "members": { + "PERSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERSON" + } + }, + "LOCATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOCATION" + } + }, + "ORGANIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORGANIZATION" + } + }, + "FACILITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FACILITY" + } + }, + "BRAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BRAND" + } + }, + "COMMERCIAL_ITEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMMERCIAL_ITEM" + } + }, + "MOVIE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MOVIE" + } + }, + "MUSIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MUSIC" + } + }, + "BOOK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOOK" + } + }, + "SOFTWARE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOFTWARE" + } + }, + "GAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GAME" + } + }, + "PERSONAL_TITLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERSONAL_TITLE" + } + }, + "EVENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVENT" + } + }, + "DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE" + } + }, + "QUANTITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUANTITY" + } + }, + "ATTRIBUTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTRIBUTE" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER" + } + } + } + }, + "com.amazonaws.comprehend#TargetedSentimentMention": { + "type": "structure", + "members": { + "Score": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

Model confidence that the entity is relevant. Value range is zero to one, where one is highest confidence.

" + } + }, + "GroupScore": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The confidence that all the entities mentioned in the group relate to the same entity.

" + } + }, + "Text": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

The text in the document that identifies the entity.

" + } + }, + "Type": { + "target": "com.amazonaws.comprehend#TargetedSentimentEntityType", + "traits": { + "smithy.api#documentation": "

The type of the entity. Amazon Comprehend supports a variety of entity types.

" + } + }, + "MentionSentiment": { + "target": "com.amazonaws.comprehend#MentionSentiment", + "traits": { + "smithy.api#documentation": "

Contains the sentiment and sentiment score for the mention.

" + } + }, + "BeginOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The offset into the document text where the mention begins.

" + } + }, + "EndOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The offset into the document text where the mention ends.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about one mention of an entity. The mention information includes the location of the mention\n in the text and the sentiment of the mention.

\n

For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.

" + } + }, + "com.amazonaws.comprehend#TaskConfig": { + "type": "structure", + "members": { + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

Language code for the language that the model supports.

", + "smithy.api#required": {} + } + }, + "DocumentClassificationConfig": { + "target": "com.amazonaws.comprehend#DocumentClassificationConfig", + "traits": { + "smithy.api#documentation": "

Configuration required for a document classification model.

" + } + }, + "EntityRecognitionConfig": { + "target": "com.amazonaws.comprehend#EntityRecognitionConfig", + "traits": { + "smithy.api#documentation": "

Configuration required for an entity recognition model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration about the model associated with a flywheel.

" + } + }, + "com.amazonaws.comprehend#TextSegment": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.comprehend#CustomerInputString", + "traits": { + "smithy.api#documentation": "

The text content.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

One of the of text strings. Each string has a size limit of 1KB.

" + } + }, + "com.amazonaws.comprehend#TextSizeLimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.comprehend#String" + } + }, + "traits": { + "smithy.api#documentation": "

The size of the input text exceeds the limit. Use a smaller document.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.comprehend#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.comprehend#TooManyRequestsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.comprehend#String" + } + }, + "traits": { + "smithy.api#documentation": "

The number of requests exceeds the limit. Resubmit your request later.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.comprehend#TooManyTagKeysException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.comprehend#String" + } + }, + "traits": { + "smithy.api#documentation": "

The request contains more tag keys than can be associated with a resource (50 tag keys per\n resource).

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.comprehend#TooManyTagsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.comprehend#String" + } + }, + "traits": { + "smithy.api#documentation": "

The request contains more tags than can be associated with a resource (50 tags per\n resource). The maximum number of tags includes both existing tags and those included in your\n current request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.comprehend#TopicsDetectionJobFilter": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

Filters the list of topic detection jobs based on job status. Returns only jobs with\n the specified status.

" + } + }, + "SubmitTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Only returns jobs submitted before the specified time. Jobs are returned in descending order,\n newest to oldest.

" + } + }, + "SubmitTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Only returns jobs submitted after the specified time. Jobs are returned in ascending order,\n oldest to newest.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information for filtering topic detection jobs. For more information, see\n .

" + } + }, + "com.amazonaws.comprehend#TopicsDetectionJobProperties": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier assigned to the topic detection job.

" + } + }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully\n qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::topics-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

The name of the topic detection job.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the topic detection job. If the status is Failed,\n the reason for the failure is shown in the Message field.

" + } + }, + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", + "traits": { + "smithy.api#documentation": "

A description for the status of a job.

" + } + }, + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the topic detection job was submitted for processing.

" + } + }, + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the topic detection job was completed.

" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", + "traits": { + "smithy.api#documentation": "

The input data configuration supplied when you created the topic detection\n job.

" + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

The output data configuration supplied when you created the topic detection\n job.

" + } + }, + "NumberOfTopics": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The number of topics to detect supplied when you created the topic detection job. The\n default is 10.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend read access to your job data.

" + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", + "traits": { + "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your topic detection job. For more information, see Amazon\n VPC.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a topic detection job.

" + } + }, + "com.amazonaws.comprehend#TopicsDetectionJobPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#TopicsDetectionJobProperties" + } + }, + "com.amazonaws.comprehend#ToxicContent": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.comprehend#ToxicContentType", + "traits": { + "smithy.api#documentation": "

The name of the toxic content type.

" + } + }, + "Score": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

\n Model confidence in the detected content type. Value range is zero to one, where one is highest confidence.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Toxic content analysis result for one string. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide\n

" + } + }, + "com.amazonaws.comprehend#ToxicContentType": { + "type": "enum", + "members": { + "GRAPHIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GRAPHIC" + } + }, + "HARASSMENT_OR_ABUSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HARASSMENT_OR_ABUSE" + } + }, + "HATE_SPEECH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HATE_SPEECH" + } + }, + "INSULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSULT" + } + }, + "PROFANITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROFANITY" + } + }, + "SEXUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEXUAL" + } + }, + "VIOLENCE_OR_THREAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIOLENCE_OR_THREAT" + } + } + } + }, + "com.amazonaws.comprehend#ToxicLabels": { + "type": "structure", + "members": { + "Labels": { + "target": "com.amazonaws.comprehend#ListOfToxicContent", + "traits": { + "smithy.api#documentation": "

Array of toxic content types identified in the string.

" + } + }, + "Toxicity": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

Overall toxicity score for the string. Value range is zero to one, where one is the highest confidence.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Toxicity analysis result for one string. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide.

" + } + }, + "com.amazonaws.comprehend#UnsupportedLanguageException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.comprehend#String" + } + }, + "traits": { + "smithy.api#documentation": "

Amazon Comprehend can't process the language of the input text. For a list of supported languages,\n Supported languages in the Comprehend Developer Guide.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.comprehend#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagKeysException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a specific tag associated with an Amazon Comprehend resource.

" + } + }, + "com.amazonaws.comprehend#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you\n want to remove the tags.

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.comprehend#TagKeyList", + "traits": { + "smithy.api#documentation": "

The initial part of a key-value pair that forms a tag being removed from a given resource.\n For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by\n the sales department. Keys must be unique and cannot be duplicated for a particular resource.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#UpdateDataSecurityConfig": { + "type": "structure", + "members": { + "ModelKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the KMS key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the KMS key that Amazon Comprehend uses to encrypt the volume.

" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig" + } + }, + "traits": { + "smithy.api#documentation": "

Data security configuration.

" + } + }, + "com.amazonaws.comprehend#UpdateEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#UpdateEndpointRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#UpdateEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates information about the specified endpoint.\n For information about endpoints, see Managing endpoints.

" + } + }, + "com.amazonaws.comprehend#UpdateEndpointRequest": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.comprehend#ComprehendEndpointArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the endpoint being updated.

", + "smithy.api#required": {} + } + }, + "DesiredModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

The ARN of the new model to use when updating an existing endpoint.

" + } + }, + "DesiredInferenceUnits": { + "target": "com.amazonaws.comprehend#InferenceUnitsInteger", + "traits": { + "smithy.api#documentation": "

The desired number of inference units to be used by the model using this endpoint.\n \n Each inference unit represents of a throughput of 100 characters per second.

" + } + }, + "DesiredDataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

Data access role ARN to use in case the new model is encrypted with a customer CMK.

" + } + }, + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the flywheel

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#UpdateEndpointResponse": { + "type": "structure", + "members": { + "DesiredModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the new model.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#UpdateFlywheel": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#UpdateFlywheelRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#UpdateFlywheelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#KmsKeyValidationException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Update the configuration information for an existing flywheel.

" + } + }, + "com.amazonaws.comprehend#UpdateFlywheelRequest": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the flywheel to update.

", + "smithy.api#required": {} + } + }, + "ActiveModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the active model version.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that\n grants Amazon Comprehend permission to access the flywheel data.

" + } + }, + "DataSecurityConfig": { + "target": "com.amazonaws.comprehend#UpdateDataSecurityConfig", + "traits": { + "smithy.api#documentation": "

Flywheel data security configuration.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#UpdateFlywheelResponse": { + "type": "structure", + "members": { + "FlywheelProperties": { + "target": "com.amazonaws.comprehend#FlywheelProperties", + "traits": { + "smithy.api#documentation": "

The flywheel properties.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#VersionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.comprehend#VpcConfig": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.comprehend#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

The ID number for a security group on an instance of your private VPC. Security groups on\n your VPC function serve as a virtual firewall to control inbound and outbound traffic and\n provides security for the resources that you’ll be accessing on the VPC. This ID number is\n preceded by \"sg-\", for instance: \"sg-03b388029b0a285ea\". For more information, see Security\n Groups for your VPC.

", + "smithy.api#required": {} + } + }, + "Subnets": { + "target": "com.amazonaws.comprehend#Subnets", + "traits": { + "smithy.api#documentation": "

The ID for each subnet being used in your private VPC. This subnet is a subset of the a\n range of IPv4 addresses used by the VPC and is specific to a given availability zone in the\n VPC’s Region. This ID number is preceded by \"subnet-\", for instance:\n \"subnet-04ccf456919e69055\". For more information, see VPCs and\n Subnets.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for the job. For more information, see Amazon\n VPC.

" + } + }, + "com.amazonaws.comprehend#WarningsListItem": { + "type": "structure", + "members": { + "Page": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Page number in the input document.

" + } + }, + "WarnCode": { + "target": "com.amazonaws.comprehend#PageBasedWarningCode", + "traits": { + "smithy.api#documentation": "

The type of warning.

" + } + }, + "WarnMessage": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Text message associated with the warning.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The system identified one of the following warnings while processing the input document:

\n
    \n
  • \n

    The document to classify is plain text, but the classifier is a native document model.

    \n
    • \n
  • \n

    The document to classify is semi-structured, but the classifier is a plain-text model.

    \n
    • \n
" + } + } + } +} diff --git a/tests/compatibility/conftest.py b/tests/compatibility/conftest.py index 434a3687..389d6311 100644 --- a/tests/compatibility/conftest.py +++ b/tests/compatibility/conftest.py @@ -149,6 +149,17 @@ def _make_client(service_name): ) +@pytest.fixture +def service_client(devcloud_server): + """Boto3 client factory for any service, by name. + + Every named fixture below wraps this same call. Writing one more of them per + service is the only step of adding a service that scales with the size of + the fleet, so a new service gets a test through this factory instead. + """ + return _make_client + + # --- Existing service fixtures --- diff --git a/tests/compatibility/test_service_smoke.py b/tests/compatibility/test_service_smoke.py new file mode 100644 index 00000000..c1303f95 --- /dev/null +++ b/tests/compatibility/test_service_smoke.py @@ -0,0 +1,61 @@ +"""Smoke coverage for services served by the generic CRUD engine. + +A scaffolded service is registered and routed the moment it is generated, which +is not the same as being served: it answers an operation only if its provider +hands the operation to the CRUD engine. This test is the difference between the +two. It fails for a service that is routed but returns an error for every +operation — the state every scaffolded service was in before the provider +template opted into the engine. + +Adding a service means adding its name below, not writing a fixture. +""" + +import pytest +from botocore import xform_name +from botocore.exceptions import ClientError + +# Services whose coverage comes from the generic CRUD engine rather than a +# hand-written provider. The engine only serves the awsJson1_0 / awsJson1_1 +# protocols, which carry the operation name in X-Amz-Target; a rest-json, +# query, or rest-xml service cannot be listed here and be served. +ENGINE_SERVED_SERVICES = [ + "comprehend", +] + + +def _parameterless_read_op(client): + """Return the first List*/Describe* operation that needs no input. + + Picking the operation from the service model rather than hardcoding one per + service is what keeps this test from growing a branch per service. + """ + model = client.meta.service_model + for name in sorted(model.operation_names): + if not name.startswith(("List", "Describe")): + continue + shape = model.operation_model(name).input_shape + if shape is None or not shape.required_members: + return name + return None + + +@pytest.mark.parametrize("service", ENGINE_SERVED_SERVICES) +def test_service_serves_at_least_one_operation(service_client, service): + client = service_client(service) + + op = _parameterless_read_op(client) + assert op is not None, ( + f"{service} declares no parameterless List*/Describe* operation, " + "so this test cannot establish that it serves anything" + ) + + try: + response = getattr(client, xform_name(op))() + except ClientError as exc: + pytest.fail( + f"{service}.{op} is routed but not served: {exc.response['Error']}. " + "The provider is most likely not returning plugin.ErrUnhandledOp, " + "so the request never reaches the CRUD engine." + ) + + assert response["ResponseMetadata"]["HTTPStatusCode"] == 200 From bad2b42a6c2bda14be52bbf091cd204fc7ca02ce Mon Sep 17 00:00:00 2001 From: Sung-Kyu Yoo Date: Sat, 5 Sep 2026 15:26:13 +0900 Subject: [PATCH 5/5] docs: add changelog fragments and TDD evidence report MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Four Changie fragments for #136, plus the RED/GREEN evidence report at .claude/tdd/aws-service-coverage-100.tdd.md so the proof survives a squash merge. Also corrects the plan's protocol-scope claim: crud.JSONProtocol matches only protocols starting with 'json', so rest-json cannot be engine-served either — only 39 of 93 in-tree models qualify, not the 66 the plan implied. --- .../plans/aws-service-coverage-100.plan.md | 192 +++++++++++++++++ .claude/plans/fidelity-manifest.plan.md | 117 ++++++++++ .claude/plans/promotion-pass.plan.md | 142 ++++++++++++ .claude/plans/release-hardening.plan.md | 170 +++++++++++++++ .claude/plans/stability-policy.plan.md | 168 +++++++++++++++ .claude/plans/v1-tag.plan.md | 204 ++++++++++++++++++ .claude/prds/aws-service-coverage-100.prd.md | 148 +++++++++++++ .claude/prds/aws-v1-stabilization.prd.md | 93 ++++++++ .claude/tdd/aws-service-coverage-100.tdd.md | 196 +++++++++++++++++ changes/unreleased/Added-20260905-152603.yaml | 5 + changes/unreleased/Fixed-20260905-152600.yaml | 5 + changes/unreleased/Fixed-20260905-152601.yaml | 5 + changes/unreleased/Fixed-20260905-152602.yaml | 5 + 13 files changed, 1450 insertions(+) create mode 100644 .claude/plans/aws-service-coverage-100.plan.md create mode 100644 .claude/plans/fidelity-manifest.plan.md create mode 100644 .claude/plans/promotion-pass.plan.md create mode 100644 .claude/plans/release-hardening.plan.md create mode 100644 .claude/plans/stability-policy.plan.md create mode 100644 .claude/plans/v1-tag.plan.md create mode 100644 .claude/prds/aws-service-coverage-100.prd.md create mode 100644 .claude/prds/aws-v1-stabilization.prd.md create mode 100644 .claude/tdd/aws-service-coverage-100.tdd.md create mode 100644 changes/unreleased/Added-20260905-152603.yaml create mode 100644 changes/unreleased/Fixed-20260905-152600.yaml create mode 100644 changes/unreleased/Fixed-20260905-152601.yaml create mode 100644 changes/unreleased/Fixed-20260905-152602.yaml diff --git a/.claude/plans/aws-service-coverage-100.plan.md b/.claude/plans/aws-service-coverage-100.plan.md new file mode 100644 index 00000000..d520d632 --- /dev/null +++ b/.claude/plans/aws-service-coverage-100.plan.md @@ -0,0 +1,192 @@ +# Plan: Repeatable AWS Service Onboarding + +**Source PRD**: `.claude/prds/aws-service-coverage-100.prd.md` +**Selected Milestone**: 1 — Onboarding cost is known +**Complexity**: Medium (small diffs; the measurement, not the code, is the deliverable) + +## Summary + +The service-onboarding pipeline already exists end to end — per-service model +download, a codegen scaffolder that writes a self-registering provider and +refuses to clobber a hand-written one, config that auto-enables every registered +service, and a main loop that needs no edit per service. Milestone 1 is therefore +a **repair-and-measure** job, not a build-a-tool job. + +Two defects make the existing pipeline unusable and one makes its output dishonest: +the import generator gates on a file no service has, so it empties `imports.go`; +the scaffolded provider declines in a way that never reaches the CRUD engine, so +a new service serves zero operations; and the fidelity manifest would publish +those zero-op services as `auto-crud` anyway. Fixing all three is under 30 lines. +The remaining work is removing the one genuinely repetitive step (a hand-written +boto3 fixture per service — there are already 104) and then running the whole +path on one real service with a stopwatch. + +## Findings That Shape the Plan + +| Finding | Evidence | Consequence | +|---|---|---| +| **`generate-imports.sh` skips every service dir.** It requires `register.go`; zero of 103 services have one — they register from an `init()` inside `provider.go`. | `scripts/generate-imports.sh:19`; `ls internal/services/*/register.go` → no matches; 103 dirs vs 103 entries in the committed `cmd/devcloud/imports.go` | Running the script today writes an **empty import block**. The weekly sync workflow runs it (`.github/workflows/smithy-sync.yml:37`) before its test step, so that job has been failing every week rather than opening sync PRs. No new service can be reached until this is fixed. | +| **The scaffold declines the wrong way.** It returns `generated.ErrNotImplemented`; the CRUD fallback is reached only on `plugin.ErrUnhandledOp`. | `internal/codegen/templates/scaffold_provider.go.tmpl:31` vs `internal/gateway/router.go:61` | A freshly scaffolded service serves **zero** operations and cannot meet the PRD's quality floor as generated. One-line fix. | +| **The fidelity manifest does not check engine wiring.** An op is labelled `auto-crud` from the model-derived CRUD registry alone. | `internal/codegen/gen_fidelity.go:95-104` (`tierFor` consults only the `hand` and `crud` maps) | A scaffolded service would be published as `auto-crud` while returning an error at runtime — the manifest overstating coverage is the PRD's top-ranked risk, and this is the mechanism. | +| Services are auto-enabled and auto-started; no per-service config or `main.go` edit. | `internal/config/config.go:122` (no `services` block ⇒ all enabled); `cmd/devcloud/main.go:102` iterates `registry.RegisteredServices()` | `docs/contributing.md` step 7 ("Update main.go") is dead. Two of its ten documented steps do not apply. | +| **104 near-identical boto3 fixtures are hand-written**, each a one-line wrapper over a shared helper. | `tests/compatibility/conftest.py:126` (`_make_client`), 104 `*_client(devcloud_server)` definitions | This is the single largest per-service cost and the only step that genuinely scales with 330 services. One parameterized fixture removes it. | +| The scaffolder already refuses to overwrite a hand-written provider. | `internal/codegen/generator.go:65` (`os.Stat` guard, comment states the intent) | Re-running codegen over the whole tree is safe; no quarantine mechanism needs inventing. | +| **338 upstream models are missing locally** (431 upstream vs 93 in-tree). | `comm` over the `aws-sdk-go-v2/aws-models` listing vs `smithy-models/` | Confirms the PRD's ~330 figure. Upstream filenames are hyphenated (`api-gateway`, `app-mesh`) while package names are not — the download script takes the **upstream filename**, and the package name comes from the model's service id. They differ. | + +## Patterns to Mirror + +| Category | Source | Pattern | +|---|---|---| +| Generated file | `cmd/devcloud/imports.go:1` | `// Code generated by