diff --git a/codegen/sdk-codegen/aws-models/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json index 54cb71b85a9..bcd11511cd0 100644 --- a/codegen/sdk-codegen/aws-models/ec2.json +++ b/codegen/sdk-codegen/aws-models/ec2.json @@ -3254,6 +3254,9 @@ { "target": "com.amazonaws.ec2#DisableFastSnapshotRestores" }, + { + "target": "com.amazonaws.ec2#DisableImageBlockPublicAccess" + }, { "target": "com.amazonaws.ec2#DisableImageDeprecation" }, @@ -3332,6 +3335,9 @@ { "target": "com.amazonaws.ec2#EnableFastSnapshotRestores" }, + { + "target": "com.amazonaws.ec2#EnableImageBlockPublicAccess" + }, { "target": "com.amazonaws.ec2#EnableImageDeprecation" }, @@ -3410,6 +3416,9 @@ { "target": "com.amazonaws.ec2#GetHostReservationPurchasePreview" }, + { + "target": "com.amazonaws.ec2#GetImageBlockPublicAccessState" + }, { "target": "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirements" }, @@ -42750,6 +42759,50 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#DisableImageBlockPublicAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableImageBlockPublicAccessRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableImageBlockPublicAccessResult" + }, + "traits": { + "smithy.api#documentation": "

Disables block public access for AMIs at the account level in the\n specified Amazon Web Services Region. This removes the block public access restriction\n from your account. With the restriction removed, you can publicly share your AMIs in the\n specified Amazon Web Services Region.

\n

The API can take up to 10 minutes to configure this setting. During this time, if you run\n GetImageBlockPublicAccessState, the response will be\n block-new-sharing. When the API has completed the configuration, the response\n will be unblocked.

\n

For more information, see Block public access to your AMIs in\n the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DisableImageBlockPublicAccessRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableImageBlockPublicAccessResult": { + "type": "structure", + "members": { + "ImageBlockPublicAccessState": { + "target": "com.amazonaws.ec2#ImageBlockPublicAccessDisabledState", + "traits": { + "aws.protocols#ec2QueryName": "ImageBlockPublicAccessState", + "smithy.api#documentation": "

Returns unblocked if the request succeeds; otherwise, it returns an\n error.

", + "smithy.api#xmlName": "imageBlockPublicAccessState" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#DisableImageDeprecation": { "type": "operation", "input": { @@ -45991,6 +46044,58 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#EnableImageBlockPublicAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableImageBlockPublicAccessRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableImageBlockPublicAccessResult" + }, + "traits": { + "smithy.api#documentation": "

Enables block public access for AMIs at the account level in the\n specified Amazon Web Services Region. This prevents the public sharing of your AMIs. However, if you already\n have public AMIs, they will remain publicly available.

\n

The API can take up to 10 minutes to configure this setting. During this time, if you run\n GetImageBlockPublicAccessState, the response will be unblocked. When\n the API has completed the configuration, the response will be\n block-new-sharing.

\n

For more information, see Block\n public access to your AMIs in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#EnableImageBlockPublicAccessRequest": { + "type": "structure", + "members": { + "ImageBlockPublicAccessState": { + "target": "com.amazonaws.ec2#ImageBlockPublicAccessEnabledState", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specify block-new-sharing to enable block public access for AMIs at the\n account level in the specified Region. This will block any attempt to publicly share your AMIs\n in the specified Region.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableImageBlockPublicAccessResult": { + "type": "structure", + "members": { + "ImageBlockPublicAccessState": { + "target": "com.amazonaws.ec2#ImageBlockPublicAccessEnabledState", + "traits": { + "aws.protocols#ec2QueryName": "ImageBlockPublicAccessState", + "smithy.api#documentation": "

Returns block-new-sharing if the request succeeds; otherwise, it returns an\n error.

