From bcad676a75ec3ebbd48460404b41d02517e4f783 Mon Sep 17 00:00:00 2001 From: knottnt Date: Tue, 18 Aug 2026 17:01:08 -0700 Subject: [PATCH 1/5] Add is_primary_key_optional config option for resources with no single primary key --- pkg/config/resource.go | 24 +++++++++ pkg/generate/code/set_resource.go | 50 ++++++++++++++++--- pkg/generate/code/set_resource_test.go | 27 ++++++++++ pkg/model/crd.go | 8 +++ .../generator-with-optional-primary-key.yaml | 8 +++ 5 files changed, 110 insertions(+), 7 deletions(-) create mode 100644 pkg/testdata/models/apis/eks/0000-00-00/generator-with-optional-primary-key.yaml diff --git a/pkg/config/resource.go b/pkg/config/resource.go index b71929bbf..daaf36ad2 100644 --- a/pkg/config/resource.go +++ b/pkg/config/resource.go @@ -126,6 +126,16 @@ type ResourceConfig struct { // IsARNPrimaryKey determines whether the CRD uses the ARN as the primary // identifier in the ReadOne operations. IsARNPrimaryKey bool `json:"is_arn_primary_key"` + // IsPrimaryKeyOptional, when true, tells the code generator to treat the + // primary key field as optional when populating the resource from an + // adoption annotation. PopulateResourceFromAnnotation still reads and sets + // the primary key (and any additional identifier fields), but no longer + // returns a "required field missing" terminal error when it is absent. Use + // this for resources that can be identified by one of several + // mutually-exclusive fields (for example, a policy keyed by name OR by + // resource ARN) so adoption succeeds with whichever field(s) the user + // supplies. + IsPrimaryKeyOptional bool `json:"is_primary_key_optional"` // TagConfig contains instructions for the code generator to generate // custom code for ensuring tags TagConfig *TagConfig `json:"tags,omitempty"` @@ -512,6 +522,20 @@ func (c *Config) ResourceIsAdoptable(resourceName string) bool { return *rConfig.IsAdoptable } +// ResourceIsPrimaryKeyOptional returns true if the resource is configured to +// treat its primary key field as optional when populating the resource from an +// adoption annotation (is_primary_key_optional: true). +func (c *Config) ResourceIsPrimaryKeyOptional(resourceName string) bool { + if c == nil { + return false + } + rConfig, ok := c.Resources[resourceName] + if !ok { + return false + } + return rConfig.IsPrimaryKeyOptional +} + // ResourceContainsAttributesMap returns true if the underlying API has // Get{Resource}Attributes/Set{Resource}Attributes API calls that map real, // schema'd fields to a raw `map[string]*string` for a given resource name (see SNS and diff --git a/pkg/generate/code/set_resource.go b/pkg/generate/code/set_resource.go index 707c88ebc..dc4a7b3c0 100644 --- a/pkg/generate/code/set_resource.go +++ b/pkg/generate/code/set_resource.go @@ -904,6 +904,29 @@ func requiredFieldGuardContructor( return out } +// optionalFieldGuardConstructor returns Go code that opens an `if ok {` guard +// which is entered only when the given optional field is present in the source +// map. The caller is responsible for emitting the guarded body and closing the +// block: +// +// f0, ok := fields["policyName"] +// if ok { +func optionalFieldGuardConstructor( + // optionalFieldVarName is the variable where the field value will be stored + optionalFieldVarName string, + // String representing the fields map that contains the fields for adoption + sourceVarName string, + // String representing the name of the optional field + optionalField string, + // Number of levels of indentation to use + indentLevel int, +) string { + indent := strings.Repeat("\t", indentLevel) + out := fmt.Sprintf("%s%s, ok := %s[\"%s\"]\n", indent, optionalFieldVarName, sourceVarName, optionalField) + out += fmt.Sprintf("%sif ok {\n", indent) + return out +} + // SetResourceGetAttributes returns the Go code that sets the Status fields // from the Output shape returned from a resource's GetAttributes operation. // @@ -1423,14 +1446,27 @@ func PopulateResourceFromAnnotation( isPrimarySet := primaryField != nil if isPrimarySet { memberPath, _ := findFieldInCR(cfg, r, primaryField.Names.Original) - primaryKeyOut += requiredFieldGuardContructor("primaryKey", sourceVarName, primaryField.Names.CamelLower, indentLevel) targetVarPath := fmt.Sprintf("%s%s", targetVarName, memberPath) - primaryKeyOut += setResourceIdentifierPrimaryIdentifierAnn( - "&primaryKey", - primaryField, - targetVarPath, - indentLevel, - ) + if r.IsPrimaryKeyOptional() { + // The primary key is optional for adoption: set it when the + // annotation supplies it, but do not require it. + primaryKeyOut += optionalFieldGuardConstructor("primaryKey", sourceVarName, primaryField.Names.CamelLower, indentLevel) + primaryKeyOut += setResourceIdentifierPrimaryIdentifierAnn( + "&primaryKey", + primaryField, + targetVarPath, + indentLevel+1, + ) + primaryKeyOut += fmt.Sprintf("%s}\n", indent) + } else { + primaryKeyOut += requiredFieldGuardContructor("primaryKey", sourceVarName, primaryField.Names.CamelLower, indentLevel) + primaryKeyOut += setResourceIdentifierPrimaryIdentifierAnn( + "&primaryKey", + primaryField, + targetVarPath, + indentLevel, + ) + } } else { var findErr error primaryCRField, primaryShapeField, findErr = FindPrimaryIdentifierFieldNames(cfg, r, op) diff --git a/pkg/generate/code/set_resource_test.go b/pkg/generate/code/set_resource_test.go index 8714a980a..cd4d10640 100644 --- a/pkg/generate/code/set_resource_test.go +++ b/pkg/generate/code/set_resource_test.go @@ -1802,6 +1802,33 @@ func TestSetResource_EKS_Cluster_PopulateResourceFromAnnotation(t *testing.T) { assert.Equal(expected, got) } +func TestSetResource_EKS_Cluster_OptionalPrimaryKey_PopulateResourceFromAnnotation(t *testing.T) { + assert := assert.New(t) + require := require.New(t) + + g := testutil.NewModelForServiceWithOptions(t, "eks", &testutil.TestingModelOptions{ + GeneratorConfigFile: "generator-with-optional-primary-key.yaml", + }) + + crd := testutil.GetCRDByName(t, g, "Cluster") + require.NotNil(crd) + require.True(crd.IsPrimaryKeyOptional()) + + // With is_primary_key_optional, the primary key is still read and set from + // the annotation, but is guarded by `if ok` instead of returning a terminal + // "required field missing" error when absent. + expected := ` + primaryKey, ok := fields["name"] + if ok { + r.ko.Spec.Name = &primaryKey + } + +` + got, err := code.PopulateResourceFromAnnotation(crd.Config(), crd, "fields", "r.ko", 1) + require.NoError(err) + assert.Equal(expected, got) +} + func TestSetResource_OpensearchServerless_SecurityPolicy_PopulateResourceFromAnnotation(t *testing.T) { assert := assert.New(t) require := require.New(t) diff --git a/pkg/model/crd.go b/pkg/model/crd.go index e9d013d69..dda7b4be3 100644 --- a/pkg/model/crd.go +++ b/pkg/model/crd.go @@ -464,6 +464,14 @@ func (r *CRD) IsARNPrimaryKey() bool { return resGenConfig.IsARNPrimaryKey } +// IsPrimaryKeyOptional returns true if the CRD is configured to treat its +// primary key as optional when populating the resource from an adoption +// annotation. When true, PopulateResourceFromAnnotation still sets the primary +// key when present but does not require it. +func (r *CRD) IsPrimaryKeyOptional() bool { + return r.cfg.ResourceIsPrimaryKeyOptional(r.Names.Original) +} + // GetPrimaryKeyField returns the field designated as the primary key, nil if // none are specified or an error if multiple are designated. func (r *CRD) GetPrimaryKeyField() (*Field, error) { diff --git a/pkg/testdata/models/apis/eks/0000-00-00/generator-with-optional-primary-key.yaml b/pkg/testdata/models/apis/eks/0000-00-00/generator-with-optional-primary-key.yaml new file mode 100644 index 000000000..a1bfc0a1a --- /dev/null +++ b/pkg/testdata/models/apis/eks/0000-00-00/generator-with-optional-primary-key.yaml @@ -0,0 +1,8 @@ +resources: + Cluster: + # is_primary_key_optional makes PopulateResourceFromAnnotation set the + # primary key when the adoption annotation supplies it, but not require it. + is_primary_key_optional: true + fields: + Name: + is_primary_key: true From eb31669a534770f140981c2efc409356f571e595 Mon Sep 17 00:00:00 2001 From: knottnt Date: Thu, 20 Aug 2026 09:48:29 -0700 Subject: [PATCH 2/5] Apply is_primary_key_optional to auto-discovered primary keys --- pkg/generate/code/set_resource.go | 30 ++++++++++++++----- pkg/generate/code/set_resource_test.go | 28 +++++++++++++++++ ...h-optional-primary-key-autodiscovered.yaml | 7 +++++ 3 files changed, 58 insertions(+), 7 deletions(-) create mode 100644 pkg/testdata/models/apis/eks/0000-00-00/generator-with-optional-primary-key-autodiscovered.yaml diff --git a/pkg/generate/code/set_resource.go b/pkg/generate/code/set_resource.go index dc4a7b3c0..90defdaa0 100644 --- a/pkg/generate/code/set_resource.go +++ b/pkg/generate/code/set_resource.go @@ -1545,13 +1545,29 @@ func PopulateResourceFromAnnotation( sourceVarPath := fmt.Sprintf("%s%s", targetVarName, memberPath) if inputShape.IsRequired(memberName) || isPrimaryIdentifier { requiredFieldVarName := fmt.Sprintf("f%d", memberIndex) - primaryKeyOut += requiredFieldGuardContructor(requiredFieldVarName, sourceVarName, targetField.Names.CamelLower, indentLevel) - primaryKeyOut += setResourceIdentifierPrimaryIdentifierAnn( - fmt.Sprintf("&%s", requiredFieldVarName), - targetField, - sourceVarPath, - indentLevel, - ) + if isPrimaryIdentifier && r.IsPrimaryKeyOptional() { + // The auto-discovered primary key is optional for adoption: set + // it when the annotation supplies it, but do not require it. + // This mirrors the explicit is_primary_key handling above. + // (Note: is_primary_key_optional has no effect for ARN primary + // keys, which return early and always require the ARN.) + primaryKeyOut += optionalFieldGuardConstructor(requiredFieldVarName, sourceVarName, targetField.Names.CamelLower, indentLevel) + primaryKeyOut += setResourceIdentifierPrimaryIdentifierAnn( + fmt.Sprintf("&%s", requiredFieldVarName), + targetField, + sourceVarPath, + indentLevel+1, + ) + primaryKeyOut += fmt.Sprintf("%s}\n", indent) + } else { + primaryKeyOut += requiredFieldGuardContructor(requiredFieldVarName, sourceVarName, targetField.Names.CamelLower, indentLevel) + primaryKeyOut += setResourceIdentifierPrimaryIdentifierAnn( + fmt.Sprintf("&%s", requiredFieldVarName), + targetField, + sourceVarPath, + indentLevel, + ) + } } else { additionalKeyOut += setResourceIdentifierAdditionalKeyAnn( cfg, r, diff --git a/pkg/generate/code/set_resource_test.go b/pkg/generate/code/set_resource_test.go index cd4d10640..8e4428511 100644 --- a/pkg/generate/code/set_resource_test.go +++ b/pkg/generate/code/set_resource_test.go @@ -1829,6 +1829,34 @@ func TestSetResource_EKS_Cluster_OptionalPrimaryKey_PopulateResourceFromAnnotati assert.Equal(expected, got) } +func TestSetResource_EKS_Cluster_OptionalAutoDiscoveredPrimaryKey_PopulateResourceFromAnnotation(t *testing.T) { + assert := assert.New(t) + require := require.New(t) + + g := testutil.NewModelForServiceWithOptions(t, "eks", &testutil.TestingModelOptions{ + GeneratorConfigFile: "generator-with-optional-primary-key-autodiscovered.yaml", + }) + + crd := testutil.GetCRDByName(t, g, "Cluster") + require.NotNil(crd) + require.True(crd.IsPrimaryKeyOptional()) + + // No field is marked is_primary_key, so the primary identifier (name) is + // auto-discovered. With is_primary_key_optional it is still read and set + // from the annotation, but guarded by `if ok` instead of returning a + // terminal "required field missing" error when absent. + expected := ` + f0, ok := fields["name"] + if ok { + r.ko.Spec.Name = &f0 + } + +` + got, err := code.PopulateResourceFromAnnotation(crd.Config(), crd, "fields", "r.ko", 1) + require.NoError(err) + assert.Equal(expected, got) +} + func TestSetResource_OpensearchServerless_SecurityPolicy_PopulateResourceFromAnnotation(t *testing.T) { assert := assert.New(t) require := require.New(t) diff --git a/pkg/testdata/models/apis/eks/0000-00-00/generator-with-optional-primary-key-autodiscovered.yaml b/pkg/testdata/models/apis/eks/0000-00-00/generator-with-optional-primary-key-autodiscovered.yaml new file mode 100644 index 000000000..14bf5743b --- /dev/null +++ b/pkg/testdata/models/apis/eks/0000-00-00/generator-with-optional-primary-key-autodiscovered.yaml @@ -0,0 +1,7 @@ +resources: + Cluster: + # is_primary_key_optional makes PopulateResourceFromAnnotation set the + # primary key when the adoption annotation supplies it, but not require it. + # No field is marked is_primary_key here, so the primary identifier is + # auto-discovered (Name, from DescribeCluster's `name` input). + is_primary_key_optional: true From e45a4db28da20cd185568114663a5c6de3197f5c Mon Sep 17 00:00:00 2001 From: knottnt Date: Thu, 27 Aug 2026 10:37:45 -0700 Subject: [PATCH 3/5] Change is_primary_key_optional to mutually_exclusive_identifiers for better enforcement of Adoption field requirement - Replace is_primary_key_optional with mutually_exclusive_identifiers - Replace optional primary key logic with mutually exclusive identifier check when generating PopulateResourceFromAnnotation - Add cloudwatchlogs api model to testdata --- pkg/config/resource.go | 35 +- pkg/config/validate.go | 29 + pkg/config/validate_test.go | 58 + pkg/generate/code/set_resource.go | 78 +- pkg/generate/code/set_resource_test.go | 75 +- pkg/model/crd.go | 46 +- .../aws-models/cloudwatch-logs.json | 17960 ++++++++++++++++ .../cloudwatch-logs/0000-00-00/generator.yaml | 46 + ...h-optional-primary-key-autodiscovered.yaml | 7 - .../generator-with-optional-primary-key.yaml | 8 - ...r-with-mutually-exclusive-identifiers.yaml | 37 + 11 files changed, 18311 insertions(+), 68 deletions(-) create mode 100644 pkg/testdata/codegen/sdk-codegen/aws-models/cloudwatch-logs.json create mode 100644 pkg/testdata/models/apis/cloudwatch-logs/0000-00-00/generator.yaml delete mode 100644 pkg/testdata/models/apis/eks/0000-00-00/generator-with-optional-primary-key-autodiscovered.yaml delete mode 100644 pkg/testdata/models/apis/eks/0000-00-00/generator-with-optional-primary-key.yaml create mode 100644 pkg/testdata/models/apis/opensearchserverless/0000-00-00/generator-with-mutually-exclusive-identifiers.yaml diff --git a/pkg/config/resource.go b/pkg/config/resource.go index daaf36ad2..742d4b0ad 100644 --- a/pkg/config/resource.go +++ b/pkg/config/resource.go @@ -126,16 +126,17 @@ type ResourceConfig struct { // IsARNPrimaryKey determines whether the CRD uses the ARN as the primary // identifier in the ReadOne operations. IsARNPrimaryKey bool `json:"is_arn_primary_key"` - // IsPrimaryKeyOptional, when true, tells the code generator to treat the - // primary key field as optional when populating the resource from an - // adoption annotation. PopulateResourceFromAnnotation still reads and sets - // the primary key (and any additional identifier fields), but no longer - // returns a "required field missing" terminal error when it is absent. Use - // this for resources that can be identified by one of several - // mutually-exclusive fields (for example, a policy keyed by name OR by - // resource ARN) so adoption succeeds with whichever field(s) the user - // supplies. - IsPrimaryKeyOptional bool `json:"is_primary_key_optional"` + // MutuallyExclusiveIdentifiers lists the resource's identifier fields (by + // their configuration/original names, e.g. PolicyName, ResourceArn) when a + // resource has no single mandatory identifier but is instead identified by + // exactly one of several mutually-exclusive fields. When set, adoption + // treats each listed field as optional (populating whichever the user + // supplies) but requires that exactly one of them is present: + // PopulateResourceFromAnnotation returns a terminal error if none or more + // than one is supplied. This prevents an empty or misspelled adoption + // annotation from silently matching an arbitrary resource. Requires at + // least two fields and is incompatible with is_arn_primary_key. + MutuallyExclusiveIdentifiers []string `json:"mutually_exclusive_identifiers,omitempty"` // TagConfig contains instructions for the code generator to generate // custom code for ensuring tags TagConfig *TagConfig `json:"tags,omitempty"` @@ -522,18 +523,18 @@ func (c *Config) ResourceIsAdoptable(resourceName string) bool { return *rConfig.IsAdoptable } -// ResourceIsPrimaryKeyOptional returns true if the resource is configured to -// treat its primary key field as optional when populating the resource from an -// adoption annotation (is_primary_key_optional: true). -func (c *Config) ResourceIsPrimaryKeyOptional(resourceName string) bool { +// ResourceMutuallyExclusiveIdentifiers returns the list of mutually-exclusive +// identifier field names configured for the resource (see +// mutually_exclusive_identifiers), or nil if none are configured. +func (c *Config) ResourceMutuallyExclusiveIdentifiers(resourceName string) []string { if c == nil { - return false + return nil } rConfig, ok := c.Resources[resourceName] if !ok { - return false + return nil } - return rConfig.IsPrimaryKeyOptional + return rConfig.MutuallyExclusiveIdentifiers } // ResourceContainsAttributesMap returns true if the underlying API has diff --git a/pkg/config/validate.go b/pkg/config/validate.go index 285ec13c5..8c89a88b0 100644 --- a/pkg/config/validate.go +++ b/pkg/config/validate.go @@ -44,10 +44,39 @@ func ValidateConfig( errs = append(errs, validateRenameOperations(cfg, sdkOperations)...) errs = append(errs, validateIgnoredOperations(cfg, sdkOperations)...) + errs = append(errs, validateMutuallyExclusiveIdentifiers(cfg)...) return errs } +// validateMutuallyExclusiveIdentifiers checks that a resource's +// mutually_exclusive_identifiers configuration is internally consistent: it +// must list at least two fields (a single identifier is not mutually exclusive +// with anything) and cannot be combined with is_arn_primary_key, since an +// ARN-primary resource always requires its ARN. +func validateMutuallyExclusiveIdentifiers(cfg *Config) []error { + var errs []error + for resName, resCfg := range cfg.Resources { + identifiers := resCfg.MutuallyExclusiveIdentifiers + if len(identifiers) == 0 { + continue + } + if len(identifiers) < 2 { + errs = append(errs, fmt.Errorf( + "resources.%s.mutually_exclusive_identifiers: must list at least two fields, got %d", + resName, len(identifiers), + )) + } + if resCfg.IsARNPrimaryKey { + errs = append(errs, fmt.Errorf( + "resources.%s.mutually_exclusive_identifiers: cannot be combined with is_arn_primary_key", + resName, + )) + } + } + return errs +} + // validateRenameOperations checks that operation names referenced in // resources[R].renames.operations[OpName] exist in the SDK. func validateRenameOperations( diff --git a/pkg/config/validate_test.go b/pkg/config/validate_test.go index 686862b2e..c71e1fb05 100644 --- a/pkg/config/validate_test.go +++ b/pkg/config/validate_test.go @@ -238,6 +238,64 @@ func TestValidateConfig_ErrorMessageIncludesAvailable(t *testing.T) { } } +func TestValidateMutuallyExclusiveIdentifiers(t *testing.T) { + testCases := []struct { + name string + resourceCfg ResourceConfig + expectedErrs int + }{ + { + name: "valid two identifiers", + resourceCfg: ResourceConfig{ + MutuallyExclusiveIdentifiers: []string{"PolicyName", "ResourceArn"}, + }, + expectedErrs: 0, + }, + { + name: "unset is allowed", + resourceCfg: ResourceConfig{}, + expectedErrs: 0, + }, + { + name: "single identifier is invalid", + resourceCfg: ResourceConfig{ + MutuallyExclusiveIdentifiers: []string{"PolicyName"}, + }, + expectedErrs: 1, + }, + { + name: "incompatible with is_arn_primary_key", + resourceCfg: ResourceConfig{ + MutuallyExclusiveIdentifiers: []string{"PolicyName", "ResourceArn"}, + IsARNPrimaryKey: true, + }, + expectedErrs: 1, + }, + { + name: "single identifier and arn primary key reports both", + resourceCfg: ResourceConfig{ + MutuallyExclusiveIdentifiers: []string{"PolicyName"}, + IsARNPrimaryKey: true, + }, + expectedErrs: 2, + }, + } + + for _, tc := range testCases { + t.Run(tc.name, func(t *testing.T) { + cfg := &Config{ + Resources: map[string]ResourceConfig{ + "ResourcePolicy": tc.resourceCfg, + }, + } + errs := validateMutuallyExclusiveIdentifiers(cfg) + if len(errs) != tc.expectedErrs { + t.Errorf("expected %d errors, got %d: %v", tc.expectedErrs, len(errs), errs) + } + }) + } +} + func TestFormatAvailableTruncated(t *testing.T) { items := []string{"A", "B", "C", "D", "E"} got := formatAvailableTruncated(items, 3) diff --git a/pkg/generate/code/set_resource.go b/pkg/generate/code/set_resource.go index 90defdaa0..63ee6ce75 100644 --- a/pkg/generate/code/set_resource.go +++ b/pkg/generate/code/set_resource.go @@ -927,6 +927,47 @@ func optionalFieldGuardConstructor( return out } +// mutuallyExclusiveIdentifierGuardConstructor returns Go code that counts how +// many of the given mutually-exclusive identifier fields are present in the +// source map and returns a terminal error unless exactly one is supplied. This +// prevents an empty or misspelled adoption annotation from silently matching an +// arbitrary resource: +// +// exclusiveIdentifierCount := 0 +// if _, ok := fields["policyName"]; ok { +// exclusiveIdentifierCount++ +// } +// if _, ok := fields["resourceARN"]; ok { +// exclusiveIdentifierCount++ +// } +// if exclusiveIdentifierCount != 1 { +// return ackerrors.NewTerminalError(fmt.Errorf("adoption requires exactly one of: policyName, resourceARN")) +// } +func mutuallyExclusiveIdentifierGuardConstructor( + // identifierFields are the annotation keys of the mutually-exclusive + // identifier fields, in configured order + identifierFields []string, + // String representing the fields map that contains the fields for adoption + sourceVarName string, + // Number of levels of indentation to use + indentLevel int, +) string { + indent := strings.Repeat("\t", indentLevel) + out := fmt.Sprintf("%sexclusiveIdentifierCount := 0\n", indent) + for _, identifierField := range identifierFields { + out += fmt.Sprintf("%sif _, ok := %s[\"%s\"]; ok {\n", indent, sourceVarName, identifierField) + out += fmt.Sprintf("%s\texclusiveIdentifierCount++\n", indent) + out += fmt.Sprintf("%s}\n", indent) + } + out += fmt.Sprintf("%sif exclusiveIdentifierCount != 1 {\n", indent) + out += fmt.Sprintf( + "%s\treturn ackerrors.NewTerminalError(fmt.Errorf(\"adoption requires exactly one of: %s\"))\n", + indent, strings.Join(identifierFields, ", "), + ) + out += fmt.Sprintf("%s}\n", indent) + return out +} + // SetResourceGetAttributes returns the Go code that sets the Status fields // from the Output shape returned from a resource's GetAttributes operation. // @@ -1422,6 +1463,22 @@ func PopulateResourceFromAnnotation( indent := strings.Repeat("\t", indentLevel) arnOut := "\n" out := "\n" + // When the resource is identified by exactly one of several + // mutually-exclusive identifiers, emit a guard that requires exactly one of + // them to be present in the adoption annotation. This runs before any field + // is populated so an empty or misspelled annotation fails with an actionable + // terminal error instead of silently matching an arbitrary resource. + if r.HasMutuallyExclusiveIdentifiers() { + identifierFields, meErr := r.GetMutuallyExclusiveIdentifierFields() + if meErr != nil { + return "", meErr + } + identifierKeys := make([]string, 0, len(identifierFields)) + for _, identifierField := range identifierFields { + identifierKeys = append(identifierKeys, identifierField.Names.CamelLower) + } + out += mutuallyExclusiveIdentifierGuardConstructor(identifierKeys, sourceVarName, indentLevel) + } // Check if the CRD defines the primary keys primaryKeyConditionalOut := "\n" primaryKeyConditionalOut += requiredFieldGuardContructor("resourceARN", sourceVarName, "arn", indentLevel) @@ -1447,9 +1504,10 @@ func PopulateResourceFromAnnotation( if isPrimarySet { memberPath, _ := findFieldInCR(cfg, r, primaryField.Names.Original) targetVarPath := fmt.Sprintf("%s%s", targetVarName, memberPath) - if r.IsPrimaryKeyOptional() { - // The primary key is optional for adoption: set it when the - // annotation supplies it, but do not require it. + if r.IsMutuallyExclusiveIdentifier(primaryField) { + // The primary key is one of several mutually-exclusive identifiers: + // set it when the annotation supplies it, but do not require it. The + // exactly-one guard emitted above ensures some identifier is present. primaryKeyOut += optionalFieldGuardConstructor("primaryKey", sourceVarName, primaryField.Names.CamelLower, indentLevel) primaryKeyOut += setResourceIdentifierPrimaryIdentifierAnn( "&primaryKey", @@ -1545,12 +1603,14 @@ func PopulateResourceFromAnnotation( sourceVarPath := fmt.Sprintf("%s%s", targetVarName, memberPath) if inputShape.IsRequired(memberName) || isPrimaryIdentifier { requiredFieldVarName := fmt.Sprintf("f%d", memberIndex) - if isPrimaryIdentifier && r.IsPrimaryKeyOptional() { - // The auto-discovered primary key is optional for adoption: set - // it when the annotation supplies it, but do not require it. - // This mirrors the explicit is_primary_key handling above. - // (Note: is_primary_key_optional has no effect for ARN primary - // keys, which return early and always require the ARN.) + if r.IsMutuallyExclusiveIdentifier(targetField) { + // This identifier (whether the auto-discovered primary key or a + // member the read op marks required) is one of several + // mutually-exclusive identifiers: set it when the annotation + // supplies it, but do not require it individually. The + // exactly-one guard emitted above enforces that one is present. + // Fields that are genuinely required and are not declared + // mutually-exclusive keep their required-field guard below. primaryKeyOut += optionalFieldGuardConstructor(requiredFieldVarName, sourceVarName, targetField.Names.CamelLower, indentLevel) primaryKeyOut += setResourceIdentifierPrimaryIdentifierAnn( fmt.Sprintf("&%s", requiredFieldVarName), diff --git a/pkg/generate/code/set_resource_test.go b/pkg/generate/code/set_resource_test.go index 8e4428511..e7929254f 100644 --- a/pkg/generate/code/set_resource_test.go +++ b/pkg/generate/code/set_resource_test.go @@ -1802,54 +1802,87 @@ func TestSetResource_EKS_Cluster_PopulateResourceFromAnnotation(t *testing.T) { assert.Equal(expected, got) } -func TestSetResource_EKS_Cluster_OptionalPrimaryKey_PopulateResourceFromAnnotation(t *testing.T) { +func TestSetResource_CloudWatchLogs_ResourcePolicy_MutuallyExclusiveIdentifiers_PopulateResourceFromAnnotation(t *testing.T) { assert := assert.New(t) require := require.New(t) - g := testutil.NewModelForServiceWithOptions(t, "eks", &testutil.TestingModelOptions{ - GeneratorConfigFile: "generator-with-optional-primary-key.yaml", + g := testutil.NewModelForServiceWithOptions(t, "cloudwatch-logs", &testutil.TestingModelOptions{ + GeneratorConfigFile: "generator.yaml", }) - crd := testutil.GetCRDByName(t, g, "Cluster") + crd := testutil.GetCRDByName(t, g, "ResourcePolicy") require.NotNil(crd) - require.True(crd.IsPrimaryKeyOptional()) - - // With is_primary_key_optional, the primary key is still read and set from - // the annotation, but is guarded by `if ok` instead of returning a terminal - // "required field missing" error when absent. + require.True(crd.HasMutuallyExclusiveIdentifiers()) + + // ResourcePolicy is identified by exactly one of PolicyName (account-scoped) + // or ResourceArn (resource-scoped), and DescribeResourcePolicies has no + // required members. mutually_exclusive_identifiers emits an exactly-one + // guard that returns a terminal error when the adoption annotation supplies + // neither identifier (empty or misspelled) or both, then populates whichever + // identifier is present. expected := ` - primaryKey, ok := fields["name"] + exclusiveIdentifierCount := 0 + if _, ok := fields["policyName"]; ok { + exclusiveIdentifierCount++ + } + if _, ok := fields["resourceARN"]; ok { + exclusiveIdentifierCount++ + } + if exclusiveIdentifierCount != 1 { + return ackerrors.NewTerminalError(fmt.Errorf("adoption requires exactly one of: policyName, resourceARN")) + } + primaryKey, ok := fields["policyName"] if ok { - r.ko.Spec.Name = &primaryKey + r.ko.Spec.PolicyName = &primaryKey } + f2, f2ok := fields["resourceARN"] + if f2ok { + r.ko.Spec.ResourceARN = aws.String(f2) + } ` got, err := code.PopulateResourceFromAnnotation(crd.Config(), crd, "fields", "r.ko", 1) require.NoError(err) assert.Equal(expected, got) } -func TestSetResource_EKS_Cluster_OptionalAutoDiscoveredPrimaryKey_PopulateResourceFromAnnotation(t *testing.T) { +func TestSetResource_OpensearchServerless_SecurityPolicy_MutuallyExclusiveIdentifiers_PopulateResourceFromAnnotation(t *testing.T) { assert := assert.New(t) require := require.New(t) - g := testutil.NewModelForServiceWithOptions(t, "eks", &testutil.TestingModelOptions{ - GeneratorConfigFile: "generator-with-optional-primary-key-autodiscovered.yaml", + g := testutil.NewModelForServiceWithOptions(t, "opensearchserverless", &testutil.TestingModelOptions{ + GeneratorConfigFile: "generator-with-mutually-exclusive-identifiers.yaml", }) - crd := testutil.GetCRDByName(t, g, "Cluster") + crd := testutil.GetCRDByName(t, g, "SecurityPolicy") require.NotNil(crd) - require.True(crd.IsPrimaryKeyOptional()) - - // No field is marked is_primary_key, so the primary identifier (name) is - // auto-discovered. With is_primary_key_optional it is still read and set - // from the annotation, but guarded by `if ok` instead of returning a - // terminal "required field missing" error when absent. + require.True(crd.HasMutuallyExclusiveIdentifiers()) + + // `name` is the auto-discovered primary identifier and `type` is a required + // member of the read operation input. Declaring them mutually exclusive + // routes both through the primary/required identifier branch but emits the + // optional `if ok` guard instead of a required-field guard, alongside the + // exactly-one terminal guard. This is the branch that previously dropped the + // guard for a genuinely-required field unconditionally. expected := ` + exclusiveIdentifierCount := 0 + if _, ok := fields["name"]; ok { + exclusiveIdentifierCount++ + } + if _, ok := fields["type_"]; ok { + exclusiveIdentifierCount++ + } + if exclusiveIdentifierCount != 1 { + return ackerrors.NewTerminalError(fmt.Errorf("adoption requires exactly one of: name, type_")) + } f0, ok := fields["name"] if ok { r.ko.Spec.Name = &f0 } + f1, ok := fields["type_"] + if ok { + r.ko.Spec.Type = &f1 + } ` got, err := code.PopulateResourceFromAnnotation(crd.Config(), crd, "fields", "r.ko", 1) diff --git a/pkg/model/crd.go b/pkg/model/crd.go index dda7b4be3..9700d8d97 100644 --- a/pkg/model/crd.go +++ b/pkg/model/crd.go @@ -464,12 +464,46 @@ func (r *CRD) IsARNPrimaryKey() bool { return resGenConfig.IsARNPrimaryKey } -// IsPrimaryKeyOptional returns true if the CRD is configured to treat its -// primary key as optional when populating the resource from an adoption -// annotation. When true, PopulateResourceFromAnnotation still sets the primary -// key when present but does not require it. -func (r *CRD) IsPrimaryKeyOptional() bool { - return r.cfg.ResourceIsPrimaryKeyOptional(r.Names.Original) +// HasMutuallyExclusiveIdentifiers returns true if the CRD is configured with a +// set of mutually-exclusive identifier fields (see +// mutually_exclusive_identifiers). +func (r *CRD) HasMutuallyExclusiveIdentifiers() bool { + return len(r.cfg.ResourceMutuallyExclusiveIdentifiers(r.Names.Original)) > 0 +} + +// GetMutuallyExclusiveIdentifierFields resolves the configured +// mutually_exclusive_identifiers names to their CRD Fields, preserving the +// configured order. It returns an error if a configured name does not match a +// known field. +func (r *CRD) GetMutuallyExclusiveIdentifierFields() ([]*Field, error) { + identifierNames := r.cfg.ResourceMutuallyExclusiveIdentifiers(r.Names.Original) + fields := make([]*Field, 0, len(identifierNames)) + for _, identifierName := range identifierNames { + fPath := names.New(identifierName).Camel + field, found := r.Fields[fPath] + if !found { + return nil, fmt.Errorf( + "could not find field with path %s for mutually_exclusive_identifiers entry %s", + fPath, identifierName, + ) + } + fields = append(fields, field) + } + return fields, nil +} + +// IsMutuallyExclusiveIdentifier returns true if the given field is one of the +// resource's configured mutually-exclusive identifier fields. +func (r *CRD) IsMutuallyExclusiveIdentifier(f *Field) bool { + if f == nil { + return false + } + for _, identifierName := range r.cfg.ResourceMutuallyExclusiveIdentifiers(r.Names.Original) { + if names.New(identifierName).Camel == f.Names.Camel { + return true + } + } + return false } // GetPrimaryKeyField returns the field designated as the primary key, nil if diff --git a/pkg/testdata/codegen/sdk-codegen/aws-models/cloudwatch-logs.json b/pkg/testdata/codegen/sdk-codegen/aws-models/cloudwatch-logs.json new file mode 100644 index 000000000..78f786e49 --- /dev/null +++ b/pkg/testdata/codegen/sdk-codegen/aws-models/cloudwatch-logs.json @@ -0,0 +1,17960 @@ +{ + "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.cloudwatchlogs#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

You don't have sufficient permissions to perform this action.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#AccessPolicy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^\\d{12}$" + } + }, + "com.amazonaws.cloudwatchlogs#AccountIds": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#AccountId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.cloudwatchlogs#AccountPolicies": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#AccountPolicy" + } + }, + "com.amazonaws.cloudwatchlogs#AccountPolicy": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#PolicyName", + "traits": { + "smithy.api#documentation": "

The name of the account policy.

" + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#AccountPolicyDocument", + "traits": { + "smithy.api#documentation": "

The policy document for this account policy.

\n

The JSON specified in policyDocument can be up to 30,720 characters.

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

The date and time that this policy was most recently updated.

" + } + }, + "policyType": { + "target": "com.amazonaws.cloudwatchlogs#PolicyType", + "traits": { + "smithy.api#documentation": "

The type of policy for this account policy.

" + } + }, + "scope": { + "target": "com.amazonaws.cloudwatchlogs#Scope", + "traits": { + "smithy.api#documentation": "

The scope of the account policy.

" + } + }, + "selectionCriteria": { + "target": "com.amazonaws.cloudwatchlogs#SelectionCriteria", + "traits": { + "smithy.api#documentation": "

The log group selection criteria that is used for this policy.

" + } + }, + "accountId": { + "target": "com.amazonaws.cloudwatchlogs#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID that the policy applies to.

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

A structure that contains information about one CloudWatch Logs account policy.

" + } + }, + "com.amazonaws.cloudwatchlogs#AccountPolicyDocument": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#ActionStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "CLIENT_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLIENT_ERROR" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#AddKeyEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#AddKeyEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.cloudwatchlogs#AddKeyEntry": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.cloudwatchlogs#Key", + "traits": { + "smithy.api#documentation": "

The key of the new entry to be added to the log event

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#AddKeyValue", + "traits": { + "smithy.api#documentation": "

The value of the new entry to be added to the log event

", + "smithy.api#required": {} + } + }, + "overwriteIfExists": { + "target": "com.amazonaws.cloudwatchlogs#OverwriteIfExists", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether to overwrite the value if the key already exists in the log event. If\n you omit this, the default is false.

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

This object defines one key that will be added with the addKeys processor.

" + } + }, + "com.amazonaws.cloudwatchlogs#AddKeyValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#AddKeys": { + "type": "structure", + "members": { + "entries": { + "target": "com.amazonaws.cloudwatchlogs#AddKeyEntries", + "traits": { + "smithy.api#documentation": "

An array of objects, where each object contains the information about one key to add to\n the log event.

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

This processor adds new key-value pairs to the log event.

\n

For more information about this processor including examples, see addKeys in the CloudWatch Logs User Guide.

" + } + }, + "com.amazonaws.cloudwatchlogs#AggregateLogGroupSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#AggregateLogGroupSummary" + } + }, + "com.amazonaws.cloudwatchlogs#AggregateLogGroupSummary": { + "type": "structure", + "members": { + "logGroupCount": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupCount", + "traits": { + "smithy.api#documentation": "

The number of log groups in this aggregate summary group.

" + } + }, + "groupingIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#GroupingIdentifiers", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs that identify the data source characteristics used to group\n the log groups.

\n

The size and content of this array depends on the groupBy parameter specified\n in the request.

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

Contains an aggregate summary of log groups grouped by data source characteristics,\n including the count of log groups and their grouping identifiers.

" + } + }, + "com.amazonaws.cloudwatchlogs#AllowedActionForAllowVendedLogsDeliveryForResource": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#AllowedFieldDelimiters": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#FieldDelimiter" + } + }, + "com.amazonaws.cloudwatchlogs#AllowedFields": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#RecordField" + } + }, + "com.amazonaws.cloudwatchlogs#AmazonResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^[\\w+=/:,.@-]*$" + } + }, + "com.amazonaws.cloudwatchlogs#Anomalies": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#Anomaly" + } + }, + "com.amazonaws.cloudwatchlogs#Anomaly": { + "type": "structure", + "members": { + "anomalyId": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyId", + "traits": { + "smithy.api#documentation": "

The unique ID that CloudWatch Logs assigned to this anomaly.

", + "smithy.api#required": {} + } + }, + "patternId": { + "target": "com.amazonaws.cloudwatchlogs#PatternId", + "traits": { + "smithy.api#documentation": "

The ID of the pattern used to help identify this anomaly.

", + "smithy.api#required": {} + } + }, + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "

The ARN of the anomaly detector that identified this anomaly.

", + "smithy.api#required": {} + } + }, + "patternString": { + "target": "com.amazonaws.cloudwatchlogs#PatternString", + "traits": { + "smithy.api#documentation": "

The pattern used to help identify this anomaly, in string format.

", + "smithy.api#required": {} + } + }, + "patternRegex": { + "target": "com.amazonaws.cloudwatchlogs#PatternRegex", + "traits": { + "smithy.api#documentation": "

The pattern used to help identify this anomaly, in regular expression format.

" + } + }, + "priority": { + "target": "com.amazonaws.cloudwatchlogs#Priority", + "traits": { + "smithy.api#documentation": "

The priority level of this anomaly, as determined by CloudWatch Logs. Priority is\n computed based on log severity labels such as FATAL and ERROR and\n the amount of deviation from the baseline. Possible values are HIGH,\n MEDIUM, and LOW.

" + } + }, + "firstSeen": { + "target": "com.amazonaws.cloudwatchlogs#EpochMillis", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The date and time when the anomaly detector first saw this anomaly. It is specified as\n epoch time, which is the number of seconds since January 1, 1970, 00:00:00\n UTC.

", + "smithy.api#required": {} + } + }, + "lastSeen": { + "target": "com.amazonaws.cloudwatchlogs#EpochMillis", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The date and time when the anomaly detector most recently saw this anomaly. It is\n specified as epoch time, which is the number of seconds since January 1, 1970, 00:00:00\n UTC.

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

A human-readable description of the anomaly. This description is generated by CloudWatch Logs.

", + "smithy.api#required": {} + } + }, + "active": { + "target": "com.amazonaws.cloudwatchlogs#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether this anomaly is still ongoing.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.cloudwatchlogs#State", + "traits": { + "smithy.api#documentation": "

Indicates the current state of this anomaly. If it is still being treated as an anomaly,\n the value is Active. If you have suppressed this anomaly by using the UpdateAnomaly operation, the value is Suppressed. If this behavior is\n now considered to be normal, the value is Baseline.

", + "smithy.api#required": {} + } + }, + "histogram": { + "target": "com.amazonaws.cloudwatchlogs#Histogram", + "traits": { + "smithy.api#documentation": "

A map showing times when the anomaly detector ran, and the number of occurrences of this\n anomaly that were detected at each of those runs. The times are specified in epoch time, which\n is the number of seconds since January 1, 1970, 00:00:00 UTC.

", + "smithy.api#required": {} + } + }, + "logSamples": { + "target": "com.amazonaws.cloudwatchlogs#LogSamples", + "traits": { + "smithy.api#documentation": "

An array of sample log event messages that are considered to be part of this\n anomaly.

", + "smithy.api#required": {} + } + }, + "patternTokens": { + "target": "com.amazonaws.cloudwatchlogs#PatternTokens", + "traits": { + "smithy.api#documentation": "

An array of structures where each structure contains information about one token that\n makes up the pattern.

", + "smithy.api#required": {} + } + }, + "logGroupArnList": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupArnList", + "traits": { + "smithy.api#documentation": "

An array of ARNS of the log groups that contained log events considered to be part of this\n anomaly.

", + "smithy.api#required": {} + } + }, + "suppressed": { + "target": "com.amazonaws.cloudwatchlogs#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether this anomaly is currently suppressed. To suppress an anomaly, use UpdateAnomaly.

" + } + }, + "suppressedDate": { + "target": "com.amazonaws.cloudwatchlogs#EpochMillis", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

If the anomaly is suppressed, this indicates when it was suppressed.

" + } + }, + "suppressedUntil": { + "target": "com.amazonaws.cloudwatchlogs#EpochMillis", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

If the anomaly is suppressed, this indicates when the suppression will end. If this value\n is 0, the anomaly was suppressed with no expiration, with the\n INFINITE value.

" + } + }, + "isPatternLevelSuppression": { + "target": "com.amazonaws.cloudwatchlogs#Boolean", + "traits": { + "smithy.api#documentation": "

If this anomaly is suppressed, this field is true if the suppression is\n because the pattern is suppressed. If false, then only this particular anomaly is\n suppressed.

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

This structure represents one anomaly that has been found by a logs anomaly\n detector.

\n

For more information about patterns and anomalies, see CreateLogAnomalyDetector.

" + } + }, + "com.amazonaws.cloudwatchlogs#AnomalyDetector": { + "type": "structure", + "members": { + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "

The ARN of the anomaly detector.

" + } + }, + "detectorName": { + "target": "com.amazonaws.cloudwatchlogs#DetectorName", + "traits": { + "smithy.api#documentation": "

The name of the anomaly detector.

" + } + }, + "logGroupArnList": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupArnList", + "traits": { + "smithy.api#documentation": "

A list of the ARNs of the log groups that this anomaly detector watches.

" + } + }, + "evaluationFrequency": { + "target": "com.amazonaws.cloudwatchlogs#EvaluationFrequency", + "traits": { + "smithy.api#documentation": "

Specifies how often the anomaly detector runs and look for anomalies.

" + } + }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern" + }, + "anomalyDetectorStatus": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorStatus", + "traits": { + "smithy.api#documentation": "

Specifies the current status of the anomaly detector. To pause an anomaly detector, use\n the enabled parameter in the UpdateLogAnomalyDetector operation.

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

The ARN of the KMS key assigned to this anomaly detector, if any.

" + } + }, + "creationTimeStamp": { + "target": "com.amazonaws.cloudwatchlogs#EpochMillis", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The date and time when this anomaly detector was created.

" + } + }, + "lastModifiedTimeStamp": { + "target": "com.amazonaws.cloudwatchlogs#EpochMillis", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The date and time when this anomaly detector was most recently modified.

" + } + }, + "anomalyVisibilityTime": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime", + "traits": { + "smithy.api#documentation": "

The number of days used as the life cycle of anomalies. After this time, anomalies are\n automatically baselined and the anomaly detector model will treat new occurrences of similar\n event as normal.

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

Contains information about one anomaly detector in the account.

" + } + }, + "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^[\\w#+=/:,.@-]*$" + } + }, + "com.amazonaws.cloudwatchlogs#AnomalyDetectorStatus": { + "type": "enum", + "members": { + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIALIZING" + } + }, + "TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAINING" + } + }, + "ANALYZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANALYZING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "PAUSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAUSED" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#AnomalyDetectors": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetector" + } + }, + "com.amazonaws.cloudwatchlogs#AnomalyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + } + } + }, + "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 7, + "max": 90 + } + } + }, + "com.amazonaws.cloudwatchlogs#ApplyOnTransformedLogs": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.cloudwatchlogs#Arn": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#AssociateKmsKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#AssociateKmsKeyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates the specified KMS key with either one log group in the\n account, or with all stored CloudWatch Logs query insights results in the\n account.

\n

When you use AssociateKmsKey, you specify either the\n logGroupName parameter or the resourceIdentifier parameter. You\n can't specify both of those parameters in the same operation.

\n
    \n
  • \n

    Specify the logGroupName parameter to cause log events ingested into that\n log group to be encrypted with that key. Only the log events ingested after the key is\n associated are encrypted with that key.

    \n

    Associating a KMS key with a log group overrides any existing\n associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group\n is encrypted using the KMS key. This association is stored as long as the\n data encrypted with the KMS key is still within CloudWatch Logs. This\n enables CloudWatch Logs to decrypt this data whenever it is requested.

    \n

    Associating a key with a log group does not cause the results of queries of that log\n group to be encrypted with that key. To have query results encrypted with a KMS key, you must use an AssociateKmsKey operation with the\n resourceIdentifier parameter that specifies a query-result\n resource.

    \n
    • \n
  • \n

    Specify the resourceIdentifier parameter with a query-result\n resource, to use that key to encrypt the stored results of all future StartQuery operations in the account. The response from a GetQueryResults operation will still return the query results in plain\n text.

    \n

    Even if you have not associated a key with your query results, the query results are\n encrypted when stored, using the default CloudWatch Logs method.

    \n

    If you run a query from a monitoring account that queries logs in a source account,\n the query results key from the monitoring account, if any, is used.

    \n
    • \n
\n \n

If you delete the key that is used to encrypt log events or log group query results,\n then all the associated stored log events or query results that were encrypted with that key\n will be unencryptable and unusable.

\n \n \n

CloudWatch Logs supports only symmetric KMS keys. Do not associate an\n asymmetric KMS key with your log group or query results. For more\n information, see Using Symmetric and Asymmetric\n Keys.

\n \n

It can take up to 5 minutes for this operation to take effect.

\n

If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an\n InvalidParameterException error.

" + } + }, + "com.amazonaws.cloudwatchlogs#AssociateKmsKeyRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

\n

In your AssociateKmsKey operation, you must specify either the\n resourceIdentifier parameter or the logGroup parameter, but you\n can't specify both.

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

The Amazon Resource Name (ARN) of the KMS key to use when encrypting log\n data. This must be a symmetric KMS key. For more information, see Amazon Resource Names and Using Symmetric and Asymmetric\n Keys.

", + "smithy.api#required": {} + } + }, + "resourceIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#ResourceIdentifier", + "traits": { + "smithy.api#documentation": "

Specifies the target for this operation. You must specify one of the following:

\n
    \n
  • \n

    Specify the following ARN to have future GetQueryResults operations in this account encrypt the results with the\n specified KMS key. Replace REGION and\n ACCOUNT_ID with your Region and account ID.

    \n

    \n arn:aws:logs:REGION:ACCOUNT_ID:query-result:*\n

    \n
    • \n
  • \n

    Specify the ARN of a log group to have CloudWatch Logs use the KMS key to encrypt log events that are ingested and stored by that log\n group. The log group ARN must be in the following format. Replace\n REGION and ACCOUNT_ID with your Region and\n account ID.

    \n

    \n arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME\n \n

    \n
    • \n
\n

In your AssociateKmsKey operation, you must specify either the\n resourceIdentifier parameter or the logGroup parameter, but you\n can't specify both.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#AssociateSourceToS3TableIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#AssociateSourceToS3TableIntegrationRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#AssociateSourceToS3TableIntegrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InternalServerException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates a data source with an S3 Table Integration for query access in the 'logs'\n namespace. This enables querying log data using analytics engines that support Iceberg such as\n Amazon Athena, Amazon Redshift, and Apache Spark.

" + } + }, + "com.amazonaws.cloudwatchlogs#AssociateSourceToS3TableIntegrationRequest": { + "type": "structure", + "members": { + "integrationArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the S3 Table Integration to associate the data source\n with.

", + "smithy.api#required": {} + } + }, + "dataSource": { + "target": "com.amazonaws.cloudwatchlogs#DataSource", + "traits": { + "smithy.api#documentation": "

The data source to associate with the S3 Table Integration. Contains the name and type of\n the data source.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#AssociateSourceToS3TableIntegrationResponse": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.cloudwatchlogs#S3TableIntegrationSourceIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier for the association between the data source and S3 Table\n Integration.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#Baseline": { + "type": "boolean" + }, + "com.amazonaws.cloudwatchlogs#BatchId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#BearerTokenAuthenticationEnabled": { + "type": "boolean" + }, + "com.amazonaws.cloudwatchlogs#Boolean": { + "type": "boolean" + }, + "com.amazonaws.cloudwatchlogs#BytesScannedValue": { + "type": "double" + }, + "com.amazonaws.cloudwatchlogs#CSV": { + "type": "structure", + "members": { + "quoteCharacter": { + "target": "com.amazonaws.cloudwatchlogs#QuoteCharacter", + "traits": { + "smithy.api#documentation": "

The character used used as a text qualifier for a single column of data. If you omit this,\n the double quotation mark \" character is used.

" + } + }, + "delimiter": { + "target": "com.amazonaws.cloudwatchlogs#Delimiter", + "traits": { + "smithy.api#documentation": "

The character used to separate each column in the original comma-separated value log\n event. If you omit this, the processor looks for the comma , character as the\n delimiter.

" + } + }, + "columns": { + "target": "com.amazonaws.cloudwatchlogs#Columns", + "traits": { + "smithy.api#documentation": "

An array of names to use for the columns in the transformed log event.

\n

If you omit this, default column names ([column_1, column_2 ...]) are\n used.

" + } + }, + "source": { + "target": "com.amazonaws.cloudwatchlogs#Source", + "traits": { + "smithy.api#documentation": "

The path to the field in the log event that has the comma separated values to be parsed.\n If you omit this value, the whole log message is processed.

" + } + }, + "destination": { + "target": "com.amazonaws.cloudwatchlogs#DestinationField", + "traits": { + "smithy.api#documentation": "

The path to the parent field to put transformed key value pairs under.\n If you omit this value, the key value pairs will be placed under the root node.

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

The CSV processor parses comma-separated values (CSV) from the log events\n into columns.

\n

For more information about this processor including examples, see csv in the CloudWatch Logs User Guide.

" + } + }, + "com.amazonaws.cloudwatchlogs#CancelExportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#CancelExportTaskRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels the specified export task.

\n

The task must be in the PENDING or RUNNING state.

" + } + }, + "com.amazonaws.cloudwatchlogs#CancelExportTaskRequest": { + "type": "structure", + "members": { + "taskId": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskId", + "traits": { + "smithy.api#documentation": "

The ID of the export task.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#CancelImportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#CancelImportTaskRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#CancelImportTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels an active import task and stops importing data from the CloudTrail Lake Event Data Store.

" + } + }, + "com.amazonaws.cloudwatchlogs#CancelImportTaskRequest": { + "type": "structure", + "members": { + "importId": { + "target": "com.amazonaws.cloudwatchlogs#ImportId", + "traits": { + "smithy.api#documentation": "

The ID of the import task to cancel.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#CancelImportTaskResponse": { + "type": "structure", + "members": { + "importId": { + "target": "com.amazonaws.cloudwatchlogs#ImportId", + "traits": { + "smithy.api#documentation": "

The ID of the cancelled import task.

" + } + }, + "importStatistics": { + "target": "com.amazonaws.cloudwatchlogs#ImportStatistics", + "traits": { + "smithy.api#documentation": "

Statistics about the import progress at the time of cancellation.

" + } + }, + "importStatus": { + "target": "com.amazonaws.cloudwatchlogs#ImportStatus", + "traits": { + "smithy.api#documentation": "

The final status of the import task. This will be set to CANCELLED.

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

The timestamp when the import task was created, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

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

The timestamp when the import task was cancelled, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 128 + }, + "smithy.api#pattern": "^\\S{36,128}$" + } + }, + "com.amazonaws.cloudwatchlogs#CollectionRetentionDays": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.cloudwatchlogs#Column": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cloudwatchlogs#Columns": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#Column" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.cloudwatchlogs#ConfigurationTemplate": { + "type": "structure", + "members": { + "service": { + "target": "com.amazonaws.cloudwatchlogs#Service", + "traits": { + "smithy.api#documentation": "

A string specifying which service this configuration template applies to. For more\n information about supported services see Enable logging from\n Amazon Web Services services..

" + } + }, + "logType": { + "target": "com.amazonaws.cloudwatchlogs#LogType", + "traits": { + "smithy.api#documentation": "

A string specifying which log type this configuration template applies to.

" + } + }, + "resourceType": { + "target": "com.amazonaws.cloudwatchlogs#ResourceType", + "traits": { + "smithy.api#documentation": "

A string specifying which resource type this configuration template applies to.

" + } + }, + "deliveryDestinationType": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationType", + "traits": { + "smithy.api#documentation": "

A string specifying which destination type this configuration template applies to.

" + } + }, + "defaultDeliveryConfigValues": { + "target": "com.amazonaws.cloudwatchlogs#ConfigurationTemplateDeliveryConfigValues", + "traits": { + "smithy.api#documentation": "

A mapping that displays the default value of each property within a delivery's\n configuration, if it is not specified in the request.

" + } + }, + "allowedFields": { + "target": "com.amazonaws.cloudwatchlogs#AllowedFields", + "traits": { + "smithy.api#documentation": "

The allowed fields that a caller can use in the recordFields parameter of a\n CreateDelivery or UpdateDeliveryConfiguration operation.

" + } + }, + "allowedOutputFormats": { + "target": "com.amazonaws.cloudwatchlogs#OutputFormats", + "traits": { + "smithy.api#documentation": "

The list of delivery destination output formats that are supported by this log\n source.

" + } + }, + "allowedActionForAllowVendedLogsDeliveryForResource": { + "target": "com.amazonaws.cloudwatchlogs#AllowedActionForAllowVendedLogsDeliveryForResource", + "traits": { + "smithy.api#documentation": "

The action permissions that a caller needs to have to be able to successfully create a\n delivery source on the desired resource type when calling PutDeliverySource.

" + } + }, + "allowedFieldDelimiters": { + "target": "com.amazonaws.cloudwatchlogs#AllowedFieldDelimiters", + "traits": { + "smithy.api#documentation": "

The valid values that a caller can use as field delimiters when calling CreateDelivery or UpdateDeliveryConfiguration on a delivery that delivers in Plain,\n W3C, or Raw format.

" + } + }, + "allowedSuffixPathFields": { + "target": "com.amazonaws.cloudwatchlogs#RecordFields", + "traits": { + "smithy.api#documentation": "

The list of variable fields that can be used in the suffix path of a delivery that\n delivers to an S3 bucket.

" + } + }, + "deliverySourceConfiguration": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceConfigurationSchemas", + "traits": { + "smithy.api#documentation": "

The schema of the delivery source configuration that is available for this log type.\n Each element describes a configuration that can be set when calling PutDeliverySource, including the configuration name, type, and default value.

" + } + }, + "s3TablesIntegration": { + "target": "com.amazonaws.cloudwatchlogs#S3TablesIntegration", + "traits": { + "smithy.api#documentation": "

The S3 Tables integration configuration for this configuration template, including the\n datasource name and type.

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

A structure containing information about the deafult settings and available settings that\n you can use to configure a delivery or a\n delivery\n destination.

" + } + }, + "com.amazonaws.cloudwatchlogs#ConfigurationTemplateDeliveryConfigValues": { + "type": "structure", + "members": { + "recordFields": { + "target": "com.amazonaws.cloudwatchlogs#RecordFields", + "traits": { + "smithy.api#documentation": "

The default record fields that will be delivered when a list of record fields is not\n provided in a CreateDelivery operation.

" + } + }, + "fieldDelimiter": { + "target": "com.amazonaws.cloudwatchlogs#FieldDelimiter", + "traits": { + "smithy.api#documentation": "

The default field delimiter that is used in a CreateDelivery operation when the field delimiter is not specified in that\n operation. The field delimiter is used only when the final output delivery is in\n Plain, W3C, or Raw format.

" + } + }, + "s3DeliveryConfiguration": { + "target": "com.amazonaws.cloudwatchlogs#S3DeliveryConfiguration", + "traits": { + "smithy.api#documentation": "

The delivery parameters that are used when you create a delivery to a delivery destination\n that is an S3 Bucket.

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

This structure contains the default values that are used for each configuration parameter\n when you use CreateDelivery to create a deliver under the current service type, resource type,\n and log type.

" + } + }, + "com.amazonaws.cloudwatchlogs#ConfigurationTemplates": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#ConfigurationTemplate" + } + }, + "com.amazonaws.cloudwatchlogs#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

This operation attempted to create a resource that already exists.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#CopyValue": { + "type": "structure", + "members": { + "entries": { + "target": "com.amazonaws.cloudwatchlogs#CopyValueEntries", + "traits": { + "smithy.api#documentation": "

An array of CopyValueEntry objects, where each object contains the\n information about one field value to copy.

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

This processor copies values within a log event. You can also use this processor to add\n metadata to log events by copying the values of the following metadata keys into the log\n events: @logGroupName, @logGroupStream, @accountId,\n @regionName.

\n

For more information about this processor including examples, see copyValue in the CloudWatch Logs User Guide.

" + } + }, + "com.amazonaws.cloudwatchlogs#CopyValueEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#CopyValueEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.cloudwatchlogs#CopyValueEntry": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.cloudwatchlogs#Source", + "traits": { + "smithy.api#documentation": "

The key to copy.

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

The key of the field to copy the value to.

", + "smithy.api#required": {} + } + }, + "overwriteIfExists": { + "target": "com.amazonaws.cloudwatchlogs#OverwriteIfExists", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether to overwrite the value if the destination key already exists. If you\n omit this, the default is false.

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

This object defines one value to be copied with the copyValue processor.

" + } + }, + "com.amazonaws.cloudwatchlogs#Count": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.cloudwatchlogs#CreateDelivery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#CreateDeliveryRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#CreateDeliveryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a delivery. A delivery is a connection between a logical\n delivery source and a logical delivery destination\n that you have already created.

\n

Only some Amazon Web Services services support being configured as a delivery source using\n this operation. These services are listed as Supported [V2\n Permissions] in the table at Enabling logging from\n Amazon Web Services services.\n

\n

A delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, a delivery stream in Firehose, or X-Ray.

\n

To configure logs delivery between a supported Amazon Web Services service and a\n destination, you must do the following:

\n
    \n
  • \n

    Create a delivery source, which is a logical object that represents the resource that\n is actually sending the logs. For more information, see PutDeliverySource.

    \n
    • \n
  • \n

    Create a delivery destination, which is a logical object that\n represents the actual delivery destination. For more information, see PutDeliveryDestination.

    \n
    • \n
  • \n

    If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.\n

    \n
    • \n
  • \n

    Use CreateDelivery to create a delivery by pairing\n exactly one delivery source and one delivery destination.

    \n
    • \n
\n

You can configure a single delivery source to send logs to multiple destinations by\n creating multiple deliveries. You can also create multiple deliveries to configure multiple\n delivery sources to send logs to the same delivery destination.

\n

To update an existing delivery configuration, use UpdateDeliveryConfiguration.

" + } + }, + "com.amazonaws.cloudwatchlogs#CreateDeliveryRequest": { + "type": "structure", + "members": { + "deliverySourceName": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", + "traits": { + "smithy.api#documentation": "

The name of the delivery source to use for this delivery.

", + "smithy.api#required": {} + } + }, + "deliveryDestinationArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the delivery destination to use for this delivery.

", + "smithy.api#required": {} + } + }, + "recordFields": { + "target": "com.amazonaws.cloudwatchlogs#RecordFields", + "traits": { + "smithy.api#documentation": "

The list of record fields to be delivered to the destination, in order. If the delivery's\n log source has mandatory fields, they must be included in this list.

" + } + }, + "fieldDelimiter": { + "target": "com.amazonaws.cloudwatchlogs#FieldDelimiter", + "traits": { + "smithy.api#documentation": "

The field delimiter to use between record fields when the final output format of a\n delivery is in Plain, W3C, or Raw format.

" + } + }, + "s3DeliveryConfiguration": { + "target": "com.amazonaws.cloudwatchlogs#S3DeliveryConfiguration", + "traits": { + "smithy.api#documentation": "

This structure contains parameters that are valid only when the delivery's delivery\n destination is an S3 bucket.

" + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

An optional list of key-value pairs to associate with the resource.

\n

For more information about tagging, see Tagging Amazon Web Services resources\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateDeliveryResponse": { + "type": "structure", + "members": { + "delivery": { + "target": "com.amazonaws.cloudwatchlogs#Delivery", + "traits": { + "smithy.api#documentation": "

A structure that contains information about the delivery that you just created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateExportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#CreateExportTaskRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#CreateExportTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an export task so that you can efficiently export data from a log group to an\n Amazon S3 bucket. When you perform a CreateExportTask operation, you must use\n credentials that have permission to write to the S3 bucket that you specify as the\n destination.

\n

Exporting log data to S3 buckets that are encrypted by KMS is supported.\n Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a\n retention period is also supported.

\n

Exporting to S3 buckets that are encrypted with AES-256 is supported.

\n

This is an asynchronous call. If all the required information is provided, this\n operation initiates an export task and responds with the ID of the task. After the task has\n started, you can use DescribeExportTasks to get the status of the export task. Each account can only\n have one active (RUNNING or PENDING) export task at a time. To\n cancel an export task, use CancelExportTask.

\n

You can export logs from multiple log groups or multiple time ranges to the same S3\n bucket. To separate log data for each export task, specify a prefix to be used as the Amazon\n S3 key prefix for all exported objects.

\n \n

We recommend that you don't regularly export to Amazon S3 as a way to\n continuously archive your logs. For that use case, we instead recommend that you use\n subscriptions. For more information about subscriptions, see Real-time processing of log data\n with subscriptions.

\n \n \n

Time-based sorting on chunks of log data inside an exported file is not guaranteed. You\n can sort the exported log field data by using Linux utilities.

\n " + } + }, + "com.amazonaws.cloudwatchlogs#CreateExportTaskRequest": { + "type": "structure", + "members": { + "taskName": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskName", + "traits": { + "smithy.api#documentation": "

The name of the export task.

" + } + }, + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + }, + "logStreamNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "

Export only log streams that match the provided prefix. If you don't specify a value,\n no prefix filter is applied.

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

The start time of the range for the request, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier than this time\n are not exported.

", + "smithy.api#required": {} + } + }, + "to": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The end time of the range for the request, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are\n not exported.

\n

You must specify a time that is not earlier than when this log group was created.

", + "smithy.api#required": {} + } + }, + "destination": { + "target": "com.amazonaws.cloudwatchlogs#ExportDestinationBucket", + "traits": { + "smithy.api#documentation": "

The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services Region.

", + "smithy.api#required": {} + } + }, + "destinationPrefix": { + "target": "com.amazonaws.cloudwatchlogs#ExportDestinationPrefix", + "traits": { + "smithy.api#documentation": "

The prefix used as the start of the key for every object exported. If you don't specify\n a value, the default is exportedlogs.

\n

The length of this parameter must comply with the S3 object key name length limits. The\n object key name is a sequence of Unicode characters with UTF-8 encoding, and can be up to\n 1,024 bytes.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateExportTaskResponse": { + "type": "structure", + "members": { + "taskId": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskId", + "traits": { + "smithy.api#documentation": "

The ID of the export task.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateImportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#CreateImportTaskRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#CreateImportTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an import from a data source to CloudWatch Log and creates a managed log group as the destination for the imported data.\n Currently, CloudTrail Event Data Store is the only supported data source.

\n

The import task must satisfy the following constraints:

\n
    \n
  • \n

    The specified source must be in an ACTIVE state.

    \n
    • \n
  • \n

    The API caller must have permissions to access the data in the provided source and to perform iam:PassRole on the\n provided import role which has the same permissions, as described below.

    \n
    • \n
  • \n

    The provided IAM role must trust the \"cloudtrail.amazonaws.com\" principal and have the following permissions:

    \n
      \n
    • \n

      cloudtrail:GetEventDataStoreData

      \n
      • \n
    • \n

      logs:CreateLogGroup

      \n
      • \n
    • \n

      logs:CreateLogStream

      \n
      • \n
    • \n

      logs:PutResourcePolicy

      \n
      • \n
    • \n

      (If source has an associated Amazon Web Services KMS Key) kms:Decrypt

      \n
      • \n
    • \n

      (If source has an associated Amazon Web Services KMS Key) kms:GenerateDataKey

      \n
      • \n
    \n

    Example IAM policy for provided import role:

    \n

    \n [ { \"Effect\": \"Allow\", \"Action\": \"iam:PassRole\", \"Resource\": \"arn:aws:iam::123456789012:role/apiCallerCredentials\", \"Condition\": { \"StringLike\": { \"iam:AssociatedResourceARN\": \"arn:aws:logs:us-east-1:123456789012:log-group:aws/cloudtrail/f1d45bff-d0e3-4868-b5d9-2eb678aa32fb:*\" } } }, { \"Effect\": \"Allow\", \"Action\": [ \"cloudtrail:GetEventDataStoreData\" ], \"Resource\": [ \"arn:aws:cloudtrail:us-east-1:123456789012:eventdatastore/f1d45bff-d0e3-4868-b5d9-2eb678aa32fb\" ] }, { \"Effect\": \"Allow\", \"Action\": [ \"logs:CreateImportTask\", \"logs:CreateLogGroup\", \"logs:CreateLogStream\", \"logs:PutResourcePolicy\" ], \"Resource\": [ \"arn:aws:logs:us-east-1:123456789012:log-group:/aws/cloudtrail/*\" ] }, { \"Effect\": \"Allow\", \"Action\": [ \"kms:Decrypt\", \"kms:GenerateDataKey\" ], \"Resource\": [ \"arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012\" ] } ]\n

    \n
    • \n
  • \n

    If the import source has a customer managed key, the \"cloudtrail.amazonaws.com\" principal needs permissions to perform kms:Decrypt and kms:GenerateDataKey.

    \n
    • \n
  • \n

    There can be no more than 3 active imports per account at a given time.

    \n
    • \n
  • \n

    The startEventTime must be less than or equal to endEventTime.

    \n
    • \n
  • \n

    The data being imported must be within the specified source's retention period.

    \n
    • \n
" + } + }, + "com.amazonaws.cloudwatchlogs#CreateImportTaskRequest": { + "type": "structure", + "members": { + "importSourceArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the source to import from.

", + "smithy.api#required": {} + } + }, + "importRoleArn": { + "target": "com.amazonaws.cloudwatchlogs#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that grants CloudWatch Logs permission to import from the CloudTrail Lake Event Data Store.

", + "smithy.api#required": {} + } + }, + "importFilter": { + "target": "com.amazonaws.cloudwatchlogs#ImportFilter", + "traits": { + "smithy.api#documentation": "

Optional filters to constrain the import by CloudTrail event time. Times are specified in Unix timestamp milliseconds.\n The range of data being imported must be within the specified source's retention period.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateImportTaskResponse": { + "type": "structure", + "members": { + "importId": { + "target": "com.amazonaws.cloudwatchlogs#ImportId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the import task.

" + } + }, + "importDestinationArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the CloudWatch Logs log group created as the destination for the imported events.

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

The timestamp when the import task was created, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetector": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetectorRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an anomaly detector that regularly scans one or more log\n groups and look for patterns and anomalies in the logs.

\n

An anomaly detector can help surface issues by automatically discovering anomalies in your\n log event traffic. An anomaly detector uses machine learning algorithms to scan log events and\n find patterns. A pattern is a shared text structure that recurs among\n your log fields. Patterns provide a useful tool for analyzing large sets of logs because a\n large number of log events can often be compressed into a few patterns.

\n

The anomaly detector uses pattern recognition to find anomalies, which are\n unusual log events. It uses the evaluationFrequency to compare current log events\n and patterns with trained baselines.

\n

Fields within a pattern are called tokens. Fields that vary within a\n pattern, such as a request ID or timestamp, are referred to as dynamic\n tokens and represented by <*>.

\n

The following is an example of a pattern:

\n

\n [INFO] Request time: <*> ms\n

\n

This pattern represents log events like [INFO] Request time: 327 ms and other\n similar log events that differ only by the number, in this csse 327. When the pattern is\n displayed, the different numbers are replaced by <*>\n

\n \n

Any parts of log events that are masked as sensitive data are not scanned for anomalies.\n For more information about masking sensitive data, see Help protect sensitive log\n data with masking.

\n " + } + }, + "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetectorRequest": { + "type": "structure", + "members": { + "logGroupArnList": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupArnList", + "traits": { + "smithy.api#documentation": "

An array containing the ARN of the log group that this anomaly detector will watch. You\n can specify only one log group ARN.

", + "smithy.api#required": {} + } + }, + "detectorName": { + "target": "com.amazonaws.cloudwatchlogs#DetectorName", + "traits": { + "smithy.api#documentation": "

A name for this anomaly detector.

" + } + }, + "evaluationFrequency": { + "target": "com.amazonaws.cloudwatchlogs#EvaluationFrequency", + "traits": { + "smithy.api#documentation": "

Specifies how often the anomaly detector is to run and look for anomalies. Set this value\n according to the frequency that the log group receives new logs. For example, if the log group\n receives new log events every 10 minutes, then 15 minutes might be a good setting for\n evaluationFrequency .

" + } + }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern", + "traits": { + "smithy.api#documentation": "

You can use this parameter to limit the anomaly detection model to examine only log events\n that match the pattern you specify here. For more information, see Filter and Pattern\n Syntax.

" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.cloudwatchlogs#DetectorKmsKeyArn", + "traits": { + "smithy.api#documentation": "

Optionally assigns a KMS key to secure this anomaly detector and its\n findings. If a key is assigned, the anomalies found and the model used by this detector are\n encrypted at rest with the key. If a key is assigned to an anomaly detector, a user must have\n permissions for both this key and for the anomaly detector to retrieve information about the\n anomalies that it finds.

\n

Make sure the value provided is a valid KMS key ARN. For more information\n about using a KMS key and to see the required IAM policy, see\n Use a KMS key with an anomaly detector.

" + } + }, + "anomalyVisibilityTime": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime", + "traits": { + "smithy.api#documentation": "

The number of days to have visibility on an anomaly. After this time period has elapsed\n for an anomaly, it will be automatically baselined and the anomaly detector will treat new\n occurrences of a similar anomaly as normal. Therefore, if you do not correct the cause of an\n anomaly during the time period specified in anomalyVisibilityTime, it will be\n considered normal going forward and will not be detected as an anomaly.

" + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

An optional list of key-value pairs to associate with the resource.

\n

For more information about tagging, see Tagging Amazon Web Services resources\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetectorResponse": { + "type": "structure", + "members": { + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "

The ARN of the log anomaly detector that you just created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateLogGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#CreateLogGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a log group with the specified name. You can create up to 1,000,000 log groups\n per Region per account.

\n

You must use the following guidelines when naming a log group:

\n
    \n
  • \n

    Log group names must be unique within a Region for an Amazon Web Services\n account.

    \n
    • \n
  • \n

    Log group names can be between 1 and 512 characters long.

    \n
    • \n
  • \n

    Log group names consist of the following characters: a-z, A-Z, 0-9, '_'\n (underscore), '-' (hyphen), '/' (forward slash), '.' (period), and '#' (number\n sign)

    \n
    • \n
  • \n

    Log group names can't start with the string aws/\n

    \n
    • \n
\n

When you create a log group, by default the log events in the log group do not expire.\n To set a retention policy so that events expire and are deleted after a specified time, use\n PutRetentionPolicy.

\n

If you associate an KMS key with the log group, ingested data is\n encrypted using the KMS key. This association is stored as long as the data\n encrypted with the KMS key is still within CloudWatch Logs. This enables\n CloudWatch Logs to decrypt this data whenever it is requested.

\n

If you attempt to associate a KMS key with the log group but the KMS key does not exist or the KMS key is disabled, you receive an\n InvalidParameterException error.

\n \n

CloudWatch Logs supports only symmetric KMS keys. Do not associate an\n asymmetric KMS key with your log group. For more information, see Using\n Symmetric and Asymmetric Keys.

\n " + } + }, + "com.amazonaws.cloudwatchlogs#CreateLogGroupRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

A name for the log group.

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

The Amazon Resource Name (ARN) of the KMS key to use when encrypting log\n data. For more information, see Amazon Resource\n Names.

" + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

The key-value pairs to use for the tags.

\n

You can grant users access to certain log groups while preventing them from accessing\n other log groups. To do so, tag your groups and use IAM policies that refer to\n those tags. To assign tags when you create a log group, you must have either the\n logs:TagResource or logs:TagLogGroup permission. For more\n information about tagging, see Tagging Amazon Web Services resources. For\n more information about using tags to control access, see Controlling access to Amazon Web Services\n resources using tags.

" + } + }, + "logGroupClass": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupClass", + "traits": { + "smithy.api#documentation": "

Use this parameter to specify the log group class for this log group. There are three\n classes:

\n
    \n
  • \n

    The Standard log class supports all CloudWatch Logs features.

    \n
    • \n
  • \n

    The Infrequent Access log class supports a subset of CloudWatch Logs\n features and incurs lower costs.

    \n
    • \n
  • \n

    Use the Delivery log class only for delivering Lambda\n logs to store in Amazon S3 or Amazon Data Firehose. Log events in log groups in\n the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn't\n offer rich CloudWatch Logs capabilities such as CloudWatch Logs Insights\n queries.

    \n
    • \n
\n

If you omit this parameter, the default of STANDARD is used.

\n \n

The value of logGroupClass can't be changed after a log group is\n created.

\n \n

For details about the features supported by each class, see Log classes\n

" + } + }, + "deletionProtectionEnabled": { + "target": "com.amazonaws.cloudwatchlogs#DeletionProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Use this parameter to enable deletion protection for the new log group. When enabled on\n a log group, deletion protection blocks all deletion operations until it is explicitly\n disabled. By default log groups are created without deletion protection enabled.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateLogStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#CreateLogStreamRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a log stream for the specified log group. A log stream is a sequence of log\n events that originate from a single source, such as an application instance or a resource that\n is being monitored.

\n

There is no limit on the number of log streams that you can create for a log group.\n There is a limit of 50 TPS on CreateLogStream operations, after which\n transactions are throttled.

\n

You must use the following guidelines when naming a log stream:

\n
    \n
  • \n

    Log stream names must be unique within the log group.

    \n
    • \n
  • \n

    Log stream names can be between 1 and 512 characters long.

    \n
    • \n
  • \n

    Don't use ':' (colon) or '*' (asterisk) characters.

    \n
    • \n
" + } + }, + "com.amazonaws.cloudwatchlogs#CreateLogStreamRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + }, + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "

The name of the log stream.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateLookupTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#CreateLookupTableRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#CreateLookupTableResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a lookup table by uploading CSV data or from CloudWatch Logs query\n results. You can use lookup tables to enrich log data in CloudWatch Logs queries with\n reference data such as user details, application names, or error descriptions.

\n

The table name must be unique within your account and Region. You must specify either\n tableBody or queryId, but not both. If you use\n tableBody, the CSV content must include a header row with column names, use\n UTF-8 encoding, and not exceed 10 MB.

" + } + }, + "com.amazonaws.cloudwatchlogs#CreateLookupTableRequest": { + "type": "structure", + "members": { + "lookupTableName": { + "target": "com.amazonaws.cloudwatchlogs#LookupTableName", + "traits": { + "smithy.api#documentation": "

The name of the lookup table. The name must be unique within your account and Region.\n The name can contain only alphanumeric characters and underscores, and can be up to\n 256 characters long.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cloudwatchlogs#LookupTableDescription", + "traits": { + "smithy.api#documentation": "

A description of the lookup table. The description can be up to 1024 characters\n long.

" + } + }, + "tableBody": { + "target": "com.amazonaws.cloudwatchlogs#TableBody", + "traits": { + "smithy.api#documentation": "

The CSV content of the lookup table. The first row must be a header row with column\n names. The content must use UTF-8 encoding and not exceed 10 MB.

\n

You must specify either tableBody or queryId, but not\n both.

" + } + }, + "queryId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "

The ID of a completed or cancelled CloudWatch Logs query whose results populate\n the lookup table. A cancelled query populates the table with the partial results that were\n available when the query was stopped.

\n

You must specify either tableBody or queryId, but not\n both.

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

The ARN of the KMS key to use to encrypt the lookup table data. If you\n don't specify a key, the data is encrypted with an Amazon Web Services-owned key.

" + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs to associate with the lookup table. You can associate as many\n as 50 tags with a lookup table. Tags can help you organize and categorize your\n resources.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateLookupTableResponse": { + "type": "structure", + "members": { + "lookupTableArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the lookup table that was created.

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

The time when the lookup table was created, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateScheduledQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#CreateScheduledQueryRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#CreateScheduledQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InternalServerException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a scheduled query that runs CloudWatch Logs Insights queries at regular intervals.\n Scheduled queries enable proactive monitoring by automatically executing queries to detect\n patterns and anomalies in your log data. Query results can be delivered to Amazon S3 for analysis\n or further processing.

" + } + }, + "com.amazonaws.cloudwatchlogs#CreateScheduledQueryRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryName", + "traits": { + "smithy.api#documentation": "

The name of the scheduled query. The name must be unique within your account and region.\n Length must be between 1 and 300 characters.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryDescription", + "traits": { + "smithy.api#documentation": "

An optional description for the scheduled query to help identify its purpose and\n functionality.

" + } + }, + "queryLanguage": { + "target": "com.amazonaws.cloudwatchlogs#QueryLanguage", + "traits": { + "smithy.api#documentation": "

The query language to use for the scheduled query. Valid values are CWLI,\n PPL, and SQL.

", + "smithy.api#required": {} + } + }, + "queryString": { + "target": "com.amazonaws.cloudwatchlogs#QueryString", + "traits": { + "smithy.api#documentation": "

The query string to execute. This is the same query syntax used in CloudWatch Logs\n Insights. Maximum length is 10,000 characters.

", + "smithy.api#required": {} + } + }, + "logGroupIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryLogGroupIdentifiers", + "traits": { + "smithy.api#documentation": "

An array of log group names or ARNs to query. You can specify between 1 and 50 log groups.\n Log groups can be identified by name or full ARN.

" + } + }, + "scheduleExpression": { + "target": "com.amazonaws.cloudwatchlogs#ScheduleExpression", + "traits": { + "smithy.api#documentation": "

A cron expression that defines when the scheduled query runs. The expression uses standard\n cron syntax and supports minute-level precision. Maximum length is 256 characters.

", + "smithy.api#required": {} + } + }, + "timezone": { + "target": "com.amazonaws.cloudwatchlogs#ScheduleTimezone", + "traits": { + "smithy.api#documentation": "

The timezone for evaluating the schedule expression. This determines when the scheduled\n query executes relative to the specified timezone.

" + } + }, + "startTimeOffset": { + "target": "com.amazonaws.cloudwatchlogs#StartTimeOffset", + "traits": { + "smithy.api#documentation": "

The time offset in seconds that defines the lookback period for the query. This determines\n how far back in time the query searches from the execution time.

" + } + }, + "endTimeOffset": { + "target": "com.amazonaws.cloudwatchlogs#EndTimeOffset", + "traits": { + "smithy.api#documentation": "

The time offset in seconds that defines the end of the lookback period for the query.\n Together with startTimeOffset, this determines the time window relative to the\n execution time over which the query runs.

" + } + }, + "destinationConfiguration": { + "target": "com.amazonaws.cloudwatchlogs#DestinationConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration for where to deliver query results. Supports Amazon S3 destinations for storing\n query output and lookup table destinations for automatically refreshing lookup tables with\n query results. You can configure one or both destination types.

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

The start time for the scheduled query in Unix epoch format. The query will not execute\n before this time.

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

The end time for the scheduled query in Unix epoch format. The query will stop executing\n after this time.

" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.cloudwatchlogs#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that grants permissions to execute the query and deliver results\n to the specified destination. The role must have permissions to read from the specified log\n groups and write to the destination.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryState", + "traits": { + "smithy.api#documentation": "

The initial state of the scheduled query. Valid values are ENABLED and\n DISABLED. Default is ENABLED.

" + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

Key-value pairs to associate with the scheduled query for resource management and cost\n allocation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateScheduledQueryResponse": { + "type": "structure", + "members": { + "scheduledQueryArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the created scheduled query.

" + } + }, + "state": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryState", + "traits": { + "smithy.api#documentation": "

The current state of the scheduled query.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DashboardViewerPrincipals": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#Arn" + } + }, + "com.amazonaws.cloudwatchlogs#Data": { + "type": "blob" + }, + "com.amazonaws.cloudwatchlogs#DataAlreadyAcceptedException": { + "type": "structure", + "members": { + "expectedSequenceToken": { + "target": "com.amazonaws.cloudwatchlogs#SequenceToken" + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The event was already logged.

\n \n

\n PutLogEvents actions are now always accepted and never return\n DataAlreadyAcceptedException regardless of whether a given batch of log\n events has already been accepted.

\n ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#DataProtectionPolicyDocument": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#DataProtectionStatus": { + "type": "enum", + "members": { + "ACTIVATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATED" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "ARCHIVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCHIVED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#DataSource": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DataSourceName", + "traits": { + "smithy.api#documentation": "

The name of the data source.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.cloudwatchlogs#DataSourceType", + "traits": { + "smithy.api#documentation": "

The type of the data source.

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

Represents a data source that categorizes logs by originating service and log type,\n providing service-based organization complementing traditional log groups.

" + } + }, + "com.amazonaws.cloudwatchlogs#DataSourceFilter": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DataSourceName", + "traits": { + "smithy.api#documentation": "

The name pattern to filter data sources by.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.cloudwatchlogs#DataSourceType", + "traits": { + "smithy.api#documentation": "

The type pattern to filter data sources by.

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

Filter criteria for data sources, used to specify which data sources to include in\n operations based on name and type.

" + } + }, + "com.amazonaws.cloudwatchlogs#DataSourceFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#DataSourceFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.cloudwatchlogs#DataSourceName": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#DataSourceType": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#DataType": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#DateTimeConverter": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.cloudwatchlogs#Source", + "traits": { + "smithy.api#documentation": "

The key to apply the date conversion to.

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

The JSON field to store the result in.

", + "smithy.api#required": {} + } + }, + "targetFormat": { + "target": "com.amazonaws.cloudwatchlogs#TargetFormat", + "traits": { + "smithy.api#documentation": "

The datetime format to use for the converted data in the target field.

\n

If you omit this, the default of yyyy-MM-dd'T'HH:mm:ss.SSS'Z is used.

" + } + }, + "matchPatterns": { + "target": "com.amazonaws.cloudwatchlogs#MatchPatterns", + "traits": { + "smithy.api#documentation": "

A list of patterns to match against the source field.

", + "smithy.api#required": {} + } + }, + "sourceTimezone": { + "target": "com.amazonaws.cloudwatchlogs#SourceTimezone", + "traits": { + "smithy.api#documentation": "

The time zone of the source field. If you omit this, the default used is the UTC\n zone.

" + } + }, + "targetTimezone": { + "target": "com.amazonaws.cloudwatchlogs#TargetTimezone", + "traits": { + "smithy.api#documentation": "

The time zone of the target field. If you omit this, the default used is the UTC\n zone.

" + } + }, + "locale": { + "target": "com.amazonaws.cloudwatchlogs#Locale", + "traits": { + "smithy.api#documentation": "

The locale of the source field. If you omit this, the default of locale.ROOT\n is used.

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

This processor converts a datetime string into a format that you specify.

\n

For more information about this processor including examples, see datetimeConverter in the CloudWatch Logs User\n Guide.

" + } + }, + "com.amazonaws.cloudwatchlogs#Days": { + "type": "integer", + "traits": { + "smithy.api#documentation": "

The number of days to retain the log events in the specified log group. Possible values\n are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557,\n 2922, 3288, and 3653.

\n

To set a log group so that its log events do not expire, use DeleteRetentionPolicy.

" + } + }, + "com.amazonaws.cloudwatchlogs#DefaultValue": { + "type": "double" + }, + "com.amazonaws.cloudwatchlogs#DeleteAccountPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteAccountPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a CloudWatch Logs account policy. This stops the account-wide policy from\n applying to log groups or data sources in the account. If you delete a data protection policy\n or subscription filter policy, any log-group level policies of those types remain in effect.\n This operation supports deletion of data source-based field index policies, including facet\n configurations, in addition to log group-based policies.

\n

To use this operation, you must be signed on with the correct permissions depending on the\n type of policy that you are deleting.

\n
    \n
  • \n

    To delete a data protection policy, you must have the\n logs:DeleteDataProtectionPolicy and logs:DeleteAccountPolicy\n permissions.

    \n
    • \n
  • \n

    To delete a subscription filter policy, you must have the\n logs:DeleteSubscriptionFilter and logs:DeleteAccountPolicy\n permissions.

    \n
    • \n
  • \n

    To delete a transformer policy, you must have the logs:DeleteTransformer\n and logs:DeleteAccountPolicy permissions.

    \n
    • \n
  • \n

    To delete a field index policy, you must have the logs:DeleteIndexPolicy\n and logs:DeleteAccountPolicy permissions.

    \n

    If you delete a field index policy that included facet configurations, those facets\n will no longer be available for interactive exploration in the CloudWatch Logs Insights\n console. However, facet data is retained for up to 30 days.

    \n
    • \n
\n

If you delete a field index policy, the indexing of the log events that happened before\n you deleted the policy will still be used for up to 30 days to improve CloudWatch Logs\n Insights queries.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteAccountPolicyRequest": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#PolicyName", + "traits": { + "smithy.api#documentation": "

The name of the policy to delete.

", + "smithy.api#required": {} + } + }, + "policyType": { + "target": "com.amazonaws.cloudwatchlogs#PolicyType", + "traits": { + "smithy.api#documentation": "

The type of policy to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDataProtectionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteDataProtectionPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the data protection policy from the specified log group.

\n

For more information about data protection policies, see PutDataProtectionPolicy.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDataProtectionPolicyRequest": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

The name or ARN of the log group that you want to delete the data protection policy\n for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDelivery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteDeliveryRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a delivery. A delivery is a connection between a logical\n delivery source and a logical delivery\n destination. Deleting a delivery only deletes the connection between the delivery\n source and delivery destination. It does not delete the delivery destination or the delivery\n source.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a delivery destination. A delivery is a connection between a\n logical delivery source and a logical delivery\n destination.

\n

You can't delete a delivery destination if any current deliveries are associated with it.\n To find whether any deliveries are associated with this delivery destination, use the DescribeDeliveries operation and check the deliveryDestinationArn\n field in the results.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a delivery destination policy. For more information about these policies, see\n PutDeliveryDestinationPolicy.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationPolicyRequest": { + "type": "structure", + "members": { + "deliveryDestinationName": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", + "traits": { + "smithy.api#documentation": "

The name of the delivery destination that you want to delete the policy for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", + "traits": { + "smithy.api#documentation": "

The name of the delivery destination that you want to delete. You can find a list of\n delivery destination names by using the DescribeDeliveryDestinations operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDeliveryRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryId", + "traits": { + "smithy.api#documentation": "

The unique ID of the delivery to delete. You can find the ID of a delivery with the DescribeDeliveries operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDeliverySource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteDeliverySourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a delivery source. A delivery is a connection between a\n logical delivery source and a logical delivery\n destination.

\n

You can't delete a delivery source if any current deliveries are associated with it. To\n find whether any deliveries are associated with this delivery source, use the DescribeDeliveries operation and check the deliverySourceName field in\n the results.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDeliverySourceRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", + "traits": { + "smithy.api#documentation": "

The name of the delivery source that you want to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteDestinationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified destination, and eventually disables all the subscription filters\n that publish to it. This operation does not delete the physical resource encapsulated by the\n destination.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDestinationRequest": { + "type": "structure", + "members": { + "destinationName": { + "target": "com.amazonaws.cloudwatchlogs#DestinationName", + "traits": { + "smithy.api#documentation": "

The name of the destination.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteIndexPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteIndexPolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DeleteIndexPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a log-group level field index policy that was applied to a single log group. The\n indexing of the log events that happened before you delete the policy will still be used for\n as many as 30 days to improve CloudWatch Logs Insights queries.

\n

If the deleted policy included facet configurations, those facets will no longer be\n available for interactive exploration in the CloudWatch Logs Insights console for this log\n group. However, facet data is retained for up to 30 days.

\n

You can't use this operation to delete an account-level index policy. Instead, use DeleteAccountPolicy.

\n

If you delete a log-group level field index policy and there is an account-level field\n index policy, in a few minutes the log group begins using that account-wide policy to index\n new incoming log events. This operation only affects log group-level policies, including any\n facet configurations, and preserves any data source-based account policies that may apply to\n the log group.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteIndexPolicyRequest": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

The log group to delete the index policy for. You can specify either the name or the ARN\n of the log group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteIndexPolicyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteIntegrationRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DeleteIntegrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the integration between CloudWatch Logs and OpenSearch Service. If your\n integration has active vended logs dashboards, you must specify true for the\n force parameter, otherwise the operation will fail. If you delete the\n integration by setting force to true, all your vended logs\n dashboards powered by OpenSearch Service will be deleted and the data that was on them will no\n longer be accessible.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteIntegrationRequest": { + "type": "structure", + "members": { + "integrationName": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationName", + "traits": { + "smithy.api#documentation": "

The name of the integration to delete. To find the name of your integration, use ListIntegrations.

", + "smithy.api#required": {} + } + }, + "force": { + "target": "com.amazonaws.cloudwatchlogs#Force", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specify true to force the deletion of the integration even if vended logs\n dashboards currently exist.

\n

The default is false.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteIntegrationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteKeys": { + "type": "structure", + "members": { + "withKeys": { + "target": "com.amazonaws.cloudwatchlogs#DeleteWithKeys", + "traits": { + "smithy.api#documentation": "

The list of keys to delete.

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

This processor deletes entries from a log event. These entries are key-value pairs.

\n

For more information about this processor including examples, see deleteKeys in the CloudWatch Logs User Guide.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteLogAnomalyDetector": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteLogAnomalyDetectorRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified CloudWatch Logs anomaly detector.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteLogAnomalyDetectorRequest": { + "type": "structure", + "members": { + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "

The ARN of the anomaly detector to delete. You can find the ARNs of log anomaly detectors\n in your account by using the ListLogAnomalyDetectors operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteLogGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteLogGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified log group and permanently deletes all the archived log events\n associated with the log group.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteLogGroupRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteLogStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteLogStreamRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified log stream and permanently deletes all the archived log events\n associated with the log stream.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteLogStreamRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + }, + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "

The name of the log stream.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteLookupTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteLookupTableRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a lookup table permanently. This operation cannot be undone.

\n

Queries that reference a deleted table will return an error. Before deleting a lookup\n table, review any saved queries or dashboards that may reference it.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteLookupTableRequest": { + "type": "structure", + "members": { + "lookupTableArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the lookup table to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteMetricFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteMetricFilterRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified metric filter.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteMetricFilterRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + }, + "filterName": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "

The name of the metric filter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteQueryDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteQueryDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DeleteQueryDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a saved CloudWatch Logs Insights query definition. A query definition contains\n details about a saved CloudWatch Logs Insights query.

\n

Each DeleteQueryDefinition operation can delete one query definition.

\n

You must have the logs:DeleteQueryDefinition permission to be able to perform\n this operation.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteQueryDefinitionRequest": { + "type": "structure", + "members": { + "queryDefinitionId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "

The ID of the query definition that you want to delete. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query\n definitions.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteQueryDefinitionResponse": { + "type": "structure", + "members": { + "success": { + "target": "com.amazonaws.cloudwatchlogs#Success", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value of TRUE indicates that the operation succeeded. FALSE indicates that the operation\n failed.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteResourcePolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a resource policy from this account. This revokes the access of the identities\n in that policy to put log events to this account.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#PolicyName", + "traits": { + "smithy.api#documentation": "

The name of the policy to be revoked. This parameter is required.

" + } + }, + "resourceArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the CloudWatch Logs resource for which the resource policy needs to be\n deleted

" + } + }, + "expectedRevisionId": { + "target": "com.amazonaws.cloudwatchlogs#ExpectedRevisionId", + "traits": { + "smithy.api#documentation": "

The expected revision ID of the resource policy. Required when deleting a resource-scoped\n policy to prevent concurrent modifications.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteRetentionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteRetentionPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified retention policy.

\n

Log events do not expire if they belong to log groups without a retention\n policy.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteRetentionPolicyRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteScheduledQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteScheduledQueryRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DeleteScheduledQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InternalServerException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a scheduled query and stops all future executions. This operation also removes any\n configured actions and associated resources.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteScheduledQueryRequest": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryIdentifier", + "traits": { + "smithy.api#documentation": "

The ARN or name of the scheduled query to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteScheduledQueryResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteSubscriptionFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteSubscriptionFilterRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified subscription filter.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteSubscriptionFilterRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + }, + "filterName": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "

The name of the subscription filter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteSyslogConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteSyslogConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a syslog configuration for a log group. After deletion, syslog data is no\n longer ingested through the specified VPC endpoint.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteSyslogConfigurationRequest": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

The name or ARN of the log group to remove the syslog configuration from.

", + "smithy.api#required": {} + } + }, + "vpcEndpointId": { + "target": "com.amazonaws.cloudwatchlogs#VpcEndpointId", + "traits": { + "smithy.api#documentation": "

The ID of the VPC endpoint associated with the syslog configuration to delete.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteTransformer": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteTransformerRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the log transformer for the specified log group. As soon as you do this, the\n transformation of incoming log events according to that transformer stops. If this account has\n an account-level transformer that applies to this log group, the log group begins using that\n account-level transformer when this log-group level transformer is deleted.

\n

After you delete a transformer, be sure to edit any metric filters or subscription filters\n that relied on the transformed versions of the log events.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteTransformerRequest": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

Specify either the name or ARN of the log group to delete the transformer for. If the log\n group is in a source account and you are using a monitoring account, you must use the log\n group ARN.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteWithKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#WithKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.cloudwatchlogs#DeletionProtectionEnabled": { + "type": "boolean" + }, + "com.amazonaws.cloudwatchlogs#Delimiter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.cloudwatchlogs#Deliveries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#Delivery" + } + }, + "com.amazonaws.cloudwatchlogs#Delivery": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryId", + "traits": { + "smithy.api#documentation": "

The unique ID that identifies this delivery in your account.

" + } + }, + "arn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies this delivery.

" + } + }, + "deliverySourceName": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", + "traits": { + "smithy.api#documentation": "

The name of the delivery source that is associated with this delivery.

" + } + }, + "deliveryDestinationArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the delivery destination that is associated with this delivery.

" + } + }, + "deliveryDestinationType": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationType", + "traits": { + "smithy.api#documentation": "

Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, Firehose, or X-Ray.

" + } + }, + "recordFields": { + "target": "com.amazonaws.cloudwatchlogs#RecordFields", + "traits": { + "smithy.api#documentation": "

The record fields used in this delivery.

" + } + }, + "fieldDelimiter": { + "target": "com.amazonaws.cloudwatchlogs#FieldDelimiter", + "traits": { + "smithy.api#documentation": "

The field delimiter that is used between record fields when the final output format of a\n delivery is in Plain, W3C, or Raw format.

" + } + }, + "s3DeliveryConfiguration": { + "target": "com.amazonaws.cloudwatchlogs#S3DeliveryConfiguration", + "traits": { + "smithy.api#documentation": "

This structure contains delivery configurations that apply only when the delivery\n destination resource is an S3 bucket.

" + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

The tags that have been assigned to this delivery.

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

This structure contains information about one delivery in your\n account.

\n

A delivery is a connection between a logical delivery source and a\n logical delivery destination.

\n

For more information, see CreateDelivery.

\n

To update an existing delivery configuration, use UpdateDeliveryConfiguration.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryDestination": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", + "traits": { + "smithy.api#documentation": "

The name of this delivery destination.

" + } + }, + "arn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies this delivery destination.

" + } + }, + "deliveryDestinationType": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationType", + "traits": { + "smithy.api#documentation": "

Displays whether this delivery destination is CloudWatch Logs, Amazon S3,\n Firehose, or X-Ray.

" + } + }, + "outputFormat": { + "target": "com.amazonaws.cloudwatchlogs#OutputFormat", + "traits": { + "smithy.api#documentation": "

The format of the logs that are sent to this delivery destination.

" + } + }, + "deliveryDestinationConfiguration": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationConfiguration", + "traits": { + "smithy.api#documentation": "

A structure that contains the ARN of the Amazon Web Services resource that will receive the\n logs.

" + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

The tags that have been assigned to this delivery destination.

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

This structure contains information about one delivery destination in\n your account. A delivery destination is an Amazon Web Services resource that represents an\n Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3,\n Firehose, and X-Ray are supported as delivery destinations.

\n

To configure logs delivery between a supported Amazon Web Services service and a\n destination, you must do the following:

\n
    \n
  • \n

    Create a delivery source, which is a logical object that represents the resource that\n is actually sending the logs. For more information, see PutDeliverySource.

    \n
    • \n
  • \n

    Create a delivery destination, which is a logical object that\n represents the actual delivery destination.

    \n
    • \n
  • \n

    If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.\n

    \n
    • \n
  • \n

    Create a delivery by pairing exactly one delivery source and one\n delivery destination. For more information, see CreateDelivery.

    \n
    • \n
\n

You can configure a single delivery source to send logs to multiple destinations by\n creating multiple deliveries. You can also create multiple deliveries to configure multiple\n delivery sources to send logs to the same delivery destination.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryDestinationConfiguration": { + "type": "structure", + "members": { + "destinationResourceArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the Amazon Web Services destination that this delivery destination represents.\n That Amazon Web Services destination can be a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.

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

A structure that contains information about one logs delivery destination.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryDestinationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60 + }, + "smithy.api#pattern": "^[\\w-]*$" + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryDestinationPolicy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 51200 + } + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryDestinationType": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + }, + "CWL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CWL" + } + }, + "FH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FH" + } + }, + "XRAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XRAY" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryDestinationTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4 + } + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryDestinations": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestination" + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9A-Za-z]+$" + } + }, + "com.amazonaws.cloudwatchlogs#DeliverySource": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", + "traits": { + "smithy.api#documentation": "

The unique name of the delivery source.

" + } + }, + "arn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies this delivery source.

" + } + }, + "resourceArns": { + "target": "com.amazonaws.cloudwatchlogs#ResourceArns", + "traits": { + "smithy.api#documentation": "

This array contains the ARN of the Amazon Web Services resource that sends logs and is\n represented by this delivery source. Currently, only one ARN can be in the array.

" + } + }, + "service": { + "target": "com.amazonaws.cloudwatchlogs#Service", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services service that is sending logs.

" + } + }, + "logType": { + "target": "com.amazonaws.cloudwatchlogs#LogType", + "traits": { + "smithy.api#documentation": "

The type of log that the source is sending. For valid values for this parameter, see the\n documentation for the source service.

" + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

The tags that have been assigned to this delivery source.

" + } + }, + "deliverySourceConfiguration": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceConfiguration", + "traits": { + "smithy.api#documentation": "

The map of key-value pairs that configure the delivery source.

" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceStatus", + "traits": { + "smithy.api#documentation": "

The status of the delivery source. A delivery source can have the status\n ACTIVE or INACTIVE. Note: This value is defined for selective log types.

" + } + }, + "statusReason": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceStatusReason", + "traits": { + "smithy.api#documentation": "

The reason for the status of the delivery source. A status reason of\n RESOURCE_DELETED indicates that the resource associated with the delivery\n source has been deleted. Note: This value is defined for selective log types.

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

This structure contains information about one delivery source in your\n account. A delivery source is an Amazon Web Services resource that sends logs to an Amazon Web Services destination. The destination can be CloudWatch Logs, Amazon S3, or\n Firehose.

\n

Only some Amazon Web Services services support being configured as a delivery source. These\n services are listed as Supported [V2 Permissions] in the\n table at Enabling logging from\n Amazon Web Services services.\n

\n

To configure logs delivery between a supported Amazon Web Services service and a\n destination, you must do the following:

\n
    \n
  • \n

    Create a delivery source, which is a logical object that represents the resource that\n is actually sending the logs. For more information, see PutDeliverySource.

    \n
    • \n
  • \n

    Create a delivery destination, which is a logical object that\n represents the actual delivery destination. For more information, see PutDeliveryDestination.

    \n
    • \n
  • \n

    If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.\n

    \n
    • \n
  • \n

    Create a delivery by pairing exactly one delivery source and one\n delivery destination. For more information, see CreateDelivery.

    \n
    • \n
\n

You can configure a single delivery source to send logs to multiple destinations by\n creating multiple deliveries. You can also create multiple deliveries to configure multiple\n delivery sources to send logs to the same delivery destination.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeliverySourceConfiguration": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceConfigurationKey" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceConfigurationValue" + } + }, + "com.amazonaws.cloudwatchlogs#DeliverySourceConfigurationKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.cloudwatchlogs#DeliverySourceConfigurationNumericValue": { + "type": "double" + }, + "com.amazonaws.cloudwatchlogs#DeliverySourceConfigurationSchema": { + "type": "structure", + "members": { + "keyName": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceConfigurationSchemaField", + "traits": { + "smithy.api#documentation": "

The name of the configuration.

", + "smithy.api#required": {} + } + }, + "valueType": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceConfigurationSchemaValueType", + "traits": { + "smithy.api#documentation": "

The data type of the configuration value. Valid values are string,\n boolean, int, double, and\n long.

", + "smithy.api#required": {} + } + }, + "defaultValue": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceConfigurationSchemaField", + "traits": { + "smithy.api#documentation": "

The default value of the configuration that is used when a value is not\n specified in a PutDeliverySource request.

", + "smithy.api#required": {} + } + }, + "supportedValues": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceConfigurationSupportedValues", + "traits": { + "smithy.api#documentation": "

The list of allowed values for the configuration. Empty for free-form configuration.

" + } + }, + "minValue": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceConfigurationNumericValue", + "traits": { + "smithy.api#documentation": "

The minimum numeric value allowed for the configuration. This applies only when\n the valueType is a numeric type.

" + } + }, + "maxValue": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceConfigurationNumericValue", + "traits": { + "smithy.api#documentation": "

The maximum numeric value allowed for the configuration. This applies only when\n the valueType is a numeric type.

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

A structure that describes a single configuration for a log type,\n including its name, value type, default value, and the range of supported values.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeliverySourceConfigurationSchemaField": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#DeliverySourceConfigurationSchemaValueType": { + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "string" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "boolean" + } + }, + "INT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "int" + } + }, + "DOUBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "double" + } + }, + "LONG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "long" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#DeliverySourceConfigurationSchemas": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceConfigurationSchema" + }, + "traits": { + "smithy.api#documentation": "

A list of DeliverySourceConfigurationSchema objects that describe the available configuration\n parameters for a delivery source.

" + } + }, + "com.amazonaws.cloudwatchlogs#DeliverySourceConfigurationSupportedValues": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceConfigurationSchemaField" + } + }, + "com.amazonaws.cloudwatchlogs#DeliverySourceConfigurationValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.cloudwatchlogs#DeliverySourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60 + }, + "smithy.api#pattern": "^[\\w-]*$" + } + }, + "com.amazonaws.cloudwatchlogs#DeliverySourceStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#DeliverySourceStatusReason": { + "type": "enum", + "members": { + "RESOURCE_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_DELETED" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#DeliverySources": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySource" + } + }, + "com.amazonaws.cloudwatchlogs#DeliverySuffixPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#Descending": { + "type": "boolean" + }, + "com.amazonaws.cloudwatchlogs#DescribeAccountPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all CloudWatch Logs account policies in the account.

\n

To use this operation, you must be signed on with the correct permissions depending on the\n type of policy that you are retrieving information for.

\n
    \n
  • \n

    To see data protection policies, you must have the\n logs:GetDataProtectionPolicy and logs:DescribeAccountPolicies\n permissions.

    \n
    • \n
  • \n

    To see subscription filter policies, you must have the\n logs:DescribeSubscriptionFilters and\n logs:DescribeAccountPolicies permissions.

    \n
    • \n
  • \n

    To see transformer policies, you must have the logs:GetTransformer and\n logs:DescribeAccountPolicies permissions.

    \n
    • \n
  • \n

    To see field index policies, you must have the logs:DescribeIndexPolicies\n and logs:DescribeAccountPolicies permissions.

    \n
    • \n
" + } + }, + "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesRequest": { + "type": "structure", + "members": { + "policyType": { + "target": "com.amazonaws.cloudwatchlogs#PolicyType", + "traits": { + "smithy.api#documentation": "

Use this parameter to limit the returned policies to only the policies that match the\n policy type that you specify.

", + "smithy.api#required": {} + } + }, + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#PolicyName", + "traits": { + "smithy.api#documentation": "

Use this parameter to limit the returned policies to only the policy with the name that\n you specify.

" + } + }, + "accountIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#AccountIds", + "traits": { + "smithy.api#documentation": "

If you are using an account that is set up as a monitoring account for CloudWatch\n unified cross-account observability, you can use this to specify the account ID of a source\n account. If you do, the operation returns the account policy for the specified account.\n Currently, you can specify only one account ID in this parameter.

\n

If you omit this parameter, only the policy in the current account is returned.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous\n call.)

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesResponse": { + "type": "structure", + "members": { + "accountPolicies": { + "target": "com.amazonaws.cloudwatchlogs#AccountPolicies", + "traits": { + "smithy.api#documentation": "

An array of structures that contain information about the CloudWatch Logs account\n policies that match the specified filters.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use when requesting the next set of items. The token expires after 24\n hours.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplatesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Use this operation to return the valid and default values that are used when creating\n delivery sources, delivery destinations, and deliveries. For more information about\n deliveries, see CreateDelivery.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "configurationTemplates", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplatesRequest": { + "type": "structure", + "members": { + "service": { + "target": "com.amazonaws.cloudwatchlogs#Service", + "traits": { + "smithy.api#documentation": "

Use this parameter to filter the response to include only the configuration templates that\n apply to the Amazon Web Services service that you specify here.

" + } + }, + "logTypes": { + "target": "com.amazonaws.cloudwatchlogs#LogTypes", + "traits": { + "smithy.api#documentation": "

Use this parameter to filter the response to include only the configuration templates that\n apply to the log types that you specify here.

" + } + }, + "resourceTypes": { + "target": "com.amazonaws.cloudwatchlogs#ResourceTypes", + "traits": { + "smithy.api#documentation": "

Use this parameter to filter the response to include only the configuration templates that\n apply to the resource types that you specify here.

" + } + }, + "deliveryDestinationTypes": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationTypes", + "traits": { + "smithy.api#documentation": "

Use this parameter to filter the response to include only the configuration templates that\n apply to the delivery destination types that you specify here.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

Use this parameter to limit the number of configuration templates that are returned in the\n response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplatesResponse": { + "type": "structure", + "members": { + "configurationTemplates": { + "target": "com.amazonaws.cloudwatchlogs#ConfigurationTemplates", + "traits": { + "smithy.api#documentation": "

An array of objects, where each object describes one configuration template that matches\n the filters that you specified in the request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliveries": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveriesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveriesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of the deliveries that have been created in the account.

\n

A delivery is a connection between a \n delivery\n source\n and a \n delivery destination\n .

\n

A delivery source represents an Amazon Web Services resource that sends logs to an logs\n delivery destination. The destination can be CloudWatch Logs, Amazon S3, Firehose or X-Ray. Only some Amazon Web Services services support being\n configured as a delivery source. These services are listed in Enable logging from\n Amazon Web Services services.\n

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "deliveries", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliveriesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

Optionally specify the maximum number of deliveries to return in the response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliveriesResponse": { + "type": "structure", + "members": { + "deliveries": { + "target": "com.amazonaws.cloudwatchlogs#Deliveries", + "traits": { + "smithy.api#documentation": "

An array of structures. Each structure contains information about one delivery in the\n account.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinations": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinationsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of the delivery destinations that have been created in the\n account.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "deliveryDestinations", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

Optionally specify the maximum number of delivery destinations to return in the\n response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinationsResponse": { + "type": "structure", + "members": { + "deliveryDestinations": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinations", + "traits": { + "smithy.api#documentation": "

An array of structures. Each structure contains information about one delivery destination\n in the account.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliverySources": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliverySourcesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliverySourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of the delivery sources that have been created in the account.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "deliverySources", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliverySourcesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

Optionally specify the maximum number of delivery sources to return in the\n response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliverySourcesResponse": { + "type": "structure", + "members": { + "deliverySources": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySources", + "traits": { + "smithy.api#documentation": "

An array of structures. Each structure contains information about one delivery source in\n the account.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDestinations": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDestinationsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDestinationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all your destinations. The results are ASCII-sorted by destination\n name.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "destinations", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDestinationsRequest": { + "type": "structure", + "members": { + "DestinationNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#DestinationName", + "traits": { + "smithy.api#documentation": "

The prefix to match. If you don't specify a value, no prefix filter is\n applied.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous\n call.)

" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of items returned. If you don't specify a value, the default maximum\n value of 50 items is used.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDestinationsResponse": { + "type": "structure", + "members": { + "destinations": { + "target": "com.amazonaws.cloudwatchlogs#Destinations", + "traits": { + "smithy.api#documentation": "

The destinations.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeExportTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeExportTasksRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeExportTasksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the specified export tasks. You can list all your export tasks or filter the\n results based on task ID or task status.

" + } + }, + "com.amazonaws.cloudwatchlogs#DescribeExportTasksRequest": { + "type": "structure", + "members": { + "taskId": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskId", + "traits": { + "smithy.api#documentation": "

The ID of the export task. Specifying a task ID filters the results to one or zero\n export tasks.

" + } + }, + "statusCode": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskStatusCode", + "traits": { + "smithy.api#documentation": "

The status code of the export task. Specifying a status code filters the results to\n zero or more export tasks.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous\n call.)

" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of items returned. If you don't specify a value, the default is up\n to 50 items.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeExportTasksResponse": { + "type": "structure", + "members": { + "exportTasks": { + "target": "com.amazonaws.cloudwatchlogs#ExportTasks", + "traits": { + "smithy.api#documentation": "

The export tasks.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeFieldIndexes": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeFieldIndexesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeFieldIndexesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of field indexes discovered in log data. By default, the response includes\n the DEFAULT, CUSTOM, and INACTIVE index categories. To\n return indexes from other categories, use the indexCategories parameter.

\n

For more information about field index policies, see PutIndexPolicy.

" + } + }, + "com.amazonaws.cloudwatchlogs#DescribeFieldIndexesLogGroupIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeFieldIndexesRequest": { + "type": "structure", + "members": { + "logGroupIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#DescribeFieldIndexesLogGroupIdentifiers", + "traits": { + "smithy.api#documentation": "

An array containing the names or ARNs of the log groups that you want to retrieve field\n indexes for.

", + "smithy.api#required": {} + } + }, + "indexCategories": { + "target": "com.amazonaws.cloudwatchlogs#IndexCategories", + "traits": { + "smithy.api#documentation": "

The index categories to return. The following values are supported:

\n
    \n
  • \n

    \n DEFAULT: Fields that CloudWatch Logs indexes by default. Examples\n include @logStream and @data_format.

    \n
    • \n
  • \n

    \n CUSTOM: Fields that you added manually to the field index policy.\n CloudWatch Logs always indexes these fields. These fields count toward the quota of\n 20 fields for each log group.

    \n
    • \n
  • \n

    \n AUTO: Fields that CloudWatch Logs indexes automatically based on your\n query patterns and usage. These fields do not count toward the field index quota.\n CloudWatch Logs might update these fields based on changes in your query patterns. To\n keep a field indexed permanently, add it to an account-level or log-group level field\n index policy.

    \n
    • \n
  • \n

    \n INACTIVE: Fields that CloudWatch Logs indexed before but does not\n index now. This happens if you remove a field from the field index policy or if\n CloudWatch Logs automatically selects a different field based on your queries.

    \n
    • \n
\n

If you omit this parameter, the response includes the DEFAULT,\n CUSTOM, and INACTIVE categories.

\n

For more information about automatically indexed fields and using the AUTO\n category, see Automatically indexed fields.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeFieldIndexesResponse": { + "type": "structure", + "members": { + "fieldIndexes": { + "target": "com.amazonaws.cloudwatchlogs#FieldIndexes", + "traits": { + "smithy.api#documentation": "

An array containing the field index information.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeImportTaskBatches": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeImportTaskBatchesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeImportTaskBatchesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets detailed information about the individual batches within an import task, including their status and any error messages.\n For CloudTrail Event Data Store sources, a batch refers to a subset of stored events grouped by their eventTime.

" + } + }, + "com.amazonaws.cloudwatchlogs#DescribeImportTaskBatchesRequest": { + "type": "structure", + "members": { + "importId": { + "target": "com.amazonaws.cloudwatchlogs#ImportId", + "traits": { + "smithy.api#documentation": "

The ID of the import task to get batch information for.

", + "smithy.api#required": {} + } + }, + "batchImportStatus": { + "target": "com.amazonaws.cloudwatchlogs#ImportStatusList", + "traits": { + "smithy.api#documentation": "

Optional filter to list import batches by their status. Accepts multiple status values: IN_PROGRESS, CANCELLED, COMPLETED and FAILED.

" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of import batches to return in the response. Default: 10

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token for the next set of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeImportTaskBatchesResponse": { + "type": "structure", + "members": { + "importSourceArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the source being imported from.

" + } + }, + "importId": { + "target": "com.amazonaws.cloudwatchlogs#ImportId", + "traits": { + "smithy.api#documentation": "

The ID of the import task.

" + } + }, + "importBatches": { + "target": "com.amazonaws.cloudwatchlogs#ImportBatchList", + "traits": { + "smithy.api#documentation": "

The list of import batches that match the request filters.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use when requesting the next set of results. Not present if there are no additional results to retrieve.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeImportTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeImportTasksRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeImportTasksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists and describes import tasks, with optional filtering by import status and source ARN.

" + } + }, + "com.amazonaws.cloudwatchlogs#DescribeImportTasksRequest": { + "type": "structure", + "members": { + "importId": { + "target": "com.amazonaws.cloudwatchlogs#ImportId", + "traits": { + "smithy.api#documentation": "

Optional filter to describe a specific import task by its ID.

" + } + }, + "importStatus": { + "target": "com.amazonaws.cloudwatchlogs#ImportStatus", + "traits": { + "smithy.api#documentation": "

Optional filter to list imports by their status. Valid values are IN_PROGRESS, CANCELLED, COMPLETED and FAILED.

" + } + }, + "importSourceArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

Optional filter to list imports from a specific source

" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of import tasks to return in the response. Default: 50

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token for the next set of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeImportTasksResponse": { + "type": "structure", + "members": { + "imports": { + "target": "com.amazonaws.cloudwatchlogs#ImportList", + "traits": { + "smithy.api#documentation": "

The list of import tasks that match the request filters.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use when requesting the next set of results. Not present if there are no additional results to retrieve.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeIndexPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeIndexPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeIndexPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the field index policies of the specified log group. For more information about\n field index policies, see PutIndexPolicy.

\n

If a specified log group has a log-group level index policy, that policy is returned by\n this operation.

\n

If a specified log group doesn't have a log-group level index policy, but an account-wide\n index policy applies to it, that account-wide policy is returned by this operation.

\n

To find information about only account-level policies, use DescribeAccountPolicies instead.

" + } + }, + "com.amazonaws.cloudwatchlogs#DescribeIndexPoliciesLogGroupIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeIndexPoliciesRequest": { + "type": "structure", + "members": { + "logGroupIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#DescribeIndexPoliciesLogGroupIdentifiers", + "traits": { + "smithy.api#documentation": "

An array containing the name or ARN of the log group that you want to retrieve field index\n policies for.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeIndexPoliciesResponse": { + "type": "structure", + "members": { + "indexPolicies": { + "target": "com.amazonaws.cloudwatchlogs#IndexPolicies", + "traits": { + "smithy.api#documentation": "

An array containing the field index policies.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLogGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLogGroupsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLogGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about log groups, including data sources that ingest into each log\n group. You can return all your log groups or filter the results by prefix. The results are\n ASCII-sorted by log group name.

\n

CloudWatch Logs doesn't support IAM policies that control access to the\n DescribeLogGroups action by using the\n aws:ResourceTag/key-name\n condition key. Other CloudWatch\n Logs actions do support the use of the\n aws:ResourceTag/key-name\n condition key to control access.\n For more information about using tags to control access, see Controlling access to Amazon Web Services\n resources using tags.

\n

If you are using CloudWatch cross-account observability, you can use this operation\n in a monitoring account and view data from the linked source accounts. For more information,\n see CloudWatch cross-account observability.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "logGroups", + "pageSize": "limit" + }, + "smithy.test#smokeTests": [ + { + "id": "DescribeLogGroupsSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLogGroupsLogGroupIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLogGroupsRequest": { + "type": "structure", + "members": { + "accountIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#AccountIds", + "traits": { + "smithy.api#documentation": "

When includeLinkedAccounts is set to true, use this parameter to\n specify the list of accounts to search. You can specify as many as 20 account IDs in the\n array.

" + } + }, + "logGroupNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The prefix to match.

\n \n

\n logGroupNamePrefix and logGroupNamePattern are mutually exclusive.\n Only one of these parameters can be passed.

\n " + } + }, + "logGroupNamePattern": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupNamePattern", + "traits": { + "smithy.api#documentation": "

If you specify a string for this parameter, the operation returns only log groups that\n have names that match the string based on a case-sensitive substring search. For example, if\n you specify DataLogs, log groups named DataLogs,\n aws/DataLogs, and GroupDataLogs would match, but\n datalogs, Data/log/s and Groupdata would not\n match.

\n

If you specify logGroupNamePattern in your request, then only\n arn, creationTime, and logGroupName are included in\n the response.

\n \n

\n logGroupNamePattern and logGroupNamePrefix are mutually exclusive.\n Only one of these parameters can be passed.

\n " + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous\n call.)

" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of items returned. If you don't specify a value, the default is up\n to 50 items.

" + } + }, + "includeLinkedAccounts": { + "target": "com.amazonaws.cloudwatchlogs#IncludeLinkedAccounts", + "traits": { + "smithy.api#documentation": "

If you are using a monitoring account, set this to true to have the operation\n return log groups in the accounts listed in accountIdentifiers.

\n

If this parameter is set to true and accountIdentifiers contains\n a null value, the operation returns all log groups in the monitoring account and all log\n groups in all source accounts that are linked to the monitoring account.

\n

The default for this parameter is false.

" + } + }, + "logGroupClass": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupClass", + "traits": { + "smithy.api#documentation": "

Use this parameter to limit the results to only those log groups in the specified log\n group class. If you omit this parameter, log groups of all classes can be returned.

\n

Specifies the log group class for this log group. There are three classes:

\n
    \n
  • \n

    The Standard log class supports all CloudWatch Logs features.

    \n
    • \n
  • \n

    The Infrequent Access log class supports a subset of CloudWatch Logs\n features and incurs lower costs.

    \n
    • \n
  • \n

    Use the Delivery log class only for delivering Lambda\n logs to store in Amazon S3 or Amazon Data Firehose. Log events in log groups in\n the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn't\n offer rich CloudWatch Logs capabilities such as CloudWatch Logs Insights\n queries.

    \n
    • \n
\n

For details about the features supported by each class, see Log classes\n

" + } + }, + "logGroupIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLogGroupsLogGroupIdentifiers", + "traits": { + "smithy.api#documentation": "

Use this array to filter the list of log groups returned. If you specify this parameter,\n the only other filter that you can choose to specify is\n includeLinkedAccounts.

\n

If you are using this operation in a monitoring account, you can specify the ARNs of log\n groups in source accounts and in the monitoring account itself. If you are using this\n operation in an account that is not a cross-account monitoring account, you can specify only\n log group names in the same account as the operation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLogGroupsResponse": { + "type": "structure", + "members": { + "logGroups": { + "target": "com.amazonaws.cloudwatchlogs#LogGroups", + "traits": { + "smithy.api#documentation": "

An array of structures, where each structure contains the information about one log\n group.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLogStreams": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLogStreamsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLogStreamsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the log streams for the specified log group. You can list all the log streams or\n filter the results by prefix. You can also control how the results are ordered.

\n

You can specify the log group to search by using either logGroupIdentifier or\n logGroupName. You must include one of these two parameters, but you can't\n include both.

\n

This operation has a limit of 25 transactions per second, after which transactions are\n throttled.

\n

If you are using CloudWatch cross-account observability, you can use this operation\n in a monitoring account and view data from the linked source accounts. For more information,\n see CloudWatch cross-account observability.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "logStreams", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLogStreamsRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

\n \n

You must include either logGroupIdentifier or logGroupName,\n but not both.

\n " + } + }, + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

Specify either the name or ARN of the log group to view. If the log group is in a source\n account and you are using a monitoring account, you must use the log group ARN.

\n \n

You must include either logGroupIdentifier or logGroupName,\n but not both.

\n " + } + }, + "logStreamNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "

The prefix to match.

\n

If orderBy is LastEventTime, you cannot specify this\n parameter.

" + } + }, + "orderBy": { + "target": "com.amazonaws.cloudwatchlogs#OrderBy", + "traits": { + "smithy.api#documentation": "

If the value is LogStreamName, the results are ordered by log stream name.\n If the value is LastEventTime, the results are ordered by the event time. The\n default value is LogStreamName.

\n

If you order the results by event time, you cannot specify the\n logStreamNamePrefix parameter.

\n

\n lastEventTimestamp represents the time of the most recent log event in the\n log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC. lastEventTimestamp updates on an\n eventual consistency basis. It typically updates in less than an hour from ingestion, but in\n rare situations might take longer.

" + } + }, + "descending": { + "target": "com.amazonaws.cloudwatchlogs#Descending", + "traits": { + "smithy.api#documentation": "

If the value is true, results are returned in descending order. If the value is to\n false, results are returned in ascending order. The default value is false.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous\n call.)

" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of items returned. If you don't specify a value, the default is up\n to 50 items.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLogStreamsResponse": { + "type": "structure", + "members": { + "logStreams": { + "target": "com.amazonaws.cloudwatchlogs#LogStreams", + "traits": { + "smithy.api#documentation": "

The log streams.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLookupTables": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLookupTablesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLookupTablesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves metadata about lookup tables in your account. You can optionally filter the\n results by table name prefix. Results are sorted by table name in ascending order.

" + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLookupTablesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "max": 100 + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLookupTablesRequest": { + "type": "structure", + "members": { + "lookupTableNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#LookupTableName", + "traits": { + "smithy.api#documentation": "

A prefix to filter lookup tables by name. Only tables whose names start with this\n prefix are returned. If you don't specify a prefix, all tables in the account and Region are\n returned.

" + } + }, + "maxResults": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLookupTablesMaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of lookup tables to return in the response. The default value is 50\n and the maximum value is 100.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous\n call.)

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLookupTablesResponse": { + "type": "structure", + "members": { + "lookupTables": { + "target": "com.amazonaws.cloudwatchlogs#LookupTables", + "traits": { + "smithy.api#documentation": "

An array of structures, where each structure contains metadata about one lookup\n table.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use when requesting the next set of items.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeMetricFilters": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeMetricFiltersRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeMetricFiltersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the specified metric filters. You can list all of the metric filters or filter\n the results by log name, prefix, metric name, or metric namespace. The results are\n ASCII-sorted by filter name.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "metricFilters", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeMetricFiltersRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

" + } + }, + "filterNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "

The prefix to match. CloudWatch Logs uses the value that you set here only if you also\n include the logGroupName parameter in your request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous\n call.)

" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of items returned. If you don't specify a value, the default is up\n to 50 items.

" + } + }, + "metricName": { + "target": "com.amazonaws.cloudwatchlogs#MetricName", + "traits": { + "smithy.api#documentation": "

Filters results to include only those with the specified metric name. If you include\n this parameter in your request, you must also include the metricNamespace\n parameter.

" + } + }, + "metricNamespace": { + "target": "com.amazonaws.cloudwatchlogs#MetricNamespace", + "traits": { + "smithy.api#documentation": "

Filters results to include only those in the specified namespace. If you include this\n parameter in your request, you must also include the metricName\n parameter.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeMetricFiltersResponse": { + "type": "structure", + "members": { + "metricFilters": { + "target": "com.amazonaws.cloudwatchlogs#MetricFilters", + "traits": { + "smithy.api#documentation": "

The metric filters.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeQueries": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeQueriesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeQueriesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have\n been run recently in this account. You can request all queries or limit it to queries of a\n specific log group or queries with a certain status.

\n

This operation includes both interactive queries started directly by users and automated\n queries executed by scheduled query configurations. Scheduled query executions appear in the\n results alongside manually initiated queries, providing visibility into all query activity in\n your account.

" + } + }, + "com.amazonaws.cloudwatchlogs#DescribeQueriesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeQueriesRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

Limits the returned queries to only those for the specified log group.

" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#QueryStatus", + "traits": { + "smithy.api#documentation": "

Limits the returned queries to only those that have the specified status. Valid values are\n Cancelled, Complete, Failed, Running,\n and Scheduled.

" + } + }, + "maxResults": { + "target": "com.amazonaws.cloudwatchlogs#DescribeQueriesMaxResults", + "traits": { + "smithy.api#documentation": "

Limits the number of returned queries to the specified number.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, + "queryLanguage": { + "target": "com.amazonaws.cloudwatchlogs#QueryLanguage", + "traits": { + "smithy.api#documentation": "

Limits the returned queries to only the queries that use the specified query\n language.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeQueriesResponse": { + "type": "structure", + "members": { + "queries": { + "target": "com.amazonaws.cloudwatchlogs#QueryInfoList", + "traits": { + "smithy.api#documentation": "

The list of queries that match the request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitionsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

This operation returns a paginated list of your saved CloudWatch Logs Insights query\n definitions. You can retrieve query definitions from the current account or from a source\n account that is linked to the current account.

\n

You can use the queryDefinitionNamePrefix parameter to limit the results to\n only the query definitions that have names that start with a certain string.

" + } + }, + "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitionsRequest": { + "type": "structure", + "members": { + "queryLanguage": { + "target": "com.amazonaws.cloudwatchlogs#QueryLanguage", + "traits": { + "smithy.api#documentation": "

The query language used for this query. For more information about the query languages\n that CloudWatch Logs supports, see Supported query\n languages.

" + } + }, + "queryDefinitionNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionName", + "traits": { + "smithy.api#documentation": "

Use this parameter to filter your results to only the query definitions that have names\n that start with the prefix you specify.

" + } + }, + "maxResults": { + "target": "com.amazonaws.cloudwatchlogs#QueryListMaxResults", + "traits": { + "smithy.api#documentation": "

Limits the number of returned query definitions to the specified number.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitionsResponse": { + "type": "structure", + "members": { + "queryDefinitions": { + "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionList", + "traits": { + "smithy.api#documentation": "

The list of query definitions that match your request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeResourcePolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeResourcePoliciesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeResourcePoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the resource policies in this account.

" + } + }, + "com.amazonaws.cloudwatchlogs#DescribeResourcePoliciesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of resource policies to be displayed with one call of this\n API.

" + } + }, + "resourceArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the CloudWatch Logs resource for which to query the resource policy.

" + } + }, + "policyScope": { + "target": "com.amazonaws.cloudwatchlogs#PolicyScope", + "traits": { + "smithy.api#documentation": "

Specifies the scope of the resource policy. Valid values are ACCOUNT or\n RESOURCE. When not specified, defaults to ACCOUNT.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeResourcePoliciesResponse": { + "type": "structure", + "members": { + "resourcePolicies": { + "target": "com.amazonaws.cloudwatchlogs#ResourcePolicies", + "traits": { + "smithy.api#documentation": "

The resource policies that exist in this account.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFilters": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFiltersRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFiltersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the subscription filters for the specified log group. You can list all the\n subscription filters or filter the results by prefix. The results are ASCII-sorted by filter\n name.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "subscriptionFilters", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFiltersRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + }, + "filterNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "

The prefix to match. If you don't specify a value, no prefix filter is\n applied.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous\n call.)

" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of items returned. If you don't specify a value, the default is up\n to 50 items.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFiltersResponse": { + "type": "structure", + "members": { + "subscriptionFilters": { + "target": "com.amazonaws.cloudwatchlogs#SubscriptionFilters", + "traits": { + "smithy.api#documentation": "

The subscription filters.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#Destination": { + "type": "structure", + "members": { + "destinationName": { + "target": "com.amazonaws.cloudwatchlogs#DestinationName", + "traits": { + "smithy.api#documentation": "

The name of the destination.

" + } + }, + "targetArn": { + "target": "com.amazonaws.cloudwatchlogs#TargetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the physical target where the log events are\n delivered (for example, a Kinesis stream).

" + } + }, + "roleArn": { + "target": "com.amazonaws.cloudwatchlogs#RoleArn", + "traits": { + "smithy.api#documentation": "

A role for impersonation, used when delivering log events to the target.

" + } + }, + "accessPolicy": { + "target": "com.amazonaws.cloudwatchlogs#AccessPolicy", + "traits": { + "smithy.api#documentation": "

An IAM policy document that governs which Amazon Web Services accounts can create\n subscription filters against this destination.

" + } + }, + "arn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of this destination.

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

The creation time of the destination, expressed as the number of milliseconds after Jan\n 1, 1970 00:00:00 UTC.

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

Represents a cross-account destination that receives subscription log events.

" + } + }, + "com.amazonaws.cloudwatchlogs#DestinationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#DestinationConfiguration": { + "type": "structure", + "members": { + "s3Configuration": { + "target": "com.amazonaws.cloudwatchlogs#S3Configuration", + "traits": { + "smithy.api#documentation": "

Configuration for delivering query results to Amazon S3.

" + } + }, + "lookupTableConfiguration": { + "target": "com.amazonaws.cloudwatchlogs#LookupTableConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration for delivering query results to a lookup table. The query results\n automatically populate or refresh the specified lookup table on each scheduled\n execution.

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

Configuration for where to deliver scheduled query results. Specifies the destination type\n and associated settings for result delivery.

" + } + }, + "com.amazonaws.cloudwatchlogs#DestinationField": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cloudwatchlogs#DestinationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[^:*]*$" + } + }, + "com.amazonaws.cloudwatchlogs#Destinations": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#Destination" + } + }, + "com.amazonaws.cloudwatchlogs#DetectorKmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:kms:[-a-z0-9]*:[0-9]*:key/[-a-z0-9]*$" + } + }, + "com.amazonaws.cloudwatchlogs#DetectorName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#Dimensions": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#DimensionsKey" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#DimensionsValue" + } + }, + "com.amazonaws.cloudwatchlogs#DimensionsKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.cloudwatchlogs#DimensionsValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.cloudwatchlogs#DisassociateKmsKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DisassociateKmsKeyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates the specified KMS key from the specified log group or\n from all CloudWatch Logs Insights query results in the account.

\n

When you use DisassociateKmsKey, you specify either the\n logGroupName parameter or the resourceIdentifier parameter. You\n can't specify both of those parameters in the same operation.

\n
    \n
  • \n

    Specify the logGroupName parameter to stop using the KMS key to encrypt future log events ingested and stored in the log group.\n Instead, they will be encrypted with the default CloudWatch Logs method. The log events\n that were ingested while the key was associated with the log group are still encrypted\n with that key. Therefore, CloudWatch Logs will need permissions for the key whenever\n that data is accessed.

    \n
    • \n
  • \n

    Specify the resourceIdentifier parameter with the\n query-result resource to stop using the KMS key to\n encrypt the results of all future StartQuery\n operations in the account. They will instead be encrypted with the default CloudWatch Logs method. The results from queries that ran while the key was associated with\n the account are still encrypted with that key. Therefore, CloudWatch Logs will need\n permissions for the key whenever that data is accessed.

    \n
    • \n
\n

It can take up to 5 minutes for this operation to take effect.

" + } + }, + "com.amazonaws.cloudwatchlogs#DisassociateKmsKeyRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

\n

In your DisassociateKmsKey operation, you must specify either the\n resourceIdentifier parameter or the logGroup parameter, but you\n can't specify both.

" + } + }, + "resourceIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#ResourceIdentifier", + "traits": { + "smithy.api#documentation": "

Specifies the target for this operation. You must specify one of the following:

\n
    \n
  • \n

    Specify the ARN of a log group to stop having CloudWatch Logs use the KMS key to encrypt log events that are ingested and stored by that log\n group. After you run this operation, CloudWatch Logs encrypts ingested log events with\n the default CloudWatch Logs method. The log group ARN must be in the following format.\n Replace REGION and ACCOUNT_ID with your Region\n and account ID.

    \n

    \n arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME\n \n

    \n
    • \n
  • \n

    Specify the following ARN to stop using this key to encrypt the results of future\n StartQuery\n operations in this account. Replace REGION and\n ACCOUNT_ID with your Region and account ID.

    \n

    \n arn:aws:logs:REGION:ACCOUNT_ID:query-result:*\n

    \n
    • \n
\n

In your DisssociateKmsKey operation, you must specify either the\n resourceIdentifier parameter or the logGroup parameter, but you\n can't specify both.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DisassociateSourceFromS3TableIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DisassociateSourceFromS3TableIntegrationRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DisassociateSourceFromS3TableIntegrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InternalServerException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates a data source from an S3 Table Integration, removing query access and\n deleting all associated data from the integration.

" + } + }, + "com.amazonaws.cloudwatchlogs#DisassociateSourceFromS3TableIntegrationRequest": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.cloudwatchlogs#S3TableIntegrationSourceIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the association to remove between the data source and S3 Table\n Integration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DisassociateSourceFromS3TableIntegrationResponse": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.cloudwatchlogs#S3TableIntegrationSourceIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the association that was removed.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#Distribution": { + "type": "enum", + "members": { + "Random": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Random" + } + }, + "ByLogStream": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ByLogStream" + } + } + }, + "traits": { + "smithy.api#documentation": "

The method used to distribute log data to the destination, which can be either random\n or grouped by log stream.

" + } + }, + "com.amazonaws.cloudwatchlogs#DynamicTokenPosition": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.cloudwatchlogs#EmitSystemFields": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#SystemField" + } + }, + "com.amazonaws.cloudwatchlogs#EncryptionKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#EndTimeOffset": { + "type": "long" + }, + "com.amazonaws.cloudwatchlogs#Entity": { + "type": "structure", + "members": { + "keyAttributes": { + "target": "com.amazonaws.cloudwatchlogs#EntityKeyAttributes", + "traits": { + "smithy.api#documentation": "

The attributes of the entity which identify the specific entity, as a list of key-value\n pairs. Entities with the same keyAttributes are considered to be the same\n entity.

\n

There are five allowed attributes (key names): Type,\n ResourceType, Identifier\n Name, and Environment.

\n

For details about how to use the key attributes, see How to add\n related information to telemetry in the CloudWatch User\n Guide.

" + } + }, + "attributes": { + "target": "com.amazonaws.cloudwatchlogs#EntityAttributes", + "traits": { + "smithy.api#documentation": "

Additional attributes of the entity that are not used to specify the identity of the\n entity. A list of key-value pairs.

\n

For details about how to use the attributes, see How to add\n related information to telemetry in the CloudWatch User\n Guide.

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

The entity associated with the log events in a PutLogEvents call.

" + } + }, + "com.amazonaws.cloudwatchlogs#EntityAttributes": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#EntityAttributesKey" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#EntityAttributesValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityAttributesKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityAttributesValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityKeyAttributes": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#EntityKeyAttributesKey" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#EntityKeyAttributesValue" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 4 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityKeyAttributesKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityKeyAttributesValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityRejectionErrorType": { + "type": "enum", + "members": { + "INVALID_ENTITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidEntity" + } + }, + "INVALID_TYPE_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidTypeValue" + } + }, + "INVALID_KEY_ATTRIBUTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidKeyAttributes" + } + }, + "INVALID_ATTRIBUTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidAttributes" + } + }, + "ENTITY_SIZE_TOO_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EntitySizeTooLarge" + } + }, + "UNSUPPORTED_LOG_GROUP_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnsupportedLogGroupType" + } + }, + "MISSING_REQUIRED_FIELDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MissingRequiredFields" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#Enumerations": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#TokenString" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#TokenValue" + } + }, + "com.amazonaws.cloudwatchlogs#EpochMillis": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.cloudwatchlogs#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#EvaluationFrequency": { + "type": "enum", + "members": { + "ONE_MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONE_MIN" + } + }, + "FIVE_MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIVE_MIN" + } + }, + "TEN_MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEN_MIN" + } + }, + "FIFTEEN_MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIFTEEN_MIN" + } + }, + "THIRTY_MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THIRTY_MIN" + } + }, + "ONE_HOUR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONE_HOUR" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#EventId": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#EventMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#EventNumber": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.cloudwatchlogs#EventSource": { + "type": "enum", + "members": { + "CLOUD_TRAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudTrail" + } + }, + "ROUTE53_RESOLVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Route53Resolver" + } + }, + "VPC_FLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPCFlow" + } + }, + "EKS_AUDIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKSAudit" + } + }, + "AWSWAF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWSWAF" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#EventsLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.cloudwatchlogs#EventsLimitStartQuery": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100000 + } + } + }, + "com.amazonaws.cloudwatchlogs#ExecutionStatus": { + "type": "enum", + "members": { + "Running": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Running" + } + }, + "InvalidQuery": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidQuery" + } + }, + "Complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Complete" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "Timeout": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Timeout" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#ExecutionStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#ExecutionStatus" + } + }, + "com.amazonaws.cloudwatchlogs#ExpectedRevisionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#ExportDestinationBucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.cloudwatchlogs#ExportDestinationPrefix": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#ExportTask": { + "type": "structure", + "members": { + "taskId": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskId", + "traits": { + "smithy.api#documentation": "

The ID of the export task.

" + } + }, + "taskName": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskName", + "traits": { + "smithy.api#documentation": "

The name of the export task.

" + } + }, + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group from which logs data was exported.

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

The start time, expressed as the number of milliseconds after Jan 1, 1970\n 00:00:00 UTC. Events with a timestamp before this time are not exported.

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

The end time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00\n UTC. Events with a timestamp later than this time are not exported.

" + } + }, + "destination": { + "target": "com.amazonaws.cloudwatchlogs#ExportDestinationBucket", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket to which the log data was exported.

" + } + }, + "destinationPrefix": { + "target": "com.amazonaws.cloudwatchlogs#ExportDestinationPrefix", + "traits": { + "smithy.api#documentation": "

The prefix that was used as the start of Amazon S3 key for every object\n exported.

" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskStatus", + "traits": { + "smithy.api#documentation": "

The status of the export task.

" + } + }, + "executionInfo": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskExecutionInfo", + "traits": { + "smithy.api#documentation": "

Execution information about the export task.

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

Represents an export task.

" + } + }, + "com.amazonaws.cloudwatchlogs#ExportTaskExecutionInfo": { + "type": "structure", + "members": { + "creationTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of the export task, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC.

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

The completion time of the export task, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC.

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

Represents the status of an export task.

" + } + }, + "com.amazonaws.cloudwatchlogs#ExportTaskId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.cloudwatchlogs#ExportTaskName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.cloudwatchlogs#ExportTaskStatus": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskStatusCode", + "traits": { + "smithy.api#documentation": "

The status code of the export task.

" + } + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskStatusMessage", + "traits": { + "smithy.api#documentation": "

The status message related to the status code.

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

Represents the status of an export task.

" + } + }, + "com.amazonaws.cloudwatchlogs#ExportTaskStatusCode": { + "type": "enum", + "members": { + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "PENDING_CANCEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_CANCEL" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#ExportTaskStatusMessage": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#ExportTasks": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#ExportTask" + } + }, + "com.amazonaws.cloudwatchlogs#ExtractedValues": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#Token" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#Value" + } + }, + "com.amazonaws.cloudwatchlogs#Field": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#FieldDelimiter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.cloudwatchlogs#FieldHeader": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.cloudwatchlogs#FieldIndex": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

If this field index appears in an index policy that applies only to a single log group,\n the ARN of that log group is displayed here.

" + } + }, + "fieldIndexName": { + "target": "com.amazonaws.cloudwatchlogs#FieldIndexName", + "traits": { + "smithy.api#documentation": "

The string that this field index matches.

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

The most recent time that CloudWatch Logs scanned ingested log events to search for\n this field index to improve the speed of future CloudWatch Logs Insights queries that\n search for this field index.

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

The time and date of the earliest log event that matches this field index, after the index\n policy that contains it was created.

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

The time and date of the most recent log event that matches this field index.

" + } + }, + "type": { + "target": "com.amazonaws.cloudwatchlogs#IndexType", + "traits": { + "smithy.api#documentation": "

The type of index. Specify FACET for facet-based indexing or\n FIELD_INDEX for field-based indexing. This determines how the field is indexed\n and can be queried.

" + } + }, + "indexCategory": { + "target": "com.amazonaws.cloudwatchlogs#IndexCategory", + "traits": { + "smithy.api#documentation": "

The category of the field index:

\n
    \n
  • \n

    \n DEFAULT: Fields that CloudWatch Logs indexes by default. Examples\n include @logStream and @data_format.

    \n
    • \n
  • \n

    \n CUSTOM: Fields that you added manually to the field index policy.\n CloudWatch Logs always indexes these fields. These fields count toward the quota of\n 20 fields for each log group.

    \n
    • \n
  • \n

    \n AUTO: Fields that CloudWatch Logs indexes automatically based on your\n query patterns and usage. These fields do not count toward the field index quota.\n CloudWatch Logs might update these fields based on changes in your query patterns. To\n keep a field indexed permanently, add it to an account-level or log-group level field\n index policy.

    \n
    • \n
  • \n

    \n INACTIVE: Fields that CloudWatch Logs indexed before but does not\n index now. This happens if you remove a field from the field index policy or if\n CloudWatch Logs automatically selects a different field based on your queries.

    \n
    • \n
\n

For more information about automatically indexed fields, see Automatically indexed fields.

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

This structure describes one log event field that is used as an index in at least one\n index policy in this account.

" + } + }, + "com.amazonaws.cloudwatchlogs#FieldIndexName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" + } + }, + "com.amazonaws.cloudwatchlogs#FieldIndexNames": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#FieldIndexName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.cloudwatchlogs#FieldIndexes": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#FieldIndex" + } + }, + "com.amazonaws.cloudwatchlogs#FieldSelectionCriteria": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.cloudwatchlogs#FieldsData": { + "type": "structure", + "members": { + "data": { + "target": "com.amazonaws.cloudwatchlogs#Data", + "traits": { + "smithy.api#documentation": "

The actual log data content returned in the streaming response. This contains the fields\n and values of the log event in a structured format that can be parsed and processed by the\n client.

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

A structure containing the extracted fields from a log event. These fields are extracted\n based on the log format and can be used for structured querying and analysis.

" + } + }, + "com.amazonaws.cloudwatchlogs#FilterCount": { + "type": "integer" + }, + "com.amazonaws.cloudwatchlogs#FilterLogEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#FilterLogEventsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#FilterLogEventsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists log events from the specified log group. You can list all the log events or\n filter the results using one or more of the following:

\n
    \n
  • \n

    A filter pattern

    \n
    • \n
  • \n

    A time range

    \n
    • \n
  • \n

    The log stream name, or a log stream name prefix that matches multiple log\n streams

    \n
    • \n
\n

You must have the logs:FilterLogEvents permission to perform this\n operation.

\n

You can specify the log group to search by using either logGroupIdentifier or\n logGroupName. You must include one of these two parameters, but you can't\n include both.

\n

\n FilterLogEvents is a paginated operation. Each page returned can contain up\n to 1 MB of log events or up to 10,000 log events. A returned page might only be partially\n full, or even empty. For example, if the result of a query would return 15,000 log events, the\n first page isn't guaranteed to have 10,000 log events even if they all fit into 1 MB.

\n

Partially full or empty pages don't necessarily mean that pagination is finished. If the\n results include a nextToken, there might be more log events available. You can\n return these additional log events by providing the nextToken in a subsequent\n FilterLogEvents operation. If the results don't include a\n nextToken, then pagination is finished.

\n

Specifying the limit parameter only guarantees that a single page doesn't\n return more log events than the specified limit, but it might return fewer events than the\n limit. This is the expected API behavior.

\n

The returned log events are sorted by event timestamp, the timestamp when the event was\n ingested by CloudWatch Logs, and the ID of the PutLogEvents request. By default,\n the events are returned in ascending timestamp order (oldest first). To return events in\n descending timestamp order (newest first), set the startFromHead parameter to\n false.

\n

If you are using CloudWatch cross-account observability, you can use this operation\n in a monitoring account and view data from the linked source accounts. For more information,\n see CloudWatch cross-account observability.

\n \n

If you are using log\n transformation, the FilterLogEvents operation returns only the\n original versions of log events, before they were transformed. To view the transformed\n versions, you must use a CloudWatch Logs\n query.\n

\n ", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#FilterLogEventsRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group to search.

\n \n

You must include either logGroupIdentifier or logGroupName,\n but not both.

\n " + } + }, + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

Specify either the name or ARN of the log group to view log events from. If the log group\n is in a source account and you are using a monitoring account, you must use the log group\n ARN.

\n \n

You must include either logGroupIdentifier or logGroupName,\n but not both.

\n " + } + }, + "logStreamNames": { + "target": "com.amazonaws.cloudwatchlogs#InputLogStreamNames", + "traits": { + "smithy.api#documentation": "

Filters the results to only logs from the log streams in this list.

\n

If you specify a value for both logStreamNames and\n logStreamNamePrefix, the action returns an\n InvalidParameterException error.

" + } + }, + "logStreamNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "

Filters the results to include only events from log streams that have names starting with\n this prefix.

\n

If you specify a value for both logStreamNamePrefix and\n logStreamNames, the action returns an InvalidParameterException\n error.

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

The start of the time range, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC. Events with a timestamp before this time are not\n returned.

\n \n

Set startTime explicitly to reduce the chances of empty pages in the\n response.

\n " + } + }, + "endTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The end of the time range, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC. Events with a timestamp later than this time are not\n returned.

" + } + }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern", + "traits": { + "smithy.api#documentation": "

The filter pattern to use. For more information, see Filter and Pattern\n Syntax.

\n

If not provided, all the events are matched.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of events to return. (You received this token from a\n previous call.)

" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#EventsLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of events to return. The default is 10,000 events.

" + } + }, + "startFromHead": { + "target": "com.amazonaws.cloudwatchlogs#StartFromHead", + "traits": { + "smithy.api#documentation": "

If the value is true, the earliest log events are returned first. If the value is\n false, the latest log events are returned first. The default value is true.

\n

The startFromHead parameter sets the sort direction on the first request.\n On subsequent requests, the nextToken determines the sort direction. To continue\n paginating in the same direction, provide the returned nextToken. If you provide\n both nextToken and startFromHead, the direction of the\n nextToken is used.

\n \n

Setting startFromHead to false is supported only when\n startTime is on or after Jan 1, 2024 00:00:00 UTC. A request with\n startFromHead set to false and a startTime before\n this date returns an InvalidParameterException.

\n " + } + }, + "interleaved": { + "target": "com.amazonaws.cloudwatchlogs#Interleaved", + "traits": { + "smithy.api#deprecated": { + "message": "Starting on June 17, 2019, this parameter will be ignored and the value will be assumed to be true. The response from this operation will always interleave events from multiple log streams within a log group." + }, + "smithy.api#documentation": "

If the value is true, the operation attempts to provide responses that contain events\n from multiple log streams within the log group, interleaved in a single response. If the value\n is false, all the matched log events in the first log stream are searched first, then those in\n the next log stream, and so on.

\n

\n Important As of June 17, 2019, this parameter is\n ignored and the value is assumed to be true. The response from this operation always\n interleaves events from multiple log streams within a log group.

" + } + }, + "unmask": { + "target": "com.amazonaws.cloudwatchlogs#Unmask", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specify true to display the log event fields with all sensitive data unmasked\n and visible. The default is false.

\n

To use this operation with this parameter, you must be signed into an account with the\n logs:Unmask permission.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#FilterLogEventsResponse": { + "type": "structure", + "members": { + "events": { + "target": "com.amazonaws.cloudwatchlogs#FilteredLogEvents", + "traits": { + "smithy.api#documentation": "

The matched events.

" + } + }, + "searchedLogStreams": { + "target": "com.amazonaws.cloudwatchlogs#SearchedLogStreams", + "traits": { + "smithy.api#documentation": "

\n Important As of May 15, 2020, this parameter is no longer\n supported. This parameter returns an empty list.

\n

Indicates which log streams have been searched and whether each has been searched\n completely.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items in the sorting direction specified by the\n startFromHead parameter in the first request. The token expires after 24\n hours.

\n

If the results don't include a nextToken, then pagination is finished.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#FilterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[^:*]*$" + } + }, + "com.amazonaws.cloudwatchlogs#FilterPattern": { + "type": "string", + "traits": { + "smithy.api#documentation": "

A symbolic description of how CloudWatch Logs should interpret the data in each log\n event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You\n use the filter pattern to specify what to look for in the log event message.

", + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.cloudwatchlogs#FilteredLogEvent": { + "type": "structure", + "members": { + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "

The name of the log stream to which this event belongs.

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

The time the event occurred, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC.

" + } + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#EventMessage", + "traits": { + "smithy.api#documentation": "

The data contained in the log event.

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

The time the event was ingested, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC.

" + } + }, + "eventId": { + "target": "com.amazonaws.cloudwatchlogs#EventId", + "traits": { + "smithy.api#documentation": "

The ID of the event.

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

Represents a matched event.

" + } + }, + "com.amazonaws.cloudwatchlogs#FilteredLogEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#FilteredLogEvent" + } + }, + "com.amazonaws.cloudwatchlogs#Flatten": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.cloudwatchlogs#FlattenedElement": { + "type": "enum", + "members": { + "FIRST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "first" + } + }, + "LAST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "last" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#Force": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.cloudwatchlogs#ForceUpdate": { + "type": "boolean" + }, + "com.amazonaws.cloudwatchlogs#FromKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a log group data protection policy.

" + } + }, + "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicyRequest": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

The name or ARN of the log group that contains the data protection policy that you want to\n see.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicyResponse": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

The log group name or ARN that you specified in your request.

" + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#DataProtectionPolicyDocument", + "traits": { + "smithy.api#documentation": "

The data protection policy document for this log group.

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

The date and time that this policy was most recently updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDelivery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetDeliveryRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetDeliveryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns complete information about one logical delivery. A delivery\n is a connection between a \n delivery\n source\n and a \n delivery destination\n .

\n

A delivery source represents an Amazon Web Services resource that sends logs to an logs\n delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web Services services support being configured as a delivery\n source. These services are listed in Enable logging from\n Amazon Web Services services.\n

\n

You need to specify the delivery id in this operation. You can find the IDs\n of the deliveries in your account with the DescribeDeliveries operation.

" + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliveryDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves complete information about one delivery destination.

" + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the delivery destination policy assigned to the delivery destination that you\n specify. For more information about delivery destinations and their policies, see PutDeliveryDestinationPolicy.

" + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicyRequest": { + "type": "structure", + "members": { + "deliveryDestinationName": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", + "traits": { + "smithy.api#documentation": "

The name of the delivery destination that you want to retrieve the policy of.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicyResponse": { + "type": "structure", + "members": { + "policy": { + "target": "com.amazonaws.cloudwatchlogs#Policy", + "traits": { + "smithy.api#documentation": "

The IAM policy for this delivery destination.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", + "traits": { + "smithy.api#documentation": "

The name of the delivery destination that you want to retrieve.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationResponse": { + "type": "structure", + "members": { + "deliveryDestination": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestination", + "traits": { + "smithy.api#documentation": "

A structure containing information about the delivery destination.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliveryRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryId", + "traits": { + "smithy.api#documentation": "

The ID of the delivery that you want to retrieve.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliveryResponse": { + "type": "structure", + "members": { + "delivery": { + "target": "com.amazonaws.cloudwatchlogs#Delivery", + "traits": { + "smithy.api#documentation": "

A structure that contains information about the delivery.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliverySource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetDeliverySourceRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetDeliverySourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves complete information about one delivery source.

" + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliverySourceRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", + "traits": { + "smithy.api#documentation": "

The name of the delivery source that you want to retrieve.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliverySourceResponse": { + "type": "structure", + "members": { + "deliverySource": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySource", + "traits": { + "smithy.api#documentation": "

A structure containing information about the delivery source.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetIntegrationRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetIntegrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about one integration between CloudWatch Logs and OpenSearch Service.

" + } + }, + "com.amazonaws.cloudwatchlogs#GetIntegrationRequest": { + "type": "structure", + "members": { + "integrationName": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationName", + "traits": { + "smithy.api#documentation": "

The name of the integration that you want to find information about. To find the name of\n your integration, use ListIntegrations\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetIntegrationResponse": { + "type": "structure", + "members": { + "integrationName": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationName", + "traits": { + "smithy.api#documentation": "

The name of the integration.

" + } + }, + "integrationType": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationType", + "traits": { + "smithy.api#documentation": "

The type of integration. Integrations with OpenSearch Service have the type\n OPENSEARCH.

" + } + }, + "integrationStatus": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationStatus", + "traits": { + "smithy.api#documentation": "

The current status of this integration.

" + } + }, + "integrationDetails": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationDetails", + "traits": { + "smithy.api#documentation": "

A structure that contains information about the integration configuration. For an\n integration with OpenSearch Service, this includes information about OpenSearch Service\n resources such as the collection, the workspace, and policies.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetector": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetectorRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about the log anomaly detector that you specify. The KMS key ARN detected is valid.

" + } + }, + "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetectorRequest": { + "type": "structure", + "members": { + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "

The ARN of the anomaly detector to retrieve information about. You can find the ARNs of\n log anomaly detectors in your account by using the ListLogAnomalyDetectors operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetectorResponse": { + "type": "structure", + "members": { + "detectorName": { + "target": "com.amazonaws.cloudwatchlogs#DetectorName", + "traits": { + "smithy.api#documentation": "

The name of the log anomaly detector

" + } + }, + "logGroupArnList": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupArnList", + "traits": { + "smithy.api#documentation": "

An array of structures, where each structure contains the ARN of a log group associated\n with this anomaly detector.

" + } + }, + "evaluationFrequency": { + "target": "com.amazonaws.cloudwatchlogs#EvaluationFrequency", + "traits": { + "smithy.api#documentation": "

Specifies how often the anomaly detector runs and look for anomalies. Set this value\n according to the frequency that the log group receives new logs. For example, if the log group\n receives new log events every 10 minutes, then setting evaluationFrequency to\n FIFTEEN_MIN might be appropriate.

" + } + }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern" + }, + "anomalyDetectorStatus": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether the anomaly detector is currently active. To change its status, use the\n enabled parameter in the UpdateLogAnomalyDetector operation.

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

The ARN of the KMS key assigned to this anomaly detector, if any.

" + } + }, + "creationTimeStamp": { + "target": "com.amazonaws.cloudwatchlogs#EpochMillis", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The date and time when this anomaly detector was created.

" + } + }, + "lastModifiedTimeStamp": { + "target": "com.amazonaws.cloudwatchlogs#EpochMillis", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The date and time when this anomaly detector was most recently modified.

" + } + }, + "anomalyVisibilityTime": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime", + "traits": { + "smithy.api#documentation": "

The number of days used as the life cycle of anomalies. After this time, anomalies are\n automatically baselined and the anomaly detector model will treat new occurrences of similar\n event as normal.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetLogEventsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetLogEventsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists log events from the specified log stream. You can list all of the log events or\n filter using a time range.

\n

\n GetLogEvents is a paginated operation. Each page returned can contain up to 1\n MB of log events or up to 10,000 log events. A returned page might only be partially full, or\n even empty. For example, if the result of a query would return 15,000 log events, the first\n page isn't guaranteed to have 10,000 log events even if they all fit into 1 MB.

\n

Partially full or empty pages don't necessarily mean that pagination is finished. As long\n as the nextBackwardToken or nextForwardToken returned is NOT equal\n to the nextToken that you passed into the API call, there might be more log\n events available. The token that you use depends on the direction you want to move in along\n the log stream. The returned tokens are never null.

\n \n

If you set startFromHead to true and you don’t include\n endTime in your request, you can end up in a situation where the pagination\n doesn't terminate. This can happen when the new log events are being added to the target log\n streams faster than they are being read. This situation is a good use case for the CloudWatch Logs\n Live Tail feature.

\n \n

If you are using CloudWatch cross-account observability, you can use this operation\n in a monitoring account and view data from the linked source accounts. For more information,\n see CloudWatch cross-account observability.

\n

You can specify the log group to search by using either logGroupIdentifier or\n logGroupName. You must include one of these two parameters, but you can't\n include both.

\n \n

If you are using log\n transformation, the GetLogEvents operation returns only the original\n versions of log events, before they were transformed. To view the transformed versions, you\n must use a CloudWatch Logs\n query.\n

\n ", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextForwardToken", + "items": "events", + "pageSize": "limit" + }, + "smithy.test#smokeTests": [ + { + "id": "GetLogEventsFailure", + "params": { + "logGroupName": "fakegroup", + "logStreamName": "fakestream" + }, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "failure": {} + } + } + ] + } + }, + "com.amazonaws.cloudwatchlogs#GetLogEventsRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

\n \n

You must include either logGroupIdentifier or logGroupName,\n but not both.

\n " + } + }, + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

Specify either the name or ARN of the log group to view events from. If the log group is\n in a source account and you are using a monitoring account, you must use the log group\n ARN.

\n \n

You must include either logGroupIdentifier or logGroupName,\n but not both.

\n " + } + }, + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "

The name of the log stream.

", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The start of the time range, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC. Events with a timestamp equal to this time or later than this time\n are included. Events with a timestamp earlier than this time are not included.

\n \n

Set startTime explicitly to reduce the chances of empty pages in the\n response.

\n " + } + }, + "endTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The end of the time range, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC. Events with a timestamp equal to or later than this time are not\n included.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous\n call.)

" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#EventsLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of log events returned. If you don't specify a limit, the default is\n as many log events as can fit in a response size of 1 MB (up to 10,000 log events).

" + } + }, + "startFromHead": { + "target": "com.amazonaws.cloudwatchlogs#StartFromHead", + "traits": { + "smithy.api#documentation": "

If the value is true, the earliest log events are returned first. If the value is\n false, the latest log events are returned first. The default value is false.

\n

If you are using a previous nextForwardToken value as the\n nextToken in this operation, you must specify true for\n startFromHead.

" + } + }, + "unmask": { + "target": "com.amazonaws.cloudwatchlogs#Unmask", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specify true to display the log event fields with all sensitive data unmasked\n and visible. The default is false.

\n

To use this operation with this parameter, you must be signed into an account with the\n logs:Unmask permission.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogEventsResponse": { + "type": "structure", + "members": { + "events": { + "target": "com.amazonaws.cloudwatchlogs#OutputLogEvents", + "traits": { + "smithy.api#documentation": "

The events.

" + } + }, + "nextForwardToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items in the forward direction. The token expires after\n 24 hours. If you have reached the end of the stream, it returns the same token you passed\n in.

" + } + }, + "nextBackwardToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items in the backward direction. The token expires after\n 24 hours. This token is not null. If you have reached the end of the stream, it returns the\n same token you passed in.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogFields": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetLogFieldsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetLogFieldsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Discovers available fields for a specific data source and type. The response includes any\n field modifications introduced through pipelines, such as new fields or changed field types.\n

" + } + }, + "com.amazonaws.cloudwatchlogs#GetLogFieldsRequest": { + "type": "structure", + "members": { + "dataSourceName": { + "target": "com.amazonaws.cloudwatchlogs#DataSourceName", + "traits": { + "smithy.api#documentation": "

The name of the data source to retrieve log fields for.

", + "smithy.api#required": {} + } + }, + "dataSourceType": { + "target": "com.amazonaws.cloudwatchlogs#DataSourceType", + "traits": { + "smithy.api#documentation": "

The type of the data source to retrieve log fields for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogFieldsResponse": { + "type": "structure", + "members": { + "logFields": { + "target": "com.amazonaws.cloudwatchlogs#LogFieldsList", + "traits": { + "smithy.api#documentation": "

The list of log fields for the specified data source, including field names and their data\n types.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogGroupFields": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetLogGroupFieldsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetLogGroupFieldsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the fields that are included in log events in the specified log group.\n Includes the percentage of log events that contain each field. The search is limited to a time\n period that you specify.

\n

This operation is used for discovering fields within log group events. For discovering\n fields across data sources, use the GetLogFields operation.

\n

You can specify the log group to search by using either logGroupIdentifier or\n logGroupName. You must specify one of these parameters, but you can't specify\n both.

\n

In the results, fields that start with @ are fields generated by CloudWatch\n Logs. For example, @timestamp is the timestamp of each log event. For more\n information about the fields that are generated by CloudWatch logs, see Supported\n Logs and Discovered Fields.

\n

The response results are sorted by the frequency percentage, starting with the highest\n percentage.

\n

If you are using CloudWatch cross-account observability, you can use this operation\n in a monitoring account and view data from the linked source accounts. For more information,\n see CloudWatch cross-account observability.

" + } + }, + "com.amazonaws.cloudwatchlogs#GetLogGroupFieldsRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group to search.

\n \n

You must include either logGroupIdentifier or logGroupName,\n but not both.

\n " + } + }, + "time": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The time to set as the center of the query. If you specify time, the 8\n minutes before and 8 minutes after this time are searched. If you omit time, the\n most recent 15 minutes up to the current time are searched.

\n

The time value is specified as epoch time, which is the number of seconds\n since January 1, 1970, 00:00:00 UTC.

" + } + }, + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

Specify either the name or ARN of the log group to view. If the log group is in a source\n account and you are using a monitoring account, you must specify the ARN.

\n \n

You must include either logGroupIdentifier or logGroupName,\n but not both.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogGroupFieldsResponse": { + "type": "structure", + "members": { + "logGroupFields": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupFieldList", + "traits": { + "smithy.api#documentation": "

The array of fields found in the query. Each object in the array contains the name of the\n field, along with the percentage of time it appeared in the log events that were\n queried.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogObject": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetLogObjectRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetLogObjectResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a large logging object (LLO) and streams it back. This API is used to fetch the\n content of large portions of log events that have been ingested through the\n PutOpenTelemetryLogs API. When log events contain fields that would cause the total event size\n to exceed 1MB, CloudWatch Logs automatically processes up to 10 fields, starting with the\n largest fields. Each field is truncated as needed to keep the total event size as close to 1MB\n as possible. The excess portions are stored as Large Log Objects (LLOs) and these fields are\n processed separately and LLO reference system fields (in the format\n @ptr.$[path.to.field]) are added. The path in the reference field reflects the\n original JSON structure where the large field was located. For example, this could be\n @ptr.$['input']['message'], @ptr.$['AAA']['BBB']['CCC']['DDD'],\n @ptr.$['AAA'], or any other path matching your log structure.

\n \n

The GetLogObject API routes requests using SDK host prefix injection. SDK versions released before April 1, 2026 route to\n streaming-logs.Region.amazonaws.com, which does not support VPC endpoints. SDK versions released on or after April 1, 2026 route to\n stream-logs.Region.amazonaws.com, which supports VPC endpoints. To set up a VPC endpoint for this API, see Creating a VPC endpoint for CloudWatch Logs\n .

\n ", + "smithy.api#endpoint": { + "hostPrefix": "stream-" + } + } + }, + "com.amazonaws.cloudwatchlogs#GetLogObjectRequest": { + "type": "structure", + "members": { + "unmask": { + "target": "com.amazonaws.cloudwatchlogs#Unmask", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A boolean flag that indicates whether to unmask sensitive log data. When set to true, any\n masked or redacted data in the log object will be displayed in its original form. Default is\n false.

" + } + }, + "logObjectPointer": { + "target": "com.amazonaws.cloudwatchlogs#LogObjectPointer", + "traits": { + "smithy.api#documentation": "

A pointer to the specific log object to retrieve. This is a required parameter that\n uniquely identifies the log object within CloudWatch Logs. The pointer is typically obtained\n from a previous query or filter operation.

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

The parameters for the GetLogObject operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogObjectResponse": { + "type": "structure", + "members": { + "fieldStream": { + "target": "com.amazonaws.cloudwatchlogs#GetLogObjectResponseStream", + "traits": { + "smithy.api#documentation": "

A stream of structured log data returned by the GetLogObject operation. This stream\n contains log events with their associated metadata and extracted fields.

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

The response from the GetLogObject operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogObjectResponseStream": { + "type": "union", + "members": { + "fields": { + "target": "com.amazonaws.cloudwatchlogs#FieldsData" + }, + "InternalStreamingException": { + "target": "com.amazonaws.cloudwatchlogs#InternalStreamingException", + "traits": { + "smithy.api#documentation": "

An internal error occurred during the streaming of log data. This exception is thrown when\n there's an issue with the internal streaming mechanism used by the GetLogObject\n operation.

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

A stream of structured log data returned by the GetLogObject operation. This stream\n contains log events with their associated metadata and extracted fields.

", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogRecord": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetLogRecordRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetLogRecordResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves all of the fields and values of a single log event. All fields are retrieved,\n even if the original query that produced the logRecordPointer retrieved only a\n subset of fields. Fields are returned as field name/field value pairs.

\n

The full unparsed log event is returned within @message.

" + } + }, + "com.amazonaws.cloudwatchlogs#GetLogRecordRequest": { + "type": "structure", + "members": { + "logRecordPointer": { + "target": "com.amazonaws.cloudwatchlogs#LogRecordPointer", + "traits": { + "smithy.api#documentation": "

The pointer corresponding to the log event record you want to retrieve. You get this from\n the response of a GetQueryResults operation. In that response, the value of the\n @ptr field for a log event is the value to use as logRecordPointer\n to retrieve that complete log event record.

", + "smithy.api#required": {} + } + }, + "unmask": { + "target": "com.amazonaws.cloudwatchlogs#Unmask", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specify true to display the log event fields with all sensitive data unmasked\n and visible. The default is false.

\n

To use this operation with this parameter, you must be signed into an account with the\n logs:Unmask permission.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogRecordResponse": { + "type": "structure", + "members": { + "logRecord": { + "target": "com.amazonaws.cloudwatchlogs#LogRecord", + "traits": { + "smithy.api#documentation": "

The requested log event, as a JSON string.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLookupTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetLookupTableRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetLookupTableResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the full content of a lookup table, including the CSV data.

" + } + }, + "com.amazonaws.cloudwatchlogs#GetLookupTableRequest": { + "type": "structure", + "members": { + "lookupTableArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the lookup table to retrieve.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLookupTableResponse": { + "type": "structure", + "members": { + "lookupTableArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the lookup table.

" + } + }, + "lookupTableName": { + "target": "com.amazonaws.cloudwatchlogs#LookupTableName", + "traits": { + "smithy.api#documentation": "

The name of the lookup table.

" + } + }, + "description": { + "target": "com.amazonaws.cloudwatchlogs#LookupTableDescription", + "traits": { + "smithy.api#documentation": "

The description of the lookup table.

" + } + }, + "tableBody": { + "target": "com.amazonaws.cloudwatchlogs#TableBody", + "traits": { + "smithy.api#documentation": "

The full CSV content of the lookup table.

" + } + }, + "sizeBytes": { + "target": "com.amazonaws.cloudwatchlogs#StoredBytes", + "traits": { + "smithy.api#documentation": "

The size of the lookup table in bytes.

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

The time when the lookup table was last updated, expressed as the number of\n milliseconds after Jan 1, 1970 00:00:00 UTC.

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

The ARN of the KMS key used to encrypt the lookup table data, if\n applicable.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetQueryResults": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetQueryResultsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetQueryResultsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the results from the specified query.

\n

Only the fields requested in the query are returned, along with a @ptr field,\n which is the identifier for the log record. You can use the value of @ptr in a\n GetLogRecord\n operation to get the full log record.

\n

\n GetQueryResults does not start running a query. To run a query, use StartQuery. For more information about how long results of previous queries are\n available, see CloudWatch Logs\n quotas.

\n

If the value of the Status field in the output is Running, this\n operation returns only partial results. If you see a value of Scheduled or\n Running for the status, you can retry the operation later to see the final\n results.

\n

This operation is used both for retrieving results from interactive queries and from\n automated scheduled query executions. Scheduled queries use GetQueryResults\n internally to retrieve query results for processing and delivery to configured\n destinations.

\n

You can retrieve up to 100,000 log event results from a query, if available, by using\n pagination. Use the nextToken returned in the response to request additional\n pages of results, with each page returning up to 10,000 log events. This is only supported for Logs Insights QL and is currently not supported for PPL and SQL query languages.

\n

If you are using CloudWatch cross-account observability, you can use this operation\n in a monitoring account to start queries in linked source accounts. For more information, see\n CloudWatch cross-account observability.

" + } + }, + "com.amazonaws.cloudwatchlogs#GetQueryResultsMaxItems": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 10000 + } + } + }, + "com.amazonaws.cloudwatchlogs#GetQueryResultsNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.cloudwatchlogs#GetQueryResultsRequest": { + "type": "structure", + "members": { + "queryId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "

The ID number of the query.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#GetQueryResultsNextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. The token expires after 1 hour.

" + } + }, + "maxItems": { + "target": "com.amazonaws.cloudwatchlogs#GetQueryResultsMaxItems", + "traits": { + "smithy.api#documentation": "

The maximum number of log events to return in the response. The maximum is 10,000 log\n events per request. You can retrieve up to 100,000 log event results from a query by\n paginating with the nextToken.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetQueryResultsResponse": { + "type": "structure", + "members": { + "queryLanguage": { + "target": "com.amazonaws.cloudwatchlogs#QueryLanguage", + "traits": { + "smithy.api#documentation": "

The query language used for this query. For more information about the query languages\n that CloudWatch Logs supports, see Supported query\n languages.

" + } + }, + "results": { + "target": "com.amazonaws.cloudwatchlogs#QueryResults", + "traits": { + "smithy.api#documentation": "

The log events that matched the query criteria during the most recent time it ran.

\n

The results value is an array of arrays. Each log event is one object in the\n top-level array. Each of these log event objects is an array of\n field/value pairs.

" + } + }, + "statistics": { + "target": "com.amazonaws.cloudwatchlogs#QueryStatistics", + "traits": { + "smithy.api#documentation": "

Includes the number of log events scanned by the query, the number of log events that\n matched the query criteria, and the total number of bytes in the scanned log events. These\n values reflect the full raw results of the query.

" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#QueryStatus", + "traits": { + "smithy.api#documentation": "

The status of the most recent running of the query. Possible values are\n Cancelled, Complete, Failed, Running,\n Scheduled, Timeout, and Unknown.

\n

Queries time out after 60 minutes of runtime. To avoid having your queries time out,\n reduce the time range being searched or partition your query into a number of queries.

" + } + }, + "encryptionKey": { + "target": "com.amazonaws.cloudwatchlogs#EncryptionKey", + "traits": { + "smithy.api#documentation": "

If you associated an KMS key with the CloudWatch Logs Insights\n query results in this account, this field displays the ARN of the key that's used to encrypt\n the query results when StartQuery stores\n them.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#GetQueryResultsNextToken", + "traits": { + "smithy.api#documentation": "

If there are more log events remaining in the results, the response includes a\n nextToken. You can use this token in a subsequent GetQueryResults\n request to get the next set of results. You can retrieve up to 100,000 log event results\n from a query by paginating with this token. This is only supported for Logs Insights QL and is currently not supported for PPL and SQL query languages.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetScheduledQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetScheduledQueryRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetScheduledQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InternalServerException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves details about a specific scheduled query, including its configuration, execution\n status, and metadata.

" + } + }, + "com.amazonaws.cloudwatchlogs#GetScheduledQueryHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetScheduledQueryHistoryRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetScheduledQueryHistoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InternalServerException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the execution history of a scheduled query within a specified time range,\n including query results and destination processing status.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "triggerHistory", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.cloudwatchlogs#GetScheduledQueryHistoryMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.cloudwatchlogs#GetScheduledQueryHistoryRequest": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryIdentifier", + "traits": { + "smithy.api#documentation": "

The ARN or name of the scheduled query to retrieve history for.

", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The start time for the history query in Unix epoch format.

", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The end time for the history query in Unix epoch format.

", + "smithy.api#required": {} + } + }, + "executionStatuses": { + "target": "com.amazonaws.cloudwatchlogs#ExecutionStatusList", + "traits": { + "smithy.api#documentation": "

An array of execution statuses to filter the history results. Only executions with the\n specified statuses are returned.

" + } + }, + "maxResults": { + "target": "com.amazonaws.cloudwatchlogs#GetScheduledQueryHistoryMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of history records to return. Valid range is 1 to 1000.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetScheduledQueryHistoryResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryName", + "traits": { + "smithy.api#documentation": "

The name of the scheduled query.

" + } + }, + "scheduledQueryArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the scheduled query.

" + } + }, + "triggerHistory": { + "target": "com.amazonaws.cloudwatchlogs#TriggerHistoryRecordList", + "traits": { + "smithy.api#documentation": "

An array of execution history records for the scheduled query.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetScheduledQueryRequest": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryIdentifier", + "traits": { + "smithy.api#documentation": "

The ARN or name of the scheduled query to retrieve.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetScheduledQueryResponse": { + "type": "structure", + "members": { + "scheduledQueryArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the scheduled query.

" + } + }, + "name": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryName", + "traits": { + "smithy.api#documentation": "

The name of the scheduled query.

" + } + }, + "description": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryDescription", + "traits": { + "smithy.api#documentation": "

The description of the scheduled query.

" + } + }, + "queryLanguage": { + "target": "com.amazonaws.cloudwatchlogs#QueryLanguage", + "traits": { + "smithy.api#documentation": "

The query language used by the scheduled query.

" + } + }, + "queryString": { + "target": "com.amazonaws.cloudwatchlogs#QueryString", + "traits": { + "smithy.api#documentation": "

The query string executed by the scheduled query.

" + } + }, + "logGroupIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryLogGroupIdentifiers", + "traits": { + "smithy.api#documentation": "

The log groups queried by the scheduled query.

" + } + }, + "scheduleExpression": { + "target": "com.amazonaws.cloudwatchlogs#ScheduleExpression", + "traits": { + "smithy.api#documentation": "

The cron expression that defines when the scheduled query runs.

" + } + }, + "timezone": { + "target": "com.amazonaws.cloudwatchlogs#ScheduleTimezone", + "traits": { + "smithy.api#documentation": "

The timezone used for evaluating the schedule expression.

" + } + }, + "startTimeOffset": { + "target": "com.amazonaws.cloudwatchlogs#StartTimeOffset", + "traits": { + "smithy.api#documentation": "

The time offset in seconds that defines the lookback period for the query.

" + } + }, + "endTimeOffset": { + "target": "com.amazonaws.cloudwatchlogs#EndTimeOffset", + "traits": { + "smithy.api#documentation": "

The time offset in seconds that defines the end of the lookback period for the\n query.

" + } + }, + "destinationConfiguration": { + "target": "com.amazonaws.cloudwatchlogs#DestinationConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration for where query results are delivered.

" + } + }, + "state": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryState", + "traits": { + "smithy.api#documentation": "

The current state of the scheduled query.

" + } + }, + "scheduleType": { + "target": "com.amazonaws.cloudwatchlogs#ScheduleType", + "traits": { + "smithy.api#documentation": "

The schedule type of the scheduled query. Valid values are\n CUSTOMER_MANAGED and AWS_MANAGED.

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

The timestamp when the scheduled query was last executed.

" + } + }, + "lastExecutionStatus": { + "target": "com.amazonaws.cloudwatchlogs#ExecutionStatus", + "traits": { + "smithy.api#documentation": "

The status of the most recent execution of the scheduled query.

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

The start time for the scheduled query in Unix epoch format.

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

The end time for the scheduled query in Unix epoch format.

" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.cloudwatchlogs#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role used to execute the query and deliver results.

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

The timestamp when the scheduled query was created.

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

The timestamp when the scheduled query was last updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetStorageTierPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetStorageTierPolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetStorageTierPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the storage tier policy for the account.

" + } + }, + "com.amazonaws.cloudwatchlogs#GetStorageTierPolicyRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetStorageTierPolicyResponse": { + "type": "structure", + "members": { + "storageTier": { + "target": "com.amazonaws.cloudwatchlogs#StorageTier", + "traits": { + "smithy.api#documentation": "

The current storage tier for the account.

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

The time when the storage tier policy was last updated, expressed as the number of\n milliseconds after January 1, 1970 00:00:00 UTC.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetTransformer": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetTransformerRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetTransformerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the information about the log transformer associated with this log group.

\n

This operation returns data only for transformers created at the log group level. To get\n information for an account-level transformer, use DescribeAccountPolicies.

" + } + }, + "com.amazonaws.cloudwatchlogs#GetTransformerRequest": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

Specify either the name or ARN of the log group to return transformer information for. If\n the log group is in a source account and you are using a monitoring account, you must use the\n log group ARN.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetTransformerResponse": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

The ARN of the log group that you specified in your request.

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

The creation time of the transformer, expressed as the number of milliseconds after Jan\n 1, 1970 00:00:00 UTC.

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

The date and time when this transformer was most recently modified, expressed as the\n number of milliseconds after Jan 1, 1970 00:00:00 UTC.

" + } + }, + "transformerConfig": { + "target": "com.amazonaws.cloudwatchlogs#Processors", + "traits": { + "smithy.api#documentation": "

This sructure contains the configuration of the requested transformer.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#Grok": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.cloudwatchlogs#Source", + "traits": { + "smithy.api#documentation": "

The path to the field in the log event that you want to parse. If you omit this value, the\n whole log message is parsed.

" + } + }, + "match": { + "target": "com.amazonaws.cloudwatchlogs#GrokMatch", + "traits": { + "smithy.api#documentation": "

The grok pattern to match against the log event. For a list of supported grok patterns,\n see Supported grok patterns.

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

This processor uses pattern matching to parse and structure unstructured data. This\n processor can also extract fields from log messages.

\n

For more information about this processor including examples, see grok in the CloudWatch Logs User Guide.

" + } + }, + "com.amazonaws.cloudwatchlogs#GrokMatch": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.cloudwatchlogs#GroupingIdentifier": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.cloudwatchlogs#GroupingIdentifierKey", + "traits": { + "smithy.api#documentation": "

The key that identifies the grouping characteristic. The format of the key uses dot\n notation. Examples are, dataSource.Name, dataSource.Type, and\n dataSource.Format.

" + } + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#GroupingIdentifierValue", + "traits": { + "smithy.api#documentation": "

The value associated with the grouping characteristic. Examples are\n amazon_vpc, flow, and OCSF.

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

A key-value pair that identifies how log groups are grouped in aggregate summaries.

" + } + }, + "com.amazonaws.cloudwatchlogs#GroupingIdentifierKey": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#GroupingIdentifierValue": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#GroupingIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#GroupingIdentifier" + } + }, + "com.amazonaws.cloudwatchlogs#Histogram": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#Time" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#Count" + } + }, + "com.amazonaws.cloudwatchlogs#Import": { + "type": "structure", + "members": { + "importId": { + "target": "com.amazonaws.cloudwatchlogs#ImportId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the import task.

" + } + }, + "importSourceArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the CloudTrail Lake Event Data Store being imported from.

" + } + }, + "importStatus": { + "target": "com.amazonaws.cloudwatchlogs#ImportStatus", + "traits": { + "smithy.api#documentation": "

The current status of the import task. Valid values are IN_PROGRESS, CANCELLED, COMPLETED and FAILED.

" + } + }, + "importDestinationArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the managed CloudWatch Logs log group where the events are being imported to.

" + } + }, + "importStatistics": { + "target": "com.amazonaws.cloudwatchlogs#ImportStatistics", + "traits": { + "smithy.api#documentation": "

Statistics about the import progress

" + } + }, + "importFilter": { + "target": "com.amazonaws.cloudwatchlogs#ImportFilter", + "traits": { + "smithy.api#documentation": "

The filter criteria used for this import task.

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

The timestamp when the import task was created, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

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

The timestamp when the import task was last updated, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

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

Error message related to any failed imports

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

An import job to move data from CloudTrail Event Data Store to CloudWatch.

" + } + }, + "com.amazonaws.cloudwatchlogs#ImportBatch": { + "type": "structure", + "members": { + "batchId": { + "target": "com.amazonaws.cloudwatchlogs#BatchId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the import batch.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#ImportStatus", + "traits": { + "smithy.api#documentation": "

The current status of the import batch. Valid values are IN_PROGRESS, CANCELLED, COMPLETED and FAILED.

", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "com.amazonaws.cloudwatchlogs#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message if the batch failed to import. Only present when status is FAILED.

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

A collection of events being imported to CloudWatch

" + } + }, + "com.amazonaws.cloudwatchlogs#ImportBatchList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#ImportBatch" + } + }, + "com.amazonaws.cloudwatchlogs#ImportFilter": { + "type": "structure", + "members": { + "startEventTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The start of the time range for events to import, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

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

The end of the time range for events to import, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

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

The filter criteria used for import tasks

" + } + }, + "com.amazonaws.cloudwatchlogs#ImportId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\-a-zA-Z0-9]+$" + } + }, + "com.amazonaws.cloudwatchlogs#ImportList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#Import" + } + }, + "com.amazonaws.cloudwatchlogs#ImportStatistics": { + "type": "structure", + "members": { + "bytesImported": { + "target": "com.amazonaws.cloudwatchlogs#StoredBytes", + "traits": { + "smithy.api#documentation": "

The total number of bytes that have been imported to the managed log group.

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

Statistics about the import progress

" + } + }, + "com.amazonaws.cloudwatchlogs#ImportStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#ImportStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#ImportStatus" + } + }, + "com.amazonaws.cloudwatchlogs#IncludeLinkedAccounts": { + "type": "boolean" + }, + "com.amazonaws.cloudwatchlogs#IndexCategories": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#IndexCategory" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4 + } + } + }, + "com.amazonaws.cloudwatchlogs#IndexCategory": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + }, + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#IndexPolicies": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#IndexPolicy" + } + }, + "com.amazonaws.cloudwatchlogs#IndexPolicy": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

The ARN of the log group that this index policy applies to.

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

The date and time that this index policy was most recently updated.

" + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#PolicyDocument", + "traits": { + "smithy.api#documentation": "

The policy document for this index policy, in JSON format.

" + } + }, + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#PolicyName", + "traits": { + "smithy.api#documentation": "

The name of this policy. Responses about log group-level field index policies don't have\n this field, because those policies don't have names.

" + } + }, + "source": { + "target": "com.amazonaws.cloudwatchlogs#IndexSource", + "traits": { + "smithy.api#documentation": "

This field indicates whether this is an account-level index policy or an index policy that\n applies only to a single log group.

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

This structure contains information about one field index policy in this account.

" + } + }, + "com.amazonaws.cloudwatchlogs#IndexSource": { + "type": "enum", + "members": { + "ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT" + } + }, + "LOG_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOG_GROUP" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#IndexType": { + "type": "enum", + "members": { + "FACET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FACET" + } + }, + "FIELD_INDEX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIELD_INDEX" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#InferredTokenName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#InheritedProperties": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#InheritedProperty" + } + }, + "com.amazonaws.cloudwatchlogs#InheritedProperty": { + "type": "enum", + "members": { + "ACCOUNT_DATA_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_DATA_PROTECTION" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#InputLogEvent": { + "type": "structure", + "members": { + "timestamp": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the event occurred, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#EventMessage", + "traits": { + "smithy.api#documentation": "

The raw event message. Each log event can be no larger than 1 MB.

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

Represents a log event, which is a record of activity that was recorded by the\n application or resource being monitored.

" + } + }, + "com.amazonaws.cloudwatchlogs#InputLogEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#InputLogEvent" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.cloudwatchlogs#InputLogStreamNames": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.cloudwatchlogs#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.cloudwatchlogs#IntegrationDetails": { + "type": "union", + "members": { + "openSearchIntegrationDetails": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchIntegrationDetails", + "traits": { + "smithy.api#documentation": "

This structure contains complete information about one integration between CloudWatch Logs and OpenSearch Service.

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

This structure contains information about the integration configuration. For an\n integration with OpenSearch Service, this includes information about OpenSearch Service\n resources such as the collection, the workspace, and policies.

\n

This structure is returned by a GetIntegration operation.

" + } + }, + "com.amazonaws.cloudwatchlogs#IntegrationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" + } + }, + "com.amazonaws.cloudwatchlogs#IntegrationNamePrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" + } + }, + "com.amazonaws.cloudwatchlogs#IntegrationStatus": { + "type": "enum", + "members": { + "PROVISIONING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROVISIONING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#IntegrationStatusMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#IntegrationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationSummary" + } + }, + "com.amazonaws.cloudwatchlogs#IntegrationSummary": { + "type": "structure", + "members": { + "integrationName": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationName", + "traits": { + "smithy.api#documentation": "

The name of this integration.

" + } + }, + "integrationType": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationType", + "traits": { + "smithy.api#documentation": "

The type of integration. Integrations with OpenSearch Service have the type\n OPENSEARCH.

" + } + }, + "integrationStatus": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationStatus", + "traits": { + "smithy.api#documentation": "

The current status of this integration.

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

This structure contains information about one CloudWatch Logs integration. This\n structure is returned by a ListIntegrations operation.

" + } + }, + "com.amazonaws.cloudwatchlogs#IntegrationType": { + "type": "enum", + "members": { + "OPENSEARCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENSEARCH" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#Interleaved": { + "type": "boolean" + }, + "com.amazonaws.cloudwatchlogs#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

An internal server error occurred while processing the request. This exception is returned\n when the service encounters an unexpected condition that prevents it from fulfilling the\n request.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.cloudwatchlogs#InternalStreamingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

An internal error occurred during the streaming of log data. This exception is thrown when\n there's an issue with the internal streaming mechanism used by the GetLogObject\n operation.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#InvalidOperationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The operation is not valid on the specified resource.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#InvalidParameterException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

A parameter is specified incorrectly.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#InvalidSequenceTokenException": { + "type": "structure", + "members": { + "expectedSequenceToken": { + "target": "com.amazonaws.cloudwatchlogs#SequenceToken" + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The sequence token is not valid. You can get the correct sequence token in the\n expectedSequenceToken field in the InvalidSequenceTokenException\n message.

\n \n

\n PutLogEvents actions are now always accepted and never return\n InvalidSequenceTokenException regardless of receiving an invalid sequence\n token.

\n ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#IsSampled": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.cloudwatchlogs#Key": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cloudwatchlogs#KeyPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cloudwatchlogs#KeyValueDelimiter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cloudwatchlogs#KmsKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#LimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

You have reached the maximum number of resources that can be created.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#ListAggregateLogGroupSummaries": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#ListAggregateLogGroupSummariesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#ListAggregateLogGroupSummariesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns an aggregate summary of all log groups in the Region grouped by specified data\n source characteristics. Supports optional filtering by log group class, name patterns, and\n data sources. If you perform this action in a monitoring account, you can also return\n aggregated summaries of log groups from source accounts that are linked to the monitoring\n account. For more information about using cross-account observability to set up monitoring\n accounts and source accounts, see CloudWatch\n cross-account observability.

\n

The operation aggregates log groups by data source name and type and optionally format,\n providing counts of log groups that share these characteristics. The operation paginates\n results. By default, it returns up to 50 results and includes a token to retrieve more\n results.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "aggregateLogGroupSummaries", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#ListAggregateLogGroupSummariesGroupBy": { + "type": "enum", + "members": { + "DATA_SOURCE_NAME_TYPE_AND_FORMAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SOURCE_NAME_TYPE_AND_FORMAT" + } + }, + "DATA_SOURCE_NAME_AND_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SOURCE_NAME_AND_TYPE" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#ListAggregateLogGroupSummariesRequest": { + "type": "structure", + "members": { + "accountIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#AccountIds", + "traits": { + "smithy.api#documentation": "

When includeLinkedAccounts is set to true, use this parameter to\n specify the list of accounts to search. You can specify as many as 20 account IDs in the\n array.

" + } + }, + "includeLinkedAccounts": { + "target": "com.amazonaws.cloudwatchlogs#IncludeLinkedAccounts", + "traits": { + "smithy.api#documentation": "

If you are using a monitoring account, set this to true to have the operation\n return log groups in the accounts listed in accountIdentifiers.

\n

If this parameter is set to true and accountIdentifiers contains\n a null value, the operation returns all log groups in the monitoring account and all log\n groups in all source accounts that are linked to the monitoring account.

\n

The default for this parameter is false.

" + } + }, + "logGroupClass": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupClass", + "traits": { + "smithy.api#documentation": "

Filters the results by log group class to include only log groups of the specified\n class.

" + } + }, + "logGroupNamePattern": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupNameRegexPattern", + "traits": { + "smithy.api#documentation": "

Use this parameter to limit the returned log groups to only those with names that match\n the pattern that you specify. This parameter is a regular expression that can match prefixes\n and substrings, and supports wildcard matching and matching multiple patterns, as in the\n following examples.

\n
    \n
  • \n

    Use ^ to match log group names by prefix.

    \n
    • \n
  • \n

    For a substring match, specify the string to match. All matches are case\n sensitive

    \n
    • \n
  • \n

    To match multiple patterns, separate them with a | as in the example\n ^/aws/lambda|discovery\n

    \n
    • \n
\n

You can specify as many as five different regular expression patterns in this field, each\n of which must be between 3 and 24 characters. You can include the ^ symbol as\n many as five times, and include the | symbol as many as four times.

" + } + }, + "dataSources": { + "target": "com.amazonaws.cloudwatchlogs#DataSourceFilters", + "traits": { + "smithy.api#documentation": "

Filters the results by data source characteristics to include only log groups associated\n with the specified data sources.

" + } + }, + "groupBy": { + "target": "com.amazonaws.cloudwatchlogs#ListAggregateLogGroupSummariesGroupBy", + "traits": { + "smithy.api#documentation": "

Specifies how to group the log groups in the summary.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#ListLogGroupsRequestLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of aggregated summaries to return. If you omit this parameter, the\n default is up to 50 aggregated summaries.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListAggregateLogGroupSummariesResponse": { + "type": "structure", + "members": { + "aggregateLogGroupSummaries": { + "target": "com.amazonaws.cloudwatchlogs#AggregateLogGroupSummaries", + "traits": { + "smithy.api#documentation": "

The list of aggregate log group summaries grouped by the specified data source\n characteristics.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListAnomalies": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#ListAnomaliesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#ListAnomaliesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of anomalies that log anomaly detectors have found. For details about the\n structure format of each anomaly object that is returned, see the example in this\n section.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "anomalies", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#ListAnomaliesLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.cloudwatchlogs#ListAnomaliesRequest": { + "type": "structure", + "members": { + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "

Use this to optionally limit the results to only the anomalies found by a certain anomaly\n detector.

" + } + }, + "suppressionState": { + "target": "com.amazonaws.cloudwatchlogs#SuppressionState", + "traits": { + "smithy.api#documentation": "

You can specify this parameter if you want to the operation to return only anomalies that\n are currently either suppressed or unsuppressed.

" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#ListAnomaliesLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return. If you don't specify a value, the default\n maximum value of 50 items is used.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListAnomaliesResponse": { + "type": "structure", + "members": { + "anomalies": { + "target": "com.amazonaws.cloudwatchlogs#Anomalies", + "traits": { + "smithy.api#documentation": "

An array of structures, where each structure contains information about one anomaly that a\n log anomaly detector has found.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListIntegrations": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#ListIntegrationsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#ListIntegrationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of integrations between CloudWatch Logs and other services in this\n account. Currently, only one integration can be created in an account, and this integration\n must be with OpenSearch Service.

" + } + }, + "com.amazonaws.cloudwatchlogs#ListIntegrationsRequest": { + "type": "structure", + "members": { + "integrationNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationNamePrefix", + "traits": { + "smithy.api#documentation": "

To limit the results to integrations that start with a certain name prefix, specify that\n name prefix here.

" + } + }, + "integrationType": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationType", + "traits": { + "smithy.api#documentation": "

To limit the results to integrations of a certain type, specify that type here.

" + } + }, + "integrationStatus": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationStatus", + "traits": { + "smithy.api#documentation": "

To limit the results to integrations with a certain status, specify that status\n here.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListIntegrationsResponse": { + "type": "structure", + "members": { + "integrationSummaries": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationSummaries", + "traits": { + "smithy.api#documentation": "

An array, where each object in the array contains information about one CloudWatch Logs\n integration in this account.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of the log anomaly detectors in the account.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "anomalyDetectors", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsRequest": { + "type": "structure", + "members": { + "filterLogGroupArn": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupArn", + "traits": { + "smithy.api#documentation": "

Use this to optionally filter the results to only include anomaly detectors that are\n associated with the specified log group.

" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return. If you don't specify a value, the default\n maximum value of 50 items is used.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsResponse": { + "type": "structure", + "members": { + "anomalyDetectors": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectors", + "traits": { + "smithy.api#documentation": "

An array of structures, where each structure in the array contains information about one\n anomaly detector.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListLogGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#ListLogGroupsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#ListLogGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of log groups in the Region in your account. If you are performing this\n action in a monitoring account, you can choose to also return log groups from source accounts\n that are linked to the monitoring account. For more information about using cross-account\n observability to set up monitoring accounts and source accounts, see \n CloudWatch cross-account observability.

\n

You can optionally filter the results by log group class, log group name pattern,\n field indexes, data sources, field index names, or log group tags. If you specify more than\n one filter type, the results include log groups that satisfy all filters.

\n

This operation is paginated. By default, your first use of this operation returns 50\n results, and includes a token to use in a subsequent operation to return more results.

" + } + }, + "com.amazonaws.cloudwatchlogs#ListLogGroupsForQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#ListLogGroupsForQueryRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#ListLogGroupsForQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the log groups that were analyzed during a single CloudWatch Logs\n Insights query. This can be useful for queries that use log group name prefixes or the\n filterIndex command, because the log groups are dynamically selected in these\n cases.

\n

For more information about field indexes, see Create field indexes\n to improve query performance and reduce costs.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "logGroupIdentifiers", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.cloudwatchlogs#ListLogGroupsForQueryMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 50, + "max": 500 + } + } + }, + "com.amazonaws.cloudwatchlogs#ListLogGroupsForQueryRequest": { + "type": "structure", + "members": { + "queryId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "

The ID of the query to use. This query ID is from the response to your StartQuery operation.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, + "maxResults": { + "target": "com.amazonaws.cloudwatchlogs#ListLogGroupsForQueryMaxResults", + "traits": { + "smithy.api#documentation": "

Limits the number of returned log groups to the specified number.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListLogGroupsForQueryResponse": { + "type": "structure", + "members": { + "logGroupIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifiers", + "traits": { + "smithy.api#documentation": "

An array of the names and ARNs of the log groups that were processed in the query.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListLogGroupsRequest": { + "type": "structure", + "members": { + "logGroupNamePattern": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupNameRegexPattern", + "traits": { + "smithy.api#documentation": "

Use this parameter to limit the returned log groups to only those with names that match\n the pattern that you specify. This parameter is a regular expression that can match prefixes\n and substrings, and supports wildcard matching and matching multiple patterns, as in the\n following examples.

\n
    \n
  • \n

    Use ^ to match log group names by prefix.

    \n
    • \n
  • \n

    For a substring match, specify the string to match. All matches are case\n sensitive

    \n
    • \n
  • \n

    To match multiple patterns, separate them with a | as in the example\n ^/aws/lambda|discovery\n

    \n
    • \n
\n

You can specify as many as five different regular expression patterns in this field, each\n of which must be between 3 and 24 characters. You can include the ^ symbol as\n many as five times, and include the | symbol as many as four times.

" + } + }, + "logGroupClass": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupClass", + "traits": { + "smithy.api#documentation": "

Use this parameter to limit the results to only those log groups in the specified log\n group class. If you omit this parameter, log groups of all classes can be returned.

" + } + }, + "includeLinkedAccounts": { + "target": "com.amazonaws.cloudwatchlogs#IncludeLinkedAccounts", + "traits": { + "smithy.api#documentation": "

If you are using a monitoring account, set this to true to have the operation\n return log groups in the accounts listed in accountIdentifiers.

\n

If this parameter is set to true and accountIdentifiers contains\n a null value, the operation returns all log groups in the monitoring account and all log\n groups in all source accounts that are linked to the monitoring account.

\n

The default for this parameter is false.

" + } + }, + "accountIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#AccountIds", + "traits": { + "smithy.api#documentation": "

When includeLinkedAccounts is set to true, use this parameter to\n specify the list of accounts to search. You can specify as many as 20 account IDs in the\n array.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#ListLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of log groups to return. If you omit this parameter, the default is\n up to 50 log groups.

" + } + }, + "dataSources": { + "target": "com.amazonaws.cloudwatchlogs#DataSourceFilters", + "traits": { + "smithy.api#documentation": "

An array of data source filters to filter log groups by their associated data sources. You\n can filter by data source name, type, or both. Multiple filters within the same dimension are\n combined with OR logic, while filters across different dimensions are combined with AND\n logic.

" + } + }, + "fieldIndexNames": { + "target": "com.amazonaws.cloudwatchlogs#FieldIndexNames", + "traits": { + "smithy.api#documentation": "

An array of field index names to filter log groups that have specific field indexes. Only\n log groups containing all specified field indexes are returned. You can specify 1 to 20 field\n index names, each with 1 to 512 characters.

" + } + }, + "logGroupTags": { + "target": "com.amazonaws.cloudwatchlogs#TagFilters", + "traits": { + "smithy.api#documentation": "

An array of tag filters to return only log groups that have specific tags. Multiple\n filters are combined with AND logic.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListLogGroupsRequestLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.cloudwatchlogs#ListLogGroupsResponse": { + "type": "structure", + "members": { + "logGroups": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupSummaries", + "traits": { + "smithy.api#documentation": "

An array of structures, where each structure contains the information about one log\n group.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListScheduledQueries": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#ListScheduledQueriesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#ListScheduledQueriesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InternalServerException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all scheduled queries in your account and region. You can filter results by state to\n show only enabled or disabled queries.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "scheduledQueries", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.cloudwatchlogs#ListScheduledQueriesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.cloudwatchlogs#ListScheduledQueriesRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.cloudwatchlogs#ListScheduledQueriesMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of scheduled queries to return. Valid range is 1 to 1000.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, + "state": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryState", + "traits": { + "smithy.api#documentation": "

Filter scheduled queries by state. Valid values are ENABLED and\n DISABLED. If not specified, all scheduled queries are returned.

" + } + }, + "scheduleType": { + "target": "com.amazonaws.cloudwatchlogs#ScheduleType", + "traits": { + "smithy.api#documentation": "

Filter scheduled queries by schedule type. Valid values are\n CUSTOMER_MANAGED and AWS_MANAGED. If not specified, scheduled\n queries of all schedule types are returned.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListScheduledQueriesResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, + "scheduledQueries": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQuerySummaryList", + "traits": { + "smithy.api#documentation": "

An array of scheduled query summary information.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListSourcesForS3TableIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#ListSourcesForS3TableIntegrationRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#ListSourcesForS3TableIntegrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InternalServerException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of data source associations for a specified S3 Table Integration, showing\n which data sources are currently associated for query access.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "sources", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.cloudwatchlogs#ListSourcesForS3TableIntegrationMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.cloudwatchlogs#ListSourcesForS3TableIntegrationRequest": { + "type": "structure", + "members": { + "integrationArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the S3 Table Integration to list associations\n for.

", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.cloudwatchlogs#ListSourcesForS3TableIntegrationMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of associations to return in a single call. Valid range is 1 to\n 100.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListSourcesForS3TableIntegrationResponse": { + "type": "structure", + "members": { + "sources": { + "target": "com.amazonaws.cloudwatchlogs#S3TableIntegrationSources", + "traits": { + "smithy.api#documentation": "

The list of data source associations for the specified S3 Table Integration.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListSyslogConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#ListSyslogConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#ListSyslogConfigurationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of syslog configurations. You can optionally filter the results by log\n group or VPC endpoint.

" + } + }, + "com.amazonaws.cloudwatchlogs#ListSyslogConfigurationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.cloudwatchlogs#ListSyslogConfigurationsRequest": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

The name or ARN of the log group to filter syslog configurations for.

" + } + }, + "vpcEndpointId": { + "target": "com.amazonaws.cloudwatchlogs#VpcEndpointId", + "traits": { + "smithy.api#documentation": "

The ID of the VPC endpoint to filter syslog configurations for.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. You received this token from a previous\n call.

" + } + }, + "maxResults": { + "target": "com.amazonaws.cloudwatchlogs#ListSyslogConfigurationsMaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of syslog configurations to return in the response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListSyslogConfigurationsResponse": { + "type": "structure", + "members": { + "syslogConfigurations": { + "target": "com.amazonaws.cloudwatchlogs#SyslogConfigurations", + "traits": { + "smithy.api#documentation": "

The list of syslog configurations.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. The token expires after 24 hours.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and\n destinations support tagging.

" + } + }, + "com.amazonaws.cloudwatchlogs#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.cloudwatchlogs#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the resource that you want to view tags for.

\n

The ARN format of a log group is\n arn:aws:logs:Region:account-id:log-group:log-group-name\n \n

\n

The ARN format of a destination is\n arn:aws:logs:Region:account-id:destination:destination-name\n \n

\n

For more information about ARN format, see CloudWatch Logs\n resources and operations.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

The list of tags associated with the requested resource.>

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListTagsLogGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#ListTagsLogGroupRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#ListTagsLogGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "Please use the generic tagging API ListTagsForResource" + }, + "smithy.api#documentation": "\n

The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use\n ListTagsForResource instead.

\n \n

Lists the tags for the specified log group.

" + } + }, + "com.amazonaws.cloudwatchlogs#ListTagsLogGroupRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Please use the generic tagging API model ListTagsForResourceRequest and ListTagsForResourceResponse" + }, + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListTagsLogGroupResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

The tags for the log group.

" + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Please use the generic tagging API model ListTagsForResourceRequest and ListTagsForResourceResponse" + }, + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListToMap": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.cloudwatchlogs#Source", + "traits": { + "smithy.api#documentation": "

The key in the log event that has a list of objects that will be converted to a\n map.

", + "smithy.api#required": {} + } + }, + "key": { + "target": "com.amazonaws.cloudwatchlogs#Key", + "traits": { + "smithy.api#documentation": "

The key of the field to be extracted as keys in the generated map

", + "smithy.api#required": {} + } + }, + "valueKey": { + "target": "com.amazonaws.cloudwatchlogs#ValueKey", + "traits": { + "smithy.api#documentation": "

If this is specified, the values that you specify in this parameter will be extracted from\n the source objects and put into the values of the generated map. Otherwise,\n original objects in the source list will be put into the values of the generated map.

" + } + }, + "target": { + "target": "com.amazonaws.cloudwatchlogs#Target", + "traits": { + "smithy.api#documentation": "

The key of the field that will hold the generated map

" + } + }, + "flatten": { + "target": "com.amazonaws.cloudwatchlogs#Flatten", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value to indicate whether the list will be flattened into single items. Specify\n true to flatten the list. The default is false\n

" + } + }, + "flattenedElement": { + "target": "com.amazonaws.cloudwatchlogs#FlattenedElement", + "traits": { + "smithy.api#documentation": "

If you set flatten to true, use flattenedElement to\n specify which element, first or last, to keep.

\n

You must specify this parameter if flatten is true\n

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

This processor takes a list of objects that contain key fields, and converts them into a\n map of target keys.

\n

For more information about this processor including examples, see listToMap in the CloudWatch Logs User Guide.

" + } + }, + "com.amazonaws.cloudwatchlogs#LiveTailSessionLogEvent": { + "type": "structure", + "members": { + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "

The name of the log stream that ingested this log event.

" + } + }, + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

The name or ARN of the log group that ingested this log event.

" + } + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#EventMessage", + "traits": { + "smithy.api#documentation": "

The log event message text.

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

The timestamp specifying when this log event was created.

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

The timestamp specifying when this log event was ingested into the log group.

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

This object contains the information for one log event returned in a Live Tail\n stream.

" + } + }, + "com.amazonaws.cloudwatchlogs#LiveTailSessionMetadata": { + "type": "structure", + "members": { + "sampled": { + "target": "com.amazonaws.cloudwatchlogs#IsSampled", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

If this is true, then more than 500 log events matched the request for this\n update, and the sessionResults includes a sample of 500 of those events.

\n

If this is false, then 500 or fewer log events matched the request for this\n update, so no sampling was necessary. In this case, the sessionResults array\n includes all log events that matched your request during this time.

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

This object contains the metadata for one LiveTailSessionUpdate structure. It\n indicates whether that update includes only a sample of 500 log events out of a larger number\n of ingested log events, or if it contains all of the matching log events ingested during that\n second of time.

" + } + }, + "com.amazonaws.cloudwatchlogs#LiveTailSessionResults": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LiveTailSessionLogEvent" + } + }, + "com.amazonaws.cloudwatchlogs#LiveTailSessionStart": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.cloudwatchlogs#RequestId", + "traits": { + "smithy.api#documentation": "

The unique ID generated by CloudWatch Logs to identify this Live Tail session\n request.

" + } + }, + "sessionId": { + "target": "com.amazonaws.cloudwatchlogs#SessionId", + "traits": { + "smithy.api#documentation": "

The unique ID generated by CloudWatch Logs to identify this Live Tail session.

" + } + }, + "logGroupIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#StartLiveTailLogGroupIdentifiers", + "traits": { + "smithy.api#documentation": "

An array of the names and ARNs of the log groups included in this Live Tail\n session.

" + } + }, + "logStreamNames": { + "target": "com.amazonaws.cloudwatchlogs#InputLogStreamNames", + "traits": { + "smithy.api#documentation": "

If your StartLiveTail operation request included a logStreamNames parameter\n that filtered the session to only include certain log streams, these streams are listed\n here.

" + } + }, + "logStreamNamePrefixes": { + "target": "com.amazonaws.cloudwatchlogs#InputLogStreamNames", + "traits": { + "smithy.api#documentation": "

If your StartLiveTail operation request included a logStreamNamePrefixes\n parameter that filtered the session to only include log streams that have names that start\n with certain prefixes, these prefixes are listed here.

" + } + }, + "logEventFilterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern", + "traits": { + "smithy.api#documentation": "

An optional pattern to filter the results to include only log events that match the\n pattern. For example, a filter pattern of error 404 displays only log events that\n include both error and 404.

\n

For more information about filter pattern syntax, see Filter and Pattern\n Syntax.

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

This object contains information about this Live Tail session, including the log groups\n included and the log stream filters, if any.

" + } + }, + "com.amazonaws.cloudwatchlogs#LiveTailSessionUpdate": { + "type": "structure", + "members": { + "sessionMetadata": { + "target": "com.amazonaws.cloudwatchlogs#LiveTailSessionMetadata", + "traits": { + "smithy.api#documentation": "

This object contains the session metadata for a Live Tail session.

" + } + }, + "sessionResults": { + "target": "com.amazonaws.cloudwatchlogs#LiveTailSessionResults", + "traits": { + "smithy.api#documentation": "

An array, where each member of the array includes the information for one log event in the\n Live Tail session.

\n

A sessionResults array can include as many as 500 log events. If the number\n of log events matching the request exceeds 500 per second, the log events are sampled down to\n 500 log events to be included in each sessionUpdate structure.

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

This object contains the log events and metadata for a Live Tail session.

" + } + }, + "com.amazonaws.cloudwatchlogs#Locale": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#LogEvent": { + "type": "structure", + "members": { + "timestamp": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The time stamp of the log event.

" + } + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#EventMessage", + "traits": { + "smithy.api#documentation": "

The message content of the log event.

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

This structure contains the information for one sample log event that is associated with\n an anomaly found by a log anomaly detector.

" + } + }, + "com.amazonaws.cloudwatchlogs#LogEventIndex": { + "type": "integer" + }, + "com.amazonaws.cloudwatchlogs#LogFieldName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#LogFieldType": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.cloudwatchlogs#DataType", + "traits": { + "smithy.api#documentation": "

The data type of the log field.

" + } + }, + "element": { + "target": "com.amazonaws.cloudwatchlogs#LogFieldType", + "traits": { + "smithy.api#documentation": "

For array or collection types, specifies the element type information.

" + } + }, + "fields": { + "target": "com.amazonaws.cloudwatchlogs#LogFieldsList", + "traits": { + "smithy.api#documentation": "

For complex types, contains the nested field definitions.

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

Defines the data type structure for a log field, including the type, element information,\n and nested fields for complex types.

" + } + }, + "com.amazonaws.cloudwatchlogs#LogFieldsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogFieldsListItem" + } + }, + "com.amazonaws.cloudwatchlogs#LogFieldsListItem": { + "type": "structure", + "members": { + "logFieldName": { + "target": "com.amazonaws.cloudwatchlogs#LogFieldName", + "traits": { + "smithy.api#documentation": "

The name of the log field.

" + } + }, + "logFieldType": { + "target": "com.amazonaws.cloudwatchlogs#LogFieldType", + "traits": { + "smithy.api#documentation": "

The data type information for the log field.

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

Represents a log field with its name and data type information for a specific data\n source.

" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroup": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

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

The creation time of the log group, expressed as the number of milliseconds after Jan\n 1, 1970 00:00:00 UTC.

" + } + }, + "retentionInDays": { + "target": "com.amazonaws.cloudwatchlogs#Days" + }, + "metricFilterCount": { + "target": "com.amazonaws.cloudwatchlogs#FilterCount", + "traits": { + "smithy.api#documentation": "

The number of metric filters.

" + } + }, + "arn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the log group. This version of the ARN includes a\n trailing :* after the log group name.

\n

Use this version to refer to the ARN in IAM policies when specifying\n permissions for most API actions. The exception is when specifying permissions for TagResource, UntagResource,\n and ListTagsForResource. The permissions for those three actions require the ARN\n version that doesn't include a trailing :*.

" + } + }, + "storedBytes": { + "target": "com.amazonaws.cloudwatchlogs#StoredBytes", + "traits": { + "smithy.api#documentation": "

The number of bytes stored.

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

The Amazon Resource Name (ARN) of the KMS key to use when\n encrypting log data.

" + } + }, + "dataProtectionStatus": { + "target": "com.amazonaws.cloudwatchlogs#DataProtectionStatus", + "traits": { + "smithy.api#documentation": "

Displays whether this log group has a protection policy, or whether it had one in the\n past. For more information, see PutDataProtectionPolicy.

" + } + }, + "inheritedProperties": { + "target": "com.amazonaws.cloudwatchlogs#InheritedProperties", + "traits": { + "smithy.api#documentation": "

Displays all the properties that this log group has inherited from account-level\n settings.

" + } + }, + "logGroupClass": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupClass", + "traits": { + "smithy.api#documentation": "

This specifies the log group class for this log group. There are three classes:

\n
    \n
  • \n

    The Standard log class supports all CloudWatch Logs features.

    \n
    • \n
  • \n

    The Infrequent Access log class supports a subset of CloudWatch Logs\n features and incurs lower costs.

    \n
    • \n
  • \n

    Use the Delivery log class only for delivering Lambda\n logs to store in Amazon S3 or Amazon Data Firehose. Log events in log groups in\n the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn't\n offer rich CloudWatch Logs capabilities such as CloudWatch Logs Insights\n queries.

    \n
    • \n
\n

For details about the features supported by the Standard and Infrequent Access classes,\n see Log classes\n

" + } + }, + "logGroupArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the log group. This version of the ARN doesn't\n include a trailing :* after the log group name.

\n

Use this version to refer to the ARN in the following situations:

\n
    \n
  • \n

    In the logGroupIdentifier input field in many CloudWatch Logs\n APIs.

    \n
    • \n
  • \n

    In the resourceArn field in tagging APIs

    \n
    • \n
  • \n

    In IAM policies, when specifying permissions for TagResource, UntagResource, and ListTagsForResource.

    \n
    • \n
" + } + }, + "deletionProtectionEnabled": { + "target": "com.amazonaws.cloudwatchlogs#DeletionProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether deletion protection is enabled for this log group. When enabled,\n deletion protection blocks all deletion operations until it is explicitly disabled.

" + } + }, + "bearerTokenAuthenticationEnabled": { + "target": "com.amazonaws.cloudwatchlogs#BearerTokenAuthenticationEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether bearer token authentication is enabled for this log group. When enabled,\n bearer token authentication is allowed on operations until it is explicitly disabled.

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

Represents a log group.

" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[\\w#+=/:,.@-]*$" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupArn" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupClass": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + }, + "INFREQUENT_ACCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFREQUENT_ACCESS" + } + }, + "DELIVERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELIVERY" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupCount": { + "type": "integer" + }, + "com.amazonaws.cloudwatchlogs#LogGroupField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#Field", + "traits": { + "smithy.api#documentation": "

The name of a log field.

" + } + }, + "percent": { + "target": "com.amazonaws.cloudwatchlogs#Percentage", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The percentage of log events queried that contained the field.

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

The fields contained in log events found by a GetLogGroupFields operation,\n along with the percentage of queried log events in which each field appears.

" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupField" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[\\w#+=/:,.@-]*$" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupNamePattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]*$" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupNameRegexPattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 129 + }, + "smithy.api#pattern": "^(\\^?[\\.\\-_\\/#A-Za-z0-9]{3,24})(\\|\\^?[\\.\\-_\\/#A-Za-z0-9]{3,24}){0,4}$" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupNames": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupSummary" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupSummary": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

" + } + }, + "logGroupArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the log group.

" + } + }, + "logGroupClass": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupClass", + "traits": { + "smithy.api#documentation": "

The log group class for this log group. For details about the features supported by each\n log group class, see Log classes\n

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

This structure contains information about one log group in your account.

" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogGroup" + } + }, + "com.amazonaws.cloudwatchlogs#LogObjectPointer": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.cloudwatchlogs#LogRecord": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#Field" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#Value" + } + }, + "com.amazonaws.cloudwatchlogs#LogRecordPointer": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#LogSamples": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogEvent" + } + }, + "com.amazonaws.cloudwatchlogs#LogStream": { + "type": "structure", + "members": { + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "

The name of the log stream.

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

The creation time of the stream, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC.

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

The time of the first event, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC.

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

The time of the most recent log event in the log stream in CloudWatch Logs. This number\n is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. The\n lastEventTime value updates on an eventual consistency basis. It typically\n updates in less than an hour from ingestion, but in rare situations might take\n longer.

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

The ingestion time, expressed as the number of milliseconds after Jan 1, 1970\n 00:00:00 UTC The lastIngestionTime value updates on an eventual\n consistency basis. It typically updates in less than an hour after ingestion, but in rare\n situations might take longer.

" + } + }, + "uploadSequenceToken": { + "target": "com.amazonaws.cloudwatchlogs#SequenceToken", + "traits": { + "smithy.api#documentation": "

The sequence token.

\n \n

The sequence token is now ignored in PutLogEvents actions.\n PutLogEvents actions are always accepted regardless of receiving an invalid\n sequence token. You don't need to obtain uploadSequenceToken to use a\n PutLogEvents action.

\n " + } + }, + "arn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the log stream.

" + } + }, + "storedBytes": { + "target": "com.amazonaws.cloudwatchlogs#StoredBytes", + "traits": { + "smithy.api#deprecated": { + "message": "Starting on June 17, 2019, this parameter will be deprecated for log streams, and will be reported as zero. This change applies only to log streams. The storedBytes parameter for log groups is not affected." + }, + "smithy.api#documentation": "

The number of bytes stored.

\n

\n Important: As of June 17, 2019, this parameter is no\n longer supported for log streams, and is always reported as zero. This change applies only to\n log streams. The storedBytes parameter for log groups is not affected.

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

Represents a log stream, which is a sequence of log events from a single emitter of\n logs.

" + } + }, + "com.amazonaws.cloudwatchlogs#LogStreamName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[^:*]*$" + } + }, + "com.amazonaws.cloudwatchlogs#LogStreamSearchedCompletely": { + "type": "boolean" + }, + "com.amazonaws.cloudwatchlogs#LogStreams": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogStream" + } + }, + "com.amazonaws.cloudwatchlogs#LogType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\w]*$" + } + }, + "com.amazonaws.cloudwatchlogs#LogTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.cloudwatchlogs#Logs_20140328": { + "type": "service", + "version": "2014-03-28", + "operations": [ + { + "target": "com.amazonaws.cloudwatchlogs#AssociateKmsKey" + }, + { + "target": "com.amazonaws.cloudwatchlogs#AssociateSourceToS3TableIntegration" + }, + { + "target": "com.amazonaws.cloudwatchlogs#CancelExportTask" + }, + { + "target": "com.amazonaws.cloudwatchlogs#CancelImportTask" + }, + { + "target": "com.amazonaws.cloudwatchlogs#CreateDelivery" + }, + { + "target": "com.amazonaws.cloudwatchlogs#CreateExportTask" + }, + { + "target": "com.amazonaws.cloudwatchlogs#CreateImportTask" + }, + { + "target": "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetector" + }, + { + "target": "com.amazonaws.cloudwatchlogs#CreateLogGroup" + }, + { + "target": "com.amazonaws.cloudwatchlogs#CreateLogStream" + }, + { + "target": "com.amazonaws.cloudwatchlogs#CreateLookupTable" + }, + { + "target": "com.amazonaws.cloudwatchlogs#CreateScheduledQuery" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteAccountPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteDataProtectionPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteDelivery" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestination" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteDeliverySource" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteDestination" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteIndexPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteIntegration" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteLogAnomalyDetector" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteLogGroup" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteLogStream" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteLookupTable" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteMetricFilter" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteQueryDefinition" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteResourcePolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteRetentionPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteScheduledQuery" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteSubscriptionFilter" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteSyslogConfiguration" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteTransformer" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeAccountPolicies" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplates" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveries" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinations" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliverySources" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeDestinations" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeExportTasks" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeFieldIndexes" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeImportTaskBatches" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeImportTasks" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeIndexPolicies" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeLogGroups" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeLogStreams" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeLookupTables" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeMetricFilters" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeQueries" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitions" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeResourcePolicies" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFilters" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DisassociateKmsKey" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DisassociateSourceFromS3TableIntegration" + }, + { + "target": "com.amazonaws.cloudwatchlogs#FilterLogEvents" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetDelivery" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestination" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetDeliverySource" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetIntegration" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetector" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetLogEvents" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetLogFields" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetLogGroupFields" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetLogObject" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetLogRecord" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetLookupTable" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetQueryResults" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetScheduledQuery" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetScheduledQueryHistory" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetStorageTierPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetTransformer" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ListAggregateLogGroupSummaries" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ListAnomalies" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ListIntegrations" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectors" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ListLogGroups" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ListLogGroupsForQuery" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ListScheduledQueries" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ListSourcesForS3TableIntegration" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ListSyslogConfigurations" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ListTagsForResource" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ListTagsLogGroup" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutAccountPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutBearerTokenAuthentication" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestination" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutDeliverySource" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutDestination" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutDestinationPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutIndexPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutIntegration" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutLogEvents" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutLogGroupDeletionProtection" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutMetricFilter" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutQueryDefinition" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutResourcePolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutRetentionPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutStorageTierPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutSubscriptionFilter" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutSyslogConfiguration" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutTransformer" + }, + { + "target": "com.amazonaws.cloudwatchlogs#StartLiveTail" + }, + { + "target": "com.amazonaws.cloudwatchlogs#StartQuery" + }, + { + "target": "com.amazonaws.cloudwatchlogs#StopQuery" + }, + { + "target": "com.amazonaws.cloudwatchlogs#TagLogGroup" + }, + { + "target": "com.amazonaws.cloudwatchlogs#TagResource" + }, + { + "target": "com.amazonaws.cloudwatchlogs#TestMetricFilter" + }, + { + "target": "com.amazonaws.cloudwatchlogs#TestTransformer" + }, + { + "target": "com.amazonaws.cloudwatchlogs#UntagLogGroup" + }, + { + "target": "com.amazonaws.cloudwatchlogs#UntagResource" + }, + { + "target": "com.amazonaws.cloudwatchlogs#UpdateAnomaly" + }, + { + "target": "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfiguration" + }, + { + "target": "com.amazonaws.cloudwatchlogs#UpdateLogAnomalyDetector" + }, + { + "target": "com.amazonaws.cloudwatchlogs#UpdateLookupTable" + }, + { + "target": "com.amazonaws.cloudwatchlogs#UpdateScheduledQuery" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "CloudWatch Logs", + "arnNamespace": "logs", + "cloudFormationName": "Logs", + "cloudTrailEventSource": "logs.amazonaws.com", + "docId": "logs-2014-03-28", + "endpointPrefix": "logs" + }, + "aws.auth#sigv4": { + "name": "logs" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

You can use Amazon CloudWatch Logs to monitor, store, and access your log files from\n EC2 instances, CloudTrail, and other sources. You can then retrieve the associated\n log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use\n CloudWatch Logs commands in the Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch\n Logs SDK.

\n

For more information about CloudWatch Logs features, see the\n Amazon CloudWatch Logs User Guide.

\n

You can use CloudWatch Logs to:

\n
    \n
  • \n

    \n Monitor logs from EC2 instances in real time: You\n can use CloudWatch Logs to monitor applications and systems using log data. For example,\n CloudWatch Logs can track the number of errors that occur in your application logs. Then,\n it can send you a notification whenever the rate of errors exceeds a threshold that you\n specify. CloudWatch Logs uses your log data for monitoring so no code changes are\n required. For example, you can monitor application logs for specific literal terms (such\n as \"NullReferenceException\"). You can also count the number of occurrences of a literal\n term at a particular position in log data (such as \"404\" status codes in an Apache access\n log). When the term you are searching for is found, CloudWatch Logs reports the data to a\n CloudWatch metric that you specify.

    \n
    • \n
  • \n

    \n Monitor CloudTrail logged events: You\n can create alarms in CloudWatch and receive notifications of particular API activity as\n captured by CloudTrail. You can use the notification to perform troubleshooting.

    \n
    • \n
  • \n

    \n Archive log data: You can use CloudWatch Logs to\n store your log data in highly durable storage. You can change the log retention setting so\n that any log events earlier than this setting are automatically deleted. The CloudWatch\n Logs agent helps to quickly send both rotated and non-rotated log data off of a host and\n into the log service. You can then access the raw log data when you need it.

    \n
    • \n
\n \n

CloudWatch Logs might log request contents for fields that aren't considered\n sensitive, such as API request parameters for CloudWatch Logs actions. This provides\n debugging information for failed API requests.

\n ", + "smithy.api#title": "Amazon CloudWatch Logs", + "smithy.api#xmlNamespace": { + "uri": "http://monitoring.amazonaws.com/doc/2014-03-28/" + }, + "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 + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-east-1" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-west-1" + ] + } + ], + "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://logs-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://logs.us-gov-east-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://logs.us-gov-west-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://logs-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://logs.{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://logs.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "root": 2, + "nodeCount": 15, + "nodes": "/////wAAAAH/////AAAAAAAAAA4AAAADAAAAAQAAAAQF9eENAAAAAgAAAAUF9eENAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEMAAAABQX14QoF9eELAAAABAAAAAwAAAAJAAAABgAAAAoF9eEJAAAABwX14QYAAAALAAAACAX14QcF9eEIAAAABQAAAA0F9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAAPAAAABAX14QIF9eED" + }, + "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://logs-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": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-east-1" + ] + } + ], + "endpoint": { + "url": "https://logs.us-gov-east-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-west-1" + ] + } + ], + "endpoint": { + "url": "https://logs.us-gov-west-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://logs-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://logs.{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://logs.{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 af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.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://logs.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.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://logs.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://logs.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.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://logs.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.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://logs.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.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://logs-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://logs.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://logs-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.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://logs-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://logs-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://logs.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://logs-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://logs-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://logs.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.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://logs.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://logs-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 disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://logs.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs-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 disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://logs-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "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.cloudwatchlogs#LookupTable": { + "type": "structure", + "members": { + "lookupTableArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the lookup table.

" + } + }, + "lookupTableName": { + "target": "com.amazonaws.cloudwatchlogs#LookupTableName", + "traits": { + "smithy.api#documentation": "

The name of the lookup table.

" + } + }, + "description": { + "target": "com.amazonaws.cloudwatchlogs#LookupTableDescription", + "traits": { + "smithy.api#documentation": "

The description of the lookup table.

" + } + }, + "tableFields": { + "target": "com.amazonaws.cloudwatchlogs#TableFields", + "traits": { + "smithy.api#documentation": "

The column headers from the first row of the CSV file.

" + } + }, + "recordsCount": { + "target": "com.amazonaws.cloudwatchlogs#RecordsCount", + "traits": { + "smithy.api#documentation": "

The number of data rows in the lookup table, excluding the header row.

" + } + }, + "sizeBytes": { + "target": "com.amazonaws.cloudwatchlogs#StoredBytes", + "traits": { + "smithy.api#documentation": "

The size of the lookup table in bytes.

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

The time when the lookup table was last updated, expressed as the number of\n milliseconds after Jan 1, 1970 00:00:00 UTC.

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

The ARN of the KMS key used to encrypt the lookup table data, if\n applicable.

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

Contains metadata about a lookup table returned by DescribeLookupTables.

" + } + }, + "com.amazonaws.cloudwatchlogs#LookupTableConfiguration": { + "type": "structure", + "members": { + "tableName": { + "target": "com.amazonaws.cloudwatchlogs#LookupTableName", + "traits": { + "smithy.api#documentation": "

The name of the lookup table to create or update with query results. The name can\n contain only alphanumeric characters and underscores.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.cloudwatchlogs#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that grants permissions to create or update the lookup table\n with query results.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cloudwatchlogs#LookupTableDescription", + "traits": { + "smithy.api#documentation": "

A description of the lookup table.

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

The ARN of the KMS key to use to encrypt the lookup table data. If you\n don't specify a key, the data is encrypted with an Amazon Web Services-owned key.

" + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

Key-value pairs to associate with the lookup table for resource management and cost\n allocation. The service applies tags only during initial table creation.

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

Configuration for a lookup table destination. Use it to automatically refresh a lookup\n table with query results on a schedule.

" + } + }, + "com.amazonaws.cloudwatchlogs#LookupTableDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.cloudwatchlogs#LookupTableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_]+$" + } + }, + "com.amazonaws.cloudwatchlogs#LookupTables": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LookupTable" + } + }, + "com.amazonaws.cloudwatchlogs#LowerCaseString": { + "type": "structure", + "members": { + "withKeys": { + "target": "com.amazonaws.cloudwatchlogs#LowerCaseStringWithKeys", + "traits": { + "smithy.api#documentation": "

The array caontaining the keys of the fields to convert to lowercase.

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

This processor converts a string to lowercase.

\n

For more information about this processor including examples, see lowerCaseString in the CloudWatch Logs User Guide.

" + } + }, + "com.amazonaws.cloudwatchlogs#LowerCaseStringWithKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#WithKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.cloudwatchlogs#MalformedQueryException": { + "type": "structure", + "members": { + "queryCompileError": { + "target": "com.amazonaws.cloudwatchlogs#QueryCompileError" + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The query string is not valid. Details about this error are displayed in a\n QueryCompileError object. For more information, see QueryCompileError.

\n

For more information about valid query syntax, see CloudWatch Logs Insights Query\n Syntax.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#MappingVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#pattern": "^\\d+\\.\\d+(\\.\\d+)?$" + } + }, + "com.amazonaws.cloudwatchlogs#MatchPattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#MatchPatterns": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#MatchPattern" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.cloudwatchlogs#Message": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#MetricFilter": { + "type": "structure", + "members": { + "filterName": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "

The name of the metric filter.

" + } + }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern" + }, + "metricTransformations": { + "target": "com.amazonaws.cloudwatchlogs#MetricTransformations", + "traits": { + "smithy.api#documentation": "

The metric transformations.

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

The creation time of the metric filter, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC.

" + } + }, + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

" + } + }, + "applyOnTransformedLogs": { + "target": "com.amazonaws.cloudwatchlogs#ApplyOnTransformedLogs", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

This parameter is valid only for log groups that have an active log transformer. For more\n information about log transformers, see PutTransformer.

\n

If this value is true, the metric filter is applied on the transformed\n version of the log events instead of the original ingested log events.

" + } + }, + "fieldSelectionCriteria": { + "target": "com.amazonaws.cloudwatchlogs#FieldSelectionCriteria", + "traits": { + "smithy.api#documentation": "

The filter expression that specifies which log events are processed by this metric filter\n based on system fields. Returns the fieldSelectionCriteria value if it was\n specified when the metric filter was created.

" + } + }, + "emitSystemFieldDimensions": { + "target": "com.amazonaws.cloudwatchlogs#EmitSystemFields", + "traits": { + "smithy.api#documentation": "

The list of system fields that are emitted as additional dimensions in the generated\n metrics. Returns the emitSystemFieldDimensions value if it was specified when the\n metric filter was created.

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

Metric filters express how CloudWatch Logs would extract metric observations from\n ingested log events and transform them into metric data in a CloudWatch metric.

" + } + }, + "com.amazonaws.cloudwatchlogs#MetricFilterMatchRecord": { + "type": "structure", + "members": { + "eventNumber": { + "target": "com.amazonaws.cloudwatchlogs#EventNumber", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The event number.

" + } + }, + "eventMessage": { + "target": "com.amazonaws.cloudwatchlogs#EventMessage", + "traits": { + "smithy.api#documentation": "

The raw event data.

" + } + }, + "extractedValues": { + "target": "com.amazonaws.cloudwatchlogs#ExtractedValues", + "traits": { + "smithy.api#documentation": "

The values extracted from the event data by the filter.

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

Represents a matched event.

" + } + }, + "com.amazonaws.cloudwatchlogs#MetricFilterMatches": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#MetricFilterMatchRecord" + } + }, + "com.amazonaws.cloudwatchlogs#MetricFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#MetricFilter" + } + }, + "com.amazonaws.cloudwatchlogs#MetricName": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The name of the CloudWatch metric to which the monitored log information should be\n published. For example, you might publish to a metric named ErrorCount.

", + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[^:*$]*$" + } + }, + "com.amazonaws.cloudwatchlogs#MetricNamespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[^:*$]*$" + } + }, + "com.amazonaws.cloudwatchlogs#MetricTransformation": { + "type": "structure", + "members": { + "metricName": { + "target": "com.amazonaws.cloudwatchlogs#MetricName", + "traits": { + "smithy.api#documentation": "

The name of the CloudWatch metric.

", + "smithy.api#required": {} + } + }, + "metricNamespace": { + "target": "com.amazonaws.cloudwatchlogs#MetricNamespace", + "traits": { + "smithy.api#documentation": "

A custom namespace to contain your metric in CloudWatch. Use namespaces to group\n together metrics that are similar. For more information, see Namespaces.

", + "smithy.api#required": {} + } + }, + "metricValue": { + "target": "com.amazonaws.cloudwatchlogs#MetricValue", + "traits": { + "smithy.api#documentation": "

The value to publish to the CloudWatch metric when a filter pattern matches a log\n event.

", + "smithy.api#required": {} + } + }, + "defaultValue": { + "target": "com.amazonaws.cloudwatchlogs#DefaultValue", + "traits": { + "smithy.api#documentation": "

(Optional) The value to emit when a filter pattern does not match a log event. This\n value can be null.

" + } + }, + "dimensions": { + "target": "com.amazonaws.cloudwatchlogs#Dimensions", + "traits": { + "smithy.api#documentation": "

The fields to use as dimensions for the metric. One metric filter can include as many as\n three dimensions.

\n \n

Metrics extracted from log events are charged as custom metrics. To prevent unexpected\n high charges, do not specify high-cardinality fields such as IPAddress or\n requestID as dimensions. Each different value found for a dimension is\n treated as a separate metric and accrues charges as a separate custom metric.

\n

CloudWatch Logs disables a metric filter if it generates 1000 different name/value\n pairs for your specified dimensions within a certain amount of time. This helps to prevent\n accidental high charges.

\n

You can also set up a billing alarm to alert you if your charges are higher than\n expected. For more information, see \n Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.\n

\n " + } + }, + "unit": { + "target": "com.amazonaws.cloudwatchlogs#StandardUnit", + "traits": { + "smithy.api#documentation": "

The unit to assign to the metric. If you omit this, the unit is set as\n None.

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

Indicates how to transform ingested log events to metric data in a CloudWatch\n metric.

" + } + }, + "com.amazonaws.cloudwatchlogs#MetricTransformations": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#MetricTransformation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#MetricValue": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The value to publish to the CloudWatch metric. For example, if you're counting the\n occurrences of a term like Error, the value is 1 for each\n occurrence. If you're counting the bytes transferred, the value is the value in the log\n event.

", + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.cloudwatchlogs#MoveKeyEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#MoveKeyEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.cloudwatchlogs#MoveKeyEntry": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.cloudwatchlogs#Source", + "traits": { + "smithy.api#documentation": "

The key to move.

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

The key to move to.

", + "smithy.api#required": {} + } + }, + "overwriteIfExists": { + "target": "com.amazonaws.cloudwatchlogs#OverwriteIfExists", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether to overwrite the value if the destination key already exists. If you\n omit this, the default is false.

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

This object defines one key that will be moved with the moveKey processor.

" + } + }, + "com.amazonaws.cloudwatchlogs#MoveKeys": { + "type": "structure", + "members": { + "entries": { + "target": "com.amazonaws.cloudwatchlogs#MoveKeyEntries", + "traits": { + "smithy.api#documentation": "

An array of objects, where each object contains the information about one key to move.\n

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

This processor moves a key from one field to another. The original key is deleted.

\n

For more information about this processor including examples, see moveKeys in the CloudWatch Logs User Guide.

" + } + }, + "com.amazonaws.cloudwatchlogs#NextToken": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. The token expires after 24\n hours.

", + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#NonMatchValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cloudwatchlogs#OCSFVersion": { + "type": "enum", + "members": { + "V1_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "V1.1" + } + }, + "V1_5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "V1.5" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchApplication": { + "type": "structure", + "members": { + "applicationEndpoint": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchApplicationEndpoint", + "traits": { + "smithy.api#documentation": "

The endpoint of the application.

" + } + }, + "applicationArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the application.

" + } + }, + "applicationId": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchResourceStatus", + "traits": { + "smithy.api#documentation": "

This structure contains information about the status of this OpenSearch Service\n resource.

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

This structure contains information about the OpenSearch Service application used for this\n integration. An OpenSearch Service application is the web application created by the\n integration with CloudWatch Logs. It hosts the vended logs dashboards.

" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchApplicationEndpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^https://[\\.\\-_/#:A-Za-z0-9]+\\.com$" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchApplicationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchCollection": { + "type": "structure", + "members": { + "collectionEndpoint": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchCollectionEndpoint", + "traits": { + "smithy.api#documentation": "

The endpoint of the collection.

" + } + }, + "collectionArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the collection.

" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchResourceStatus", + "traits": { + "smithy.api#documentation": "

This structure contains information about the status of this OpenSearch Service\n resource.

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

This structure contains information about the OpenSearch Service collection used for this\n integration. An OpenSearch Service collection is a logical grouping of one or more indexes\n that represent an analytics workload. For more information, see Creating and\n managing OpenSearch Service Serverless collections.

" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchCollectionEndpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^https://[\\.\\-_/#:A-Za-z0-9]+\\.com$" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchDataAccessPolicy": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchPolicyName", + "traits": { + "smithy.api#documentation": "

The name of the data access policy.

" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchResourceStatus", + "traits": { + "smithy.api#documentation": "

This structure contains information about the status of this OpenSearch Service\n resource.

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

This structure contains information about the OpenSearch Service data access policy used\n for this integration. The access policy defines the access controls for the collection. This\n data access policy was automatically created as part of the integration setup. For more\n information about OpenSearch Service data access policies, see Data access\n control for Amazon OpenSearch Serverless in the OpenSearch Service Developer\n Guide.

" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchDataSource": { + "type": "structure", + "members": { + "dataSourceName": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchDataSourceName", + "traits": { + "smithy.api#documentation": "

The name of the OpenSearch Service data source.

" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchResourceStatus", + "traits": { + "smithy.api#documentation": "

This structure contains information about the status of this OpenSearch Service\n resource.

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

This structure contains information about the OpenSearch Service data source used for this\n integration. This data source was created as part of the integration setup. An OpenSearch Service data source defines the source and destination for OpenSearch Service queries. It\n includes the role required to execute queries and write to collections.

\n

For more information about OpenSearch Service data sources , see Creating\n OpenSearch Service data source integrations with Amazon S3.\n

" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchDataSourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchEncryptionPolicy": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchPolicyName", + "traits": { + "smithy.api#documentation": "

The name of the encryption policy.

" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchResourceStatus", + "traits": { + "smithy.api#documentation": "

This structure contains information about the status of this OpenSearch Service\n resource.

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

This structure contains information about the OpenSearch Service encryption policy used\n for this integration. The encryption policy was created automatically when you created the\n integration. For more information, see Encryption policies in the OpenSearch Service Developer Guide.

" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchIntegrationDetails": { + "type": "structure", + "members": { + "dataSource": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchDataSource", + "traits": { + "smithy.api#documentation": "

This structure contains information about the OpenSearch Service data source used for this\n integration. This data source was created as part of the integration setup. An OpenSearch Service data source defines the source and destination for OpenSearch Service queries. It\n includes the role required to execute queries and write to collections.

\n

For more information about OpenSearch Service data sources , see Creating\n OpenSearch Service data source integrations with Amazon S3.\n

" + } + }, + "application": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchApplication", + "traits": { + "smithy.api#documentation": "

This structure contains information about the OpenSearch Service application used for this\n integration. An OpenSearch Service application is the web application that was created by the\n integration with CloudWatch Logs. It hosts the vended logs dashboards.

" + } + }, + "collection": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchCollection", + "traits": { + "smithy.api#documentation": "

This structure contains information about the OpenSearch Service collection used for this\n integration. This collection was created as part of the integration setup. An OpenSearch Service collection is a logical grouping of one or more indexes that represent an analytics\n workload. For more information, see Creating and\n managing OpenSearch Service Serverless collections.

" + } + }, + "workspace": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchWorkspace", + "traits": { + "smithy.api#documentation": "

This structure contains information about the OpenSearch Service workspace used for this\n integration. An OpenSearch Service workspace is the collection of dashboards along with other\n OpenSearch Service tools. This workspace was created automatically as part of the\n integration setup. For more information, see Centralized OpenSearch user\n interface (Dashboards) with OpenSearch Service.

" + } + }, + "encryptionPolicy": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchEncryptionPolicy", + "traits": { + "smithy.api#documentation": "

This structure contains information about the OpenSearch Service encryption policy used\n for this integration. The encryption policy was created automatically when you created the\n integration. For more information, see Encryption policies in the OpenSearch Service Developer Guide.

" + } + }, + "networkPolicy": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchNetworkPolicy", + "traits": { + "smithy.api#documentation": "

This structure contains information about the OpenSearch Service network policy used for\n this integration. The network policy assigns network access settings to collections. For more\n information, see Network policies in the OpenSearch Service Developer Guide.

" + } + }, + "accessPolicy": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchDataAccessPolicy", + "traits": { + "smithy.api#documentation": "

This structure contains information about the OpenSearch Service data access policy used\n for this integration. The access policy defines the access controls for the collection. This\n data access policy was automatically created as part of the integration setup. For more\n information about OpenSearch Service data access policies, see Data access\n control for Amazon OpenSearch Serverless in the OpenSearch Service Developer\n Guide.

" + } + }, + "lifecyclePolicy": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchLifecyclePolicy", + "traits": { + "smithy.api#documentation": "

This structure contains information about the OpenSearch Service data lifecycle policy\n used for this integration. The lifecycle policy determines the lifespan of the data in the\n collection. It was automatically created as part of the integration setup.

\n

For more information, see Using data\n lifecycle policies with OpenSearch Service Serverless in the OpenSearch Service\n Developer Guide.

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

This structure contains complete information about one CloudWatch Logs integration.\n This structure is returned by a GetIntegration operation.

" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchLifecyclePolicy": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchPolicyName", + "traits": { + "smithy.api#documentation": "

The name of the lifecycle policy.

" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchResourceStatus", + "traits": { + "smithy.api#documentation": "

This structure contains information about the status of this OpenSearch Service\n resource.

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

This structure contains information about the OpenSearch Service data lifecycle policy\n used for this integration. The lifecycle policy determines the lifespan of the data in the\n collection. It was automatically created as part of the integration setup.

\n

For more information, see Using data\n lifecycle policies with OpenSearch Service Serverless in the OpenSearch Service\n Developer Guide.

" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchNetworkPolicy": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchPolicyName", + "traits": { + "smithy.api#documentation": "

The name of the network policy.

" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchResourceStatus", + "traits": { + "smithy.api#documentation": "

This structure contains information about the status of this OpenSearch Service\n resource.

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

This structure contains information about the OpenSearch Service network policy used for\n this integration. The network policy assigns network access settings to collections. For more\n information, see Network policies in the OpenSearch Service Developer Guide.

" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchPolicyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchResourceConfig": { + "type": "structure", + "members": { + "kmsKeyArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

To have the vended dashboard data encrypted with KMS instead of the CloudWatch Logs default encryption method, specify the ARN of the KMS key that you\n want to use.

" + } + }, + "dataSourceRoleArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

Specify the ARN of an IAM role that CloudWatch Logs will use to create\n the integration. This role must have the permissions necessary to access the OpenSearch Service collection to be able to create the dashboards. For more information about the permissions\n needed, see Permissions that\n the integration needs in the CloudWatch Logs User Guide.

", + "smithy.api#required": {} + } + }, + "dashboardViewerPrincipals": { + "target": "com.amazonaws.cloudwatchlogs#DashboardViewerPrincipals", + "traits": { + "smithy.api#documentation": "

Specify the ARNs of IAM roles and IAM users who you want to\n grant permission to for viewing the dashboards.

\n \n

In addition to specifying these users here, you must also grant them the CloudWatchOpenSearchDashboardAccess\n IAM policy. For more information, see IAM policies for\n users.

\n ", + "smithy.api#required": {} + } + }, + "applicationArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

If you want to use an existing OpenSearch Service application for your integration with\n OpenSearch Service, specify it here. If you omit this, a new application will be\n created.

" + } + }, + "retentionDays": { + "target": "com.amazonaws.cloudwatchlogs#CollectionRetentionDays", + "traits": { + "smithy.api#documentation": "

Specify how many days that you want the data derived by OpenSearch Service to be retained\n in the index that the dashboard refers to. This also sets the maximum time period that you can\n choose when viewing data in the dashboard. Choosing a longer time frame will incur additional\n costs.

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

This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service.

" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchResourceStatus": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchResourceStatusType", + "traits": { + "smithy.api#documentation": "

The current status of this resource.

" + } + }, + "statusMessage": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationStatusMessage", + "traits": { + "smithy.api#documentation": "

A message with additional information about the status of this resource.

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

This structure contains information about the status of an OpenSearch Service\n resource.

" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchResourceStatusType": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_FOUND" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchWorkspace": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchWorkspaceId", + "traits": { + "smithy.api#documentation": "

The ID of this workspace.

" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchResourceStatus", + "traits": { + "smithy.api#documentation": "

This structure contains information about the status of an OpenSearch Service\n resource.

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

This structure contains information about the OpenSearch Service workspace used for this\n integration. An OpenSearch Service workspace is the collection of dashboards along with other\n OpenSearch Service tools. This workspace was created automatically as part of the\n integration setup. For more information, see Centralized OpenSearch user\n interface (Dashboards) with OpenSearch Service.

" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchWorkspaceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" + } + }, + "com.amazonaws.cloudwatchlogs#OperationAbortedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

Multiple concurrent requests to update the same resource were in conflict.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#OrderBy": { + "type": "enum", + "members": { + "LogStreamName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LogStreamName" + } + }, + "LastEventTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastEventTime" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#OutputFormat": { + "type": "enum", + "members": { + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "json" + } + }, + "PLAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "plain" + } + }, + "W3C": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "w3c" + } + }, + "RAW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "raw" + } + }, + "PARQUET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "parquet" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#OutputFormats": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#OutputFormat" + } + }, + "com.amazonaws.cloudwatchlogs#OutputLogEvent": { + "type": "structure", + "members": { + "timestamp": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the event occurred, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC.

" + } + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#EventMessage", + "traits": { + "smithy.api#documentation": "

The data contained in the log event.

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

The time the event was ingested, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC.

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

Represents a log event.

" + } + }, + "com.amazonaws.cloudwatchlogs#OutputLogEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#OutputLogEvent" + } + }, + "com.amazonaws.cloudwatchlogs#OverwriteIfExists": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.cloudwatchlogs#ParseCloudfront": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.cloudwatchlogs#Source", + "traits": { + "smithy.api#documentation": "

Omit this parameter and the whole log message will be processed by this processor. No\n other value than @message is allowed for source.

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

This processor parses CloudFront vended logs, extract fields, and convert them into\n JSON format. Encoded field values are decoded. Values that are integers and doubles are\n treated as such. For more information about this processor including examples, see parseCloudfront\n

\n

For more information about CloudFront log format, see Configure and use standard\n logs (access logs).

\n

If you use this processor, it must be the first processor in your transformer.

" + } + }, + "com.amazonaws.cloudwatchlogs#ParseJSON": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.cloudwatchlogs#Source", + "traits": { + "smithy.api#documentation": "

Path to the field in the log event that will be parsed. Use dot notation to access child\n fields. For example, store.book\n

" + } + }, + "destination": { + "target": "com.amazonaws.cloudwatchlogs#DestinationField", + "traits": { + "smithy.api#documentation": "

The location to put the parsed key value pair into. If you omit this parameter, it is\n placed under the root node.

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

This processor parses log events that are in JSON format. It can extract JSON key-value\n pairs and place them under a destination that you specify.

\n

Additionally, because you must have at least one parse-type processor in a transformer,\n you can use ParseJSON as that processor for JSON-format logs, so that you can\n also apply other processors, such as mutate processors, to these logs.

\n

For more information about this processor including examples, see parseJSON in the CloudWatch Logs User Guide.

" + } + }, + "com.amazonaws.cloudwatchlogs#ParseKeyValue": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.cloudwatchlogs#Source", + "traits": { + "smithy.api#documentation": "

Path to the field in the log event that will be parsed. Use dot notation to access child\n fields. For example, store.book\n

" + } + }, + "destination": { + "target": "com.amazonaws.cloudwatchlogs#DestinationField", + "traits": { + "smithy.api#documentation": "

The destination field to put the extracted key-value pairs into

" + } + }, + "fieldDelimiter": { + "target": "com.amazonaws.cloudwatchlogs#ParserFieldDelimiter", + "traits": { + "smithy.api#documentation": "

The field delimiter string that is used between key-value pairs in the original log\n events. If you omit this, the ampersand & character is used.

" + } + }, + "keyValueDelimiter": { + "target": "com.amazonaws.cloudwatchlogs#KeyValueDelimiter", + "traits": { + "smithy.api#documentation": "

The delimiter string to use between the key and value in each pair in the transformed log\n event.

\n

If you omit this, the equal = character is used.

" + } + }, + "keyPrefix": { + "target": "com.amazonaws.cloudwatchlogs#KeyPrefix", + "traits": { + "smithy.api#documentation": "

If you want to add a prefix to all transformed keys, specify it here.

" + } + }, + "nonMatchValue": { + "target": "com.amazonaws.cloudwatchlogs#NonMatchValue", + "traits": { + "smithy.api#documentation": "

A value to insert into the value field in the result, when a key-value pair is not\n successfully split.

" + } + }, + "overwriteIfExists": { + "target": "com.amazonaws.cloudwatchlogs#OverwriteIfExists", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether to overwrite the value if the destination key already exists. If you\n omit this, the default is false.

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

This processor parses a specified field in the original log event into key-value pairs.

\n

For more information about this processor including examples, see parseKeyValue in the CloudWatch Logs User Guide.

" + } + }, + "com.amazonaws.cloudwatchlogs#ParsePostgres": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.cloudwatchlogs#Source", + "traits": { + "smithy.api#documentation": "

Omit this parameter and the whole log message will be processed by this processor. No\n other value than @message is allowed for source.

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

Use this processor to parse RDS for PostgreSQL vended logs, extract fields, and\n and convert them into a JSON format. This processor always processes the entire log event\n message. For more information about this processor including examples, see parsePostGres.

\n

For more information about RDS for PostgreSQL log format, see \n RDS for PostgreSQL database log filesTCP flag sequence.

\n \n

If you use this processor, it must be the first processor in your transformer.

\n " + } + }, + "com.amazonaws.cloudwatchlogs#ParseRoute53": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.cloudwatchlogs#Source", + "traits": { + "smithy.api#documentation": "

Omit this parameter and the whole log message will be processed by this processor. No\n other value than @message is allowed for source.

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

Use this processor to parse Route 53 vended logs, extract fields, and and\n convert them into a JSON format. This processor always processes the entire log event message.\n For more information about this processor including examples, see parseRoute53.

\n \n

If you use this processor, it must be the first processor in your transformer.

\n " + } + }, + "com.amazonaws.cloudwatchlogs#ParseToOCSF": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.cloudwatchlogs#Source", + "traits": { + "smithy.api#documentation": "

The path to the field in the log event that you want to parse. If you omit this value, the\n whole log message is parsed.

" + } + }, + "eventSource": { + "target": "com.amazonaws.cloudwatchlogs#EventSource", + "traits": { + "smithy.api#documentation": "

Specify the service or process that produces the log events that will be converted with\n this processor.

", + "smithy.api#required": {} + } + }, + "ocsfVersion": { + "target": "com.amazonaws.cloudwatchlogs#OCSFVersion", + "traits": { + "smithy.api#documentation": "

Specify which version of the OCSF schema to use for the transformed log events.

", + "smithy.api#required": {} + } + }, + "mappingVersion": { + "target": "com.amazonaws.cloudwatchlogs#MappingVersion", + "traits": { + "smithy.api#documentation": "

The version of the OCSF mapping to use for parsing log data.

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

This processor converts logs into Open Cybersecurity Schema\n Framework (OCSF) events.

\n

For more information about this processor including examples, see parseToOCSF in the CloudWatch Logs User Guide.

" + } + }, + "com.amazonaws.cloudwatchlogs#ParseVPC": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.cloudwatchlogs#Source", + "traits": { + "smithy.api#documentation": "

Omit this parameter and the whole log message will be processed by this processor. No\n other value than @message is allowed for source.

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

Use this processor to parse Amazon VPC vended logs, extract fields, and and\n convert them into a JSON format. This processor always processes the entire log event\n message.

\n

This processor doesn't support custom log formats, such as NAT gateway logs. For more\n information about custom log formats in Amazon VPC, see \n parseVPC For more information about this processor including examples, see parseVPC.

\n \n

If you use this processor, it must be the first processor in your transformer.

\n " + } + }, + "com.amazonaws.cloudwatchlogs#ParseWAF": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.cloudwatchlogs#Source", + "traits": { + "smithy.api#documentation": "

Omit this parameter and the whole log message will be processed by this processor. No\n other value than @message is allowed for source.

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

Use this processor to parse WAF vended logs, extract fields, and and\n convert them into a JSON format. This processor always processes the entire log event message.\n For more information about this processor including examples, see parseWAF.

\n

For more information about WAF log format, see Log examples for web ACL\n traffic.

\n \n

If you use this processor, it must be the first processor in your transformer.

\n " + } + }, + "com.amazonaws.cloudwatchlogs#ParserFieldDelimiter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cloudwatchlogs#PatternId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 32, + "max": 32 + } + } + }, + "com.amazonaws.cloudwatchlogs#PatternRegex": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#PatternString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#PatternToken": { + "type": "structure", + "members": { + "dynamicTokenPosition": { + "target": "com.amazonaws.cloudwatchlogs#DynamicTokenPosition", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

For a dynamic token, this indicates where in the pattern that this token appears, related\n to other dynamic tokens. The dynamic token that appears first has a value of 1,\n the one that appears second is 2, and so on.

" + } + }, + "isDynamic": { + "target": "com.amazonaws.cloudwatchlogs#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether this is a dynamic token.

" + } + }, + "tokenString": { + "target": "com.amazonaws.cloudwatchlogs#TokenString", + "traits": { + "smithy.api#documentation": "

The string represented by this token. If this is a dynamic token, the value will be\n <*>\n

" + } + }, + "enumerations": { + "target": "com.amazonaws.cloudwatchlogs#Enumerations", + "traits": { + "smithy.api#documentation": "

Contains the values found for a dynamic token, and the number of times each value was\n found.

" + } + }, + "inferredTokenName": { + "target": "com.amazonaws.cloudwatchlogs#InferredTokenName", + "traits": { + "smithy.api#documentation": "

A name that CloudWatch Logs assigned to this dynamic token to make the pattern more\n readable. The string part of the inferredTokenName gives you a clearer idea of\n the content of this token. The number part of the inferredTokenName shows where\n in the pattern this token appears, compared to other dynamic tokens. CloudWatch Logs\n assigns the string part of the name based on analyzing the content of the log events that\n contain it.

\n

For example, an inferred token name of IPAddress-3 means that the token\n represents an IP address, and this token is the third dynamic token in the pattern.

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

A structure that contains information about one pattern token related to an\n anomaly.

\n

For more information about patterns and tokens, see CreateLogAnomalyDetector.

" + } + }, + "com.amazonaws.cloudwatchlogs#PatternTokens": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#PatternToken" + } + }, + "com.amazonaws.cloudwatchlogs#Percentage": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.cloudwatchlogs#Policy": { + "type": "structure", + "members": { + "deliveryDestinationPolicy": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationPolicy", + "traits": { + "smithy.api#documentation": "

The contents of the delivery destination policy.

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

A structure that contains information about one delivery destination policy.

" + } + }, + "com.amazonaws.cloudwatchlogs#PolicyDocument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 51200 + } + } + }, + "com.amazonaws.cloudwatchlogs#PolicyName": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#PolicyScope": { + "type": "enum", + "members": { + "ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT" + } + }, + "RESOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#PolicyType": { + "type": "enum", + "members": { + "DATA_PROTECTION_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_PROTECTION_POLICY" + } + }, + "SUBSCRIPTION_FILTER_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBSCRIPTION_FILTER_POLICY" + } + }, + "FIELD_INDEX_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIELD_INDEX_POLICY" + } + }, + "TRANSFORMER_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSFORMER_POLICY" + } + }, + "METRIC_EXTRACTION_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "METRIC_EXTRACTION_POLICY" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#Priority": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#Processor": { + "type": "structure", + "members": { + "addKeys": { + "target": "com.amazonaws.cloudwatchlogs#AddKeys", + "traits": { + "smithy.api#documentation": "

Use this parameter to include the addKeys processor in your transformer.

" + } + }, + "copyValue": { + "target": "com.amazonaws.cloudwatchlogs#CopyValue", + "traits": { + "smithy.api#documentation": "

Use this parameter to include the copyValue processor in your transformer.

" + } + }, + "csv": { + "target": "com.amazonaws.cloudwatchlogs#CSV", + "traits": { + "smithy.api#documentation": "

Use this parameter to include the CSV processor in your transformer.

" + } + }, + "dateTimeConverter": { + "target": "com.amazonaws.cloudwatchlogs#DateTimeConverter", + "traits": { + "smithy.api#documentation": "

Use this parameter to include the datetimeConverter processor in your transformer.

" + } + }, + "deleteKeys": { + "target": "com.amazonaws.cloudwatchlogs#DeleteKeys", + "traits": { + "smithy.api#documentation": "

Use this parameter to include the deleteKeys processor in your transformer.

" + } + }, + "grok": { + "target": "com.amazonaws.cloudwatchlogs#Grok", + "traits": { + "smithy.api#documentation": "

Use this parameter to include the grok processor in your transformer.

" + } + }, + "listToMap": { + "target": "com.amazonaws.cloudwatchlogs#ListToMap", + "traits": { + "smithy.api#documentation": "

Use this parameter to include the listToMap processor in your transformer.

" + } + }, + "lowerCaseString": { + "target": "com.amazonaws.cloudwatchlogs#LowerCaseString", + "traits": { + "smithy.api#documentation": "

Use this parameter to include the lowerCaseString processor in your transformer.

" + } + }, + "moveKeys": { + "target": "com.amazonaws.cloudwatchlogs#MoveKeys", + "traits": { + "smithy.api#documentation": "

Use this parameter to include the moveKeys processor in your transformer.

" + } + }, + "parseCloudfront": { + "target": "com.amazonaws.cloudwatchlogs#ParseCloudfront", + "traits": { + "smithy.api#documentation": "

Use this parameter to include the parseCloudfront processor in your transformer.

\n

If you use this processor, it must be the first processor in your transformer.

" + } + }, + "parseJSON": { + "target": "com.amazonaws.cloudwatchlogs#ParseJSON", + "traits": { + "smithy.api#documentation": "

Use this parameter to include the parseJSON processor in your transformer.

" + } + }, + "parseKeyValue": { + "target": "com.amazonaws.cloudwatchlogs#ParseKeyValue", + "traits": { + "smithy.api#documentation": "

Use this parameter to include the parseKeyValue processor in your transformer.

" + } + }, + "parseRoute53": { + "target": "com.amazonaws.cloudwatchlogs#ParseRoute53", + "traits": { + "smithy.api#documentation": "

Use this parameter to include the parseRoute53 processor in your transformer.

\n

If you use this processor, it must be the first processor in your transformer.

" + } + }, + "parseToOCSF": { + "target": "com.amazonaws.cloudwatchlogs#ParseToOCSF", + "traits": { + "smithy.api#documentation": "

Use this parameter to convert logs into Open Cybersecurity Schema (OCSF) format.

" + } + }, + "parsePostgres": { + "target": "com.amazonaws.cloudwatchlogs#ParsePostgres", + "traits": { + "smithy.api#documentation": "

Use this parameter to include the parsePostGres processor in your transformer.

\n

If you use this processor, it must be the first processor in your transformer.

" + } + }, + "parseVPC": { + "target": "com.amazonaws.cloudwatchlogs#ParseVPC", + "traits": { + "smithy.api#documentation": "

Use this parameter to include the parseVPC processor in your transformer.

\n

If you use this processor, it must be the first processor in your transformer.

" + } + }, + "parseWAF": { + "target": "com.amazonaws.cloudwatchlogs#ParseWAF", + "traits": { + "smithy.api#documentation": "

Use this parameter to include the parseWAF processor in your transformer.

\n

If you use this processor, it must be the first processor in your transformer.

" + } + }, + "renameKeys": { + "target": "com.amazonaws.cloudwatchlogs#RenameKeys", + "traits": { + "smithy.api#documentation": "

Use this parameter to include the renameKeys processor in your transformer.

" + } + }, + "splitString": { + "target": "com.amazonaws.cloudwatchlogs#SplitString", + "traits": { + "smithy.api#documentation": "

Use this parameter to include the splitString processor in your transformer.

" + } + }, + "substituteString": { + "target": "com.amazonaws.cloudwatchlogs#SubstituteString", + "traits": { + "smithy.api#documentation": "

Use this parameter to include the substituteString processor in your transformer.

" + } + }, + "trimString": { + "target": "com.amazonaws.cloudwatchlogs#TrimString", + "traits": { + "smithy.api#documentation": "

Use this parameter to include the trimString processor in your transformer.

" + } + }, + "typeConverter": { + "target": "com.amazonaws.cloudwatchlogs#TypeConverter", + "traits": { + "smithy.api#documentation": "

Use this parameter to include the typeConverter processor in your transformer.

" + } + }, + "upperCaseString": { + "target": "com.amazonaws.cloudwatchlogs#UpperCaseString", + "traits": { + "smithy.api#documentation": "

Use this parameter to include the upperCaseString processor in your transformer.

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

This structure contains the information about one processor in a log transformer.

" + } + }, + "com.amazonaws.cloudwatchlogs#Processors": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#Processor" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.cloudwatchlogs#PutAccountPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutAccountPolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutAccountPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an account-level data protection policy, subscription filter policy, field index\n policy, transformer policy, or metric extraction policy that applies to all log groups, a\n subset of log groups, or a data source name and type combination in the account.

\n \n

\n PutAccountPolicy is an account-wide administrative operation intended for\n CloudWatch Logs administrators. Because it affects all log groups (or a broad subset) in\n the account, you should grant logs:PutAccountPolicy permissions only to\n administrators who manage logging configuration across the account, not to application teams\n or individual log group owners.

\n \n

\n Conflict resolution between account-level and log-group-level\n policies\n

\n

When both an account-level policy and a log-group-level policy of the same type apply to a\n log group, the resolution depends on the policy type:

\n
    \n
  • \n

    \n Data protection — The two policies are cumulative. Any sensitive\n term specified in either the account-level or the log-group-level policy is masked.

    \n
    • \n
  • \n

    \n Subscription filters — Account-level and log-group-level\n subscription filters are additive. A log group can have up to 1 account-level and up to 2\n log-group-level subscription filters.

    \n
    • \n
  • \n

    \n Transformers — A log-group-level transformer overrides the\n account-level transformer. If a log group has its own transformer, it ignores the\n account-level transformer policy.

    \n
    • \n
  • \n

    \n Field index policies — If a log group has its own field index\n policy (created with PutIndexPolicy), any account-level policy that uses\n LogGroupNamePrefix selection criteria or has no selection criteria is ignored\n for that log group. However, account-level policies that use DataSourceName\n and DataSourceType selection criteria still apply alongside the log-group-level\n policy.

    \n
    • \n
  • \n

    \n Metric extraction policies — Metric extraction policies are\n account-level only and have no log-group-level equivalent, so no conflict resolution\n applies.

    \n
    • \n
\n

For field index policies, you can configure indexed fields as facets\n to enable interactive exploration of your logs. Facets provide value distributions and counts\n for indexed fields in the CloudWatch Logs Insights console without requiring query\n execution. For more information, see Use facets to group and\n explore logs.

\n

To use this operation, you must be signed on with the correct permissions depending on the\n type of policy that you are creating.

\n
    \n
  • \n

    To create a data protection policy, you must have the\n logs:PutDataProtectionPolicy and logs:PutAccountPolicy\n permissions.

    \n
    • \n
  • \n

    To create a subscription filter policy, you must have the\n logs:PutSubscriptionFilter and logs:PutAccountPolicy\n permissions.

    \n
    • \n
  • \n

    To create a transformer policy, you must have the logs:PutTransformer and\n logs:PutAccountPolicy permissions.

    \n
    • \n
  • \n

    To create a field index policy, you must have the logs:PutIndexPolicy and\n logs:PutAccountPolicy permissions.

    \n
    • \n
  • \n

    To configure facets for field index policies, you must have the\n logs:PutIndexPolicy and logs:PutAccountPolicy\n permissions.

    \n
    • \n
  • \n

    To create a metric extraction policy, you must have the\n logs:PutMetricExtractionPolicy and logs:PutAccountPolicy\n permissions.

    \n
    • \n
\n

\n Data protection policy\n

\n

A data protection policy can help safeguard sensitive data that's ingested by your log\n groups by auditing and masking the sensitive log data. Each account can have only one\n account-level data protection policy.

\n \n

Sensitive data is detected and masked when it is ingested into a log group. When you set\n a data protection policy, log events ingested into the log groups before that time are not\n masked.

\n \n

If you use PutAccountPolicy to create a data protection policy for your whole\n account, it applies to both existing log groups and all log groups that are created later in\n this account. The account-level policy is applied to existing log groups with eventual\n consistency. It might take up to 5 minutes before sensitive data in existing log groups begins\n to be masked.

\n

By default, when a user views a log event that includes masked data, the sensitive data is\n replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to\n true to view the unmasked log events. Users with the logs:Unmask\n can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs\n Insights query with the unmask query command.

\n

For more information, including a list of types of data that can be audited and masked,\n see Protect sensitive log data\n with masking.

\n

To use the PutAccountPolicy operation for a data protection policy, you must\n be signed on with the logs:PutDataProtectionPolicy and\n logs:PutAccountPolicy permissions.

\n

The PutAccountPolicy operation applies to all log groups in the account. You\n can use PutDataProtectionPolicy to create a data protection policy that applies to just one\n log group. If a log group has its own data protection policy and the account also has an\n account-level data protection policy, then the two policies are cumulative. Any sensitive term\n specified in either policy is masked.

\n

\n Subscription filter policy\n

\n

A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services. Account-level subscription filter policies apply to\n both existing log groups and log groups that are created later in this account. Supported\n destinations are Kinesis Data Streams, Firehose, and Lambda. When log\n events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP\n format.

\n

The following destinations are supported for subscription filters:

\n
    \n
  • \n

    An Kinesis Data Streams data stream in the same account as the subscription policy, for\n same-account delivery.

    \n
    • \n
  • \n

    An Firehose data stream in the same account as the subscription policy, for\n same-account delivery.

    \n
    • \n
  • \n

    A Lambda function in the same account as the subscription policy, for\n same-account delivery.

    \n
    • \n
  • \n

    A logical destination in a different account created with PutDestination, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations.

    \n
    • \n
\n

Each account can have one account-level subscription filter policy per Region. If you are\n updating an existing filter, you must specify the correct name in PolicyName. To\n perform a PutAccountPolicy subscription filter operation for any destination\n except a Lambda function, you must also have the iam:PassRole\n permission.

\n

\n Transformer policy\n

\n

Creates or updates a log transformer policy for your account. You use\n log transformers to transform log events into a different format, making them easier for you\n to process and analyze. You can also transform logs from different sources into standardized\n formats that contain relevant, source-specific information. After you have created a\n transformer, CloudWatch Logs performs this transformation at the time of log ingestion. You\n can then refer to the transformed versions of the logs during operations such as querying with\n CloudWatch Logs Insights or creating metric filters or subscription filters.

\n

You can also use a transformer to copy metadata from metadata keys into the log events\n themselves. This metadata can include log group name, log stream name, account ID and\n Region.

\n

A transformer for a log group is a series of processors, where each processor applies one\n type of transformation to the log events ingested into this log group. For more information\n about the available processors to use in a transformer, see Processors that you can use.

\n

Having log events in standardized format enables visibility across your applications for\n your log analysis, reporting, and alarming needs. CloudWatch Logs provides transformation\n for common log types with out-of-the-box transformation templates for major Amazon Web Services\n log sources such as VPC flow logs, Lambda, and Amazon RDS. You can use\n pre-built transformation templates or create custom transformation policies.

\n

You can create transformers only for the log groups in the Standard log class.

\n

You can have one account-level transformer policy that applies to all log groups in the\n account. Or you can create as many as 20 account-level transformer policies that are each\n scoped to a subset of log groups with the selectionCriteria parameter. If you\n have multiple account-level transformer policies with selection criteria, no two of them can\n use the same or overlapping log group name prefixes. For example, if you have one policy\n filtered to log groups that start with my-log, you can't have another transformer\n policy filtered to my-logpprod or my-logging.

\n

You can also set up a transformer at the log-group level. For more information, see PutTransformer. If there is both a log-group level transformer created with\n PutTransformer and an account-level transformer that could apply to the same\n log group, the log group uses only the log-group level transformer. It ignores the\n account-level transformer.

\n

\n Field index policy\n

\n

You can use field index policies to create indexes on fields found in log events for a log\n group or data source name and type combination. Creating field indexes can help lower the scan\n volume for CloudWatch Logs Insights queries that reference those fields, because these\n queries attempt to skip the processing of log events that are known to not match the indexed\n field. Good fields to index are fields that you often need to query for and fields or values\n that match only a small fraction of the total log events. Common examples of indexes include\n request ID, session ID, user IDs, or instance IDs. For more information, see Create field indexes to improve query performance and reduce costs\n

\n

To find the fields that are in your log group events, use the GetLogGroupFields operation. To find the fields for a data source use the GetLogFields operation.

\n

For example, suppose you have created a field index for requestId. Then, any\n CloudWatch Logs Insights query on that log group that includes requestId =\n value\n or requestId in [value,\n value, ...] will attempt to process only the log events where\n the indexed field matches the specified value.

\n

Matches of log events to the names of indexed fields are case-sensitive. For example, an\n indexed field of RequestId won't match a log event containing\n requestId.

\n

You can have one account-level field index policy that applies to all log groups in the\n account. Or you can create as many as 20 account-level field index policies that are each\n scoped to a subset of log groups using LogGroupNamePrefix with the\n selectionCriteria parameter. You can have another 20 account-level field index\n policies using DataSourceName and DataSourceType for the\n selectionCriteria parameter. If you have multiple account-level index policies\n with LogGroupNamePrefix selection criteria, no two of them can use the same or\n overlapping log group name prefixes. For example, if you have one policy filtered to log\n groups that start with my-log, you can't have another field index policy\n filtered to my-logpprod or my-logging. Similarly, if\n you have multiple account-level index policies with DataSourceName and\n DataSourceType selection criteria, no two of them can use the same data source\n name and type combination. For example, if you have one policy filtered to the data source\n name amazon_vpc and data source type flow you cannot create another\n policy with this combination.

\n

If you create an account-level field index policy in a monitoring account in cross-account\n observability, the policy is applied only to the monitoring account and not to any source\n accounts.

\n

CloudWatch Logs provides default field indexes for all log groups in the Standard log\n class. Default field indexes are automatically available for the following fields:

\n
    \n
  • \n

    \n @logStream\n

    \n
    • \n
  • \n

    \n @aws.region\n

    \n
    • \n
  • \n

    \n @aws.account\n

    \n
    • \n
  • \n

    \n @source.log\n

    \n
    • \n
  • \n

    \n @data_source_name\n

    \n
    • \n
  • \n

    \n @data_source_type\n

    \n
    • \n
  • \n

    \n @data_format\n

    \n
    • \n
  • \n

    \n traceId\n

    \n
    • \n
  • \n

    \n severityText\n

    \n
    • \n
  • \n

    \n attributes.session.id\n

    \n
    • \n
\n

CloudWatch Logs provides default field indexes for certain data source name and type\n combinations as well. Default field indexes are automatically available for the following data\n source name and type combinations as identified in the following list:

\n

\n amazon_vpc.flow\n

\n
    \n
  • \n

    \n action\n

    \n
    • \n
  • \n

    \n logStatus\n

    \n
    • \n
  • \n

    \n region\n

    \n
    • \n
  • \n

    \n flowDirection\n

    \n
    • \n
  • \n

    \n type\n

    \n
    • \n
\n

\n amazon_route53.resolver_query\n

\n
    \n
  • \n

    \n transport\n

    \n
    • \n
  • \n

    \n rcode\n

    \n
    • \n
\n

\n aws_waf.access\n

\n
    \n
  • \n

    \n action\n

    \n
    • \n
  • \n

    \n httpRequest.country\n

    \n
    • \n
\n

\n aws_cloudtrail.data, aws_cloudtrail.management\n

\n
    \n
  • \n

    \n eventSource\n

    \n
    • \n
  • \n

    \n eventName\n

    \n
    • \n
  • \n

    \n awsRegion\n

    \n
    • \n
  • \n

    \n userAgent\n

    \n
    • \n
  • \n

    \n errorCode\n

    \n
    • \n
  • \n

    \n eventType\n

    \n
    • \n
  • \n

    \n managementEvent\n

    \n
    • \n
  • \n

    \n readOnly\n

    \n
    • \n
  • \n

    \n eventCategory\n

    \n
    • \n
  • \n

    \n requestId\n

    \n
    • \n
\n

Default field indexes are in addition to any custom field indexes you define within your\n policy. Default field indexes are not counted towards your field index\n quota.

\n

If you want to create a field index policy for a single log group, you can use PutIndexPolicy instead of PutAccountPolicy. If you do so, that log\n group will use that log-group level policy and any account-level policies that match at the\n data source level; any account-level policy that matches at the log group level (for example,\n no selection criteria or log group name prefix selection criteria) will be ignored.

\n

\n Metric extraction policy\n

\n

A metric extraction policy controls whether CloudWatch Metrics can be created through the\n Embedded Metrics Format (EMF) for log groups in your account. By default, EMF metric creation\n is enabled for all log groups. You can use metric extraction policies to disable EMF metric\n creation for your entire account or specific log groups.

\n

When a policy disables EMF metric creation for a log group, log events in the EMF format\n are still ingested, but no CloudWatch Metrics are created from them.

\n \n

Creating a policy disables metrics for Amazon Web Services features that use EMF to create metrics, such\n as CloudWatch Container Insights and CloudWatch Application Signals. To prevent turning off\n those features by accident, we recommend that you exclude the underlying log-groups through\n a selection-criteria such as LogGroupNamePrefix NOT IN [\"/aws/containerinsights\",\n \"/aws/ecs/containerinsights\", \"/aws/application-signals/data\"].

\n \n

Each account can have either one account-level metric extraction policy that applies to\n all log groups, or up to 5 policies that are each scoped to a subset of log groups with the\n selectionCriteria parameter. The selection criteria supports filtering by\n LogGroupName and LogGroupNamePrefix using the operators\n IN and NOT IN. You can specify up to 50 values in each\n IN or NOT IN list.

\n

The selection criteria can be specified in these formats:

\n

\n LogGroupName IN [\"log-group-1\", \"log-group-2\"]\n

\n

\n LogGroupNamePrefix NOT IN [\"/aws/prefix1\", \"/aws/prefix2\"]\n

\n

If you have multiple account-level metric extraction policies with selection criteria, no\n two of them can have overlapping criteria. For example, if you have one policy with selection\n criteria LogGroupNamePrefix IN [\"my-log\"], you can't have another metric\n extraction policy with selection criteria LogGroupNamePrefix IN [\"/my-log-prod\"]\n or LogGroupNamePrefix IN [\"/my-logging\"], as the set of log groups matching these\n prefixes would be a subset of the log groups matching the first policy's prefix, creating an\n overlap.

\n

When using NOT IN, only one policy with this operator is allowed per\n account.

\n

When combining policies with IN and NOT IN operators, the\n overlap check ensures that policies don't have conflicting effects. Two policies with\n IN and NOT IN operators do not overlap if and only if every value\n in the IN policy is completely contained within some value in the NOT\n IN policy. For example:

\n
    \n
  • \n

    If you have a NOT IN policy for prefix \"/aws/lambda\", you\n can create an IN policy for the exact log group name\n \"/aws/lambda/function1\" because the set of log groups matching\n \"/aws/lambda/function1\" is a subset of the log groups matching\n \"/aws/lambda\".

    \n
    • \n
  • \n

    If you have a NOT IN policy for prefix \"/aws/lambda\", you\n cannot create an IN policy for prefix \"/aws\" because the set of\n log groups matching \"/aws\" is not a subset of the log groups matching\n \"/aws/lambda\".

    \n
    • \n
" + } + }, + "com.amazonaws.cloudwatchlogs#PutAccountPolicyRequest": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#PolicyName", + "traits": { + "smithy.api#documentation": "

A name for the policy. This must be unique within the account and cannot start with\n aws/.

", + "smithy.api#required": {} + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#AccountPolicyDocument", + "traits": { + "smithy.api#documentation": "

Specify the policy, in JSON.

\n

\n Data protection policy\n

\n

A data protection policy must include two JSON blocks:

\n
    \n
  • \n

    The first block must include both a DataIdentifer array and an\n Operation property with an Audit action. The\n DataIdentifer array lists the types of sensitive data that you want to\n mask. For more information about the available options, see Types of data that\n you can mask.

    \n

    The Operation property with an Audit action is required to\n find the sensitive data terms. This Audit action must contain a\n FindingsDestination object. You can optionally use that\n FindingsDestination object to list one or more destinations to send audit\n findings to. If you specify destinations such as log groups, Firehose streams,\n and S3 buckets, they must already exist.

    \n
    • \n
  • \n

    The second block must include both a DataIdentifer array and an\n Operation property with an Deidentify action. The\n DataIdentifer array must exactly match the DataIdentifer array\n in the first block of the policy.

    \n

    The Operation property with the Deidentify action is what\n actually masks the data, and it must contain the \"MaskConfig\": {} object.\n The \"MaskConfig\": {} object must be empty.

    \n
    • \n
\n

For an example data protection policy, see the Examples\n section on this page.

\n \n

The contents of the two DataIdentifer arrays must match exactly.

\n \n

In addition to the two JSON blocks, the policyDocument can also include\n Name, Description, and Version fields. The\n Name is different than the operation's policyName parameter, and\n is used as a dimension when CloudWatch Logs reports audit findings metrics to CloudWatch.

\n

The JSON specified in policyDocument can be up to 30,720 characters\n long.

\n

\n Subscription filter policy\n

\n

A subscription filter policy can include the following attributes in a JSON block:

\n
    \n
  • \n

    \n DestinationArn The ARN of the destination to deliver\n log events to. Supported destinations are:

    \n
      \n
    • \n

      An Kinesis Data Streams data stream in the same account as the subscription policy,\n for same-account delivery.

      \n
      • \n
    • \n

      An Firehose data stream in the same account as the subscription policy,\n for same-account delivery.

      \n
      • \n
    • \n

      A Lambda function in the same account as the subscription policy, for\n same-account delivery.

      \n
      • \n
    • \n

      A logical destination in a different account created with PutDestination, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations.

      \n
      • \n
    \n
    • \n
  • \n

    \n RoleArn The ARN of an IAM role that grants CloudWatch\n Logs permissions to deliver ingested log events to the destination stream. You don't need\n to provide the ARN when you are working with a logical destination for cross-account\n delivery.

    \n
    • \n
  • \n

    \n FilterPattern A filter pattern for subscribing to\n a filtered stream of log events.

    \n
    • \n
  • \n

    \n Distribution The method used to distribute log data\n to the destination. By default, log data is grouped by log stream, but the grouping can be\n set to Random for a more even distribution. This property is only applicable\n when the destination is an Kinesis Data Streams data stream.

    \n
    • \n
\n

\n Transformer policy\n

\n

A transformer policy must include one JSON block with the array of processors and their\n configurations. For more information about available processors, see Processors that you can use.

\n

\n Field index policy\n

\n

A field index filter policy can include the following attribute in a JSON block:

\n
    \n
  • \n

    \n Fields The array of field indexes to create.

    \n
    • \n
  • \n

    \n FieldsV2 The object of field indexes to create along\n with it's type.

    \n
    • \n
\n

It must contain at least one field index.

\n

The following is an example of an index policy document that creates indexes with\n different types.

\n

\n \"policyDocument\": \"{ \\\"Fields\\\": [ \\\"TransactionId\\\" ], \\\"FieldsV2\\\":\n {\\\"RequestId\\\": {\\\"type\\\": \\\"FIELD_INDEX\\\"}, \\\"APIName\\\": {\\\"type\\\": \\\"FACET\\\"},\n \\\"StatusCode\\\": {\\\"type\\\": \\\"FACET\\\"}}}\"\n

\n

You can use FieldsV2 to specify the type for each field. Supported types are\n FIELD_INDEX and FACET. Field names within Fields and\n FieldsV2 must be mutually exclusive.

", + "smithy.api#required": {} + } + }, + "policyType": { + "target": "com.amazonaws.cloudwatchlogs#PolicyType", + "traits": { + "smithy.api#documentation": "

The type of policy that you're creating or updating.

", + "smithy.api#required": {} + } + }, + "scope": { + "target": "com.amazonaws.cloudwatchlogs#Scope", + "traits": { + "smithy.api#documentation": "

Currently the only valid value for this parameter is ALL, which specifies\n that the data protection policy applies to all log groups in the account. If you omit this\n parameter, the default of ALL is used.

" + } + }, + "selectionCriteria": { + "target": "com.amazonaws.cloudwatchlogs#SelectionCriteria", + "traits": { + "smithy.api#documentation": "

Use this parameter to apply the new policy to a subset of log groups in the account or a\n data source name and type combination.

\n

Specifying selectionCriteria is valid only when you specify\n SUBSCRIPTION_FILTER_POLICY, FIELD_INDEX_POLICY or\n TRANSFORMER_POLICYfor policyType.

\n
    \n
  • \n

    If policyType is SUBSCRIPTION_FILTER_POLICY, the only\n supported selectionCriteria filter is LogGroupName NOT IN\n []\n

    \n
    • \n
  • \n

    If policyType is TRANSFORMER_POLICY, the only supported\n selectionCriteria filter is LogGroupNamePrefix\n

    \n
    • \n
  • \n

    If policyType is FIELD_INDEX_POLICY, the supported\n selectionCriteria filters are:

    \n
      \n
    • \n

      \n LogGroupNamePrefix\n

      \n
      • \n
    • \n

      \n DataSourceName AND DataSourceType\n

      \n
      • \n
    \n

    When you specify selectionCriteria for a field index policy you can\n use either LogGroupNamePrefix by itself or DataSourceName and\n DataSourceType together.

    \n
    • \n
\n

The selectionCriteria string can be up to 25KB in length. The length is\n determined by using its UTF-8 bytes.

\n

Using the selectionCriteria parameter with\n SUBSCRIPTION_FILTER_POLICY is useful to help prevent infinite loops. For more\n information, see Log recursion\n prevention.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutAccountPolicyResponse": { + "type": "structure", + "members": { + "accountPolicy": { + "target": "com.amazonaws.cloudwatchlogs#AccountPolicy", + "traits": { + "smithy.api#documentation": "

The account policy that you created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutBearerTokenAuthentication": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutBearerTokenAuthenticationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Enables or disables bearer token authentication for the specified log group. When enabled on a\n log group, bearer token authentication is enabled on operations until it is explicitly\n disabled.

\n

For information about the parameters that are common to all actions, see Common Parameters.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutBearerTokenAuthenticationRequest": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

The name or ARN of the log group.

\n

Type: String

\n

Length Constraints: Minimum length of 1. Maximum length of 512.

\n

Pattern: [\\.\\-_/#A-Za-z0-9]+\n

\n

Required: Yes

", + "smithy.api#required": {} + } + }, + "bearerTokenAuthenticationEnabled": { + "target": "com.amazonaws.cloudwatchlogs#BearerTokenAuthenticationEnabled", + "traits": { + "smithy.api#documentation": "

Whether to enable bearer token authentication.

\n

Type: Boolean

\n

Required: Yes

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a data protection policy for the specified log group. A data protection policy can\n help safeguard sensitive data that's ingested by the log group by auditing and masking the\n sensitive log data.

\n \n

Sensitive data is detected and masked when it is ingested into the log group. When you\n set a data protection policy, log events ingested into the log group before that time are\n not masked.

\n \n

By default, when a user views a log event that includes masked data, the sensitive data is\n replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to\n true to view the unmasked log events. Users with the logs:Unmask\n can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs\n Insights query with the unmask query command.

\n

For more information, including a list of types of data that can be audited and masked,\n see Protect sensitive log data\n with masking.

\n

The PutDataProtectionPolicy operation applies to only the specified log\n group. You can also use PutAccountPolicy to create an account-level data protection policy that applies to\n all log groups in the account, including both existing log groups and log groups that are\n created level. If a log group has its own data protection policy and the account also has an\n account-level data protection policy, then the two policies are cumulative. Any sensitive term\n specified in either policy is masked.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicyRequest": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

Specify either the log group name or log group ARN.

", + "smithy.api#required": {} + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#DataProtectionPolicyDocument", + "traits": { + "smithy.api#documentation": "

Specify the data protection policy, in JSON.

\n

This policy must include two JSON blocks:

\n
    \n
  • \n

    The first block must include both a DataIdentifer array and an\n Operation property with an Audit action. The\n DataIdentifer array lists the types of sensitive data that you want to\n mask. For more information about the available options, see Types of data that\n you can mask.

    \n

    The Operation property with an Audit action is required to\n find the sensitive data terms. This Audit action must contain a\n FindingsDestination object. You can optionally use that\n FindingsDestination object to list one or more destinations to send audit\n findings to. If you specify destinations such as log groups, Firehose streams,\n and S3 buckets, they must already exist.

    \n
    • \n
  • \n

    The second block must include both a DataIdentifer array and an\n Operation property with an Deidentify action. The\n DataIdentifer array must exactly match the DataIdentifer array\n in the first block of the policy.

    \n

    The Operation property with the Deidentify action is what\n actually masks the data, and it must contain the \"MaskConfig\": {} object.\n The \"MaskConfig\": {} object must be empty.

    \n
    • \n
\n

For an example data protection policy, see the Examples\n section on this page.

\n \n

The contents of the two DataIdentifer arrays must match exactly.

\n \n

In addition to the two JSON blocks, the policyDocument can also include\n Name, Description, and Version fields. The\n Name is used as a dimension when CloudWatch Logs reports audit findings\n metrics to CloudWatch.

\n

The JSON specified in policyDocument can be up to 30,720 characters.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicyResponse": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

The log group name or ARN that you specified in your request.

" + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#DataProtectionPolicyDocument", + "traits": { + "smithy.api#documentation": "

The data protection policy used for this log group.

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

The date and time that this policy was most recently updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliveryDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a logical delivery destination. A delivery\n destination is an Amazon Web Services resource that represents an Amazon Web Services service\n that logs can be sent to. CloudWatch Logs, Amazon S3, and Firehose are\n supported as logs delivery destinations and X-Ray as the trace delivery\n destination.

\n

To configure logs delivery between a supported Amazon Web Services service and a\n destination, you must do the following:

\n
    \n
  • \n

    Create a delivery source, which is a logical object that represents the resource that\n is actually sending the logs. For more information, see PutDeliverySource.

    \n
    • \n
  • \n

    Use PutDeliveryDestination to create a delivery\n destination in the same account of the actual delivery destination. The\n delivery destination that you create is a logical object that represents the actual\n delivery destination.

    \n
    • \n
  • \n

    If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.\n

    \n
    • \n
  • \n

    Use CreateDelivery to create a delivery by pairing\n exactly one delivery source and one delivery destination. For more information, see CreateDelivery.

    \n
    • \n
\n

You can configure a single delivery source to send logs to multiple destinations by\n creating multiple deliveries. You can also create multiple deliveries to configure multiple\n delivery sources to send logs to the same delivery destination.

\n

Only some Amazon Web Services services support being configured as a delivery source. These\n services are listed as Supported [V2 Permissions] in the\n table at Enabling logging from\n Amazon Web Services services.\n

\n

If you use this operation to update an existing delivery destination, all the current\n delivery destination parameters are overwritten with the new parameter values that you\n specify.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account. To\n configure the delivery of logs from an Amazon Web Services service in another account to a logs\n delivery destination in the current account, you must do the following:

\n
    \n
  • \n

    Create a delivery source, which is a logical object that represents the resource that\n is actually sending the logs. For more information, see PutDeliverySource.

    \n
    • \n
  • \n

    Create a delivery destination, which is a logical object that\n represents the actual delivery destination. For more information, see PutDeliveryDestination.

    \n
    • \n
  • \n

    Use this operation in the destination account to assign an IAM policy\n to the destination. This policy allows delivery to that destination.

    \n
    • \n
  • \n

    Create a delivery by pairing exactly one delivery source and one\n delivery destination. For more information, see CreateDelivery.

    \n
    • \n
\n

Only some Amazon Web Services services support being configured as a delivery source. These\n services are listed as Supported [V2 Permissions] in the\n table at Enabling logging from\n Amazon Web Services services.\n

\n

The contents of the policy must include two statements. One statement enables general logs\n delivery, and the other allows delivery to the chosen destination. See the examples for the\n needed policies.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicyRequest": { + "type": "structure", + "members": { + "deliveryDestinationName": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", + "traits": { + "smithy.api#documentation": "

The name of the delivery destination to assign this policy to.

", + "smithy.api#required": {} + } + }, + "deliveryDestinationPolicy": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationPolicy", + "traits": { + "smithy.api#documentation": "

The contents of the policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicyResponse": { + "type": "structure", + "members": { + "policy": { + "target": "com.amazonaws.cloudwatchlogs#Policy", + "traits": { + "smithy.api#documentation": "

The contents of the policy that you just created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", + "traits": { + "smithy.api#documentation": "

A name for this delivery destination. This name must be unique for all delivery\n destinations in your account.

", + "smithy.api#required": {} + } + }, + "outputFormat": { + "target": "com.amazonaws.cloudwatchlogs#OutputFormat", + "traits": { + "smithy.api#documentation": "

The format for the logs that this delivery destination will receive.

" + } + }, + "deliveryDestinationConfiguration": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationConfiguration", + "traits": { + "smithy.api#documentation": "

A structure that contains the ARN of the Amazon Web Services resource that will receive the\n logs.

\n \n

\n deliveryDestinationConfiguration is required for CloudWatch Logs,\n Amazon S3, Firehose log delivery destinations and not required for\n X-Ray trace delivery destinations. deliveryDestinationType is\n needed for X-Ray trace delivery destinations but not required for other logs\n delivery destinations.

\n " + } + }, + "deliveryDestinationType": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationType", + "traits": { + "smithy.api#documentation": "

The type of delivery destination. This parameter specifies the target service where log\n data will be delivered. Valid values include:

\n
    \n
  • \n

    \n S3 - Amazon S3 for long-term storage and analytics

    \n
    • \n
  • \n

    \n CWL - CloudWatch Logs for centralized log management

    \n
    • \n
  • \n

    \n FH - Amazon Kinesis Data Firehose for real-time data streaming

    \n
    • \n
  • \n

    \n XRAY - Amazon Web Services\n X-Ray for distributed tracing and application monitoring

    \n
    • \n
\n

The delivery destination type determines the format and configuration options available\n for log delivery.

" + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

An optional list of key-value pairs to associate with the resource.

\n

For more information about tagging, see Tagging Amazon Web Services resources\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationResponse": { + "type": "structure", + "members": { + "deliveryDestination": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestination", + "traits": { + "smithy.api#documentation": "

A structure containing information about the delivery destination that you just created or\n updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliverySource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutDeliverySourceRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutDeliverySourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a logical delivery source. A delivery source\n represents an Amazon Web Services resource that sends logs to an logs delivery destination. The\n destination can be CloudWatch Logs, Amazon S3, Firehose or X-Ray for sending traces.

\n

To configure logs delivery between a delivery destination and an Amazon Web Services\n service that is supported as a delivery source, you must do the following:

\n
    \n
  • \n

    Use PutDeliverySource to create a delivery source, which is a logical\n object that represents the resource that is actually sending the logs.

    \n
    • \n
  • \n

    Use PutDeliveryDestination to create a delivery\n destination, which is a logical object that represents the actual delivery\n destination. For more information, see PutDeliveryDestination.

    \n
    • \n
  • \n

    If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.\n

    \n
    • \n
  • \n

    Use CreateDelivery to create a delivery by pairing\n exactly one delivery source and one delivery destination. For more information, see CreateDelivery.

    \n
    • \n
\n

You can configure a single delivery source to send logs to multiple destinations by\n creating multiple deliveries. You can also create multiple deliveries to configure multiple\n delivery sources to send logs to the same delivery destination.

\n

Only some Amazon Web Services services support being configured as a delivery source. These\n services are listed as Supported [V2 Permissions] in the\n table at Enabling logging from\n Amazon Web Services services.\n

\n

If you use this operation to update an existing delivery source, all the current delivery\n source parameters are overwritten with the new parameter values that you specify.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliverySourceRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", + "traits": { + "smithy.api#documentation": "

A name for this delivery source. This name must be unique for all delivery sources in your\n account.

", + "smithy.api#required": {} + } + }, + "resourceArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the Amazon Web Services resource that is generating and sending logs. For\n example,\n arn:aws:workmail:us-east-1:123456789012:organization/m-1234EXAMPLEabcd1234abcd1234abcd1234\n

\n

For the SECURITY_FINDING_LOGS logType, use a wildcard ARN for the hub\n resource. For Amazon Web Services Security Hub CSPM, use\n arn:aws:securityhub:us-east-1:111122223333:hub/*\n and for Amazon Web Services Security Hub, use\n arn:aws:securityhub:us-east-1:111122223333:hubv2/*\n

", + "smithy.api#required": {} + } + }, + "logType": { + "target": "com.amazonaws.cloudwatchlogs#LogType", + "traits": { + "smithy.api#documentation": "

Defines the type of log that the source is sending.

\n
    \n
  • \n

    For Application Load Balancer, the valid values are ALB_ACCESS_LOGS,\n ALB_CONNECTION_LOGS, and ALB_HEALTH_CHECK_LOGS.

    \n
    • \n
  • \n

    For Amazon Bedrock Agents, the valid values are APPLICATION_LOGS and\n EVENT_LOGS.

    \n
    • \n
  • \n

    For Amazon Bedrock Knowledge Bases, the valid values are\n APPLICATION_LOGS and TRACES.

    \n
    • \n
  • \n

    For Amazon Bedrock AgentCore Runtime, the valid values are\n APPLICATION_LOGS, USAGE_LOGS and TRACES.

    \n
    • \n
  • \n

    For Amazon Bedrock AgentCore Tools, the valid values are\n APPLICATION_LOGS, USAGE_LOGS and TRACES.

    \n
    • \n
  • \n

    For Amazon Bedrock AgentCore Identity, the valid values are\n APPLICATION_LOGS and TRACES.

    \n
    • \n
  • \n

    For Amazon Bedrock AgentCore Memory, the valid values are\n APPLICATION_LOGS and TRACES.

    \n
    • \n
  • \n

    For Amazon Bedrock AgentCore Gateway, the valid values are\n APPLICATION_LOGS and TRACES.

    \n
    • \n
  • \n

    For Amazon Bedrock AgentCore Payments, the valid values are\n APPLICATION_LOGS and TRACES.

    \n
    • \n
  • \n

    For CloudFront, the valid value is ACCESS_LOGS.

    \n
    • \n
  • \n

    For DevOps Agent, the valid value is APPLICATION_LOGS.

    \n
    • \n
  • \n

    For Amazon CodeWhisperer, the valid value is EVENT_LOGS.

    \n
    • \n
  • \n

    For Elemental MediaPackage, the valid values are EGRESS_ACCESS_LOGS and\n INGRESS_ACCESS_LOGS.

    \n
    • \n
  • \n

    For Elemental MediaTailor, the valid values are AD_DECISION_SERVER_LOGS,\n MANIFEST_SERVICE_LOGS, and TRANSCODE_LOGS.

    \n
    • \n
  • \n

    For Amazon EKS Auto Mode, the valid values are AUTO_MODE_BLOCK_STORAGE_LOGS,\n AUTO_MODE_COMPUTE_LOGS, AUTO_MODE_IPAM_LOGS, and\n AUTO_MODE_LOAD_BALANCING_LOGS.

    \n
    • \n
  • \n

    For Amazon EKS Capability Logs, the valid values are EKS_CAPABILITY_ACK_LOGS,\n EKS_CAPABILITY_ARGOCD_APPLICATION_LOGS,\n EKS_CAPABILITY_ARGOCD_APPLICATIONSET_LOGS,\n EKS_CAPABILITY_ARGOCD_COMMITSERVER_LOGS,\n EKS_CAPABILITY_ARGOCD_REPOSERVER_LOGS,\n EKS_CAPABILITY_ARGOCD_SERVER_LOGS, and\n EKS_CAPABILITY_KRO_LOGS.

    \n
    • \n
  • \n

    For Entity Resolution, the valid value is WORKFLOW_LOGS.

    \n
    • \n
  • \n

    For IAM Identity Center, the valid value is\n ERROR_LOGS.

    \n
    • \n
  • \n

    For Network Firewall Proxy, the valid values are ALERT_LOGS,\n ALLOW_LOGS, and DENY_LOGS.

    \n
    • \n
  • \n

    For Network Load Balancer, the valid value is NLB_ACCESS_LOGS.

    \n
    • \n
  • \n

    For PCS, the valid values are PCS_SCHEDULER_LOGS,\n PCS_JOBCOMP_LOGS, and PCS_SCHEDULER_AUDIT_LOGS.

    \n
    • \n
  • \n

    For Quick, the valid values are AGENT_HOURS_LOGS,\n CHAT_LOGS, FEEDBACK_LOGS, and\n INDEX_USAGE_LOGS.

    \n
    • \n
  • \n

    For Amazon Web Services RTB Fabric, the valid values is\n APPLICATION_LOGS.

    \n
    • \n
  • \n

    For Amazon Q, the valid values are EVENT_LOGS and\n SYNC_JOB_LOGS.

    \n
    • \n
  • \n

    For Amazon S3, the valid value is\n S3_SERVER_ACCESS_LOGS.

    \n
    • \n
  • \n

    For Amazon Web Services Security Hub CSPM, the valid value is\n SECURITY_FINDING_LOGS.

    \n
    • \n
  • \n

    For Amazon Web Services Security Hub, the valid value is\n SECURITY_FINDING_LOGS.

    \n
    • \n
  • \n

    For Amazon SES mail manager, the valid values are\n APPLICATION_LOGS and TRAFFIC_POLICY_DEBUG_LOGS.

    \n
    • \n
  • \n

    For Amazon WorkMail, the valid values are ACCESS_CONTROL_LOGS,\n AUTHENTICATION_LOGS, WORKMAIL_AVAILABILITY_PROVIDER_LOGS,\n WORKMAIL_MAILBOX_ACCESS_LOGS, and\n WORKMAIL_PERSONAL_ACCESS_TOKEN_LOGS.

    \n
    • \n
  • \n

    For Amazon VPC Route Server, the valid value is\n EVENT_LOGS.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "

An optional list of key-value pairs to associate with the resource.

\n

For more information about tagging, see Tagging Amazon Web Services resources\n

" + } + }, + "deliverySourceConfiguration": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceConfiguration", + "traits": { + "smithy.api#documentation": "

A map of key-value pairs to configure the delivery source. Both keys and values must be\n between 1 and 255 characters in length. For example,\n {\"samplingRate\": \"50\"}.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliverySourceResponse": { + "type": "structure", + "members": { + "deliverySource": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySource", + "traits": { + "smithy.api#documentation": "

A structure containing information about the delivery source that was just created or\n updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutDestinationRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a destination. This operation is used only to create destinations\n for cross-account subscriptions.

\n

A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With\n a destination, you can subscribe to a real-time stream of log events for a different account,\n ingested using PutLogEvents.

\n

Through an access policy, a destination controls what is written to it. By default,\n PutDestination does not set any access policy with the destination, which means\n a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination\n owner must call PutDestinationPolicy after PutDestination.

\n

To perform a PutDestination operation, you must also have the\n iam:PassRole permission.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutDestinationPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutDestinationPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates an access policy associated with an existing destination. An access\n policy is an IAM\n policy document that is used to authorize claims to register a subscription filter\n against a given destination.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutDestinationPolicyRequest": { + "type": "structure", + "members": { + "destinationName": { + "target": "com.amazonaws.cloudwatchlogs#DestinationName", + "traits": { + "smithy.api#documentation": "

A name for an existing destination.

", + "smithy.api#required": {} + } + }, + "accessPolicy": { + "target": "com.amazonaws.cloudwatchlogs#AccessPolicy", + "traits": { + "smithy.api#documentation": "

An IAM policy document that authorizes cross-account users to deliver their log events\n to the associated destination. This can be up to 5120 bytes.

", + "smithy.api#required": {} + } + }, + "forceUpdate": { + "target": "com.amazonaws.cloudwatchlogs#ForceUpdate", + "traits": { + "smithy.api#documentation": "

Specify true if you are updating an existing destination policy to grant permission to an\n organization ID instead of granting permission to individual Amazon Web Services accounts.\n Before you update a destination policy this way, you must first update the subscription\n filters in the accounts that send logs to this destination. If you do not, the subscription\n filters might stop working. By specifying true for forceUpdate, you\n are affirming that you have already updated the subscription filters. For more information,\n see Updating an\n existing cross-account subscription\n

\n

If you omit this parameter, the default of false is used.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDestinationRequest": { + "type": "structure", + "members": { + "destinationName": { + "target": "com.amazonaws.cloudwatchlogs#DestinationName", + "traits": { + "smithy.api#documentation": "

A name for the destination.

", + "smithy.api#required": {} + } + }, + "targetArn": { + "target": "com.amazonaws.cloudwatchlogs#TargetArn", + "traits": { + "smithy.api#documentation": "

The ARN of an Amazon Kinesis stream to which to deliver matching log events.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.cloudwatchlogs#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon\n Kinesis PutRecord operation on the destination stream.

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

An optional list of key-value pairs to associate with the resource.

\n

For more information about tagging, see Tagging Amazon Web Services resources\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDestinationResponse": { + "type": "structure", + "members": { + "destination": { + "target": "com.amazonaws.cloudwatchlogs#Destination", + "traits": { + "smithy.api#documentation": "

The destination.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutIndexPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutIndexPolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutIndexPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a field index policy for the specified log group.\n Only log groups in the Standard log class support field index policies. For more information\n about log classes, see Log\n classes.

\n

You can use field index policies to create field indexes on fields\n found in log events in the log group. Creating field indexes speeds up and lowers the costs\n for CloudWatch Logs Insights queries that reference those field indexes, because these\n queries attempt to skip the processing of log events that are known to not match the indexed\n field. Good fields to index are fields that you often need to query for and fields or values\n that match only a small fraction of the total log events. Common examples of indexes include\n request ID, session ID, userID, and instance IDs. For more information, see Create field indexes to improve query performance and reduce costs.

\n

You can configure indexed fields as facets to enable interactive\n exploration and filtering of your logs in the CloudWatch Logs Insights console. Facets\n allow you to view value distributions and counts for indexed fields without running queries.\n When you create a field index, you can optionally set it as a facet to enable this interactive\n analysis capability. For more information, see Use facets to group and\n explore logs.

\n

To find the fields that are in your log group events, use the GetLogGroupFields operation.

\n

For example, suppose you have created a field index for requestId. Then, any\n CloudWatch Logs Insights query on that log group that includes requestId =\n value\n or requestId IN [value,\n value, ...] will process fewer log events to reduce costs, and\n have improved performance.

\n

CloudWatch Logs provides default field indexes for all log groups in the Standard log\n class. Default field indexes are automatically available for the following fields:

\n
    \n
  • \n

    \n @logStream\n

    \n
    • \n
  • \n

    \n @aws.region\n

    \n
    • \n
  • \n

    \n @aws.account\n

    \n
    • \n
  • \n

    \n @source.log\n

    \n
    • \n
  • \n

    \n traceId\n

    \n
    • \n
\n

Default field indexes are in addition to any custom field indexes you define within your\n policy. Default field indexes are not counted towards your field index quota.

\n

Each index policy has the following quotas and restrictions:

\n
    \n
  • \n

    As many as 20 fields can be included in the policy.

    \n
    • \n
  • \n

    Each field name can include as many as 100 characters.

    \n
    • \n
\n

Matches of log events to the names of indexed fields are case-sensitive. For example, a\n field index of RequestId won't match a log event containing\n requestId.

\n

Log group-level field index policies created with PutIndexPolicy override\n account-level field index policies created with PutAccountPolicy that apply to log groups. If you use PutIndexPolicy\n to create a field index policy for a log group, that log group uses only that policy for log\n group-level indexing, including any facet configurations. The log group ignores any\n account-wide field index policy that applies to log groups, but data source-based account\n policies may still apply.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutIndexPolicyRequest": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

Specify either the log group name or log group ARN to apply this field index policy to. If\n you specify an ARN, use the format\n arn:aws:logs:region:account-id:log-group:log_group_name\n Don't include an * at the end.

", + "smithy.api#required": {} + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#PolicyDocument", + "traits": { + "smithy.api#documentation": "

The index policy document, in JSON format. The following is an example of an index policy\n document that creates indexes with different types.

\n

\n \"policyDocument\": \"{\"Fields\": [ \"TransactionId\" ], \"FieldsV2\": {\"RequestId\":\n {\"type\": \"FIELD_INDEX\"}, \"APIName\": {\"type\": \"FACET\"}, \"StatusCode\": {\"type\":\n \"FACET\"}}}\"\n

\n

You can use FieldsV2 to specify the type for each field. Supported types are\n FIELD_INDEX and FACET. Field names within Fields and\n FieldsV2 must be mutually exclusive.

\n

The policy document must include at least one field index. For more information about the\n fields that can be included and other restrictions, see Field index\n syntax and quotas.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutIndexPolicyResponse": { + "type": "structure", + "members": { + "indexPolicy": { + "target": "com.amazonaws.cloudwatchlogs#IndexPolicy", + "traits": { + "smithy.api#documentation": "

The index policy that you just created or updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutIntegrationRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutIntegrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an integration between CloudWatch Logs and another service in this account.\n Currently, only integrations with OpenSearch Service are supported, and currently you can have\n only one integration in your account.

\n

Integrating with OpenSearch Service makes it possible for you to create curated vended\n logs dashboards, powered by OpenSearch Service analytics. For more information, see Vended log\n dashboards powered by Amazon OpenSearch Service.

\n

You can use this operation only to create a new integration. You can't modify an existing\n integration.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutIntegrationRequest": { + "type": "structure", + "members": { + "integrationName": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationName", + "traits": { + "smithy.api#documentation": "

A name for the integration.

", + "smithy.api#required": {} + } + }, + "resourceConfig": { + "target": "com.amazonaws.cloudwatchlogs#ResourceConfig", + "traits": { + "smithy.api#documentation": "

A structure that contains configuration information for the integration that you are\n creating.

", + "smithy.api#required": {} + } + }, + "integrationType": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationType", + "traits": { + "smithy.api#documentation": "

The type of integration. Currently, the only supported type is\n OPENSEARCH.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutIntegrationResponse": { + "type": "structure", + "members": { + "integrationName": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationName", + "traits": { + "smithy.api#documentation": "

The name of the integration that you just created.

" + } + }, + "integrationStatus": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationStatus", + "traits": { + "smithy.api#documentation": "

The status of the integration that you just created.

\n

After you create an integration, it takes a few minutes to complete. During this time,\n you'll see the status as PROVISIONING.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutLogEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutLogEventsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutLogEventsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#DataAlreadyAcceptedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidSequenceTokenException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#UnrecognizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Uploads a batch of log events to the specified log stream.

\n \n

The sequence token is now ignored in PutLogEvents actions.\n PutLogEvents actions are always accepted and never return\n InvalidSequenceTokenException or DataAlreadyAcceptedException\n even if the sequence token is not valid. You can use parallel PutLogEvents\n actions on the same log stream.

\n \n

The batch of events must satisfy the following constraints:

\n
    \n
  • \n

    The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of\n all event messages in UTF-8, plus 26 bytes for each log event.

    \n
    • \n
  • \n

    Events more than 2 hours in the future are rejected while processing remaining\n valid events.

    \n
    • \n
  • \n

    Events older than 14 days or preceding the log group's retention period are\n rejected while processing remaining valid events.

    \n
    • \n
  • \n

    The log events in the batch must be in chronological order by their timestamp. The\n timestamp is the time that the event occurred, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell\n and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format:\n yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)\n

    \n
    • \n
  • \n

    A batch of log events in a single request must be in a chronological order.\n Otherwise, the operation fails.

    \n
    • \n
  • \n

    Each log event can be no larger than 1 MB.

    \n
    • \n
  • \n

    The maximum number of log events in a batch is 10,000.

    \n
    • \n
  • \n

    For valid events (within 14 days in the past to 2 hours in future), the time span\n in a single batch cannot exceed 24 hours. Otherwise, the operation fails.

    \n
    • \n
\n \n

The quota of five requests per second per log stream has been removed. Instead,\n PutLogEvents actions are throttled based on a per-second per-account quota.\n You can request an increase to the per-second throttling quota by using the Service Quotas service.

\n \n

If a call to PutLogEvents returns \"UnrecognizedClientException\" the most\n likely cause is a non-valid Amazon Web Services access key ID or secret key.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutLogEventsRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + }, + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "

The name of the log stream.

", + "smithy.api#required": {} + } + }, + "logEvents": { + "target": "com.amazonaws.cloudwatchlogs#InputLogEvents", + "traits": { + "smithy.api#documentation": "

The log events.

", + "smithy.api#required": {} + } + }, + "sequenceToken": { + "target": "com.amazonaws.cloudwatchlogs#SequenceToken", + "traits": { + "smithy.api#documentation": "

The sequence token obtained from the response of the previous PutLogEvents\n call.

\n \n

The sequenceToken parameter is now ignored in PutLogEvents\n actions. PutLogEvents actions are now accepted and never return\n InvalidSequenceTokenException or DataAlreadyAcceptedException\n even if the sequence token is not valid.

\n " + } + }, + "entity": { + "target": "com.amazonaws.cloudwatchlogs#Entity", + "traits": { + "smithy.api#documentation": "

The entity associated with the log events.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutLogEventsResponse": { + "type": "structure", + "members": { + "nextSequenceToken": { + "target": "com.amazonaws.cloudwatchlogs#SequenceToken", + "traits": { + "smithy.api#documentation": "

The next sequence token.

\n \n

This field has been deprecated.

\n

The sequence token is now ignored in PutLogEvents actions.\n PutLogEvents actions are always accepted even if the sequence token is not\n valid. You can use parallel PutLogEvents actions on the same log stream and you\n do not need to wait for the response of a previous PutLogEvents action to\n obtain the nextSequenceToken value.

\n " + } + }, + "rejectedLogEventsInfo": { + "target": "com.amazonaws.cloudwatchlogs#RejectedLogEventsInfo", + "traits": { + "smithy.api#documentation": "

The rejected events.

" + } + }, + "rejectedEntityInfo": { + "target": "com.amazonaws.cloudwatchlogs#RejectedEntityInfo", + "traits": { + "smithy.api#documentation": "

Information about why the entity is rejected when calling PutLogEvents. Only\n returned when the entity is rejected.

\n \n

When the entity is rejected, the events may still be accepted.

\n " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutLogGroupDeletionProtection": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutLogGroupDeletionProtectionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Enables or disables deletion protection for the specified log group. When enabled on a\n log group, deletion protection blocks all deletion operations until it is explicitly\n disabled.

\n

For information about the parameters that are common to all actions, see Common Parameters.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutLogGroupDeletionProtectionRequest": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

The name or ARN of the log group.

\n

Type: String

\n

Length Constraints: Minimum length of 1. Maximum length of 512.

\n

Pattern: [\\.\\-_/#A-Za-z0-9]+\n

\n

Required: Yes

", + "smithy.api#required": {} + } + }, + "deletionProtectionEnabled": { + "target": "com.amazonaws.cloudwatchlogs#DeletionProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Whether to enable deletion protection.

\n

Type: Boolean

\n

Required: Yes

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutMetricFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutMetricFilterRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a metric filter and associates it with the specified log group. With\n metric filters, you can configure rules to extract metric data from log events ingested\n through PutLogEvents.

\n

The maximum number of metric filters that can be associated with a log group is\n 100.

\n

Using regular expressions in filter patterns is supported. For these filters, there is a\n quota of two regular expression patterns within a single filter pattern. There is also a quota\n of five regular expression patterns per log group. For more information about using regular\n expressions in filter patterns, see Filter pattern syntax for\n metric filters, subscription filters, filter log events, and Live Tail.

\n

When you create a metric filter, you can also optionally assign a unit and dimensions to\n the metric that is created.

\n \n

Metrics extracted from log events are charged as custom metrics. To prevent unexpected\n high charges, do not specify high-cardinality fields such as IPAddress or\n requestID as dimensions. Each different value found for a dimension is\n treated as a separate metric and accrues charges as a separate custom metric.

\n

CloudWatch Logs might disable a metric filter if it generates 1,000 different\n name/value pairs for your specified dimensions within one hour.

\n

You can also set up a billing alarm to alert you if your charges are higher than\n expected. For more information, see \n Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.\n

\n " + } + }, + "com.amazonaws.cloudwatchlogs#PutMetricFilterRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + }, + "filterName": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "

A name for the metric filter.

", + "smithy.api#required": {} + } + }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern", + "traits": { + "smithy.api#documentation": "

A filter pattern for extracting metric data out of ingested log events.

", + "smithy.api#required": {} + } + }, + "metricTransformations": { + "target": "com.amazonaws.cloudwatchlogs#MetricTransformations", + "traits": { + "smithy.api#documentation": "

A collection of information that defines how metric data gets emitted.

", + "smithy.api#required": {} + } + }, + "applyOnTransformedLogs": { + "target": "com.amazonaws.cloudwatchlogs#ApplyOnTransformedLogs", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

This parameter is valid only for log groups that have an active log transformer. For more\n information about log transformers, see PutTransformer.

\n

If the log group uses either a log-group level or account-level transformer, and you\n specify true, the metric filter will be applied on the transformed version of the\n log events instead of the original ingested log events.

" + } + }, + "fieldSelectionCriteria": { + "target": "com.amazonaws.cloudwatchlogs#FieldSelectionCriteria", + "traits": { + "smithy.api#documentation": "

A filter expression that specifies which log events should be processed by this metric\n filter based on system fields such as source account and source region. Uses selection\n criteria syntax with operators like =, !=, AND,\n OR, IN, NOT IN. Example: @aws.region =\n \"us-east-1\" or @aws.account IN [\"123456789012\", \"987654321098\"]. Maximum\n length: 2000 characters.

" + } + }, + "emitSystemFieldDimensions": { + "target": "com.amazonaws.cloudwatchlogs#EmitSystemFields", + "traits": { + "smithy.api#documentation": "

A list of system fields to emit as additional dimensions in the generated metrics. Valid\n values are @aws.account and @aws.region. These dimensions help\n identify the source of centralized log data and count toward the total dimension limit for\n metric filters.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutQueryDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutQueryDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutQueryDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a query definition for CloudWatch Logs Insights. For more information,\n see Analyzing Log Data with CloudWatch Logs Insights.

\n

To update a query definition, specify its queryDefinitionId in your request.\n The values of name, queryString, and logGroupNames are\n changed to the values that you specify in your update operation. No current values are\n retained from the current query definition. For example, imagine updating a current query\n definition that includes log groups. If you don't specify the logGroupNames\n parameter in your update operation, the query definition changes to contain no log\n groups.

\n

You must have the logs:PutQueryDefinition permission to be able to perform\n this operation.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutQueryDefinitionRequest": { + "type": "structure", + "members": { + "queryLanguage": { + "target": "com.amazonaws.cloudwatchlogs#QueryLanguage", + "traits": { + "smithy.api#documentation": "

Specify the query language to use for this query. The options are Logs Insights QL,\n OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that\n CloudWatch Logs supports, see Supported query\n languages.

" + } + }, + "name": { + "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionName", + "traits": { + "smithy.api#documentation": "

A name for the query definition. If you are saving numerous query definitions, we\n recommend that you name them. This way, you can find the ones you want by using the first part\n of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.

", + "smithy.api#required": {} + } + }, + "queryDefinitionId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "

If you are updating a query definition, use this parameter to specify the ID of the query\n definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query\n definitions.

\n

If you are creating a query definition, do not specify this parameter. CloudWatch\n generates a unique ID for the new query definition and include it in the response to this\n operation.

" + } + }, + "logGroupNames": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupNames", + "traits": { + "smithy.api#documentation": "

Use this parameter to include specific log groups as part of your query definition. If\n your query uses the OpenSearch Service query language, you specify the log group names inside\n the querystring instead of here.

\n

If you are updating an existing query definition for the Logs Insights QL or OpenSearch Service PPL and you omit this parameter, then the updated definition will contain no log\n groups.

" + } + }, + "queryString": { + "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionString", + "traits": { + "smithy.api#documentation": "

The query string to use for this definition. For more information, see CloudWatch Logs\n Insights Query Syntax.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.cloudwatchlogs#ClientToken", + "traits": { + "smithy.api#documentation": "

Used as an idempotency token, to avoid returning an exception if the service receives the\n same request twice because of a network error.

", + "smithy.api#idempotencyToken": {} + } + }, + "parameters": { + "target": "com.amazonaws.cloudwatchlogs#QueryParameterList", + "traits": { + "smithy.api#documentation": "

Use this parameter to include specific query parameters as part of your query definition.\n Query parameters are supported only for Logs Insights QL queries. Query parameters allow you\n to use placeholder variables in your query string that are substituted with values at execution\n time. Use the {{parameterName}} syntax in your query string to reference a\n parameter.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutQueryDefinitionResponse": { + "type": "structure", + "members": { + "queryDefinitionId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "

The ID of the query definition.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a resource policy allowing other Amazon Web Services services to put\n log events to this account, such as Amazon Route 53. This API has the following\n restrictions:

\n
    \n
  • \n

    \n Supported actions - Policy only supports\n logs:PutLogEvents and logs:CreateLogStream actions

    \n
    • \n
  • \n

    \n Supported principals - Policy only applies when\n operations are invoked by Amazon Web Services service principals (not IAM\n users, roles, or cross-account principals

    \n
    • \n
  • \n

    \n Policy limits - An account can have a maximum of 10\n policies without resourceARN and one per LogGroup resourceARN

    \n
    • \n
\n \n

Resource policies with actions invoked by non-Amazon Web Services service principals\n (such as IAM users, roles, or other Amazon Web Services accounts) will not be\n enforced. For access control involving these principals, use the IAM\n policies.

\n " + } + }, + "com.amazonaws.cloudwatchlogs#PutResourcePolicyRequest": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#PolicyName", + "traits": { + "smithy.api#documentation": "

Name of the new policy. This parameter is required.

" + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#PolicyDocument", + "traits": { + "smithy.api#documentation": "

Details of the new policy, including the identity of the principal that is enabled to\n put logs to this account. This is formatted as a JSON string. This parameter is\n required.

\n

The following example creates a resource policy enabling the Route 53 service to put\n DNS query logs in to the specified log group. Replace \"logArn\" with the ARN of\n your CloudWatch Logs resource, such as a log group or log stream.

\n

CloudWatch Logs also supports aws:SourceArn and aws:SourceAccount condition context keys.

\n

In the example resource policy, you would replace the value of SourceArn with\n the resource making the call from Route 53 to CloudWatch Logs. You would also\n replace the value of SourceAccount with the Amazon Web Services account ID making\n that call.

\n

\n

\n { \"Version\": \"2012-10-17\",\t\t \t \t \"Statement\": [ { \"Sid\":\n \"Route53LogsToCloudWatchLogs\", \"Effect\": \"Allow\", \"Principal\": { \"Service\": [\n \"route53.amazonaws.com\" ] }, \"Action\": \"logs:PutLogEvents\", \"Resource\": \"logArn\",\n \"Condition\": { \"ArnLike\": { \"aws:SourceArn\": \"myRoute53ResourceArn\" }, \"StringEquals\": {\n \"aws:SourceAccount\": \"myAwsAccountId\" } } } ] }\n

" + } + }, + "resourceArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the CloudWatch Logs resource to which the resource policy needs to be added\n or attached. Currently only supports LogGroup ARN.

" + } + }, + "expectedRevisionId": { + "target": "com.amazonaws.cloudwatchlogs#ExpectedRevisionId", + "traits": { + "smithy.api#documentation": "

The expected revision ID of the resource policy. Required when resourceArn is\n provided to prevent concurrent modifications. Use null when creating a resource\n policy for the first time.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutResourcePolicyResponse": { + "type": "structure", + "members": { + "resourcePolicy": { + "target": "com.amazonaws.cloudwatchlogs#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The new policy.

" + } + }, + "revisionId": { + "target": "com.amazonaws.cloudwatchlogs#ExpectedRevisionId", + "traits": { + "smithy.api#documentation": "

The revision ID of the created or updated resource policy. Only returned for\n resource-scoped policies.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutRetentionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutRetentionPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the retention of the specified log group. With a retention policy, you can\n configure the number of days for which to retain log events in the specified log\n group.

\n \n

CloudWatch Logs doesn't immediately delete log events when they reach their retention\n setting. It typically takes up to 72 hours after that before log events are deleted, but in\n rare situations might take longer.

\n

To illustrate, imagine that you change a log group to have a longer retention setting\n when it contains log events that are past the expiration date, but haven't been deleted.\n Those log events will take up to 72 hours to be deleted after the new retention date is\n reached. To make sure that log data is deleted permanently, keep a log group at its lower\n retention setting until 72 hours after the previous retention period ends. Alternatively,\n wait to change the retention setting until you confirm that the earlier log events are\n deleted.

\n

When log events reach their retention setting they are marked for deletion. After they\n are marked for deletion, they do not add to your archival storage costs anymore, even if\n they are not actually deleted until later. These log events marked for deletion are also not\n included when you use an API to retrieve the storedBytes value to see how many\n bytes a log group is storing.

\n " + } + }, + "com.amazonaws.cloudwatchlogs#PutRetentionPolicyRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + }, + "retentionInDays": { + "target": "com.amazonaws.cloudwatchlogs#Days", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutStorageTierPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutStorageTierPolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutStorageTierPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the storage tier policy for the account. When you set the storage tier to\n INTELLIGENT_TIERING, the service automatically moves log data to the most\n cost-effective storage tier based on access frequency.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutStorageTierPolicyRequest": { + "type": "structure", + "members": { + "storageTier": { + "target": "com.amazonaws.cloudwatchlogs#StorageTier", + "traits": { + "smithy.api#documentation": "

The storage tier to set for the account. Use INTELLIGENT_TIERING to\n automatically optimize storage costs by moving log data to the appropriate tier based on\n access frequency.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutStorageTierPolicyResponse": { + "type": "structure", + "members": { + "storageTier": { + "target": "com.amazonaws.cloudwatchlogs#StorageTier", + "traits": { + "smithy.api#documentation": "

The storage tier for the account.

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

The time when the storage tier policy was last updated, expressed as the number of\n milliseconds after January 1, 1970 00:00:00 UTC.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutSubscriptionFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutSubscriptionFilterRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a subscription filter and associates it with the specified log\n group. With subscription filters, you can subscribe to a real-time stream of log events\n ingested through PutLogEvents\n and have them delivered to a specific destination. When log events are sent to the receiving\n service, they are Base64 encoded and compressed with the GZIP format.

\n

The following destinations are supported for subscription filters:

\n
    \n
  • \n

    An Amazon Kinesis data stream belonging to the same account as the subscription\n filter, for same-account delivery.

    \n
    • \n
  • \n

    A logical destination created with PutDestination that belongs to a different account, for cross-account delivery.\n We currently support Kinesis Data Streams and Firehose as logical\n destinations.

    \n
    • \n
  • \n

    An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as\n the subscription filter, for same-account delivery.

    \n
    • \n
  • \n

    An Lambda function that belongs to the same account as the\n subscription filter, for same-account delivery.

    \n
    • \n
\n

Each log group can have up to two subscription filters associated with it. If you are\n updating an existing filter, you must specify the correct name in filterName.

\n

Using regular expressions in filter patterns is supported. For these filters, there is a\n quotas of quota of two regular expression patterns within a single filter pattern. There is\n also a quota of five regular expression patterns per log group. For more information about\n using regular expressions in filter patterns, see Filter pattern syntax for\n metric filters, subscription filters, filter log events, and Live Tail.

\n

To perform a PutSubscriptionFilter operation for any destination except a\n Lambda function, you must also have the iam:PassRole\n permission.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutSubscriptionFilterRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} + } + }, + "filterName": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "

A name for the subscription filter. If you are updating an existing filter, you must\n specify the correct name in filterName. To find the name of the filter currently\n associated with a log group, use DescribeSubscriptionFilters.

", + "smithy.api#required": {} + } + }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern", + "traits": { + "smithy.api#documentation": "

A filter pattern for subscribing to a filtered stream of log events.

", + "smithy.api#required": {} + } + }, + "destinationArn": { + "target": "com.amazonaws.cloudwatchlogs#DestinationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the destination to deliver matching log events to. Currently, the supported\n destinations are:

\n
    \n
  • \n

    An Amazon Kinesis stream belonging to the same account as the subscription filter,\n for same-account delivery.

    \n
    • \n
  • \n

    A logical destination (specified using an ARN) belonging to a different account,\n for cross-account delivery.

    \n

    If you're setting up a cross-account subscription, the destination must have an IAM\n policy associated with it. The IAM policy must allow the sender to send logs to the\n destination. For more information, see PutDestinationPolicy.

    \n
    • \n
  • \n

    A Kinesis Data Firehose delivery stream belonging to the same account as the\n subscription filter, for same-account delivery.

    \n
    • \n
  • \n

    A Lambda function belonging to the same account as the subscription\n filter, for same-account delivery.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.cloudwatchlogs#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log\n events to the destination stream. You don't need to provide the ARN when you are working with\n a logical destination for cross-account delivery.

" + } + }, + "distribution": { + "target": "com.amazonaws.cloudwatchlogs#Distribution", + "traits": { + "smithy.api#documentation": "

The method used to distribute log data to the destination. By default, log data is\n grouped by log stream, but the grouping can be set to random for a more even distribution.\n This property is only applicable when the destination is an Amazon Kinesis data stream.\n

" + } + }, + "applyOnTransformedLogs": { + "target": "com.amazonaws.cloudwatchlogs#ApplyOnTransformedLogs", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

This parameter is valid only for log groups that have an active log transformer. For more\n information about log transformers, see PutTransformer.

\n

If the log group uses either a log-group level or account-level transformer, and you\n specify true, the subscription filter will be applied on the transformed version\n of the log events instead of the original ingested log events.

" + } + }, + "fieldSelectionCriteria": { + "target": "com.amazonaws.cloudwatchlogs#FieldSelectionCriteria", + "traits": { + "smithy.api#documentation": "

A filter expression that specifies which log events should be processed by this\n subscription filter based on system fields such as source account and source region. Uses\n selection criteria syntax with operators like =, !=,\n AND, OR, IN, NOT IN. Example:\n @aws.region NOT IN [\"cn-north-1\"] or @aws.account = \"123456789012\" AND\n @aws.region = \"us-east-1\". Maximum length: 2000 characters.

" + } + }, + "emitSystemFields": { + "target": "com.amazonaws.cloudwatchlogs#EmitSystemFields", + "traits": { + "smithy.api#documentation": "

A list of system fields to include in the log events sent to the subscription destination.\n Valid values are @aws.account, @aws.region, and\n @source.log. These fields provide\n source information for centralized log data in the forwarded payload.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutSyslogConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutSyslogConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a syslog configuration for a log group. This enables ingestion of\n syslog data through the specified VPC endpoint into the log group.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutSyslogConfigurationRequest": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

The name or ARN of the log group to associate with the syslog configuration.

", + "smithy.api#required": {} + } + }, + "vpcEndpointId": { + "target": "com.amazonaws.cloudwatchlogs#VpcEndpointId", + "traits": { + "smithy.api#documentation": "

The ID of the VPC endpoint to use for syslog ingestion.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutTransformer": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutTransformerRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a log transformer for a single log group. You use\n log transformers to transform log events into a different format, making them easier for you\n to process and analyze. You can also transform logs from different sources into standardized\n formats that contains relevant, source-specific information.

\n

After you have created a transformer, CloudWatch Logs performs the transformations at\n the time of log ingestion. You can then refer to the transformed versions of the logs during\n operations such as querying with CloudWatch Logs Insights or creating metric filters or\n subscription filers.

\n

You can also use a transformer to copy metadata from metadata keys into the log events\n themselves. This metadata can include log group name, log stream name, account ID and\n Region.

\n

A transformer for a log group is a series of processors, where each processor applies one\n type of transformation to the log events ingested into this log group. The processors work one\n after another, in the order that you list them, like a pipeline. For more information about\n the available processors to use in a transformer, see Processors that you can use.

\n

Having log events in standardized format enables visibility across your applications for\n your log analysis, reporting, and alarming needs. CloudWatch Logs provides transformation\n for common log types with out-of-the-box transformation templates for major Amazon Web Services\n log sources such as VPC flow logs, Lambda, and Amazon RDS. You can use\n pre-built transformation templates or create custom transformation policies.

\n

You can create transformers only for the log groups in the Standard log class.

\n

You can also set up a transformer at the account level. For more information, see PutAccountPolicy. If there is both a log-group level transformer created with\n PutTransformer and an account-level transformer that could apply to the same\n log group, the log group uses only the log-group level transformer. It ignores the\n account-level transformer.

" + } + }, + "com.amazonaws.cloudwatchlogs#PutTransformerRequest": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

Specify either the name or ARN of the log group to create the transformer for.

", + "smithy.api#required": {} + } + }, + "transformerConfig": { + "target": "com.amazonaws.cloudwatchlogs#Processors", + "traits": { + "smithy.api#documentation": "

This structure contains the configuration of this log transformer. A log transformer is an\n array of processors, where each processor applies one type of transformation to the log events\n that are ingested.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#QueryCharOffset": { + "type": "integer" + }, + "com.amazonaws.cloudwatchlogs#QueryCompileError": { + "type": "structure", + "members": { + "location": { + "target": "com.amazonaws.cloudwatchlogs#QueryCompileErrorLocation", + "traits": { + "smithy.api#documentation": "

Reserved.

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

Reserved.

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

Reserved.

" + } + }, + "com.amazonaws.cloudwatchlogs#QueryCompileErrorLocation": { + "type": "structure", + "members": { + "startCharOffset": { + "target": "com.amazonaws.cloudwatchlogs#QueryCharOffset", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } + }, + "endCharOffset": { + "target": "com.amazonaws.cloudwatchlogs#QueryCharOffset", + "traits": { + "smithy.api#documentation": "

Reserved.

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

Reserved.

" + } + }, + "com.amazonaws.cloudwatchlogs#QueryDefinition": { + "type": "structure", + "members": { + "queryLanguage": { + "target": "com.amazonaws.cloudwatchlogs#QueryLanguage", + "traits": { + "smithy.api#documentation": "

The query language used for this query. For more information about the query languages\n that CloudWatch Logs supports, see Supported query\n languages.

" + } + }, + "queryDefinitionId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "

The unique ID of the query definition.

" + } + }, + "name": { + "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionName", + "traits": { + "smithy.api#documentation": "

The name of the query definition.

" + } + }, + "queryString": { + "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionString", + "traits": { + "smithy.api#documentation": "

The query string to use for this definition. For more information, see CloudWatch Logs\n Insights Query Syntax.

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

The date that the query definition was most recently modified.

" + } + }, + "logGroupNames": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupNames", + "traits": { + "smithy.api#documentation": "

If this query definition contains a list of log groups that it is limited to, that list\n appears here.

" + } + }, + "parameters": { + "target": "com.amazonaws.cloudwatchlogs#QueryParameterList", + "traits": { + "smithy.api#documentation": "

If this query definition contains a list of query parameters that define placeholder\n variables for the query string, that list appears here.

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

This structure contains details about a saved CloudWatch Logs Insights query\n definition.

" + } + }, + "com.amazonaws.cloudwatchlogs#QueryDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#QueryDefinition" + } + }, + "com.amazonaws.cloudwatchlogs#QueryDefinitionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.cloudwatchlogs#QueryDefinitionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.cloudwatchlogs#QueryDuration": { + "type": "long" + }, + "com.amazonaws.cloudwatchlogs#QueryId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#QueryInfo": { + "type": "structure", + "members": { + "queryLanguage": { + "target": "com.amazonaws.cloudwatchlogs#QueryLanguage", + "traits": { + "smithy.api#documentation": "

The query language used for this query. For more information about the query languages\n that CloudWatch Logs supports, see Supported query\n languages.

" + } + }, + "queryId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "

The unique ID number of this query.

" + } + }, + "queryString": { + "target": "com.amazonaws.cloudwatchlogs#QueryString", + "traits": { + "smithy.api#documentation": "

The query string used in this query.

" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#QueryStatus", + "traits": { + "smithy.api#documentation": "

The status of this query. Possible values are Cancelled,\n Complete, Failed, Running, Scheduled,\n and Unknown.

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

The date and time that this query was created.

" + } + }, + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group scanned by this query.

" + } + }, + "queryDuration": { + "target": "com.amazonaws.cloudwatchlogs#QueryDuration", + "traits": { + "smithy.api#documentation": "

The duration in milliseconds that the query took to execute.

" + } + }, + "bytesScanned": { + "target": "com.amazonaws.cloudwatchlogs#BytesScannedValue", + "traits": { + "smithy.api#documentation": "

The total number of bytes scanned by the query. This indicates the cost associated with the query.

" + } + }, + "userIdentity": { + "target": "com.amazonaws.cloudwatchlogs#UserIdentity", + "traits": { + "smithy.api#documentation": "

The ARN of the user who ran the query.

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

Information about one CloudWatch Logs Insights query that matches the request in a\n DescribeQueries operation.

" + } + }, + "com.amazonaws.cloudwatchlogs#QueryInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#QueryInfo" + } + }, + "com.amazonaws.cloudwatchlogs#QueryLanguage": { + "type": "enum", + "members": { + "CWLI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CWLI" + } + }, + "SQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL" + } + }, + "PPL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PPL" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#QueryListMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.cloudwatchlogs#QueryParameter": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#QueryParameterName", + "traits": { + "smithy.api#documentation": "

The name of the query parameter. A query parameter name must start with a letter or\n underscore, and contain only letters, digits, and underscores.

", + "smithy.api#required": {} + } + }, + "defaultValue": { + "target": "com.amazonaws.cloudwatchlogs#QueryParameterDefaultValue", + "traits": { + "smithy.api#documentation": "

The default value to use for this query parameter if no value is supplied at execution\n time.

" + } + }, + "description": { + "target": "com.amazonaws.cloudwatchlogs#QueryParameterDescription", + "traits": { + "smithy.api#documentation": "

A description of the query parameter that explains its purpose or expected values.

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

This structure defines a query parameter for a saved CloudWatch Logs Insights query\n definition. Query parameters are supported only for Logs Insights QL queries. They are\n placeholder variables that you can reference in a query string using the\n {{parameterName}} syntax. Each parameter can include a default value and a\n description.

" + } + }, + "com.amazonaws.cloudwatchlogs#QueryParameterDefaultValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.cloudwatchlogs#QueryParameterDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "com.amazonaws.cloudwatchlogs#QueryParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#QueryParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.cloudwatchlogs#QueryParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" + } + }, + "com.amazonaws.cloudwatchlogs#QueryResults": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#ResultRows" + } + }, + "com.amazonaws.cloudwatchlogs#QueryStatistics": { + "type": "structure", + "members": { + "recordsMatched": { + "target": "com.amazonaws.cloudwatchlogs#StatsValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of log events that matched the query string.

" + } + }, + "recordsScanned": { + "target": "com.amazonaws.cloudwatchlogs#StatsValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of log events scanned during the query.

" + } + }, + "estimatedRecordsSkipped": { + "target": "com.amazonaws.cloudwatchlogs#StatsValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

An estimate of the number of log events that were skipped when processing this query,\n because the query contained an indexed field. Skipping these entries lowers query costs and\n improves the query performance time. For more information about field indexes, see PutIndexPolicy.

" + } + }, + "bytesScanned": { + "target": "com.amazonaws.cloudwatchlogs#StatsValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of bytes in the log events scanned during the query.

" + } + }, + "estimatedBytesSkipped": { + "target": "com.amazonaws.cloudwatchlogs#StatsValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

An estimate of the number of bytes in the log events that were skipped when processing\n this query, because the query contained an indexed field. Skipping these entries lowers query\n costs and improves the query performance time. For more information about field indexes, see\n PutIndexPolicy.

" + } + }, + "logGroupsScanned": { + "target": "com.amazonaws.cloudwatchlogs#StatsValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of log groups that were scanned by this query.

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

Contains the number of log events scanned by the query, the number of log events that\n matched the query criteria, and the total number of bytes in the log events that were\n scanned.

\n

If the query involved log groups that have field index policies, the estimated number of\n skipped log events and the total bytes of those skipped log events are included. Using field\n indexes to skip log events in queries reduces scan volume and improves performance. For more\n information, see Create field indexes\n to improve query performance and reduce scan volume.

" + } + }, + "com.amazonaws.cloudwatchlogs#QueryStatus": { + "type": "enum", + "members": { + "Scheduled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Scheduled" + } + }, + "Running": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Running" + } + }, + "Complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Complete" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "Cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelled" + } + }, + "Timeout": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Timeout" + } + }, + "Unknown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unknown" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#QueryString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10000 + } + } + }, + "com.amazonaws.cloudwatchlogs#QuoteCharacter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#RecordField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#FieldHeader", + "traits": { + "smithy.api#documentation": "

The name to use when specifying this record field in a CreateDelivery or UpdateDeliveryConfiguration operation.

" + } + }, + "mandatory": { + "target": "com.amazonaws.cloudwatchlogs#Boolean", + "traits": { + "smithy.api#documentation": "

If this is true, the record field must be present in the\n recordFields parameter provided to a CreateDelivery or UpdateDeliveryConfiguration operation.

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

A structure that represents a valid record field header and whether it is\n mandatory.

" + } + }, + "com.amazonaws.cloudwatchlogs#RecordFields": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#FieldHeader" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.cloudwatchlogs#RecordsCount": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.cloudwatchlogs#RejectedEntityInfo": { + "type": "structure", + "members": { + "errorType": { + "target": "com.amazonaws.cloudwatchlogs#EntityRejectionErrorType", + "traits": { + "smithy.api#documentation": "

The type of error that caused the rejection of the entity when calling\n PutLogEvents.

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

If an entity is rejected when a PutLogEvents request was made, this includes\n details about the reason for the rejection.

" + } + }, + "com.amazonaws.cloudwatchlogs#RejectedLogEventsInfo": { + "type": "structure", + "members": { + "tooNewLogEventStartIndex": { + "target": "com.amazonaws.cloudwatchlogs#LogEventIndex", + "traits": { + "smithy.api#documentation": "

The index of the first log event that is too new. This field is inclusive.

" + } + }, + "tooOldLogEventEndIndex": { + "target": "com.amazonaws.cloudwatchlogs#LogEventIndex", + "traits": { + "smithy.api#documentation": "

The index of the last log event that is too old. This field is exclusive.

" + } + }, + "expiredLogEventEndIndex": { + "target": "com.amazonaws.cloudwatchlogs#LogEventIndex", + "traits": { + "smithy.api#documentation": "

The expired log events.

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

Represents the rejected events.

" + } + }, + "com.amazonaws.cloudwatchlogs#RenameKeyEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#RenameKeyEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.cloudwatchlogs#RenameKeyEntry": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.cloudwatchlogs#Key", + "traits": { + "smithy.api#documentation": "

The key to rename

", + "smithy.api#required": {} + } + }, + "renameTo": { + "target": "com.amazonaws.cloudwatchlogs#RenameTo", + "traits": { + "smithy.api#documentation": "

The string to use for the new key name

", + "smithy.api#required": {} + } + }, + "overwriteIfExists": { + "target": "com.amazonaws.cloudwatchlogs#OverwriteIfExists", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether to overwrite the existing value if the destination key already exists.\n The default is false\n

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

This object defines one key that will be renamed with the renameKey processor.

" + } + }, + "com.amazonaws.cloudwatchlogs#RenameKeys": { + "type": "structure", + "members": { + "entries": { + "target": "com.amazonaws.cloudwatchlogs#RenameKeyEntries", + "traits": { + "smithy.api#documentation": "

An array of RenameKeyEntry objects, where each object contains the\n information about a single key to rename.

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

Use this processor to rename keys in a log event.

\n

For more information about this processor including examples, see renameKeys in the CloudWatch Logs User Guide.

" + } + }, + "com.amazonaws.cloudwatchlogs#RenameTo": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cloudwatchlogs#RequestId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#ResourceAlreadyExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The specified resource already exists.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#ResourceArns": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#Arn" + } + }, + "com.amazonaws.cloudwatchlogs#ResourceConfig": { + "type": "union", + "members": { + "openSearchResourceConfig": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchResourceConfig", + "traits": { + "smithy.api#documentation": "

This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service.

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

This structure contains configuration details about an integration between CloudWatch Logs and another entity.

" + } + }, + "com.amazonaws.cloudwatchlogs#ResourceIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[\\w+=/:,.@\\-\\*]*$" + } + }, + "com.amazonaws.cloudwatchlogs#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The specified resource does not exist.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#ResourcePolicies": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#ResourcePolicy" + } + }, + "com.amazonaws.cloudwatchlogs#ResourcePolicy": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#PolicyName", + "traits": { + "smithy.api#documentation": "

The name of the resource policy.

" + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#PolicyDocument", + "traits": { + "smithy.api#documentation": "

The details of the policy.

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

Timestamp showing when this policy was last updated, expressed as the number of\n milliseconds after Jan 1, 1970 00:00:00 UTC.

" + } + }, + "policyScope": { + "target": "com.amazonaws.cloudwatchlogs#PolicyScope", + "traits": { + "smithy.api#documentation": "

Specifies scope of the resource policy. Valid values are ACCOUNT or RESOURCE.

" + } + }, + "resourceArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the CloudWatch Logs resource to which the resource policy is attached. Only\n populated for resource-scoped policies.

" + } + }, + "revisionId": { + "target": "com.amazonaws.cloudwatchlogs#ExpectedRevisionId", + "traits": { + "smithy.api#documentation": "

The revision ID of the resource policy. Only populated for resource-scoped\n policies.

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

A policy enabling one or more entities to put logs to a log group in this\n account.

" + } + }, + "com.amazonaws.cloudwatchlogs#ResourceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\w-_]*$" + } + }, + "com.amazonaws.cloudwatchlogs#ResourceTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#ResourceType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.cloudwatchlogs#ResultField": { + "type": "structure", + "members": { + "field": { + "target": "com.amazonaws.cloudwatchlogs#Field", + "traits": { + "smithy.api#documentation": "

The log event field.

" + } + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#Value", + "traits": { + "smithy.api#documentation": "

The value of this field.

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

Contains one field from one log event returned by a CloudWatch Logs Insights query, along\n with the value of that field.

\n

For more information about the fields that are generated by CloudWatch logs, see Supported\n Logs and Discovered Fields.

" + } + }, + "com.amazonaws.cloudwatchlogs#ResultRows": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#ResultField" + } + }, + "com.amazonaws.cloudwatchlogs#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#S3Configuration": { + "type": "structure", + "members": { + "destinationIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI where query results are delivered. Must be a valid S3 URI format.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.cloudwatchlogs#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that grants permissions to write query results to the specified\n Amazon S3 destination.

", + "smithy.api#required": {} + } + }, + "ownerAccountId": { + "target": "com.amazonaws.cloudwatchlogs#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services accountId for the bucket owning account.

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

The Amazon Resource Name (ARN) of the KMS encryption key. Must belong to the same Amazon Web Services Region\n as the destination Amazon S3 bucket.

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

Configuration for Amazon S3 destination where scheduled query results are delivered.

" + } + }, + "com.amazonaws.cloudwatchlogs#S3DeliveryConfiguration": { + "type": "structure", + "members": { + "suffixPath": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySuffixPath", + "traits": { + "smithy.api#documentation": "

This string allows re-configuring the S3 object prefix to contain either static or\n variable sections. The valid variables to use in the suffix path will vary by each log source.\n To find the values supported for the suffix path for each log source, use the DescribeConfigurationTemplates operation and check the\n allowedSuffixPathFields field in the response.

" + } + }, + "enableHiveCompatiblePath": { + "target": "com.amazonaws.cloudwatchlogs#Boolean", + "traits": { + "smithy.api#documentation": "

This parameter causes the S3 objects that contain delivered logs to use a prefix structure\n that allows for integration with Apache Hive.

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

This structure contains delivery configurations that apply only when the delivery\n destination resource is an S3 bucket.

" + } + }, + "com.amazonaws.cloudwatchlogs#S3TableIntegrationSource": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.cloudwatchlogs#S3TableIntegrationSourceIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier for this data source association.

" + } + }, + "dataSource": { + "target": "com.amazonaws.cloudwatchlogs#DataSource", + "traits": { + "smithy.api#documentation": "

The data source associated with the S3 Table Integration.

" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#S3TableIntegrationSourceStatus", + "traits": { + "smithy.api#documentation": "

The current status of the data source association.

" + } + }, + "statusReason": { + "target": "com.amazonaws.cloudwatchlogs#S3TableIntegrationSourceStatusReason", + "traits": { + "smithy.api#documentation": "

Additional information about the status of the data source association.

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

The timestamp when the data source association was created.

" + } + }, + "parentSourceIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#S3TableIntegrationSourceIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the parent data source for this association.

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

Represents a data source association with an S3 Table Integration, including its status\n and metadata.

" + } + }, + "com.amazonaws.cloudwatchlogs#S3TableIntegrationSourceIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.cloudwatchlogs#S3TableIntegrationSourceStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UNHEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNHEALTHY" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "DATA_SOURCE_DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SOURCE_DELETE_IN_PROGRESS" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#S3TableIntegrationSourceStatusReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#S3TableIntegrationSources": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#S3TableIntegrationSource" + } + }, + "com.amazonaws.cloudwatchlogs#S3TablesDatasourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#S3TablesDatasourceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#S3TablesIntegration": { + "type": "structure", + "members": { + "datasourceName": { + "target": "com.amazonaws.cloudwatchlogs#S3TablesDatasourceName", + "traits": { + "smithy.api#documentation": "

The name of the S3 Tables datasource.

" + } + }, + "datasourceType": { + "target": "com.amazonaws.cloudwatchlogs#S3TablesDatasourceType", + "traits": { + "smithy.api#documentation": "

The type of the S3 Tables datasource.

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

Contains information about the S3 Tables integration configuration for a configuration\n template.

" + } + }, + "com.amazonaws.cloudwatchlogs#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.cloudwatchlogs#ScheduleExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#ScheduleTimezone": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#ScheduleType": { + "type": "enum", + "members": { + "CUSTOMER_MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER_MANAGED" + } + }, + "AWS_MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_MANAGED" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#ScheduledQueryDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.cloudwatchlogs#ScheduledQueryDestination": { + "type": "structure", + "members": { + "destinationType": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryDestinationType", + "traits": { + "smithy.api#documentation": "

The type of destination for query results.

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

The identifier for the destination where results are delivered.

" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#ActionStatus", + "traits": { + "smithy.api#documentation": "

The processing status of the destination delivery.

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

The identifier of the processed result at the destination.

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

Error message if destination processing failed.

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

Information about a destination where scheduled query results are processed, including\n processing status and any error messages.

" + } + }, + "com.amazonaws.cloudwatchlogs#ScheduledQueryDestinationList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryDestination" + } + }, + "com.amazonaws.cloudwatchlogs#ScheduledQueryDestinationType": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + }, + "LOOKUP_TABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOOKUP_TABLE" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#ScheduledQueryIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.cloudwatchlogs#ScheduledQueryLogGroupIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.cloudwatchlogs#ScheduledQueryName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.cloudwatchlogs#ScheduledQueryState": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#ScheduledQuerySummary": { + "type": "structure", + "members": { + "scheduledQueryArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the scheduled query.

" + } + }, + "name": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryName", + "traits": { + "smithy.api#documentation": "

The name of the scheduled query.

" + } + }, + "state": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryState", + "traits": { + "smithy.api#documentation": "

The current state of the scheduled query.

" + } + }, + "scheduleType": { + "target": "com.amazonaws.cloudwatchlogs#ScheduleType", + "traits": { + "smithy.api#documentation": "

The schedule type of the scheduled query. Valid values are\n CUSTOMER_MANAGED and AWS_MANAGED.

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

The timestamp when the scheduled query was last executed.

" + } + }, + "lastExecutionStatus": { + "target": "com.amazonaws.cloudwatchlogs#ExecutionStatus", + "traits": { + "smithy.api#documentation": "

The status of the most recent execution.

" + } + }, + "scheduleExpression": { + "target": "com.amazonaws.cloudwatchlogs#ScheduleExpression", + "traits": { + "smithy.api#documentation": "

The cron expression that defines when the scheduled query runs.

" + } + }, + "timezone": { + "target": "com.amazonaws.cloudwatchlogs#ScheduleTimezone", + "traits": { + "smithy.api#documentation": "

The timezone used for evaluating the schedule expression.

" + } + }, + "destinationConfiguration": { + "target": "com.amazonaws.cloudwatchlogs#DestinationConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration for where query results are delivered.

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

The timestamp when the scheduled query was created.

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

The timestamp when the scheduled query was last updated.

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

Summary information about a scheduled query, including basic configuration and execution\n status.

" + } + }, + "com.amazonaws.cloudwatchlogs#ScheduledQuerySummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQuerySummary" + } + }, + "com.amazonaws.cloudwatchlogs#Scope": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#SearchedLogStream": { + "type": "structure", + "members": { + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "

The name of the log stream.

" + } + }, + "searchedCompletely": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamSearchedCompletely", + "traits": { + "smithy.api#documentation": "

Indicates whether all the events in this log stream were searched.

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

Represents the search status of a log stream.

" + } + }, + "com.amazonaws.cloudwatchlogs#SearchedLogStreams": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#SearchedLogStream" + } + }, + "com.amazonaws.cloudwatchlogs#SelectionCriteria": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#SequenceToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#Service": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\w_-]*$" + } + }, + "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

This request exceeds a service quota.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#ServiceUnavailableException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The service cannot complete the request.

", + "smithy.api#error": "server" + } + }, + "com.amazonaws.cloudwatchlogs#SessionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#SessionStreamingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

This exception is returned if an unknown error occurs during a Live Tail session.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#SessionTimeoutException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

This exception is returned in a Live Tail stream when the Live Tail session times out.\n Live Tail sessions time out after three hours.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#Source": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cloudwatchlogs#SourceTimezone": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#SplitString": { + "type": "structure", + "members": { + "entries": { + "target": "com.amazonaws.cloudwatchlogs#SplitStringEntries", + "traits": { + "smithy.api#documentation": "

An array of SplitStringEntry objects, where each object contains the\n information about one field to split.

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

Use this processor to split a field into an array of strings using a delimiting\n character.

\n

For more information about this processor including examples, see splitString in the CloudWatch Logs User Guide.

" + } + }, + "com.amazonaws.cloudwatchlogs#SplitStringDelimiter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cloudwatchlogs#SplitStringEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#SplitStringEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.cloudwatchlogs#SplitStringEntry": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.cloudwatchlogs#Source", + "traits": { + "smithy.api#documentation": "

The key of the field to split.

", + "smithy.api#required": {} + } + }, + "delimiter": { + "target": "com.amazonaws.cloudwatchlogs#SplitStringDelimiter", + "traits": { + "smithy.api#documentation": "

The separator characters to split the string entry on.

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

This object defines one log field that will be split with the splitString processor.

" + } + }, + "com.amazonaws.cloudwatchlogs#StandardUnit": { + "type": "enum", + "members": { + "Seconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Seconds" + } + }, + "Microseconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Microseconds" + } + }, + "Milliseconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Milliseconds" + } + }, + "Bytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bytes" + } + }, + "Kilobytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobytes" + } + }, + "Megabytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabytes" + } + }, + "Gigabytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabytes" + } + }, + "Terabytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabytes" + } + }, + "Bits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bits" + } + }, + "Kilobits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobits" + } + }, + "Megabits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabits" + } + }, + "Gigabits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabits" + } + }, + "Terabits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabits" + } + }, + "Percent": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Percent" + } + }, + "Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Count" + } + }, + "BytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bytes/Second" + } + }, + "KilobytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobytes/Second" + } + }, + "MegabytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabytes/Second" + } + }, + "GigabytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabytes/Second" + } + }, + "TerabytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabytes/Second" + } + }, + "BitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bits/Second" + } + }, + "KilobitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobits/Second" + } + }, + "MegabitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabits/Second" + } + }, + "GigabitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabits/Second" + } + }, + "TerabitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabits/Second" + } + }, + "CountSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Count/Second" + } + }, + "None": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#StartFromHead": { + "type": "boolean" + }, + "com.amazonaws.cloudwatchlogs#StartLiveTail": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#StartLiveTailRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#StartLiveTailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a Live Tail streaming session for one or more log groups. A Live Tail session\n returns a stream of log events that have been recently ingested in the log groups. For more\n information, see Use Live Tail to view logs\n in near real time.

\n

The response to this operation is a response stream, over which the server sends live log\n events and the client receives them.

\n

The following objects are sent over the stream:

\n
    \n
  • \n

    A single LiveTailSessionStart object is sent at the start of the session.

    \n
    • \n
  • \n

    Every second, a LiveTailSessionUpdate object is sent. Each of these objects contains an array\n of the actual log events.

    \n

    If no new log events were ingested in the past second, the\n LiveTailSessionUpdate object will contain an empty array.

    \n

    The array of log events contained in a LiveTailSessionUpdate can include\n as many as 500 log events. If the number of log events matching the request exceeds 500\n per second, the log events are sampled down to 500 log events to be included in each\n LiveTailSessionUpdate object.

    \n

    If your client consumes the log events slower than the server produces them, CloudWatch Logs buffers up to 10 LiveTailSessionUpdate events or 5000 log\n events, after which it starts dropping the oldest events.

    \n
    • \n
  • \n

    A SessionStreamingException object is returned if an unknown error occurs on the\n server side.

    \n
    • \n
  • \n

    A SessionTimeoutException object is returned when the session times out, after it\n has been kept open for three hours.

    \n
    • \n
\n \n

The StartLiveTail API routes requests using SDK host prefix injection. SDK versions released before April 1, 2026 route to\n streaming-logs.Region.amazonaws.com, which does not support VPC endpoints. SDK versions released on or after April 1, 2026 route to\n stream-logs.Region.amazonaws.com, which supports VPC endpoints. To set up a VPC endpoint for this API, see Creating a VPC endpoint for CloudWatch Logs\n .

\n \n \n

You can end a session before it times out by closing the session stream or by closing\n the client that is receiving the stream. The session also ends if the established connection\n between the client and the server breaks.

\n \n

For examples of using an SDK to start a Live Tail session, see Start\n a Live Tail session using an Amazon Web Services SDK.

", + "smithy.api#endpoint": { + "hostPrefix": "stream-" + } + } + }, + "com.amazonaws.cloudwatchlogs#StartLiveTailLogGroupIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.cloudwatchlogs#StartLiveTailRequest": { + "type": "structure", + "members": { + "logGroupIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#StartLiveTailLogGroupIdentifiers", + "traits": { + "smithy.api#documentation": "

An array where each item in the array is a log group to include in the Live Tail\n session.

\n

Specify each log group by its ARN.

\n

If you specify an ARN, the ARN can't end with an asterisk (*).

\n \n

You can include up to 10 log groups.

\n ", + "smithy.api#required": {} + } + }, + "logStreamNames": { + "target": "com.amazonaws.cloudwatchlogs#InputLogStreamNames", + "traits": { + "smithy.api#documentation": "

If you specify this parameter, then only log events in the log streams that you specify\n here are included in the Live Tail session.

\n

If you specify this field, you can't also specify the logStreamNamePrefixes\n field.

\n \n

You can specify this parameter only if you specify only one log group in\n logGroupIdentifiers.

\n " + } + }, + "logStreamNamePrefixes": { + "target": "com.amazonaws.cloudwatchlogs#InputLogStreamNames", + "traits": { + "smithy.api#documentation": "

If you specify this parameter, then only log events in the log streams that have names\n that start with the prefixes that you specify here are included in the Live Tail\n session.

\n

If you specify this field, you can't also specify the logStreamNames\n field.

\n \n

You can specify this parameter only if you specify only one log group in\n logGroupIdentifiers.

\n " + } + }, + "logEventFilterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern", + "traits": { + "smithy.api#documentation": "

An optional pattern to use to filter the results to include only log events that match the\n pattern. For example, a filter pattern of error 404 causes only log events that\n include both error and 404 to be included in the Live Tail\n stream.

\n

Regular expression filter patterns are supported.

\n

For more information about filter pattern syntax, see Filter and Pattern\n Syntax.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#StartLiveTailResponse": { + "type": "structure", + "members": { + "responseStream": { + "target": "com.amazonaws.cloudwatchlogs#StartLiveTailResponseStream", + "traits": { + "smithy.api#documentation": "

An object that includes the stream returned by your request. It can include both log\n events and exceptions.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#StartLiveTailResponseStream": { + "type": "union", + "members": { + "sessionStart": { + "target": "com.amazonaws.cloudwatchlogs#LiveTailSessionStart", + "traits": { + "smithy.api#documentation": "

This object contains information about this Live Tail session, including the log groups\n included and the log stream filters, if any.

" + } + }, + "sessionUpdate": { + "target": "com.amazonaws.cloudwatchlogs#LiveTailSessionUpdate", + "traits": { + "smithy.api#documentation": "

This object contains the log events and session metadata.

" + } + }, + "SessionTimeoutException": { + "target": "com.amazonaws.cloudwatchlogs#SessionTimeoutException", + "traits": { + "smithy.api#documentation": "

This exception is returned in the stream when the Live Tail session times out. Live Tail\n sessions time out after three hours.

" + } + }, + "SessionStreamingException": { + "target": "com.amazonaws.cloudwatchlogs#SessionStreamingException", + "traits": { + "smithy.api#documentation": "

This exception is returned if an unknown error occurs.

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

This object includes the stream returned by your StartLiveTail\n request.

", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.cloudwatchlogs#StartQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#StartQueryRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#StartQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#MalformedQueryException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a query of one or more log groups or data sources using CloudWatch Logs\n Insights. You specify the log groups or data sources and time range to query and the query\n string to use. You can query up to 10 data sources in a single query.

\n

For more information, see CloudWatch Logs Insights Query\n Syntax.

\n

After you run a query using StartQuery, the query results are stored by\n CloudWatch Logs. You can use GetQueryResults to retrieve the results of a query, using the queryId\n that StartQuery returns.

\n

Interactive queries started with StartQuery share concurrency limits with\n automated scheduled query executions. Both types of queries count toward the same regional\n concurrent query quota, so high scheduled query activity may affect the availability of\n concurrent slots for interactive queries.

\n \n

To specify the log groups to query, a StartQuery operation must include one\n of the following:

\n
    \n
  • \n

    Either exactly one of the following parameters: logGroupName,\n logGroupNames, or logGroupIdentifiers\n

    \n
    • \n
  • \n

    Or the queryString must include a SOURCE command to select\n log groups for the query. The SOURCE command can select log groups based on\n log group name prefix, account ID, and log class, or select data sources using\n dataSource syntax in LogsQL, PPL, and SQL. In LogsQL, the SOURCE command\n also supports filtering by log group tags.\n

    \n

    For more information about the SOURCE command, see SOURCE.

    \n
    • \n
\n \n

If you have associated a KMS key with the query results in this\n account, then StartQuery uses\n that key to encrypt the results when it stores them. If no key is associated with query\n results, the query results are encrypted with the default CloudWatch Logs encryption\n method.

\n

Queries time out after 60 minutes of runtime. If your queries are timing out, reduce the\n time range being searched or partition your query into a number of queries.

\n

If you are using CloudWatch cross-account observability, you can use this operation\n in a monitoring account to start a query in a linked source account. For more information, see\n CloudWatch cross-account observability. For a cross-account StartQuery\n operation, the query definition must be defined in the monitoring account.

\n

You can have up to 100 concurrent CloudWatch Logs insights queries, including queries\n that have been added to dashboards.

" + } + }, + "com.amazonaws.cloudwatchlogs#StartQueryRequest": { + "type": "structure", + "members": { + "queryLanguage": { + "target": "com.amazonaws.cloudwatchlogs#QueryLanguage", + "traits": { + "smithy.api#documentation": "

Specify the query language to use for this query. The options are Logs Insights QL,\n OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that\n CloudWatch Logs supports, see Supported query\n languages.

" + } + }, + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The log group on which to perform the query.

\n \n

A StartQuery operation must include exactly one of the following\n parameters: logGroupName, logGroupNames, or\n logGroupIdentifiers. The exception is queries using the OpenSearch Service\n SQL query language, where you specify the log group names inside the\n querystring instead of here.

\n " + } + }, + "logGroupNames": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupNames", + "traits": { + "smithy.api#documentation": "

The list of log groups to be queried. You can include up to 50 log groups.

\n \n

A StartQuery operation must include exactly one of the following\n parameters: logGroupName, logGroupNames, or\n logGroupIdentifiers. The exception is queries using the OpenSearch Service\n SQL query language, where you specify the log group names inside the\n querystring instead of here.

\n " + } + }, + "logGroupIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifiers", + "traits": { + "smithy.api#documentation": "

The list of log groups to query. You can include up to 50 log groups.

\n

You can specify them by the log group name or ARN. If a log group that you're querying is\n in a source account and you're using a monitoring account, you must specify the ARN of the log\n group here. The query definition must also be defined in the monitoring account.

\n

If you specify an ARN, use the format\n arn:aws:logs:region:account-id:log-group:log_group_name\n Don't include an * at the end.

\n

A StartQuery operation must include exactly one of the following parameters:\n logGroupName, logGroupNames, or logGroupIdentifiers.\n The exception is queries using the OpenSearch Service SQL query language, where you specify\n the log group names inside the querystring instead of here.

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

The beginning of the time range to query. The range is inclusive, so the specified start\n time is included in the query. Specified as epoch time, the number of seconds since\n January 1, 1970, 00:00:00 UTC.

", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The end of the time range to query. The range is inclusive, so the specified end time is\n included in the query. Specified as epoch time, the number of seconds since January 1,\n 1970, 00:00:00 UTC.

", + "smithy.api#required": {} + } + }, + "queryString": { + "target": "com.amazonaws.cloudwatchlogs#QueryString", + "traits": { + "smithy.api#documentation": "

The query string to use. For more information, see CloudWatch Logs Insights Query\n Syntax.

", + "smithy.api#required": {} + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#EventsLimitStartQuery", + "traits": { + "smithy.api#documentation": "

The maximum number of log events to return from the query. The maximum limit is 100,000. The maximum events returned in a single GetQueryResults API call is 10,000 log events per request. You can retrieve up to 100,000 log event results from a query by paginating with the nextToken. 100,000 limit is only supported for Logs Insights QL and is currently not supported for PPL and SQL query languages.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#StartQueryResponse": { + "type": "structure", + "members": { + "queryId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "

The unique ID of the query.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#StartTimeOffset": { + "type": "long" + }, + "com.amazonaws.cloudwatchlogs#State": { + "type": "enum", + "members": { + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "Suppressed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Suppressed" + } + }, + "Baseline": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Baseline" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#StatsValue": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.cloudwatchlogs#StopQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#StopQueryRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#StopQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a CloudWatch Logs Insights query that is in progress. If the query has already\n ended, the operation returns an error indicating that the specified query is not\n running.

\n

This operation can be used to cancel both interactive queries and individual scheduled\n query executions. When used with scheduled queries, StopQuery cancels only the\n specific execution identified by the query ID, not the scheduled query configuration\n itself.

" + } + }, + "com.amazonaws.cloudwatchlogs#StopQueryRequest": { + "type": "structure", + "members": { + "queryId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "

The ID number of the query to stop. To find this ID number, use\n DescribeQueries.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#StopQueryResponse": { + "type": "structure", + "members": { + "success": { + "target": "com.amazonaws.cloudwatchlogs#Success", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

This is true if the query was stopped by the StopQuery operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#StorageTier": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + }, + "INTELLIGENT_TIERING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTELLIGENT_TIERING" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#StoredBytes": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.cloudwatchlogs#String": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#SubscriptionFilter": { + "type": "structure", + "members": { + "filterName": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "

The name of the subscription filter.

" + } + }, + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

" + } + }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern" + }, + "destinationArn": { + "target": "com.amazonaws.cloudwatchlogs#DestinationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination.

" + } + }, + "roleArn": { + "target": "com.amazonaws.cloudwatchlogs#RoleArn", + "traits": { + "smithy.api#documentation": "

" + } + }, + "distribution": { + "target": "com.amazonaws.cloudwatchlogs#Distribution" + }, + "applyOnTransformedLogs": { + "target": "com.amazonaws.cloudwatchlogs#ApplyOnTransformedLogs", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

This parameter is valid only for log groups that have an active log transformer. For more\n information about log transformers, see PutTransformer.

\n

If this value is true, the subscription filter is applied on the transformed\n version of the log events instead of the original ingested log events.

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

The creation time of the subscription filter, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC.

" + } + }, + "fieldSelectionCriteria": { + "target": "com.amazonaws.cloudwatchlogs#FieldSelectionCriteria", + "traits": { + "smithy.api#documentation": "

The filter expression that specifies which log events are processed by this subscription\n filter based on system fields. Returns the fieldSelectionCriteria value if it was\n specified when the subscription filter was created.

" + } + }, + "emitSystemFields": { + "target": "com.amazonaws.cloudwatchlogs#EmitSystemFields", + "traits": { + "smithy.api#documentation": "

The list of system fields that are included in the log events sent to the subscription\n destination. Returns the emitSystemFields value if it was specified when the\n subscription filter was created.

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

Represents a subscription filter.

" + } + }, + "com.amazonaws.cloudwatchlogs#SubscriptionFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#SubscriptionFilter" + } + }, + "com.amazonaws.cloudwatchlogs#SubstituteString": { + "type": "structure", + "members": { + "entries": { + "target": "com.amazonaws.cloudwatchlogs#SubstituteStringEntries", + "traits": { + "smithy.api#documentation": "

An array of objects, where each object contains the information about one key to match and\n replace.

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

This processor matches a key’s value against a regular expression and replaces all matches\n with a replacement string.

\n

For more information about this processor including examples, see substituteString in the CloudWatch Logs User Guide.

" + } + }, + "com.amazonaws.cloudwatchlogs#SubstituteStringEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#SubstituteStringEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.cloudwatchlogs#SubstituteStringEntry": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.cloudwatchlogs#Source", + "traits": { + "smithy.api#documentation": "

The key to modify

", + "smithy.api#required": {} + } + }, + "from": { + "target": "com.amazonaws.cloudwatchlogs#FromKey", + "traits": { + "smithy.api#documentation": "

The regular expression string to be replaced. Special regex characters such as [ and ]\n must be escaped using \\\\ when using double quotes and with \\ when using single quotes. For\n more information, see Class Pattern on the Oracle web site.

", + "smithy.api#required": {} + } + }, + "to": { + "target": "com.amazonaws.cloudwatchlogs#ToKey", + "traits": { + "smithy.api#documentation": "

The string to be substituted for each match of from\n

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

This object defines one log field key that will be replaced using the substituteString processor.

" + } + }, + "com.amazonaws.cloudwatchlogs#Success": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.cloudwatchlogs#SuppressionPeriod": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.cloudwatchlogs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the number of seconds, minutes or hours to suppress this anomaly. There is no\n maximum.

" + } + }, + "suppressionUnit": { + "target": "com.amazonaws.cloudwatchlogs#SuppressionUnit", + "traits": { + "smithy.api#documentation": "

Specifies whether the value of value is in seconds, minutes, or hours.

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

If you are suppressing an anomaly temporariliy, this structure defines how long the\n suppression period is to be.

" + } + }, + "com.amazonaws.cloudwatchlogs#SuppressionState": { + "type": "enum", + "members": { + "SUPPRESSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUPPRESSED" + } + }, + "UNSUPPRESSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSUPPRESSED" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#SuppressionType": { + "type": "enum", + "members": { + "LIMITED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIMITED" + } + }, + "INFINITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFINITE" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#SuppressionUnit": { + "type": "enum", + "members": { + "SECONDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECONDS" + } + }, + "MINUTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MINUTES" + } + }, + "HOURS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOURS" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#SyslogConfiguration": { + "type": "structure", + "members": { + "logGroupArn": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupArn", + "traits": { + "smithy.api#documentation": "

The ARN of the log group associated with this syslog configuration.

" + } + }, + "sourceType": { + "target": "com.amazonaws.cloudwatchlogs#SyslogSourceType", + "traits": { + "smithy.api#documentation": "

The source type for the syslog configuration.

" + } + }, + "vpcEndpointId": { + "target": "com.amazonaws.cloudwatchlogs#VpcEndpointId", + "traits": { + "smithy.api#documentation": "

The ID of the VPC endpoint used for syslog ingestion.

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

The time when the syslog configuration was created, expressed as the number of\n milliseconds after Jan 1, 1970 00:00:00 UTC.

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

Contains information about a syslog configuration associated with a log group.

" + } + }, + "com.amazonaws.cloudwatchlogs#SyslogConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#SyslogConfiguration" + } + }, + "com.amazonaws.cloudwatchlogs#SyslogSourceType": { + "type": "enum", + "members": { + "VPCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPCE" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#SystemField": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#TableBody": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10485760 + } + } + }, + "com.amazonaws.cloudwatchlogs#TableFields": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#String" + } + }, + "com.amazonaws.cloudwatchlogs#TagFilter": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.cloudwatchlogs#TagFilterKey", + "traits": { + "smithy.api#documentation": "

The tag key to filter on.

", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.cloudwatchlogs#TagFilterValues", + "traits": { + "smithy.api#documentation": "

An optional list of tag values to filter on.

\n
    \n
  • \n

    If you specify a filter that contains more than one value for a key, \n the response returns log groups that match any of the specified values for that key.

    \n
    • \n
  • \n

    If you don't specify values, the response returns all log groups that are \n tagged with that key, with any or no value.

    \n
    • \n
  • \n

    Use * for wildcard matching. For example,\n prod* matches values that start with prod.

    \n
    • \n
  • \n

    Use ! as a prefix for negation. For example,\n !prod matches values that are not prod.

    \n
    • \n
  • \n

    Exact matching and negation are case-sensitive. Wildcard matching is\n case-insensitive.

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

A tag filter that specifies a tag key and optional tag values for filtering log\n groups by tags.

" + } + }, + "com.amazonaws.cloudwatchlogs#TagFilterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+)$" + } + }, + "com.amazonaws.cloudwatchlogs#TagFilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 259 + }, + "smithy.api#pattern": "^!?\\*?([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)\\*?$" + } + }, + "com.amazonaws.cloudwatchlogs#TagFilterValues": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#TagFilterValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.cloudwatchlogs#TagFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#TagFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.cloudwatchlogs#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+)$" + } + }, + "com.amazonaws.cloudwatchlogs#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.cloudwatchlogs#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#TagLogGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#TagLogGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "Please use the generic tagging API TagResource" + }, + "smithy.api#documentation": "\n

The TagLogGroup operation is on the path to deprecation. We recommend that you use\n TagResource\n instead.

\n \n

Adds or updates the specified tags for the specified log group.

\n

To list the tags for a log group, use ListTagsForResource. To remove tags, use UntagResource.

\n

For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs\n User Guide.

\n

CloudWatch Logs doesn't support IAM policies that prevent users from assigning specified\n tags to log groups using the aws:Resource/key-name\n or\n aws:TagKeys condition keys. For more information about using tags to control\n access, see Controlling access to Amazon Web Services resources using tags.

" + } + }, + "com.amazonaws.cloudwatchlogs#TagLogGroupRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

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

The key-value pairs to use for the tags.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Please use the generic tagging API model TagResourceRequest" + }, + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#TagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource.\n Currently, the only CloudWatch Logs resources that can be tagged are log groups and\n destinations.

\n

Tags can help you organize and categorize your resources. You can also use them to scope\n user permissions by granting a user permission to access or change only resources with certain\n tag values.

\n

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as\n strings of characters.

\n

You can use the TagResource action with a resource that already has tags. If\n you specify a new tag key for the alarm, this tag is appended to the list of tags associated\n with the alarm. If you specify a tag key that is already associated with the alarm, the new\n tag value that you specify replaces the previous value for that tag.

\n

You can associate as many as 50 tags with a CloudWatch Logs resource.

" + } + }, + "com.amazonaws.cloudwatchlogs#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.cloudwatchlogs#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the resource that you're adding tags to.

\n

The ARN format of a log group is\n arn:aws:logs:Region:account-id:log-group:log-group-name\n \n

\n

The ARN format of a destination is\n arn:aws:logs:Region:account-id:destination:destination-name\n \n

\n

For more information about ARN format, see CloudWatch Logs\n resources and operations.

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

The list of key-value pairs to associate with the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.cloudwatchlogs#Tags": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#TagKey" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.cloudwatchlogs#Target": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cloudwatchlogs#TargetArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#TargetFormat": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.cloudwatchlogs#TargetTimezone": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#TestEventMessages": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#EventMessage" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.cloudwatchlogs#TestMetricFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#TestMetricFilterRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#TestMetricFilterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Tests the filter pattern of a metric filter against a sample of log event messages. You\n can use this operation to validate the correctness of a metric filter pattern.

" + } + }, + "com.amazonaws.cloudwatchlogs#TestMetricFilterRequest": { + "type": "structure", + "members": { + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern", + "traits": { + "smithy.api#required": {} + } + }, + "logEventMessages": { + "target": "com.amazonaws.cloudwatchlogs#TestEventMessages", + "traits": { + "smithy.api#documentation": "

The log event messages to test.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#TestMetricFilterResponse": { + "type": "structure", + "members": { + "matches": { + "target": "com.amazonaws.cloudwatchlogs#MetricFilterMatches", + "traits": { + "smithy.api#documentation": "

The matched events.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#TestTransformer": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#TestTransformerRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#TestTransformerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Use this operation to test a log transformer. You enter the transformer configuration and\n a set of log events to test with. The operation responds with an array that includes the\n original log events and the transformed versions.

" + } + }, + "com.amazonaws.cloudwatchlogs#TestTransformerRequest": { + "type": "structure", + "members": { + "transformerConfig": { + "target": "com.amazonaws.cloudwatchlogs#Processors", + "traits": { + "smithy.api#documentation": "

This structure contains the configuration of this log transformer that you want to test. A\n log transformer is an array of processors, where each processor applies one type of\n transformation to the log events that are ingested.

", + "smithy.api#required": {} + } + }, + "logEventMessages": { + "target": "com.amazonaws.cloudwatchlogs#TestEventMessages", + "traits": { + "smithy.api#documentation": "

An array of the raw log events that you want to use to test this transformer.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#TestTransformerResponse": { + "type": "structure", + "members": { + "transformedLogs": { + "target": "com.amazonaws.cloudwatchlogs#TransformedLogs", + "traits": { + "smithy.api#documentation": "

An array where each member of the array includes both the original version and the\n transformed version of one of the log events that you input.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The request was throttled because of quota limits.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#Time": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#Timestamp": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.cloudwatchlogs#ToKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cloudwatchlogs#Token": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#TokenString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#TokenValue": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.cloudwatchlogs#TooManyTagsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + }, + "resourceName": { + "target": "com.amazonaws.cloudwatchlogs#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The name of the resource.

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

A resource can have no more than 50 tags.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudwatchlogs#TransformedEventMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#TransformedLogRecord": { + "type": "structure", + "members": { + "eventNumber": { + "target": "com.amazonaws.cloudwatchlogs#EventNumber", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The event number.

" + } + }, + "eventMessage": { + "target": "com.amazonaws.cloudwatchlogs#EventMessage", + "traits": { + "smithy.api#documentation": "

The original log event message before it was transformed.

" + } + }, + "transformedEventMessage": { + "target": "com.amazonaws.cloudwatchlogs#TransformedEventMessage", + "traits": { + "smithy.api#documentation": "

The log event message after being transformed.

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

This structure contains information for one log event that has been processed by a log\n transformer.

" + } + }, + "com.amazonaws.cloudwatchlogs#TransformedLogs": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#TransformedLogRecord" + } + }, + "com.amazonaws.cloudwatchlogs#TriggerHistoryRecord": { + "type": "structure", + "members": { + "queryId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "

The unique identifier for this query execution.

" + } + }, + "executionStatus": { + "target": "com.amazonaws.cloudwatchlogs#ExecutionStatus", + "traits": { + "smithy.api#documentation": "

The execution status of the scheduled query run.

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

The timestamp when the scheduled query execution was triggered.

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

Error message if the query execution failed.

" + } + }, + "destinations": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryDestinationList", + "traits": { + "smithy.api#documentation": "

Information about destination processing for this query execution.

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

A record of a scheduled query execution, including execution status, timestamp, and\n destination processing results.

" + } + }, + "com.amazonaws.cloudwatchlogs#TriggerHistoryRecordList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#TriggerHistoryRecord" + } + }, + "com.amazonaws.cloudwatchlogs#TrimString": { + "type": "structure", + "members": { + "withKeys": { + "target": "com.amazonaws.cloudwatchlogs#TrimStringWithKeys", + "traits": { + "smithy.api#documentation": "

The array containing the keys of the fields to trim.

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

Use this processor to remove leading and trailing whitespace.

\n

For more information about this processor including examples, see trimString in the CloudWatch Logs User Guide.

" + } + }, + "com.amazonaws.cloudwatchlogs#TrimStringWithKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#WithKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.cloudwatchlogs#Type": { + "type": "enum", + "members": { + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "boolean" + } + }, + "INTEGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "integer" + } + }, + "DOUBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "double" + } + }, + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "string" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#TypeConverter": { + "type": "structure", + "members": { + "entries": { + "target": "com.amazonaws.cloudwatchlogs#TypeConverterEntries", + "traits": { + "smithy.api#documentation": "

An array of TypeConverterEntry objects, where each object contains the\n information about one field to change the type of.

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

Use this processor to convert a value type associated with the specified key to the\n specified type. It's a casting processor that changes the types of the specified fields.\n Values can be converted into one of the following datatypes: integer,\n double, string and boolean.

\n

For more information about this processor including examples, see trimString in the CloudWatch Logs User Guide.

" + } + }, + "com.amazonaws.cloudwatchlogs#TypeConverterEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#TypeConverterEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.cloudwatchlogs#TypeConverterEntry": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.cloudwatchlogs#Key", + "traits": { + "smithy.api#documentation": "

The key with the value that is to be converted to a different type.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.cloudwatchlogs#Type", + "traits": { + "smithy.api#documentation": "

The type to convert the field value to. Valid values are integer,\n double, string and boolean.

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

This object defines one value type that will be converted using the typeConverter processor.

" + } + }, + "com.amazonaws.cloudwatchlogs#Unmask": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.cloudwatchlogs#UnrecognizedClientException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The most likely cause is an Amazon Web Services access key ID or secret key that's not\n valid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#UntagLogGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#UntagLogGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "Please use the generic tagging API UntagResource" + }, + "smithy.api#documentation": "\n

The UntagLogGroup operation is on the path to deprecation. We recommend that you use\n UntagResource instead.

\n \n

Removes the specified tags from the specified log group.

\n

To list the tags for a log group, use ListTagsForResource. To add tags, use TagResource.

\n

When using IAM policies to control tag management for CloudWatch Logs log groups, the\n condition keys aws:Resource/key-name and aws:TagKeys cannot be used\n to restrict which tags users can assign.

" + } + }, + "com.amazonaws.cloudwatchlogs#UntagLogGroupRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

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

The tag keys. The corresponding tags are removed from the log group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Please use the generic tagging API model UntagResourceRequest" + }, + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#UntagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes one or more tags from the specified resource.

" + } + }, + "com.amazonaws.cloudwatchlogs#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.cloudwatchlogs#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the CloudWatch Logs resource that you're removing tags from.

\n

The ARN format of a log group is\n arn:aws:logs:Region:account-id:log-group:log-group-name\n \n

\n

The ARN format of a destination is\n arn:aws:logs:Region:account-id:destination:destination-name\n \n

\n

For more information about ARN format, see CloudWatch Logs\n resources and operations.

", + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.cloudwatchlogs#TagKeyList", + "traits": { + "smithy.api#documentation": "

The list of tag keys to remove from the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#UpdateAnomaly": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#UpdateAnomalyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Use this operation to suppress anomaly detection for a specified\n anomaly or pattern. If you suppress an anomaly, CloudWatch Logs won't report new\n occurrences of that anomaly and won't update that anomaly with new data. If you suppress a\n pattern, CloudWatch Logs won't report any anomalies related to that pattern.

\n

You must specify either anomalyId or patternId, but you can't\n specify both parameters in the same operation.

\n

If you have previously used this operation to suppress detection of a pattern or anomaly,\n you can use it again to cause CloudWatch Logs to end the suppression. To do this, use this\n operation and specify the anomaly or pattern to stop suppressing, and omit the\n suppressionType and suppressionPeriod parameters.

" + } + }, + "com.amazonaws.cloudwatchlogs#UpdateAnomalyRequest": { + "type": "structure", + "members": { + "anomalyId": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyId", + "traits": { + "smithy.api#documentation": "

If you are suppressing or unsuppressing an anomaly, specify its unique ID here. You can\n find anomaly IDs by using the ListAnomalies\n operation.

" + } + }, + "patternId": { + "target": "com.amazonaws.cloudwatchlogs#PatternId", + "traits": { + "smithy.api#documentation": "

If you are suppressing or unsuppressing an pattern, specify its unique ID here. You can\n find pattern IDs by using the ListAnomalies\n operation.

" + } + }, + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "

The ARN of the anomaly detector that this operation is to act on.

", + "smithy.api#required": {} + } + }, + "suppressionType": { + "target": "com.amazonaws.cloudwatchlogs#SuppressionType", + "traits": { + "smithy.api#documentation": "

Use this to specify whether the suppression to be temporary or infinite. If you specify\n LIMITED, you must also specify a suppressionPeriod. If you specify\n INFINITE, any value for suppressionPeriod is ignored.

" + } + }, + "suppressionPeriod": { + "target": "com.amazonaws.cloudwatchlogs#SuppressionPeriod", + "traits": { + "smithy.api#documentation": "

If you are temporarily suppressing an anomaly or pattern, use this structure to specify\n how long the suppression is to last.

" + } + }, + "baseline": { + "target": "com.amazonaws.cloudwatchlogs#Baseline", + "traits": { + "smithy.api#documentation": "

Set this to true to prevent CloudWatch Logs from displaying this behavior\n as an anomaly in the future. The behavior is then treated as baseline behavior. However, if\n similar but more severe occurrences of this behavior occur in the future, those will still be\n reported as anomalies.

\n

The default is false\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Use this operation to update the configuration of a delivery to change\n either the S3 path pattern or the format of the delivered logs. You can't use this operation\n to change the source or destination of the delivery.

" + } + }, + "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfigurationRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryId", + "traits": { + "smithy.api#documentation": "

The ID of the delivery to be updated by this request.

", + "smithy.api#required": {} + } + }, + "recordFields": { + "target": "com.amazonaws.cloudwatchlogs#RecordFields", + "traits": { + "smithy.api#documentation": "

The list of record fields to be delivered to the destination, in order. If the delivery's\n log source has mandatory fields, they must be included in this list.

" + } + }, + "fieldDelimiter": { + "target": "com.amazonaws.cloudwatchlogs#FieldDelimiter", + "traits": { + "smithy.api#documentation": "

The field delimiter to use between record fields when the final output format of a\n delivery is in Plain, W3C, or Raw format.

" + } + }, + "s3DeliveryConfiguration": { + "target": "com.amazonaws.cloudwatchlogs#S3DeliveryConfiguration", + "traits": { + "smithy.api#documentation": "

This structure contains parameters that are valid only when the delivery's delivery\n destination is an S3 bucket.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#UpdateLogAnomalyDetector": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#UpdateLogAnomalyDetectorRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing log anomaly detector.

" + } + }, + "com.amazonaws.cloudwatchlogs#UpdateLogAnomalyDetectorRequest": { + "type": "structure", + "members": { + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "

The ARN of the anomaly detector that you want to update.

", + "smithy.api#required": {} + } + }, + "evaluationFrequency": { + "target": "com.amazonaws.cloudwatchlogs#EvaluationFrequency", + "traits": { + "smithy.api#documentation": "

Specifies how often the anomaly detector runs and look for anomalies. Set this value\n according to the frequency that the log group receives new logs. For example, if the log group\n receives new log events every 10 minutes, then setting evaluationFrequency to\n FIFTEEN_MIN might be appropriate.

" + } + }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern" + }, + "anomalyVisibilityTime": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime", + "traits": { + "smithy.api#documentation": "

The number of days to use as the life cycle of anomalies. After this time, anomalies are\n automatically baselined and the anomaly detector model will treat new occurrences of similar\n event as normal. Therefore, if you do not correct the cause of an anomaly during this time, it\n will be considered normal going forward and will not be detected.

" + } + }, + "enabled": { + "target": "com.amazonaws.cloudwatchlogs#Boolean", + "traits": { + "smithy.api#documentation": "

Use this parameter to pause or restart the anomaly detector.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#UpdateLookupTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#UpdateLookupTableRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#UpdateLookupTableResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing lookup table by replacing all of its content with new CSV data or\n CloudWatch Logs query results. After the update completes, queries that use this table\n use the new data.

\n

This is a full replacement operation. All existing content is replaced. You must specify\n either tableBody or queryId, but not both.

" + } + }, + "com.amazonaws.cloudwatchlogs#UpdateLookupTableRequest": { + "type": "structure", + "members": { + "lookupTableArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the lookup table to update.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cloudwatchlogs#LookupTableDescription", + "traits": { + "smithy.api#documentation": "

An updated description of the lookup table.

" + } + }, + "tableBody": { + "target": "com.amazonaws.cloudwatchlogs#TableBody", + "traits": { + "smithy.api#documentation": "

The new CSV content to replace the existing data. The first row must be a header row\n with column names. The content must use UTF-8 encoding and not exceed 10 MB.

\n

You must specify either tableBody or queryId, but not\n both.

" + } + }, + "queryId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "

The ID of a completed or cancelled CloudWatch Logs query whose results replace\n the lookup table content. A cancelled query replaces the content with the partial results\n that were available when the query was stopped.

\n

You must specify either tableBody or queryId, but not\n both.

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

The ARN of the KMS key to use to encrypt the lookup table data. You can\n use this parameter to add, update, or remove the KMS key. To remove the KMS key and use an\n Amazon Web Services-owned key instead, specify an empty string.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#UpdateLookupTableResponse": { + "type": "structure", + "members": { + "lookupTableArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the lookup table that was updated.

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

The time when the lookup table was last updated, expressed as the number of\n milliseconds after Jan 1, 1970 00:00:00 UTC.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#UpdateScheduledQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#UpdateScheduledQueryRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#UpdateScheduledQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InternalServerException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing scheduled query with new configuration. This operation uses PUT\n semantics, allowing modification of query parameters, schedule, and destinations.

" + } + }, + "com.amazonaws.cloudwatchlogs#UpdateScheduledQueryRequest": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryIdentifier", + "traits": { + "smithy.api#documentation": "

The ARN or name of the scheduled query to update.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryDescription", + "traits": { + "smithy.api#documentation": "

An updated description for the scheduled query.

" + } + }, + "queryLanguage": { + "target": "com.amazonaws.cloudwatchlogs#QueryLanguage", + "traits": { + "smithy.api#documentation": "

The updated query language for the scheduled query.

", + "smithy.api#required": {} + } + }, + "queryString": { + "target": "com.amazonaws.cloudwatchlogs#QueryString", + "traits": { + "smithy.api#documentation": "

The updated query string to execute.

", + "smithy.api#required": {} + } + }, + "logGroupIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryLogGroupIdentifiers", + "traits": { + "smithy.api#documentation": "

The updated array of log group names or ARNs to query.

" + } + }, + "scheduleExpression": { + "target": "com.amazonaws.cloudwatchlogs#ScheduleExpression", + "traits": { + "smithy.api#documentation": "

The updated cron expression that defines when the scheduled query runs.

", + "smithy.api#required": {} + } + }, + "timezone": { + "target": "com.amazonaws.cloudwatchlogs#ScheduleTimezone", + "traits": { + "smithy.api#documentation": "

The updated timezone for evaluating the schedule expression.

" + } + }, + "startTimeOffset": { + "target": "com.amazonaws.cloudwatchlogs#StartTimeOffset", + "traits": { + "smithy.api#documentation": "

The updated time offset in seconds that defines the lookback period for the query.

" + } + }, + "endTimeOffset": { + "target": "com.amazonaws.cloudwatchlogs#EndTimeOffset", + "traits": { + "smithy.api#documentation": "

The updated time offset in seconds that defines the end of the lookback period for\n the query.

" + } + }, + "destinationConfiguration": { + "target": "com.amazonaws.cloudwatchlogs#DestinationConfiguration", + "traits": { + "smithy.api#documentation": "

The updated configuration for where to deliver query results.

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

The updated start time for the scheduled query in Unix epoch format.

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

The updated end time for the scheduled query in Unix epoch format.

" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.cloudwatchlogs#RoleArn", + "traits": { + "smithy.api#documentation": "

The updated ARN of the IAM role that grants permissions to execute the query and deliver\n results.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryState", + "traits": { + "smithy.api#documentation": "

The updated state of the scheduled query.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#UpdateScheduledQueryResponse": { + "type": "structure", + "members": { + "scheduledQueryArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the updated scheduled query.

" + } + }, + "name": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryName", + "traits": { + "smithy.api#documentation": "

The name of the updated scheduled query.

" + } + }, + "description": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryDescription", + "traits": { + "smithy.api#documentation": "

The description of the updated scheduled query.

" + } + }, + "queryLanguage": { + "target": "com.amazonaws.cloudwatchlogs#QueryLanguage", + "traits": { + "smithy.api#documentation": "

The query language of the updated scheduled query.

" + } + }, + "queryString": { + "target": "com.amazonaws.cloudwatchlogs#QueryString", + "traits": { + "smithy.api#documentation": "

The query string of the updated scheduled query.

" + } + }, + "logGroupIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryLogGroupIdentifiers", + "traits": { + "smithy.api#documentation": "

The log groups queried by the updated scheduled query.

" + } + }, + "scheduleExpression": { + "target": "com.amazonaws.cloudwatchlogs#ScheduleExpression", + "traits": { + "smithy.api#documentation": "

The cron expression of the updated scheduled query.

" + } + }, + "timezone": { + "target": "com.amazonaws.cloudwatchlogs#ScheduleTimezone", + "traits": { + "smithy.api#documentation": "

The timezone of the updated scheduled query.

" + } + }, + "startTimeOffset": { + "target": "com.amazonaws.cloudwatchlogs#StartTimeOffset", + "traits": { + "smithy.api#documentation": "

The time offset of the updated scheduled query.

" + } + }, + "endTimeOffset": { + "target": "com.amazonaws.cloudwatchlogs#EndTimeOffset", + "traits": { + "smithy.api#documentation": "

The end time offset in seconds of the updated scheduled query.

" + } + }, + "destinationConfiguration": { + "target": "com.amazonaws.cloudwatchlogs#DestinationConfiguration", + "traits": { + "smithy.api#documentation": "

The destination configuration of the updated scheduled query.

" + } + }, + "state": { + "target": "com.amazonaws.cloudwatchlogs#ScheduledQueryState", + "traits": { + "smithy.api#documentation": "

The state of the updated scheduled query.

" + } + }, + "scheduleType": { + "target": "com.amazonaws.cloudwatchlogs#ScheduleType", + "traits": { + "smithy.api#documentation": "

The schedule type of the updated scheduled query.

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

The timestamp when the updated scheduled query was last executed.

" + } + }, + "lastExecutionStatus": { + "target": "com.amazonaws.cloudwatchlogs#ExecutionStatus", + "traits": { + "smithy.api#documentation": "

The status of the most recent execution of the updated scheduled query.

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

The start time of the updated scheduled query.

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

The end time of the updated scheduled query.

" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.cloudwatchlogs#RoleArn", + "traits": { + "smithy.api#documentation": "

The execution role ARN of the updated scheduled query.

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

The timestamp when the scheduled query was originally created.

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

The timestamp when the scheduled query was last updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#UpperCaseString": { + "type": "structure", + "members": { + "withKeys": { + "target": "com.amazonaws.cloudwatchlogs#UpperCaseStringWithKeys", + "traits": { + "smithy.api#documentation": "

The array of containing the keys of the field to convert to uppercase.

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

This processor converts a string field to uppercase.

\n

For more information about this processor including examples, see upperCaseString in the CloudWatch Logs User Guide.

" + } + }, + "com.amazonaws.cloudwatchlogs#UpperCaseStringWithKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#WithKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.cloudwatchlogs#UserIdentity": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.cloudwatchlogs#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

One of the parameters for the request is not valid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#Value": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#ValueKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cloudwatchlogs#VpcEndpointId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^vpce-[0-9a-f]{1,64}$" + } + }, + "com.amazonaws.cloudwatchlogs#WithKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + } + } +} \ No newline at end of file diff --git a/pkg/testdata/models/apis/cloudwatch-logs/0000-00-00/generator.yaml b/pkg/testdata/models/apis/cloudwatch-logs/0000-00-00/generator.yaml new file mode 100644 index 000000000..e1f71b46b --- /dev/null +++ b/pkg/testdata/models/apis/cloudwatch-logs/0000-00-00/generator.yaml @@ -0,0 +1,46 @@ +# Minimal generator config used by the code-generator unit tests to exercise +# mutually_exclusive_identifiers on a resource whose ReadMany operation has no +# required members (CloudWatch Logs ResourcePolicy). Account-scoped policies are +# keyed by PolicyName and resource-scoped policies by ResourceArn; exactly one +# is supplied at adoption time. +ignore: + # Only ResourcePolicy is needed for these tests. Ignore every other resource + # that would otherwise be generated from a Create* operation. + resource_names: + - Delivery + - ExportTask + - ImportTask + - LogAnomalyDetector + - LogGroup + - LogStream + - LookupTable + - ScheduledQuery + field_paths: + # PolicyScope is not an identifier: it is inferred from whether PolicyName + # (ACCOUNT) or ResourceArn (RESOURCE) is set, so it must not appear as an + # adoption field. + - DescribeResourcePoliciesInput.PolicyScope + - PutResourcePolicyInput.ExpectedRevisionId +operations: + PutResourcePolicy: + resource_name: ResourcePolicy + # PutResourcePolicy is an idempotent upsert serving as both Create and + # Update. + operation_type: + - Create + - Update + output_wrapper_field_path: ResourcePolicy + DescribeResourcePolicies: + resource_name: ResourcePolicy + operation_type: + - List +resources: + ResourcePolicy: + # ResourcePolicy has no single mandatory identifier: exactly one of + # PolicyName (account-scoped) or ResourceArn (resource-scoped) is supplied. + mutually_exclusive_identifiers: + - PolicyName + - ResourceArn + fields: + PolicyName: + is_primary_key: true diff --git a/pkg/testdata/models/apis/eks/0000-00-00/generator-with-optional-primary-key-autodiscovered.yaml b/pkg/testdata/models/apis/eks/0000-00-00/generator-with-optional-primary-key-autodiscovered.yaml deleted file mode 100644 index 14bf5743b..000000000 --- a/pkg/testdata/models/apis/eks/0000-00-00/generator-with-optional-primary-key-autodiscovered.yaml +++ /dev/null @@ -1,7 +0,0 @@ -resources: - Cluster: - # is_primary_key_optional makes PopulateResourceFromAnnotation set the - # primary key when the adoption annotation supplies it, but not require it. - # No field is marked is_primary_key here, so the primary identifier is - # auto-discovered (Name, from DescribeCluster's `name` input). - is_primary_key_optional: true diff --git a/pkg/testdata/models/apis/eks/0000-00-00/generator-with-optional-primary-key.yaml b/pkg/testdata/models/apis/eks/0000-00-00/generator-with-optional-primary-key.yaml deleted file mode 100644 index a1bfc0a1a..000000000 --- a/pkg/testdata/models/apis/eks/0000-00-00/generator-with-optional-primary-key.yaml +++ /dev/null @@ -1,8 +0,0 @@ -resources: - Cluster: - # is_primary_key_optional makes PopulateResourceFromAnnotation set the - # primary key when the adoption annotation supplies it, but not require it. - is_primary_key_optional: true - fields: - Name: - is_primary_key: true diff --git a/pkg/testdata/models/apis/opensearchserverless/0000-00-00/generator-with-mutually-exclusive-identifiers.yaml b/pkg/testdata/models/apis/opensearchserverless/0000-00-00/generator-with-mutually-exclusive-identifiers.yaml new file mode 100644 index 000000000..25f4577fa --- /dev/null +++ b/pkg/testdata/models/apis/opensearchserverless/0000-00-00/generator-with-mutually-exclusive-identifiers.yaml @@ -0,0 +1,37 @@ +# Variant of generator.yaml used to exercise mutually_exclusive_identifiers on +# a resource whose identifier fields flow through the required/auto-discovered +# primary identifier branch of PopulateResourceFromAnnotation (SecurityPolicy's +# `name` is the auto-discovered primary identifier and `type` is a required +# member of the read operation input). Declaring them mutually exclusive relaxes +# each individual field to optional and emits the exactly-one guard. +ignore: + resource_names: + - AccessPolicy + - Collection + - LifecyclePolicy + - SecurityConfig + # - SecurityPolicy + - VpcEndpoint + field_paths: + - CreateSecurityPolicyOutput.SecurityPolicyDetail.Policy + - CreateSecurityPolicyOutput.SecurityPolicyDetail.ClientToken + - CreateSecurityPolicyInput.ClientToken +resources: + SecurityPolicy: + # `name` and `type` are not truly mutually exclusive for SecurityPolicy; + # this config exists only to exercise the generator branch that relaxes the + # auto-discovered primary identifier and a required read-input member. + mutually_exclusive_identifiers: + - Name + - Type + tags: + ignore: true + fields: + Type: + go_tag: json:"type" + is_immutable: true + Policy: + compare: + is_ignored: true + Name: + is_immutable: true From 8111453952a4c56dd765a0132cbb45f795bf9ffd Mon Sep 17 00:00:00 2001 From: knottnt Date: Thu, 27 Aug 2026 10:57:01 -0700 Subject: [PATCH 4/5] Generate required fields check when mutually_exclusive_identifiers is used --- pkg/generate/code/check.go | 78 +++++++++++++++++++++++++++++++++ pkg/generate/code/check_test.go | 59 +++++++++++++++++++++++++ 2 files changed, 137 insertions(+) diff --git a/pkg/generate/code/check.go b/pkg/generate/code/check.go index 41117eaae..b2844e7ed 100644 --- a/pkg/generate/code/check.go +++ b/pkg/generate/code/check.go @@ -96,6 +96,42 @@ func CheckRequiredFieldsMissingFromShape( ) } +// mutuallyExclusiveIdentifierNilConditions returns, for each of the resource's +// configured mutually-exclusive identifier fields, a " == nil" condition +// string, along with the set of CR paths so callers can exclude them from +// per-field required checks. The resource is uniquely identified by exactly one +// of these fields, so it is considered incomplete only when all of them are +// nil. Returns nil slices when the resource has no mutually-exclusive +// identifiers. +func mutuallyExclusiveIdentifierNilConditions( + r *model.CRD, + koVarName string, +) ([]string, map[string]bool, error) { + if !r.HasMutuallyExclusiveIdentifiers() { + return nil, nil, nil + } + identifierFields, err := r.GetMutuallyExclusiveIdentifierFields() + if err != nil { + return nil, nil, err + } + cfg := r.Config() + conditions := make([]string, 0, len(identifierFields)) + paths := make(map[string]bool, len(identifierFields)) + for _, identifierField := range identifierFields { + memberPath, targetField := findFieldInCR(cfg, r, identifierField.Names.Original) + if targetField == nil { + return nil, nil, fmt.Errorf( + "resource %q: mutually_exclusive_identifiers field %q is not in the CR's Spec or Status", + r.Names.Original, identifierField.Names.Original, + ) + } + path := fmt.Sprintf("%s%s.%s", koVarName, memberPath, targetField.Path) + conditions = append(conditions, fmt.Sprintf("%s == nil", path)) + paths[path] = true + } + return conditions, paths, nil +} + func checkRequiredFieldsMissingFromShape( r *model.CRD, koVarName string, @@ -104,7 +140,26 @@ func checkRequiredFieldsMissingFromShape( shape *awssdkmodel.Shape, ) (string, error) { indent := strings.Repeat("\t", indentLevel) + + // When the resource declares mutually-exclusive identifiers, the resource is + // uniquely identified by exactly one of the declared fields. Build a single + // grouped condition that is true only when none of them are set, and collect + // their CR paths so they are not required individually below. This makes the + // generated check treat the input as incomplete unless at least one + // identifier is present, mirroring the ReadMany handling. + exclusiveConditions, exclusivePaths, err := mutuallyExclusiveIdentifierNilConditions(r, koVarName) + if err != nil { + return "", err + } + exclusiveGroupCondition := "" + if len(exclusiveConditions) > 0 { + exclusiveGroupCondition = fmt.Sprintf("(%s)", strings.Join(exclusiveConditions, " && ")) + } + if shape == nil || len(shape.Required) == 0 { + if exclusiveGroupCondition != "" { + return fmt.Sprintf("%sreturn %s\n", indent, exclusiveGroupCondition), nil + } return fmt.Sprintf("%sreturn false", indent), nil } @@ -144,8 +199,16 @@ func checkRequiredFieldsMissingFromShape( r.Names.Original, memberName, shape.ShapeName, ) } + // Mutually-exclusive identifiers are not required individually; they are + // covered by the grouped condition appended below. + if exclusivePaths[resVarPath] { + continue + } missing = append(missing, fmt.Sprintf("%s == nil", resVarPath)) } + if exclusiveGroupCondition != "" { + missing = append(missing, exclusiveGroupCondition) + } // Use '||' because if any of the required fields are missing the object // is not created yet missingCondition := strings.Join(missing, " || ") @@ -178,6 +241,21 @@ func checkRequiredFieldsMissingFromShapeReadMany( indent := strings.Repeat("\t", indentLevel) result := fmt.Sprintf("%sreturn false", indent) + // When the resource declares mutually-exclusive identifiers, the ReadMany + // input typically has no required members, so the default `return false` + // would let sdkFind list every resource and match an arbitrary one. Instead, + // treat the read input as incomplete (returning true so sdkFind bails out + // with NotFound) unless at least one of the declared identifiers is set on + // the resource. The mutually_exclusive_identifiers guard in + // PopulateResourceFromAnnotation still rejects supplying more than one. + if r.HasMutuallyExclusiveIdentifiers() { + exclusiveConditions, _, err := mutuallyExclusiveIdentifierNilConditions(r, koVarName) + if err != nil { + return result + } + return fmt.Sprintf("%sreturn %s\n", indent, strings.Join(exclusiveConditions, " && ")) + } + reqIdentifier, _ := FindPluralizedIdentifiersInShape(r, shape, op) resVarPath, err := r.GetSanitizedMemberPath(reqIdentifier, op, koVarName) if err != nil { diff --git a/pkg/generate/code/check_test.go b/pkg/generate/code/check_test.go index 848f5ab92..f1ae4db9a 100644 --- a/pkg/generate/code/check_test.go +++ b/pkg/generate/code/check_test.go @@ -165,6 +165,65 @@ func TestCheckRequiredFields_StatusField_ReadMany_EgressOnlyIGW(t *testing.T) { ) } +func TestCheckRequiredFields_MutuallyExclusiveIdentifiers_ReadOne(t *testing.T) { + assert := assert.New(t) + require := require.New(t) + + g := testutil.NewModelForServiceWithOptions(t, "opensearchserverless", &testutil.TestingModelOptions{ + GeneratorConfigFile: "generator-with-mutually-exclusive-identifiers.yaml", + }) + + crd := testutil.GetCRDByName(t, g, "SecurityPolicy") + require.NotNil(crd) + require.True(crd.HasMutuallyExclusiveIdentifiers()) + + // GetSecurityPolicy (ReadOne) marks both `name` and `type` required. + // Declaring them mutually exclusive drops each from the per-field `||` list + // and collapses them into a single grouped condition that is true only when + // neither identifier is set. + expRequiredFieldsCode := ` + return (r.ko.Spec.Name == nil && r.ko.Spec.Type == nil) +` + gotCode, err := code.CheckRequiredFieldsMissingFromShape( + crd, model.OpTypeGet, "r.ko", 1, + ) + require.NoError(err) + assert.Equal( + strings.TrimSpace(expRequiredFieldsCode), + strings.TrimSpace(gotCode), + ) +} + +func TestCheckRequiredFields_MutuallyExclusiveIdentifiers_ReadMany(t *testing.T) { + assert := assert.New(t) + require := require.New(t) + + g := testutil.NewModelForServiceWithOptions(t, "cloudwatch-logs", &testutil.TestingModelOptions{ + GeneratorConfigFile: "generator.yaml", + }) + + crd := testutil.GetCRDByName(t, g, "ResourcePolicy") + require.NotNil(crd) + require.True(crd.HasMutuallyExclusiveIdentifiers()) + + // DescribeResourcePolicies has no required input members, so without + // mutually_exclusive_identifiers this would generate `return false` and let + // sdkFind match an arbitrary policy. Instead, the read input is treated as + // incomplete unless at least one of the declared identifiers is set, which + // is what the controller previously had to supply via a custom method. + expRequiredFieldsCode := ` + return r.ko.Spec.PolicyName == nil && r.ko.Spec.ResourceARN == nil +` + gotCode, err := code.CheckRequiredFieldsMissingFromShape( + crd, model.OpTypeList, "r.ko", 1, + ) + require.NoError(err) + assert.Equal( + strings.TrimSpace(expRequiredFieldsCode), + strings.TrimSpace(gotCode), + ) +} + func TestCheckNilFieldPath(t *testing.T) { // Empty FieldPath field := model.Field{Path: ""} From 8499c38c29ecfd7ea26d7e374e1893fa1a831c21 Mon Sep 17 00:00:00 2001 From: knottnt Date: Mon, 31 Aug 2026 10:22:51 -0700 Subject: [PATCH 5/5] PR review feedback - emit error from checkRequiredFieldsMissingFromShapeReadMany when mutuallyExclusiveIdentifierNilConditions throws an error. - Validate for duplicate entries post normalization in validateMutuallyExclusiveIdentifiers --- pkg/config/validate.go | 24 ++++++++++++++++++++++-- pkg/generate/code/check.go | 17 +++++++++-------- pkg/generate/code/check_test.go | 2 +- 3 files changed, 32 insertions(+), 11 deletions(-) diff --git a/pkg/config/validate.go b/pkg/config/validate.go index 8c89a88b0..fa51a6c43 100644 --- a/pkg/config/validate.go +++ b/pkg/config/validate.go @@ -17,6 +17,8 @@ import ( "fmt" "sort" "strings" + + "github.com/aws-controllers-k8s/pkg/names" ) // ValidateConfig checks that generator.yaml references to SDK operations are @@ -52,8 +54,10 @@ func ValidateConfig( // validateMutuallyExclusiveIdentifiers checks that a resource's // mutually_exclusive_identifiers configuration is internally consistent: it // must list at least two fields (a single identifier is not mutually exclusive -// with anything) and cannot be combined with is_arn_primary_key, since an -// ARN-primary resource always requires its ARN. +// with anything), the fields must be distinct after name normalization (two +// entries that resolve to the same CR field can never be "exactly one"), and it +// cannot be combined with is_arn_primary_key, since an ARN-primary resource +// always requires its ARN. func validateMutuallyExclusiveIdentifiers(cfg *Config) []error { var errs []error for resName, resCfg := range cfg.Resources { @@ -67,6 +71,22 @@ func validateMutuallyExclusiveIdentifiers(cfg *Config) []error { resName, len(identifiers), )) } + // Entries are resolved to CR fields by camel-casing the name (see + // CRD.GetMutuallyExclusiveIdentifierFields), so e.g. "PolicyName" and + // "policyName" collapse to the same field. Reject duplicates after + // normalization: the generated exactly-one guard would otherwise count + // the same field twice and adoption could never satisfy it. + seen := make(map[string]bool, len(identifiers)) + for _, id := range identifiers { + norm := names.New(id).Camel + if seen[norm] { + errs = append(errs, fmt.Errorf( + "resources.%s.mutually_exclusive_identifiers: %q resolves to the same field as another entry", + resName, id, + )) + } + seen[norm] = true + } if resCfg.IsARNPrimaryKey { errs = append(errs, fmt.Errorf( "resources.%s.mutually_exclusive_identifiers: cannot be combined with is_arn_primary_key", diff --git a/pkg/generate/code/check.go b/pkg/generate/code/check.go index b2844e7ed..82f1749d6 100644 --- a/pkg/generate/code/check.go +++ b/pkg/generate/code/check.go @@ -77,7 +77,7 @@ func CheckRequiredFieldsMissingFromShape( case model.OpTypeList: op = r.Ops.ReadMany return checkRequiredFieldsMissingFromShapeReadMany( - r, koVarName, indentLevel, op, op.InputRef.Shape), nil + r, koVarName, indentLevel, op, op.InputRef.Shape) case model.OpTypeGetAttributes: op = r.Ops.GetAttributes case model.OpTypeSetAttributes: @@ -237,7 +237,7 @@ func checkRequiredFieldsMissingFromShapeReadMany( indentLevel int, op *awssdkmodel.Operation, shape *awssdkmodel.Shape, -) string { +) (string, error) { indent := strings.Repeat("\t", indentLevel) result := fmt.Sprintf("%sreturn false", indent) @@ -246,24 +246,25 @@ func checkRequiredFieldsMissingFromShapeReadMany( // would let sdkFind list every resource and match an arbitrary one. Instead, // treat the read input as incomplete (returning true so sdkFind bails out // with NotFound) unless at least one of the declared identifiers is set on - // the resource. The mutually_exclusive_identifiers guard in - // PopulateResourceFromAnnotation still rejects supplying more than one. + // the resource. if r.HasMutuallyExclusiveIdentifiers() { exclusiveConditions, _, err := mutuallyExclusiveIdentifierNilConditions(r, koVarName) if err != nil { - return result + return "", err } - return fmt.Sprintf("%sreturn %s\n", indent, strings.Join(exclusiveConditions, " && ")) + // Parenthesize the grouped condition to mirror the ReadOne handling and + // stay correct if a future term is ever joined here with `||`. + return fmt.Sprintf("%sreturn (%s)\n", indent, strings.Join(exclusiveConditions, " && ")), nil } reqIdentifier, _ := FindPluralizedIdentifiersInShape(r, shape, op) resVarPath, err := r.GetSanitizedMemberPath(reqIdentifier, op, koVarName) if err != nil { - return result + return result, nil } result = fmt.Sprintf("%s == nil", resVarPath) - return fmt.Sprintf("%sreturn %s\n", indent, result) + return fmt.Sprintf("%sreturn %s\n", indent, result), nil } // CheckNilFieldPath returns the condition statement for Nil check diff --git a/pkg/generate/code/check_test.go b/pkg/generate/code/check_test.go index f1ae4db9a..6c4eb9c6d 100644 --- a/pkg/generate/code/check_test.go +++ b/pkg/generate/code/check_test.go @@ -212,7 +212,7 @@ func TestCheckRequiredFields_MutuallyExclusiveIdentifiers_ReadMany(t *testing.T) // incomplete unless at least one of the declared identifiers is set, which // is what the controller previously had to supply via a custom method. expRequiredFieldsCode := ` - return r.ko.Spec.PolicyName == nil && r.ko.Spec.ResourceARN == nil + return (r.ko.Spec.PolicyName == nil && r.ko.Spec.ResourceARN == nil) ` gotCode, err := code.CheckRequiredFieldsMissingFromShape( crd, model.OpTypeList, "r.ko", 1,