", + "smithy.api#xmlName": "imageBlockPublicAccessState" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#EnableImageDeprecation": { "type": "operation", "input": { @@ -50919,6 +51024,50 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#GetImageBlockPublicAccessState": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetImageBlockPublicAccessStateRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetImageBlockPublicAccessStateResult" + }, + "traits": { + "smithy.api#documentation": "

Gets the current state of block public access for AMIs at the account\n level in the specified Amazon Web Services Region.

\n

For more information, see Block\n public access to your AMIs in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#GetImageBlockPublicAccessStateRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetImageBlockPublicAccessStateResult": { + "type": "structure", + "members": { + "ImageBlockPublicAccessState": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageBlockPublicAccessState", + "smithy.api#documentation": "

The current state of block public access for AMIs at the account level in the specified\n Amazon Web Services Region.

\n

Possible values:

\n ", + "smithy.api#xmlName": "imageBlockPublicAccessState" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirements": { "type": "operation", "input": { @@ -55157,6 +55306,28 @@ } } }, + "com.amazonaws.ec2#ImageBlockPublicAccessDisabledState": { + "type": "enum", + "members": { + "unblocked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unblocked" + } + } + } + }, + "com.amazonaws.ec2#ImageBlockPublicAccessEnabledState": { + "type": "enum", + "members": { + "block_new_sharing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "block-new-sharing" + } + } + } + }, "com.amazonaws.ec2#ImageDiskContainer": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/eventbridge.json b/codegen/sdk-codegen/aws-models/eventbridge.json index 3fac15dfeee..b23a7bf7a40 100644 --- a/codegen/sdk-codegen/aws-models/eventbridge.json +++ b/codegen/sdk-codegen/aws-models/eventbridge.json @@ -2010,6 +2010,17 @@ "smithy.api#pattern": "^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$" } }, + "com.amazonaws.eventbridge#AuthHeaderParametersSensitive": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.eventbridge#AwsVpcConfiguration": { "type": "structure", "members": { @@ -2444,7 +2455,7 @@ } }, "Value": { - "target": "com.amazonaws.eventbridge#String", + "target": "com.amazonaws.eventbridge#SensitiveString", "traits": { "smithy.api#documentation": "

The value associated with the key.

" } @@ -2493,7 +2504,7 @@ } }, "Value": { - "target": "com.amazonaws.eventbridge#HeaderValue", + "target": "com.amazonaws.eventbridge#HeaderValueSensitive", "traits": { "smithy.api#documentation": "

The value associated with the key.

" } @@ -2637,7 +2648,7 @@ } }, "Value": { - "target": "com.amazonaws.eventbridge#QueryStringValue", + "target": "com.amazonaws.eventbridge#QueryStringValueSensitive", "traits": { "smithy.api#documentation": "

The value associated with the key for the query string parameter.

" } @@ -2973,7 +2984,7 @@ } }, "ApiKeyValue": { - "target": "com.amazonaws.eventbridge#AuthHeaderParameters", + "target": "com.amazonaws.eventbridge#AuthHeaderParametersSensitive", "traits": { "smithy.api#documentation": "

The value for the API key to use for authorization.

", "smithy.api#required": {} @@ -3027,7 +3038,7 @@ } }, "Password": { - "target": "com.amazonaws.eventbridge#AuthHeaderParameters", + "target": "com.amazonaws.eventbridge#AuthHeaderParametersSensitive", "traits": { "smithy.api#documentation": "

The password associated with the user name to use for Basic authorization.

", "smithy.api#required": {} @@ -3049,7 +3060,7 @@ } }, "ClientSecret": { - "target": "com.amazonaws.eventbridge#AuthHeaderParameters", + "target": "com.amazonaws.eventbridge#AuthHeaderParametersSensitive", "traits": { "smithy.api#documentation": "

The client secret associated with the client ID to use for OAuth authorization for the\n connection.

", "smithy.api#required": {} @@ -5461,6 +5472,17 @@ "smithy.api#pattern": "^[ \\t]*[\\x20-\\x7E]+([ \\t]+[\\x20-\\x7E]+)*[ \\t]*$" } }, + "com.amazonaws.eventbridge#HeaderValueSensitive": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[ \\t]*[\\x20-\\x7E]+([ \\t]+[\\x20-\\x7E]+)*[ \\t]*$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.eventbridge#HealthCheck": { "type": "string", "traits": { @@ -7556,6 +7578,17 @@ "smithy.api#pattern": "^[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+$" } }, + "com.amazonaws.eventbridge#QueryStringValueSensitive": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.eventbridge#RedshiftDataParameters": { "type": "structure", "members": { @@ -8394,6 +8427,12 @@ "smithy.api#pattern": "^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]|\\d|\\-)*:([0-9]{12})?:secret:[\\/_+=\\.@\\-A-Za-z0-9]+$" } }, + "com.amazonaws.eventbridge#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.eventbridge#Sql": { "type": "string", "traits": { @@ -9236,7 +9275,7 @@ } }, "ApiKeyValue": { - "target": "com.amazonaws.eventbridge#AuthHeaderParameters", + "target": "com.amazonaws.eventbridge#AuthHeaderParametersSensitive", "traits": { "smithy.api#documentation": "

The value associated with teh API key to use for authorization.

" } @@ -9288,7 +9327,7 @@ } }, "Password": { - "target": "com.amazonaws.eventbridge#AuthHeaderParameters", + "target": "com.amazonaws.eventbridge#AuthHeaderParametersSensitive", "traits": { "smithy.api#documentation": "

The password associated with the user name to use for Basic authorization.

" } @@ -9308,7 +9347,7 @@ } }, "ClientSecret": { - "target": "com.amazonaws.eventbridge#AuthHeaderParameters", + "target": "com.amazonaws.eventbridge#AuthHeaderParametersSensitive", "traits": { "smithy.api#documentation": "

The client secret assciated with the client ID to use for OAuth authorization.

" } diff --git a/codegen/sdk-codegen/aws-models/kendra.json b/codegen/sdk-codegen/aws-models/kendra.json index 23d0c050792..e7d54f2362a 100644 --- a/codegen/sdk-codegen/aws-models/kendra.json +++ b/codegen/sdk-codegen/aws-models/kendra.json @@ -306,52 +306,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -359,13 +363,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -375,224 +388,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://kendra-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://kendra-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": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://kendra-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://kendra-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://kendra.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://kendra.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://kendra.{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://kendra.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -1489,66 +1453,66 @@ "AndAllFilters": { "target": "com.amazonaws.kendra#AttributeFilterList", "traits": { - "smithy.api#documentation": "

Performs a logical AND operation on all supplied filters.

" + "smithy.api#documentation": "

Performs a logical AND operation on all filters that you specify.

" } }, "OrAllFilters": { "target": "com.amazonaws.kendra#AttributeFilterList", "traits": { - "smithy.api#documentation": "

Performs a logical OR operation on all supplied filters.

" + "smithy.api#documentation": "

Performs a logical OR operation on all filters that you specify.

" } }, "NotFilter": { "target": "com.amazonaws.kendra#AttributeFilter", "traits": { - "smithy.api#documentation": "

Performs a logical NOT operation on all supplied filters.

" + "smithy.api#documentation": "

Performs a logical NOT operation on all filters that you specify.

" } }, "EqualsTo": { "target": "com.amazonaws.kendra#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs an equals operation on two document attributes or metadata fields.

" + "smithy.api#documentation": "

Performs an equals operation on document attributes/fields and their values.

" } }, "ContainsAll": { "target": "com.amazonaws.kendra#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Returns true when a document contains all of the specified document attributes or\n metadata fields. This filter is only applicable to StringListValue\n metadata.

" + "smithy.api#documentation": "

Returns true when a document contains all of the specified document attributes/fields. \n This filter is only applicable to StringListValue.

" } }, "ContainsAny": { "target": "com.amazonaws.kendra#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Returns true when a document contains any of the specified document attributes or\n metadata fields. This filter is only applicable to StringListValue\n metadata.

" + "smithy.api#documentation": "

Returns true when a document contains any of the specified document attributes/fields. \n This filter is only applicable to StringListValue.

" } }, "GreaterThan": { "target": "com.amazonaws.kendra#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a greater than operation on two document attributes or metadata fields. Use\n with a document attribute of type Date or Long.

" + "smithy.api#documentation": "

Performs a greater than operation on document attributes/fields and their \n values. Use with the document attribute \n type\n Date or Long.

" } }, "GreaterThanOrEquals": { "target": "com.amazonaws.kendra#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a greater or equals than operation on two document attributes or metadata\n fields. Use with a document attribute of type Date or\n Long.

" + "smithy.api#documentation": "

Performs a greater or equals than operation on document attributes/fields and \n their values. Use with the document attribute \n type\n Date or Long.

" } }, "LessThan": { "target": "com.amazonaws.kendra#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a less than operation on two document attributes or metadata fields. Use with a\n document attribute of type Date or Long.

" + "smithy.api#documentation": "

Performs a less than operation on document attributes/fields and their values. \n Use with the document attribute \n type\n Date or Long.

" } }, "LessThanOrEquals": { "target": "com.amazonaws.kendra#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a less than or equals operation on two document attributes or metadata fields.\n Use with a document attribute of type Date or Long.

" + "smithy.api#documentation": "

Performs a less than or equals operation on document attributes/fields and \n their values. Use with the document attribute \n type\n Date or Long.

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

Provides filtering the query results based on document attributes or metadata\n fields.

\n

When you use the AndAllFilters or OrAllFilters, filters you\n can use 2 layers under the first attribute filter. For example, you can use:

\n

\n \n

\n
    \n
  1. \n

    \n \n

    \n
    2. \n
  2. \n

    \n \n

    \n
    3. \n
\n

If you use more than 2 layers, you receive a ValidationException exception\n with the message \"AttributeFilter cannot have a depth of more than 2.\"

\n

If you use more than 10 attribute filters in a given list for AndAllFilters\n or OrAllFilters, you receive a ValidationException with the\n message \"AttributeFilter cannot have a length of more than 10\".

" + "smithy.api#documentation": "

Filters the search results based on document attributes or fields.

\n

You can filter results using attributes for your particular documents. \n The attributes must exist in your index. For example, if your documents \n include the custom attribute \"Department\", you can filter documents that \n belong to the \"HR\" department. You would use the EqualsTo \n operation to filter results or documents with \"Department\" equals to \"HR\".

\n

You can use AndAllFilters and AndOrFilters in \n combination with each other or with other operations such as EqualsTo. \n For example:

\n

\n AndAllFilters\n

\n \n

This example filters results or documents that belong to the HR department \n and belong to projects that contain \"new hires\" \n or \"new hiring\" in the project name (must use \n ContainAny with StringListValue). This example is \n filtering with a depth of 2.

\n

You cannot filter more than a depth of 2, otherwise you receive a \n ValidationException exception with the message \"AttributeFilter \n cannot have a depth of more than 2.\" Also, if you use more than 10 attribute \n filters in a given list for AndAllFilters or OrAllFilters, \n you receive a ValidationException with the message \"AttributeFilter \n cannot have a length of more than 10\".

\n

For examples of using AttributeFilter, see Using \n document attributes to filter search results.

" } }, "com.amazonaws.kendra#AttributeFilterList": { @@ -1730,7 +1694,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes one or more documents from an index. The documents must have been added with\n the BatchPutDocument API.

\n

The documents are deleted asynchronously. You can see the progress of the deletion by\n using Amazon Web Services CloudWatch. Any error messages related to the processing of the\n batch are sent to you CloudWatch log.

" + "smithy.api#documentation": "

Removes one or more documents from an index. The documents must have been added with\n the BatchPutDocument API.

\n

The documents are deleted asynchronously. You can see the progress of the deletion by\n using Amazon Web Services CloudWatch. Any error messages related to the processing of the\n batch are sent to your Amazon Web Services CloudWatch log. You can also use the \n BatchGetDocumentStatus API to monitor the progress of deleting your documents.

\n

Deleting documents from an index using BatchDeleteDocument could take up \n to an hour or more, depending on the number of documents you want to delete.

" } }, "com.amazonaws.kendra#BatchDeleteDocumentRequest": { @@ -2043,7 +2007,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds one or more documents to an index.

\n

The BatchPutDocument API enables you to ingest inline documents or a set\n of documents stored in an Amazon S3 bucket. Use this API to ingest your text and\n unstructured text into an index, add custom attributes to the documents, and to attach\n an access control list to the documents added to the index.

\n

The documents are indexed asynchronously. You can see the progress of the batch using\n Amazon Web Services\n CloudWatch. Any error messages related to processing the batch are sent to your\n Amazon Web Services\n CloudWatch log.

\n

For an example of ingesting inline documents using Python and Java SDKs, see Adding files\n directly to an index.

" + "smithy.api#documentation": "

Adds one or more documents to an index.

\n

The BatchPutDocument API enables you to ingest inline documents or a set\n of documents stored in an Amazon S3 bucket. Use this API to ingest your text and\n unstructured text into an index, add custom attributes to the documents, and to attach\n an access control list to the documents added to the index.

\n

The documents are indexed asynchronously. You can see the progress of the batch using \n Amazon Web Services CloudWatch. Any error messages related to processing the batch \n are sent to your Amazon Web Services CloudWatch log. You can also use the \n BatchGetDocumentStatus API to monitor the progress of indexing your documents.

\n

For an example of ingesting inline documents using Python and Java SDKs, see Adding files\n directly to an index.

" } }, "com.amazonaws.kendra#BatchPutDocumentRequest": { @@ -2086,7 +2050,7 @@ "FailedDocuments": { "target": "com.amazonaws.kendra#BatchPutDocumentResponseFailedDocuments", "traits": { - "smithy.api#documentation": "

A list of documents that were not added to the index because the document failed a\n validation check. Each document contains an error message that indicates why the\n document couldn't be added to the index.

\n

If there was an error adding a document to an index the error is reported in your\n Amazon Web Services CloudWatch log. For more information, see Monitoring Amazon\n Kendra with Amazon CloudWatch Logs\n

" + "smithy.api#documentation": "

A list of documents that were not added to the index because the document failed a\n validation check. Each document contains an error message that indicates why the\n document couldn't be added to the index.

\n

If there was an error adding a document to an index the error is reported in your\n Amazon Web Services CloudWatch log. For more information, see Monitoring \n Amazon Kendra with Amazon CloudWatch logs.

" } } }, @@ -3920,7 +3884,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine\n if index creation has completed, check the Status field returned from a call to\n DescribeIndex. The Status field is set to ACTIVE when\n the index is ready to use.

\n

Once the index is active you can index your documents using the\n BatchPutDocument API or using one of the supported data sources.

\n

For an example of creating an index and data source using the Python SDK, see Getting started with Python\n SDK. For an example of creating an index and data source using the Java SDK, see\n Getting started with Java\n SDK.

" + "smithy.api#documentation": "

Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine\n if index creation has completed, check the Status field returned from a call to\n DescribeIndex. The Status field is set to ACTIVE when\n the index is ready to use.

\n

Once the index is active, you can index your documents using the\n BatchPutDocument API or using one of the supported data sources.

\n

For an example of creating an index and data source using the Python SDK, see Getting started with Python\n SDK. For an example of creating an index and data source using the Java SDK, see\n Getting started with Java\n SDK.

" } }, "com.amazonaws.kendra#CreateIndexRequest": { @@ -4746,26 +4710,26 @@ "DataSourceFieldName": { "target": "com.amazonaws.kendra#DataSourceFieldName", "traits": { - "smithy.api#documentation": "

The name of the column or attribute in the data source.

", + "smithy.api#documentation": "

The name of the field in the data source. You must first create the index field \n using the UpdateIndex API.

", "smithy.api#required": {} } }, "DateFieldFormat": { "target": "com.amazonaws.kendra#DataSourceDateFieldFormat", "traits": { - "smithy.api#documentation": "

The type of data stored in the column or attribute.

" + "smithy.api#documentation": "

The format for date fields in the data source. If the field specified in \n DataSourceFieldName is a date field, you must specify the date \n format. If the field is not a date field, an exception is thrown.

" } }, "IndexFieldName": { "target": "com.amazonaws.kendra#IndexFieldName", "traits": { - "smithy.api#documentation": "

The name of the field in the index.

", + "smithy.api#documentation": "

The name of the index field to map to the data source field. The index field type \n must match the data source field type.

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

Maps a column or attribute in the data source to an index field. You must first create the\n fields in the index using the UpdateIndex API.

" + "smithy.api#documentation": "

Maps attributes or field names of the documents synced from the data source \n to Amazon Kendra index field names. You can set up field mappings for each \n data source when calling CreateDataSource \n or UpdateDataSource API. To create custom fields, use the UpdateIndex \n API to first create an index field and then map to the data source field. For more \n information, see Mapping data source fields.

" } }, "com.amazonaws.kendra#DataSourceToIndexFieldMappingList": { @@ -4962,7 +4926,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the configuration information to connect to a index.

" + "smithy.api#documentation": "

Provides the configuration information to an Amazon Kendra supported \n database.

" } }, "com.amazonaws.kendra#DatabaseEngineType": { @@ -5112,7 +5076,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an Amazon Kendra data source connector. An exception is not thrown if the\n data source is already being deleted. While the data source is being deleted, the\n Status field returned by a call to the DescribeDataSource API is\n set to DELETING. For more information, see Deleting Data Sources.

" + "smithy.api#documentation": "

Deletes an Amazon Kendra data source connector. An exception is not thrown if the\n data source is already being deleted. While the data source is being deleted, the\n Status field returned by a call to the DescribeDataSource API is\n set to DELETING. For more information, see Deleting Data Sources.

\n

Deleting an entire data source or re-syncing your index after deleting specific documents \n from a data source could take up to an hour or more, depending on the number of documents you \n want to delete.

" } }, "com.amazonaws.kendra#DeleteDataSourceRequest": { @@ -7076,24 +7040,24 @@ "DocumentAttributeValue": { "target": "com.amazonaws.kendra#DocumentAttributeValue", "traits": { - "smithy.api#documentation": "

The value of the attribute. For example, \"HR\".

" + "smithy.api#documentation": "

The value of the attribute/field. For example, \"HR\".

" } }, "Count": { "target": "com.amazonaws.kendra#Integer", "traits": { - "smithy.api#documentation": "

The number of documents in the response that have the attribute value for the\n key.

" + "smithy.api#documentation": "

The number of documents in the response that have the attribute/field value for \n the key.

" } }, "FacetResults": { "target": "com.amazonaws.kendra#FacetResultList", "traits": { - "smithy.api#documentation": "

Contains the results of a document attribute that is a nested facet. A\n FacetResult contains the counts for each facet nested within a\n facet.

\n

For example, the document attribute or facet \"Department\" includes a value called\n \"Engineering\". In addition, the document attribute or facet \"SubDepartment\" includes the\n values \"Frontend\" and \"Backend\" for documents assigned to \"Engineering\". You can display\n nested facets in the search results so that documents can be searched not only by\n department but also by a sub department within a department. The counts for documents that\n belong to \"Frontend\" and \"Backend\" within \"Engineering\" are returned for a query.

\n

\n

" + "smithy.api#documentation": "

Contains the results of a document attribute/field that is a nested facet. A\n FacetResult contains the counts for each facet nested within a\n facet.

\n

For example, the document attribute or facet \"Department\" includes a value called\n \"Engineering\". In addition, the document attribute or facet \"SubDepartment\" includes the\n values \"Frontend\" and \"Backend\" for documents assigned to \"Engineering\". You can display\n nested facets in the search results so that documents can be searched not only by\n department but also by a sub department within a department. The counts for documents that\n belong to \"Frontend\" and \"Backend\" within \"Engineering\" are returned for a query.

\n

\n

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

Provides the count of documents that match a particular attribute when doing a faceted\n search.

" + "smithy.api#documentation": "

Provides the count of documents that match a particular document attribute or \n field when doing a faceted search.

" } }, "com.amazonaws.kendra#DocumentAttributeValueCountPairList": { @@ -7813,7 +7777,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about a document attribute. You can use document attributes as\n facets.

\n

For example, the document attribute or facet \"Department\" includes the values \"HR\",\n \"Engineering\", and \"Accounting\". You can display these values in the search results so that\n documents can be searched by department.

\n

You can display up to 10 facet values per facet for a query. If you want to increase\n this limit, contact Support.

" + "smithy.api#documentation": "

Information about a document attribute or field. You can use document attributes as\n facets.

\n

For example, the document attribute or facet \"Department\" includes the values \"HR\",\n \"Engineering\", and \"Accounting\". You can display these values in the search results so that\n documents can be searched by department.

\n

You can display up to 10 facet values per facet for a query. If you want to increase\n this limit, contact Support.

" } }, "com.amazonaws.kendra#FacetList": { @@ -12405,7 +12369,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves relevant passages or text excerpts given an input query.

\n

This API is similar to the Query \n API. However, by default, the Query API only \n returns excerpt passages of up to 100 token words. With the \n Retrieve API, you can retrieve longer passages of up to \n 200 token words and up to 100 semantically relevant passages. This doesn't \n include question-answer or FAQ type responses from your index. The passages \n are text excerpts that can be semantically extracted from multiple documents \n and multiple parts of the same document. If in extreme cases your documents \n produce no relevant passages using the Retrieve API, you can \n alternatively use the Query API.

\n

You can also do the following:

\n \n

You can also include certain fields in the response that might provide useful\n additional information.

" + "smithy.api#documentation": "

Retrieves relevant passages or text excerpts given an input query.

\n

This API is similar to the Query \n API. However, by default, the Query API only \n returns excerpt passages of up to 100 token words. With the \n Retrieve API, you can retrieve longer passages of up to \n 200 token words and up to 100 semantically relevant passages. This doesn't \n include question-answer or FAQ type responses from your index. The passages \n are text excerpts that can be semantically extracted from multiple documents \n and multiple parts of the same document. If in extreme cases your documents \n produce zero passages using the Retrieve API, you can alternatively \n use the Query API and its types of responses.

\n

You can also do the following:

\n \n

You can also include certain fields in the response that might provide useful\n additional information.

\n

The Retrieve API shares the number of query capacity \n units that you set for your index. For more information on what's included in \n a single capacity unit and the default base capacity for an index, see Adjusting \n capacity.

" } }, "com.amazonaws.kendra#RetrieveRequest": { @@ -12524,6 +12488,12 @@ "traits": { "smithy.api#documentation": "

An array of document fields/attributes assigned to a document in the \n search results. For example, the document author (_author) \n or the source URI (_source_uri) of the document.

" } + }, + "ScoreAttributes": { + "target": "com.amazonaws.kendra#ScoreAttributes", + "traits": { + "smithy.api#documentation": "

The confidence score bucket for a retrieved passage result. The confidence \n bucket provides a relative ranking that indicates how confident Amazon Kendra \n is that the response is relevant to the query.

" + } } }, "traits": { @@ -14028,7 +13998,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a synchronization job for a data source connector. If a synchronization job is\n already in progress, Amazon Kendra returns a ResourceInUseException\n exception.

" + "smithy.api#documentation": "

Starts a synchronization job for a data source connector. If a synchronization job is\n already in progress, Amazon Kendra returns a ResourceInUseException\n exception.

\n

Re-syncing your data source with your index after modifying, adding, or deleting \n documents from your data source respository could take up to an hour or more, depending on \n the number of documents to sync.

" } }, "com.amazonaws.kendra#StartDataSourceSyncJobRequest": {