diff --git a/codegen/sdk-codegen/aws-models/accessanalyzer.json b/codegen/sdk-codegen/aws-models/accessanalyzer.json index 1575af48db3..81bcf0da2ab 100644 --- a/codegen/sdk-codegen/aws-models/accessanalyzer.json +++ b/codegen/sdk-codegen/aws-models/accessanalyzer.json @@ -2331,7 +2331,7 @@ "s3Bucket": { "target": "com.amazonaws.accessanalyzer#S3BucketConfiguration", "traits": { - "smithy.api#documentation": "

The access control configuration is for an Amazon S3 Bucket.

" + "smithy.api#documentation": "

The access control configuration is for an Amazon S3 bucket.

" } }, "snsTopic": { @@ -2345,6 +2345,12 @@ "traits": { "smithy.api#documentation": "

The access control configuration is for an Amazon SQS queue.

" } + }, + "s3ExpressDirectoryBucket": { + "target": "com.amazonaws.accessanalyzer#S3ExpressDirectoryBucketConfiguration", + "traits": { + "smithy.api#documentation": "

The access control configuration is for an Amazon S3 directory bucket.

" + } } }, "traits": { @@ -5838,6 +5844,10 @@ { "value": "AWS::SNS::Topic", "name": "AWS_SNS_TOPIC" + }, + { + "value": "AWS::S3Express::DirectoryBucket", + "name": "AWS_S3EXPRESS_DIRECTORYBUCKET" } ] } @@ -5949,6 +5959,23 @@ "com.amazonaws.accessanalyzer#S3BucketPolicy": { "type": "string" }, + "com.amazonaws.accessanalyzer#S3ExpressDirectoryBucketConfiguration": { + "type": "structure", + "members": { + "bucketPolicy": { + "target": "com.amazonaws.accessanalyzer#S3ExpressDirectoryBucketPolicy", + "traits": { + "smithy.api#documentation": "

The proposed bucket policy for the Amazon S3 directory bucket.

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

Proposed access control configuration for an Amazon S3 directory bucket. You can propose a\n configuration for a new Amazon S3 directory bucket or an existing Amazon S3 directory bucket that you\n own by specifying the Amazon S3 bucket policy. If the configuration is for an existing Amazon S3\n directory bucket and you do not specify the Amazon S3 bucket policy, the access preview uses the\n existing policy attached to the directory bucket. If the access preview is for a new\n resource and you do not specify the Amazon S3 bucket policy, the access preview assumes an\n directory bucket without a policy. To propose deletion of an existing bucket policy, you\n can specify an empty string. For more information about bucket policy limits, see Example bucket policies.

" + } + }, + "com.amazonaws.accessanalyzer#S3ExpressDirectoryBucketPolicy": { + "type": "string" + }, "com.amazonaws.accessanalyzer#S3PublicAccessBlockConfiguration": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json b/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json new file mode 100644 index 00000000000..3aeb386278c --- /dev/null +++ b/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json @@ -0,0 +1,2454 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.bedrockagentruntime#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentruntime#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when a request is denied per access permissions", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.bedrockagentruntime#ActionGroupInvocationInput": { + "type": "structure", + "members": { + "actionGroupName": { + "target": "com.amazonaws.bedrockagentruntime#ActionGroupName" + }, + "verb": { + "target": "com.amazonaws.bedrockagentruntime#Verb" + }, + "apiPath": { + "target": "com.amazonaws.bedrockagentruntime#ApiPath" + }, + "parameters": { + "target": "com.amazonaws.bedrockagentruntime#Parameters" + }, + "requestBody": { + "target": "com.amazonaws.bedrockagentruntime#RequestBody" + } + }, + "traits": { + "smithy.api#documentation": "input to lambda used in action group" + } + }, + "com.amazonaws.bedrockagentruntime#ActionGroupInvocationOutput": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.bedrockagentruntime#ActionGroupOutputString" + } + }, + "traits": { + "smithy.api#documentation": "output from lambda used in action group" + } + }, + "com.amazonaws.bedrockagentruntime#ActionGroupName": { + "type": "string", + "traits": { + "smithy.api#documentation": "Agent Trace Action Group Name", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#ActionGroupOutputString": { + "type": "string", + "traits": { + "smithy.api#documentation": "Agent Trace Action Group Lambda Invocation Output String", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#AgentAliasId": { + "type": "string", + "traits": { + "smithy.api#documentation": "Identifier of the agent alias.", + "smithy.api#length": { + "max": 10 + }, + "smithy.api#pattern": "^[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrockagentruntime#AgentId": { + "type": "string", + "traits": { + "smithy.api#documentation": "Identifier of the agent.", + "smithy.api#length": { + "max": 10 + }, + "smithy.api#pattern": "^[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrockagentruntime#AmazonBedrockAgentRunTimeService": { + "type": "service", + "version": "2023-07-26", + "resources": [ + { + "target": "com.amazonaws.bedrockagentruntime#InferenceResource" + }, + { + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateResource" + }, + { + "target": "com.amazonaws.bedrockagentruntime#RetrieveResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Bedrock Agent Runtime", + "arnNamespace": "bedrock", + "endpointPrefix": "bedrock-agent-runtime", + "cloudTrailEventSource": "bedrock.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "bedrock" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Amazon Bedrock Agent", + "smithy.api#title": "Agents for Amazon Bedrock Runtime", + "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": [], + "rules": [ + { + "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" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent-runtime-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent-runtime-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent-runtime.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent-runtime.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime-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://bedrock-agent-runtime-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://bedrock-agent-runtime.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.bedrockagentruntime#ApiPath": { + "type": "string", + "traits": { + "smithy.api#documentation": "Agent Trace Action Group API path", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#Attribution": { + "type": "structure", + "members": { + "citations": { + "target": "com.amazonaws.bedrockagentruntime#Citations" + } + }, + "traits": { + "smithy.api#documentation": "Citations associated with final agent response" + } + }, + "com.amazonaws.bedrockagentruntime#BadGatewayException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentruntime#NonBlankString" + }, + "resourceName": { + "target": "com.amazonaws.bedrockagentruntime#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource", + "smithy.api#error": "server", + "smithy.api#httpError": 502 + } + }, + "com.amazonaws.bedrockagentruntime#BedrockModelArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "Arn of a Bedrock model.", + "smithy.api#length": { + "min": 20, + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))$" + } + }, + "com.amazonaws.bedrockagentruntime#Citation": { + "type": "structure", + "members": { + "generatedResponsePart": { + "target": "com.amazonaws.bedrockagentruntime#GeneratedResponsePart" + }, + "retrievedReferences": { + "target": "com.amazonaws.bedrockagentruntime#RetrievedReferences" + } + }, + "traits": { + "smithy.api#documentation": "Citation associated with the agent response" + } + }, + "com.amazonaws.bedrockagentruntime#Citations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#Citation" + }, + "traits": { + "smithy.api#documentation": "List of citations" + } + }, + "com.amazonaws.bedrockagentruntime#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentruntime#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when there is a conflict performing an operation", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.bedrockagentruntime#ContentMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.bedrockagentruntime#Parameters" + }, + "traits": { + "smithy.api#documentation": "Content type paramter map" + } + }, + "com.amazonaws.bedrockagentruntime#CreationMode": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + }, + "OVERRIDDEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERRIDDEN" + } + } + }, + "traits": { + "smithy.api#documentation": "indicates if agent uses default prompt or overriden prompt" + } + }, + "com.amazonaws.bedrockagentruntime#DependencyFailedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentruntime#NonBlankString" + }, + "resourceName": { + "target": "com.amazonaws.bedrockagentruntime#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource due to a customer fault (i.e. bad configuration)", + "smithy.api#error": "client", + "smithy.api#httpError": 424 + } + }, + "com.amazonaws.bedrockagentruntime#FailureReasonString": { + "type": "string", + "traits": { + "smithy.api#documentation": "Agent Trace Failed Reason String", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FailureTrace": { + "type": "structure", + "members": { + "traceId": { + "target": "com.amazonaws.bedrockagentruntime#TraceId" + }, + "failureReason": { + "target": "com.amazonaws.bedrockagentruntime#FailureReasonString" + } + }, + "traits": { + "smithy.api#documentation": "Trace Part which is emitted when agent trace could not be generated", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FinalResponse": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.bedrockagentruntime#FinalResponseString" + } + }, + "traits": { + "smithy.api#documentation": "Agent finish output" + } + }, + "com.amazonaws.bedrockagentruntime#FinalResponseString": { + "type": "string", + "traits": { + "smithy.api#documentation": "Agent Trace Action Group Lambda Invocation Output String", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GeneratedResponsePart": { + "type": "structure", + "members": { + "textResponsePart": { + "target": "com.amazonaws.bedrockagentruntime#TextResponsePart" + } + }, + "traits": { + "smithy.api#documentation": "Generate response part" + } + }, + "com.amazonaws.bedrockagentruntime#InferenceConfiguration": { + "type": "structure", + "members": { + "temperature": { + "target": "com.amazonaws.bedrockagentruntime#Temperature" + }, + "topP": { + "target": "com.amazonaws.bedrockagentruntime#TopP" + }, + "topK": { + "target": "com.amazonaws.bedrockagentruntime#TopK" + }, + "maximumLength": { + "target": "com.amazonaws.bedrockagentruntime#MaximumLength" + }, + "stopSequences": { + "target": "com.amazonaws.bedrockagentruntime#StopSequences" + } + }, + "traits": { + "smithy.api#documentation": "Configurations for controlling the inference response of an InvokeAgent API call" + } + }, + "com.amazonaws.bedrockagentruntime#InferenceResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentruntime#InvokeAgent" + } + ] + }, + "com.amazonaws.bedrockagentruntime#InputText": { + "type": "string", + "traits": { + "smithy.api#documentation": "Model text input", + "smithy.api#length": { + "max": 25000000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentruntime#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown if there was an unexpected error during processing of request", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.bedrockagentruntime#InvocationInput": { + "type": "structure", + "members": { + "traceId": { + "target": "com.amazonaws.bedrockagentruntime#TraceId" + }, + "invocationType": { + "target": "com.amazonaws.bedrockagentruntime#InvocationType" + }, + "actionGroupInvocationInput": { + "target": "com.amazonaws.bedrockagentruntime#ActionGroupInvocationInput" + }, + "knowledgeBaseLookupInput": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInput" + } + }, + "traits": { + "smithy.api#documentation": "Trace Part which contains input details for action group or knowledge base", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#InvocationType": { + "type": "enum", + "members": { + "ACTION_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTION_GROUP" + } + }, + "KNOWLEDGE_BASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KNOWLEDGE_BASE" + } + }, + "FINISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FINISH" + } + } + }, + "traits": { + "smithy.api#documentation": "types of invocations" + } + }, + "com.amazonaws.bedrockagentruntime#InvokeAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#InvokeAgentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#InvokeAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Invokes the specified Bedrock model to run inference using the input provided in the request body.", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/{agentId}/agentAliases/{agentAliasId}/sessions/{sessionId}/text" + } + } + }, + "com.amazonaws.bedrockagentruntime#InvokeAgentRequest": { + "type": "structure", + "members": { + "sessionState": { + "target": "com.amazonaws.bedrockagentruntime#SessionState", + "traits": { + "smithy.api#documentation": "Session state passed by customer. Base64 encoded json string representation of SessionState." + } + }, + "agentId": { + "target": "com.amazonaws.bedrockagentruntime#AgentId", + "traits": { + "smithy.api#documentation": "Identifier for Agent", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagentruntime#AgentAliasId", + "traits": { + "smithy.api#documentation": "Identifier for Agent Alias", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#SessionId", + "traits": { + "smithy.api#documentation": "Identifier used for the current session", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "endSession": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "End current session" + } + }, + "enableTrace": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Enable agent trace events for improved debugging" + } + }, + "inputText": { + "target": "com.amazonaws.bedrockagentruntime#InputText", + "traits": { + "smithy.api#documentation": "Input data in the format specified in the Content-Type request header.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "InvokeAgent Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#InvokeAgentResponse": { + "type": "structure", + "members": { + "completion": { + "target": "com.amazonaws.bedrockagentruntime#ResponseStream", + "traits": { + "smithy.api#documentation": "Inference response from the model in the format specified in the Content-Type response header.", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.bedrockagentruntime#MimeType", + "traits": { + "smithy.api#documentation": "streaming response mimetype of the model", + "smithy.api#httpHeader": "x-amzn-bedrock-agent-content-type", + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#SessionId", + "traits": { + "smithy.api#documentation": "streaming response mimetype of the model", + "smithy.api#httpHeader": "x-amz-bedrock-agent-session-id", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "InvokeAgent Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "A KMS key ARN", + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseId": { + "type": "string", + "traits": { + "smithy.api#documentation": "Identifier of the KnowledgeBase", + "smithy.api#length": { + "max": 10 + }, + "smithy.api#pattern": "^[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInput": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInputString" + }, + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagentruntime#TraceKnowledgeBaseId" + } + }, + "traits": { + "smithy.api#documentation": "Input to lambda used in action group" + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInputString": { + "type": "string", + "traits": { + "smithy.api#documentation": "Agent Trace Action Group Lambda Invocation Output String", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupOutput": { + "type": "structure", + "members": { + "retrievedReferences": { + "target": "com.amazonaws.bedrockagentruntime#RetrievedReferences" + } + }, + "traits": { + "smithy.api#documentation": "Input to lambda used in action group" + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseQuery": { + "type": "structure", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Knowledge base input query in text", + "smithy.api#length": { + "max": 1000 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Knowledge base input query.", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalConfiguration": { + "type": "structure", + "members": { + "vectorSearchConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseVectorSearchConfiguration", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Search parameters for retrieving from knowledge base." + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalResult": { + "type": "structure", + "members": { + "content": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultContent", + "traits": { + "smithy.api#required": {} + } + }, + "location": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultLocation" + }, + "score": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The relevance score of a result." + } + } + }, + "traits": { + "smithy.api#documentation": "Result item returned from a knowledge base retrieval." + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalResults": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalResult" + }, + "traits": { + "smithy.api#documentation": "List of knowledge base retrieval results", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrieveAndGenerateConfiguration": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseId", + "traits": { + "smithy.api#required": {} + } + }, + "modelArn": { + "target": "com.amazonaws.bedrockagentruntime#BedrockModelArn", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configurations for retrieval and generation for knowledge base." + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseVectorSearchConfiguration": { + "type": "structure", + "members": { + "numberOfResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Top-K results to retrieve from knowledge base.", + "smithy.api#range": { + "min": 1, + "max": 10 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Knowledge base vector search configuration" + } + }, + "com.amazonaws.bedrockagentruntime#LambdaArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "ARN of a Lambda." + } + }, + "com.amazonaws.bedrockagentruntime#MaximumLength": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Maximum length of output", + "smithy.api#range": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.bedrockagentruntime#MimeType": { + "type": "string", + "traits": { + "smithy.api#documentation": "Content type of the request" + } + }, + "com.amazonaws.bedrockagentruntime#ModelInvocationInput": { + "type": "structure", + "members": { + "traceId": { + "target": "com.amazonaws.bedrockagentruntime#TraceId" + }, + "text": { + "target": "com.amazonaws.bedrockagentruntime#PromptText" + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#PromptType" + }, + "inferenceConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#InferenceConfiguration" + }, + "overrideLambda": { + "target": "com.amazonaws.bedrockagentruntime#LambdaArn" + }, + "promptCreationMode": { + "target": "com.amazonaws.bedrockagentruntime#CreationMode" + }, + "parserMode": { + "target": "com.amazonaws.bedrockagentruntime#CreationMode" + } + }, + "traits": { + "smithy.api#documentation": "Trace Part which contains information used to call Invoke Model", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#NextToken": { + "type": "string", + "traits": { + "smithy.api#documentation": "Opaque continuation token of previous paginated response.", + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\S*$" + } + }, + "com.amazonaws.bedrockagentruntime#NonBlankString": { + "type": "string", + "traits": { + "smithy.api#documentation": "Non Blank String", + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.bedrockagentruntime#Observation": { + "type": "structure", + "members": { + "traceId": { + "target": "com.amazonaws.bedrockagentruntime#TraceId" + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#Type" + }, + "actionGroupInvocationOutput": { + "target": "com.amazonaws.bedrockagentruntime#ActionGroupInvocationOutput" + }, + "knowledgeBaseLookupOutput": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupOutput" + }, + "finalResponse": { + "target": "com.amazonaws.bedrockagentruntime#FinalResponse" + }, + "repromptResponse": { + "target": "com.amazonaws.bedrockagentruntime#RepromptResponse" + } + }, + "traits": { + "smithy.api#documentation": "Trace Part which contains output details for action group or knowledge base or final response", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#OrchestrationTrace": { + "type": "union", + "members": { + "rationale": { + "target": "com.amazonaws.bedrockagentruntime#Rationale" + }, + "invocationInput": { + "target": "com.amazonaws.bedrockagentruntime#InvocationInput" + }, + "observation": { + "target": "com.amazonaws.bedrockagentruntime#Observation" + }, + "modelInvocationInput": { + "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput" + } + }, + "traits": { + "smithy.api#documentation": "Trace contains intermidate response during orchestration", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#OutputString": { + "type": "string", + "traits": { + "smithy.api#documentation": "Agent Trace Output String", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#Parameter": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Name of parameter" + } + }, + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Type of parameter" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Value of parameter" + } + } + }, + "traits": { + "smithy.api#documentation": "parameters included in action group invocation" + } + }, + "com.amazonaws.bedrockagentruntime#Parameters": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#Parameter" + }, + "traits": { + "smithy.api#documentation": "list of parameters included in action group invocation" + } + }, + "com.amazonaws.bedrockagentruntime#PartBody": { + "type": "blob", + "traits": { + "smithy.api#documentation": "PartBody of the payload in bytes", + "smithy.api#length": { + "max": 1000000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#PayloadPart": { + "type": "structure", + "members": { + "bytes": { + "target": "com.amazonaws.bedrockagentruntime#PartBody" + }, + "attribution": { + "target": "com.amazonaws.bedrockagentruntime#Attribution" + } + }, + "traits": { + "smithy.api#documentation": "Base 64 endoded byte response", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#PostProcessingModelInvocationOutput": { + "type": "structure", + "members": { + "traceId": { + "target": "com.amazonaws.bedrockagentruntime#TraceId" + }, + "parsedResponse": { + "target": "com.amazonaws.bedrockagentruntime#PostProcessingParsedResponse" + } + }, + "traits": { + "smithy.api#documentation": "Trace Part which contains information related to postprocessing", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#PostProcessingParsedResponse": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.bedrockagentruntime#OutputString" + } + }, + "traits": { + "smithy.api#documentation": "Trace Part which contains information if preprocessing was successful", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#PostProcessingTrace": { + "type": "union", + "members": { + "modelInvocationInput": { + "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput" + }, + "modelInvocationOutput": { + "target": "com.amazonaws.bedrockagentruntime#PostProcessingModelInvocationOutput" + } + }, + "traits": { + "smithy.api#documentation": "Trace Part which contains information related to post processing step", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#PreProcessingModelInvocationOutput": { + "type": "structure", + "members": { + "traceId": { + "target": "com.amazonaws.bedrockagentruntime#TraceId" + }, + "parsedResponse": { + "target": "com.amazonaws.bedrockagentruntime#PreProcessingParsedResponse" + } + }, + "traits": { + "smithy.api#documentation": "Trace Part which contains information related to preprocessing", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#PreProcessingParsedResponse": { + "type": "structure", + "members": { + "rationale": { + "target": "com.amazonaws.bedrockagentruntime#RationaleString" + }, + "isValid": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Boolean value" + } + } + }, + "traits": { + "smithy.api#documentation": "Trace Part which contains information if preprocessing was successful", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#PreProcessingTrace": { + "type": "union", + "members": { + "modelInvocationInput": { + "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput" + }, + "modelInvocationOutput": { + "target": "com.amazonaws.bedrockagentruntime#PreProcessingModelInvocationOutput" + } + }, + "traits": { + "smithy.api#documentation": "Trace Part which contains information related to preprocessing step", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#PromptSessionAttributesMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#documentation": "Session attributes that go to the prompt" + } + }, + "com.amazonaws.bedrockagentruntime#PromptText": { + "type": "string", + "traits": { + "smithy.api#documentation": "Prompt Message", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#PromptType": { + "type": "enum", + "members": { + "PRE_PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRE_PROCESSING" + } + }, + "ORCHESTRATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORCHESTRATION" + } + }, + "KNOWLEDGE_BASE_RESPONSE_GENERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KNOWLEDGE_BASE_RESPONSE_GENERATION" + } + }, + "POST_PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POST_PROCESSING" + } + } + }, + "traits": { + "smithy.api#documentation": "types of prompts" + } + }, + "com.amazonaws.bedrockagentruntime#Rationale": { + "type": "structure", + "members": { + "traceId": { + "target": "com.amazonaws.bedrockagentruntime#TraceId" + }, + "text": { + "target": "com.amazonaws.bedrockagentruntime#RationaleString" + } + }, + "traits": { + "smithy.api#documentation": "Trace Part which contains information related to reasoning", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#RationaleString": { + "type": "string", + "traits": { + "smithy.api#documentation": "Agent Trace Rationale String", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#RepromptResponse": { + "type": "structure", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Reprompt response text" + } + }, + "source": { + "target": "com.amazonaws.bedrockagentruntime#Source" + } + }, + "traits": { + "smithy.api#documentation": "Observation information if there were reprompts", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#RequestBody": { + "type": "structure", + "members": { + "content": { + "target": "com.amazonaws.bedrockagentruntime#ContentMap" + } + }, + "traits": { + "smithy.api#documentation": "Request Body Content Map" + } + }, + "com.amazonaws.bedrockagentruntime#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentruntime#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when a resource referenced by the operation does not exist", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.bedrockagentruntime#ResponseStream": { + "type": "union", + "members": { + "chunk": { + "target": "com.amazonaws.bedrockagentruntime#PayloadPart" + }, + "trace": { + "target": "com.amazonaws.bedrockagentruntime#TracePart" + }, + "internalServerException": { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + "validationException": { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + }, + "resourceNotFoundException": { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + "serviceQuotaExceededException": { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + }, + "throttlingException": { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + "accessDeniedException": { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + "conflictException": { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + "dependencyFailedException": { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + }, + "badGatewayException": { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + } + }, + "traits": { + "smithy.api#documentation": "Response body of is a stream", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.bedrockagentruntime#RetrievalResultContent": { + "type": "structure", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Content of a retrieval result in text", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Content of a retrieval result." + } + }, + "com.amazonaws.bedrockagentruntime#RetrievalResultLocation": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultLocationType", + "traits": { + "smithy.api#required": {} + } + }, + "s3Location": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultS3Location" + } + }, + "traits": { + "smithy.api#documentation": "The source location of a retrieval result." + } + }, + "com.amazonaws.bedrockagentruntime#RetrievalResultLocationType": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + } + }, + "traits": { + "smithy.api#documentation": "The location type of a retrieval result." + } + }, + "com.amazonaws.bedrockagentruntime#RetrievalResultS3Location": { + "type": "structure", + "members": { + "uri": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "URI of S3 location" + } + } + }, + "traits": { + "smithy.api#documentation": "The S3 location of a retrieval result." + } + }, + "com.amazonaws.bedrockagentruntime#Retrieve": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#RetrieveRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#RetrieveResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieve from knowledge base.", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/knowledgebases/{knowledgeBaseId}/retrieve" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "retrievalResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentruntime#RetrieveAndGenerate": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "RetrieveAndGenerate API", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/retrieveAndGenerate" + } + } + }, + "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateType", + "traits": { + "smithy.api#required": {} + } + }, + "knowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrieveAndGenerateConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Configures the retrieval and generation for the session." + } + }, + "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateInput": { + "type": "structure", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Customer input of the turn in text", + "smithy.api#length": { + "max": 1000 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Customer input of the turn", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateOutput": { + "type": "structure", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Service response of the turn in text", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Service response of the turn", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateRequest": { + "type": "structure", + "members": { + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#SessionId" + }, + "input": { + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateInput", + "traits": { + "smithy.api#required": {} + } + }, + "retrieveAndGenerateConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateConfiguration" + }, + "sessionConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateSessionConfiguration" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerate" + } + ] + }, + "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateResponse": { + "type": "structure", + "members": { + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#SessionId", + "traits": { + "smithy.api#required": {} + } + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateOutput", + "traits": { + "smithy.api#required": {} + } + }, + "citations": { + "target": "com.amazonaws.bedrockagentruntime#Citations" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateSessionConfiguration": { + "type": "structure", + "members": { + "kmsKeyArn": { + "target": "com.amazonaws.bedrockagentruntime#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The KMS key arn to encrypt the customer data of the session.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configures common parameters of the session." + } + }, + "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateType": { + "type": "enum", + "members": { + "KNOWLEDGE_BASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KNOWLEDGE_BASE" + } + } + }, + "traits": { + "smithy.api#documentation": "The type of RetrieveAndGenerate." + } + }, + "com.amazonaws.bedrockagentruntime#RetrieveRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "retrievalQuery": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseQuery", + "traits": { + "smithy.api#required": {} + } + }, + "retrievalConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalConfiguration" + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#RetrieveResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentruntime#Retrieve" + } + ] + }, + "com.amazonaws.bedrockagentruntime#RetrieveResponse": { + "type": "structure", + "members": { + "retrievalResults": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalResults", + "traits": { + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#RetrievedReference": { + "type": "structure", + "members": { + "content": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultContent" + }, + "location": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultLocation" + } + }, + "traits": { + "smithy.api#documentation": "Retrieved reference" + } + }, + "com.amazonaws.bedrockagentruntime#RetrievedReferences": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#RetrievedReference" + }, + "traits": { + "smithy.api#documentation": "list of retrieved references" + } + }, + "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentruntime#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when a request is made beyond the service quota", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrockagentruntime#SessionAttributesMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#documentation": "Session attributes are pass through attributes passed to the action group" + } + }, + "com.amazonaws.bedrockagentruntime#SessionId": { + "type": "string", + "traits": { + "smithy.api#documentation": "Identifier of the session.", + "smithy.api#length": { + "min": 2, + "max": 100 + }, + "smithy.api#pattern": "^[0-9a-zA-Z._:-]+$" + } + }, + "com.amazonaws.bedrockagentruntime#SessionState": { + "type": "structure", + "members": { + "sessionAttributes": { + "target": "com.amazonaws.bedrockagentruntime#SessionAttributesMap", + "traits": { + "smithy.api#documentation": "Session Attributes" + } + }, + "promptSessionAttributes": { + "target": "com.amazonaws.bedrockagentruntime#PromptSessionAttributesMap", + "traits": { + "smithy.api#documentation": "Prompt Session Attributes" + } + } + }, + "traits": { + "smithy.api#documentation": "Session state provided" + } + }, + "com.amazonaws.bedrockagentruntime#Source": { + "type": "enum", + "members": { + "ACTION_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTION_GROUP" + } + }, + "KNOWLEDGE_BASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KNOWLEDGE_BASE" + } + }, + "PARSER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARSER" + } + } + }, + "traits": { + "smithy.api#documentation": "Parsing error source", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#Span": { + "type": "structure", + "members": { + "start": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Start of span", + "smithy.api#range": { + "min": 0 + } + } + }, + "end": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "End of span", + "smithy.api#range": { + "min": 0 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Span of text" + } + }, + "com.amazonaws.bedrockagentruntime#StopSequences": { + "type": "list", + "member": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#documentation": "List of stop sequences", + "smithy.api#length": { + "min": 0, + "max": 4 + } + } + }, + "com.amazonaws.bedrockagentruntime#Temperature": { + "type": "float", + "traits": { + "smithy.api#documentation": "Controls randomness, higher values increase diversity", + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagentruntime#TextResponsePart": { + "type": "structure", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Response part in text" + } + }, + "span": { + "target": "com.amazonaws.bedrockagentruntime#Span" + } + }, + "traits": { + "smithy.api#documentation": "Text response part" + } + }, + "com.amazonaws.bedrockagentruntime#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentruntime#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when the number of requests exceeds the limit", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.bedrockagentruntime#TopK": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Sample from the k most likely next tokens", + "smithy.api#range": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.bedrockagentruntime#TopP": { + "type": "float", + "traits": { + "smithy.api#documentation": "Cumulative probability cutoff for token selection", + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagentruntime#Trace": { + "type": "union", + "members": { + "preProcessingTrace": { + "target": "com.amazonaws.bedrockagentruntime#PreProcessingTrace" + }, + "orchestrationTrace": { + "target": "com.amazonaws.bedrockagentruntime#OrchestrationTrace" + }, + "postProcessingTrace": { + "target": "com.amazonaws.bedrockagentruntime#PostProcessingTrace" + }, + "failureTrace": { + "target": "com.amazonaws.bedrockagentruntime#FailureTrace" + } + }, + "traits": { + "smithy.api#documentation": "Trace contains intermidate response for customer", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#TraceId": { + "type": "string", + "traits": { + "smithy.api#documentation": "Identifier for trace", + "smithy.api#length": { + "min": 2, + "max": 16 + } + } + }, + "com.amazonaws.bedrockagentruntime#TraceKnowledgeBaseId": { + "type": "string", + "traits": { + "smithy.api#documentation": "Agent Trace Action Group Knowledge Base Id", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#TracePart": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagentruntime#AgentId" + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagentruntime#AgentAliasId" + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#SessionId" + }, + "trace": { + "target": "com.amazonaws.bedrockagentruntime#Trace" + } + }, + "traits": { + "smithy.api#documentation": "Trace Part which contains intermidate response for customer", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#Type": { + "type": "enum", + "members": { + "ACTION_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTION_GROUP" + } + }, + "KNOWLEDGE_BASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KNOWLEDGE_BASE" + } + }, + "FINISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FINISH" + } + }, + "ASK_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASK_USER" + } + }, + "REPROMPT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPROMPT" + } + } + }, + "traits": { + "smithy.api#documentation": "types of observations" + } + }, + "com.amazonaws.bedrockagentruntime#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentruntime#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when the request's input validation fails", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrockagentruntime#Verb": { + "type": "string", + "traits": { + "smithy.api#documentation": "Agent Trace Action Group Action verb", + "smithy.api#sensitive": {} + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/bedrock-agent.json b/codegen/sdk-codegen/aws-models/bedrock-agent.json new file mode 100644 index 00000000000..497062a202a --- /dev/null +++ b/codegen/sdk-codegen/aws-models/bedrock-agent.json @@ -0,0 +1,7036 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.bedrockagent#APISchema": { + "type": "union", + "members": { + "s3": { + "target": "com.amazonaws.bedrockagent#S3Identifier" + }, + "payload": { + "target": "com.amazonaws.bedrockagent#Payload" + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the API Schema for the Action Group" + } + }, + "com.amazonaws.bedrockagent#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when a request is denied per access permissions", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.bedrockagent#ActionGroupExecutor": { + "type": "union", + "members": { + "lambda": { + "target": "com.amazonaws.bedrockagent#LambdaArn" + } + }, + "traits": { + "smithy.api#documentation": "Type of Executors for an Action Group" + } + }, + "com.amazonaws.bedrockagent#ActionGroupResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#CreateAgentActionGroup" + }, + { + "target": "com.amazonaws.bedrockagent#DeleteAgentActionGroup" + }, + { + "target": "com.amazonaws.bedrockagent#GetAgentActionGroup" + }, + { + "target": "com.amazonaws.bedrockagent#ListAgentActionGroups" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateAgentActionGroup" + } + ] + }, + "com.amazonaws.bedrockagent#ActionGroupSignature": { + "type": "enum", + "members": { + "AMAZON_USERINPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON.UserInput" + } + } + }, + "traits": { + "smithy.api#documentation": "Action Group Signature for a BuiltIn Action" + } + }, + "com.amazonaws.bedrockagent#ActionGroupState": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "State of the action group" + } + }, + "com.amazonaws.bedrockagent#ActionGroupSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#ActionGroupSummary" + }, + "traits": { + "smithy.api#documentation": "List of ActionGroup Summaries", + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#ActionGroupSummary": { + "type": "structure", + "members": { + "actionGroupId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "actionGroupName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#required": {} + } + }, + "actionGroupState": { + "target": "com.amazonaws.bedrockagent#ActionGroupState", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "ActionGroup Summary" + } + }, + "com.amazonaws.bedrockagent#Agent": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#required": {} + } + }, + "agentArn": { + "target": "com.amazonaws.bedrockagent#AgentArn", + "traits": { + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken" + }, + "instruction": { + "target": "com.amazonaws.bedrockagent#Instruction" + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#required": {} + } + }, + "foundationModel": { + "target": "com.amazonaws.bedrockagent#ModelIdentifier" + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.bedrockagent#SessionTTL", + "traits": { + "smithy.api#required": {} + } + }, + "agentResourceRoleArn": { + "target": "com.amazonaws.bedrockagent#AgentRoleArn", + "traits": { + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn" + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "preparedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp" + }, + "failureReasons": { + "target": "com.amazonaws.bedrockagent#FailureReasons" + }, + "recommendedActions": { + "target": "com.amazonaws.bedrockagent#RecommendedActions" + }, + "promptOverrideConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Contains the information of an agent" + } + }, + "com.amazonaws.bedrockagent#AgentActionGroup": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#required": {} + } + }, + "actionGroupId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "actionGroupName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken" + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "parentActionSignature": { + "target": "com.amazonaws.bedrockagent#ActionGroupSignature" + }, + "actionGroupExecutor": { + "target": "com.amazonaws.bedrockagent#ActionGroupExecutor" + }, + "apiSchema": { + "target": "com.amazonaws.bedrockagent#APISchema" + }, + "actionGroupState": { + "target": "com.amazonaws.bedrockagent#ActionGroupState", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the information of an Agent Action Group" + } + }, + "com.amazonaws.bedrockagent#AgentAlias": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#required": {} + } + }, + "agentAliasName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#required": {} + } + }, + "agentAliasArn": { + "target": "com.amazonaws.bedrockagent#AgentAliasArn", + "traits": { + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken" + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "agentAliasHistoryEvents": { + "target": "com.amazonaws.bedrockagent#AgentAliasHistoryEvents" + }, + "agentAliasStatus": { + "target": "com.amazonaws.bedrockagent#AgentAliasStatus", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the information of an agent alias" + } + }, + "com.amazonaws.bedrockagent#AgentAliasArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "Arn representation of the Agent Alias.", + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagent#AgentAliasHistoryEvent": { + "type": "structure", + "members": { + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration" + }, + "endDate": { + "target": "com.amazonaws.bedrockagent#DateTimestamp" + }, + "startDate": { + "target": "com.amazonaws.bedrockagent#DateTimestamp" + } + }, + "traits": { + "smithy.api#documentation": "History event for an alias for an Agent." + } + }, + "com.amazonaws.bedrockagent#AgentAliasHistoryEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentAliasHistoryEvent" + }, + "traits": { + "smithy.api#documentation": "The list of history events for an alias for an Agent.", + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#AgentAliasId": { + "type": "string", + "traits": { + "smithy.api#documentation": "Id for an Agent Alias generated at the server side.", + "smithy.api#length": { + "min": 10, + "max": 10 + }, + "smithy.api#pattern": "^(\\bTSTALIASID\\b|[0-9a-zA-Z]+)$" + } + }, + "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfigurationListItem" + }, + "traits": { + "smithy.api#documentation": "Routing configuration for an Agent alias.", + "smithy.api#length": { + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#AgentAliasRoutingConfigurationListItem": { + "type": "structure", + "members": { + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the routing configuration for an Agent alias." + } + }, + "com.amazonaws.bedrockagent#AgentAliasStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "PREPARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREPARED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } + }, + "traits": { + "smithy.api#documentation": "The statuses an Agent Alias can be in." + } + }, + "com.amazonaws.bedrockagent#AgentAliasSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentAliasSummary" + }, + "traits": { + "smithy.api#documentation": "The list of summaries of all the aliases for an Agent.", + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#AgentAliasSummary": { + "type": "structure", + "members": { + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#required": {} + } + }, + "agentAliasName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration" + }, + "agentAliasStatus": { + "target": "com.amazonaws.bedrockagent#AgentAliasStatus", + "traits": { + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of an alias for an Agent." + } + }, + "com.amazonaws.bedrockagent#AgentArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "Arn representation of the Agent.", + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagent#AgentKnowledgeBase": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "knowledgeBaseState": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the information of an Agent Knowledge Base." + } + }, + "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummary" + }, + "traits": { + "smithy.api#documentation": "List of Agent Knowledge Base Summaries", + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummary": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "knowledgeBaseState": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", + "traits": { + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Agent Knowledge Base Summary" + } + }, + "com.amazonaws.bedrockagent#AgentResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#CreateAgent" + }, + { + "target": "com.amazonaws.bedrockagent#DeleteAgent" + }, + { + "target": "com.amazonaws.bedrockagent#GetAgent" + }, + { + "target": "com.amazonaws.bedrockagent#ListAgents" + }, + { + "target": "com.amazonaws.bedrockagent#PrepareAgent" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateAgent" + } + ] + }, + "com.amazonaws.bedrockagent#AgentRoleArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "ARN of a IAM role.", + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?AmazonBedrockExecutionRoleForAgents.+$" + } + }, + "com.amazonaws.bedrockagent#AgentStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "PREPARING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREPARING" + } + }, + "PREPARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREPARED" + } + }, + "NOT_PREPARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_PREPARED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "VERSIONING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERSIONING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } + }, + "traits": { + "smithy.api#documentation": "Schema Type for Action APIs." + } + }, + "com.amazonaws.bedrockagent#AgentSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentSummary" + }, + "traits": { + "smithy.api#documentation": "List of AgentSummary.", + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#AgentSummary": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#required": {} + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "latestAgentVersion": { + "target": "com.amazonaws.bedrockagent#Version" + } + }, + "traits": { + "smithy.api#documentation": "Summary of Agent." + } + }, + "com.amazonaws.bedrockagent#AgentVersion": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#required": {} + } + }, + "agentArn": { + "target": "com.amazonaws.bedrockagent#AgentArn", + "traits": { + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#required": {} + } + }, + "instruction": { + "target": "com.amazonaws.bedrockagent#Instruction" + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#required": {} + } + }, + "foundationModel": { + "target": "com.amazonaws.bedrockagent#ModelIdentifier" + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.bedrockagent#SessionTTL", + "traits": { + "smithy.api#required": {} + } + }, + "agentResourceRoleArn": { + "target": "com.amazonaws.bedrockagent#AgentRoleArn", + "traits": { + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn" + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "failureReasons": { + "target": "com.amazonaws.bedrockagent#FailureReasons" + }, + "recommendedActions": { + "target": "com.amazonaws.bedrockagent#RecommendedActions" + }, + "promptOverrideConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Contains the information of an agent version." + } + }, + "com.amazonaws.bedrockagent#AgentVersionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentVersionSummary" + }, + "traits": { + "smithy.api#documentation": "List of AgentVersionSummary.", + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#AgentVersionSummary": { + "type": "structure", + "members": { + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#required": {} + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + } + }, + "traits": { + "smithy.api#documentation": "Summary of agent version." + } + }, + "com.amazonaws.bedrockagent#AliasResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#CreateAgentAlias" + }, + { + "target": "com.amazonaws.bedrockagent#DeleteAgentAlias" + }, + { + "target": "com.amazonaws.bedrockagent#GetAgentAlias" + }, + { + "target": "com.amazonaws.bedrockagent#ListAgentAliases" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateAgentAlias" + } + ] + }, + "com.amazonaws.bedrockagent#AmazonBedrockAgentBuildTimeLambda": { + "type": "service", + "version": "2023-06-05", + "resources": [ + { + "target": "com.amazonaws.bedrockagent#ActionGroupResource" + }, + { + "target": "com.amazonaws.bedrockagent#AgentResource" + }, + { + "target": "com.amazonaws.bedrockagent#AliasResource" + }, + { + "target": "com.amazonaws.bedrockagent#DataSourceResource" + }, + { + "target": "com.amazonaws.bedrockagent#IngestionJobResource" + }, + { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseResource" + }, + { + "target": "com.amazonaws.bedrockagent#TaggingResource" + }, + { + "target": "com.amazonaws.bedrockagent#VersionResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Bedrock Agent", + "arnNamespace": "bedrock", + "endpointPrefix": "bedrock-agent", + "cloudTrailEventSource": "bedrock.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "bedrock" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*", + "content-type", + "x-amz-content-sha256", + "x-amz-user-agent", + "x-amzn-platform-id", + "x-amzn-trace-id" + ], + "additionalExposedHeaders": [ + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-trace-id" + ], + "maxAge": 86400 + }, + "smithy.api#documentation": "An example service, deployed with the Octane Service creator,\nwhich will echo the string", + "smithy.api#title": "Agents for Amazon Bedrock", + "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": [], + "rules": [ + { + "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" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-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://bedrock-agent-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://bedrock-agent.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Associate a Knowledge Base to an existing Amazon Bedrock Agent", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBaseRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "Draft Version of the Agent.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#required": {} + } + }, + "knowledgeBaseState": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseState" + } + }, + "traits": { + "smithy.api#documentation": "Associate Agent Knowledge Base Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBaseResponse": { + "type": "structure", + "members": { + "agentKnowledgeBase": { + "target": "com.amazonaws.bedrockagent#AgentKnowledgeBase", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Associate Agent Knowledge Base Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#BasePromptTemplate": { + "type": "string", + "traits": { + "smithy.api#documentation": "Base Prompt Template.", + "smithy.api#length": { + "min": 1, + "max": 100000 + } + } + }, + "com.amazonaws.bedrockagent#BedrockEmbeddingModelArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "Arn of a Bedrock model.", + "smithy.api#length": { + "min": 20, + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))$" + } + }, + "com.amazonaws.bedrockagent#ChunkingConfiguration": { + "type": "structure", + "members": { + "chunkingStrategy": { + "target": "com.amazonaws.bedrockagent#ChunkingStrategy", + "traits": { + "smithy.api#required": {} + } + }, + "fixedSizeChunkingConfiguration": { + "target": "com.amazonaws.bedrockagent#FixedSizeChunkingConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Configures chunking strategy" + } + }, + "com.amazonaws.bedrockagent#ChunkingStrategy": { + "type": "enum", + "members": { + "FIXED_SIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIXED_SIZE" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + }, + "traits": { + "smithy.api#documentation": "The type of chunking strategy" + } + }, + "com.amazonaws.bedrockagent#ClientToken": { + "type": "string", + "traits": { + "smithy.api#documentation": "Client specified token used for idempotency checks", + "smithy.api#length": { + "min": 33, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.bedrockagent#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when there is a conflict performing an operation", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.bedrockagent#CreateAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateAgentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Amazon Bedrock Agent", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/agents/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#CreateAgentActionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateAgentActionGroupRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateAgentActionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Action Group for existing Amazon Bedrock Agent", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#CreateAgentActionGroupRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "Draft Version of the Agent.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actionGroupName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#idempotencyToken": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "parentActionGroupSignature": { + "target": "com.amazonaws.bedrockagent#ActionGroupSignature" + }, + "actionGroupExecutor": { + "target": "com.amazonaws.bedrockagent#ActionGroupExecutor" + }, + "apiSchema": { + "target": "com.amazonaws.bedrockagent#APISchema" + }, + "actionGroupState": { + "target": "com.amazonaws.bedrockagent#ActionGroupState" + } + }, + "traits": { + "smithy.api#documentation": "Create Action Group Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateAgentActionGroupResponse": { + "type": "structure", + "members": { + "agentActionGroup": { + "target": "com.amazonaws.bedrockagent#AgentActionGroup", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Create Action Group Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateAgentAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateAgentAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateAgentAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Alias for an existing Amazon Bedrock Agent", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/agents/{agentId}/agentaliases/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#CreateAgentAliasRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#idempotencyToken": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration" + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap" + } + }, + "traits": { + "smithy.api#documentation": "Create Agent Alias Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateAgentAliasResponse": { + "type": "structure", + "members": { + "agentAlias": { + "target": "com.amazonaws.bedrockagent#AgentAlias", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Create Agent Alias Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateAgentRequest": { + "type": "structure", + "members": { + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#idempotencyToken": {} + } + }, + "instruction": { + "target": "com.amazonaws.bedrockagent#Instruction" + }, + "foundationModel": { + "target": "com.amazonaws.bedrockagent#ModelIdentifier" + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.bedrockagent#SessionTTL" + }, + "agentResourceRoleArn": { + "target": "com.amazonaws.bedrockagent#AgentRoleArn", + "traits": { + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn" + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap" + }, + "promptOverrideConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Create Agent Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateAgentResponse": { + "type": "structure", + "members": { + "agent": { + "target": "com.amazonaws.bedrockagent#Agent", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Create Agent Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Create a new data source", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#CreateDataSourceRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#idempotencyToken": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "dataSourceConfiguration": { + "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "serverSideEncryptionConfiguration": { + "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration" + }, + "vectorIngestionConfiguration": { + "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateDataSourceResponse": { + "type": "structure", + "members": { + "dataSource": { + "target": "com.amazonaws.bedrockagent#DataSource", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Create a new knowledge base", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/knowledgebases/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#CreateKnowledgeBaseRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#idempotencyToken": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "roleArn": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", + "traits": { + "smithy.api#required": {} + } + }, + "knowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "storageConfiguration": { + "target": "com.amazonaws.bedrockagent#StorageConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateKnowledgeBaseResponse": { + "type": "structure", + "members": { + "knowledgeBase": { + "target": "com.amazonaws.bedrockagent#KnowledgeBase", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreationMode": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + }, + "OVERRIDDEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERRIDDEN" + } + } + }, + "traits": { + "smithy.api#documentation": "Creation Mode for Prompt Configuration." + } + }, + "com.amazonaws.bedrockagent#DataSource": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#DataSourceStatus", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "dataSourceConfiguration": { + "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "serverSideEncryptionConfiguration": { + "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration" + }, + "vectorIngestionConfiguration": { + "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration" + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the information of a data source." + } + }, + "com.amazonaws.bedrockagent#DataSourceConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#DataSourceType", + "traits": { + "smithy.api#required": {} + } + }, + "s3Configuration": { + "target": "com.amazonaws.bedrockagent#S3DataSourceConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Specifies a raw data source location to ingest." + } + }, + "com.amazonaws.bedrockagent#DataSourceResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#CreateDataSource" + }, + { + "target": "com.amazonaws.bedrockagent#DeleteDataSource" + }, + { + "target": "com.amazonaws.bedrockagent#GetDataSource" + }, + { + "target": "com.amazonaws.bedrockagent#ListDataSources" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateDataSource" + } + ] + }, + "com.amazonaws.bedrockagent#DataSourceStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } + }, + "traits": { + "smithy.api#documentation": "The status of a data source." + } + }, + "com.amazonaws.bedrockagent#DataSourceSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#DataSourceSummary" + }, + "traits": { + "smithy.api#documentation": "list of data source summaries" + } + }, + "com.amazonaws.bedrockagent#DataSourceSummary": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#DataSourceStatus", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information of a data source." + } + }, + "com.amazonaws.bedrockagent#DataSourceType": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + } + }, + "traits": { + "smithy.api#documentation": "The type of the data source location." + } + }, + "com.amazonaws.bedrockagent#DateTimestamp": { + "type": "timestamp", + "traits": { + "smithy.api#documentation": "Time Stamp.", + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.bedrockagent#DeleteAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteAgentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an Agent for existing Amazon Bedrock Agent", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/agents/{agentId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteAgentActionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteAgentActionGroupRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteAgentActionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an Action Group for existing Amazon Bedrock Agent.", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteAgentActionGroupRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "Draft Version of the Agent.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actionGroupId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent ActionGroup is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "skipResourceInUseCheck": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Skips checking if resource is in use when set to true. Defaults to false", + "smithy.api#httpQuery": "skipResourceInUseCheck" + } + } + }, + "traits": { + "smithy.api#documentation": "Delete Action Group Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeleteAgentActionGroupResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Delete Action Group Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteAgentAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteAgentAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteAgentAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an Alias for a Amazon Bedrock Agent", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteAgentAliasRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent Alias is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Delete Agent Alias Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeleteAgentAliasResponse": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#required": {} + } + }, + "agentAliasStatus": { + "target": "com.amazonaws.bedrockagent#AgentAliasStatus", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Delete Agent Alias Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteAgentRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "skipResourceInUseCheck": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Skips checking if resource is in use when set to true. Defaults to false", + "smithy.api#httpQuery": "skipResourceInUseCheck" + } + } + }, + "traits": { + "smithy.api#documentation": "Delete Agent Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeleteAgentResponse": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Delete Agent Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteAgentVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteAgentVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteAgentVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an Agent version for existing Amazon Bedrock Agent", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteAgentVersionRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "skipResourceInUseCheck": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Skips checking if resource is in use when set to true. Defaults to false", + "smithy.api#httpQuery": "skipResourceInUseCheck" + } + } + }, + "traits": { + "smithy.api#documentation": "Delete Agent Version Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeleteAgentVersionResponse": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#required": {} + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Delete Agent Version Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Delete an existing data source", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteDataSourceRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeleteDataSourceResponse": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#DataSourceStatus", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Delete an existing knowledge base", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/knowledgebases/{knowledgeBaseId}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteKnowledgeBaseRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeleteKnowledgeBaseResponse": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#Description": { + "type": "string", + "traits": { + "smithy.api#documentation": "Description of the Resource.", + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociate an existing Knowledge Base from an Amazon Bedrock Agent", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "Draft Version of the Agent.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when a Knowledge Base is associated to an Agent", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Disassociate Agent Knowledge Base Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Disassociate Agent Knowledge Base Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DraftVersion": { + "type": "string", + "traits": { + "smithy.api#documentation": "Draft Agent Version.", + "smithy.api#length": { + "min": 5, + "max": 5 + }, + "smithy.api#pattern": "^DRAFT$" + } + }, + "com.amazonaws.bedrockagent#FailureReason": { + "type": "string", + "traits": { + "smithy.api#documentation": "Failure Reason for Error.", + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagent#FailureReasons": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FailureReason" + }, + "traits": { + "smithy.api#documentation": "Failure Reasons for Error.", + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagent#FieldName": { + "type": "string", + "traits": { + "smithy.api#documentation": "Name of the field", + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#FixedSizeChunkingConfiguration": { + "type": "structure", + "members": { + "maxTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of tokens per chunk.", + "smithy.api#range": { + "min": 1 + }, + "smithy.api#required": {} + } + }, + "overlapPercentage": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The overlap percentage between adjacent chunks.", + "smithy.api#range": { + "min": 1, + "max": 99 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configures fixed size chunking strategy" + } + }, + "com.amazonaws.bedrockagent#GetAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetAgentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an Agent for existing Amazon Bedrock Agent", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetAgentActionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetAgentActionGroupRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetAgentActionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an Action Group for existing Amazon Bedrock Agent Version", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetAgentActionGroupRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "Version number generated when a version is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actionGroupId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent Action Group is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Get Action Group Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentActionGroupResponse": { + "type": "structure", + "members": { + "agentActionGroup": { + "target": "com.amazonaws.bedrockagent#AgentActionGroup", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Get Action Group Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetAgentAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetAgentAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Describes an Alias for a Amazon Bedrock Agent", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetAgentAliasRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent Alias is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Get Agent Alias Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentAliasResponse": { + "type": "structure", + "members": { + "agentAlias": { + "target": "com.amazonaws.bedrockagent#AgentAlias", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Get Agent Alias Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a knowledge base associated to an existing Amazon Bedrock Agent Version", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "Version number generated when a version is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when a Knowledge Base is associated", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Get Agent Knowledge Base Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseResponse": { + "type": "structure", + "members": { + "agentKnowledgeBase": { + "target": "com.amazonaws.bedrockagent#AgentKnowledgeBase", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Get Agent Knowledge Base Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Get Agent Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentResponse": { + "type": "structure", + "members": { + "agent": { + "target": "com.amazonaws.bedrockagent#Agent", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Get Agent Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetAgentVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetAgentVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an Agent version for existing Amazon Bedrock Agent", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetAgentVersionRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Get Agent Version Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentVersionResponse": { + "type": "structure", + "members": { + "agentVersion": { + "target": "com.amazonaws.bedrockagent#AgentVersion", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Get Agent Version Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get an existing data source", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetDataSourceRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetDataSourceResponse": { + "type": "structure", + "members": { + "dataSource": { + "target": "com.amazonaws.bedrockagent#DataSource", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetIngestionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetIngestionJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetIngestionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get an ingestion job", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/{ingestionJobId}" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetIngestionJobRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ingestionJobId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetIngestionJobResponse": { + "type": "structure", + "members": { + "ingestionJob": { + "target": "com.amazonaws.bedrockagent#IngestionJob", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get an existing knowledge base", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/knowledgebases/{knowledgeBaseId}" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetKnowledgeBaseRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetKnowledgeBaseResponse": { + "type": "structure", + "members": { + "knowledgeBase": { + "target": "com.amazonaws.bedrockagent#KnowledgeBase", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#Id": { + "type": "string", + "traits": { + "smithy.api#documentation": "Identifier for a resource.", + "smithy.api#pattern": "^[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagent#InferenceConfiguration": { + "type": "structure", + "members": { + "temperature": { + "target": "com.amazonaws.bedrockagent#Temperature" + }, + "topP": { + "target": "com.amazonaws.bedrockagent#TopP" + }, + "topK": { + "target": "com.amazonaws.bedrockagent#TopK" + }, + "maximumLength": { + "target": "com.amazonaws.bedrockagent#MaximumLength" + }, + "stopSequences": { + "target": "com.amazonaws.bedrockagent#StopSequences" + } + }, + "traits": { + "smithy.api#documentation": "Configuration for inference in prompt configuration" + } + }, + "com.amazonaws.bedrockagent#IngestionJob": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "ingestionJobId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "status": { + "target": "com.amazonaws.bedrockagent#IngestionJobStatus", + "traits": { + "smithy.api#required": {} + } + }, + "statistics": { + "target": "com.amazonaws.bedrockagent#IngestionJobStatistics" + }, + "failureReasons": { + "target": "com.amazonaws.bedrockagent#FailureReasons" + }, + "startedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the information of an ingestion job." + } + }, + "com.amazonaws.bedrockagent#IngestionJobFilter": { + "type": "structure", + "members": { + "attribute": { + "target": "com.amazonaws.bedrockagent#IngestionJobFilterAttribute", + "traits": { + "smithy.api#required": {} + } + }, + "operator": { + "target": "com.amazonaws.bedrockagent#IngestionJobFilterOperator", + "traits": { + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.bedrockagent#IngestionJobFilterValues", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Filters the response returned by ListIngestionJobs operation." + } + }, + "com.amazonaws.bedrockagent#IngestionJobFilterAttribute": { + "type": "enum", + "members": { + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATUS" + } + } + }, + "traits": { + "smithy.api#documentation": "The name of the field to filter ingestion jobs." + } + }, + "com.amazonaws.bedrockagent#IngestionJobFilterOperator": { + "type": "enum", + "members": { + "EQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQ" + } + } + }, + "traits": { + "smithy.api#documentation": "The operator used to filter ingestion jobs." + } + }, + "com.amazonaws.bedrockagent#IngestionJobFilterValue": { + "type": "string", + "traits": { + "smithy.api#documentation": "The value used to filter ingestion jobs.", + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#IngestionJobFilterValues": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#IngestionJobFilterValue" + }, + "traits": { + "smithy.api#documentation": "The list of values used to filter ingestion jobs.", + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#IngestionJobFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#IngestionJobFilter" + }, + "traits": { + "smithy.api#documentation": "List of IngestionJobFilters", + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#IngestionJobResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#GetIngestionJob" + }, + { + "target": "com.amazonaws.bedrockagent#ListIngestionJobs" + }, + { + "target": "com.amazonaws.bedrockagent#StartIngestionJob" + } + ] + }, + "com.amazonaws.bedrockagent#IngestionJobSortBy": { + "type": "structure", + "members": { + "attribute": { + "target": "com.amazonaws.bedrockagent#IngestionJobSortByAttribute", + "traits": { + "smithy.api#required": {} + } + }, + "order": { + "target": "com.amazonaws.bedrockagent#SortOrder", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Sorts the response returned by ListIngestionJobs operation." + } + }, + "com.amazonaws.bedrockagent#IngestionJobSortByAttribute": { + "type": "enum", + "members": { + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATUS" + } + }, + "STARTED_AT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTED_AT" + } + } + }, + "traits": { + "smithy.api#documentation": "The name of the field to sort ingestion jobs." + } + }, + "com.amazonaws.bedrockagent#IngestionJobStatistics": { + "type": "structure", + "members": { + "numberOfDocumentsScanned": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Number of scanned documents" + } + }, + "numberOfNewDocumentsIndexed": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Number of indexed documents" + } + }, + "numberOfModifiedDocumentsIndexed": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Number of modified documents indexed" + } + }, + "numberOfDocumentsDeleted": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Number of deleted documents" + } + }, + "numberOfDocumentsFailed": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Number of failed documents" + } + } + }, + "traits": { + "smithy.api#documentation": "The document level statistics of an ingestion job" + } + }, + "com.amazonaws.bedrockagent#IngestionJobStatus": { + "type": "enum", + "members": { + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + }, + "traits": { + "smithy.api#documentation": "The status of an ingestion job." + } + }, + "com.amazonaws.bedrockagent#IngestionJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#IngestionJobSummary" + }, + "traits": { + "smithy.api#documentation": "List of IngestionJobSummaries" + } + }, + "com.amazonaws.bedrockagent#IngestionJobSummary": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "ingestionJobId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "status": { + "target": "com.amazonaws.bedrockagent#IngestionJobStatus", + "traits": { + "smithy.api#required": {} + } + }, + "startedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "statistics": { + "target": "com.amazonaws.bedrockagent#IngestionJobStatistics" + } + }, + "traits": { + "smithy.api#documentation": "Summary information of an ingestion job." + } + }, + "com.amazonaws.bedrockagent#Instruction": { + "type": "string", + "traits": { + "smithy.api#documentation": "Instruction for the agent.", + "smithy.api#length": { + "min": 40, + "max": 1200 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown if there was an unexpected error during processing of request", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.bedrockagent#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "A KMS key ARN", + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBase": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#required": {} + } + }, + "knowledgeBaseArn": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseArn", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "roleArn": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", + "traits": { + "smithy.api#required": {} + } + }, + "knowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "storageConfiguration": { + "target": "com.amazonaws.bedrockagent#StorageConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", + "traits": { + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "failureReasons": { + "target": "com.amazonaws.bedrockagent#FailureReasons" + } + }, + "traits": { + "smithy.api#documentation": "Contains the information of a knowledge base." + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "ARN of a KnowledgeBase", + "smithy.api#length": { + "max": 128 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseType", + "traits": { + "smithy.api#required": {} + } + }, + "vectorKnowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrockagent#VectorKnowledgeBaseConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Configures a bedrock knowledge base." + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#CreateKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#GetAgentKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#GetKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#ListAgentKnowledgeBases" + }, + { + "target": "com.amazonaws.bedrockagent#ListKnowledgeBases" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateKnowledgeBase" + } + ] + }, + "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "ARN of a IAM role.", + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?AmazonBedrockExecutionRoleForKnowledgeBase.+$" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseState": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "State of the knowledge base; whether it is enabled or disabled" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + }, + "traits": { + "smithy.api#documentation": "The status of a knowledge base." + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseStorageType": { + "type": "enum", + "members": { + "OPENSEARCH_SERVERLESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENSEARCH_SERVERLESS" + } + }, + "PINECONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PINECONE" + } + }, + "REDIS_ENTERPRISE_CLOUD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REDIS_ENTERPRISE_CLOUD" + } + } + }, + "traits": { + "smithy.api#documentation": "The storage type of a knowledge base." + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseSummary" + }, + "traits": { + "smithy.api#documentation": "List of KnowledgeBaseSummaries" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseSummary": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "status": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", + "traits": { + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information of a knowledge base." + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseType": { + "type": "enum", + "members": { + "VECTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VECTOR" + } + } + }, + "traits": { + "smithy.api#documentation": "The type of a knowledge base." + } + }, + "com.amazonaws.bedrockagent#LambdaArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "ARN of a Lambda.", + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" + } + }, + "com.amazonaws.bedrockagent#ListAgentActionGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListAgentActionGroupsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListAgentActionGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists an Action Group for existing Amazon Bedrock Agent Version", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "actionGroupSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListAgentActionGroupsRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent is Listed", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent is Listed", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults" + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "List Action Groups Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListAgentActionGroupsResponse": { + "type": "structure", + "members": { + "actionGroupSummaries": { + "target": "com.amazonaws.bedrockagent#ActionGroupSummaries", + "traits": { + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "List Action Groups Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#ListAgentAliases": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListAgentAliasesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListAgentAliasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all the Aliases for an Amazon Bedrock Agent", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/{agentId}/agentaliases/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "agentAliasSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListAgentAliasesRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults" + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "List Agent Aliases Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListAgentAliasesResponse": { + "type": "structure", + "members": { + "agentAliasSummaries": { + "target": "com.amazonaws.bedrockagent#AgentAliasSummaries", + "traits": { + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "List Agent Aliases Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#ListAgentKnowledgeBases": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListAgentKnowledgeBasesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListAgentKnowledgeBasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List of Knowledge Bases associated to an existing Amazon Bedrock Agent Version", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "agentKnowledgeBaseSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListAgentKnowledgeBasesRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "Version number generated when a version is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults" + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "List Agent Knowledge Bases Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListAgentKnowledgeBasesResponse": { + "type": "structure", + "members": { + "agentKnowledgeBaseSummaries": { + "target": "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummaries", + "traits": { + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "List Agent Knowledge Bases Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#ListAgentVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListAgentVersionsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListAgentVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists Agent Versions", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/{agentId}/agentversions/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "agentVersionSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListAgentVersionsRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults" + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "List Agent Versions Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListAgentVersionsResponse": { + "type": "structure", + "members": { + "agentVersionSummaries": { + "target": "com.amazonaws.bedrockagent#AgentVersionSummaries", + "traits": { + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "List Agent Versions Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#ListAgents": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListAgentsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListAgentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists Agents", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "agentSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListAgentsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults" + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "List Agent Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListAgentsResponse": { + "type": "structure", + "members": { + "agentSummaries": { + "target": "com.amazonaws.bedrockagent#AgentSummaries", + "traits": { + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "List Agent Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#ListDataSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListDataSourcesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListDataSourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List data sources", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "dataSourceSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListDataSourcesRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults" + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListDataSourcesResponse": { + "type": "structure", + "members": { + "dataSourceSummaries": { + "target": "com.amazonaws.bedrockagent#DataSourceSummaries", + "traits": { + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#ListIngestionJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListIngestionJobsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListIngestionJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List ingestion jobs", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "ingestionJobSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListIngestionJobsRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "filters": { + "target": "com.amazonaws.bedrockagent#IngestionJobFilters" + }, + "sortBy": { + "target": "com.amazonaws.bedrockagent#IngestionJobSortBy" + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults" + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListIngestionJobsResponse": { + "type": "structure", + "members": { + "ingestionJobSummaries": { + "target": "com.amazonaws.bedrockagent#IngestionJobSummaries", + "traits": { + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#ListKnowledgeBases": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListKnowledgeBasesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListKnowledgeBasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List Knowledge Bases", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/knowledgebases/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "knowledgeBaseSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListKnowledgeBasesRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults" + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListKnowledgeBasesResponse": { + "type": "structure", + "members": { + "knowledgeBaseSummaries": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseSummaries", + "traits": { + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List tags for a resource", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagent#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Max Results.", + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.bedrockagent#MaximumLength": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Maximum length of output", + "smithy.api#range": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.bedrockagent#ModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#documentation": "ARN or name of a Bedrock model.", + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "(^[a-zA-Z0-9-_.]+$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))$)|(^([0-9a-zA-Z][_-]?)+$)|^([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63})$" + } + }, + "com.amazonaws.bedrockagent#Name": { + "type": "string", + "traits": { + "smithy.api#documentation": "Name for a resource.", + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" + } + }, + "com.amazonaws.bedrockagent#NextToken": { + "type": "string", + "traits": { + "smithy.api#documentation": "Opaque continuation token of previous paginated response.", + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\S*$" + } + }, + "com.amazonaws.bedrockagent#NonBlankString": { + "type": "string", + "traits": { + "smithy.api#documentation": "Non Blank String", + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.bedrockagent#NumericalVersion": { + "type": "string", + "traits": { + "smithy.api#documentation": "Numerical Agent Version.", + "smithy.api#pattern": "^[0-9]{1,5}$" + } + }, + "com.amazonaws.bedrockagent#OpenSearchServerlessCollectionArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "Arn of an OpenSearch Serverless collection.", + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:aoss:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:collection/[a-z0-9-]{3,32}$" + } + }, + "com.amazonaws.bedrockagent#OpenSearchServerlessConfiguration": { + "type": "structure", + "members": { + "collectionArn": { + "target": "com.amazonaws.bedrockagent#OpenSearchServerlessCollectionArn", + "traits": { + "smithy.api#required": {} + } + }, + "vectorIndexName": { + "target": "com.amazonaws.bedrockagent#OpenSearchServerlessIndexName", + "traits": { + "smithy.api#required": {} + } + }, + "fieldMapping": { + "target": "com.amazonaws.bedrockagent#OpenSearchServerlessFieldMapping", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the configurations to use OpenSearch Serverless to store knowledge base data." + } + }, + "com.amazonaws.bedrockagent#OpenSearchServerlessFieldMapping": { + "type": "structure", + "members": { + "vectorField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#required": {} + } + }, + "textField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#required": {} + } + }, + "metadataField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names" + } + }, + "com.amazonaws.bedrockagent#OpenSearchServerlessIndexName": { + "type": "string", + "traits": { + "smithy.api#documentation": "Arn of an OpenSearch Serverless index.", + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#Payload": { + "type": "string", + "traits": { + "smithy.api#documentation": "String OpenAPI Payload", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PineconeConfiguration": { + "type": "structure", + "members": { + "connectionString": { + "target": "com.amazonaws.bedrockagent#PineconeConnectionString", + "traits": { + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.bedrockagent#PineconeNamespace" + }, + "fieldMapping": { + "target": "com.amazonaws.bedrockagent#PineconeFieldMapping", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the configurations to use Pinecone to store knowledge base data." + } + }, + "com.amazonaws.bedrockagent#PineconeConnectionString": { + "type": "string", + "traits": { + "smithy.api#documentation": "Pinecone connection string", + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#PineconeFieldMapping": { + "type": "structure", + "members": { + "textField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#required": {} + } + }, + "metadataField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A mapping of Bedrock Knowledge Base fields to Pinecone field names" + } + }, + "com.amazonaws.bedrockagent#PineconeNamespace": { + "type": "string", + "traits": { + "smithy.api#documentation": "Pinecone namespace", + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#PrepareAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#PrepareAgentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#PrepareAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Prepares an existing Amazon Bedrock Agent to receive runtime requests", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/agents/{agentId}/" + }, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#PrepareAgentRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "PrepareAgent Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#PrepareAgentResponse": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#required": {} + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#required": {} + } + }, + "preparedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "PrepareAgent Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#PromptConfiguration": { + "type": "structure", + "members": { + "promptType": { + "target": "com.amazonaws.bedrockagent#PromptType" + }, + "promptCreationMode": { + "target": "com.amazonaws.bedrockagent#CreationMode" + }, + "promptState": { + "target": "com.amazonaws.bedrockagent#PromptState" + }, + "basePromptTemplate": { + "target": "com.amazonaws.bedrockagent#BasePromptTemplate" + }, + "inferenceConfiguration": { + "target": "com.amazonaws.bedrockagent#InferenceConfiguration" + }, + "parserMode": { + "target": "com.amazonaws.bedrockagent#CreationMode" + } + }, + "traits": { + "smithy.api#documentation": "BasePromptConfiguration per Prompt Type." + } + }, + "com.amazonaws.bedrockagent#PromptConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#PromptConfiguration" + }, + "traits": { + "smithy.api#documentation": "List of BasePromptConfiguration", + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#PromptOverrideConfiguration": { + "type": "structure", + "members": { + "promptConfigurations": { + "target": "com.amazonaws.bedrockagent#PromptConfigurations", + "traits": { + "smithy.api#required": {} + } + }, + "overrideLambda": { + "target": "com.amazonaws.bedrockagent#LambdaArn" + } + }, + "traits": { + "smithy.api#documentation": "Configuration for prompt override.", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptState": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "Prompt State." + } + }, + "com.amazonaws.bedrockagent#PromptType": { + "type": "enum", + "members": { + "PRE_PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRE_PROCESSING" + } + }, + "ORCHESTRATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORCHESTRATION" + } + }, + "POST_PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POST_PROCESSING" + } + }, + "KNOWLEDGE_BASE_RESPONSE_GENERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KNOWLEDGE_BASE_RESPONSE_GENERATION" + } + } + }, + "traits": { + "smithy.api#documentation": "Prompt Type." + } + }, + "com.amazonaws.bedrockagent#RecommendedAction": { + "type": "string", + "traits": { + "smithy.api#documentation": "The recommended action users can take to resolve an error in failureReasons.", + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagent#RecommendedActions": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#RecommendedAction" + }, + "traits": { + "smithy.api#documentation": "The recommended actions users can take to resolve an error in failureReasons.", + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagent#RedisEnterpriseCloudConfiguration": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudEndpoint", + "traits": { + "smithy.api#required": {} + } + }, + "vectorIndexName": { + "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudIndexName", + "traits": { + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#required": {} + } + }, + "fieldMapping": { + "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudFieldMapping", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the configurations to use Redis Enterprise Cloud to store knowledge base data." + } + }, + "com.amazonaws.bedrockagent#RedisEnterpriseCloudEndpoint": { + "type": "string", + "traits": { + "smithy.api#documentation": "Redis enterprise cloud endpoint", + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#RedisEnterpriseCloudFieldMapping": { + "type": "structure", + "members": { + "vectorField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#required": {} + } + }, + "textField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#required": {} + } + }, + "metadataField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A mapping of Bedrock Knowledge Base fields to Redis Cloud field names" + } + }, + "com.amazonaws.bedrockagent#RedisEnterpriseCloudIndexName": { + "type": "string", + "traits": { + "smithy.api#documentation": "Name of a redis enterprise cloud index", + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when a resource referenced by the operation does not exist", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.bedrockagent#S3BucketArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "A S3 bucket ARN", + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$" + } + }, + "com.amazonaws.bedrockagent#S3BucketName": { + "type": "string", + "traits": { + "smithy.api#documentation": "A bucket in S3.", + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + } + }, + "com.amazonaws.bedrockagent#S3DataSourceConfiguration": { + "type": "structure", + "members": { + "bucketArn": { + "target": "com.amazonaws.bedrockagent#S3BucketArn", + "traits": { + "smithy.api#required": {} + } + }, + "inclusionPrefixes": { + "target": "com.amazonaws.bedrockagent#S3Prefixes" + } + }, + "traits": { + "smithy.api#documentation": "Configures an S3 data source location." + } + }, + "com.amazonaws.bedrockagent#S3Identifier": { + "type": "structure", + "members": { + "s3BucketName": { + "target": "com.amazonaws.bedrockagent#S3BucketName" + }, + "s3ObjectKey": { + "target": "com.amazonaws.bedrockagent#S3ObjectKey" + } + }, + "traits": { + "smithy.api#documentation": "The identifier for the S3 resource." + } + }, + "com.amazonaws.bedrockagent#S3ObjectKey": { + "type": "string", + "traits": { + "smithy.api#documentation": "A object key in S3.", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$" + } + }, + "com.amazonaws.bedrockagent#S3Prefix": { + "type": "string", + "traits": { + "smithy.api#documentation": "Prefix for s3 object.", + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.bedrockagent#S3Prefixes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#S3Prefix" + }, + "traits": { + "smithy.api#documentation": "A list of S3 prefixes.", + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#SecretArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "Arn of a SecretsManager Secret.", + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9/_+=.@-]{1,63}$" + } + }, + "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration": { + "type": "structure", + "members": { + "kmsKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn" + } + }, + "traits": { + "smithy.api#documentation": "Server-side encryption configuration." + } + }, + "com.amazonaws.bedrockagent#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when a request is made beyond the service quota", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.bedrockagent#SessionTTL": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Max Session Time.", + "smithy.api#range": { + "min": 60, + "max": 3600 + } + } + }, + "com.amazonaws.bedrockagent#SortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASCENDING" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESCENDING" + } + } + }, + "traits": { + "smithy.api#documentation": "Order to sort results by." + } + }, + "com.amazonaws.bedrockagent#StartIngestionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#StartIngestionJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#StartIngestionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Start a new ingestion job", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#StartIngestionJobRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#idempotencyToken": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#StartIngestionJobResponse": { + "type": "structure", + "members": { + "ingestionJob": { + "target": "com.amazonaws.bedrockagent#IngestionJob", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#StopSequences": { + "type": "list", + "member": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#documentation": "List of stop sequences", + "smithy.api#length": { + "min": 0, + "max": 4 + } + } + }, + "com.amazonaws.bedrockagent#StorageConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseStorageType", + "traits": { + "smithy.api#required": {} + } + }, + "opensearchServerlessConfiguration": { + "target": "com.amazonaws.bedrockagent#OpenSearchServerlessConfiguration" + }, + "pineconeConfiguration": { + "target": "com.amazonaws.bedrockagent#PineconeConfiguration" + }, + "redisEnterpriseCloudConfiguration": { + "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Configures the physical storage of ingested data in a knowledge base." + } + }, + "com.amazonaws.bedrockagent#TagKey": { + "type": "string", + "traits": { + "smithy.api#documentation": "Key of a tag", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrockagent#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#TagKey" + }, + "traits": { + "smithy.api#documentation": "List of Tag Keys", + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagent#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Tag a resource", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/tags/{resourceArn}" + } + } + }, + "com.amazonaws.bedrockagent#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#TagValue": { + "type": "string", + "traits": { + "smithy.api#documentation": "Value of a tag", + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrockagent#TaggableResourcesArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "ARN of Taggable resources: [Agent, AgentAlias, Knowledge-Base]", + "smithy.api#length": { + "min": 20, + "max": 1011 + }, + "smithy.api#pattern": "(^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:(agent|agent-alias|knowledge-base)/[A-Z0-9]{10}(?:/[A-Z0-9]{10})?$)" + } + }, + "com.amazonaws.bedrockagent#TaggingResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#ListTagsForResource" + }, + { + "target": "com.amazonaws.bedrockagent#TagResource" + }, + { + "target": "com.amazonaws.bedrockagent#UntagResource" + } + ] + }, + "com.amazonaws.bedrockagent#TagsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagent#TagKey" + }, + "value": { + "target": "com.amazonaws.bedrockagent#TagValue" + }, + "traits": { + "smithy.api#documentation": "A map of tag keys and values" + } + }, + "com.amazonaws.bedrockagent#Temperature": { + "type": "float", + "traits": { + "smithy.api#documentation": "Controls randomness, higher values increase diversity", + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when the number of requests exceeds the limit", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.bedrockagent#TopK": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Sample from the k most likely next tokens", + "smithy.api#range": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.bedrockagent#TopP": { + "type": "float", + "traits": { + "smithy.api#documentation": "Cumulative probability cutoff for token selection", + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Untag a resource", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagent#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.bedrockagent#TagKeyList", + "traits": { + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateAgentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing Amazon Bedrock Agent", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/agents/{agentId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#UpdateAgentActionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateAgentActionGroupRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateAgentActionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing Action Group for Amazon Bedrock Agent", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#UpdateAgentActionGroupRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "Draft Version of the Agent.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actionGroupId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Action Group is created under Agent", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actionGroupName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "parentActionGroupSignature": { + "target": "com.amazonaws.bedrockagent#ActionGroupSignature" + }, + "actionGroupExecutor": { + "target": "com.amazonaws.bedrockagent#ActionGroupExecutor" + }, + "actionGroupState": { + "target": "com.amazonaws.bedrockagent#ActionGroupState" + }, + "apiSchema": { + "target": "com.amazonaws.bedrockagent#APISchema" + } + }, + "traits": { + "smithy.api#documentation": "Update Action Group Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentActionGroupResponse": { + "type": "structure", + "members": { + "agentActionGroup": { + "target": "com.amazonaws.bedrockagent#AgentActionGroup", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Update Action Group Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateAgentAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateAgentAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing Alias for an Amazon Bedrock Agent", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#UpdateAgentAliasRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent Alias is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Update Agent Alias Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentAliasResponse": { + "type": "structure", + "members": { + "agentAlias": { + "target": "com.amazonaws.bedrockagent#AgentAlias", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Update Agent Alias Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing Knowledge Base associated to an Amazon Bedrock Agent", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "Draft Version of the Agent.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when a Knowledge Base is associated to an Agent", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "knowledgeBaseState": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseState" + } + }, + "traits": { + "smithy.api#documentation": "Update Agent Knowledge Base Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseResponse": { + "type": "structure", + "members": { + "agentKnowledgeBase": { + "target": "com.amazonaws.bedrockagent#AgentKnowledgeBase", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Update Agent Knowledge Base Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#required": {} + } + }, + "instruction": { + "target": "com.amazonaws.bedrockagent#Instruction" + }, + "foundationModel": { + "target": "com.amazonaws.bedrockagent#ModelIdentifier" + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.bedrockagent#SessionTTL" + }, + "agentResourceRoleArn": { + "target": "com.amazonaws.bedrockagent#AgentRoleArn", + "traits": { + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn" + }, + "promptOverrideConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Update Agent Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentResponse": { + "type": "structure", + "members": { + "agent": { + "target": "com.amazonaws.bedrockagent#Agent", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Update Agent Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Update an existing data source", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#UpdateDataSourceRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "dataSourceConfiguration": { + "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "serverSideEncryptionConfiguration": { + "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration" + }, + "vectorIngestionConfiguration": { + "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateDataSourceResponse": { + "type": "structure", + "members": { + "dataSource": { + "target": "com.amazonaws.bedrockagent#DataSource", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Update an existing knowledge base", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/knowledgebases/{knowledgeBaseId}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#UpdateKnowledgeBaseRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description" + }, + "roleArn": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", + "traits": { + "smithy.api#required": {} + } + }, + "knowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "storageConfiguration": { + "target": "com.amazonaws.bedrockagent#StorageConfiguration", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateKnowledgeBaseResponse": { + "type": "structure", + "members": { + "knowledgeBase": { + "target": "com.amazonaws.bedrockagent#KnowledgeBase", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString" + }, + "fieldList": { + "target": "com.amazonaws.bedrockagent#ValidationExceptionFieldList" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when the request's input validation fails", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrockagent#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#NonBlankString", + "traits": { + "smithy.api#required": {} + } + }, + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Stores information about a field passed inside a request that resulted in an exception" + } + }, + "com.amazonaws.bedrockagent#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#ValidationExceptionField" + }, + "traits": { + "smithy.api#documentation": "list of ValidationExceptionField" + } + }, + "com.amazonaws.bedrockagent#VectorIngestionConfiguration": { + "type": "structure", + "members": { + "chunkingConfiguration": { + "target": "com.amazonaws.bedrockagent#ChunkingConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Configures ingestion for a vector knowledge base" + } + }, + "com.amazonaws.bedrockagent#VectorKnowledgeBaseConfiguration": { + "type": "structure", + "members": { + "embeddingModelArn": { + "target": "com.amazonaws.bedrockagent#BedrockEmbeddingModelArn", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configurations for a vector knowledge base." + } + }, + "com.amazonaws.bedrockagent#Version": { + "type": "string", + "traits": { + "smithy.api#documentation": "Agent Version.", + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#pattern": "^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$" + } + }, + "com.amazonaws.bedrockagent#VersionResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#DeleteAgentVersion" + }, + { + "target": "com.amazonaws.bedrockagent#GetAgentVersion" + }, + { + "target": "com.amazonaws.bedrockagent#ListAgentVersions" + } + ] + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/bedrock-runtime.json b/codegen/sdk-codegen/aws-models/bedrock-runtime.json index 1e1bef9f169..c3f00c8025e 100644 --- a/codegen/sdk-codegen/aws-models/bedrock-runtime.json +++ b/codegen/sdk-codegen/aws-models/bedrock-runtime.json @@ -76,7 +76,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -95,7 +94,6 @@ }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -123,13 +121,14 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -142,7 +141,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -156,7 +154,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -179,7 +176,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -214,11 +210,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -229,16 +223,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -252,14 +249,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -268,15 +263,14 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -287,16 +281,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -310,7 +307,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -330,11 +326,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -345,20 +339,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -369,18 +365,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } - ] + ], + "type": "tree" } ] }, @@ -786,7 +786,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$" + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$" } }, "com.amazonaws.bedrockruntime#InvokeModelRequest": { diff --git a/codegen/sdk-codegen/aws-models/bedrock.json b/codegen/sdk-codegen/aws-models/bedrock.json index d5bba06e1a0..e866df5a4d7 100644 --- a/codegen/sdk-codegen/aws-models/bedrock.json +++ b/codegen/sdk-codegen/aws-models/bedrock.json @@ -46,7 +46,7 @@ "name": "bedrock" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Describes the API operations for creating and managing Bedrock models.

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

Describes the API operations for creating and managing Amazon Bedrock models.

", "smithy.api#title": "Amazon Bedrock", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -90,7 +90,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -109,7 +108,6 @@ }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -137,13 +135,14 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -156,7 +155,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -170,7 +168,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -193,7 +190,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -228,11 +224,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -243,16 +237,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -266,14 +263,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -282,15 +277,14 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -301,16 +295,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -324,7 +321,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -344,11 +340,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -359,20 +353,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -383,18 +379,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } - ] + ], + "type": "tree" } ] }, @@ -721,7 +721,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$" + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$" } }, "com.amazonaws.bedrock#BedrockModelId": { @@ -845,16 +845,13 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a fine-tuning job to customize a base model.

\n

You specify the base foundation model and the location of the training data.\n After the model-customization job completes successfully, your custom model resource will be ready to use. Training data\n contains input and output text for each record in a JSONL format. Optionally, you can specify validation data\n in the same format as the training data. Bedrock returns validation loss metrics and output generations\n after the job completes.\n

\n

\n Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size.\n To monitor a job, use the GetModelCustomizationJob operation to retrieve the job status.

\n

For more information, see Custom models in the Bedrock User Guide.

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

Creates a fine-tuning job to customize a base model.

\n

You specify the base foundation model and the location of the training data.\n After the model-customization job completes successfully, your custom model resource will be ready to use. Training data\n contains input and output text for each record in a JSONL format. Optionally, you can specify validation data\n in the same format as the training data. Amazon Bedrock returns validation loss metrics and output generations \n after the job completes.\n

\n

\n Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size.\n To monitor a job, use the GetModelCustomizationJob operation to retrieve the job status.

\n

For more information, see Custom models in the Bedrock User Guide.

", "smithy.api#http": { "code": 201, "method": "POST", "uri": "/model-customization-jobs" }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "model-customization" - ] + "smithy.api#idempotent": {} } }, "com.amazonaws.bedrock#CreateModelCustomizationJobRequest": { @@ -877,7 +874,7 @@ "roleArn": { "target": "com.amazonaws.bedrock#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that Bedrock can assume to perform tasks on your behalf.\n For example, during model training, Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket.\n To pass this role to Bedrock, the caller of this API must have the iam:PassRole permission.\n

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

The Amazon Resource Name (ARN) of an IAM role that Amazon Bedrock can assume to perform tasks on your behalf.\n For example, during model training, Amazon Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket.\n To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission.\n

", "smithy.api#required": {} } }, @@ -895,13 +892,16 @@ "smithy.api#required": {} } }, + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", + "traits": { + "smithy.api#documentation": "

The customization type.

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

The custom model is encrypted at rest using this key.

", - "smithy.api#tags": [ - "customer-managed-key" - ] + "smithy.api#documentation": "

The custom model is encrypted at rest using this key.

" } }, "jobTags": { @@ -946,10 +946,7 @@ "vpcConfig": { "target": "com.amazonaws.bedrock#VpcConfig", "traits": { - "smithy.api#documentation": "

VPC configuration (optional). Configuration parameters for the\n private Virtual Private Cloud (VPC) that contains the resources you are using for this job.

", - "smithy.api#tags": [ - "model-customization-vpc" - ] + "smithy.api#documentation": "

VPC configuration (optional). Configuration parameters for the\n private Virtual Private Cloud (VPC) that contains the resources you are using for this job.

" } } }, @@ -1019,7 +1016,7 @@ "clientRequestToken": { "target": "com.amazonaws.bedrock#IdempotencyToken", "traits": { - "smithy.api#documentation": "

Unique token value that you can provide. If this token matches a previous request,\n Bedrock ignores the request, but does not return an error.

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

Unique token value that you can provide. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error.

", "smithy.api#idempotencyToken": {} } }, @@ -1133,6 +1130,12 @@ "smithy.api#documentation": "

The base model name.

", "smithy.api#required": {} } + }, + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", + "traits": { + "smithy.api#documentation": "

Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.

" + } } }, "traits": { @@ -1145,6 +1148,23 @@ "target": "com.amazonaws.bedrock#CustomModelSummary" } }, + "com.amazonaws.bedrock#CustomizationType": { + "type": "enum", + "members": { + "FINE_TUNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FINE_TUNING" + } + }, + "CONTINUED_PRE_TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTINUED_PRE_TRAINING" + } + } + } + }, "com.amazonaws.bedrock#DeleteCustomModel": { "type": "operation", "input": { @@ -1180,10 +1200,7 @@ "method": "DELETE", "uri": "/custom-models/{modelIdentifier}" }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "model-customization" - ] + "smithy.api#idempotent": {} } }, "com.amazonaws.bedrock#DeleteCustomModelRequest": { @@ -1420,12 +1437,50 @@ "traits": { "smithy.api#documentation": "

The inference types that the model supports.

" } + }, + "modelLifecycle": { + "target": "com.amazonaws.bedrock#FoundationModelLifecycle", + "traits": { + "smithy.api#documentation": "

Contains details about whether a model version is available or deprecated

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

Information about a foundation model.

" } }, + "com.amazonaws.bedrock#FoundationModelLifecycle": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrock#FoundationModelLifecycleStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether a model version is available (ACTIVE) or deprecated (LEGACY.

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

Details about whether a model version is available or deprecated.

" + } + }, + "com.amazonaws.bedrock#FoundationModelLifecycleStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "LEGACY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEGACY" + } + } + } + }, "com.amazonaws.bedrock#FoundationModelSummary": { "type": "structure", "members": { @@ -1484,6 +1539,12 @@ "traits": { "smithy.api#documentation": "

The inference types that the model supports.

" } + }, + "modelLifecycle": { + "target": "com.amazonaws.bedrock#FoundationModelLifecycle", + "traits": { + "smithy.api#documentation": "

Contains details about whether a model version is available or deprecated.

" + } } }, "traits": { @@ -1522,16 +1583,13 @@ } ], "traits": { - "smithy.api#documentation": "

Get the properties associated with a Bedrock custom model that you have created.For more information, see Custom models in the Bedrock User Guide.

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

Get the properties associated with a Amazon Bedrock custom model that you have created.For more information, see Custom models in the Bedrock User Guide.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/custom-models/{modelIdentifier}" }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "model-customization" - ] + "smithy.api#readonly": {} } }, "com.amazonaws.bedrock#GetCustomModelRequest": { @@ -1587,13 +1645,16 @@ "smithy.api#required": {} } }, + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", + "traits": { + "smithy.api#documentation": "

The type of model customization.

" + } + }, "modelKmsKeyArn": { "target": "com.amazonaws.bedrock#KmsKeyArn", "traits": { - "smithy.api#documentation": "

The custom model is encrypted at rest using this key.

", - "smithy.api#tags": [ - "customer-managed-key" - ] + "smithy.api#documentation": "

The custom model is encrypted at rest using this key.

" } }, "hyperParameters": { @@ -1669,7 +1730,7 @@ } ], "traits": { - "smithy.api#documentation": "

Get details about a Bedrock foundation model.

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

Get details about a Amazon Bedrock foundation model.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -1734,16 +1795,13 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the properties associated with a model-customization job, including the status of the job.\n For more information, see Custom models in the Bedrock User Guide.

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

Retrieves the properties associated with a model-customization job, including the status of the job.\n For more information, see Custom models in the Bedrock User Guide.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/model-customization-jobs/{jobIdentifier}" }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "model-customization" - ] + "smithy.api#readonly": {} } }, "com.amazonaws.bedrock#GetModelCustomizationJobRequest": { @@ -1808,7 +1866,7 @@ "status": { "target": "com.amazonaws.bedrock#ModelCustomizationJobStatus", "traits": { - "smithy.api#documentation": "

The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use.\n If the job failed, the failure message contains information about why the job failed.

" + "smithy.api#documentation": "

The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use.\n If the job failed, the failure message contains information about why the job failed.

" } }, "failureMessage": { @@ -1846,7 +1904,7 @@ "hyperParameters": { "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", "traits": { - "smithy.api#documentation": "

The hyperparameter values for the job.

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

The hyperparameter values for the job. For information about hyperparameters for specific models, see Guidelines for model customization.

", "smithy.api#required": {} } }, @@ -1869,13 +1927,16 @@ "smithy.api#required": {} } }, + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", + "traits": { + "smithy.api#documentation": "

The type of model customization.

" + } + }, "outputModelKmsKeyArn": { "target": "com.amazonaws.bedrock#KmsKeyArn", "traits": { - "smithy.api#documentation": "

The custom model is encrypted at rest using this key.

", - "smithy.api#tags": [ - "customer-managed-key" - ] + "smithy.api#documentation": "

The custom model is encrypted at rest using this key.

" } }, "trainingMetrics": { @@ -1890,10 +1951,7 @@ "vpcConfig": { "target": "com.amazonaws.bedrock#VpcConfig", "traits": { - "smithy.api#documentation": "

VPC configuration for the custom model job.

", - "smithy.api#tags": [ - "model-customization-vpc" - ] + "smithy.api#documentation": "

VPC configuration for the custom model job.

" } } }, @@ -2217,10 +2275,7 @@ "pageSize": "maxResults", "items": "modelSummaries" }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "model-customization" - ] + "smithy.api#readonly": {} } }, "com.amazonaws.bedrock#ListCustomModelsRequest": { @@ -2271,7 +2326,7 @@ "nextToken": { "target": "com.amazonaws.bedrock#PaginationToken", "traits": { - "smithy.api#documentation": "

Continuation token from the previous response, for Bedrock to list the next set of results.

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

Continuation token from the previous response, for Amazon Bedrock to list the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -2337,7 +2392,7 @@ } ], "traits": { - "smithy.api#documentation": "

List of Bedrock foundation models that you can use. For more information, see Foundation models in the Bedrock User Guide.

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

List of Amazon Bedrock foundation models that you can use. For more information, see Foundation models in the Bedrock User Guide.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -2352,7 +2407,7 @@ "byProvider": { "target": "com.amazonaws.bedrock#Provider", "traits": { - "smithy.api#documentation": "

A Bedrock model provider.

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

A Amazon Bedrock model provider.

", "smithy.api#httpQuery": "byProvider" } }, @@ -2388,7 +2443,7 @@ "modelSummaries": { "target": "com.amazonaws.bedrock#FoundationModelSummaryList", "traits": { - "smithy.api#documentation": "

A list of bedrock foundation models.

" + "smithy.api#documentation": "

A list of Amazon Bedrock foundation models.

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

Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on\n one or more criteria.

\n

For more information, see Custom models in the Bedrock User Guide.

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

Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on\n one or more criteria.

\n

For more information, see Custom models in the Bedrock User Guide.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -2431,10 +2486,7 @@ "pageSize": "maxResults", "items": "modelCustomizationJobSummaries" }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "model-customization" - ] + "smithy.api#readonly": {} } }, "com.amazonaws.bedrock#ListModelCustomizationJobsRequest": { @@ -2478,7 +2530,7 @@ "nextToken": { "target": "com.amazonaws.bedrock#PaginationToken", "traits": { - "smithy.api#documentation": "

Continuation token from the previous response, for Bedrock to list the next set of results.

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

Continuation token from the previous response, for Amazon Bedrock to list the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -2607,7 +2659,7 @@ "nextToken": { "target": "com.amazonaws.bedrock#PaginationToken", "traits": { - "smithy.api#documentation": "

Continuation token from the previous response, for Bedrock to list the next set of results.

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

Continuation token from the previous response, for Amazon Bedrock to list the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -2681,10 +2733,7 @@ "code": 200, "method": "POST", "uri": "/listTagsForResource" - }, - "smithy.api#tags": [ - "tagging" - ] + } } }, "com.amazonaws.bedrock#ListTagsForResourceRequest": { @@ -2807,6 +2856,12 @@ "traits": { "smithy.api#enumValue": "FINE_TUNING" } + }, + "CONTINUED_PRE_TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTINUED_PRE_TRAINING" + } } } }, @@ -2939,6 +2994,12 @@ "traits": { "smithy.api#documentation": "

Name of the custom model.

" } + }, + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", + "traits": { + "smithy.api#documentation": "

Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.

" + } } }, "traits": { @@ -3062,7 +3123,7 @@ "com.amazonaws.bedrock#Provider": { "type": "string", "traits": { - "smithy.api#pattern": "^[a-z0-9-]{1,63}$" + "smithy.api#pattern": "^[A-Za-z0-9- ]{1,63}$" } }, "com.amazonaws.bedrock#ProvisionedModelArn": { @@ -3345,10 +3406,7 @@ "smithy.api#length": { "max": 32 }, - "smithy.api#pattern": "^[-0-9a-zA-Z]+$", - "smithy.api#tags": [ - "model-customization-vpc" - ] + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" } }, "com.amazonaws.bedrock#SecurityGroupIds": { @@ -3360,10 +3418,7 @@ "smithy.api#length": { "min": 1, "max": 5 - }, - "smithy.api#tags": [ - "model-customization-vpc" - ] + } } }, "com.amazonaws.bedrock#ServiceQuotaExceededException": { @@ -3464,10 +3519,7 @@ "method": "POST", "uri": "/model-customization-jobs/{jobIdentifier}/stop" }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "model-customization" - ] + "smithy.api#idempotent": {} } }, "com.amazonaws.bedrock#StopModelCustomizationJobRequest": { @@ -3499,10 +3551,7 @@ "smithy.api#length": { "max": 32 }, - "smithy.api#pattern": "^[-0-9a-zA-Z]+$", - "smithy.api#tags": [ - "model-customization-vpc" - ] + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" } }, "com.amazonaws.bedrock#SubnetIds": { @@ -3514,10 +3563,7 @@ "smithy.api#length": { "min": 1, "max": 16 - }, - "smithy.api#tags": [ - "model-customization-vpc" - ] + } } }, "com.amazonaws.bedrock#SubscriptionResource": { @@ -3613,10 +3659,7 @@ "code": 200, "method": "POST", "uri": "/tagResource" - }, - "smithy.api#tags": [ - "tagging" - ] + } } }, "com.amazonaws.bedrock#TagResourceRequest": { @@ -3715,7 +3758,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request contains more tags than can be associated with a resource (50 tags per resource).\n The maximum number of tags includes both existing tags and those included in your current request.

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

The request contains more tags than can be associated with a resource (50 tags per resource). \n The maximum number of tags includes both existing tags and those included in your current request.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3797,10 +3840,7 @@ "code": 200, "method": "POST", "uri": "/untagResource" - }, - "smithy.api#tags": [ - "tagging" - ] + } } }, "com.amazonaws.bedrock#UntagResourceRequest": { @@ -3995,10 +4035,7 @@ } }, "traits": { - "smithy.api#documentation": "

VPC configuration.

", - "smithy.api#tags": [ - "model-customization-vpc" - ] + "smithy.api#documentation": "

VPC configuration.

" } } } diff --git a/codegen/sdk-codegen/aws-models/connect.json b/codegen/sdk-codegen/aws-models/connect.json index 1e8079f9656..5917b4026b9 100644 --- a/codegen/sdk-codegen/aws-models/connect.json +++ b/codegen/sdk-codegen/aws-models/connect.json @@ -32,6 +32,9 @@ "com.amazonaws.connect#ARN": { "type": "string" }, + "com.amazonaws.connect#AWSAccountId": { + "type": "string" + }, "com.amazonaws.connect#AccessDeniedException": { "type": "structure", "members": { @@ -607,6 +610,26 @@ } } }, + "com.amazonaws.connect#AllowedCapabilities": { + "type": "structure", + "members": { + "Customer": { + "target": "com.amazonaws.connect#ParticipantCapabilities", + "traits": { + "smithy.api#documentation": "

Information about the customer's video sharing capabilities.

" + } + }, + "Agent": { + "target": "com.amazonaws.connect#ParticipantCapabilities", + "traits": { + "smithy.api#documentation": "

Information about the agent's video sharing capabilities.

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

Information about the capabilities enabled for participants of the contact.

" + } + }, "com.amazonaws.connect#AllowedMonitorCapabilities": { "type": "list", "member": { @@ -626,6 +649,9 @@ { "target": "com.amazonaws.connect#ActivateEvaluationForm" }, + { + "target": "com.amazonaws.connect#AssociateAnalyticsDataSet" + }, { "target": "com.amazonaws.connect#AssociateApprovedOrigin" }, @@ -635,6 +661,9 @@ { "target": "com.amazonaws.connect#AssociateDefaultVocabulary" }, + { + "target": "com.amazonaws.connect#AssociateFlow" + }, { "target": "com.amazonaws.connect#AssociateInstanceStorageConfig" }, @@ -659,6 +688,12 @@ { "target": "com.amazonaws.connect#AssociateTrafficDistributionGroupUser" }, + { + "target": "com.amazonaws.connect#BatchAssociateAnalyticsDataSet" + }, + { + "target": "com.amazonaws.connect#BatchDisassociateAnalyticsDataSet" + }, { "target": "com.amazonaws.connect#BatchGetFlowAssociation" }, @@ -872,12 +907,18 @@ { "target": "com.amazonaws.connect#DescribeVocabulary" }, + { + "target": "com.amazonaws.connect#DisassociateAnalyticsDataSet" + }, { "target": "com.amazonaws.connect#DisassociateApprovedOrigin" }, { "target": "com.amazonaws.connect#DisassociateBot" }, + { + "target": "com.amazonaws.connect#DisassociateFlow" + }, { "target": "com.amazonaws.connect#DisassociateInstanceStorageConfig" }, @@ -917,6 +958,9 @@ { "target": "com.amazonaws.connect#GetFederationToken" }, + { + "target": "com.amazonaws.connect#GetFlowAssociation" + }, { "target": "com.amazonaws.connect#GetMetricData" }, @@ -932,9 +976,15 @@ { "target": "com.amazonaws.connect#GetTrafficDistribution" }, + { + "target": "com.amazonaws.connect#ImportPhoneNumber" + }, { "target": "com.amazonaws.connect#ListAgentStatuses" }, + { + "target": "com.amazonaws.connect#ListAnalyticsDataAssociations" + }, { "target": "com.amazonaws.connect#ListApprovedOrigins" }, @@ -962,6 +1012,9 @@ { "target": "com.amazonaws.connect#ListEvaluationFormVersions" }, + { + "target": "com.amazonaws.connect#ListFlowAssociations" + }, { "target": "com.amazonaws.connect#ListHoursOfOperations" }, @@ -1001,6 +1054,9 @@ { "target": "com.amazonaws.connect#ListQuickConnects" }, + { + "target": "com.amazonaws.connect#ListRealtimeContactAnalysisSegmentsV2" + }, { "target": "com.amazonaws.connect#ListRoutingProfileQueues" }, @@ -1094,6 +1150,9 @@ { "target": "com.amazonaws.connect#SearchVocabularies" }, + { + "target": "com.amazonaws.connect#SendChatIntegrationEvent" + }, { "target": "com.amazonaws.connect#StartChatContact" }, @@ -1112,6 +1171,9 @@ { "target": "com.amazonaws.connect#StartTaskContact" }, + { + "target": "com.amazonaws.connect#StartWebRTCContact" + }, { "target": "com.amazonaws.connect#StopContact" }, @@ -2078,6 +2140,44 @@ } } }, + "com.amazonaws.connect#AnalyticsDataAssociationResult": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.connect#DataSetId", + "traits": { + "smithy.api#documentation": "

The identifier of the dataset.

" + } + }, + "TargetAccountId": { + "target": "com.amazonaws.connect#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The identifier of the target account.

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

The Resource Access Manager share ID.

" + } + }, + "ResourceShareArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Resource Access Manager share.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Information about associations that are successfully created: DataSetId,\n TargetAccountId, ResourceShareId,\n ResourceShareArn.

" + } + }, + "com.amazonaws.connect#AnalyticsDataAssociationResults": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#AnalyticsDataAssociationResult" + } + }, "com.amazonaws.connect#AnswerMachineDetectionConfig": { "type": "structure", "members": { @@ -2147,11 +2247,138 @@ "com.amazonaws.connect#ApproximateTotalCount": { "type": "long" }, + "com.amazonaws.connect#ArtifactId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connect#ArtifactStatus": { + "type": "enum", + "members": { + "APPROVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPROVED" + } + }, + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECTED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + } + } + }, "com.amazonaws.connect#AssignContactCategoryActionDefinition": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

This action must be set if TriggerEventSource is one of the following values:\n OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable |\n OnPostChatAnalysisAvailable. Contact is categorized using the rule name.

\n

\n RuleName is used as ContactCategory.

" + "smithy.api#documentation": "

This action must be set if TriggerEventSource is one of the following values:\n OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable |\n OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable. Contact\n is categorized using the rule name.

\n

\n RuleName is used as ContactCategory.

" + } + }, + "com.amazonaws.connect#AssociateAnalyticsDataSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#AssociateAnalyticsDataSetRequest" + }, + "output": { + "target": "com.amazonaws.connect#AssociateAnalyticsDataSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Associates the specified dataset for a Amazon Connect instance with the target account.\n You can associate only one dataset in a single call.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/analytics-data/instance/{InstanceId}/association", + "code": 200 + } + } + }, + "com.amazonaws.connect#AssociateAnalyticsDataSetRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.connect#DataSetId", + "traits": { + "smithy.api#documentation": "

The identifier of the dataset to associate with the target account.

", + "smithy.api#required": {} + } + }, + "TargetAccountId": { + "target": "com.amazonaws.connect#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The identifier of the target account. Use to associate a dataset to a different account than the one containing\n the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#AssociateAnalyticsDataSetResponse": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.connect#DataSetId", + "traits": { + "smithy.api#documentation": "

The identifier of the dataset that was associated.

" + } + }, + "TargetAccountId": { + "target": "com.amazonaws.connect#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The identifier of the target account.

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

The Resource Access Manager share ID that is generated.

" + } + }, + "ResourceShareArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Resource Access Manager share.

" + } + } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.connect#AssociateApprovedOrigin": { @@ -2353,6 +2580,87 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#AssociateFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#AssociateFlowRequest" + }, + "output": { + "target": "com.amazonaws.connect#AssociateFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates a connect resource to a flow.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/flow-associations/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#AssociateFlowRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The identifier of the resource.

", + "smithy.api#required": {} + } + }, + "FlowId": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The identifier of the flow.

", + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.connect#FlowAssociationResourceType", + "traits": { + "smithy.api#documentation": "

A valid resource type.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#AssociateFlowResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#AssociateInstanceStorageConfig": { "type": "operation", "input": { @@ -2918,6 +3226,15 @@ } } }, + "com.amazonaws.connect#AttachmentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, "com.amazonaws.connect#AttachmentReference": { "type": "structure", "members": { @@ -2944,6 +3261,29 @@ "smithy.api#documentation": "

Information about a reference when the referenceType is\n ATTACHMENT. Otherwise, null.

" } }, + "com.amazonaws.connect#Attendee": { + "type": "structure", + "members": { + "AttendeeId": { + "target": "com.amazonaws.connect#AttendeeId", + "traits": { + "smithy.api#documentation": "

The Amazon Chime SDK attendee ID.

" + } + }, + "JoinToken": { + "target": "com.amazonaws.connect#JoinToken", + "traits": { + "smithy.api#documentation": "

The join token used by the Amazon Chime SDK attendee.

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

The attendee information, including attendee ID and join token.

" + } + }, + "com.amazonaws.connect#AttendeeId": { + "type": "string" + }, "com.amazonaws.connect#Attribute": { "type": "structure", "members": { @@ -2997,6 +3337,20 @@ "target": "com.amazonaws.connect#Attribute" } }, + "com.amazonaws.connect#AudioFeatures": { + "type": "structure", + "members": { + "EchoReduction": { + "target": "com.amazonaws.connect#MeetingFeatureStatus", + "traits": { + "smithy.api#documentation": "

Makes echo reduction available to clients who connect to the meeting.

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

Has audio-specific configurations as the operating parameter for Echo Reduction.

" + } + }, "com.amazonaws.connect#AutoAccept": { "type": "boolean", "traits": { @@ -3045,6 +3399,172 @@ "smithy.api#pattern": "^[a-z]{2}(-[a-z]+){1,2}(-[0-9])?$" } }, + "com.amazonaws.connect#BatchAssociateAnalyticsDataSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#BatchAssociateAnalyticsDataSetRequest" + }, + "output": { + "target": "com.amazonaws.connect#BatchAssociateAnalyticsDataSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can\n associate multiple datasets in a single call.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/analytics-data/instance/{InstanceId}/associations", + "code": 200 + } + } + }, + "com.amazonaws.connect#BatchAssociateAnalyticsDataSetRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetIds": { + "target": "com.amazonaws.connect#DataSetIds", + "traits": { + "smithy.api#documentation": "

An array of dataset identifiers to associate.

", + "smithy.api#required": {} + } + }, + "TargetAccountId": { + "target": "com.amazonaws.connect#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The identifier of the target account. Use to associate a dataset to a different account than the one containing\n the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#BatchAssociateAnalyticsDataSetResponse": { + "type": "structure", + "members": { + "Created": { + "target": "com.amazonaws.connect#AnalyticsDataAssociationResults", + "traits": { + "smithy.api#documentation": "

Information about associations that are successfully created: DataSetId,\n TargetAccountId, ResourceShareId,\n ResourceShareArn.

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

A list of errors for datasets that aren't successfully associated \n with the target account.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.connect#BatchDisassociateAnalyticsDataSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#BatchDisassociateAnalyticsDataSetRequest" + }, + "output": { + "target": "com.amazonaws.connect#BatchDisassociateAnalyticsDataSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Removes a list of analytics datasets associated with a given Amazon Connect instance.\n You can disassociate multiple datasets in a single call.

", + "smithy.api#http": { + "method": "POST", + "uri": "/analytics-data/instance/{InstanceId}/associations", + "code": 200 + } + } + }, + "com.amazonaws.connect#BatchDisassociateAnalyticsDataSetRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetIds": { + "target": "com.amazonaws.connect#DataSetIds", + "traits": { + "smithy.api#documentation": "

An array of associated dataset identifiers to remove.

", + "smithy.api#required": {} + } + }, + "TargetAccountId": { + "target": "com.amazonaws.connect#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The identifier of the target account. Use to disassociate a dataset from a different account than the one containing\n the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#BatchDisassociateAnalyticsDataSetResponse": { + "type": "structure", + "members": { + "Deleted": { + "target": "com.amazonaws.connect#DataSetIds", + "traits": { + "smithy.api#documentation": "

An array of successfully disassociated dataset identifiers.

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

A list of errors for any datasets not successfully removed.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#BatchGetFlowAssociation": { "type": "operation", "input": { @@ -3354,6 +3874,56 @@ } } }, + "com.amazonaws.connect#ChatEvent": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.connect#ChatEventType", + "traits": { + "smithy.api#documentation": "

Type of chat integration event.

", + "smithy.api#required": {} + } + }, + "ContentType": { + "target": "com.amazonaws.connect#ChatContentType", + "traits": { + "smithy.api#documentation": "

Type of content. This is required when Type is MESSAGE or\n EVENT.

\n " + } + }, + "Content": { + "target": "com.amazonaws.connect#ChatContent", + "traits": { + "smithy.api#documentation": "

Content of the message or event. This is required when Type is\n MESSAGE and for certain ContentTypes when Type is\n EVENT.

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

Chat integration event containing payload to perform different chat actions such as:

\n " + } + }, + "com.amazonaws.connect#ChatEventType": { + "type": "enum", + "members": { + "DISCONNECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISCONNECT" + } + }, + "MESSAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MESSAGE" + } + }, + "EVENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVENT" + } + } + } + }, "com.amazonaws.connect#ChatMessage": { "type": "structure", "members": { @@ -3580,6 +4150,12 @@ "traits": { "smithy.api#documentation": "

The status of the phone number.

\n \n \n

You will not be billed for the phone number during the 1-day period if number claiming\n fails.

\n " } + }, + "SourcePhoneNumberArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The claimed phone number ARN that was previously imported from the external service, such as\n Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number\n that was imported from Amazon Pinpoint.

" + } } }, "traits": { @@ -3624,6 +4200,26 @@ } } }, + "com.amazonaws.connect#ConnectionData": { + "type": "structure", + "members": { + "Attendee": { + "target": "com.amazonaws.connect#Attendee", + "traits": { + "smithy.api#documentation": "

The attendee information, including attendee ID and join token.

" + } + }, + "Meeting": { + "target": "com.amazonaws.connect#Meeting", + "traits": { + "smithy.api#documentation": "

A meeting created using the Amazon Chime SDK.

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

Information required to join the call.

" + } + }, "com.amazonaws.connect#Contact": { "type": "structure", "members": { @@ -4365,6 +4961,15 @@ } } }, + "com.amazonaws.connect#ContentType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, "com.amazonaws.connect#ControlPlaneTagFilter": { "type": "structure", "members": { @@ -6387,7 +6992,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a user account for the specified Amazon Connect instance.

\n \n

Certain UserIdentityInfo parameters\n are required in some situations. For example, Email is required if you are using\n SAML for identity management. FirstName and LastName are required if\n you are using Amazon Connect or SAML for identity management.

\n \n

For information about how to create user accounts using the Amazon Connect console, see\n Add\n Users in the Amazon Connect Administrator Guide.

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

Creates a user account for the specified Amazon Connect instance.

\n \n

Certain UserIdentityInfo parameters\n are required in some situations. For example, Email is required if you are using\n SAML for identity management. FirstName and LastName are required if\n you are using Amazon Connect or SAML for identity management.

\n \n

For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.

", "smithy.api#http": { "method": "PUT", "uri": "/users/{InstanceId}", @@ -7153,6 +7758,21 @@ "target": "com.amazonaws.connect#CurrentMetric" } }, + "com.amazonaws.connect#DataSetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.connect#DataSetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#DataSetId" + } + }, "com.amazonaws.connect#DateReference": { "type": "structure", "members": { @@ -9963,7 +10583,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the specified user account. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the\n user IDs. Instead, list the users and note the IDs provided in the output.

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

Describes the specified user. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the\n user IDs. Instead, list the users and note the IDs provided in the output.

", "smithy.api#http": { "method": "GET", "uri": "/users/{InstanceId}/{UserId}", @@ -10312,6 +10932,15 @@ "smithy.api#pattern": "^(^[\\S].*[\\S]$)|(^[\\S]$)$" } }, + "com.amazonaws.connect#DestinationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, "com.amazonaws.connect#DestinationNotAllowedException": { "type": "structure", "members": { @@ -10417,6 +11046,69 @@ "com.amazonaws.connect#DirectoryUserId": { "type": "string" }, + "com.amazonaws.connect#DisassociateAnalyticsDataSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DisassociateAnalyticsDataSetRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Removes the dataset ID associated with a given Amazon Connect instance.

", + "smithy.api#http": { + "method": "POST", + "uri": "/analytics-data/instance/{InstanceId}/association", + "code": 200 + } + } + }, + "com.amazonaws.connect#DisassociateAnalyticsDataSetRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.connect#DataSetId", + "traits": { + "smithy.api#documentation": "

The identifier of the dataset to remove.

", + "smithy.api#required": {} + } + }, + "TargetAccountId": { + "target": "com.amazonaws.connect#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The identifier of the target account. Use to associate a dataset to a different account than the one containing\n the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.connect#DisassociateApprovedOrigin": { "type": "operation", "input": { @@ -10531,6 +11223,82 @@ "smithy.api#input": {} } }, + "com.amazonaws.connect#DisassociateFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DisassociateFlowRequest" + }, + "output": { + "target": "com.amazonaws.connect#DisassociateFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates a connect resource from a flow.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/flow-associations/{InstanceId}/{ResourceId}/{ResourceType}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DisassociateFlowRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The identifier of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.connect#FlowAssociationResourceType", + "traits": { + "smithy.api#documentation": "

A valid resource type.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#DisassociateFlowResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#DisassociateInstanceStorageConfig": { "type": "operation", "input": { @@ -11295,6 +12063,32 @@ } } }, + "com.amazonaws.connect#ErrorResult": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.connect#String", + "traits": { + "smithy.api#documentation": "

The error code.

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

The corresponding error message for the error code.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

List of errors for dataset association failures.

" + } + }, + "com.amazonaws.connect#ErrorResults": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ErrorResult" + } + }, "com.amazonaws.connect#Evaluation": { "type": "structure", "members": { @@ -12628,6 +13422,12 @@ "smithy.api#enumValue": "OnRealTimeCallAnalysisAvailable" } }, + "OnRealTimeChatAnalysisAvailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OnRealTimeChatAnalysisAvailable" + } + }, "OnPostChatAnalysisAvailable": { "target": "smithy.api#Unit", "traits": { @@ -12833,6 +13633,17 @@ } } }, + "com.amazonaws.connect#FlowAssociationResourceType": { + "type": "enum", + "members": { + "SMS_PHONE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMS_PHONE_NUMBER" + } + } + } + }, "com.amazonaws.connect#FlowAssociationSummary": { "type": "structure", "members": { @@ -13256,6 +14067,101 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#GetFlowAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#GetFlowAssociationRequest" + }, + "output": { + "target": "com.amazonaws.connect#GetFlowAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the flow associated for a given resource.

", + "smithy.api#http": { + "method": "GET", + "uri": "/flow-associations/{InstanceId}/{ResourceId}/{ResourceType}", + "code": 200 + } + } + }, + "com.amazonaws.connect#GetFlowAssociationRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The identifier of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.connect#FlowAssociationResourceType", + "traits": { + "smithy.api#documentation": "

A valid resource type.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#GetFlowAssociationResponse": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The identifier of the resource.

" + } + }, + "FlowId": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The identifier of the flow.

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

A valid resource type.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#GetMetricData": { "type": "operation", "input": { @@ -13449,20 +14355,20 @@ "Filters": { "target": "com.amazonaws.connect#FiltersV2List", "traits": { - "smithy.api#documentation": "

The filters to apply to returned metrics. You can filter on the following resources:

\n \n

At least one filter must be passed from queues, routing profiles, agents, or user hierarchy\n groups.

\n

To filter by phone number, see Create a historical\n metrics report in the Amazon Connect Administrator's\n Guide.

\n

Note the following limits:

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

The filters to apply to returned metrics. You can filter on the following resources:

\n \n

At least one filter must be passed from queues, routing profiles, agents, or user hierarchy\n groups.

\n

To filter by phone number, see Create a historical\n metrics report in the Amazon Connect Administrator's\n Guide.

\n

Note the following limits:

\n ", "smithy.api#required": {} } }, "Groupings": { "target": "com.amazonaws.connect#GroupingsV2", "traits": { - "smithy.api#documentation": "

The grouping applied to the metrics that are returned. For example, when results are grouped\n by queue, the metrics returned are grouped by queue. The values that are returned apply to the\n metrics for each queue. They are not aggregated for all queues.

\n

If no grouping is specified, a summary of all metrics is returned.

\n

Valid grouping keys: QUEUE | ROUTING_PROFILE | AGENT\n | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE |\n AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE |\n AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE\n

" + "smithy.api#documentation": "

The grouping applied to the metrics that are returned. For example, when results are grouped\n by queue, the metrics returned are grouped by queue. The values that are returned apply to the\n metrics for each queue. They are not aggregated for all queues.

\n

If no grouping is specified, a summary of all metrics is returned.

\n

Valid grouping keys: QUEUE | ROUTING_PROFILE | AGENT\n | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE |\n AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE |\n AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE,\n contact/segmentAttributes/connect:Subtype\n

" } }, "Metrics": { "target": "com.amazonaws.connect#MetricsV2", "traits": { - "smithy.api#documentation": "

The metrics to retrieve. Specify the name, groupings, and filters for each metric. The\n following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's\n Guide.

\n
\n
ABANDONMENT_RATE
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_ADHERENT_TIME
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_NON_RESPONSE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

Data for this metric is available starting from October 1, 2023 0:00:00 GMT.

\n
\n
AGENT_OCCUPANCY
\n
\n

Unit: Percentage

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_SCHEDULE_ADHERENCE
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_SCHEDULED_TIME
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_ABANDON_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_AFTER_CONTACT_WORK_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_AGENT_CONNECTING_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n \n

The Negate key in Metric Level Filters is not applicable for this\n metric.

\n \n
\n
AVG_CONTACT_DURATION
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_CONVERSATION_DURATION
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_GREETING_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_HANDLE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_HOLD_TIME_ALL_CONTACTS
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_HOLDS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_INTERACTION_AND_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_INTERACTION_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_INTERRUPTIONS_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_INTERRUPTION_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_NON_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_QUEUE_ANSWER_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_RESOLUTION_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile

\n
\n
AVG_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_TALK_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_TALK_TIME_CUSTOMER
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_ABANDONED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_CREATED
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_HANDLED
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_HOLD_ABANDONS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_QUEUED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_RESOLVED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile

\n

Threshold: For ThresholdValue enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
CONTACTS_TRANSFERRED_OUT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_TRANSFERRED_OUT_BY_AGENT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
MAX_QUEUED_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
PERCENT_NON_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
PERCENT_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
PERCENT_TALK_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
PERCENT_TALK_TIME_CUSTOMER
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SERVICE_LEVEL
\n
\n

You can include up to 20 SERVICE_LEVEL metrics in a request.

\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
SUM_CONTACTS_ANSWERED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
SUM_CONTACTS_ABANDONED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
SUM_CONTACTS_DISCONNECTED
\n
\n

Valid metric filter key: DISCONNECT_REASON\n

\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile

\n
\n
SUM_RETRY_CALLBACK_ATTEMPTS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile

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

The metrics to retrieve. Specify the name, groupings, and filters for each metric. The\n following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's\n Guide.

\n
\n
ABANDONMENT_RATE
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n
\n
AGENT_ADHERENT_TIME
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_ANSWER_RATE
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_NON_ADHERENT_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_NON_RESPONSE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

Data for this metric is available starting from October 1, 2023 0:00:00 GMT.

\n
\n
AGENT_OCCUPANCY
\n
\n

Unit: Percentage

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_SCHEDULE_ADHERENCE
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_SCHEDULED_TIME
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_ABANDON_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_AFTER_CONTACT_WORK_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_AGENT_CONNECTING_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n \n

The Negate key in Metric Level Filters is not applicable for this\n metric.

\n \n
\n
AVG_CONTACT_DURATION
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_CONVERSATION_DURATION
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_GREETING_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_HANDLE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_HOLD_TIME_ALL_CONTACTS
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_HOLDS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_INTERACTION_AND_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_INTERACTION_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_INTERRUPTIONS_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_INTERRUPTION_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_NON_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_QUEUE_ANSWER_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_RESOLUTION_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_TALK_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_TALK_TIME_CUSTOMER
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
CONTACTS_ABANDONED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
CONTACTS_CREATED
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_HANDLED
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_HOLD_ABANDONS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
CONTACTS_ON_HOLD_AGENT_DISCONNECT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_PUT_ON_HOLD
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_TRANSFERRED_OUT_EXTERNAL
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_TRANSFERRED_OUT_INTERNAL
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_QUEUED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
CONTACTS_RESOLVED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype

\n

Threshold: For ThresholdValue enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
CONTACTS_TRANSFERRED_OUT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_TRANSFERRED_OUT_BY_AGENT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
MAX_QUEUED_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
PERCENT_NON_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
PERCENT_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
PERCENT_TALK_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
PERCENT_TALK_TIME_CUSTOMER
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
SERVICE_LEVEL
\n
\n

You can include up to 20 SERVICE_LEVEL metrics in a request.

\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
SUM_AFTER_CONTACT_WORK_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_CONNECTING_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD. This metric only supports the\n following filter keys as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n \n

The Negate key in Metric Level Filters is not applicable for this\n metric.

\n \n
\n
SUM_CONTACT_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_CONTACT_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_CONTACTS_ANSWERED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
SUM_CONTACTS_ABANDONED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
SUM_CONTACTS_DISCONNECTED
\n
\n

Valid metric filter key: DISCONNECT_REASON\n

\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
SUM_ERROR_STATUS_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_HANDLE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_HOLD_TIME
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_IDLE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_INTERACTION_AND_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_INTERACTION_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_NON_PRODUCTIVE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_ONLINE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_RETRY_CALLBACK_ATTEMPTS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype

\n
\n
", "smithy.api#required": {} } }, @@ -14819,6 +15725,104 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.connect#ImportPhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ImportPhoneNumberRequest" + }, + "output": { + "target": "com.amazonaws.connect#ImportPhoneNumberResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#IdempotencyException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an\n Amazon Connect instance. You can call this API only in the same Amazon Web Services Region\n where the Amazon Connect instance was created.

", + "smithy.api#http": { + "method": "POST", + "uri": "/phone-number/import", + "code": 200 + } + } + }, + "com.amazonaws.connect#ImportPhoneNumberRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "smithy.api#required": {} + } + }, + "SourcePhoneNumberArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The claimed phone number ARN being imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number to\n import from Amazon Pinpoint.

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

The description of the phone number.

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

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#ImportPhoneNumberResponse": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the phone number.

" + } + }, + "PhoneNumberArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the phone number.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#InboundCallsEnabled": { "type": "boolean" }, @@ -15524,6 +16528,12 @@ "target": "com.amazonaws.connect#InvisibleFieldInfo" } }, + "com.amazonaws.connect#JoinToken": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.connect#KeyId": { "type": "string", "traits": { @@ -15810,6 +16820,97 @@ } } }, + "com.amazonaws.connect#ListAnalyticsDataAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListAnalyticsDataAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListAnalyticsDataAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Lists the association status of requested dataset ID for a given Amazon Connect\n instance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/analytics-data/instance/{InstanceId}/association", + "code": 200 + } + } + }, + "com.amazonaws.connect#ListAnalyticsDataAssociationsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.connect#DataSetId", + "traits": { + "smithy.api#documentation": "

The identifier of the dataset to get the association status.

", + "smithy.api#httpQuery": "DataSetId" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#ListAnalyticsDataAssociationsResponse": { + "type": "structure", + "members": { + "Results": { + "target": "com.amazonaws.connect#AnalyticsDataAssociationResults", + "traits": { + "smithy.api#documentation": "

An array of successful results: DataSetId, TargetAccountId,\n ResourceShareId, ResourceShareArn. This is a paginated API, so\n nextToken is given if there are more results to be returned.

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

If there are additional results, this is the token for the next set of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#ListApprovedOrigins": { "type": "operation", "input": { @@ -16665,6 +17766,106 @@ } } }, + "com.amazonaws.connect#ListFlowAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListFlowAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListFlowAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

List the flow association based on the filters.

", + "smithy.api#http": { + "method": "GET", + "uri": "/flow-associations-summary/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FlowAssociationSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListFlowAssociationsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.connect#ListFlowAssociationResourceType", + "traits": { + "smithy.api#documentation": "

A valid resource type.

", + "smithy.api#httpQuery": "ResourceType" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#ListFlowAssociationsResponse": { + "type": "structure", + "members": { + "FlowAssociationSummaryList": { + "target": "com.amazonaws.connect#FlowAssociationSummaryList", + "traits": { + "smithy.api#documentation": "

Summary of flow associations.

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

If there are additional results, this is the token for the next set of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#ListHoursOfOperations": { "type": "operation", "input": { @@ -17445,6 +18646,18 @@ "traits": { "smithy.api#documentation": "

The identifier of the Amazon Connect instance that phone numbers are claimed to. You\n can find the\n instance ID in the Amazon Resource Name (ARN) of the instance.

" } + }, + "PhoneNumberDescription": { + "target": "com.amazonaws.connect#PhoneNumberDescription", + "traits": { + "smithy.api#documentation": "

The description of the phone number.

" + } + }, + "SourcePhoneNumberArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The claimed phone number ARN that was previously imported from the external service, such as\n Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number\n that was imported from Amazon Pinpoint.

" + } } }, "traits": { @@ -17932,7 +19145,7 @@ "QuickConnectTypes": { "target": "com.amazonaws.connect#QuickConnectTypes", "traits": { - "smithy.api#documentation": "

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are\n prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

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

The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are\n prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

", "smithy.api#httpQuery": "QuickConnectTypes" } } @@ -17961,6 +19174,133 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#ListRealtimeContactAnalysisSegmentsV2": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListRealtimeContactAnalysisSegmentsV2Request" + }, + "output": { + "target": "com.amazonaws.connect#ListRealtimeContactAnalysisSegmentsV2Response" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#OutputTypeNotFoundException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a list of analysis segments for a real-time analysis session.

", + "smithy.api#http": { + "method": "POST", + "uri": "/contact/list-real-time-analysis-segments-v2/{InstanceId}/{ContactId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListRealtimeContactAnalysisSegmentsV2Request": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact in this instance of Amazon Connect.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" + } + }, + "OutputType": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisOutputType", + "traits": { + "smithy.api#documentation": "

The Contact Lens output type to be returned.

", + "smithy.api#required": {} + } + }, + "SegmentTypes": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisSegmentTypes", + "traits": { + "smithy.api#documentation": "

Enum with segment types . Each value corresponds to a segment type returned in the segments\n list of the API. Each segment type has its own structure. Different channels may have different\n sets of supported segment types.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#ListRealtimeContactAnalysisSegmentsV2Response": { + "type": "structure", + "members": { + "Channel": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisSupportedChannel", + "traits": { + "smithy.api#documentation": "

The channel of the contact. Voice will not be returned.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisStatus", + "traits": { + "smithy.api#documentation": "

Status of real-time contact analysis.

", + "smithy.api#required": {} + } + }, + "Segments": { + "target": "com.amazonaws.connect#RealtimeContactAnalysisSegments", + "traits": { + "smithy.api#documentation": "

An analyzed transcript or category.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#LargeNextToken", + "traits": { + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#ListRoutingProfileQueues": { "type": "operation", "input": { @@ -19612,6 +20952,113 @@ "smithy.api#documentation": "

Contains information about which channels are supported, and how many contacts an agent can\n have on a channel simultaneously.

" } }, + "com.amazonaws.connect#MediaPlacement": { + "type": "structure", + "members": { + "AudioHostUrl": { + "target": "com.amazonaws.connect#URI", + "traits": { + "smithy.api#documentation": "

The audio host URL.

" + } + }, + "AudioFallbackUrl": { + "target": "com.amazonaws.connect#URI", + "traits": { + "smithy.api#documentation": "

The audio fallback URL.

" + } + }, + "SignalingUrl": { + "target": "com.amazonaws.connect#URI", + "traits": { + "smithy.api#documentation": "

The signaling URL.

" + } + }, + "TurnControlUrl": { + "target": "com.amazonaws.connect#URI", + "traits": { + "smithy.api#documentation": "

The turn control URL.

" + } + }, + "EventIngestionUrl": { + "target": "com.amazonaws.connect#URI", + "traits": { + "smithy.api#documentation": "

The event ingestion URL to which you send client meeting events.

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

A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.

" + } + }, + "com.amazonaws.connect#MediaRegion": { + "type": "string" + }, + "com.amazonaws.connect#Meeting": { + "type": "structure", + "members": { + "MediaRegion": { + "target": "com.amazonaws.connect#MediaRegion", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region in which you create the meeting.

" + } + }, + "MediaPlacement": { + "target": "com.amazonaws.connect#MediaPlacement", + "traits": { + "smithy.api#documentation": "

The media placement for the meeting.

" + } + }, + "MeetingFeatures": { + "target": "com.amazonaws.connect#MeetingFeaturesConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the features available to a meeting.

" + } + }, + "MeetingId": { + "target": "com.amazonaws.connect#MeetingId", + "traits": { + "smithy.api#documentation": "

The Amazon Chime SDK meeting ID.

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

A meeting created using the Amazon Chime SDK.

" + } + }, + "com.amazonaws.connect#MeetingFeatureStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "UNAVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNAVAILABLE" + } + } + } + }, + "com.amazonaws.connect#MeetingFeaturesConfiguration": { + "type": "structure", + "members": { + "Audio": { + "target": "com.amazonaws.connect#AudioFeatures", + "traits": { + "smithy.api#documentation": "

The configuration settings for the audio features available to a meeting.

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

The configuration settings of the features available to a meeting.

" + } + }, + "com.amazonaws.connect#MeetingId": { + "type": "string" + }, "com.amazonaws.connect#Message": { "type": "string" }, @@ -19942,6 +21389,35 @@ } } }, + "com.amazonaws.connect#NewChatCreated": { + "type": "boolean" + }, + "com.amazonaws.connect#NewSessionDetails": { + "type": "structure", + "members": { + "SupportedMessagingContentTypes": { + "target": "com.amazonaws.connect#SupportedMessagingContentTypes", + "traits": { + "smithy.api#documentation": "

The supported chat message content types. Supported types are text/plain,\n text/markdown, application/json,\n application/vnd.amazonaws.connect.message.interactive, and\n application/vnd.amazonaws.connect.message.interactive.response.

\n

Content types must always contain text/plain. You can then put any other\n supported type in the list. For example, all the following lists are valid because they contain\n text/plain: [text/plain, text/markdown, application/json], \n [text/markdown, text/plain], [text/plain, application/json,\n application/vnd.amazonaws.connect.message.interactive.response].

" + } + }, + "ParticipantDetails": { + "target": "com.amazonaws.connect#ParticipantDetails" + }, + "Attributes": { + "target": "com.amazonaws.connect#Attributes", + "traits": { + "smithy.api#documentation": "

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.

\n

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute\n keys can include only alphanumeric, dash, and underscore characters.

" + } + }, + "StreamingConfiguration": { + "target": "com.amazonaws.connect#ChatStreamingConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "

Payload of chat properties to apply when starting a new contact.

" + } + }, "com.amazonaws.connect#NextToken": { "type": "string" }, @@ -20157,6 +21633,19 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.connect#OutputTypeNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message" + } + }, + "traits": { + "smithy.api#documentation": "

Thrown for analyzed content when requested OutputType was not enabled for a given contact.\n For example, if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction\n policy set in Contact flow.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, "com.amazonaws.connect#PEM": { "type": "string", "traits": { @@ -20166,6 +21655,20 @@ } } }, + "com.amazonaws.connect#ParticipantCapabilities": { + "type": "structure", + "members": { + "Video": { + "target": "com.amazonaws.connect#VideoCapability", + "traits": { + "smithy.api#documentation": "

The configuration having the video sharing capabilities for participants over the\n call.

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

The configuration for the allowed capabilities for participants present over the\n call.

" + } + }, "com.amazonaws.connect#ParticipantDetails": { "type": "structure", "members": { @@ -22004,6 +23507,12 @@ "traits": { "smithy.api#enumValue": "THIRD_PARTY_DID" } + }, + "SHORT_CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHORT_CODE" + } } } }, @@ -22863,7 +24372,7 @@ "QuickConnectType": { "target": "com.amazonaws.connect#QuickConnectType", "traits": { - "smithy.api#documentation": "

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are\n prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

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

The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are\n prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

", "smithy.api#required": {} } }, @@ -22984,7 +24493,7 @@ "QuickConnectType": { "target": "com.amazonaws.connect#QuickConnectType", "traits": { - "smithy.api#documentation": "

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are\n prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

" + "smithy.api#documentation": "

The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are\n prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

" } }, "LastModifiedTime": { @@ -23077,6 +24586,662 @@ "target": "com.amazonaws.connect#ReadOnlyFieldInfo" } }, + "com.amazonaws.connect#RealTimeContactAnalysisAttachment": { + "type": "structure", + "members": { + "AttachmentName": { + "target": "com.amazonaws.connect#AttachmentName", + "traits": { + "smithy.api#documentation": "

A case-sensitive name of the attachment being uploaded. Can be redacted.

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

Describes the MIME file type of the attachment. For a list of supported file types, see\n Feature\n specifications in the Amazon Connect Administrator\n Guide.

" + } + }, + "AttachmentId": { + "target": "com.amazonaws.connect#ArtifactId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the attachment.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.connect#ArtifactStatus", + "traits": { + "smithy.api#documentation": "

Status of the attachment.

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

Object that describes attached file.

" + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisAttachments": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisAttachment" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisCategoryDetails": { + "type": "structure", + "members": { + "PointsOfInterest": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisPointsOfInterest", + "traits": { + "smithy.api#documentation": "

List of PointOfInterest - objects describing a single match of a rule.

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

Provides information about the category rule that was matched.

" + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisCategoryName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisCharacterInterval": { + "type": "structure", + "members": { + "BeginOffsetChar": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisOffset", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The beginning of the character interval.

", + "smithy.api#required": {} + } + }, + "EndOffsetChar": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisOffset", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The end of the character interval.

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

Begin and end offsets for a part of text.

" + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisCharacterIntervals": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisCharacterInterval" + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisContentType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisEventType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisId256": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisIssueDetected": { + "type": "structure", + "members": { + "TranscriptItems": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisTranscriptItemsWithContent", + "traits": { + "smithy.api#documentation": "

List of the transcript items (segments) that are associated with a given issue.

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

Potential issues that are detected based on an artificial intelligence analysis of each turn\n in the conversation.

" + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisIssuesDetected": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisIssueDetected" + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisMatchedDetails": { + "type": "map", + "key": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisCategoryName" + }, + "value": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisCategoryDetails" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 150 + } + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisOffset": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisOutputType": { + "type": "enum", + "members": { + "Raw": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Raw" + } + }, + "Redacted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Redacted" + } + } + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisPointOfInterest": { + "type": "structure", + "members": { + "TranscriptItems": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisTranscriptItemsWithCharacterOffsets", + "traits": { + "smithy.api#documentation": "

List of the transcript items (segments) that are associated with a given point of interest.\n

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

The section of the contact transcript segment that category rule was detected.

" + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisPointsOfInterest": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisPointOfInterest" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisSegmentAttachments": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisId256", + "traits": { + "smithy.api#documentation": "

The identifier of the segment.

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

The identifier of the participant.

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

The role of the participant. For example, is it a customer, agent, or system.

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

The display name of the participant. Can be redacted.

" + } + }, + "Attachments": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisAttachments", + "traits": { + "smithy.api#documentation": "

List of objects describing an individual attachment.

", + "smithy.api#required": {} + } + }, + "Time": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisTimeData", + "traits": { + "smithy.api#documentation": "

Field describing the time of the event. It can have different representations of time.

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

Segment containing list of attachments.

" + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisSegmentCategories": { + "type": "structure", + "members": { + "MatchedDetails": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisMatchedDetails", + "traits": { + "smithy.api#documentation": "

Map between the name of the matched rule and RealTimeContactAnalysisCategoryDetails.

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

The matched category rules.

" + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisSegmentEvent": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisId256", + "traits": { + "smithy.api#documentation": "

The identifier of the contact event.

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

The identifier of the participant.

" + } + }, + "ParticipantRole": { + "target": "com.amazonaws.connect#ParticipantRole", + "traits": { + "smithy.api#documentation": "

The role of the participant. For example, is it a customer, agent, or system.

" + } + }, + "DisplayName": { + "target": "com.amazonaws.connect#DisplayName", + "traits": { + "smithy.api#documentation": "

The display name of the participant. Can be redacted.

" + } + }, + "EventType": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisEventType", + "traits": { + "smithy.api#documentation": "

Type of the event. For example,\n application/vnd.amazonaws.connect.event.participant.left.

", + "smithy.api#required": {} + } + }, + "Time": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisTimeData", + "traits": { + "smithy.api#documentation": "

Field describing the time of the event. It can have different representations of time.

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

Segment type describing a contact event.

" + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisSegmentIssues": { + "type": "structure", + "members": { + "IssuesDetected": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisIssuesDetected", + "traits": { + "smithy.api#documentation": "

List of the issues detected.

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

Segment type containing a list of detected issues.

" + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisSegmentTranscript": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisId256", + "traits": { + "smithy.api#documentation": "

The identifier of the transcript.

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

The identifier of the participant.

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

The role of the participant. For example, is it a customer, agent, or system.

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

The display name of the participant.

" + } + }, + "Content": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisTranscriptContent", + "traits": { + "smithy.api#documentation": "

The content of the transcript. Can be redacted.

", + "smithy.api#required": {} + } + }, + "ContentType": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisContentType", + "traits": { + "smithy.api#documentation": "

The type of content of the item. For example, text/plain.

" + } + }, + "Time": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisTimeData", + "traits": { + "smithy.api#documentation": "

Field describing the time of the event. It can have different representations of time.

", + "smithy.api#required": {} + } + }, + "Redaction": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisTranscriptItemRedaction", + "traits": { + "smithy.api#documentation": "

Object describing redaction that was applied to the transcript. If transcript has the field\n it means part of the transcript was redacted.

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

The sentiment detected for this piece of transcript.

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

The analyzed transcript segment.

" + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisSegmentType": { + "type": "enum", + "members": { + "Transcript": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Transcript" + } + }, + "Categories": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Categories" + } + }, + "Issues": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Issues" + } + }, + "Event": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Event" + } + }, + "Attachments": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Attachments" + } + } + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisSegmentTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisSegmentType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisSentimentLabel": { + "type": "enum", + "members": { + "POSITIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSITIVE" + } + }, + "NEGATIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEGATIVE" + } + }, + "NEUTRAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEUTRAL" + } + } + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + } + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisSupportedChannel": { + "type": "enum", + "members": { + "VOICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VOICE" + } + }, + "CHAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHAT" + } + } + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisTimeData": { + "type": "union", + "members": { + "AbsoluteTime": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisTimeInstant", + "traits": { + "smithy.api#documentation": "

Time represented in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,\n 2019-11-08T02:41:28.172Z.

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

Object describing time with which the segment is associated. It can have different\n representations of time. Currently supported: absoluteTime

" + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisTimeInstant": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisTranscriptContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16384 + } + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisTranscriptItemRedaction": { + "type": "structure", + "members": { + "CharacterOffsets": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisCharacterIntervals", + "traits": { + "smithy.api#documentation": "

List of character intervals each describing a part of the text that was redacted. For\n OutputType.Raw, part of the original text that contains data that can be redacted.\n For OutputType.Redacted, part of the string with redaction tag.

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

Object describing redaction applied to the segment.

" + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisTranscriptItemWithCharacterOffsets": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisId256", + "traits": { + "smithy.api#documentation": "

Transcript identifier. Matches the identifier from one of the TranscriptSegments.

", + "smithy.api#required": {} + } + }, + "CharacterOffsets": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisCharacterInterval", + "traits": { + "smithy.api#documentation": "

List of character intervals within transcript content/text.

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

Transcript representation containing Id and list of character intervals that are associated\n with analysis data. For example, this object within a\n RealTimeContactAnalysisPointOfInterest in Category.MatchedDetails\n would have character interval describing part of the text that matched category.

" + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisTranscriptItemWithContent": { + "type": "structure", + "members": { + "Content": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisTranscriptContent", + "traits": { + "smithy.api#documentation": "

Part of the transcript content that contains identified issue. Can be redacted

" + } + }, + "Id": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisId256", + "traits": { + "smithy.api#documentation": "

Transcript identifier. Matches the identifier from one of the TranscriptSegments.

", + "smithy.api#required": {} + } + }, + "CharacterOffsets": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisCharacterInterval" + } + }, + "traits": { + "smithy.api#documentation": "

Transcript representation containing Id, Content and list of character intervals that are\n associated with analysis data. For example, this object within an issue detected would describe\n both content that contains identified issue and intervals where that content is taken\n from.

" + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisTranscriptItemsWithCharacterOffsets": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisTranscriptItemWithCharacterOffsets" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.connect#RealTimeContactAnalysisTranscriptItemsWithContent": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisTranscriptItemWithContent" + } + }, + "com.amazonaws.connect#RealtimeContactAnalysisSegment": { + "type": "union", + "members": { + "Transcript": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisSegmentTranscript" + }, + "Categories": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisSegmentCategories" + }, + "Issues": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisSegmentIssues" + }, + "Event": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisSegmentEvent" + }, + "Attachments": { + "target": "com.amazonaws.connect#RealTimeContactAnalysisSegmentAttachments", + "traits": { + "smithy.api#documentation": "

The analyzed attachments.

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

An analyzed segment for a real-time analysis session.

" + } + }, + "com.amazonaws.connect#RealtimeContactAnalysisSegments": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RealtimeContactAnalysisSegment" + } + }, "com.amazonaws.connect#Reference": { "type": "structure", "members": { @@ -23301,7 +25466,7 @@ } ], "traits": { - "smithy.api#documentation": "

Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You\n can call this API only in the Amazon Web Services Region where the number was claimed.

\n \n

To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the\n Amazon Connect console.

\n

After releasing a phone number, the phone number enters into a cooldown period of 30 days.\n It cannot be searched for or claimed again until the period has ended. If you accidentally\n release a phone number, contact Amazon Web Services Support.

\n \n

If you plan to claim and release numbers frequently during a 30 day period,\n contact us for a service quota exception. Otherwise, it is possible you will be blocked from\n claiming and releasing any more numbers until 30 days past the oldest number\n released has expired.

\n

By default you can claim and release up to 200% of your maximum number of active\n phone numbers during any 30 day period. If you claim and release phone numbers using\n the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number\n service level quota, you will be blocked from claiming any more numbers until 30\n days past the oldest number released has expired.

\n

For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30\n day period you release 99, claim 99, and then release 99, you will have exceeded the\n 200% limit. At that point you are blocked from claiming any more numbers until you\n open an Amazon Web Services support ticket.

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

Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You\n can call this API only in the Amazon Web Services Region where the number was claimed.

\n \n

To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the\n Amazon Connect admin website.

\n

After releasing a phone number, the phone number enters into a cooldown period of 30 days.\n It cannot be searched for or claimed again until the period has ended. If you accidentally\n release a phone number, contact Amazon Web Services Support.

\n \n

If you plan to claim and release numbers frequently during a 30 day period,\n contact us for a service quota exception. Otherwise, it is possible you will be blocked from\n claiming and releasing any more numbers until 30 days past the oldest number\n released has expired.

\n

By default you can claim and release up to 200% of your maximum number of active\n phone numbers during any 30 day period. If you claim and release phone numbers using\n the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number\n service level quota, you will be blocked from claiming any more numbers until 30\n days past the oldest number released has expired.

\n

For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30\n day period you release 99, claim 99, and then release 99, you will have exceeded the\n 200% limit. At that point you are blocked from claiming any more numbers until you\n open an Amazon Web Services support ticket.

", "smithy.api#http": { "method": "DELETE", "uri": "/phone-number/{PhoneNumberId}", @@ -23605,6 +25770,12 @@ "traits": { "smithy.api#enumValue": "USER" } + }, + "PHONE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PHONE_NUMBER" + } } } }, @@ -24147,19 +26318,19 @@ "EventBridgeAction": { "target": "com.amazonaws.connect#EventBridgeActionDefinition", "traits": { - "smithy.api#documentation": "

Information about the EventBridge action.

\n

Supported only for TriggerEventSource values:\n OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable |\n OnPostChatAnalysisAvailable | OnContactEvaluationSubmit |\n OnMetricDataUpdate\n

" + "smithy.api#documentation": "

Information about the EventBridge action.

\n

Supported only for TriggerEventSource values:\n OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable |\n OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable |\n OnContactEvaluationSubmit | OnMetricDataUpdate\n

" } }, "AssignContactCategoryAction": { "target": "com.amazonaws.connect#AssignContactCategoryActionDefinition", "traits": { - "smithy.api#documentation": "

Information about the contact category action.

\n

Supported only for TriggerEventSource values:\n OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable |\n OnPostChatAnalysisAvailable | OnZendeskTicketCreate |\n OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate\n

" + "smithy.api#documentation": "

Information about the contact category action.

\n

Supported only for TriggerEventSource values:\n OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable |\n OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable |\n OnZendeskTicketCreate | OnZendeskTicketStatusUpdate |\n OnSalesforceCaseCreate\n

" } }, "SendNotificationAction": { "target": "com.amazonaws.connect#SendNotificationActionDefinition", "traits": { - "smithy.api#documentation": "

Information about the send notification action.

\n

Supported only for TriggerEventSource values:\n OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable |\n OnPostChatAnalysisAvailable | OnContactEvaluationSubmit |\n OnMetricDataUpdate\n

" + "smithy.api#documentation": "

Information about the send notification action.

\n

Supported only for TriggerEventSource values:\n OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable |\n OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable |\n OnContactEvaluationSubmit | OnMetricDataUpdate\n

" } } }, @@ -25733,6 +27904,101 @@ "target": "com.amazonaws.connect#SegmentAttributeValue" } }, + "com.amazonaws.connect#SendChatIntegrationEvent": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#SendChatIntegrationEventRequest" + }, + "output": { + "target": "com.amazonaws.connect#SendChatIntegrationEventResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Processes chat integration events from Amazon Web Services or external integrations to\n Amazon Connect. A chat integration event includes:

\n \n

When a chat integration event is sent with chat identifiers that do not map to an active\n chat contact, a new chat contact is also created before handling chat action.

\n

Access to this API is currently restricted to Amazon Pinpoint for supporting SMS\n integration.

", + "smithy.api#http": { + "method": "POST", + "uri": "/chat-integration-event", + "code": 200 + } + } + }, + "com.amazonaws.connect#SendChatIntegrationEventRequest": { + "type": "structure", + "members": { + "SourceId": { + "target": "com.amazonaws.connect#SourceId", + "traits": { + "smithy.api#documentation": "

External identifier of chat customer participant, used in part to uniquely identify a chat.\n For SMS, this is the E164 phone number of the chat customer participant.

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

Chat system identifier, used in part to uniquely identify chat. This is associated with the\n Amazon Connect instance and flow to be used to start chats. For SMS, this is the phone\n number destination of inbound SMS messages represented by an Amazon Pinpoint phone number ARN.

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

Classification of a channel. This is used in part to uniquely identify chat.

\n

Valid value: [\"connect:sms\"]\n

" + } + }, + "Event": { + "target": "com.amazonaws.connect#ChatEvent", + "traits": { + "smithy.api#documentation": "

Chat integration event payload

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

Contact properties to apply when starting a new chat. If the integration event is handled\n with an existing chat, this is ignored.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#SendChatIntegrationEventResponse": { + "type": "structure", + "members": { + "InitialContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

Identifier of chat contact used to handle integration event. This may be null if the\n integration event is not valid without an already existing chat contact.

" + } + }, + "NewChatCreated": { + "target": "com.amazonaws.connect#NewChatCreated", + "traits": { + "smithy.api#documentation": "

Whether handling the integration event resulted in creating a new chat or acting on existing\n chat.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#SendNotificationActionDefinition": { "type": "structure", "members": { @@ -25923,6 +28189,15 @@ "smithy.api#pattern": "^[a-zA-Z0-9_ -]+$" } }, + "com.amazonaws.connect#SourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, "com.amazonaws.connect#SourceType": { "type": "enum", "members": { @@ -25987,7 +28262,7 @@ "ContactFlowId": { "target": "com.amazonaws.connect#ContactFlowId", "traits": { - "smithy.api#documentation": "

The identifier of the flow for initiating the chat.\n To\n see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go\n to Routing, Contact Flows.\n Choose the flow. On the flow page, under the name of the flow, choose Show\n additional flow information. The ContactFlowId is the last part of the ARN, shown\n here in bold:

\n

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n

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

The identifier of the flow for initiating the chat.\n To\n see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the\n flow page, under the name of the flow, choose Show additional flow\n information. The ContactFlowId is the last part of the ARN, shown here in bold:

\n

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n

", "smithy.api#required": {} } }, @@ -26044,7 +28319,7 @@ "SegmentAttributes": { "target": "com.amazonaws.connect#SegmentAttributes", "traits": { - "smithy.api#documentation": "

A set of system defined key-value pairs stored on individual contact segments using an\n attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in\n flows.

\n

Attribute keys can include only alphanumeric, -, and _.

\n

This field can be used to show channel subtype, such as connect:Guide.

\n \n

The types application/vnd.amazonaws.connect.message.interactive and\n application/vnd.amazonaws.connect.message.interactive.response must be present in the\n SupportedMessagingContentTypes field of this API in order to set SegmentAttributes as {\n \"connect:Subtype\": {\"valueString\" : \"connect:Guide\" }}.

\n " + "smithy.api#documentation": "

A set of system defined key-value pairs stored on individual contact segments using an\n attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in\n flows.

\n

Attribute keys can include only alphanumeric, -, and _.

\n

This field can be used to show channel subtype, such as connect:Guide.

\n \n

The types application/vnd.amazonaws.connect.message.interactive and\n application/vnd.amazonaws.connect.message.interactive.response must be present in the\n SupportedMessagingContentTypes field of this API in order to set SegmentAttributes as {\n \"connect:Subtype\": {\"valueString\" : \"connect:Guide\" }}.

\n " } } }, @@ -26394,7 +28669,7 @@ "ContactFlowId": { "target": "com.amazonaws.connect#ContactFlowId", "traits": { - "smithy.api#documentation": "

The\n identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect\n console user interface, on the navigation menu go to Routing,\n Contact Flows. Choose the flow. On the flow page, under the\n name of the flow, choose Show additional flow information. The\n ContactFlowId is the last part of the ARN, shown here in bold:

\n

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n

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

The\n identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, on the\n navigation menu go to Routing, Contact\n Flows. Choose the flow. On the flow page, under the name of the flow, choose\n Show additional flow information. The ContactFlowId is the last\n part of the ARN, shown here in bold:

\n

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n

", "smithy.api#required": {} } }, @@ -26523,7 +28798,7 @@ "ContactFlowId": { "target": "com.amazonaws.connect#ContactFlowId", "traits": { - "smithy.api#documentation": "

The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the\n flow page, under the name of the flow, choose Show additional flow\n information. The ContactFlowId is the last part of the ARN, shown here in bold:

\n

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n

" + "smithy.api#documentation": "

The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website,\n on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose\n Show additional flow information. The ContactFlowId is the last\n part of the ARN, shown here in bold:

\n

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n

" } }, "Attributes": { @@ -26601,6 +28876,137 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#StartWebRTCContact": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#StartWebRTCContactRequest" + }, + "output": { + "target": "com.amazonaws.connect#StartWebRTCContactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It\n performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).

", + "smithy.api#http": { + "method": "PUT", + "uri": "/contact/webrtc", + "code": 200 + } + } + }, + "com.amazonaws.connect#StartWebRTCContactRequest": { + "type": "structure", + "members": { + "Attributes": { + "target": "com.amazonaws.connect#Attributes", + "traits": { + "smithy.api#documentation": "

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

\n

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys\n can include only alphanumeric, -, and _ characters.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

\n

The token is valid for 7 days after creation. If a contact is already started, the contact\n ID is returned.

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

The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the\n navigation menu go to Routing, Contact\n Flows. Choose the flow. On the flow page, under the name of the flow, choose\n Show additional flow information. The ContactFlowId is the last\n part of the ARN, shown here in bold:

\n

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n

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

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

Information about the video sharing capabilities of the participants (customer,\n agent).

" + } + }, + "ParticipantDetails": { + "target": "com.amazonaws.connect#ParticipantDetails", + "traits": { + "smithy.api#required": {} + } + }, + "RelatedContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The unique identifier for an Amazon Connect contact. This identifier is related to the\n contact starting.

" + } + }, + "References": { + "target": "com.amazonaws.connect#ContactReferences", + "traits": { + "smithy.api#documentation": "

A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have\n the following reference types at the time of creation: URL | NUMBER |\n STRING | DATE | EMAIL. ATTACHMENT is not a\n supported reference type during task creation.

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

A description of the task that is shown to an agent in the Contact Control Panel\n (CCP).

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#StartWebRTCContactResponse": { + "type": "structure", + "members": { + "ConnectionData": { + "target": "com.amazonaws.connect#ConnectionData", + "traits": { + "smithy.api#documentation": "

Information required for the client application (mobile application or website) to connect\n to the call.

" + } + }, + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact in this instance of Amazon Connect.

" + } + }, + "ParticipantId": { + "target": "com.amazonaws.connect#ParticipantId", + "traits": { + "smithy.api#documentation": "

The identifier for a contact participant. The ParticipantId for a contact\n participant is the same throughout the contact lifecycle.

" + } + }, + "ParticipantToken": { + "target": "com.amazonaws.connect#ParticipantToken", + "traits": { + "smithy.api#documentation": "

The token used by the contact participant to call the CreateParticipantConnection API. The participant token is valid for the lifetime of a\n contact participant.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#Statistic": { "type": "enum", "members": { @@ -27035,6 +29441,15 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#Subtype": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.connect#SuccessfulRequest": { "type": "structure", "members": { @@ -32348,6 +34763,17 @@ } } }, + "com.amazonaws.connect#VideoCapability": { + "type": "enum", + "members": { + "SEND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEND" + } + } + } + }, "com.amazonaws.connect#View": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/customer-profiles.json b/codegen/sdk-codegen/aws-models/customer-profiles.json index d75763f655c..cb48f8b807f 100644 --- a/codegen/sdk-codegen/aws-models/customer-profiles.json +++ b/codegen/sdk-codegen/aws-models/customer-profiles.json @@ -1500,6 +1500,9 @@ { "target": "com.amazonaws.customerprofiles#DeleteWorkflow" }, + { + "target": "com.amazonaws.customerprofiles#DetectProfileObjectType" + }, { "target": "com.amazonaws.customerprofiles#GetAutoMergingPreview" }, @@ -3085,6 +3088,109 @@ "smithy.api#documentation": "

Summary information about the Kinesis data stream

" } }, + "com.amazonaws.customerprofiles#DetectProfileObjectType": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#DetectProfileObjectTypeRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#DetectProfileObjectTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

The process of detecting profile object type mapping by using given objects.

", + "smithy.api#http": { + "method": "POST", + "uri": "/domains/{DomainName}/detect/object-types", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#DetectProfileObjectTypeRequest": { + "type": "structure", + "members": { + "Objects": { + "target": "com.amazonaws.customerprofiles#Objects", + "traits": { + "smithy.api#documentation": "

A string that is serialized from a JSON object.

", + "smithy.api#required": {} + } + }, + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.customerprofiles#DetectProfileObjectTypeResponse": { + "type": "structure", + "members": { + "DetectedProfileObjectTypes": { + "target": "com.amazonaws.customerprofiles#DetectedProfileObjectTypes", + "traits": { + "smithy.api#documentation": "

Detected ProfileObjectType mappings from given objects. A maximum of one mapping is supported.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.customerprofiles#DetectedProfileObjectType": { + "type": "structure", + "members": { + "SourceLastUpdatedTimestampFormat": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The format of sourceLastUpdatedTimestamp that was detected in fields.

" + } + }, + "Fields": { + "target": "com.amazonaws.customerprofiles#FieldMap", + "traits": { + "smithy.api#documentation": "

A map of the name and the ObjectType field.

" + } + }, + "Keys": { + "target": "com.amazonaws.customerprofiles#KeyMap", + "traits": { + "smithy.api#documentation": "

A list of unique keys that can be used to map data to a profile.

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

Contains ProfileObjectType mapping information from the model.

" + } + }, + "com.amazonaws.customerprofiles#DetectedProfileObjectTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.customerprofiles#DetectedProfileObjectType" + } + }, "com.amazonaws.customerprofiles#DomainList": { "type": "list", "member": { @@ -7335,6 +7441,19 @@ "target": "com.amazonaws.customerprofiles#typeName" } }, + "com.amazonaws.customerprofiles#Objects": { + "type": "list", + "member": { + "target": "com.amazonaws.customerprofiles#stringifiedJson" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.customerprofiles#Operator": { "type": "enum", "members": { diff --git a/codegen/sdk-codegen/aws-models/qbusiness.json b/codegen/sdk-codegen/aws-models/qbusiness.json new file mode 100644 index 00000000000..324cc5989dd --- /dev/null +++ b/codegen/sdk-codegen/aws-models/qbusiness.json @@ -0,0 +1,10260 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.qbusiness#AccessConfiguration": { + "type": "structure", + "members": { + "accessControls": { + "target": "com.amazonaws.qbusiness#AccessControls", + "traits": { + "smithy.api#documentation": "

A list of AccessControlList objects.

", + "smithy.api#required": {} + } + }, + "memberRelation": { + "target": "com.amazonaws.qbusiness#MemberRelation", + "traits": { + "smithy.api#documentation": "

Describes the member relation within the AccessControlList object.

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

Used to configure access permissions for a document.

" + } + }, + "com.amazonaws.qbusiness#AccessControl": { + "type": "structure", + "members": { + "principals": { + "target": "com.amazonaws.qbusiness#Principals", + "traits": { + "smithy.api#documentation": "

Contains a list of principals, where a principal can be either a USER or\n a GROUP. Each principal can be have the following type of document access:\n ALLOW or DENY.

", + "smithy.api#required": {} + } + }, + "memberRelation": { + "target": "com.amazonaws.qbusiness#MemberRelation", + "traits": { + "smithy.api#documentation": "

Describes the member relation within a principal list.

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

A list of principals. Each principal can be either a USER or a\n GROUP and can be designated document access permissions of either\n ALLOW or DENY.

" + } + }, + "com.amazonaws.qbusiness#AccessControls": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#AccessControl" + } + }, + "com.amazonaws.qbusiness#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.qbusiness#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

You don't have access to perform this action. Make sure you have the required\n permission policies and user accounts and try again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.qbusiness#ActionExecution": { + "type": "structure", + "members": { + "pluginId": { + "target": "com.amazonaws.qbusiness#PluginId", + "traits": { + "smithy.api#documentation": "

The identifier of the plugin the action is attached to.

", + "smithy.api#required": {} + } + }, + "payload": { + "target": "com.amazonaws.qbusiness#ActionExecutionPayload", + "traits": { + "smithy.api#documentation": "

A mapping of field names to the field values in input that an end user provides to\n Amazon Q requests to perform their plugin action.

", + "smithy.api#required": {} + } + }, + "payloadFieldNameSeparator": { + "target": "com.amazonaws.qbusiness#ActionPayloadFieldNameSeparator", + "traits": { + "smithy.api#documentation": "

A string used to retain information about the hierarchical contexts within an action\n execution event payload.

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

Performs an Amazon Q plugin action during a non-streaming chat\n conversation.

" + } + }, + "com.amazonaws.qbusiness#ActionExecutionPayload": { + "type": "map", + "key": { + "target": "com.amazonaws.qbusiness#ActionPayloadFieldKey" + }, + "value": { + "target": "com.amazonaws.qbusiness#ActionExecutionPayloadField" + } + }, + "com.amazonaws.qbusiness#ActionExecutionPayloadField": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.qbusiness#ActionPayloadFieldValue", + "traits": { + "smithy.api#documentation": "

The content of a user input field in an plugin action execution payload.

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

A user input field in an plugin action execution payload.

" + } + }, + "com.amazonaws.qbusiness#ActionPayloadFieldKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.qbusiness#ActionPayloadFieldNameSeparator": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.qbusiness#ActionPayloadFieldType": { + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + }, + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMBER" + } + }, + "ARRAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARRAY" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOOLEAN" + } + } + } + }, + "com.amazonaws.qbusiness#ActionPayloadFieldValue": { + "type": "document" + }, + "com.amazonaws.qbusiness#ActionReview": { + "type": "structure", + "members": { + "pluginId": { + "target": "com.amazonaws.qbusiness#PluginId", + "traits": { + "smithy.api#documentation": "

The identifier of the plugin associated with the action review.

" + } + }, + "pluginType": { + "target": "com.amazonaws.qbusiness#PluginType", + "traits": { + "smithy.api#documentation": "

The type of plugin.

" + } + }, + "payload": { + "target": "com.amazonaws.qbusiness#ActionReviewPayload", + "traits": { + "smithy.api#documentation": "

Field values that an end user needs to provide to Amazon Q for Amazon Q to\n perform the requested plugin action.

" + } + }, + "payloadFieldNameSeparator": { + "target": "com.amazonaws.qbusiness#ActionPayloadFieldNameSeparator", + "traits": { + "smithy.api#documentation": "

A string used to retain information about the hierarchical contexts within an action\n review payload.

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

An output event that Amazon Q returns to an user who wants to perform a plugin\n action during a non-streaming chat conversation. It contains information about the\n selected action with a list of possible user input fields, some pre-populated by\n Amazon Q.

" + } + }, + "com.amazonaws.qbusiness#ActionReviewPayload": { + "type": "map", + "key": { + "target": "com.amazonaws.qbusiness#ActionPayloadFieldKey" + }, + "value": { + "target": "com.amazonaws.qbusiness#ActionReviewPayloadField" + } + }, + "com.amazonaws.qbusiness#ActionReviewPayloadField": { + "type": "structure", + "members": { + "displayName": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The name of the field.

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

The display order of fields in a payload.

" + } + }, + "type": { + "target": "com.amazonaws.qbusiness#ActionPayloadFieldType", + "traits": { + "smithy.api#documentation": "

The type of field.

" + } + }, + "value": { + "target": "com.amazonaws.qbusiness#ActionPayloadFieldValue", + "traits": { + "smithy.api#documentation": "

The field value.

" + } + }, + "allowedValues": { + "target": "com.amazonaws.qbusiness#ActionReviewPayloadFieldAllowedValues", + "traits": { + "smithy.api#documentation": "

Information about the field values that an end user can use to provide to\n Amazon Q for Amazon Q to perform the requested plugin action.

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

Information about whether the field is required.

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

A user input field in an plugin action review payload.

" + } + }, + "com.amazonaws.qbusiness#ActionReviewPayloadFieldAllowedValue": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.qbusiness#ActionPayloadFieldValue", + "traits": { + "smithy.api#documentation": "

The field value.

" + } + }, + "displayValue": { + "target": "com.amazonaws.qbusiness#ActionPayloadFieldValue", + "traits": { + "smithy.api#documentation": "

The name of the field.

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

Information about the field values that an end user can use to provide to\n Amazon Q for Amazon Q to perform the requested plugin action.

" + } + }, + "com.amazonaws.qbusiness#ActionReviewPayloadFieldAllowedValues": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#ActionReviewPayloadFieldAllowedValue" + } + }, + "com.amazonaws.qbusiness#AmazonResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + } + } + }, + "com.amazonaws.qbusiness#Application": { + "type": "structure", + "members": { + "displayName": { + "target": "com.amazonaws.qbusiness#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Q application.

" + } + }, + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier for the Amazon Q application.

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

The Unix timestamp when the Amazon Q application was created.

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

The Unix timestamp when the Amazon Q application was last updated.

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

The status of the Amazon Q application. The application is ready to use when the\n status is ACTIVE.

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

Summary information for an Amazon Q application.

" + } + }, + "com.amazonaws.qbusiness#ApplicationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1284 + }, + "smithy.api#pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" + } + }, + "com.amazonaws.qbusiness#ApplicationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" + } + }, + "com.amazonaws.qbusiness#ApplicationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$" + } + }, + "com.amazonaws.qbusiness#ApplicationResource": { + "type": "resource", + "identifiers": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId" + } + }, + "create": { + "target": "com.amazonaws.qbusiness#CreateApplication" + }, + "read": { + "target": "com.amazonaws.qbusiness#GetApplication" + }, + "update": { + "target": "com.amazonaws.qbusiness#UpdateApplication" + }, + "delete": { + "target": "com.amazonaws.qbusiness#DeleteApplication" + }, + "list": { + "target": "com.amazonaws.qbusiness#ListApplications" + }, + "resources": [ + { + "target": "com.amazonaws.qbusiness#IndexResource" + }, + { + "target": "com.amazonaws.qbusiness#PluginResource" + }, + { + "target": "com.amazonaws.qbusiness#RetrieverResource" + }, + { + "target": "com.amazonaws.qbusiness#WebExperienceResource" + } + ], + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Application" + } + } + }, + "com.amazonaws.qbusiness#ApplicationStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } + } + }, + "com.amazonaws.qbusiness#Applications": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#Application" + } + }, + "com.amazonaws.qbusiness#AppliedAttachmentsConfiguration": { + "type": "structure", + "members": { + "attachmentsControlMode": { + "target": "com.amazonaws.qbusiness#AttachmentsControlMode", + "traits": { + "smithy.api#documentation": "

Information about whether file upload during chat functionality is activated for your\n application.

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

Configuration information about the file upload during chat feature for your\n application.

" + } + }, + "com.amazonaws.qbusiness#AttachmentInput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.qbusiness#AttachmentName", + "traits": { + "smithy.api#documentation": "

The name of the file.

", + "smithy.api#required": {} + } + }, + "data": { + "target": "com.amazonaws.qbusiness#Blob", + "traits": { + "smithy.api#documentation": "

The data contained within the uploaded file.

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

A file directly uploaded into a web experience chat.

" + } + }, + "com.amazonaws.qbusiness#AttachmentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^\\P{C}*$" + } + }, + "com.amazonaws.qbusiness#AttachmentOutput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.qbusiness#AttachmentName", + "traits": { + "smithy.api#documentation": "

The name of a file uploaded during chat.

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

The status of a file uploaded during chat.

" + } + }, + "error": { + "target": "com.amazonaws.qbusiness#ErrorDetail", + "traits": { + "smithy.api#documentation": "

An error associated with a file uploaded during chat.

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

The details of a file uploaded during chat.

" + } + }, + "com.amazonaws.qbusiness#AttachmentStatus": { + "type": "enum", + "members": { + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + } + } + }, + "com.amazonaws.qbusiness#AttachmentsConfiguration": { + "type": "structure", + "members": { + "attachmentsControlMode": { + "target": "com.amazonaws.qbusiness#AttachmentsControlMode", + "traits": { + "smithy.api#documentation": "

Status information about whether file upload functionality is activated or deactivated\n for your end user.

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

Configuration information for the file upload during chat feature.

" + } + }, + "com.amazonaws.qbusiness#AttachmentsControlMode": { + "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.qbusiness#AttachmentsInput": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#AttachmentInput" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.qbusiness#AttachmentsOutput": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#AttachmentOutput" + } + }, + "com.amazonaws.qbusiness#AttributeFilter": { + "type": "structure", + "members": { + "andAllFilters": { + "target": "com.amazonaws.qbusiness#AttributeFilters", + "traits": { + "smithy.api#documentation": "

Performs a logical AND operation on all supplied filters.

" + } + }, + "orAllFilters": { + "target": "com.amazonaws.qbusiness#AttributeFilters", + "traits": { + "smithy.api#documentation": "

Performs a logical OR operation on all supplied filters.

" + } + }, + "notFilter": { + "target": "com.amazonaws.qbusiness#AttributeFilter", + "traits": { + "smithy.api#documentation": "

Performs a logical NOT operation on all supplied filters.

" + } + }, + "equalsTo": { + "target": "com.amazonaws.qbusiness#DocumentAttribute", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "containsAll": { + "target": "com.amazonaws.qbusiness#DocumentAttribute", + "traits": { + "smithy.api#documentation": "

Returns true when a document contains all the specified document\n attributes or metadata fields.

" + } + }, + "containsAny": { + "target": "com.amazonaws.qbusiness#DocumentAttribute", + "traits": { + "smithy.api#documentation": "

Returns true when a document contains any of the specified document\n attributes or metadata fields.

" + } + }, + "greaterThan": { + "target": "com.amazonaws.qbusiness#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.

" + } + }, + "greaterThanOrEquals": { + "target": "com.amazonaws.qbusiness#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 Long.\n

" + } + }, + "lessThan": { + "target": "com.amazonaws.qbusiness#DocumentAttribute", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "lessThanOrEquals": { + "target": "com.amazonaws.qbusiness#DocumentAttribute", + "traits": { + "smithy.api#documentation": "

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

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

Enables filtering of Amazon Q web experience responses based on document\n attributes or metadata fields.

" + } + }, + "com.amazonaws.qbusiness#AttributeFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#AttributeFilter" + } + }, + "com.amazonaws.qbusiness#AttributeType": { + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + }, + "STRING_LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING_LIST" + } + }, + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMBER" + } + }, + "DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE" + } + } + } + }, + "com.amazonaws.qbusiness#AttributeValueOperator": { + "type": "enum", + "members": { + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + } + } + }, + "com.amazonaws.qbusiness#BasicAuthConfiguration": { + "type": "structure", + "members": { + "secretArn": { + "target": "com.amazonaws.qbusiness#SecretArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Secrets Manager secret that stores the basic authentication\n credentials used for plugin configuration..

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

The ARN of an IAM role used by Amazon Q to access the basic\n authentication credentials stored in a Secrets Manager secret.

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

Information about the basic authentication credentials used to configure a\n plugin.

" + } + }, + "com.amazonaws.qbusiness#BatchDeleteDocument": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#BatchDeleteDocumentRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#BatchDeleteDocumentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Asynchronously deletes one or more documents added using the\n BatchPutDocument API from an Amazon Q index.

\n

You can see the progress of the deletion, and any error messages related to the\n process, by using CloudWatch.

", + "smithy.api#http": { + "method": "POST", + "uri": "/applications/{applicationId}/indices/{indexId}/documents/delete" + } + } + }, + "com.amazonaws.qbusiness#BatchDeleteDocumentRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q index that contains the documents to\n delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "documents": { + "target": "com.amazonaws.qbusiness#DeleteDocuments", + "traits": { + "smithy.api#documentation": "

Documents deleted from the Amazon Q index.

", + "smithy.api#required": {} + } + }, + "dataSourceSyncId": { + "target": "com.amazonaws.qbusiness#ExecutionId", + "traits": { + "smithy.api#documentation": "

The identifier of the data source sync during which the documents were deleted.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#BatchDeleteDocumentResponse": { + "type": "structure", + "members": { + "failedDocuments": { + "target": "com.amazonaws.qbusiness#FailedDocuments", + "traits": { + "smithy.api#documentation": "

A list of documents that couldn't be removed from the Amazon Q index. Each entry\n contains an error message that indicates why the document couldn't be removed from the\n index.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#BatchPutDocument": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#BatchPutDocumentRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#BatchPutDocumentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds one or more documents to an Amazon Q index.

\n

You use this API to:

\n \n

You can see the progress of the deletion, and any error messages related to the\n process, by using CloudWatch.

", + "smithy.api#http": { + "method": "POST", + "uri": "/applications/{applicationId}/indices/{indexId}/documents" + } + } + }, + "com.amazonaws.qbusiness#BatchPutDocumentRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q index to add the documents to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "documents": { + "target": "com.amazonaws.qbusiness#Documents", + "traits": { + "smithy.api#documentation": "

One or more documents to add to the index.

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

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3\n bucket.

" + } + }, + "dataSourceSyncId": { + "target": "com.amazonaws.qbusiness#ExecutionId", + "traits": { + "smithy.api#documentation": "

The identifier of the data source sync during which the documents were added.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#BatchPutDocumentResponse": { + "type": "structure", + "members": { + "failedDocuments": { + "target": "com.amazonaws.qbusiness#FailedDocuments", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#Blob": { + "type": "blob" + }, + "com.amazonaws.qbusiness#BlockedPhrase": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 36 + }, + "smithy.api#pattern": "^\\P{C}*$" + } + }, + "com.amazonaws.qbusiness#BlockedPhrases": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#BlockedPhrase" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.qbusiness#BlockedPhrasesConfiguration": { + "type": "structure", + "members": { + "blockedPhrases": { + "target": "com.amazonaws.qbusiness#BlockedPhrases", + "traits": { + "smithy.api#documentation": "

A list of phrases blocked from a Amazon Q web experience chat.

" + } + }, + "systemMessageOverride": { + "target": "com.amazonaws.qbusiness#SystemMessageOverride", + "traits": { + "smithy.api#documentation": "

The configured custom message displayed to an end user informing them that they've\n used a blocked phrase during chat.

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

Provides information about the phrases blocked from chat by your chat control\n configuration.

" + } + }, + "com.amazonaws.qbusiness#BlockedPhrasesConfigurationUpdate": { + "type": "structure", + "members": { + "blockedPhrasesToCreateOrUpdate": { + "target": "com.amazonaws.qbusiness#BlockedPhrases", + "traits": { + "smithy.api#documentation": "

Creates or updates a blocked phrases configuration in your Amazon Q\n application.

" + } + }, + "blockedPhrasesToDelete": { + "target": "com.amazonaws.qbusiness#BlockedPhrases", + "traits": { + "smithy.api#documentation": "

Deletes a blocked phrases configuration in your Amazon Q application.

" + } + }, + "systemMessageOverride": { + "target": "com.amazonaws.qbusiness#SystemMessageOverride", + "traits": { + "smithy.api#documentation": "

The configured custom message displayed to your end user when they use blocked phrase\n during chat.

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

Updates a blocked phrases configuration in your Amazon Q application.

" + } + }, + "com.amazonaws.qbusiness#ChatSync": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#ChatSyncInput" + }, + "output": { + "target": "com.amazonaws.qbusiness#ChatSyncOutput" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#LicenseNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts or continues a non-streaming Amazon Q conversation.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/conversations?sync", + "method": "POST" + } + } + }, + "com.amazonaws.qbusiness#ChatSyncInput": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application linked to the Amazon Q\n conversation.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userId": { + "target": "com.amazonaws.qbusiness#UserId", + "traits": { + "smithy.api#documentation": "

The identifier of the user attached to the chat input.

", + "smithy.api#httpQuery": "userId", + "smithy.api#required": {} + } + }, + "userGroups": { + "target": "com.amazonaws.qbusiness#UserGroups", + "traits": { + "smithy.api#documentation": "

The groups that a user associated with the chat input belongs to.

", + "smithy.api#httpQuery": "userGroups" + } + }, + "userMessage": { + "target": "com.amazonaws.qbusiness#UserMessage", + "traits": { + "smithy.api#documentation": "

A end user message in a conversation.

" + } + }, + "attachments": { + "target": "com.amazonaws.qbusiness#AttachmentsInput", + "traits": { + "smithy.api#documentation": "

A list of files uploaded directly during chat. You can upload a maximum of 5 files of\n upto 10 MB each.

" + } + }, + "actionExecution": { + "target": "com.amazonaws.qbusiness#ActionExecution", + "traits": { + "smithy.api#documentation": "

A request from an end user to perform an Amazon Q plugin action.

" + } + }, + "conversationId": { + "target": "com.amazonaws.qbusiness#ConversationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q conversation.

" + } + }, + "parentMessageId": { + "target": "com.amazonaws.qbusiness#MessageId", + "traits": { + "smithy.api#documentation": "

The identifier of the previous end user text input message in a conversation.

" + } + }, + "attributeFilter": { + "target": "com.amazonaws.qbusiness#AttributeFilter", + "traits": { + "smithy.api#documentation": "

Enables filtering of Amazon Q web experience responses based on document\n attributes or metadata fields.

" + } + }, + "clientToken": { + "target": "com.amazonaws.qbusiness#ClientToken", + "traits": { + "smithy.api#documentation": "

A token that you provide to identify a chat request.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#ChatSyncOutput": { + "type": "structure", + "members": { + "conversationId": { + "target": "com.amazonaws.qbusiness#ConversationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q conversation.

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

An AI-generated message in a conversation.

" + } + }, + "systemMessageId": { + "target": "com.amazonaws.qbusiness#MessageId", + "traits": { + "smithy.api#documentation": "

The identifier of an Amazon Q AI generated message within the\n conversation.

" + } + }, + "userMessageId": { + "target": "com.amazonaws.qbusiness#MessageId", + "traits": { + "smithy.api#documentation": "

The identifier of an Amazon Q end user text input message within the\n conversation.

" + } + }, + "actionReview": { + "target": "com.amazonaws.qbusiness#ActionReview", + "traits": { + "smithy.api#documentation": "

A request from Amazon Q to the end user for information Amazon Q needs to\n successfully complete a requested plugin action.

" + } + }, + "sourceAttributions": { + "target": "com.amazonaws.qbusiness#SourceAttributions", + "traits": { + "smithy.api#documentation": "

The source documents used to generate the conversation response.

" + } + }, + "failedAttachments": { + "target": "com.amazonaws.qbusiness#AttachmentsOutput", + "traits": { + "smithy.api#documentation": "

A list of files which failed to upload during chat.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.qbusiness#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.qbusiness#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The message describing a ConflictException.

", + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The identifier of the resource affected.

", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The type of the resource affected.

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

You are trying to perform an action that conflicts with the current status of your\n resource. Fix any inconsistences with your resources and try again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.qbusiness#ContentBlockerRule": { + "type": "structure", + "members": { + "systemMessageOverride": { + "target": "com.amazonaws.qbusiness#SystemMessageOverride", + "traits": { + "smithy.api#documentation": "

The configured custom message displayed to an end user informing them that they've\n used a blocked phrase during chat.

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

A rule for configuring how Amazon Q responds when it encounters a a blocked\n topic. You can configure a custom message to inform your end users that they have asked\n about a restricted topic and suggest any next steps they should take.

" + } + }, + "com.amazonaws.qbusiness#ContentRetrievalRule": { + "type": "structure", + "members": { + "eligibleDataSources": { + "target": "com.amazonaws.qbusiness#EligibleDataSources", + "traits": { + "smithy.api#documentation": "

Specifies data sources in a Amazon Q application to use for content\n generation.

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

Rules for retrieving content from data sources connected to a Amazon Q\n application for a specific topic control configuration.

" + } + }, + "com.amazonaws.qbusiness#ContentType": { + "type": "enum", + "members": { + "PDF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PDF" + } + }, + "HTML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTML" + } + }, + "MS_WORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MS_WORD" + } + }, + "PLAIN_TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLAIN_TEXT" + } + }, + "PPT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PPT" + } + }, + "RTF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RTF" + } + }, + "XML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XML" + } + }, + "XSLT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XSLT" + } + }, + "MS_EXCEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MS_EXCEL" + } + }, + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + }, + "MD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MD" + } + } + } + }, + "com.amazonaws.qbusiness#Conversation": { + "type": "structure", + "members": { + "conversationId": { + "target": "com.amazonaws.qbusiness#ConversationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q conversation.

" + } + }, + "title": { + "target": "com.amazonaws.qbusiness#ConversationTitle", + "traits": { + "smithy.api#documentation": "

The title of the conversation.

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

The start time of the conversation.

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

A conversation in an Amazon Q application.

" + } + }, + "com.amazonaws.qbusiness#ConversationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" + } + }, + "com.amazonaws.qbusiness#ConversationTitle": { + "type": "string" + }, + "com.amazonaws.qbusiness#Conversations": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#Conversation" + } + }, + "com.amazonaws.qbusiness#CreateApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#CreateApplicationRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#CreateApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:GetApplication", + "qbusiness:TagResource", + "qbusiness:ListTagsForResource", + "iam:PassRole", + "kms:DescribeKey", + "kms:CreateGrant" + ], + "smithy.api#documentation": "

Creates an Amazon Q application.

", + "smithy.api#http": { + "uri": "/applications", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#CreateApplicationRequest": { + "type": "structure", + "members": { + "displayName": { + "target": "com.amazonaws.qbusiness#ApplicationName", + "traits": { + "smithy.api#documentation": "

A name for the Amazon Q application.

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

The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon\n CloudWatch logs and metrics.

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

A description for the Amazon Q application.

" + } + }, + "encryptionConfiguration": { + "target": "com.amazonaws.qbusiness#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

The identifier of the KMS key that is used to encrypt your data.\n Amazon Q doesn't support asymmetric keys.

" + } + }, + "tags": { + "target": "com.amazonaws.qbusiness#Tags", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

A list of key-value pairs that identify or categorize your Amazon Q application.\n You can also use tags to help control access to the application. Tag keys and values can\n consist of Unicode letters, digits, white space, and any of the following symbols: _ . :\n / = + - @.

" + } + }, + "clientToken": { + "target": "com.amazonaws.qbusiness#ClientToken", + "traits": { + "smithy.api#documentation": "

A token that you provide to identify the request to create your Amazon Q\n application.

", + "smithy.api#idempotencyToken": {} + } + }, + "attachmentsConfiguration": { + "target": "com.amazonaws.qbusiness#AttachmentsConfiguration", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

An option to allow end users to upload files directly during chat.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#CreateApplicationResponse": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application.

" + } + }, + "applicationArn": { + "target": "com.amazonaws.qbusiness#ApplicationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q application.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#CreateDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#CreateDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#CreateDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:GetDataSource", + "qbusiness:TagResource", + "qbusiness:ListTagsForResource", + "iam:PassRole" + ], + "smithy.api#documentation": "

Creates a data source connector for an Amazon Q application.

\n

\n CreateDataSource is a synchronous operation. The operation returns 200 if\n the data source was successfully created. Otherwise, an exception is raised.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/indices/{indexId}/datasources", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#CreateDataSourceRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application the data source will be attached\n to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the index that you want to use with the data source\n connector.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "displayName": { + "target": "com.amazonaws.qbusiness#DataSourceName", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

A name for the data source connector.

", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.qbusiness#DataSourceConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration information to connect to your data source repository. For configuration\n templates for your specific data source, see Supported\n connectors.

", + "smithy.api#required": {} + } + }, + "vpcConfiguration": { + "target": "com.amazonaws.qbusiness#DataSourceVpcConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect\n to your data source. For more information, see Using\n Amazon VPC with Amazon Q connectors.

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

A description for the data source connector.

" + } + }, + "tags": { + "target": "com.amazonaws.qbusiness#Tags", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

A list of key-value pairs that identify or categorize the data source connector. You\n can also use tags to help control access to the data source connector. Tag keys and\n values can consist of Unicode letters, digits, white space, and any of the following\n symbols: _ . : / = + - @.

" + } + }, + "syncSchedule": { + "target": "com.amazonaws.qbusiness#SyncSchedule", + "traits": { + "smithy.api#documentation": "

Sets the frequency for Amazon Q to check the documents in your data source\n repository and update your index. If you don't set a schedule, Amazon Q won't\n periodically update the index.

\n

Specify a cron- format schedule string or an empty string to indicate\n that the index is updated on demand. You can't specify the Schedule\n parameter when the Type parameter is set to CUSTOM. If you do,\n you receive a ValidationException exception.

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

The Amazon Resource Name (ARN) of an IAM role with permission to access\n the data source and required resources.

" + } + }, + "clientToken": { + "target": "com.amazonaws.qbusiness#ClientToken", + "traits": { + "smithy.api#documentation": "

A token you provide to identify a request to create a data source connector. Multiple\n calls to the CreateDataSource API with the same client token will create\n only one data source connector.

", + "smithy.api#idempotencyToken": {} + } + }, + "documentEnrichmentConfiguration": { + "target": "com.amazonaws.qbusiness#DocumentEnrichmentConfiguration" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#CreateDataSourceResponse": { + "type": "structure", + "members": { + "dataSourceId": { + "target": "com.amazonaws.qbusiness#DataSourceId", + "traits": { + "smithy.api#documentation": "

The identifier of the data source connector.

" + } + }, + "dataSourceArn": { + "target": "com.amazonaws.qbusiness#DataSourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a data source in an Amazon Q application.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#CreateIndex": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#CreateIndexRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#CreateIndexResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:GetIndex", + "qbusiness:TagResource", + "qbusiness:ListTagsForResource" + ], + "smithy.api#documentation": "

Creates an Amazon Q index.

\n

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

\n

Once the index is active, you can index your documents using the \n BatchPutDocument\n API or the \n CreateDataSource\n API.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/indices", + "method": "POST" + } + } + }, + "com.amazonaws.qbusiness#CreateIndexRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application using the index.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "displayName": { + "target": "com.amazonaws.qbusiness#IndexName", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

A name for the Amazon Q index.

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

A description for the Amazon Q index.

" + } + }, + "tags": { + "target": "com.amazonaws.qbusiness#Tags", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

A list of key-value pairs that identify or categorize the index. You can also use tags\n to help control access to the index. Tag keys and values can consist of Unicode letters,\n digits, white space, and any of the following symbols: _ . : / = + - @.

" + } + }, + "capacityConfiguration": { + "target": "com.amazonaws.qbusiness#IndexCapacityConfiguration", + "traits": { + "smithy.api#documentation": "

The capacity units you want to provision for your index. You can add and remove\n capacity to fit your usage needs.

" + } + }, + "clientToken": { + "target": "com.amazonaws.qbusiness#ClientToken", + "traits": { + "smithy.api#documentation": "

A token that you provide to identify the request to create an index. Multiple calls to\n the CreateIndex API with the same client token will create only one\n index.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#CreateIndexResponse": { + "type": "structure", + "members": { + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier for the Amazon Q index.

" + } + }, + "indexArn": { + "target": "com.amazonaws.qbusiness#IndexArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Q index.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#CreatePlugin": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#CreatePluginRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#CreatePluginResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:GetPlugin", + "qbusiness:TagResource", + "qbusiness:ListTagsForResource", + "iam:PassRole" + ], + "smithy.api#documentation": "

Creates an Amazon Q plugin.

", + "smithy.api#http": { + "method": "POST", + "uri": "/applications/{applicationId}/plugins" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#CreatePluginRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the application that will contain the plugin.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "displayName": { + "target": "com.amazonaws.qbusiness#PluginName", + "traits": { + "smithy.api#documentation": "

A the name for your plugin.

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

The type of plugin you want to create.

", + "smithy.api#required": {} + } + }, + "serverUrl": { + "target": "com.amazonaws.qbusiness#Url", + "traits": { + "smithy.api#documentation": "

The source URL used for plugin configuration.

", + "smithy.api#required": {} + } + }, + "authConfiguration": { + "target": "com.amazonaws.qbusiness#PluginAuthConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.qbusiness#Tags", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

A list of key-value pairs that identify or categorize the data source connector. You\n can also use tags to help control access to the data source connector. Tag keys and\n values can consist of Unicode letters, digits, white space, and any of the following\n symbols: _ . : / = + - @.

" + } + }, + "clientToken": { + "target": "com.amazonaws.qbusiness#ClientToken", + "traits": { + "smithy.api#documentation": "

A token that you provide to identify the request to create your Amazon Q\n plugin.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#CreatePluginResponse": { + "type": "structure", + "members": { + "pluginId": { + "target": "com.amazonaws.qbusiness#PluginId", + "traits": { + "smithy.api#documentation": "

The identifier of the plugin created.

" + } + }, + "pluginArn": { + "target": "com.amazonaws.qbusiness#PluginArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a plugin.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#CreateRetriever": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#CreateRetrieverRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#CreateRetrieverResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:TagResource", + "qbusiness:ListTagsForResource", + "qbusiness:GetRetriever", + "iam:PassRole" + ], + "smithy.api#documentation": "

Adds a retriever to your Amazon Q application.

", + "smithy.api#http": { + "method": "POST", + "uri": "/applications/{applicationId}/retrievers" + } + } + }, + "com.amazonaws.qbusiness#CreateRetrieverRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of your Amazon Q application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.qbusiness#RetrieverType", + "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", + "smithy.api#documentation": "

The type of retriever you are using.

", + "smithy.api#required": {} + } + }, + "displayName": { + "target": "com.amazonaws.qbusiness#RetrieverName", + "traits": { + "smithy.api#documentation": "

The name of your retriever.

", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.qbusiness#RetrieverConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.qbusiness#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role used by Amazon Q to access the basic\n authentication credentials stored in a Secrets Manager secret.

" + } + }, + "clientToken": { + "target": "com.amazonaws.qbusiness#ClientToken", + "traits": { + "smithy.api#documentation": "

A token that you provide to identify the request to create your Amazon Q\n application retriever.

", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.qbusiness#Tags", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

A list of key-value pairs that identify or categorize the retriever. You can also use\n tags to help control access to the retriever. Tag keys and values can consist of Unicode\n letters, digits, white space, and any of the following symbols: _ . : / = + - @.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#CreateRetrieverResponse": { + "type": "structure", + "members": { + "retrieverId": { + "target": "com.amazonaws.qbusiness#RetrieverId", + "traits": { + "smithy.api#documentation": "

The identifier of the retriever you are using.

" + } + }, + "retrieverArn": { + "target": "com.amazonaws.qbusiness#RetrieverArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role associated with a retriever.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#CreateUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#CreateUserRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#CreateUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a universally unique identifier (UUID) mapped to a list of local user ids\n within an application.

", + "smithy.api#http": { + "method": "POST", + "uri": "/applications/{applicationId}/users" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#CreateUserRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the application for which the user mapping will be created.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userId": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The user emails attached to a user mapping.

", + "smithy.api#required": {} + } + }, + "userAliases": { + "target": "com.amazonaws.qbusiness#UserAliases", + "traits": { + "smithy.api#documentation": "

The list of user aliases in the mapping.

", + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "clientToken": { + "target": "com.amazonaws.qbusiness#ClientToken", + "traits": { + "smithy.api#documentation": "

A token that you provide to identify the request to create your Amazon Q user\n mapping.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#CreateUserResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#CreateWebExperience": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#CreateWebExperienceRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#CreateWebExperienceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:GetWebExperience", + "qbusiness:TagResource", + "qbusiness:ListTagsForResource", + "iam:PassRole" + ], + "smithy.api#documentation": "

Creates an Amazon Q web experience.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/experiences", + "method": "POST" + } + } + }, + "com.amazonaws.qbusiness#CreateWebExperienceRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q web experience.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "title": { + "target": "com.amazonaws.qbusiness#WebExperienceTitle", + "traits": { + "smithy.api#documentation": "

The title for your Amazon Q web experience.

" + } + }, + "subtitle": { + "target": "com.amazonaws.qbusiness#WebExperienceSubtitle", + "traits": { + "smithy.api#documentation": "

A subtitle to personalize your Amazon Q web experience.

" + } + }, + "welcomeMessage": { + "target": "com.amazonaws.qbusiness#WebExperienceWelcomeMessage", + "traits": { + "smithy.api#documentation": "

The customized welcome message for end users of an Amazon Q web\n experience.

" + } + }, + "samplePromptsControlMode": { + "target": "com.amazonaws.qbusiness#WebExperienceSamplePromptsControlMode", + "traits": { + "smithy.api#documentation": "

Determines whether sample prompts are enabled in the web experience for an end\n user.

" + } + }, + "tags": { + "target": "com.amazonaws.qbusiness#Tags", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

A list of key-value pairs that identify or categorize your Amazon Q web\n experience. You can also use tags to help control access to the web experience. Tag keys\n and values can consist of Unicode letters, digits, white space, and any of the following\n symbols: _ . : / = + - @.

" + } + }, + "clientToken": { + "target": "com.amazonaws.qbusiness#ClientToken", + "traits": { + "smithy.api#documentation": "

A token you provide to identify a request to create an Amazon Q web experience.\n

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#CreateWebExperienceResponse": { + "type": "structure", + "members": { + "webExperienceId": { + "target": "com.amazonaws.qbusiness#WebExperienceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q web experience.

" + } + }, + "webExperienceArn": { + "target": "com.amazonaws.qbusiness#WebExperienceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Q web experience.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#DataSource": { + "type": "structure", + "members": { + "displayName": { + "target": "com.amazonaws.qbusiness#DataSourceName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Q data source.

" + } + }, + "dataSourceId": { + "target": "com.amazonaws.qbusiness#DataSourceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q data source.

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

The type of the Amazon Q data source.

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

The Unix timestamp when the Amazon Q data source was created.

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

The Unix timestamp when the Amazon Q data source was last updated.

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

The status of the Amazon Q data source.

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

A data source in an Amazon Q application.

" + } + }, + "com.amazonaws.qbusiness#DataSourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1284 + }, + "smithy.api#pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" + } + }, + "com.amazonaws.qbusiness#DataSourceConfiguration": { + "type": "document", + "traits": { + "smithy.api#documentation": "

Provides the configuration information for an Amazon Q data source.

" + } + }, + "com.amazonaws.qbusiness#DataSourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" + } + }, + "com.amazonaws.qbusiness#DataSourceIds": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#DataSourceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.qbusiness#DataSourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$" + } + }, + "com.amazonaws.qbusiness#DataSourceResource": { + "type": "resource", + "identifiers": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId" + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId" + }, + "dataSourceId": { + "target": "com.amazonaws.qbusiness#DataSourceId" + } + }, + "create": { + "target": "com.amazonaws.qbusiness#CreateDataSource" + }, + "read": { + "target": "com.amazonaws.qbusiness#GetDataSource" + }, + "update": { + "target": "com.amazonaws.qbusiness#UpdateDataSource" + }, + "delete": { + "target": "com.amazonaws.qbusiness#DeleteDataSource" + }, + "list": { + "target": "com.amazonaws.qbusiness#ListDataSources" + }, + "traits": { + "aws.cloudformation#cfnResource": { + "name": "DataSource" + } + } + }, + "com.amazonaws.qbusiness#DataSourceStatus": { + "type": "enum", + "members": { + "PENDING_CREATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_CREATION" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } + } + }, + "com.amazonaws.qbusiness#DataSourceSyncJob": { + "type": "structure", + "members": { + "executionId": { + "target": "com.amazonaws.qbusiness#ExecutionId", + "traits": { + "smithy.api#documentation": "

The identifier of a data source synchronization job.

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

The Unix time stamp when the data source synchronization job started.

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

The Unix timestamp when the synchronization job completed.

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

The status of the synchronization job. When the Status field is set to\n SUCCEEDED, the synchronization job is done. If the status code is\n FAILED, the ErrorCode and ErrorMessage fields\n give you the reason for the failure.

" + } + }, + "error": { + "target": "com.amazonaws.qbusiness#ErrorDetail", + "traits": { + "smithy.api#documentation": "

If the Status field is set to FAILED, the\n ErrorCode field indicates the reason the synchronization failed.

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

If the reason that the synchronization failed is due to an error with the underlying\n data source, this field contains a code that identifies the error.

" + } + }, + "metrics": { + "target": "com.amazonaws.qbusiness#DataSourceSyncJobMetrics", + "traits": { + "smithy.api#documentation": "

Maps a batch delete document request to a specific data source sync job. This is\n optional and should only be supplied when documents are deleted by a data source\n connector.

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

Provides information about an Amazon Q data source connector synchronization\n job.

" + } + }, + "com.amazonaws.qbusiness#DataSourceSyncJobMetrics": { + "type": "structure", + "members": { + "documentsAdded": { + "target": "com.amazonaws.qbusiness#MetricValue", + "traits": { + "smithy.api#documentation": "

The current count of documents added from the data source during the data source\n sync.

" + } + }, + "documentsModified": { + "target": "com.amazonaws.qbusiness#MetricValue", + "traits": { + "smithy.api#documentation": "

The current count of documents modified in the data source during the data source\n sync.

" + } + }, + "documentsDeleted": { + "target": "com.amazonaws.qbusiness#MetricValue", + "traits": { + "smithy.api#documentation": "

The current count of documents deleted from the data source during the data source\n sync.

" + } + }, + "documentsFailed": { + "target": "com.amazonaws.qbusiness#MetricValue", + "traits": { + "smithy.api#documentation": "

The current count of documents that failed to sync from the data source during the\n data source sync.

" + } + }, + "documentsScanned": { + "target": "com.amazonaws.qbusiness#MetricValue", + "traits": { + "smithy.api#documentation": "

The current count of documents crawled by the ongoing sync job in the data\n source.

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

Maps a batch delete document request to a specific Amazon Q data source connector\n sync job.

" + } + }, + "com.amazonaws.qbusiness#DataSourceSyncJobStatus": { + "type": "enum", + "members": { + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "SYNCING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNCING" + } + }, + "INCOMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCOMPLETE" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "ABORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABORTED" + } + }, + "SYNCING_INDEXING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNCING_INDEXING" + } + } + } + }, + "com.amazonaws.qbusiness#DataSourceSyncJobs": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#DataSourceSyncJob" + } + }, + "com.amazonaws.qbusiness#DataSourceUserId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^\\P{C}*$" + } + }, + "com.amazonaws.qbusiness#DataSourceVpcConfiguration": { + "type": "structure", + "members": { + "subnetIds": { + "target": "com.amazonaws.qbusiness#SubnetIds", + "traits": { + "smithy.api#documentation": "

A list of identifiers for subnets within your Amazon VPC. The subnets should\n be able to connect to each other in the VPC, and they should have outgoing access to the\n Internet through a NAT device.

", + "smithy.api#required": {} + } + }, + "securityGroupIds": { + "target": "com.amazonaws.qbusiness#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

A list of identifiers of security groups within your Amazon VPC. The security\n groups should enable Amazon Q to connect to the data source.

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

Provides configuration information needed to connect to an Amazon VPC (Virtual\n Private Cloud).

" + } + }, + "com.amazonaws.qbusiness#DataSources": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#DataSource" + } + }, + "com.amazonaws.qbusiness#DeleteApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#DeleteApplicationRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#DeleteApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:GetApplication", + "kms:RetireGrant" + ], + "smithy.api#documentation": "

Deletes an Amazon Q application.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#DeleteApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#DeleteApplicationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#DeleteChatControlsConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#DeleteChatControlsConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#DeleteChatControlsConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes chat controls configured for an existing Amazon Q application.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/chatcontrols", + "method": "DELETE", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#DeleteChatControlsConfigurationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the application the chat controls have been configured for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#DeleteChatControlsConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#DeleteConversation": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#DeleteConversationRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#DeleteConversationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#LicenseNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Amazon Q web experience conversation.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/conversations/{conversationId}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#DeleteConversationRequest": { + "type": "structure", + "members": { + "conversationId": { + "target": "com.amazonaws.qbusiness#ConversationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q web experience conversation being deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application associated with the\n conversation.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userId": { + "target": "com.amazonaws.qbusiness#UserId", + "traits": { + "smithy.api#documentation": "

The identifier of the user who is deleting the conversation.

", + "smithy.api#httpQuery": "userId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#DeleteConversationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#DeleteDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#DeleteDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#DeleteDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:GetDataSource" + ], + "smithy.api#documentation": "

Deletes an Amazon Q data source connector. While the data source is being\n deleted, the Status field returned by a call to the\n DescribeDataSource API is set to DELETING.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#DeleteDataSourceRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application used with the data source\n connector.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the index used with the data source connector.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.qbusiness#DataSourceId", + "traits": { + "smithy.api#documentation": "

The identifier of the data source connector that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#DeleteDataSourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#DeleteDocument": { + "type": "structure", + "members": { + "documentId": { + "target": "com.amazonaws.qbusiness#DocumentId", + "traits": { + "smithy.api#documentation": "

The identifier of the deleted document.

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

A document deleted from an Amazon Q data source connector.

" + } + }, + "com.amazonaws.qbusiness#DeleteDocuments": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#DeleteDocument" + } + }, + "com.amazonaws.qbusiness#DeleteGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#DeleteGroupRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#DeleteGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a group so that all users and sub groups that belong to the group can no\n longer access documents only available to that group. For example, after deleting the\n group \"Summer Interns\", all interns who belonged to that group no longer see intern-only\n documents in their chat results.

\n

If you want to delete, update, or replace users or sub groups of a group, you need to\n use the PutGroup operation. For example, if a user in the group\n \"Engineering\" leaves the engineering team and another user takes their place, you\n provide an updated list of users or sub groups that belong to the \"Engineering\" group\n when calling PutGroup.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/applications/{applicationId}/indices/{indexId}/groups/{groupName}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#DeleteGroupRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the application in which the group mapping belongs.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the index you want to delete the group from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "groupName": { + "target": "com.amazonaws.qbusiness#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.qbusiness#DataSourceId", + "traits": { + "smithy.api#documentation": "

The identifier of the data source linked to the group

\n

A group can be tied to multiple data sources. You can delete a group from accessing\n documents in a certain data source. For example, the groups \"Research\", \"Engineering\",\n and \"Sales and Marketing\" are all tied to the company's documents stored in the data\n sources Confluence and Salesforce. You want to delete \"Research\" and \"Engineering\"\n groups from Salesforce, so that these groups cannot access customer-related documents\n stored in Salesforce. Only \"Sales and Marketing\" should access documents in the\n Salesforce data source.

", + "smithy.api#httpQuery": "dataSourceId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#DeleteGroupResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#DeleteIndex": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#DeleteIndexRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#DeleteIndexResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:GetIndex" + ], + "smithy.api#documentation": "

Deletes an Amazon Q index.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/indices/{indexId}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#DeleteIndexRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application the Amazon Q index is linked\n to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q index.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#DeleteIndexResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#DeletePlugin": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#DeletePluginRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#DeletePluginResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:GetPlugin" + ], + "smithy.api#documentation": "

Deletes an Amazon Q plugin.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/applications/{applicationId}/plugins/{pluginId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#DeletePluginRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier the application attached to the Amazon Q plugin.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "pluginId": { + "target": "com.amazonaws.qbusiness#PluginId", + "traits": { + "smithy.api#documentation": "

The identifier of the plugin being deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#DeletePluginResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#DeleteRetriever": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#DeleteRetrieverRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#DeleteRetrieverResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:GetRetriever" + ], + "smithy.api#documentation": "

Deletes the retriever used by an Amazon Q application.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/applications/{applicationId}/retrievers/{retrieverId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#DeleteRetrieverRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application using the retriever.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "retrieverId": { + "target": "com.amazonaws.qbusiness#RetrieverId", + "traits": { + "smithy.api#documentation": "

The identifier of the retriever being deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#DeleteRetrieverResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#DeleteUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#DeleteUserRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#DeleteUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a user by email id.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/applications/{applicationId}/users/{userId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#DeleteUserRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the application from which the user is being deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userId": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The user email being deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#DeleteUserResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#DeleteWebExperience": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#DeleteWebExperienceRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#DeleteWebExperienceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:GetWebExperience" + ], + "smithy.api#documentation": "

Deletes an Amazon Q web experience.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/experiences/{webExperienceId}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#DeleteWebExperienceRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application linked to the Amazon Q web\n experience.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "webExperienceId": { + "target": "com.amazonaws.qbusiness#WebExperienceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q web experience being deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#DeleteWebExperienceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + }, + "smithy.api#pattern": "^\\P{C}*$" + } + }, + "com.amazonaws.qbusiness#Document": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.qbusiness#DocumentId", + "traits": { + "smithy.api#documentation": "

The identifier of the document.

", + "smithy.api#required": {} + } + }, + "attributes": { + "target": "com.amazonaws.qbusiness#DocumentAttributes", + "traits": { + "smithy.api#documentation": "

Custom attributes to apply to the document for refining Amazon Q web experience\n responses.

" + } + }, + "content": { + "target": "com.amazonaws.qbusiness#DocumentContent", + "traits": { + "smithy.api#documentation": "

The contents of the document.

" + } + }, + "contentType": { + "target": "com.amazonaws.qbusiness#ContentType", + "traits": { + "smithy.api#documentation": "

The file type of the document in the Blob field.

\n

If you want to index snippets or subsets of HTML documents instead of the entirety of\n the HTML documents, you add the HTML start and closing tags\n (<HTML>content</HTML>) around the content.

" + } + }, + "title": { + "target": "com.amazonaws.qbusiness#Title", + "traits": { + "smithy.api#documentation": "

The title of the document.

" + } + }, + "accessConfiguration": { + "target": "com.amazonaws.qbusiness#AccessConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration information for access permission to a document.

" + } + }, + "documentEnrichmentConfiguration": { + "target": "com.amazonaws.qbusiness#DocumentEnrichmentConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information for altering document metadata and content during the\n document ingestion process.

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

A document in an Amazon Q application.

" + } + }, + "com.amazonaws.qbusiness#DocumentAttribute": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.qbusiness#DocumentAttributeKey", + "traits": { + "smithy.api#documentation": "

The identifier for the attribute.

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

The value of the attribute.

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

A document attribute or metadata field.

" + } + }, + "com.amazonaws.qbusiness#DocumentAttributeCondition": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.qbusiness#DocumentAttributeKey", + "traits": { + "smithy.api#documentation": "

The identifier of the document attribute used for the condition.

\n

For example, 'Source_URI' could be an identifier for the attribute or metadata field\n that contains source URIs associated with the documents.

\n

Amazon Q currently doesn't support _document_body as an attribute\n key used for the condition.

", + "smithy.api#required": {} + } + }, + "operator": { + "target": "com.amazonaws.qbusiness#DocumentEnrichmentConditionOperator", + "traits": { + "smithy.api#documentation": "

The identifier of the document attribute used for the condition.

\n

For example, 'Source_URI' could be an identifier for the attribute or metadata field\n that contains source URIs associated with the documents.

\n

Amazon Kendra currently does not support _document_body as an\n attribute key used for the condition.

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

The condition used for the target document attribute or metadata field when ingesting\n documents into Amazon Q. You use this with \n DocumentAttributeTarget\n to apply the condition.

\n

For example, you can create the 'Department' target field and have it prefill\n department names associated with the documents based on information in the 'Source_URI'\n field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI\n value, then prefill the target field 'Department' with the target value 'Finance' for\n the document.

\n

Amazon Q can't create a target field if it has not already been created as an\n index field. After you create your index field, you can create a document metadata field\n using DocumentAttributeTarget. Amazon Q then will map your newly\n created metadata field to your index field.

" + } + }, + "com.amazonaws.qbusiness#DocumentAttributeConfiguration": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The name of the document attribute.

" + } + }, + "type": { + "target": "com.amazonaws.qbusiness#AttributeType", + "traits": { + "smithy.api#documentation": "

The type of document attribute.

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

Information about whether the document attribute can be used by an end user to search\n for information on their web experience.

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

Configuration information for document attributes. Document attributes are metadata or\n fields associated with your documents. For example, the company department name\n associated with each document.

\n

For more information, see Understanding document attributes.

" + } + }, + "com.amazonaws.qbusiness#DocumentAttributeConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#DocumentAttributeConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.qbusiness#DocumentAttributeKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]*$" + } + }, + "com.amazonaws.qbusiness#DocumentAttributeStringListValue": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#String" + } + }, + "com.amazonaws.qbusiness#DocumentAttributeStringValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.qbusiness#DocumentAttributeTarget": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.qbusiness#DocumentAttributeKey", + "traits": { + "smithy.api#documentation": "

The identifier of the target document attribute or metadata field. For example,\n 'Department' could be an identifier for the target attribute or metadata field that\n includes the department names associated with the documents.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.qbusiness#DocumentAttributeValue" + }, + "attributeValueOperator": { + "target": "com.amazonaws.qbusiness#AttributeValueOperator", + "traits": { + "smithy.api#documentation": "

\n TRUE to delete the existing target value for your specified target\n attribute key. You cannot create a target value and set this to\n TRUE.

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

The target document attribute or metadata field you want to alter when ingesting\n documents into Amazon Q.

\n

For example, you can delete all customer identification numbers associated with the\n documents, stored in the document metadata field called 'Customer_ID' by setting the\n target key as 'Customer_ID' and the deletion flag to TRUE. This removes all\n customer ID values in the field 'Customer_ID'. This would scrub personally identifiable\n information from each document's metadata.

\n

Amazon Q can't create a target field if it has not already been created as an\n index field. After you create your index field, you can create a document metadata field\n using \n DocumentAttributeTarget\n . Amazon Q\n will then map your newly created document attribute to your index field.

\n

You can also use this with \n DocumentAttributeCondition\n .

" + } + }, + "com.amazonaws.qbusiness#DocumentAttributeValue": { + "type": "union", + "members": { + "stringValue": { + "target": "com.amazonaws.qbusiness#DocumentAttributeStringValue", + "traits": { + "smithy.api#documentation": "

A string.

", + "smithy.api#length": { + "max": 2048 + } + } + }, + "stringListValue": { + "target": "com.amazonaws.qbusiness#DocumentAttributeStringListValue", + "traits": { + "smithy.api#documentation": "

A list of strings.

" + } + }, + "longValue": { + "target": "com.amazonaws.qbusiness#Long", + "traits": { + "smithy.api#documentation": "

A long integer value.

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

A date expressed as an ISO 8601 string.

\n

It's important for the time zone to be included in the ISO 8601 date-time format. For\n example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012\n at 12:30PM (plus 10 seconds) in Central European Time.

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

The value of a document attribute. You can only provide one value for a document\n attribute.

" + } + }, + "com.amazonaws.qbusiness#DocumentAttributes": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#DocumentAttribute" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.qbusiness#DocumentContent": { + "type": "union", + "members": { + "blob": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "

The contents of the document. Documents passed to the blob parameter must\n be base64 encoded. Your code might not need to encode the document file bytes if you're\n using an Amazon Web Services SDK to call Amazon Q APIs. If you are calling the\n Amazon Q endpoint directly using REST, you must base64 encode the contents before\n sending.

" + } + }, + "s3": { + "target": "com.amazonaws.qbusiness#S3", + "traits": { + "smithy.api#documentation": "

The path to the document in an Amazon S3 bucket.

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

The contents of a document.

" + } + }, + "com.amazonaws.qbusiness#DocumentContentOperator": { + "type": "enum", + "members": { + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + } + } + }, + "com.amazonaws.qbusiness#DocumentDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#DocumentDetails" + } + }, + "com.amazonaws.qbusiness#DocumentDetails": { + "type": "structure", + "members": { + "documentId": { + "target": "com.amazonaws.qbusiness#DocumentId", + "traits": { + "smithy.api#documentation": "

The identifier of the document.

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

The current status of the document.

" + } + }, + "error": { + "target": "com.amazonaws.qbusiness#ErrorDetail", + "traits": { + "smithy.api#documentation": "

An error message associated with the document.

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

The timestamp for when the document was created.

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

The timestamp for when the document was last updated.

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

The details of a document within an Amazon Q index.

" + } + }, + "com.amazonaws.qbusiness#DocumentEnrichmentConditionOperator": { + "type": "enum", + "members": { + "GREATER_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER_THAN" + } + }, + "GREATER_THAN_OR_EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER_THAN_OR_EQUALS" + } + }, + "LESS_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LESS_THAN" + } + }, + "LESS_THAN_OR_EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LESS_THAN_OR_EQUALS" + } + }, + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + }, + "NOT_EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_EQUALS" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS" + } + }, + "NOT_CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_CONTAINS" + } + }, + "EXISTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXISTS" + } + }, + "NOT_EXISTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_EXISTS" + } + }, + "BEGINS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEGINS_WITH" + } + } + } + }, + "com.amazonaws.qbusiness#DocumentEnrichmentConfiguration": { + "type": "structure", + "members": { + "inlineConfigurations": { + "target": "com.amazonaws.qbusiness#InlineDocumentEnrichmentConfigurations", + "traits": { + "smithy.api#documentation": "

Configuration information to alter document attributes or metadata fields and content\n when ingesting documents into Amazon Q.

" + } + }, + "preExtractionHookConfiguration": { + "target": "com.amazonaws.qbusiness#HookConfiguration" + }, + "postExtractionHookConfiguration": { + "target": "com.amazonaws.qbusiness#HookConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "

Provides the configuration information for altering document metadata and content\n during the document ingestion process.

\n

For more information, see Custom document\n enrichment.

" + } + }, + "com.amazonaws.qbusiness#DocumentId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1825 + }, + "smithy.api#pattern": "^\\P{C}*$" + } + }, + "com.amazonaws.qbusiness#DocumentStatus": { + "type": "enum", + "members": { + "RECEIVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECEIVED" + } + }, + "PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROCESSING" + } + }, + "INDEXED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INDEXED" + } + }, + "UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "DOCUMENT_FAILED_TO_INDEX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCUMENT_FAILED_TO_INDEX" + } + } + } + }, + "com.amazonaws.qbusiness#Documents": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#Document" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.qbusiness#EligibleDataSource": { + "type": "structure", + "members": { + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the index the data source is attached to.

" + } + }, + "dataSourceId": { + "target": "com.amazonaws.qbusiness#DataSourceId", + "traits": { + "smithy.api#documentation": "

The identifier of the data source.

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

The identifier of the data source Amazon Q will generate responses from.

" + } + }, + "com.amazonaws.qbusiness#EligibleDataSources": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#EligibleDataSource" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.qbusiness#EncryptionConfiguration": { + "type": "structure", + "members": { + "kmsKeyId": { + "target": "com.amazonaws.qbusiness#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The identifier of the KMS key. Amazon Q doesn't support asymmetric\n keys.

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

Provides the identifier of the KMS key used to encrypt data indexed by\n Amazon Q. Amazon Q doesn't support asymmetric keys.

" + } + }, + "com.amazonaws.qbusiness#ErrorCode": { + "type": "enum", + "members": { + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InternalError" + } + }, + "INVALID_REQUEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidRequest" + } + }, + "RESOURCE_INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceInactive" + } + }, + "RESOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceNotFound" + } + } + } + }, + "com.amazonaws.qbusiness#ErrorDetail": { + "type": "structure", + "members": { + "errorMessage": { + "target": "com.amazonaws.qbusiness#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The message explaining the data source sync error.

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

The code associated with the data source sync error.

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

Provides information about a data source sync error.

" + } + }, + "com.amazonaws.qbusiness#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\P{C}*$" + } + }, + "com.amazonaws.qbusiness#ExampleChatMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 350 + }, + "smithy.api#pattern": "^\\P{C}*$" + } + }, + "com.amazonaws.qbusiness#ExampleChatMessages": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#ExampleChatMessage" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.qbusiness#ExecutionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" + } + }, + "com.amazonaws.qbusiness#ExpertQ": { + "type": "service", + "version": "2023-11-27", + "operations": [ + { + "target": "com.amazonaws.qbusiness#BatchDeleteDocument" + }, + { + "target": "com.amazonaws.qbusiness#BatchPutDocument" + }, + { + "target": "com.amazonaws.qbusiness#ChatSync" + }, + { + "target": "com.amazonaws.qbusiness#CreateUser" + }, + { + "target": "com.amazonaws.qbusiness#DeleteChatControlsConfiguration" + }, + { + "target": "com.amazonaws.qbusiness#DeleteConversation" + }, + { + "target": "com.amazonaws.qbusiness#DeleteGroup" + }, + { + "target": "com.amazonaws.qbusiness#DeleteUser" + }, + { + "target": "com.amazonaws.qbusiness#GetChatControlsConfiguration" + }, + { + "target": "com.amazonaws.qbusiness#GetGroup" + }, + { + "target": "com.amazonaws.qbusiness#GetUser" + }, + { + "target": "com.amazonaws.qbusiness#ListConversations" + }, + { + "target": "com.amazonaws.qbusiness#ListDataSourceSyncJobs" + }, + { + "target": "com.amazonaws.qbusiness#ListDocuments" + }, + { + "target": "com.amazonaws.qbusiness#ListGroups" + }, + { + "target": "com.amazonaws.qbusiness#ListMessages" + }, + { + "target": "com.amazonaws.qbusiness#ListTagsForResource" + }, + { + "target": "com.amazonaws.qbusiness#PutFeedback" + }, + { + "target": "com.amazonaws.qbusiness#PutGroup" + }, + { + "target": "com.amazonaws.qbusiness#StartDataSourceSyncJob" + }, + { + "target": "com.amazonaws.qbusiness#StopDataSourceSyncJob" + }, + { + "target": "com.amazonaws.qbusiness#TagResource" + }, + { + "target": "com.amazonaws.qbusiness#UntagResource" + }, + { + "target": "com.amazonaws.qbusiness#UpdateChatControlsConfiguration" + }, + { + "target": "com.amazonaws.qbusiness#UpdateUser" + } + ], + "resources": [ + { + "target": "com.amazonaws.qbusiness#ApplicationResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "QBusiness", + "cloudFormationName": "QBusiness", + "arnNamespace": "qbusiness", + "cloudTrailEventSource": "qbusiness.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "qbusiness" + }, + "aws.protocols#restJson1": { + "http": [ + "h2", + "http/1.1" + ], + "eventStreamHttp": [ + "h2" + ] + }, + "smithy.api#documentation": "

\n

", + "smithy.api#title": "QBusiness", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "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": [], + "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": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://qbusiness-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://qbusiness.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://qbusiness-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": [], + "endpoint": { + "url": "https://qbusiness.{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 us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://qbusiness-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://qbusiness.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://qbusiness-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://qbusiness.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://qbusiness-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://qbusiness.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": 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, + "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, + "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, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.qbusiness#FailedDocument": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.qbusiness#DocumentId", + "traits": { + "smithy.api#documentation": "

The identifier of the document that couldn't be removed from the Amazon Q\n index.

" + } + }, + "error": { + "target": "com.amazonaws.qbusiness#ErrorDetail", + "traits": { + "smithy.api#documentation": "

An explanation for why the document couldn't be removed from the index.

" + } + }, + "dataSourceId": { + "target": "com.amazonaws.qbusiness#DataSourceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q data source connector that contains the failed\n document.

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

A list of documents that could not be removed from an Amazon Q index. Each entry\n contains an error message that indicates why the document couldn't be removed from the\n index.

" + } + }, + "com.amazonaws.qbusiness#FailedDocuments": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#FailedDocument" + } + }, + "com.amazonaws.qbusiness#GetApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#GetApplicationRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#GetApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:ListTagsForResource" + ], + "smithy.api#documentation": "

Gets information about an existing Amazon Q application.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#GetApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#GetApplicationResponse": { + "type": "structure", + "members": { + "displayName": { + "target": "com.amazonaws.qbusiness#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Q application.

" + } + }, + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application.

" + } + }, + "applicationArn": { + "target": "com.amazonaws.qbusiness#ApplicationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q application.

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

The Amazon Resource Name (ARN) of the IAM with permissions to access\n your CloudWatch logs and metrics.

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

The status of the Amazon Q application.

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

A description for the Amazon Q application.

" + } + }, + "encryptionConfiguration": { + "target": "com.amazonaws.qbusiness#EncryptionConfiguration", + "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", + "smithy.api#documentation": "

The identifier of the Amazon Web Services\n KMS key that is used to encrypt your data. Amazon Q doesn't support\n asymmetric keys.

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

The Unix timestamp when the Amazon Q application was last updated.

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

The Unix timestamp when the Amazon Q application was last updated.

" + } + }, + "error": { + "target": "com.amazonaws.qbusiness#ErrorDetail", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

If the Status field is set to ERROR, the\n ErrorMessage field contains a description of the error that caused the\n synchronization to fail.

" + } + }, + "attachmentsConfiguration": { + "target": "com.amazonaws.qbusiness#AppliedAttachmentsConfiguration", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

Settings for whether end users can upload files directly during chat.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#GetChatControlsConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#GetChatControlsConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#GetChatControlsConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about an chat controls configured for an existing Amazon Q\n application.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/chatcontrols", + "method": "GET", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "topicConfigurations" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#GetChatControlsConfigurationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the application for which the chat controls are configured.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.qbusiness#MaxResultsIntegerForGetTopicConfigurations", + "traits": { + "smithy.api#documentation": "

The maximum number of configured chat controls to return.

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

If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q chat controls\n configured.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#GetChatControlsConfigurationResponse": { + "type": "structure", + "members": { + "responseScope": { + "target": "com.amazonaws.qbusiness#ResponseScope", + "traits": { + "smithy.api#documentation": "

The response scope configured for a Amazon Q application. This determines whether\n your application uses its retrieval augmented generation (RAG) system to generate\n answers only from your enterprise data, or also uses the large language models (LLM)\n knowledge to respons to end user questions in chat.

" + } + }, + "blockedPhrases": { + "target": "com.amazonaws.qbusiness#BlockedPhrasesConfiguration", + "traits": { + "smithy.api#documentation": "

The phrases blocked from chat by your chat control configuration.

" + } + }, + "topicConfigurations": { + "target": "com.amazonaws.qbusiness#TopicConfigurations", + "traits": { + "smithy.api#documentation": "

The topic specific controls configured for a Amazon Q application.

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

If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q chat controls\n configured.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#GetDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#GetDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#GetDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:ListTagsForResource" + ], + "smithy.api#documentation": "

Gets information about an existing Amazon Q data source connector.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#GetDataSourceRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identfier of the index used with the data source connector.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.qbusiness#DataSourceId", + "traits": { + "smithy.api#documentation": "

The identifier of the data source connector.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#GetDataSourceResponse": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application.

" + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the index linked to the data source connector.

" + } + }, + "dataSourceId": { + "target": "com.amazonaws.qbusiness#DataSourceId", + "traits": { + "smithy.api#documentation": "

The identifier of the data source connector.

" + } + }, + "dataSourceArn": { + "target": "com.amazonaws.qbusiness#DataSourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" + } + }, + "displayName": { + "target": "com.amazonaws.qbusiness#DataSourceName", + "traits": { + "smithy.api#documentation": "

The name for the data source connector.

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

The type of the data source connector. For example, S3.

" + } + }, + "configuration": { + "target": "com.amazonaws.qbusiness#DataSourceConfiguration", + "traits": { + "smithy.api#documentation": "

The details of how the data source connector is configured.

" + } + }, + "vpcConfiguration": { + "target": "com.amazonaws.qbusiness#DataSourceVpcConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect\n to your data source.

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

The Unix timestamp when the data source connector was created.

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

The Unix timestamp when the data source connector was last updated.

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

The description for the data source connector.

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

The current status of the data source connector. When the Status field\n value is FAILED, the ErrorMessage field contains a description\n of the error that caused the data source connector to fail.

" + } + }, + "syncSchedule": { + "target": "com.amazonaws.qbusiness#SyncSchedule", + "traits": { + "smithy.api#documentation": "

The schedule for Amazon Q to update the index.

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

The Amazon Resource Name (ARN) of the role with permission to access the data source\n and required resources.

" + } + }, + "error": { + "target": "com.amazonaws.qbusiness#ErrorDetail", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

When the Status field value is FAILED, the\n ErrorMessage field contains a description of the error that caused the\n data source connector to fail.

" + } + }, + "documentEnrichmentConfiguration": { + "target": "com.amazonaws.qbusiness#DocumentEnrichmentConfiguration" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#GetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#GetGroupRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#GetGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a group by group name.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/indices/{indexId}/groups/{groupName}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#GetGroupRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the application id the group is attached to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the index the group is attached to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "groupName": { + "target": "com.amazonaws.qbusiness#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.qbusiness#DataSourceId", + "traits": { + "smithy.api#documentation": "

The identifier of the data source the group is attached to.

", + "smithy.api#httpQuery": "dataSourceId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#GetGroupResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.qbusiness#GroupStatusDetail", + "traits": { + "smithy.api#documentation": "

The current status of the group.

" + } + }, + "statusHistory": { + "target": "com.amazonaws.qbusiness#GroupStatusDetails", + "traits": { + "smithy.api#documentation": "

The status history of the group.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#GetIndex": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#GetIndexRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#GetIndexResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:ListTagsForResource" + ], + "smithy.api#documentation": "

Gets information about an existing Amazon Q index.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/indices/{indexId}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#GetIndexRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application connected to the index.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q index you want information on.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#GetIndexResponse": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application associated with the index.

" + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q index.

" + } + }, + "displayName": { + "target": "com.amazonaws.qbusiness#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Q index.

" + } + }, + "indexArn": { + "target": "com.amazonaws.qbusiness#IndexArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q index.

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

The current status of the index. When the value is ACTIVE, the index is\n ready for use. If the Status field value is FAILED, the\n ErrorMessage field contains a message that explains why.

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

The description for the Amazon Q index.

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

The Unix timestamp when the Amazon Q index was created.

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

The Unix timestamp when the Amazon Q index was last updated.

" + } + }, + "capacityConfiguration": { + "target": "com.amazonaws.qbusiness#IndexCapacityConfiguration", + "traits": { + "smithy.api#documentation": "

The storage capacity units chosen for your Amazon Q index.

" + } + }, + "documentAttributeConfigurations": { + "target": "com.amazonaws.qbusiness#DocumentAttributeConfigurations", + "traits": { + "smithy.api#documentation": "

Configuration information for document attributes or metadata. Document metadata are\n fields associated with your documents. For example, the company department name\n associated with each document. For more information, see Understanding document attributes.

" + } + }, + "error": { + "target": "com.amazonaws.qbusiness#ErrorDetail", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

When the Status field value is FAILED, the\n ErrorMessage field contains a message that explains why.

" + } + }, + "indexStatistics": { + "target": "com.amazonaws.qbusiness#IndexStatistics", + "traits": { + "smithy.api#documentation": "

Provides information about the number of documents indexed.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#GetPlugin": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#GetPluginRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#GetPluginResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:ListTagsForResource" + ], + "smithy.api#documentation": "

Gets information about an existing Amazon Q plugin.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/plugins/{pluginId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#GetPluginRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the application which contains the plugin.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "pluginId": { + "target": "com.amazonaws.qbusiness#PluginId", + "traits": { + "smithy.api#documentation": "

The identifier of the plugin.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#GetPluginResponse": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the application which contains the plugin.

" + } + }, + "pluginId": { + "target": "com.amazonaws.qbusiness#PluginId", + "traits": { + "smithy.api#documentation": "

The identifier of the plugin.

" + } + }, + "displayName": { + "target": "com.amazonaws.qbusiness#PluginName", + "traits": { + "smithy.api#documentation": "

The name of the plugin.

" + } + }, + "type": { + "target": "com.amazonaws.qbusiness#PluginType", + "traits": { + "smithy.api#documentation": "

The type of the plugin.

" + } + }, + "serverUrl": { + "target": "com.amazonaws.qbusiness#Url", + "traits": { + "smithy.api#documentation": "

The source URL used for plugin configuration.

" + } + }, + "authConfiguration": { + "target": "com.amazonaws.qbusiness#PluginAuthConfiguration" + }, + "pluginArn": { + "target": "com.amazonaws.qbusiness#PluginArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role with permission to access resources needed\n to create the plugin.

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

The current state of the plugin.

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

The timestamp for when the plugin was created.

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

The timestamp for when the plugin was last updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#GetRetriever": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#GetRetrieverRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#GetRetrieverResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:ListTagsForResource" + ], + "smithy.api#documentation": "

Gets information about an existing retriever used by an Amazon Q\n application.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/retrievers/{retrieverId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#GetRetrieverRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application using the retriever.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "retrieverId": { + "target": "com.amazonaws.qbusiness#RetrieverId", + "traits": { + "smithy.api#documentation": "

The identifier of the retriever.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#GetRetrieverResponse": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application using the retriever.

" + } + }, + "retrieverId": { + "target": "com.amazonaws.qbusiness#RetrieverId", + "traits": { + "smithy.api#documentation": "

The identifier of the retriever.

" + } + }, + "retrieverArn": { + "target": "com.amazonaws.qbusiness#RetrieverArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role associated with the retriever.

" + } + }, + "type": { + "target": "com.amazonaws.qbusiness#RetrieverType", + "traits": { + "smithy.api#documentation": "

The type of the retriever.

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

The status of the retriever.

" + } + }, + "displayName": { + "target": "com.amazonaws.qbusiness#RetrieverName", + "traits": { + "smithy.api#documentation": "

The name of the retriever.

" + } + }, + "configuration": { + "target": "com.amazonaws.qbusiness#RetrieverConfiguration" + }, + "roleArn": { + "target": "com.amazonaws.qbusiness#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role with the permission to access the retriever\n and required resources.

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

The Unix timestamp when the retriever was created.

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

The Unix timestamp when the retriever was last updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#GetUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#GetUserRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#GetUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the universally unique identifier (UUID) associated with a local user in a\n data source.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/users/{userId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#GetUserRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the application connected to the user.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userId": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The user email address attached to the user.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#GetUserResponse": { + "type": "structure", + "members": { + "userAliases": { + "target": "com.amazonaws.qbusiness#UserAliases", + "traits": { + "smithy.api#documentation": "

A list of user aliases attached to a user.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#GetWebExperience": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#GetWebExperienceRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#GetWebExperienceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:ListTagsForResource" + ], + "smithy.api#documentation": "

Gets information about an existing Amazon Q web experience.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/experiences/{webExperienceId}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#GetWebExperienceRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application linked to the web experience.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "webExperienceId": { + "target": "com.amazonaws.qbusiness#WebExperienceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q web experience.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#GetWebExperienceResponse": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application linked to the web experience.

" + } + }, + "webExperienceId": { + "target": "com.amazonaws.qbusiness#WebExperienceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q web experience.

" + } + }, + "webExperienceArn": { + "target": "com.amazonaws.qbusiness#WebExperienceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role with the permission to access the\n Amazon Q web experience and required resources.

" + } + }, + "defaultEndpoint": { + "target": "com.amazonaws.qbusiness#Url", + "traits": { + "smithy.api#documentation": "

The endpoint of your Amazon Q web experience.

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

The current status of the Amazon Q web experience. When the Status\n field value is FAILED, the ErrorMessage field contains a\n description of the error that caused the data source connector to fail.

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

The Unix timestamp when the retriever was created.

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

The Unix timestamp when the data source connector was last updated.

" + } + }, + "title": { + "target": "com.amazonaws.qbusiness#WebExperienceTitle", + "traits": { + "smithy.api#documentation": "

The title for your Amazon Q web experience.

" + } + }, + "subtitle": { + "target": "com.amazonaws.qbusiness#WebExperienceSubtitle", + "traits": { + "smithy.api#documentation": "

The subtitle for your Amazon Q web experience.

" + } + }, + "welcomeMessage": { + "target": "com.amazonaws.qbusiness#WebExperienceWelcomeMessage", + "traits": { + "smithy.api#documentation": "

The customized welcome message for end users of an Amazon Q web\n experience.

" + } + }, + "samplePromptsControlMode": { + "target": "com.amazonaws.qbusiness#WebExperienceSamplePromptsControlMode", + "traits": { + "smithy.api#documentation": "

Determines whether sample prompts are enabled in the web experience for an end\n user.

" + } + }, + "authenticationConfiguration": { + "target": "com.amazonaws.qbusiness#WebExperienceAuthConfiguration", + "traits": { + "smithy.api#documentation": "

The authentication configuration information for your Amazon Q web\n experience.

" + } + }, + "error": { + "target": "com.amazonaws.qbusiness#ErrorDetail", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

When the Status field value is FAILED, the\n ErrorMessage field contains a description of the error that caused the\n data source connector to fail.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#GroupMembers": { + "type": "structure", + "members": { + "memberGroups": { + "target": "com.amazonaws.qbusiness#MemberGroups", + "traits": { + "smithy.api#documentation": "

A list of sub groups that belong to a group. For example, the sub groups \"Research\",\n \"Engineering\", and \"Sales and Marketing\" all belong to the group \"Company\".

" + } + }, + "memberUsers": { + "target": "com.amazonaws.qbusiness#MemberUsers", + "traits": { + "smithy.api#documentation": "

A list of users that belong to a group. For example, a list of interns all belong to\n the \"Interns\" group.

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

A list of users or sub groups that belong to a group. This is for generating\n Amazon Q chat results only from document a user has access to.

" + } + }, + "com.amazonaws.qbusiness#GroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^\\P{C}*$" + } + }, + "com.amazonaws.qbusiness#GroupStatus": { + "type": "enum", + "members": { + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROCESSING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.qbusiness#GroupStatusDetail": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.qbusiness#GroupStatus", + "traits": { + "smithy.api#documentation": "

The status of a group.

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

The Unix timestamp when the Amazon Q application was last updated.

" + } + }, + "errorDetail": { + "target": "com.amazonaws.qbusiness#ErrorDetail", + "traits": { + "smithy.api#documentation": "

The details of an error associated a group status.

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

Provides the details of a group's status.

" + } + }, + "com.amazonaws.qbusiness#GroupStatusDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#GroupStatusDetail" + } + }, + "com.amazonaws.qbusiness#GroupSummary": { + "type": "structure", + "members": { + "groupName": { + "target": "com.amazonaws.qbusiness#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group the summary information is for.

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

Summary information for groups.

" + } + }, + "com.amazonaws.qbusiness#GroupSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#GroupSummary" + } + }, + "com.amazonaws.qbusiness#HookConfiguration": { + "type": "structure", + "members": { + "invocationCondition": { + "target": "com.amazonaws.qbusiness#DocumentAttributeCondition", + "traits": { + "smithy.api#documentation": "

The condition used for when a Lambda function should be invoked.

\n

For example, you can specify a condition that if there are empty date-time values,\n then Amazon Q should invoke a function that inserts the current date-time.

" + } + }, + "lambdaArn": { + "target": "com.amazonaws.qbusiness#LambdaArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a role with permission to run a Lambda\n function during ingestion. For more information, see IAM roles for Custom\n Document Enrichment (CDE).

" + } + }, + "s3BucketName": { + "target": "com.amazonaws.qbusiness#S3BucketName", + "traits": { + "smithy.api#documentation": "

Stores the original, raw documents or the structured, parsed documents before and\n after altering them. For more information, see Data contracts for Lambda functions.

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

The Amazon Resource Name (ARN) of a role with permission to run\n PreExtractionHookConfiguration and\n PostExtractionHookConfiguration for altering document metadata and\n content during the document ingestion process.

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

Provides the configuration information for invoking a Lambda function in\n Lambda to alter document metadata and content when ingesting\n documents into Amazon Q.

\n

You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on\n the original or raw documents.

\n

If you want to apply advanced alterations on the Amazon Q structured documents,\n you must configure your Lambda function using PostExtractionHookConfiguration.

\n

You can only invoke one Lambda function. However, this function can invoke\n other functions it requires.

\n

For more information, see Custom document enrichment.

" + } + }, + "com.amazonaws.qbusiness#Index": { + "type": "structure", + "members": { + "displayName": { + "target": "com.amazonaws.qbusiness#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the index.

" + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier for the index.

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

The Unix timestamp when the index was created.

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

The Unix timestamp when the index was last updated.

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

The current status of the index. When the status is ACTIVE, the index is\n ready.

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

Summary information for your Amazon Q index.

" + } + }, + "com.amazonaws.qbusiness#IndexArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1284 + }, + "smithy.api#pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" + } + }, + "com.amazonaws.qbusiness#IndexCapacityConfiguration": { + "type": "structure", + "members": { + "units": { + "target": "com.amazonaws.qbusiness#IndexCapacityInteger", + "traits": { + "smithy.api#documentation": "

The number of storage units configured for an Amazon Q index.

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

Provides information about index capacity configuration.

" + } + }, + "com.amazonaws.qbusiness#IndexCapacityInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.qbusiness#IndexId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" + } + }, + "com.amazonaws.qbusiness#IndexName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$" + } + }, + "com.amazonaws.qbusiness#IndexResource": { + "type": "resource", + "identifiers": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId" + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId" + } + }, + "create": { + "target": "com.amazonaws.qbusiness#CreateIndex" + }, + "read": { + "target": "com.amazonaws.qbusiness#GetIndex" + }, + "update": { + "target": "com.amazonaws.qbusiness#UpdateIndex" + }, + "delete": { + "target": "com.amazonaws.qbusiness#DeleteIndex" + }, + "list": { + "target": "com.amazonaws.qbusiness#ListIndices" + }, + "resources": [ + { + "target": "com.amazonaws.qbusiness#DataSourceResource" + } + ], + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Index" + } + } + }, + "com.amazonaws.qbusiness#IndexStatistics": { + "type": "structure", + "members": { + "textDocumentStatistics": { + "target": "com.amazonaws.qbusiness#TextDocumentStatistics", + "traits": { + "smithy.api#documentation": "

The number of documents indexed.

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

Provides information about the number of documents in an index.

" + } + }, + "com.amazonaws.qbusiness#IndexStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } + } + }, + "com.amazonaws.qbusiness#IndexedTextBytes": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.qbusiness#IndexedTextDocument": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.qbusiness#Indices": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#Index" + } + }, + "com.amazonaws.qbusiness#InlineDocumentEnrichmentConfiguration": { + "type": "structure", + "members": { + "condition": { + "target": "com.amazonaws.qbusiness#DocumentAttributeCondition" + }, + "target": { + "target": "com.amazonaws.qbusiness#DocumentAttributeTarget" + }, + "documentContentOperator": { + "target": "com.amazonaws.qbusiness#DocumentContentOperator", + "traits": { + "smithy.api#documentation": "

\n TRUE to delete content if the condition used for the target attribute is\n met.

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

Provides the configuration information for applying basic logic to alter document\n metadata and content when ingesting documents into Amazon Q.

\n

To apply advanced logic, to go beyond what you can do with basic logic, see \n HookConfiguration\n .

\n

For more information, see Custom document enrichment.

" + } + }, + "com.amazonaws.qbusiness#InlineDocumentEnrichmentConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#InlineDocumentEnrichmentConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.qbusiness#Integer": { + "type": "integer" + }, + "com.amazonaws.qbusiness#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.qbusiness#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An issue occurred with the internal server used for your Amazon Q service. Wait\n some minutes and try again, or contact Support for help.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.qbusiness#KendraIndexConfiguration": { + "type": "structure", + "members": { + "indexId": { + "target": "com.amazonaws.qbusiness#KendraIndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Kendra index.

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

Stores an Amazon Kendra index as a retriever.

" + } + }, + "com.amazonaws.qbusiness#KendraIndexId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" + } + }, + "com.amazonaws.qbusiness#KmsKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.qbusiness#LambdaArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:lambda:[a-z-]*-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?$" + } + }, + "com.amazonaws.qbusiness#LicenseNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.qbusiness#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

You don't have permissions to perform the action because your license is inactive. Ask\n your admin to activate your license and try again after your licence is active.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.qbusiness#ListApplications": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#ListApplicationsRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#ListApplicationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists Amazon Q applications.

", + "smithy.api#http": { + "uri": "/applications", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "applications" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#ListApplicationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.qbusiness#NextToken", + "traits": { + "smithy.api#documentation": "

If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q applications.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qbusiness#MaxResultsIntegerForListApplications", + "traits": { + "smithy.api#documentation": "

The maximum number of Amazon Q applications to return.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#ListApplicationsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.qbusiness#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, Amazon Q returns this token. You can use this token\n in a subsequent request to retrieve the next set of applications.

" + } + }, + "applications": { + "target": "com.amazonaws.qbusiness#Applications", + "traits": { + "smithy.api#documentation": "

An array of summary information on the configuration of one or more Amazon Q\n applications.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#ListConversations": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#ListConversationsRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#ListConversationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#LicenseNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists one or more Amazon Q conversations.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/conversations", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "conversations" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#ListConversationsRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userId": { + "target": "com.amazonaws.qbusiness#UserId", + "traits": { + "smithy.api#documentation": "

The identifier of the user involved in the Amazon Q web experience conversation.\n

", + "smithy.api#httpQuery": "userId", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.qbusiness#NextToken", + "traits": { + "smithy.api#documentation": "

If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q conversations.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qbusiness#MaxResultsIntegerForListConversations", + "traits": { + "smithy.api#documentation": "

The maximum number of Amazon Q conversations to return.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#ListConversationsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.qbusiness#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, Amazon Q returns this token, which you can use in a\n later request to list the next set of messages.

" + } + }, + "conversations": { + "target": "com.amazonaws.qbusiness#Conversations", + "traits": { + "smithy.api#documentation": "

An array of summary information on the configuration of one or more Amazon Q web\n experiences.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#ListDataSourceSyncJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#ListDataSourceSyncJobsRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#ListDataSourceSyncJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get information about an Amazon Q data source connector synchronization.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/syncjobs", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "history" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#ListDataSourceSyncJobsRequest": { + "type": "structure", + "members": { + "dataSourceId": { + "target": "com.amazonaws.qbusiness#DataSourceId", + "traits": { + "smithy.api#documentation": "

The identifier of the data source connector.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application connected to the data source.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the index used with the Amazon Q data source connector.

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

If the maxResults response was incpmplete because there is more data to\n retriever, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of responses.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qbusiness#MaxResultsIntegerForListDataSourcesSyncJobs", + "traits": { + "smithy.api#documentation": "

The maximum number of synchronization jobs to return in the response.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "startTime": { + "target": "com.amazonaws.qbusiness#Timestamp", + "traits": { + "smithy.api#documentation": "

The start time of the data source connector sync.

", + "smithy.api#httpQuery": "startTime" + } + }, + "endTime": { + "target": "com.amazonaws.qbusiness#Timestamp", + "traits": { + "smithy.api#documentation": "

The end time of the data source connector sync.

", + "smithy.api#httpQuery": "endTime" + } + }, + "statusFilter": { + "target": "com.amazonaws.qbusiness#DataSourceSyncJobStatus", + "traits": { + "smithy.api#documentation": "

Only returns synchronization jobs with the Status field equal to the\n specified status.

", + "smithy.api#httpQuery": "syncStatus" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#ListDataSourceSyncJobsResponse": { + "type": "structure", + "members": { + "history": { + "target": "com.amazonaws.qbusiness#DataSourceSyncJobs", + "traits": { + "smithy.api#documentation": "

A history of synchronization jobs for the data source connector.

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

If the response is truncated, Amazon Q returns this token. You can use this token\n in any subsequent request to retrieve the next set of jobs.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#ListDataSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#ListDataSourcesRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#ListDataSourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the Amazon Q data source connectors that you have created.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/indices/{indexId}/datasources", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "dataSources" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#ListDataSourcesRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application linked to the data source\n connectors.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the index used with one or more data source connectors.

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

If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q data source\n connectors.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qbusiness#MaxResultsIntegerForListDataSources", + "traits": { + "smithy.api#documentation": "

The maximum number of data source connectors to return.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#ListDataSourcesResponse": { + "type": "structure", + "members": { + "dataSources": { + "target": "com.amazonaws.qbusiness#DataSources", + "traits": { + "smithy.api#documentation": "

An array of summary information for one or more data source connector.

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

If the response is truncated, Amazon Q returns this token. You can use this token\n in a subsequent request to retrieve the next set of data source connectors.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#ListDocuments": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#ListDocumentsRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#ListDocumentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

A list of documents attached to an index.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/index/{indexId}/documents", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "documentDetailList" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#ListDocumentsRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the application id the documents are attached to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the index the documents are attached to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceIds": { + "target": "com.amazonaws.qbusiness#DataSourceIds", + "traits": { + "smithy.api#documentation": "

The identifier of the data sources the documents are attached to.

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

If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of documents.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qbusiness#MaxResultsIntegerForListDocuments", + "traits": { + "smithy.api#documentation": "

The maximum number of documents to return.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#ListDocumentsResponse": { + "type": "structure", + "members": { + "documentDetailList": { + "target": "com.amazonaws.qbusiness#DocumentDetailList", + "traits": { + "smithy.api#documentation": "

A list of document details.

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

If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of documents.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#ListGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#ListGroupsRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#ListGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a list of groups that are mapped to users.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/indices/{indexId}/groups" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#ListGroupsRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the application for getting a list of groups mapped to users.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the index for getting a list of groups mapped to users.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "updatedEarlierThan": { + "target": "com.amazonaws.qbusiness#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp identifier used for the latest PUT or DELETE\n action for mapping users to their groups.

", + "smithy.api#httpQuery": "updatedEarlierThan", + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.qbusiness#DataSourceId", + "traits": { + "smithy.api#documentation": "

The identifier of the data source for getting a list of groups mapped to users.

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

If the previous response was incomplete (because there is more data to retrieve),\n Amazon Q returns a pagination token in the response. You can use this pagination\n token to retrieve the next set of groups that are mapped to users.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qbusiness#MaxResultsIntegerForListGroupsRequest", + "traits": { + "smithy.api#documentation": "

The maximum number of returned groups that are mapped to users.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#ListGroupsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.qbusiness#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, Amazon Q returns this token that you can use in the\n subsequent request to retrieve the next set of groups that are mapped to users.

" + } + }, + "items": { + "target": "com.amazonaws.qbusiness#GroupSummaryList", + "traits": { + "smithy.api#documentation": "

Summary information for list of groups that are mapped to users.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#ListIndices": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#ListIndicesRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#ListIndicesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the Amazon Q indices you have created.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/indices", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "indices" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#ListIndicesRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application connected to the index.

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

If the maxResults response was incomplete because there is more data to retrieve,\n Amazon Q returns a pagination token in the response. You can use this pagination\n token to retrieve the next set of Amazon Q indices.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qbusiness#MaxResultsIntegerForListIndices", + "traits": { + "smithy.api#documentation": "

The maximum number of indices to return.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#ListIndicesResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.qbusiness#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, Amazon Q returns this token that you can use in the\n subsequent request to retrieve the next set of indexes.

" + } + }, + "indices": { + "target": "com.amazonaws.qbusiness#Indices", + "traits": { + "smithy.api#documentation": "

An array of information on the items in one or more indexes.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#ListMessages": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#ListMessagesRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#ListMessagesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#LicenseNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of messages associated with an Amazon Q web experience.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/conversations/{conversationId}", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "messages" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#ListMessagesRequest": { + "type": "structure", + "members": { + "conversationId": { + "target": "com.amazonaws.qbusiness#ConversationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q web experience conversation.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier for the Amazon Q application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userId": { + "target": "com.amazonaws.qbusiness#UserId", + "traits": { + "smithy.api#documentation": "

The identifier of the user involved in the Amazon Q web experience\n conversation.

", + "smithy.api#httpQuery": "userId", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.qbusiness#NextToken", + "traits": { + "smithy.api#documentation": "

If the number of retrievers returned exceeds maxResults, Amazon Q\n returns a next token as a pagination token to retrieve the next set of messages.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qbusiness#MaxResultsIntegerForListMessages", + "traits": { + "smithy.api#documentation": "

The maximum number of messages to return.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#ListMessagesResponse": { + "type": "structure", + "members": { + "messages": { + "target": "com.amazonaws.qbusiness#Messages", + "traits": { + "smithy.api#documentation": "

An array of information on one or more messages.

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

If the response is truncated, Amazon Q returns this token, which you can use in a\n later request to list the next set of messages.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#ListPlugins": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#ListPluginsRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#ListPluginsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists configured Amazon Q plugins.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/plugins" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "plugins" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#ListPluginsRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the application the plugin is attached to.

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

If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of plugins.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qbusiness#MaxResultsIntegerForListPlugins", + "traits": { + "smithy.api#documentation": "

The maximum number of documents to return.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#ListPluginsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.qbusiness#NextToken", + "traits": { + "smithy.api#documentation": "

If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of plugins.

" + } + }, + "plugins": { + "target": "com.amazonaws.qbusiness#Plugins", + "traits": { + "smithy.api#documentation": "

Information about a configured plugin.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#ListRetrievers": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#ListRetrieversRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#ListRetrieversResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the retriever used by an Amazon Q application.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/retrievers", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "retrievers" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#ListRetrieversRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application using the retriever.

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

If the number of retrievers returned exceeds maxResults, Amazon Q\n returns a next token as a pagination token to retrieve the next set of\n retrievers.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qbusiness#MaxResultsIntegerForListRetrieversRequest", + "traits": { + "smithy.api#documentation": "

The maximum number of retrievers returned.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#ListRetrieversResponse": { + "type": "structure", + "members": { + "retrievers": { + "target": "com.amazonaws.qbusiness#Retrievers", + "traits": { + "smithy.api#documentation": "

An array of summary information for one or more retrievers.

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

If the response is truncated, Amazon Q returns this token, which you can use in a\n later request to list the next set of retrievers.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of tags associated with a specified resource. Amazon Q applications\n and data sources can have tags associated with them.

", + "smithy.api#http": { + "uri": "/v1/tags/{resourceARN}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceARN": { + "target": "com.amazonaws.qbusiness#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q application or data source to get\n a list of tags for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.qbusiness#Tags", + "traits": { + "smithy.api#documentation": "

A list of tags associated with the Amazon Q application or data source.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#ListWebExperiences": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#ListWebExperiencesRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#ListWebExperiencesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists one or more Amazon Q Web Experiences.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/experiences", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "webExperiences" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#ListWebExperiencesRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application linked to the listed web\n experiences.

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

If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q conversations.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qbusiness#MaxResultsIntegerForListWebExperiencesRequest", + "traits": { + "smithy.api#documentation": "

The maximum number of Amazon Q Web Experiences to return.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#ListWebExperiencesResponse": { + "type": "structure", + "members": { + "webExperiences": { + "target": "com.amazonaws.qbusiness#WebExperiences", + "traits": { + "smithy.api#documentation": "

An array of summary information for one or more Amazon Q experiences.

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

If the response is truncated, Amazon Q returns this token, which you can use in a\n later request to list the next set of messages.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#Long": { + "type": "long" + }, + "com.amazonaws.qbusiness#MaxResultsIntegerForGetTopicConfigurations": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.qbusiness#MaxResultsIntegerForListApplications": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.qbusiness#MaxResultsIntegerForListConversations": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.qbusiness#MaxResultsIntegerForListDataSources": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.qbusiness#MaxResultsIntegerForListDataSourcesSyncJobs": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.qbusiness#MaxResultsIntegerForListDocuments": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.qbusiness#MaxResultsIntegerForListGroupsRequest": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.qbusiness#MaxResultsIntegerForListIndices": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.qbusiness#MaxResultsIntegerForListMessages": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.qbusiness#MaxResultsIntegerForListPlugins": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.qbusiness#MaxResultsIntegerForListRetrieversRequest": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.qbusiness#MaxResultsIntegerForListWebExperiencesRequest": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.qbusiness#MemberGroup": { + "type": "structure", + "members": { + "groupName": { + "target": "com.amazonaws.qbusiness#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the sub group.

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

The type of the sub group.

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

The sub groups that belong to a group.

" + } + }, + "com.amazonaws.qbusiness#MemberGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#MemberGroup" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.qbusiness#MemberRelation": { + "type": "enum", + "members": { + "AND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AND" + } + }, + "OR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OR" + } + } + } + }, + "com.amazonaws.qbusiness#MemberUser": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.qbusiness#DataSourceUserId", + "traits": { + "smithy.api#documentation": "

The identifier of the user you want to map to a group.

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

The type of the user.

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

The users that belong to a group.

" + } + }, + "com.amazonaws.qbusiness#MemberUsers": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#MemberUser" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.qbusiness#MembershipType": { + "type": "enum", + "members": { + "INDEX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INDEX" + } + }, + "DATASOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATASOURCE" + } + } + } + }, + "com.amazonaws.qbusiness#Message": { + "type": "structure", + "members": { + "messageId": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q web experience message.

" + } + }, + "body": { + "target": "com.amazonaws.qbusiness#MessageBody", + "traits": { + "smithy.api#documentation": "

The content of the Amazon Q web experience message.

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

The timestamp of the first Amazon Q web experience message.

" + } + }, + "type": { + "target": "com.amazonaws.qbusiness#MessageType", + "traits": { + "smithy.api#documentation": "

The type of Amazon Q message, whether HUMAN or AI\n generated.

" + } + }, + "attachments": { + "target": "com.amazonaws.qbusiness#AttachmentsOutput", + "traits": { + "smithy.api#documentation": "

A file directly uploaded into an Amazon Q web experience chat.

" + } + }, + "sourceAttribution": { + "target": "com.amazonaws.qbusiness#SourceAttributions", + "traits": { + "smithy.api#documentation": "

The source documents used to generate Amazon Q web experience message.

" + } + }, + "actionReview": { + "target": "com.amazonaws.qbusiness#ActionReview" + }, + "actionExecution": { + "target": "com.amazonaws.qbusiness#ActionExecution" + } + }, + "traits": { + "smithy.api#documentation": "

A message in an Amazon Q web experience.

" + } + }, + "com.amazonaws.qbusiness#MessageBody": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + }, + "smithy.api#pattern": "^\\P{C}*$}$" + } + }, + "com.amazonaws.qbusiness#MessageId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" + } + }, + "com.amazonaws.qbusiness#MessageType": { + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER" + } + }, + "SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYSTEM" + } + } + } + }, + "com.amazonaws.qbusiness#MessageUsefulness": { + "type": "enum", + "members": { + "USEFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USEFUL" + } + }, + "NOT_USEFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_USEFUL" + } + } + } + }, + "com.amazonaws.qbusiness#MessageUsefulnessComment": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + }, + "smithy.api#pattern": "^\\P{C}*$" + } + }, + "com.amazonaws.qbusiness#MessageUsefulnessFeedback": { + "type": "structure", + "members": { + "usefulness": { + "target": "com.amazonaws.qbusiness#MessageUsefulness", + "traits": { + "smithy.api#documentation": "

The usefulness value assigned by an end user to a message.

", + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.qbusiness#MessageUsefulnessReason", + "traits": { + "smithy.api#documentation": "

The reason for a usefulness rating.

" + } + }, + "comment": { + "target": "com.amazonaws.qbusiness#MessageUsefulnessComment", + "traits": { + "smithy.api#documentation": "

A comment given by an end user on the usefulness of an AI-generated chat\n message.

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

The timestamp for when the feedback was submitted.

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

End user feedback on an AI-generated web experience chat message usefulness.

" + } + }, + "com.amazonaws.qbusiness#MessageUsefulnessReason": { + "type": "enum", + "members": { + "NOT_FACTUALLY_CORRECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_FACTUALLY_CORRECT" + } + }, + "HARMFUL_OR_UNSAFE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HARMFUL_OR_UNSAFE" + } + }, + "INCORRECT_OR_MISSING_SOURCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCORRECT_OR_MISSING_SOURCES" + } + }, + "NOT_HELPFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_HELPFUL" + } + }, + "FACTUALLY_CORRECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FACTUALLY_CORRECT" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "RELEVANT_SOURCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RELEVANT_SOURCES" + } + }, + "HELPFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HELPFUL" + } + } + } + }, + "com.amazonaws.qbusiness#Messages": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#Message" + } + }, + "com.amazonaws.qbusiness#MetricValue": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(([1-9][0-9]*)|0)$" + } + }, + "com.amazonaws.qbusiness#NativeIndexConfiguration": { + "type": "structure", + "members": { + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier for the Amazon Q index.

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

Configuration information for an Amazon Q index.

" + } + }, + "com.amazonaws.qbusiness#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 800 + } + } + }, + "com.amazonaws.qbusiness#OAuth2ClientCredentialConfiguration": { + "type": "structure", + "members": { + "secretArn": { + "target": "com.amazonaws.qbusiness#SecretArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token\n used for plugin configuration.

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

The ARN of an IAM role used by Amazon Q to access the OAuth 2.0\n authentication credentials stored in a Secrets Manager secret.

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

Information about the OAuth 2.0 authentication credential/token used to configure a\n plugin.

" + } + }, + "com.amazonaws.qbusiness#Plugin": { + "type": "structure", + "members": { + "pluginId": { + "target": "com.amazonaws.qbusiness#PluginId", + "traits": { + "smithy.api#documentation": "

The identifier of the plugin.

" + } + }, + "displayName": { + "target": "com.amazonaws.qbusiness#PluginName", + "traits": { + "smithy.api#documentation": "

The name of the plugin.

" + } + }, + "type": { + "target": "com.amazonaws.qbusiness#PluginType", + "traits": { + "smithy.api#documentation": "

The type of the plugin.

" + } + }, + "serverUrl": { + "target": "com.amazonaws.qbusiness#Url", + "traits": { + "smithy.api#documentation": "

The plugin server URL used for configuration.

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

The current status of the plugin.

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

The timestamp for when the plugin was created.

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

The timestamp for when the plugin was last updated.

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

Information about an Amazon Q plugin and its configuration.

" + } + }, + "com.amazonaws.qbusiness#PluginArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1284 + }, + "smithy.api#pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" + } + }, + "com.amazonaws.qbusiness#PluginAuthConfiguration": { + "type": "union", + "members": { + "basicAuthConfiguration": { + "target": "com.amazonaws.qbusiness#BasicAuthConfiguration", + "traits": { + "smithy.api#documentation": "

Information about the basic authentication credentials used to configure a\n plugin.

" + } + }, + "oAuth2ClientCredentialConfiguration": { + "target": "com.amazonaws.qbusiness#OAuth2ClientCredentialConfiguration", + "traits": { + "smithy.api#documentation": "

Information about the OAuth 2.0 authentication credential/token used to configure a\n plugin.

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

Authentication configuration information for an Amazon Q plugin.

" + } + }, + "com.amazonaws.qbusiness#PluginId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.qbusiness#PluginName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$" + } + }, + "com.amazonaws.qbusiness#PluginResource": { + "type": "resource", + "identifiers": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId" + }, + "pluginId": { + "target": "com.amazonaws.qbusiness#PluginId" + } + }, + "create": { + "target": "com.amazonaws.qbusiness#CreatePlugin" + }, + "read": { + "target": "com.amazonaws.qbusiness#GetPlugin" + }, + "update": { + "target": "com.amazonaws.qbusiness#UpdatePlugin" + }, + "delete": { + "target": "com.amazonaws.qbusiness#DeletePlugin" + }, + "list": { + "target": "com.amazonaws.qbusiness#ListPlugins" + }, + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Plugin" + } + } + }, + "com.amazonaws.qbusiness#PluginState": { + "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.qbusiness#PluginType": { + "type": "enum", + "members": { + "SERVICE_NOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE_NOW" + } + }, + "SALESFORCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SALESFORCE" + } + }, + "JIRA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JIRA" + } + }, + "ZENDESK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZENDESK" + } + } + } + }, + "com.amazonaws.qbusiness#Plugins": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#Plugin" + } + }, + "com.amazonaws.qbusiness#Principal": { + "type": "union", + "members": { + "user": { + "target": "com.amazonaws.qbusiness#PrincipalUser", + "traits": { + "smithy.api#documentation": "

The user associated with the principal.

" + } + }, + "group": { + "target": "com.amazonaws.qbusiness#PrincipalGroup", + "traits": { + "smithy.api#documentation": "

The group associated with the principal.

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

Provides user and group information used for filtering documents to use for generating\n Amazon Q conversation responses.

" + } + }, + "com.amazonaws.qbusiness#PrincipalGroup": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.qbusiness#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group.

" + } + }, + "access": { + "target": "com.amazonaws.qbusiness#ReadAccessType", + "traits": { + "smithy.api#documentation": "

Provides information about whether to allow or deny access to the principal.

", + "smithy.api#required": {} + } + }, + "membershipType": { + "target": "com.amazonaws.qbusiness#MembershipType", + "traits": { + "smithy.api#documentation": "

The type of group.

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

Provides information about a group associated with the principal.

" + } + }, + "com.amazonaws.qbusiness#PrincipalUser": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.qbusiness#UserId", + "traits": { + "smithy.api#documentation": "

The identifier of the user.

" + } + }, + "access": { + "target": "com.amazonaws.qbusiness#ReadAccessType", + "traits": { + "smithy.api#documentation": "

Provides information about whether to allow or deny access to the principal.

", + "smithy.api#required": {} + } + }, + "membershipType": { + "target": "com.amazonaws.qbusiness#MembershipType", + "traits": { + "smithy.api#documentation": "

The type of group.

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

Provides information about a user associated with a principal.

" + } + }, + "com.amazonaws.qbusiness#Principals": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#Principal" + } + }, + "com.amazonaws.qbusiness#PutFeedback": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#PutFeedbackRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Enables your end user to to provide feedback on their Amazon Q generated chat\n responses.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/conversations/{conversationId}/messages/{messageId}/feedback", + "method": "POST" + } + } + }, + "com.amazonaws.qbusiness#PutFeedbackRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the application associated with the feedback.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userId": { + "target": "com.amazonaws.qbusiness#UserId", + "traits": { + "smithy.api#documentation": "

The identifier of the user giving the feedback.

", + "smithy.api#httpQuery": "userId", + "smithy.api#required": {} + } + }, + "conversationId": { + "target": "com.amazonaws.qbusiness#ConversationId", + "traits": { + "smithy.api#documentation": "

The identifier of the conversation the feedback is attached to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "messageId": { + "target": "com.amazonaws.qbusiness#SystemMessageId", + "traits": { + "smithy.api#documentation": "

The identifier of the chat message that the feedback was given for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "messageCopiedAt": { + "target": "com.amazonaws.qbusiness#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp for when the feedback was recorded.

" + } + }, + "messageUsefulness": { + "target": "com.amazonaws.qbusiness#MessageUsefulnessFeedback", + "traits": { + "smithy.api#documentation": "

The feedback usefulness value given by the user to the chat message.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#PutGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#PutGroupRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#PutGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Create, or updates, a mapping of users—who have access to a document—to\n groups.

\n

You can also map sub groups to groups. For example, the group \"Company Intellectual\n Property Teams\" includes sub groups \"Research\" and \"Engineering\". These sub groups\n include their own list of users or people who work in these teams. Only users who work\n in research and engineering, and therefore belong in the intellectual property group,\n can see top-secret company documents in their Amazon Q chat results.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/applications/{applicationId}/indices/{indexId}/groups" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#PutGroupRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the application in which the user and group mapping belongs.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the index in which you want to map users to their groups.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "groupName": { + "target": "com.amazonaws.qbusiness#GroupName", + "traits": { + "smithy.api#documentation": "

The list that contains your users or sub groups that belong the same group. For\n example, the group \"Company\" includes the user \"CEO\" and the sub groups \"Research\",\n \"Engineering\", and \"Sales and Marketing\".

\n

If you have more than 1000 users and/or sub groups for a single group, you need to\n provide the path to the S3 file that lists your users and sub groups for a group. Your\n sub groups can contain more than 1000 users, but the list of sub groups that belong to a\n group (and/or users) must be no more than 1000.

", + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.qbusiness#DataSourceId", + "traits": { + "smithy.api#documentation": "

The identifier of the data source for which you want to map users to their groups.\n This is useful if a group is tied to multiple data sources, but you only want the group\n to access documents of a certain data source. For example, the groups \"Research\",\n \"Engineering\", and \"Sales and Marketing\" are all tied to the company's documents stored\n in the data sources Confluence and Salesforce. However, \"Sales and Marketing\" team only\n needs access to customer-related documents stored in Salesforce.

" + } + }, + "type": { + "target": "com.amazonaws.qbusiness#MembershipType", + "traits": { + "smithy.api#documentation": "

The type of the group.

", + "smithy.api#required": {} + } + }, + "groupMembers": { + "target": "com.amazonaws.qbusiness#GroupMembers", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#PutGroupResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#ReadAccessType": { + "type": "enum", + "members": { + "ALLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALLOW" + } + }, + "DENY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DENY" + } + } + } + }, + "com.amazonaws.qbusiness#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.qbusiness#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The message describing a ResourceNotFoundException.

", + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The identifier of the resource affected.

", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The type of the resource affected.

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

The resource you want to use doesn’t exist. Make sure you have provided the correct\n resource and try again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.qbusiness#ResponseScope": { + "type": "enum", + "members": { + "ENTERPRISE_CONTENT_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENTERPRISE_CONTENT_ONLY" + } + }, + "EXTENDED_KNOWLEDGE_ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTENDED_KNOWLEDGE_ENABLED" + } + } + } + }, + "com.amazonaws.qbusiness#Retriever": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application using the retriever.

" + } + }, + "retrieverId": { + "target": "com.amazonaws.qbusiness#RetrieverId", + "traits": { + "smithy.api#documentation": "

The identifier of the retriever used by your Amazon Q application.

" + } + }, + "type": { + "target": "com.amazonaws.qbusiness#RetrieverType", + "traits": { + "smithy.api#documentation": "

The type of your retriever.

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

The status of your retriever.

" + } + }, + "displayName": { + "target": "com.amazonaws.qbusiness#RetrieverName", + "traits": { + "smithy.api#documentation": "

The name of your retriever.

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

Summary information for the retriever used for your Amazon Q application.

" + } + }, + "com.amazonaws.qbusiness#RetrieverArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1284 + }, + "smithy.api#pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" + } + }, + "com.amazonaws.qbusiness#RetrieverConfiguration": { + "type": "union", + "members": { + "nativeIndexConfiguration": { + "target": "com.amazonaws.qbusiness#NativeIndexConfiguration", + "traits": { + "smithy.api#documentation": "

Provides information on how a Amazon Q index used as a retriever for your\n Amazon Q application is configured.

" + } + }, + "kendraIndexConfiguration": { + "target": "com.amazonaws.qbusiness#KendraIndexConfiguration", + "traits": { + "smithy.api#documentation": "

Provides information on how the Amazon Kendra index used as a retriever for your\n Amazon Q application is configured.

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

Provides information on how the retriever used for your Amazon Q application is\n configured.

" + } + }, + "com.amazonaws.qbusiness#RetrieverId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" + } + }, + "com.amazonaws.qbusiness#RetrieverName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$" + } + }, + "com.amazonaws.qbusiness#RetrieverResource": { + "type": "resource", + "identifiers": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId" + }, + "retrieverId": { + "target": "com.amazonaws.qbusiness#RetrieverId" + } + }, + "create": { + "target": "com.amazonaws.qbusiness#CreateRetriever" + }, + "read": { + "target": "com.amazonaws.qbusiness#GetRetriever" + }, + "update": { + "target": "com.amazonaws.qbusiness#UpdateRetriever" + }, + "delete": { + "target": "com.amazonaws.qbusiness#DeleteRetriever" + }, + "list": { + "target": "com.amazonaws.qbusiness#ListRetrievers" + }, + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Retriever" + } + } + }, + "com.amazonaws.qbusiness#RetrieverStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.qbusiness#RetrieverType": { + "type": "enum", + "members": { + "NATIVE_INDEX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NATIVE_INDEX" + } + }, + "KENDRA_INDEX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KENDRA_INDEX" + } + } + } + }, + "com.amazonaws.qbusiness#Retrievers": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#Retriever" + } + }, + "com.amazonaws.qbusiness#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1284 + }, + "smithy.api#pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" + } + }, + "com.amazonaws.qbusiness#Rule": { + "type": "structure", + "members": { + "includedUsersAndGroups": { + "target": "com.amazonaws.qbusiness#UsersAndGroups", + "traits": { + "smithy.api#documentation": "

Users and groups to be included in a rule.

" + } + }, + "excludedUsersAndGroups": { + "target": "com.amazonaws.qbusiness#UsersAndGroups", + "traits": { + "smithy.api#documentation": "

Users and groups to be excluded from a rule.

" + } + }, + "ruleType": { + "target": "com.amazonaws.qbusiness#RuleType", + "traits": { + "smithy.api#documentation": "

The type fo rule.

", + "smithy.api#required": {} + } + }, + "ruleConfiguration": { + "target": "com.amazonaws.qbusiness#RuleConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information for a rule.

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

Guardrail rules for an Amazon Q application. Amazon Q supports only one rule\n at a time.

" + } + }, + "com.amazonaws.qbusiness#RuleConfiguration": { + "type": "union", + "members": { + "contentBlockerRule": { + "target": "com.amazonaws.qbusiness#ContentBlockerRule", + "traits": { + "smithy.api#documentation": "

A rule for configuring how Amazon Q responds when it encounters a a blocked\n topic.

" + } + }, + "contentRetrievalRule": { + "target": "com.amazonaws.qbusiness#ContentRetrievalRule" + } + }, + "traits": { + "smithy.api#documentation": "

Provides configuration information about a rule.

" + } + }, + "com.amazonaws.qbusiness#RuleType": { + "type": "enum", + "members": { + "CONTENT_BLOCKER_RULE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTENT_BLOCKER_RULE" + } + }, + "CONTENT_RETRIEVAL_RULE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTENT_RETRIEVAL_RULE" + } + } + } + }, + "com.amazonaws.qbusiness#Rules": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#Rule" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.qbusiness#S3": { + "type": "structure", + "members": { + "bucket": { + "target": "com.amazonaws.qbusiness#S3BucketName", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket that contains the file.

", + "smithy.api#required": {} + } + }, + "key": { + "target": "com.amazonaws.qbusiness#S3ObjectKey", + "traits": { + "smithy.api#documentation": "

The name of the file.

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

Information required for Amazon Q to find a specific file in an Amazon S3\n bucket.

" + } + }, + "com.amazonaws.qbusiness#S3BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + } + }, + "com.amazonaws.qbusiness#S3ObjectKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.qbusiness#SamlAttribute": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.qbusiness#SamlConfiguration": { + "type": "structure", + "members": { + "metadataXML": { + "target": "com.amazonaws.qbusiness#SamlMetadataXML", + "traits": { + "smithy.api#documentation": "

The metadata XML that your IdP generated.

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

The Amazon Resource Name (ARN) of an IAM role assumed by users when\n they authenticate into their Amazon Q web experience, containing the relevant\n Amazon Q permissions for conversing with Amazon Q.

", + "smithy.api#required": {} + } + }, + "userIdAttribute": { + "target": "com.amazonaws.qbusiness#SamlAttribute", + "traits": { + "smithy.api#documentation": "

The user attribute name in your IdP that maps to the user email.

", + "smithy.api#required": {} + } + }, + "userGroupAttribute": { + "target": "com.amazonaws.qbusiness#SamlAttribute", + "traits": { + "smithy.api#documentation": "

The group attribute name in your IdP that maps to user groups.

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

Provides the SAML 2.0 compliant identity provider (IdP) configuration information\n Amazon Q needs to deploy a Amazon Q web experience.

" + } + }, + "com.amazonaws.qbusiness#SamlMetadataXML": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1000, + "max": 10000000 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.qbusiness#SecretArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1284 + }, + "smithy.api#pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" + } + }, + "com.amazonaws.qbusiness#SecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.qbusiness#SecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#SecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.qbusiness#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.qbusiness#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The message describing a ServiceQuotaExceededException.

", + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The identifier of the resource affected.

", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The type of the resource affected.

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

You have exceeded the set limits for your Amazon Q service.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.qbusiness#SourceAttribution": { + "type": "structure", + "members": { + "title": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The title of the document which is the source for the Amazon Q generated\n response.

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

The content extract from the document on which the generated response is based.\n

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

The URL of the document which is the source for the Amazon Q generated response.\n

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

The number attached to a citation in an Amazon Q generated response.

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

The Unix timestamp when the Amazon Q application was last updated.

" + } + }, + "textMessageSegments": { + "target": "com.amazonaws.qbusiness#TextSegmentList", + "traits": { + "smithy.api#documentation": "

A text extract from a source document that is used for source attribution.

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

The documents used to generate an Amazon Q web experience response.

" + } + }, + "com.amazonaws.qbusiness#SourceAttributions": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#SourceAttribution" + }, + "traits": { + "smithy.api#sparse": {} + } + }, + "com.amazonaws.qbusiness#StartDataSourceSyncJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#StartDataSourceSyncJobRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#StartDataSourceSyncJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a data source connector synchronization job. If a synchronization job is\n already in progress, Amazon Q returns a ConflictException.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/startsync", + "method": "POST" + } + } + }, + "com.amazonaws.qbusiness#StartDataSourceSyncJobRequest": { + "type": "structure", + "members": { + "dataSourceId": { + "target": "com.amazonaws.qbusiness#DataSourceId", + "traits": { + "smithy.api#documentation": "

The identifier of the data source connector.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of Amazon Q application the data source is connected to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the index used with the data source connector.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#StartDataSourceSyncJobResponse": { + "type": "structure", + "members": { + "executionId": { + "target": "com.amazonaws.qbusiness#ExecutionId", + "traits": { + "smithy.api#documentation": "

The identifier for a particular synchronization job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#Status": { + "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.qbusiness#StopDataSourceSyncJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#StopDataSourceSyncJobRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#StopDataSourceSyncJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops an Amazon Q data source connector synchronization job already in\n progress.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/stopsync", + "method": "POST" + } + } + }, + "com.amazonaws.qbusiness#StopDataSourceSyncJobRequest": { + "type": "structure", + "members": { + "dataSourceId": { + "target": "com.amazonaws.qbusiness#DataSourceId", + "traits": { + "smithy.api#documentation": "

The identifier of the data source connector.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application that the data source is connected\n to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the index used with the Amazon Q data source connector.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#StopDataSourceSyncJobResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#String": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.qbusiness#SubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.qbusiness#SubnetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#SubnetId" + } + }, + "com.amazonaws.qbusiness#SyncSchedule": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 998 + }, + "smithy.api#pattern": "^\\P{C}*$" + } + }, + "com.amazonaws.qbusiness#SystemMessageId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" + } + }, + "com.amazonaws.qbusiness#SystemMessageOverride": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 350 + }, + "smithy.api#pattern": "^\\P{C}*$" + } + }, + "com.amazonaws.qbusiness#Tag": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.qbusiness#TagKey", + "traits": { + "smithy.api#documentation": "

The key for the tag. Keys are not case sensitive and must be unique for the\n Amazon Q application or data source.

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

The value associated with the tag. The value may be an empty string but it can't be\n null.

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

A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and\n values can consist of Unicode letters, digits, white space, and any of the following\n symbols: _ . : / = + - @.

" + } + }, + "com.amazonaws.qbusiness#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.qbusiness#TagKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.qbusiness#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds the specified tag to the specified Amazon Q application or data source\n resource. If the tag already exists, the existing value is replaced with the new\n value.

", + "smithy.api#http": { + "uri": "/v1/tags/{resourceARN}", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#TagResourceRequest": { + "type": "structure", + "members": { + "resourceARN": { + "target": "com.amazonaws.qbusiness#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q application or data source to\n tag.

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

A list of tag keys to add to the Amazon Q application or data source. If a tag\n already exists, the existing value is replaced with the new value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.qbusiness#Tags": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.qbusiness#TextDocumentStatistics": { + "type": "structure", + "members": { + "indexedTextBytes": { + "target": "com.amazonaws.qbusiness#IndexedTextBytes", + "traits": { + "smithy.api#documentation": "

The total size, in bytes, of the indexed documents.

" + } + }, + "indexedTextDocumentCount": { + "target": "com.amazonaws.qbusiness#IndexedTextDocument", + "traits": { + "smithy.api#documentation": "

The number of text documents indexed.

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

Provides information about text documents in an index.

" + } + }, + "com.amazonaws.qbusiness#TextSegment": { + "type": "structure", + "members": { + "beginOffset": { + "target": "com.amazonaws.qbusiness#Integer", + "traits": { + "smithy.api#documentation": "

The zero-based location in the response string where the source attribution\n starts.

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

The zero-based location in the response string where the source attribution\n ends.

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

Provides information about a text extract in a chat response that can be attributed to\n a source document.

" + } + }, + "com.amazonaws.qbusiness#TextSegmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#TextSegment" + } + }, + "com.amazonaws.qbusiness#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.qbusiness#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request was denied due to throttling. Reduce the number of requests and try\n again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.qbusiness#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.qbusiness#Title": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.qbusiness#TopicConfiguration": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.qbusiness#TopicConfigurationName", + "traits": { + "smithy.api#documentation": "

A name for your topic control configuration.

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

A description for your topic control configuration. Use this outline how the large\n language model (LLM) should use this topic control configuration.

" + } + }, + "exampleChatMessages": { + "target": "com.amazonaws.qbusiness#ExampleChatMessages", + "traits": { + "smithy.api#documentation": "

A list of example phrases that you expect the end user to use in relation to the\n topic.

" + } + }, + "rules": { + "target": "com.amazonaws.qbusiness#Rules", + "traits": { + "smithy.api#documentation": "

Rules defined for a topic configuration.

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

The topic specific controls configured for an Amazon Q application.

" + } + }, + "com.amazonaws.qbusiness#TopicConfigurationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{0,35}$" + } + }, + "com.amazonaws.qbusiness#TopicConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#TopicConfiguration" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.qbusiness#TopicDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 350 + }, + "smithy.api#pattern": "^\\P{C}*$" + } + }, + "com.amazonaws.qbusiness#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a tag from an Amazon Q application or a data source.

", + "smithy.api#http": { + "uri": "/v1/tags/{resourceARN}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceARN": { + "target": "com.amazonaws.qbusiness#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q application, or data source to\n remove the tag from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.qbusiness#TagKeys", + "traits": { + "smithy.api#documentation": "

A list of tag keys to remove from the Amazon Q application or data source. If a\n tag key does not exist on the resource, it is ignored.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#UpdateApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#UpdateApplicationRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#UpdateApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:GetApplication", + "qbusiness:TagResource", + "qbusiness:UntagResource", + "qbusiness:ListTagsForResource", + "iam:PassRole" + ], + "smithy.api#documentation": "

Updates an existing Amazon Q application.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}", + "method": "PUT" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#UpdateApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "displayName": { + "target": "com.amazonaws.qbusiness#ApplicationName", + "traits": { + "smithy.api#documentation": "

A name for the Amazon Q application.

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

A description for the Amazon Q application.

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

An Amazon Web Services Identity and Access Management (IAM) role that\n gives Amazon Q permission to access Amazon CloudWatch logs and\n metrics.

" + } + }, + "attachmentsConfiguration": { + "target": "com.amazonaws.qbusiness#AttachmentsConfiguration", + "traits": { + "smithy.api#documentation": "

An option to allow end users to upload files directly during chat.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#UpdateApplicationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#UpdateChatControlsConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#UpdateChatControlsConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#UpdateChatControlsConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an set of chat controls configured for an existing Amazon Q\n application.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/chatcontrols", + "method": "PATCH", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#UpdateChatControlsConfigurationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the application for which the chat controls are configured.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.qbusiness#ClientToken", + "traits": { + "smithy.api#documentation": "

A token that you provide to identify the request to update a Amazon Q application\n chat configuration.

", + "smithy.api#idempotencyToken": {} + } + }, + "responseScope": { + "target": "com.amazonaws.qbusiness#ResponseScope", + "traits": { + "smithy.api#documentation": "

The response scope configured for your application. This determines whether your\n application uses its retrieval augmented generation (RAG) system to generate answers\n only from your enterprise data, or also uses the large language models (LLM) knowledge\n to respons to end user questions in chat.

" + } + }, + "blockedPhrasesConfigurationUpdate": { + "target": "com.amazonaws.qbusiness#BlockedPhrasesConfigurationUpdate", + "traits": { + "smithy.api#documentation": "

The phrases blocked from chat by your chat control configuration.

" + } + }, + "topicConfigurationsToCreateOrUpdate": { + "target": "com.amazonaws.qbusiness#TopicConfigurations", + "traits": { + "smithy.api#documentation": "

The configured topic specific chat controls you want to update.

" + } + }, + "topicConfigurationsToDelete": { + "target": "com.amazonaws.qbusiness#TopicConfigurations", + "traits": { + "smithy.api#documentation": "

The configured topic specific chat controls you want to delete.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#UpdateChatControlsConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#UpdateDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#UpdateDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#UpdateDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:GetDataSource", + "qbusiness:TagResource", + "qbusiness:UntagResource", + "qbusiness:ListTagsForResource", + "iam:PassRole" + ], + "smithy.api#documentation": "

Updates an existing Amazon Q data source connector.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}", + "method": "PUT" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#UpdateDataSourceRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application the data source is attached\n to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the index attached to the data source connector.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.qbusiness#DataSourceId", + "traits": { + "smithy.api#documentation": "

The identifier of the data source connector.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "displayName": { + "target": "com.amazonaws.qbusiness#DataSourceName", + "traits": { + "smithy.api#documentation": "

A name of the data source connector.

" + } + }, + "configuration": { + "target": "com.amazonaws.qbusiness#DataSourceConfiguration" + }, + "vpcConfiguration": { + "target": "com.amazonaws.qbusiness#DataSourceVpcConfiguration" + }, + "description": { + "target": "com.amazonaws.qbusiness#Description", + "traits": { + "smithy.api#documentation": "

The description of the data source connector.

" + } + }, + "syncSchedule": { + "target": "com.amazonaws.qbusiness#SyncSchedule", + "traits": { + "smithy.api#documentation": "

The chosen update frequency for your data source.

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

The Amazon Resource Name (ARN) of an IAM role with permission to access\n the data source and required resources.

" + } + }, + "documentEnrichmentConfiguration": { + "target": "com.amazonaws.qbusiness#DocumentEnrichmentConfiguration" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#UpdateDataSourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#UpdateIndex": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#UpdateIndexRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#UpdateIndexResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:GetIndex", + "qbusiness:TagResource", + "qbusiness:UntagResource", + "qbusiness:ListTagsForResource" + ], + "smithy.api#documentation": "

Updates an Amazon Q index.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/indices/{indexId}", + "method": "PUT" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#UpdateIndexRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application connected to the index.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q index.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "displayName": { + "target": "com.amazonaws.qbusiness#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Q index.

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

The description of the Amazon Q index.

" + } + }, + "capacityConfiguration": { + "target": "com.amazonaws.qbusiness#IndexCapacityConfiguration", + "traits": { + "smithy.api#documentation": "

The storage capacity units you want to provision for your Amazon Q index. You can\n add and remove capacity to fit your usage needs.

" + } + }, + "documentAttributeConfigurations": { + "target": "com.amazonaws.qbusiness#DocumentAttributeConfigurations", + "traits": { + "smithy.api#documentation": "

Configuration information for document metadata or fields. Document metadata are\n fields or attributes associated with your documents. For example, the company department\n name associated with each document. For more information, see Understanding document attributes.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#UpdateIndexResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#UpdatePlugin": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#UpdatePluginRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#UpdatePluginResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:GetPlugin", + "qbusiness:TagResource", + "qbusiness:UntagResource", + "qbusiness:ListTagsForResource", + "iam:PassRole" + ], + "smithy.api#documentation": "

Updates an Amazon Q plugin.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/applications/{applicationId}/plugins/{pluginId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#UpdatePluginRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the application the plugin is attached to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "pluginId": { + "target": "com.amazonaws.qbusiness#PluginId", + "traits": { + "smithy.api#documentation": "

The identifier of the plugin.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "displayName": { + "target": "com.amazonaws.qbusiness#PluginName", + "traits": { + "smithy.api#documentation": "

The name of the plugin.

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

The status of the plugin.

" + } + }, + "serverUrl": { + "target": "com.amazonaws.qbusiness#Url", + "traits": { + "smithy.api#documentation": "

The source URL used for plugin configuration.

" + } + }, + "authConfiguration": { + "target": "com.amazonaws.qbusiness#PluginAuthConfiguration", + "traits": { + "smithy.api#documentation": "

The authentication configuration the plugin is using.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#UpdatePluginResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#UpdateRetriever": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#UpdateRetrieverRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#UpdateRetrieverResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:TagResource", + "qbusiness:UntagResource", + "qbusiness:ListTagsForResource", + "qbusiness:GetRetriever", + "iam:PassRole" + ], + "smithy.api#documentation": "

Updates the retriever used for your Amazon Q application.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/applications/{applicationId}/retrievers/{retrieverId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#UpdateRetrieverRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of your Amazon Q application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "retrieverId": { + "target": "com.amazonaws.qbusiness#RetrieverId", + "traits": { + "smithy.api#documentation": "

The identifier of your retriever.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.qbusiness#RetrieverConfiguration" + }, + "displayName": { + "target": "com.amazonaws.qbusiness#RetrieverName", + "traits": { + "smithy.api#documentation": "

The name of your retriever.

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

The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever\n and required resources.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#UpdateRetrieverResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#UpdateUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#UpdateUserRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#UpdateUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a information associated with a user id.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/applications/{applicationId}/users/{userId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#UpdateUserRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the application the user is attached to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userId": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The email id attached to the user.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userAliasesToUpdate": { + "target": "com.amazonaws.qbusiness#UserAliases", + "traits": { + "smithy.api#documentation": "

The user aliases attached to the user id that are to be updated.

" + } + }, + "userAliasesToDelete": { + "target": "com.amazonaws.qbusiness#UserAliases", + "traits": { + "smithy.api#documentation": "

The user aliases attached to the user id that are to be deleted.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#UpdateUserResponse": { + "type": "structure", + "members": { + "userAliasesAdded": { + "target": "com.amazonaws.qbusiness#UserAliases", + "traits": { + "smithy.api#documentation": "

The user aliases that have been to be added to a user id.

" + } + }, + "userAliasesUpdated": { + "target": "com.amazonaws.qbusiness#UserAliases", + "traits": { + "smithy.api#documentation": "

The user aliases attached to a user id that have been updated.

" + } + }, + "userAliasesDeleted": { + "target": "com.amazonaws.qbusiness#UserAliases", + "traits": { + "smithy.api#documentation": "

The user aliases that have been deleted from a user id.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#UpdateWebExperience": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#UpdateWebExperienceRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#UpdateWebExperienceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "qbusiness:GetWebExperience", + "qbusiness:TagResource", + "qbusiness:UntagResource", + "qbusiness:ListTagsForResource", + "iam:PassRole" + ], + "smithy.api#documentation": "

Updates an Amazon Q web experience.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/experiences/{webExperienceId}", + "method": "PUT" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qbusiness#UpdateWebExperienceRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q application attached to the web experience.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "webExperienceId": { + "target": "com.amazonaws.qbusiness#WebExperienceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q web experience.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "authenticationConfiguration": { + "target": "com.amazonaws.qbusiness#WebExperienceAuthConfiguration", + "traits": { + "smithy.api#documentation": "

The authentication configuration of the Amazon Q web experience.

" + } + }, + "title": { + "target": "com.amazonaws.qbusiness#WebExperienceTitle", + "traits": { + "smithy.api#documentation": "

The title of the Amazon Q web experience.

" + } + }, + "subtitle": { + "target": "com.amazonaws.qbusiness#WebExperienceSubtitle", + "traits": { + "smithy.api#documentation": "

The subtitle of the Amazon Q web experience.

" + } + }, + "welcomeMessage": { + "target": "com.amazonaws.qbusiness#WebExperienceWelcomeMessage", + "traits": { + "smithy.api#documentation": "

A customized welcome message for an end user in an Amazon Q web\n experience.

" + } + }, + "samplePromptsControlMode": { + "target": "com.amazonaws.qbusiness#WebExperienceSamplePromptsControlMode", + "traits": { + "smithy.api#documentation": "

Determines whether sample prompts are enabled in the web experience for an end\n user.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#UpdateWebExperienceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#Url": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(https?|ftp|file)://([^\\s]*)$" + } + }, + "com.amazonaws.qbusiness#UserAlias": { + "type": "structure", + "members": { + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the index that the user aliases are associated with.

" + } + }, + "dataSourceId": { + "target": "com.amazonaws.qbusiness#DataSourceId", + "traits": { + "smithy.api#documentation": "

The identifier of the data source that the user aliases are associated with.

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

The identifier of the user id associated with the user aliases.

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

Aliases attached to a user id within an Amazon Q application.

" + } + }, + "com.amazonaws.qbusiness#UserAliases": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#UserAlias" + } + }, + "com.amazonaws.qbusiness#UserGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#String" + } + }, + "com.amazonaws.qbusiness#UserId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^\\P{C}*$" + } + }, + "com.amazonaws.qbusiness#UserIds": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#String" + } + }, + "com.amazonaws.qbusiness#UserMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 7000 + } + } + }, + "com.amazonaws.qbusiness#UsersAndGroups": { + "type": "structure", + "members": { + "userIds": { + "target": "com.amazonaws.qbusiness#UserIds", + "traits": { + "smithy.api#documentation": "

The user ids associated with a topic control rule.

" + } + }, + "userGroups": { + "target": "com.amazonaws.qbusiness#UserGroups", + "traits": { + "smithy.api#documentation": "

The user groups associated with a topic control rule.

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

Provides information about users and groups associated with a topic control\n rule.

" + } + }, + "com.amazonaws.qbusiness#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.qbusiness#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The message describing the ValidationException.

", + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.qbusiness#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "

The reason for the ValidationException.

", + "smithy.api#required": {} + } + }, + "fields": { + "target": "com.amazonaws.qbusiness#ValidationExceptionFields", + "traits": { + "smithy.api#documentation": "

The input field(s) that failed validation.

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

The input doesn't meet the constraints set by the Amazon Q service. Provide the\n correct input and try again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.qbusiness#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The field name where the invalid entry was detected.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

A message about the validation exception.

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

The input failed to meet the constraints specified by Amazon Q in a specified\n field.

" + } + }, + "com.amazonaws.qbusiness#ValidationExceptionFields": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#ValidationExceptionField" + } + }, + "com.amazonaws.qbusiness#ValidationExceptionReason": { + "type": "enum", + "members": { + "CANNOT_PARSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANNOT_PARSE" + } + }, + "FIELD_VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIELD_VALIDATION_FAILED" + } + }, + "UNKNOWN_OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN_OPERATION" + } + } + } + }, + "com.amazonaws.qbusiness#WebExperience": { + "type": "structure", + "members": { + "webExperienceId": { + "target": "com.amazonaws.qbusiness#WebExperienceId", + "traits": { + "smithy.api#documentation": "

The identifier of your Amazon Q web experience.

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

The Unix timestamp when the Amazon Q application was last updated.

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

The Unix timestamp when your Amazon Q web experience was updated.

" + } + }, + "defaultEndpoint": { + "target": "com.amazonaws.qbusiness#Url", + "traits": { + "smithy.api#documentation": "

The endpoint URLs for your Amazon Q web experience. The URLs are unique and fully\n hosted by Amazon Web Services.

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

The status of your Amazon Q web experience.

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

Provides information for an Amazon Q web experience.

" + } + }, + "com.amazonaws.qbusiness#WebExperienceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1284 + }, + "smithy.api#pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" + } + }, + "com.amazonaws.qbusiness#WebExperienceAuthConfiguration": { + "type": "union", + "members": { + "samlConfiguration": { + "target": "com.amazonaws.qbusiness#SamlConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "

Provides the authorization configuration information needed to deploy a Amazon Q\n web experience to end users.

" + } + }, + "com.amazonaws.qbusiness#WebExperienceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, + "com.amazonaws.qbusiness#WebExperienceResource": { + "type": "resource", + "identifiers": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId" + }, + "webExperienceId": { + "target": "com.amazonaws.qbusiness#WebExperienceId" + } + }, + "create": { + "target": "com.amazonaws.qbusiness#CreateWebExperience" + }, + "read": { + "target": "com.amazonaws.qbusiness#GetWebExperience" + }, + "update": { + "target": "com.amazonaws.qbusiness#UpdateWebExperience" + }, + "delete": { + "target": "com.amazonaws.qbusiness#DeleteWebExperience" + }, + "list": { + "target": "com.amazonaws.qbusiness#ListWebExperiences" + }, + "traits": { + "aws.cloudformation#cfnResource": { + "name": "WebExperience" + } + } + }, + "com.amazonaws.qbusiness#WebExperienceSamplePromptsControlMode": { + "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.qbusiness#WebExperienceStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "PENDING_AUTH_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_AUTH_CONFIG" + } + } + } + }, + "com.amazonaws.qbusiness#WebExperienceSubtitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + }, + "smithy.api#pattern": "^\\P{C}*$" + } + }, + "com.amazonaws.qbusiness#WebExperienceTitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + }, + "smithy.api#pattern": "^\\P{C}*$" + } + }, + "com.amazonaws.qbusiness#WebExperienceWelcomeMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 300 + } + } + }, + "com.amazonaws.qbusiness#WebExperiences": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#WebExperience" + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/qconnect.json b/codegen/sdk-codegen/aws-models/qconnect.json new file mode 100644 index 00000000000..116df8f1ce0 --- /dev/null +++ b/codegen/sdk-codegen/aws-models/qconnect.json @@ -0,0 +1,7385 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.qconnect#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.qconnect#AppIntegrationsConfiguration": { + "type": "structure", + "members": { + "appIntegrationArn": { + "target": "com.amazonaws.qconnect#GenericArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

\n ", + "smithy.api#required": {} + } + }, + "objectFields": { + "target": "com.amazonaws.qconnect#ObjectFieldsList", + "traits": { + "smithy.api#documentation": "

The fields from the source that are made available to your agents in Amazon Q. Optional if\n ObjectConfiguration is included in the provided DataIntegration.

\n \n

Make sure to include additional fields. These fields are indexed and used to source\n recommendations.

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

Configuration information for Amazon AppIntegrations to automatically ingest content.

" + } + }, + "com.amazonaws.qconnect#Arn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$" + } + }, + "com.amazonaws.qconnect#Assistant": { + "type": "resource", + "identifiers": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + } + }, + "create": { + "target": "com.amazonaws.qconnect#CreateAssistant" + }, + "read": { + "target": "com.amazonaws.qconnect#GetAssistant" + }, + "delete": { + "target": "com.amazonaws.qconnect#DeleteAssistant" + }, + "list": { + "target": "com.amazonaws.qconnect#ListAssistants" + }, + "operations": [ + { + "target": "com.amazonaws.qconnect#GetRecommendations" + }, + { + "target": "com.amazonaws.qconnect#NotifyRecommendationsReceived" + }, + { + "target": "com.amazonaws.qconnect#QueryAssistant" + }, + { + "target": "com.amazonaws.qconnect#SearchSessions" + } + ], + "resources": [ + { + "target": "com.amazonaws.qconnect#AssistantAssociation" + }, + { + "target": "com.amazonaws.qconnect#Session" + } + ], + "traits": { + "aws.api#arn": { + "template": "assistant/{assistantId}" + }, + "aws.cloudformation#cfnResource": {}, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.qconnect#AssistantAssociation": { + "type": "resource", + "identifiers": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + }, + "assistantAssociationId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + } + }, + "create": { + "target": "com.amazonaws.qconnect#CreateAssistantAssociation" + }, + "read": { + "target": "com.amazonaws.qconnect#GetAssistantAssociation" + }, + "delete": { + "target": "com.amazonaws.qconnect#DeleteAssistantAssociation" + }, + "list": { + "target": "com.amazonaws.qconnect#ListAssistantAssociations" + }, + "traits": { + "aws.api#arn": { + "template": "association/{assistantId}/{assistantAssociationId}" + }, + "aws.cloudformation#cfnResource": {}, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.qconnect#AssistantAssociationData": { + "type": "structure", + "members": { + "assistantAssociationId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the assistant association.

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

The Amazon Resource Name (ARN) of the assistant association.

", + "smithy.api#required": {} + } + }, + "assistantId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q assistant.

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

The Amazon Resource Name (ARN) of the Amazon Q assistant.

", + "smithy.api#required": {} + } + }, + "associationType": { + "target": "com.amazonaws.qconnect#AssociationType", + "traits": { + "smithy.api#documentation": "

The type of association.

", + "smithy.api#required": {} + } + }, + "associationData": { + "target": "com.amazonaws.qconnect#AssistantAssociationOutputData", + "traits": { + "smithy.api#documentation": "

A union type that currently has a single argument, the knowledge base ID.

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

The tags used to organize, track, or control access for this resource.

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

Information about the assistant association.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#AssistantAssociation" + } + ] + } + }, + "com.amazonaws.qconnect#AssistantAssociationInputData": { + "type": "union", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

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

The data that is input into Amazon Q as a result of the assistant association.

" + } + }, + "com.amazonaws.qconnect#AssistantAssociationOutputData": { + "type": "union", + "members": { + "knowledgeBaseAssociation": { + "target": "com.amazonaws.qconnect#KnowledgeBaseAssociationData", + "traits": { + "smithy.api#documentation": "

The knowledge base where output data is sent.

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

The data that is output as a result of the assistant association.

" + } + }, + "com.amazonaws.qconnect#AssistantAssociationSummary": { + "type": "structure", + "members": { + "assistantAssociationId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the assistant association.

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

The Amazon Resource Name (ARN) of the assistant association.

", + "smithy.api#required": {} + } + }, + "assistantId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q assistant.

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

The Amazon Resource Name (ARN) of the Amazon Q assistant.

", + "smithy.api#required": {} + } + }, + "associationType": { + "target": "com.amazonaws.qconnect#AssociationType", + "traits": { + "smithy.api#documentation": "

The type of association.

", + "smithy.api#required": {} + } + }, + "associationData": { + "target": "com.amazonaws.qconnect#AssistantAssociationOutputData", + "traits": { + "smithy.api#documentation": "

The association data.

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

The tags used to organize, track, or control access for this resource.

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

Summary information about the assistant association.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#AssistantAssociation" + } + ] + } + }, + "com.amazonaws.qconnect#AssistantAssociationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#AssistantAssociationSummary" + } + }, + "com.amazonaws.qconnect#AssistantCapabilityConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.qconnect#AssistantCapabilityType", + "traits": { + "smithy.api#documentation": "

The type of Amazon Q assistant capability.

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

The capability configuration for a Amazon Q assistant.

" + } + }, + "com.amazonaws.qconnect#AssistantCapabilityType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "V1", + "name": "V1" + }, + { + "value": "V2", + "name": "V2" + } + ] + } + }, + "com.amazonaws.qconnect#AssistantData": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q assistant.

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

The Amazon Resource Name (ARN) of the Amazon Q assistant.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#Name", + "traits": { + "smithy.api#documentation": "

The name.

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

The type of assistant.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.qconnect#AssistantStatus", + "traits": { + "smithy.api#documentation": "

The status of the assistant.

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

The description.

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

The tags used to organize, track, or control access for this resource.

" + } + }, + "serverSideEncryptionConfiguration": { + "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.

\n

For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for\n your instance.

" + } + }, + "integrationConfiguration": { + "target": "com.amazonaws.qconnect#AssistantIntegrationConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information for the Amazon Q assistant integration.

" + } + }, + "capabilityConfiguration": { + "target": "com.amazonaws.qconnect#AssistantCapabilityConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information for the Amazon Q assistant capability.

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

The assistant data.

" + } + }, + "com.amazonaws.qconnect#AssistantIntegrationConfiguration": { + "type": "structure", + "members": { + "topicIntegrationArn": { + "target": "com.amazonaws.qconnect#GenericArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.

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

The configuration information for the Amazon Q assistant integration.

" + } + }, + "com.amazonaws.qconnect#AssistantList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#AssistantSummary" + } + }, + "com.amazonaws.qconnect#AssistantStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATE_IN_PROGRESS", + "name": "CREATE_IN_PROGRESS" + }, + { + "value": "CREATE_FAILED", + "name": "CREATE_FAILED" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "DELETE_IN_PROGRESS", + "name": "DELETE_IN_PROGRESS" + }, + { + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, + "com.amazonaws.qconnect#AssistantSummary": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q assistant.

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

The Amazon Resource Name (ARN) of the Amazon Q assistant.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#Name", + "traits": { + "smithy.api#documentation": "

The name of the assistant.

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

The type of the assistant.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.qconnect#AssistantStatus", + "traits": { + "smithy.api#documentation": "

The status of the assistant.

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

The description of the assistant.

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

The tags used to organize, track, or control access for this resource.

" + } + }, + "serverSideEncryptionConfiguration": { + "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.

\n

For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for\n your instance.

" + } + }, + "integrationConfiguration": { + "target": "com.amazonaws.qconnect#AssistantIntegrationConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information for the Amazon Q assistant integration.

" + } + }, + "capabilityConfiguration": { + "target": "com.amazonaws.qconnect#AssistantCapabilityConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information for the Amazon Q assistant capability.

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

Summary information about the assistant.

" + } + }, + "com.amazonaws.qconnect#AssistantType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AGENT", + "name": "AGENT" + } + ] + } + }, + "com.amazonaws.qconnect#AssociationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "KNOWLEDGE_BASE", + "name": "KNOWLEDGE_BASE" + } + ] + } + }, + "com.amazonaws.qconnect#Channel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.qconnect#Channels": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#Channel" + }, + "traits": { + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.qconnect#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.qconnect#Configuration": { + "type": "union", + "members": { + "connectConfiguration": { + "target": "com.amazonaws.qconnect#ConnectConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information of the Amazon Connect data source.

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

The configuration information of the external data source.

" + } + }, + "com.amazonaws.qconnect#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

The request could not be processed because of conflict in the current state of the\n resource. For example, if you're using a Create API (such as\n CreateAssistant) that accepts name, a conflicting resource (usually with the\n same name) is being created or mutated.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.qconnect#ConnectConfiguration": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The configuration information of the Amazon Connect data source.

" + } + }, + "com.amazonaws.qconnect#ContactAttributeKey": { + "type": "string" + }, + "com.amazonaws.qconnect#ContactAttributeKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#ContactAttributeKey" + }, + "traits": { + "smithy.api#sensitive": {}, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.qconnect#ContactAttributeValue": { + "type": "string" + }, + "com.amazonaws.qconnect#ContactAttributes": { + "type": "map", + "key": { + "target": "com.amazonaws.qconnect#ContactAttributeKey" + }, + "value": { + "target": "com.amazonaws.qconnect#ContactAttributeValue" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.qconnect#Content": { + "type": "resource", + "identifiers": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + }, + "contentId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + } + }, + "create": { + "target": "com.amazonaws.qconnect#CreateContent" + }, + "read": { + "target": "com.amazonaws.qconnect#GetContent" + }, + "update": { + "target": "com.amazonaws.qconnect#UpdateContent" + }, + "delete": { + "target": "com.amazonaws.qconnect#DeleteContent" + }, + "list": { + "target": "com.amazonaws.qconnect#ListContents" + }, + "operations": [ + { + "target": "com.amazonaws.qconnect#GetContentSummary" + } + ], + "traits": { + "aws.api#arn": { + "template": "content/{knowledgeBaseId}/{contentId}" + }, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.qconnect#ContentData": { + "type": "structure", + "members": { + "contentArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the content.

", + "smithy.api#required": {} + } + }, + "contentId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the content.

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

The Amazon Resource Name (ARN) of the knowledge base.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#Name", + "traits": { + "smithy.api#documentation": "

The name of the content.

", + "smithy.api#required": {} + } + }, + "revisionId": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the content revision.

", + "smithy.api#required": {} + } + }, + "title": { + "target": "com.amazonaws.qconnect#ContentTitle", + "traits": { + "smithy.api#documentation": "

The title of the content.

", + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.qconnect#ContentType", + "traits": { + "smithy.api#documentation": "

The media type of the content.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.qconnect#ContentStatus", + "traits": { + "smithy.api#documentation": "

The status of the content.

", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.qconnect#ContentMetadata", + "traits": { + "smithy.api#documentation": "

A key/value map to store attributes without affecting tagging or recommendations. \nFor example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.

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

The tags used to organize, track, or control access for this resource.

" + } + }, + "linkOutUri": { + "target": "com.amazonaws.qconnect#Uri", + "traits": { + "smithy.api#documentation": "

The URI of the content.

" + } + }, + "url": { + "target": "com.amazonaws.qconnect#Url", + "traits": { + "smithy.api#documentation": "

The URL of the content.

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

The expiration time of the URL as an epoch timestamp.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the content.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#Content" + }, + { + "resource": "com.amazonaws.qconnect#KnowledgeBase" + } + ] + } + }, + "com.amazonaws.qconnect#ContentDataDetails": { + "type": "structure", + "members": { + "textData": { + "target": "com.amazonaws.qconnect#TextData", + "traits": { + "smithy.api#documentation": "

Details about the content text data.

", + "smithy.api#required": {} + } + }, + "rankingData": { + "target": "com.amazonaws.qconnect#RankingData", + "traits": { + "smithy.api#documentation": "

Details about the content ranking data.

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

Details about the content data.

" + } + }, + "com.amazonaws.qconnect#ContentMetadata": { + "type": "map", + "key": { + "target": "com.amazonaws.qconnect#NonEmptyString" + }, + "value": { + "target": "com.amazonaws.qconnect#NonEmptyString" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.qconnect#ContentReference": { + "type": "structure", + "members": { + "knowledgeBaseArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the knowledge base.

" + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

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

The Amazon Resource Name (ARN) of the content.

" + } + }, + "contentId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the content.

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

Reference information about the content.

" + } + }, + "com.amazonaws.qconnect#ContentStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATE_IN_PROGRESS", + "name": "CREATE_IN_PROGRESS" + }, + { + "value": "CREATE_FAILED", + "name": "CREATE_FAILED" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "DELETE_IN_PROGRESS", + "name": "DELETE_IN_PROGRESS" + }, + { + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" + }, + { + "value": "DELETED", + "name": "DELETED" + }, + { + "value": "UPDATE_FAILED", + "name": "UPDATE_FAILED" + } + ] + } + }, + "com.amazonaws.qconnect#ContentSummary": { + "type": "structure", + "members": { + "contentArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the content.

", + "smithy.api#required": {} + } + }, + "contentId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the content.

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

The Amazon Resource Name (ARN) of the knowledge base.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#Name", + "traits": { + "smithy.api#documentation": "

The name of the content.

", + "smithy.api#required": {} + } + }, + "revisionId": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the revision of the content.

", + "smithy.api#required": {} + } + }, + "title": { + "target": "com.amazonaws.qconnect#ContentTitle", + "traits": { + "smithy.api#documentation": "

The title of the content.

", + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.qconnect#ContentType", + "traits": { + "smithy.api#documentation": "

The media type of the content.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.qconnect#ContentStatus", + "traits": { + "smithy.api#documentation": "

The status of the content.

", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.qconnect#ContentMetadata", + "traits": { + "smithy.api#documentation": "

A key/value map to store attributes without affecting tagging or recommendations. \nFor example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.

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

The tags used to organize, track, or control access for this resource.

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

Summary information about the content.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#Content" + }, + { + "resource": "com.amazonaws.qconnect#KnowledgeBase" + } + ] + } + }, + "com.amazonaws.qconnect#ContentSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#ContentSummary" + } + }, + "com.amazonaws.qconnect#ContentTitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.qconnect#ContentType": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(text/(plain|html|csv))|(application/(pdf|vnd\\.openxmlformats-officedocument\\.wordprocessingml\\.document))|(application/x\\.wisdom-json;source=(salesforce|servicenow|zendesk))$" + } + }, + "com.amazonaws.qconnect#CreateAssistant": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#CreateAssistantRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#CreateAssistantResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon Q in Connect assistant.

", + "smithy.api#http": { + "uri": "/assistants", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#CreateAssistantAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#CreateAssistantAssociationRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#CreateAssistantAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the\n only supported association is with a knowledge base. An assistant can have only a single\n association.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/associations", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#CreateAssistantAssociationRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "associationType": { + "target": "com.amazonaws.qconnect#AssociationType", + "traits": { + "smithy.api#documentation": "

The type of association.

", + "smithy.api#required": {} + } + }, + "association": { + "target": "com.amazonaws.qconnect#AssistantAssociationInputData", + "traits": { + "smithy.api#documentation": "

The identifier of the associated resource.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.qconnect#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

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

The tags used to organize, track, or control access for this resource.

" + } + } + } + }, + "com.amazonaws.qconnect#CreateAssistantAssociationResponse": { + "type": "structure", + "members": { + "assistantAssociation": { + "target": "com.amazonaws.qconnect#AssistantAssociationData", + "traits": { + "smithy.api#documentation": "

The assistant association.

" + } + } + } + }, + "com.amazonaws.qconnect#CreateAssistantRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.qconnect#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", + "smithy.api#idempotencyToken": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#Name", + "traits": { + "smithy.api#documentation": "

The name of the assistant.

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

The type of assistant.

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

The description of the assistant.

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

The tags used to organize, track, or control access for this resource.

" + } + }, + "serverSideEncryptionConfiguration": { + "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

The customer managed key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.

\n

For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for\n your instance.

" + } + } + } + }, + "com.amazonaws.qconnect#CreateAssistantResponse": { + "type": "structure", + "members": { + "assistant": { + "target": "com.amazonaws.qconnect#AssistantData", + "traits": { + "smithy.api#documentation": "

Information about the assistant.

" + } + } + } + }, + "com.amazonaws.qconnect#CreateContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#CreateContentRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#CreateContentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates Amazon Q content. Before to calling this API, use StartContentUpload to\n upload an asset.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/contents", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#CreateContentRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#Name", + "traits": { + "smithy.api#documentation": "

The name of the content. Each piece of content in a knowledge base must have a unique\n name. You can retrieve a piece of content using only its knowledge base and its name with the\n SearchContent API.

", + "smithy.api#required": {} + } + }, + "title": { + "target": "com.amazonaws.qconnect#ContentTitle", + "traits": { + "smithy.api#documentation": "

The title of the content. If not set, the title is equal to the name.

" + } + }, + "overrideLinkOutUri": { + "target": "com.amazonaws.qconnect#Uri", + "traits": { + "smithy.api#documentation": "

The URI you want to use for the article. If the knowledge base has a templateUri, setting\n this argument overrides it for this piece of content.

" + } + }, + "metadata": { + "target": "com.amazonaws.qconnect#ContentMetadata", + "traits": { + "smithy.api#documentation": "

A key/value map to store attributes without affecting tagging or recommendations. \nFor example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.

" + } + }, + "uploadId": { + "target": "com.amazonaws.qconnect#UploadId", + "traits": { + "smithy.api#documentation": "

A pointer to the uploaded asset. This value is returned by StartContentUpload.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

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

The tags used to organize, track, or control access for this resource.

" + } + } + } + }, + "com.amazonaws.qconnect#CreateContentResponse": { + "type": "structure", + "members": { + "content": { + "target": "com.amazonaws.qconnect#ContentData", + "traits": { + "smithy.api#documentation": "

The content.

" + } + } + } + }, + "com.amazonaws.qconnect#CreateKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#CreateKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#CreateKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a knowledge base.

\n \n

When using this API, you cannot reuse Amazon AppIntegrations\n DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do,\n you'll get an InvalidRequestException error.

\n

For example, you're programmatically managing your external knowledge base, and you want\n to add or remove one of the fields that is being ingested from Salesforce. Do the\n following:

\n
    \n
  1. \n

    Call DeleteKnowledgeBase.

    \n
    2. \n
  2. \n

    Call DeleteDataIntegration.

    \n
    3. \n
  3. \n

    Call CreateDataIntegration to recreate the DataIntegration or a create different\n one.

    \n
    4. \n
  4. \n

    Call CreateKnowledgeBase.

    \n
    5. \n
\n ", + "smithy.api#http": { + "uri": "/knowledgeBases", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#CreateKnowledgeBaseRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", + "smithy.api#idempotencyToken": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#Name", + "traits": { + "smithy.api#documentation": "

The name of the knowledge base.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseType": { + "target": "com.amazonaws.qconnect#KnowledgeBaseType", + "traits": { + "smithy.api#documentation": "

The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content.\n EXTERNAL knowledge bases support integrations with third-party systems whose content is\n synchronized automatically.

", + "smithy.api#required": {} + } + }, + "sourceConfiguration": { + "target": "com.amazonaws.qconnect#SourceConfiguration", + "traits": { + "smithy.api#documentation": "

The source of the knowledge base content. Only set this argument for EXTERNAL knowledge\n bases.

" + } + }, + "renderingConfiguration": { + "target": "com.amazonaws.qconnect#RenderingConfiguration", + "traits": { + "smithy.api#documentation": "

Information about how to render the content.

" + } + }, + "serverSideEncryptionConfiguration": { + "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q.

\n

For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for\n your instance.

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

The description.

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

The tags used to organize, track, or control access for this resource.

" + } + } + } + }, + "com.amazonaws.qconnect#CreateKnowledgeBaseResponse": { + "type": "structure", + "members": { + "knowledgeBase": { + "target": "com.amazonaws.qconnect#KnowledgeBaseData", + "traits": { + "smithy.api#documentation": "

The knowledge base.

" + } + } + } + }, + "com.amazonaws.qconnect#CreateQuickResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#CreateQuickResponseRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#CreateQuickResponseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a Amazon Q quick response.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/quickResponses", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#CreateQuickResponseRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#QuickResponseName", + "traits": { + "smithy.api#documentation": "

The name of the quick response.

", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.qconnect#QuickResponseDataProvider", + "traits": { + "smithy.api#documentation": "

The content of the quick response.

", + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.qconnect#QuickResponseType", + "traits": { + "smithy.api#documentation": "

The media type of the quick response content.

\n " + } + }, + "groupingConfiguration": { + "target": "com.amazonaws.qconnect#GroupingConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information of the user groups that the quick response is accessible to.

" + } + }, + "description": { + "target": "com.amazonaws.qconnect#QuickResponseDescription", + "traits": { + "smithy.api#documentation": "

The description of the quick response.

" + } + }, + "shortcutKey": { + "target": "com.amazonaws.qconnect#ShortCutKey", + "traits": { + "smithy.api#documentation": "

The shortcut key of the quick response. The value should be unique across the\n knowledge base.\n

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

Whether the quick response is active.

" + } + }, + "channels": { + "target": "com.amazonaws.qconnect#Channels", + "traits": { + "smithy.api#documentation": "

The Amazon Connect channels this quick response applies to.

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

The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES,\n fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR,\n zh_CN, zh_TW\n

" + } + }, + "clientToken": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

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

The tags used to organize, track, or control access for this resource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#CreateQuickResponseResponse": { + "type": "structure", + "members": { + "quickResponse": { + "target": "com.amazonaws.qconnect#QuickResponseData", + "traits": { + "smithy.api#documentation": "

The quick response.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#CreateSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#CreateSessionRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#CreateSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a session. A session is a contextual container used for generating\n recommendations. Amazon Connect creates a new Amazon Q session for each contact on which\n Amazon Q is enabled.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/sessions", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#CreateSessionRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.qconnect#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", + "smithy.api#idempotencyToken": {} + } + }, + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#Name", + "traits": { + "smithy.api#documentation": "

The name of the session.

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

The description.

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

The tags used to organize, track, or control access for this resource.

" + } + } + } + }, + "com.amazonaws.qconnect#CreateSessionResponse": { + "type": "structure", + "members": { + "session": { + "target": "com.amazonaws.qconnect#SessionData", + "traits": { + "smithy.api#documentation": "

The session.

" + } + } + } + }, + "com.amazonaws.qconnect#DataDetails": { + "type": "union", + "members": { + "contentData": { + "target": "com.amazonaws.qconnect#ContentDataDetails", + "traits": { + "smithy.api#documentation": "

Details about the content data.

" + } + }, + "generativeData": { + "target": "com.amazonaws.qconnect#GenerativeDataDetails", + "traits": { + "smithy.api#documentation": "

Details about the generative data.

" + } + }, + "sourceContentData": { + "target": "com.amazonaws.qconnect#SourceContentDataDetails", + "traits": { + "smithy.api#documentation": "

Details about the content data.

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

Details about the data.

" + } + }, + "com.amazonaws.qconnect#DataReference": { + "type": "union", + "members": { + "contentReference": { + "target": "com.amazonaws.qconnect#ContentReference" + }, + "generativeReference": { + "target": "com.amazonaws.qconnect#GenerativeReference", + "traits": { + "smithy.api#documentation": "

Reference information about the generative content.

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

Reference data.

" + } + }, + "com.amazonaws.qconnect#DataSummary": { + "type": "structure", + "members": { + "reference": { + "target": "com.amazonaws.qconnect#DataReference", + "traits": { + "smithy.api#documentation": "

Reference information about the content.

", + "smithy.api#required": {} + } + }, + "details": { + "target": "com.amazonaws.qconnect#DataDetails", + "traits": { + "smithy.api#documentation": "

Details about the data.

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

Summary of the data.

" + } + }, + "com.amazonaws.qconnect#DataSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#DataSummary" + } + }, + "com.amazonaws.qconnect#DeleteAssistant": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#DeleteAssistantRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#DeleteAssistantResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an assistant.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#DeleteAssistantAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#DeleteAssistantAssociationRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#DeleteAssistantAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an assistant association.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/associations/{assistantAssociationId}", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#DeleteAssistantAssociationRequest": { + "type": "structure", + "members": { + "assistantAssociationId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.qconnect#DeleteAssistantAssociationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.qconnect#DeleteAssistantRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.qconnect#DeleteAssistantResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.qconnect#DeleteContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#DeleteContentRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#DeleteContentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the content.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#DeleteContentRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "contentId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.qconnect#DeleteContentResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.qconnect#DeleteImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#DeleteImportJobRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#DeleteImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the quick response import job.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/importJobs/{importJobId}", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#DeleteImportJobRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "importJobId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the import job to be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#DeleteImportJobResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#DeleteKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#DeleteKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#DeleteKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the knowledge base.

\n \n

When you use this API to delete an external knowledge base such as Salesforce or\n ServiceNow, you must also delete the Amazon AppIntegrations\n DataIntegration. This is because you can't reuse the DataIntegration after it's been\n associated with an external knowledge base. However, you can delete and recreate it. See\n DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API\n Reference.

\n ", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#DeleteKnowledgeBaseRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.qconnect#DeleteKnowledgeBaseResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.qconnect#DeleteQuickResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#DeleteQuickResponseRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#DeleteQuickResponseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a quick response.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#DeleteQuickResponseRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The knowledge base from which the quick response is deleted. The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "quickResponseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the quick response to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#DeleteQuickResponseResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s_.,-]+" + } + }, + "com.amazonaws.qconnect#Document": { + "type": "structure", + "members": { + "contentReference": { + "target": "com.amazonaws.qconnect#ContentReference", + "traits": { + "smithy.api#documentation": "

A reference to the content resource.

", + "smithy.api#required": {} + } + }, + "title": { + "target": "com.amazonaws.qconnect#DocumentText", + "traits": { + "smithy.api#documentation": "

The title of the document.

" + } + }, + "excerpt": { + "target": "com.amazonaws.qconnect#DocumentText", + "traits": { + "smithy.api#documentation": "

The excerpt from the document.

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

The document.

" + } + }, + "com.amazonaws.qconnect#DocumentText": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.qconnect#SensitiveString", + "traits": { + "smithy.api#documentation": "

Text in the document.

" + } + }, + "highlights": { + "target": "com.amazonaws.qconnect#Highlights", + "traits": { + "smithy.api#documentation": "

Highlights in the document text.

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

The text of the document.

" + } + }, + "com.amazonaws.qconnect#ExternalSource": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AMAZON_CONNECT", + "name": "AMAZON_CONNECT" + } + ] + } + }, + "com.amazonaws.qconnect#ExternalSourceConfiguration": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.qconnect#ExternalSource", + "traits": { + "smithy.api#documentation": "

The type of the external data source.

", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.qconnect#Configuration", + "traits": { + "smithy.api#documentation": "

The configuration information of the external data source.

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

The configuration information of the external data source.

" + } + }, + "com.amazonaws.qconnect#Filter": { + "type": "structure", + "members": { + "field": { + "target": "com.amazonaws.qconnect#FilterField", + "traits": { + "smithy.api#documentation": "

The field on which to filter.

", + "smithy.api#required": {} + } + }, + "operator": { + "target": "com.amazonaws.qconnect#FilterOperator", + "traits": { + "smithy.api#documentation": "

The operator to use for comparing the field’s value with the provided value.

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

The desired field value on which to filter.

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

A search filter.

" + } + }, + "com.amazonaws.qconnect#FilterField": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NAME", + "name": "NAME" + } + ] + } + }, + "com.amazonaws.qconnect#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#Filter" + } + }, + "com.amazonaws.qconnect#FilterOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EQUALS", + "name": "EQUALS" + } + ] + } + }, + "com.amazonaws.qconnect#GenerativeDataDetails": { + "type": "structure", + "members": { + "completion": { + "target": "com.amazonaws.qconnect#SensitiveString", + "traits": { + "smithy.api#documentation": "

The LLM response.

", + "smithy.api#required": {} + } + }, + "references": { + "target": "com.amazonaws.qconnect#DataSummaryList", + "traits": { + "smithy.api#documentation": "

The references used to generative the LLM response.

", + "smithy.api#required": {} + } + }, + "rankingData": { + "target": "com.amazonaws.qconnect#RankingData", + "traits": { + "smithy.api#documentation": "

Details about the generative content ranking data.

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

Details about generative data.

" + } + }, + "com.amazonaws.qconnect#GenerativeReference": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.qconnect#LlmModelId", + "traits": { + "smithy.api#documentation": "

The identifier of the LLM model.

" + } + }, + "generationId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the LLM model.

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

Reference information about generative content.

" + } + }, + "com.amazonaws.qconnect#GenericArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+$" + } + }, + "com.amazonaws.qconnect#GetAssistant": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#GetAssistantRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#GetAssistantResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about an assistant.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#GetAssistantAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#GetAssistantAssociationRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#GetAssistantAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about an assistant association.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/associations/{assistantAssociationId}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#GetAssistantAssociationRequest": { + "type": "structure", + "members": { + "assistantAssociationId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.qconnect#GetAssistantAssociationResponse": { + "type": "structure", + "members": { + "assistantAssociation": { + "target": "com.amazonaws.qconnect#AssistantAssociationData", + "traits": { + "smithy.api#documentation": "

The assistant association.

" + } + } + } + }, + "com.amazonaws.qconnect#GetAssistantRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.qconnect#GetAssistantResponse": { + "type": "structure", + "members": { + "assistant": { + "target": "com.amazonaws.qconnect#AssistantData", + "traits": { + "smithy.api#documentation": "

Information about the assistant.

" + } + } + } + }, + "com.amazonaws.qconnect#GetContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#GetContentRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#GetContentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves content, including a pre-signed URL to download the content.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#GetContentRequest": { + "type": "structure", + "members": { + "contentId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.qconnect#GetContentResponse": { + "type": "structure", + "members": { + "content": { + "target": "com.amazonaws.qconnect#ContentData", + "traits": { + "smithy.api#documentation": "

The content.

" + } + } + } + }, + "com.amazonaws.qconnect#GetContentSummary": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#GetContentSummaryRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#GetContentSummaryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves summary information about the content.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}/summary", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#GetContentSummaryRequest": { + "type": "structure", + "members": { + "contentId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.qconnect#GetContentSummaryResponse": { + "type": "structure", + "members": { + "contentSummary": { + "target": "com.amazonaws.qconnect#ContentSummary", + "traits": { + "smithy.api#documentation": "

The content summary.

" + } + } + } + }, + "com.amazonaws.qconnect#GetImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#GetImportJobRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#GetImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the started import job.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/importJobs/{importJobId}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#GetImportJobRequest": { + "type": "structure", + "members": { + "importJobId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the import job to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base that the import job belongs to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#GetImportJobResponse": { + "type": "structure", + "members": { + "importJob": { + "target": "com.amazonaws.qconnect#ImportJobData", + "traits": { + "smithy.api#documentation": "

The import job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#GetKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#GetKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#GetKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about the knowledge base.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#GetKnowledgeBaseRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.qconnect#GetKnowledgeBaseResponse": { + "type": "structure", + "members": { + "knowledgeBase": { + "target": "com.amazonaws.qconnect#KnowledgeBaseData", + "traits": { + "smithy.api#documentation": "

The knowledge base.

" + } + } + } + }, + "com.amazonaws.qconnect#GetQuickResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#GetQuickResponseRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#GetQuickResponseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the quick response.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#GetQuickResponseRequest": { + "type": "structure", + "members": { + "quickResponseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the quick response.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#GetQuickResponseResponse": { + "type": "structure", + "members": { + "quickResponse": { + "target": "com.amazonaws.qconnect#QuickResponseData", + "traits": { + "smithy.api#documentation": "

The quick response.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#GetRecommendations": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#GetRecommendationsRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#GetRecommendationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves recommendations for the specified session. To avoid retrieving the same\n recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the\n waitTimeSeconds parameter. Short poll is the default behavior and only returns\n recommendations already available. To perform a manual query against an assistant, use QueryAssistant.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/sessions/{sessionId}/recommendations", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#GetRecommendationsRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.qconnect#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "waitTimeSeconds": { + "target": "com.amazonaws.qconnect#WaitTimeSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The duration (in seconds) for which the call waits for a recommendation to be made\n available before returning. If a recommendation is available, the call returns sooner than\n WaitTimeSeconds. If no messages are available and the wait time expires, the\n call returns successfully with an empty list.

", + "smithy.api#httpQuery": "waitTimeSeconds" + } + } + } + }, + "com.amazonaws.qconnect#GetRecommendationsResponse": { + "type": "structure", + "members": { + "recommendations": { + "target": "com.amazonaws.qconnect#RecommendationList", + "traits": { + "smithy.api#documentation": "

The recommendations.

", + "smithy.api#required": {} + } + }, + "triggers": { + "target": "com.amazonaws.qconnect#RecommendationTriggerList", + "traits": { + "smithy.api#documentation": "

The triggers corresponding to recommendations.

" + } + } + } + }, + "com.amazonaws.qconnect#GetSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#GetSessionRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#GetSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information for a specified session.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/sessions/{sessionId}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#GetSessionRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.qconnect#GetSessionResponse": { + "type": "structure", + "members": { + "session": { + "target": "com.amazonaws.qconnect#SessionData", + "traits": { + "smithy.api#documentation": "

The session.

" + } + } + } + }, + "com.amazonaws.qconnect#GroupingConfiguration": { + "type": "structure", + "members": { + "criteria": { + "target": "com.amazonaws.qconnect#GroupingCriteria", + "traits": { + "smithy.api#documentation": "

The criteria used for grouping Amazon Q users.

\n

The following is the list of supported criteria values.

\n " + } + }, + "values": { + "target": "com.amazonaws.qconnect#GroupingValues", + "traits": { + "smithy.api#documentation": "

The list of values that define different groups of Amazon Q users.

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

The configuration information of the grouping of Amazon Q users.

" + } + }, + "com.amazonaws.qconnect#GroupingCriteria": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.qconnect#GroupingValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.qconnect#GroupingValues": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#GroupingValue" + }, + "traits": { + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.qconnect#Headers": { + "type": "map", + "key": { + "target": "com.amazonaws.qconnect#NonEmptyString" + }, + "value": { + "target": "com.amazonaws.qconnect#NonEmptyString" + } + }, + "com.amazonaws.qconnect#Highlight": { + "type": "structure", + "members": { + "beginOffsetInclusive": { + "target": "com.amazonaws.qconnect#HighlightOffset", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The offset for the start of the highlight.

" + } + }, + "endOffsetExclusive": { + "target": "com.amazonaws.qconnect#HighlightOffset", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The offset for the end of the highlight.

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

Offset specification to describe highlighting of document excerpts for rendering search\n results and recommendations.

" + } + }, + "com.amazonaws.qconnect#HighlightOffset": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.qconnect#Highlights": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#Highlight" + } + }, + "com.amazonaws.qconnect#ImportJobData": { + "type": "structure", + "members": { + "importJobId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the import job.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

", + "smithy.api#required": {} + } + }, + "uploadId": { + "target": "com.amazonaws.qconnect#UploadId", + "traits": { + "smithy.api#documentation": "

A pointer to the uploaded asset. This value is returned by StartContentUpload.

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

The Amazon Resource Name (ARN) of the knowledge base.

", + "smithy.api#required": {} + } + }, + "importJobType": { + "target": "com.amazonaws.qconnect#ImportJobType", + "traits": { + "smithy.api#documentation": "

The type of the import job.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.qconnect#ImportJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the import job.

", + "smithy.api#required": {} + } + }, + "url": { + "target": "com.amazonaws.qconnect#Url", + "traits": { + "smithy.api#documentation": "

The download link to the resource file that is uploaded to the import job.

", + "smithy.api#required": {} + } + }, + "failedRecordReport": { + "target": "com.amazonaws.qconnect#Url", + "traits": { + "smithy.api#documentation": "

The link to donwload the information of resource data that failed to be imported.

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

The expiration time of the URL as an epoch timestamp.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "createdTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the import job was created.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the import job data was last modified.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "metadata": { + "target": "com.amazonaws.qconnect#ContentMetadata", + "traits": { + "smithy.api#documentation": "

The metadata fields of the imported Amazon Q resources.

" + } + }, + "externalSourceConfiguration": { + "target": "com.amazonaws.qconnect#ExternalSourceConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "

Summary information about the import job.

" + } + }, + "com.amazonaws.qconnect#ImportJobList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#ImportJobSummary" + } + }, + "com.amazonaws.qconnect#ImportJobStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "START_IN_PROGRESS", + "name": "START_IN_PROGRESS" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "COMPLETE", + "name": "COMPLETE" + }, + { + "value": "DELETE_IN_PROGRESS", + "name": "DELETE_IN_PROGRESS" + }, + { + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, + "com.amazonaws.qconnect#ImportJobSummary": { + "type": "structure", + "members": { + "importJobId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the import job.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

", + "smithy.api#required": {} + } + }, + "uploadId": { + "target": "com.amazonaws.qconnect#UploadId", + "traits": { + "smithy.api#documentation": "

A pointer to the uploaded asset. This value is returned by StartContentUpload.

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

The Amazon Resource Name (ARN) of the knowledge base.

", + "smithy.api#required": {} + } + }, + "importJobType": { + "target": "com.amazonaws.qconnect#ImportJobType", + "traits": { + "smithy.api#documentation": "

The type of import job.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.qconnect#ImportJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the import job.

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

The timestamp when the import job was created.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the import job was last modified.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "metadata": { + "target": "com.amazonaws.qconnect#ContentMetadata", + "traits": { + "smithy.api#documentation": "

The metadata fields of the imported Amazon Q resources.

" + } + }, + "externalSourceConfiguration": { + "target": "com.amazonaws.qconnect#ExternalSourceConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information of the external source that the resource data are imported from.

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

Summary information about the import job.

" + } + }, + "com.amazonaws.qconnect#ImportJobType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "QUICK_RESPONSES", + "name": "QUICK_RESPONSES" + } + ] + } + }, + "com.amazonaws.qconnect#KnowledgeBase": { + "type": "resource", + "identifiers": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + } + }, + "create": { + "target": "com.amazonaws.qconnect#CreateKnowledgeBase" + }, + "read": { + "target": "com.amazonaws.qconnect#GetKnowledgeBase" + }, + "delete": { + "target": "com.amazonaws.qconnect#DeleteKnowledgeBase" + }, + "list": { + "target": "com.amazonaws.qconnect#ListKnowledgeBases" + }, + "operations": [ + { + "target": "com.amazonaws.qconnect#DeleteImportJob" + }, + { + "target": "com.amazonaws.qconnect#GetImportJob" + }, + { + "target": "com.amazonaws.qconnect#ListImportJobs" + }, + { + "target": "com.amazonaws.qconnect#RemoveKnowledgeBaseTemplateUri" + }, + { + "target": "com.amazonaws.qconnect#SearchContent" + }, + { + "target": "com.amazonaws.qconnect#SearchQuickResponses" + }, + { + "target": "com.amazonaws.qconnect#StartContentUpload" + }, + { + "target": "com.amazonaws.qconnect#StartImportJob" + }, + { + "target": "com.amazonaws.qconnect#UpdateKnowledgeBaseTemplateUri" + } + ], + "resources": [ + { + "target": "com.amazonaws.qconnect#Content" + }, + { + "target": "com.amazonaws.qconnect#QuickResponse" + } + ], + "traits": { + "aws.api#arn": { + "template": "knowledge-base/{knowledgeBaseId}" + }, + "aws.cloudformation#cfnResource": {}, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.qconnect#KnowledgeBaseAssociationData": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

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

The Amazon Resource Name (ARN) of the knowledge base.

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

Association information about the knowledge base.

" + } + }, + "com.amazonaws.qconnect#KnowledgeBaseData": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

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

The Amazon Resource Name (ARN) of the knowledge base.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#Name", + "traits": { + "smithy.api#documentation": "

The name of the knowledge base.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseType": { + "target": "com.amazonaws.qconnect#KnowledgeBaseType", + "traits": { + "smithy.api#documentation": "

The type of knowledge base.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.qconnect#KnowledgeBaseStatus", + "traits": { + "smithy.api#documentation": "

The status of the knowledge base.

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

An epoch timestamp indicating the most recent content modification inside the knowledge\n base. If no content exists in a knowledge base, this value is unset.

", + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "sourceConfiguration": { + "target": "com.amazonaws.qconnect#SourceConfiguration", + "traits": { + "smithy.api#documentation": "

Source configuration information about the knowledge base.

" + } + }, + "renderingConfiguration": { + "target": "com.amazonaws.qconnect#RenderingConfiguration", + "traits": { + "smithy.api#documentation": "

Information about how to render the content.

" + } + }, + "serverSideEncryptionConfiguration": { + "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q.

\n

For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for\n your instance.

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

The description.

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

The tags used to organize, track, or control access for this resource.

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

Information about the knowledge base.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#KnowledgeBase" + } + ] + } + }, + "com.amazonaws.qconnect#KnowledgeBaseList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#KnowledgeBaseSummary" + } + }, + "com.amazonaws.qconnect#KnowledgeBaseStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATE_IN_PROGRESS", + "name": "CREATE_IN_PROGRESS" + }, + { + "value": "CREATE_FAILED", + "name": "CREATE_FAILED" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "DELETE_IN_PROGRESS", + "name": "DELETE_IN_PROGRESS" + }, + { + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, + "com.amazonaws.qconnect#KnowledgeBaseSummary": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

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

The Amazon Resource Name (ARN) of the knowledge base.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#Name", + "traits": { + "smithy.api#documentation": "

The name of the knowledge base.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseType": { + "target": "com.amazonaws.qconnect#KnowledgeBaseType", + "traits": { + "smithy.api#documentation": "

The type of knowledge base.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.qconnect#KnowledgeBaseStatus", + "traits": { + "smithy.api#documentation": "

The status of the knowledge base summary.

", + "smithy.api#required": {} + } + }, + "sourceConfiguration": { + "target": "com.amazonaws.qconnect#SourceConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration information about the external data source.

" + } + }, + "renderingConfiguration": { + "target": "com.amazonaws.qconnect#RenderingConfiguration", + "traits": { + "smithy.api#documentation": "

Information about how to render the content.

" + } + }, + "serverSideEncryptionConfiguration": { + "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q.

\n

For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for\n your instance.

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

The description of the knowledge base.

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

The tags used to organize, track, or control access for this resource.

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

Summary information about the knowledge base.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#KnowledgeBase" + } + ] + } + }, + "com.amazonaws.qconnect#KnowledgeBaseType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EXTERNAL", + "name": "EXTERNAL" + }, + { + "value": "CUSTOM", + "name": "CUSTOM" + }, + { + "value": "QUICK_RESPONSES", + "name": "QUICK_RESPONSES" + } + ] + } + }, + "com.amazonaws.qconnect#LanguageCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 5 + } + } + }, + "com.amazonaws.qconnect#ListAssistantAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#ListAssistantAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#ListAssistantAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists information about assistant associations.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/associations", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "assistantAssociationSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#ListAssistantAssociationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.qconnect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qconnect#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.qconnect#ListAssistantAssociationsResponse": { + "type": "structure", + "members": { + "assistantAssociationSummaries": { + "target": "com.amazonaws.qconnect#AssistantAssociationSummaryList", + "traits": { + "smithy.api#documentation": "

Summary information about assistant associations.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.qconnect#ListAssistants": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#ListAssistantsRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#ListAssistantsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists information about assistants.

", + "smithy.api#http": { + "uri": "/assistants", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "assistantSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#ListAssistantsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.qconnect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qconnect#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.qconnect#ListAssistantsResponse": { + "type": "structure", + "members": { + "assistantSummaries": { + "target": "com.amazonaws.qconnect#AssistantList", + "traits": { + "smithy.api#documentation": "

Information about the assistants.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.qconnect#ListContents": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#ListContentsRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#ListContentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the content.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/contents", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "contentSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#ListContentsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.qconnect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qconnect#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.qconnect#ListContentsResponse": { + "type": "structure", + "members": { + "contentSummaries": { + "target": "com.amazonaws.qconnect#ContentSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the content.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.qconnect#ListImportJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#ListImportJobsRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#ListImportJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists information about import jobs.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/importJobs", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "importJobSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#ListImportJobsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qconnect#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#ListImportJobsResponse": { + "type": "structure", + "members": { + "importJobSummaries": { + "target": "com.amazonaws.qconnect#ImportJobList", + "traits": { + "smithy.api#documentation": "

Summary information about the import jobs.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#ListKnowledgeBases": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#ListKnowledgeBasesRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#ListKnowledgeBasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the knowledge bases.

", + "smithy.api#http": { + "uri": "/knowledgeBases", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "knowledgeBaseSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#ListKnowledgeBasesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qconnect#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.qconnect#ListKnowledgeBasesResponse": { + "type": "structure", + "members": { + "knowledgeBaseSummaries": { + "target": "com.amazonaws.qconnect#KnowledgeBaseList", + "traits": { + "smithy.api#documentation": "

Information about the knowledge bases.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.qconnect#ListQuickResponses": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#ListQuickResponsesRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#ListQuickResponsesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists information about quick response.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/quickResponses", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "quickResponseSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#ListQuickResponsesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qconnect#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#ListQuickResponsesResponse": { + "type": "structure", + "members": { + "quickResponseSummaries": { + "target": "com.amazonaws.qconnect#QuickResponseSummaryList", + "traits": { + "smithy.api#documentation": "

Summary information about the quick responses.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags for the specified resource.

", + "smithy.api#http": { + "uri": "/tags/{resourceArn}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.qconnect#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.qconnect#Tags", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + } + } + } + }, + "com.amazonaws.qconnect#LlmModelId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.qconnect#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.qconnect#Name": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s_.,-]+" + } + }, + "com.amazonaws.qconnect#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.qconnect#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.qconnect#NotifyRecommendationsReceived": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#NotifyRecommendationsReceivedRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#NotifyRecommendationsReceivedResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified recommendations from the specified assistant's queue of newly\n available recommendations. You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling\n behavior and avoiding duplicate recommendations.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/sessions/{sessionId}/recommendations/notify", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#NotifyRecommendationsReceivedError": { + "type": "structure", + "members": { + "recommendationId": { + "target": "com.amazonaws.qconnect#RecommendationId", + "traits": { + "smithy.api#documentation": "

The identifier of the recommendation that is in error.

" + } + }, + "message": { + "target": "com.amazonaws.qconnect#NotifyRecommendationsReceivedErrorMessage", + "traits": { + "smithy.api#documentation": "

A recommendation is causing an error.

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

An error occurred when creating a recommendation.

" + } + }, + "com.amazonaws.qconnect#NotifyRecommendationsReceivedErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#NotifyRecommendationsReceivedError" + } + }, + "com.amazonaws.qconnect#NotifyRecommendationsReceivedErrorMessage": { + "type": "string" + }, + "com.amazonaws.qconnect#NotifyRecommendationsReceivedRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "recommendationIds": { + "target": "com.amazonaws.qconnect#RecommendationIdList", + "traits": { + "smithy.api#documentation": "

The identifiers of the recommendations.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.qconnect#NotifyRecommendationsReceivedResponse": { + "type": "structure", + "members": { + "recommendationIds": { + "target": "com.amazonaws.qconnect#RecommendationIdList", + "traits": { + "smithy.api#documentation": "

The identifiers of the recommendations.

" + } + }, + "errors": { + "target": "com.amazonaws.qconnect#NotifyRecommendationsReceivedErrorList", + "traits": { + "smithy.api#documentation": "

The identifiers of recommendations that are causing errors.

" + } + } + } + }, + "com.amazonaws.qconnect#ObjectFieldsList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#NonEmptyString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.qconnect#Order": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ASC", + "name": "ASC" + }, + { + "value": "DESC", + "name": "DESC" + } + ] + } + }, + "com.amazonaws.qconnect#PreconditionFailedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

The provided revisionId does not match, indicating the content has been\n modified since it was last read.

", + "smithy.api#error": "client", + "smithy.api#httpError": 412 + } + }, + "com.amazonaws.qconnect#Priority": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "MEDIUM", + "name": "MEDIUM" + }, + { + "value": "LOW", + "name": "LOW" + } + ] + } + }, + "com.amazonaws.qconnect#QueryAssistant": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#QueryAssistantRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#QueryAssistantResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#RequestTimeoutException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Performs a manual search against the specified assistant. To retrieve recommendations for\n an assistant, use GetRecommendations.\n

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/query", + "method": "POST" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "results" + }, + "smithy.api#readonly": {}, + "smithy.api#suppress": [ + "HttpMethodSemantics" + ] + } + }, + "com.amazonaws.qconnect#QueryAssistantRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "queryText": { + "target": "com.amazonaws.qconnect#QueryText", + "traits": { + "smithy.api#documentation": "

The text to search for.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

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

The maximum number of results to return per page.

" + } + }, + "sessionId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q session. Can be either the ID or the ARN. URLs cannot\n contain the ARN.

" + } + }, + "queryCondition": { + "target": "com.amazonaws.qconnect#QueryConditionExpression", + "traits": { + "smithy.api#documentation": "

Information about how to query content.

" + } + } + } + }, + "com.amazonaws.qconnect#QueryAssistantResponse": { + "type": "structure", + "members": { + "results": { + "target": "com.amazonaws.qconnect#QueryResultsList", + "traits": { + "smithy.api#documentation": "

The results of the query.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.qconnect#QueryCondition": { + "type": "union", + "members": { + "single": { + "target": "com.amazonaws.qconnect#QueryConditionItem", + "traits": { + "smithy.api#documentation": "

The condition for the query.

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

Information about how to query content.

" + } + }, + "com.amazonaws.qconnect#QueryConditionComparisonOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EQUALS", + "name": "EQUALS" + } + ] + } + }, + "com.amazonaws.qconnect#QueryConditionExpression": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#QueryCondition" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.qconnect#QueryConditionFieldName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RESULT_TYPE", + "name": "RESULT_TYPE" + } + ] + } + }, + "com.amazonaws.qconnect#QueryConditionItem": { + "type": "structure", + "members": { + "field": { + "target": "com.amazonaws.qconnect#QueryConditionFieldName", + "traits": { + "smithy.api#documentation": "

The name of the field for query condition to query on.

", + "smithy.api#required": {} + } + }, + "comparator": { + "target": "com.amazonaws.qconnect#QueryConditionComparisonOperator", + "traits": { + "smithy.api#documentation": "

The comparison operator for query condition to query on.

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

The value for the query condition to query on.

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

The condition for the query.

" + } + }, + "com.amazonaws.qconnect#QueryRecommendationTriggerData": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.qconnect#QueryText", + "traits": { + "smithy.api#documentation": "

The text associated with the recommendation trigger.

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

Data associated with the QUERY RecommendationTriggerType.

" + } + }, + "com.amazonaws.qconnect#QueryResultType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "KNOWLEDGE_CONTENT", + "name": "KNOWLEDGE_CONTENT" + }, + { + "value": "GENERATIVE_ANSWER", + "name": "GENERATIVE_ANSWER" + } + ] + } + }, + "com.amazonaws.qconnect#QueryResultsList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#ResultData" + } + }, + "com.amazonaws.qconnect#QueryText": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.qconnect#QuickResponse": { + "type": "resource", + "identifiers": { + "quickResponseId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + } + }, + "create": { + "target": "com.amazonaws.qconnect#CreateQuickResponse" + }, + "read": { + "target": "com.amazonaws.qconnect#GetQuickResponse" + }, + "update": { + "target": "com.amazonaws.qconnect#UpdateQuickResponse" + }, + "delete": { + "target": "com.amazonaws.qconnect#DeleteQuickResponse" + }, + "list": { + "target": "com.amazonaws.qconnect#ListQuickResponses" + }, + "traits": { + "aws.api#arn": { + "template": "quick-response/{knowledgeBaseId}/{quickResponseId}" + }, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.qconnect#QuickResponseContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.qconnect#QuickResponseContentProvider": { + "type": "union", + "members": { + "content": { + "target": "com.amazonaws.qconnect#QuickResponseContent", + "traits": { + "smithy.api#documentation": "

The content of the quick response.

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

The container quick response content.

" + } + }, + "com.amazonaws.qconnect#QuickResponseContents": { + "type": "structure", + "members": { + "plainText": { + "target": "com.amazonaws.qconnect#QuickResponseContentProvider" + }, + "markdown": { + "target": "com.amazonaws.qconnect#QuickResponseContentProvider" + } + }, + "traits": { + "smithy.api#documentation": "

The content of the quick response stored in different media types.

" + } + }, + "com.amazonaws.qconnect#QuickResponseData": { + "type": "structure", + "members": { + "quickResponseArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the quick response.

", + "smithy.api#required": {} + } + }, + "quickResponseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the quick response.

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

The Amazon Resource Name (ARN) of the knowledge base.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#QuickResponseName", + "traits": { + "smithy.api#documentation": "

The name of the quick response.

", + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.qconnect#QuickResponseType", + "traits": { + "smithy.api#documentation": "

The media type of the quick response content.

\n ", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.qconnect#QuickResponseStatus", + "traits": { + "smithy.api#documentation": "

The status of the quick response data.

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

The timestamp when the quick response was created.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the quick response data was last modified.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "contents": { + "target": "com.amazonaws.qconnect#QuickResponseContents", + "traits": { + "smithy.api#documentation": "

The contents of the quick response.

" + } + }, + "description": { + "target": "com.amazonaws.qconnect#QuickResponseDescription", + "traits": { + "smithy.api#documentation": "

The description of the quick response.

" + } + }, + "groupingConfiguration": { + "target": "com.amazonaws.qconnect#GroupingConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information of the user groups that the quick response is accessible to.

" + } + }, + "shortcutKey": { + "target": "com.amazonaws.qconnect#ShortCutKey", + "traits": { + "smithy.api#documentation": "

The shortcut key of the quick response. The value should be unique across the\n knowledge base.

" + } + }, + "lastModifiedBy": { + "target": "com.amazonaws.qconnect#GenericArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last updated the quick response data.

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

Whether the quick response is active.

" + } + }, + "channels": { + "target": "com.amazonaws.qconnect#Channels", + "traits": { + "smithy.api#documentation": "

The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.

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

The language code value for the language in which the quick response is written.

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

The tags used to organize, track, or control access for this resource.

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

Information about the quick response.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#QuickResponse" + }, + { + "resource": "com.amazonaws.qconnect#KnowledgeBase" + } + ] + } + }, + "com.amazonaws.qconnect#QuickResponseDataProvider": { + "type": "union", + "members": { + "content": { + "target": "com.amazonaws.qconnect#QuickResponseContent", + "traits": { + "smithy.api#documentation": "

The content of the quick response.

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

The container of quick response data.

" + } + }, + "com.amazonaws.qconnect#QuickResponseDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.qconnect#QuickResponseFilterField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the attribute field to filter the quick responses by.

", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.qconnect#QuickResponseFilterValueList", + "traits": { + "smithy.api#documentation": "

The values of attribute field to filter the quick response by.

" + } + }, + "operator": { + "target": "com.amazonaws.qconnect#QuickResponseFilterOperator", + "traits": { + "smithy.api#documentation": "

The operator to use for filtering.

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

Whether to treat null value as a match for the attribute field.

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

The quick response fields to filter the quick response query results by.

\n

The following is the list of supported field names.

\n " + } + }, + "com.amazonaws.qconnect#QuickResponseFilterFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#QuickResponseFilterField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.qconnect#QuickResponseFilterOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EQUALS", + "name": "EQUALS" + }, + { + "value": "PREFIX", + "name": "PREFIX" + } + ] + } + }, + "com.amazonaws.qconnect#QuickResponseFilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.qconnect#QuickResponseFilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#QuickResponseFilterValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.qconnect#QuickResponseName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 40 + } + } + }, + "com.amazonaws.qconnect#QuickResponseOrderField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the attribute to order the quick response query results by.

", + "smithy.api#required": {} + } + }, + "order": { + "target": "com.amazonaws.qconnect#Order", + "traits": { + "smithy.api#documentation": "

The order at which the quick responses are sorted by.

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

The quick response fields to order the quick response query results by.

\n

The following is the list of supported field names.

\n " + } + }, + "com.amazonaws.qconnect#QuickResponseQueryField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the attribute to query the quick responses by.

", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.qconnect#QuickResponseQueryValueList", + "traits": { + "smithy.api#documentation": "

The values of the attribute to query the quick responses by.

", + "smithy.api#required": {} + } + }, + "operator": { + "target": "com.amazonaws.qconnect#QuickResponseQueryOperator", + "traits": { + "smithy.api#documentation": "

The operator to use for matching attribute field values in the query.

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

Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.

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

The importance of the attribute field when calculating query result relevancy scores.\n The value set for this parameter affects the ordering of search results.

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

The quick response fields to query quick responses by.

\n

The following is the list of supported field names.

\n " + } + }, + "com.amazonaws.qconnect#QuickResponseQueryFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#QuickResponseQueryField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4 + } + } + }, + "com.amazonaws.qconnect#QuickResponseQueryOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CONTAINS", + "name": "CONTAINS" + }, + { + "value": "CONTAINS_AND_PREFIX", + "name": "CONTAINS_AND_PREFIX" + } + ] + } + }, + "com.amazonaws.qconnect#QuickResponseQueryValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.qconnect#QuickResponseQueryValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#QuickResponseQueryValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.qconnect#QuickResponseSearchExpression": { + "type": "structure", + "members": { + "queries": { + "target": "com.amazonaws.qconnect#QuickResponseQueryFieldList", + "traits": { + "smithy.api#documentation": "

The quick response query expressions.

" + } + }, + "filters": { + "target": "com.amazonaws.qconnect#QuickResponseFilterFieldList", + "traits": { + "smithy.api#documentation": "

The configuration of filtering rules applied to quick response query results.

" + } + }, + "orderOnField": { + "target": "com.amazonaws.qconnect#QuickResponseOrderField", + "traits": { + "smithy.api#documentation": "

The quick response attribute fields on which the query results are ordered.

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

Information about the import job.

" + } + }, + "com.amazonaws.qconnect#QuickResponseSearchResultData": { + "type": "structure", + "members": { + "quickResponseArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the quick response.

", + "smithy.api#required": {} + } + }, + "quickResponseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the quick response.

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

The Amazon Resource Name (ARN) of the knowledge base.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#QuickResponseName", + "traits": { + "smithy.api#documentation": "

The name of the quick response.

", + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.qconnect#QuickResponseType", + "traits": { + "smithy.api#documentation": "

The media type of the quick response content.

\n ", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.qconnect#QuickResponseStatus", + "traits": { + "smithy.api#documentation": "

The resource status of the quick response.

", + "smithy.api#required": {} + } + }, + "contents": { + "target": "com.amazonaws.qconnect#QuickResponseContents", + "traits": { + "smithy.api#documentation": "

The contents of the quick response.

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

The timestamp when the quick response was created.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the quick response search result data was last modified.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "isActive": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether the quick response is active.

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

The description of the quick response.

" + } + }, + "groupingConfiguration": { + "target": "com.amazonaws.qconnect#GroupingConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information of the user groups that the quick response is accessible to.

" + } + }, + "shortcutKey": { + "target": "com.amazonaws.qconnect#ShortCutKey", + "traits": { + "smithy.api#documentation": "

The shortcut key of the quick response. The value should be unique across the\n knowledge base.

" + } + }, + "lastModifiedBy": { + "target": "com.amazonaws.qconnect#GenericArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.

" + } + }, + "channels": { + "target": "com.amazonaws.qconnect#Channels", + "traits": { + "smithy.api#documentation": "

The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.

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

The language code value for the language in which the quick response is written.

" + } + }, + "attributesNotInterpolated": { + "target": "com.amazonaws.qconnect#ContactAttributeKeys", + "traits": { + "smithy.api#documentation": "

The user defined contact attributes that are not resolved when the search result is returned.

" + } + }, + "attributesInterpolated": { + "target": "com.amazonaws.qconnect#ContactAttributeKeys", + "traits": { + "smithy.api#documentation": "

The user defined contact attributes that are resolved when the search result is returned.

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

The tags used to organize, track, or control access for this resource.

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

The result of quick response search.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#QuickResponse" + }, + { + "resource": "com.amazonaws.qconnect#KnowledgeBase" + } + ] + } + }, + "com.amazonaws.qconnect#QuickResponseSearchResultsList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#QuickResponseSearchResultData" + } + }, + "com.amazonaws.qconnect#QuickResponseStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATE_IN_PROGRESS", + "name": "CREATE_IN_PROGRESS" + }, + { + "value": "CREATE_FAILED", + "name": "CREATE_FAILED" + }, + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "DELETE_IN_PROGRESS", + "name": "DELETE_IN_PROGRESS" + }, + { + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" + }, + { + "value": "DELETED", + "name": "DELETED" + }, + { + "value": "UPDATE_IN_PROGRESS", + "name": "UPDATE_IN_PROGRESS" + }, + { + "value": "UPDATE_FAILED", + "name": "UPDATE_FAILED" + } + ] + } + }, + "com.amazonaws.qconnect#QuickResponseSummary": { + "type": "structure", + "members": { + "quickResponseArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the quick response.

", + "smithy.api#required": {} + } + }, + "quickResponseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the quick response.

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

The Amazon Resource Name (ARN) of the knowledge base.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#QuickResponseName", + "traits": { + "smithy.api#documentation": "

The name of the quick response.

", + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.qconnect#QuickResponseType", + "traits": { + "smithy.api#documentation": "

The media type of the quick response content.

\n ", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.qconnect#QuickResponseStatus", + "traits": { + "smithy.api#documentation": "

The resource status of the quick response.

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

The timestamp when the quick response was created.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the quick response summary was last modified.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "description": { + "target": "com.amazonaws.qconnect#QuickResponseDescription", + "traits": { + "smithy.api#documentation": "

The description of the quick response.

" + } + }, + "lastModifiedBy": { + "target": "com.amazonaws.qconnect#GenericArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last updated the quick response data.

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

Whether the quick response is active.

" + } + }, + "channels": { + "target": "com.amazonaws.qconnect#Channels", + "traits": { + "smithy.api#documentation": "

The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.

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

The tags used to organize, track, or control access for this resource.

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

The summary information about the quick response.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#QuickResponse" + }, + { + "resource": "com.amazonaws.qconnect#KnowledgeBase" + } + ] + } + }, + "com.amazonaws.qconnect#QuickResponseSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#QuickResponseSummary" + } + }, + "com.amazonaws.qconnect#QuickResponseType": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(application/x\\.quickresponse;format=(plain|markdown))$" + } + }, + "com.amazonaws.qconnect#RankingData": { + "type": "structure", + "members": { + "relevanceScore": { + "target": "com.amazonaws.qconnect#RelevanceScore", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The relevance level of the recommendation.

" + } + }, + "relevanceLevel": { + "target": "com.amazonaws.qconnect#RelevanceLevel", + "traits": { + "smithy.api#documentation": "

The relevance score of the content.

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

Details about the source content ranking data.

" + } + }, + "com.amazonaws.qconnect#RecommendationData": { + "type": "structure", + "members": { + "recommendationId": { + "target": "com.amazonaws.qconnect#RecommendationId", + "traits": { + "smithy.api#documentation": "

The identifier of the recommendation.

", + "smithy.api#required": {} + } + }, + "document": { + "target": "com.amazonaws.qconnect#Document", + "traits": { + "smithy.api#documentation": "

The recommended document.

" + } + }, + "relevanceScore": { + "target": "com.amazonaws.qconnect#RelevanceScore", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The relevance score of the recommendation.

" + } + }, + "relevanceLevel": { + "target": "com.amazonaws.qconnect#RelevanceLevel", + "traits": { + "smithy.api#documentation": "

The relevance level of the recommendation.

" + } + }, + "type": { + "target": "com.amazonaws.qconnect#RecommendationType", + "traits": { + "smithy.api#documentation": "

The type of recommendation.

" + } + }, + "data": { + "target": "com.amazonaws.qconnect#DataSummary", + "traits": { + "smithy.api#documentation": "

Summary of the recommended content.

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

Information about the recommendation.

" + } + }, + "com.amazonaws.qconnect#RecommendationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.qconnect#RecommendationIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#RecommendationId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.qconnect#RecommendationList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#RecommendationData" + } + }, + "com.amazonaws.qconnect#RecommendationSourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ISSUE_DETECTION", + "name": "ISSUE_DETECTION" + }, + { + "value": "RULE_EVALUATION", + "name": "RULE_EVALUATION" + }, + { + "value": "OTHER", + "name": "OTHER" + } + ] + } + }, + "com.amazonaws.qconnect#RecommendationTrigger": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the recommendation trigger.

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

The type of recommendation trigger.

", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.qconnect#RecommendationSourceType", + "traits": { + "smithy.api#documentation": "

The source of the recommendation trigger.

\n ", + "smithy.api#required": {} + } + }, + "data": { + "target": "com.amazonaws.qconnect#RecommendationTriggerData", + "traits": { + "smithy.api#documentation": "

A union type containing information related to the trigger.

", + "smithy.api#required": {} + } + }, + "recommendationIds": { + "target": "com.amazonaws.qconnect#RecommendationIdList", + "traits": { + "smithy.api#documentation": "

The identifiers of the recommendations.

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

A recommendation trigger provides context on the event that produced the referenced\n recommendations. Recommendations are only referenced in recommendationIds by a\n single RecommendationTrigger.

" + } + }, + "com.amazonaws.qconnect#RecommendationTriggerData": { + "type": "union", + "members": { + "query": { + "target": "com.amazonaws.qconnect#QueryRecommendationTriggerData", + "traits": { + "smithy.api#documentation": "

Data associated with the QUERY RecommendationTriggerType.

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

A union type containing information related to the trigger.

" + } + }, + "com.amazonaws.qconnect#RecommendationTriggerList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#RecommendationTrigger" + } + }, + "com.amazonaws.qconnect#RecommendationTriggerType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "QUERY", + "name": "QUERY" + }, + { + "value": "GENERATIVE", + "name": "GENERATIVE" + } + ] + } + }, + "com.amazonaws.qconnect#RecommendationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "KNOWLEDGE_CONTENT", + "name": "KNOWLEDGE_CONTENT" + }, + { + "value": "GENERATIVE_RESPONSE", + "name": "GENERATIVE_RESPONSE" + }, + { + "value": "GENERATIVE_ANSWER", + "name": "GENERATIVE_ANSWER" + } + ] + } + }, + "com.amazonaws.qconnect#RelevanceLevel": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "MEDIUM", + "name": "MEDIUM" + }, + { + "value": "LOW", + "name": "LOW" + } + ] + } + }, + "com.amazonaws.qconnect#RelevanceScore": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0.0 + } + } + }, + "com.amazonaws.qconnect#RemoveKnowledgeBaseTemplateUri": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#RemoveKnowledgeBaseTemplateUriRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#RemoveKnowledgeBaseTemplateUriResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a URI template from a knowledge base.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/templateUri", + "method": "DELETE", + "code": 204 + } + } + }, + "com.amazonaws.qconnect#RemoveKnowledgeBaseTemplateUriRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.qconnect#RemoveKnowledgeBaseTemplateUriResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.qconnect#RenderingConfiguration": { + "type": "structure", + "members": { + "templateUri": { + "target": "com.amazonaws.qconnect#Uri", + "traits": { + "smithy.api#documentation": "

A URI template containing exactly one variable in ${variableName} format.\n This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow,\n and Zendesk, the variable must be one of the following:

\n \n

The variable is replaced with the actual value for a piece of content when calling GetContent.

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

Information about how to render the content.

" + } + }, + "com.amazonaws.qconnect#RequestTimeoutException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

The request reached the service more than 15 minutes after the date stamp on the request\n or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or\n the date stamp on the request is more than 15 minutes in the future.

", + "smithy.api#error": "client", + "smithy.api#httpError": 408, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.qconnect#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + }, + "resourceName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The specified resource name.

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

The specified resource does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.qconnect#ResultData": { + "type": "structure", + "members": { + "resultId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the result data.

", + "smithy.api#required": {} + } + }, + "document": { + "target": "com.amazonaws.qconnect#Document", + "traits": { + "smithy.api#documentation": "

The document.

" + } + }, + "relevanceScore": { + "target": "com.amazonaws.qconnect#RelevanceScore", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The relevance score of the results.

" + } + }, + "data": { + "target": "com.amazonaws.qconnect#DataSummary", + "traits": { + "smithy.api#documentation": "

Summary of the recommended content.

" + } + }, + "type": { + "target": "com.amazonaws.qconnect#QueryResultType", + "traits": { + "smithy.api#documentation": "

The type of the query result.

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

Information about the result.

" + } + }, + "com.amazonaws.qconnect#SearchContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#SearchContentRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#SearchContentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Searches for content in a specified knowledge base. Can be used to get a specific content\n resource by its name.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/search", + "method": "POST" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "contentSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#SearchContentRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.qconnect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qconnect#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "searchExpression": { + "target": "com.amazonaws.qconnect#SearchExpression", + "traits": { + "smithy.api#documentation": "

The search expression to filter results.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.qconnect#SearchContentResponse": { + "type": "structure", + "members": { + "contentSummaries": { + "target": "com.amazonaws.qconnect#ContentSummaryList", + "traits": { + "smithy.api#documentation": "

Summary information about the content.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.qconnect#SearchExpression": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.qconnect#FilterList", + "traits": { + "smithy.api#documentation": "

The search expression filters.

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

The search expression.

" + } + }, + "com.amazonaws.qconnect#SearchQuickResponses": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#SearchQuickResponsesRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#SearchQuickResponsesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#RequestTimeoutException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Searches existing Amazon Q quick responses in a Amazon Q knowledge base.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/search/quickResponses", + "method": "POST" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "results" + } + } + }, + "com.amazonaws.qconnect#SearchQuickResponsesRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "searchExpression": { + "target": "com.amazonaws.qconnect#QuickResponseSearchExpression", + "traits": { + "smithy.api#documentation": "

The search expression for querying the quick response.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qconnect#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "attributes": { + "target": "com.amazonaws.qconnect#ContactAttributes", + "traits": { + "smithy.api#documentation": "

The user-defined Amazon Connect contact attributes to be resolved when search results are returned.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#SearchQuickResponsesResponse": { + "type": "structure", + "members": { + "results": { + "target": "com.amazonaws.qconnect#QuickResponseSearchResultsList", + "traits": { + "smithy.api#documentation": "

The results of the quick response search.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#SearchSessions": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#SearchSessionsRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#SearchSessionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Searches for sessions.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/searchSessions", + "method": "POST" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "sessionSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#SearchSessionsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.qconnect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qconnect#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "searchExpression": { + "target": "com.amazonaws.qconnect#SearchExpression", + "traits": { + "smithy.api#documentation": "

The search expression to filter results.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.qconnect#SearchSessionsResponse": { + "type": "structure", + "members": { + "sessionSummaries": { + "target": "com.amazonaws.qconnect#SessionSummaries", + "traits": { + "smithy.api#documentation": "

Summary information about the sessions.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.qconnect#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.qconnect#ServerSideEncryptionConfiguration": { + "type": "structure", + "members": { + "kmsKeyId": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The customer managed key used for encryption. For more information about setting up a\n customer managed key for Amazon Q, see Enable Amazon Q in Connect for your instance.\n For information about valid ID values, see Key identifiers (KeyId).

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

The configuration information for the customer managed key used for encryption.

" + } + }, + "com.amazonaws.qconnect#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

You've exceeded your service quota. To perform the requested action, remove some of the\n relevant resources, or use service quotas to request a service quota increase.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.qconnect#Session": { + "type": "resource", + "identifiers": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + }, + "sessionId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + } + }, + "create": { + "target": "com.amazonaws.qconnect#CreateSession" + }, + "read": { + "target": "com.amazonaws.qconnect#GetSession" + }, + "traits": { + "aws.api#arn": { + "template": "session/{assistantId}/{sessionId}" + }, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.qconnect#SessionData": { + "type": "structure", + "members": { + "sessionArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the session.

", + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the session.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#Name", + "traits": { + "smithy.api#documentation": "

The name of the session.

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

The description of the session.

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

The tags used to organize, track, or control access for this resource.

" + } + }, + "integrationConfiguration": { + "target": "com.amazonaws.qconnect#SessionIntegrationConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information for the session integration.

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

Information about the session.

" + } + }, + "com.amazonaws.qconnect#SessionIntegrationConfiguration": { + "type": "structure", + "members": { + "topicIntegrationArn": { + "target": "com.amazonaws.qconnect#GenericArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.

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

The configuration information for the session integration.

" + } + }, + "com.amazonaws.qconnect#SessionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#SessionSummary" + } + }, + "com.amazonaws.qconnect#SessionSummary": { + "type": "structure", + "members": { + "sessionId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the session.

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

The Amazon Resource Name (ARN) of the session.

", + "smithy.api#required": {} + } + }, + "assistantId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q assistant.

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

The Amazon Resource Name (ARN) of the Amazon Q assistant.

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

Summary information about the session.

" + } + }, + "com.amazonaws.qconnect#ShortCutKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.qconnect#SourceConfiguration": { + "type": "union", + "members": { + "appIntegrations": { + "target": "com.amazonaws.qconnect#AppIntegrationsConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration information for Amazon AppIntegrations to automatically ingest content.

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

Configuration information about the external data source.

" + } + }, + "com.amazonaws.qconnect#SourceContentDataDetails": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the source content.

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

The type of the source content.

", + "smithy.api#required": {} + } + }, + "textData": { + "target": "com.amazonaws.qconnect#TextData", + "traits": { + "smithy.api#documentation": "

Details about the source content text data.

", + "smithy.api#required": {} + } + }, + "rankingData": { + "target": "com.amazonaws.qconnect#RankingData", + "traits": { + "smithy.api#documentation": "

Details about the source content ranking data.

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

Details about the source content data.

" + } + }, + "com.amazonaws.qconnect#SourceContentType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "KNOWLEDGE_CONTENT", + "name": "KNOWLEDGE_CONTENT" + } + ] + } + }, + "com.amazonaws.qconnect#StartContentUpload": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#StartContentUploadRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#StartContentUploadResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get a URL to upload content to a knowledge base. To upload content, first make a PUT\n request to the returned URL with your file, making sure to include the required headers. Then\n use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a\n knowledge base of type CUSTOM.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/upload", + "method": "POST" + } + } + }, + "com.amazonaws.qconnect#StartContentUploadRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.qconnect#ContentType", + "traits": { + "smithy.api#documentation": "

The type of content to upload.

", + "smithy.api#required": {} + } + }, + "presignedUrlTimeToLive": { + "target": "com.amazonaws.qconnect#TimeToLive", + "traits": { + "smithy.api#documentation": "

The expected expiration time of the generated presigned URL, specified in minutes.

" + } + } + } + }, + "com.amazonaws.qconnect#StartContentUploadResponse": { + "type": "structure", + "members": { + "uploadId": { + "target": "com.amazonaws.qconnect#UploadId", + "traits": { + "smithy.api#documentation": "

The identifier of the upload.

", + "smithy.api#required": {} + } + }, + "url": { + "target": "com.amazonaws.qconnect#Url", + "traits": { + "smithy.api#documentation": "

The URL of the upload.

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

The expiration time of the URL as an epoch timestamp.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "headersToInclude": { + "target": "com.amazonaws.qconnect#Headers", + "traits": { + "smithy.api#documentation": "

The headers to include in the upload.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.qconnect#StartImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#StartImportJobRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#StartImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Start an asynchronous job to import Amazon Q resources from an uploaded source file. Before calling this API, use StartContentUpload to\n upload an asset that contains the resource data.

\n ", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/importJobs", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#StartImportJobRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "importJobType": { + "target": "com.amazonaws.qconnect#ImportJobType", + "traits": { + "smithy.api#documentation": "

The type of the import job.

\n ", + "smithy.api#required": {} + } + }, + "uploadId": { + "target": "com.amazonaws.qconnect#UploadId", + "traits": { + "smithy.api#documentation": "

A pointer to the uploaded asset. This value is returned by StartContentUpload.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

", + "smithy.api#idempotencyToken": {} + } + }, + "metadata": { + "target": "com.amazonaws.qconnect#ContentMetadata", + "traits": { + "smithy.api#documentation": "

The metadata fields of the imported Amazon Q resources.

" + } + }, + "externalSourceConfiguration": { + "target": "com.amazonaws.qconnect#ExternalSourceConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information of the external source that the resource data are imported from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#StartImportJobResponse": { + "type": "structure", + "members": { + "importJob": { + "target": "com.amazonaws.qconnect#ImportJobData", + "traits": { + "smithy.api#documentation": "

The import job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + } + }, + "com.amazonaws.qconnect#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.qconnect#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds the specified tags to the specified resource.

", + "smithy.api#http": { + "uri": "/tags/{resourceArn}", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

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

The tags used to organize, track, or control access for this resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.qconnect#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.qconnect#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.qconnect#Tags": { + "type": "map", + "key": { + "target": "com.amazonaws.qconnect#TagKey" + }, + "value": { + "target": "com.amazonaws.qconnect#TagValue" + } + }, + "com.amazonaws.qconnect#TextData": { + "type": "structure", + "members": { + "title": { + "target": "com.amazonaws.qconnect#DocumentText" + }, + "excerpt": { + "target": "com.amazonaws.qconnect#DocumentText" + } + }, + "traits": { + "smithy.api#documentation": "

Details about the source content text data.

" + } + }, + "com.amazonaws.qconnect#TimeToLive": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Expiration time in minutes", + "smithy.api#range": { + "min": 1, + "max": 60 + } + } + }, + "com.amazonaws.qconnect#TooManyTagsException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + }, + "resourceName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The specified resource name.

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

Amazon Q in Connect throws this exception if you have too many tags in your tag set.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.qconnect#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified tags from the specified resource.

", + "smithy.api#http": { + "uri": "/tags/{resourceArn}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.qconnect#TagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.qconnect#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.qconnect#UpdateContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#UpdateContentRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#UpdateContentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#PreconditionFailedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates information about the content.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", + "method": "POST" + } + } + }, + "com.amazonaws.qconnect#UpdateContentRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "contentId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "revisionId": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The revisionId of the content resource to update, taken from an earlier call\n to GetContent, GetContentSummary, SearchContent, or\n ListContents. If included, this argument acts as an optimistic lock to ensure\n content was not modified since it was last read. If it has been modified, this API throws a\n PreconditionFailedException.

" + } + }, + "title": { + "target": "com.amazonaws.qconnect#ContentTitle", + "traits": { + "smithy.api#documentation": "

The title of the content.

" + } + }, + "overrideLinkOutUri": { + "target": "com.amazonaws.qconnect#Uri", + "traits": { + "smithy.api#documentation": "

The URI for the article. If the knowledge base has a templateUri, setting this argument\n overrides it for this piece of content. To remove an existing overrideLinkOurUri,\n exclude this argument and set removeOverrideLinkOutUri to true.

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

Unset the existing overrideLinkOutUri if it exists.

" + } + }, + "metadata": { + "target": "com.amazonaws.qconnect#ContentMetadata", + "traits": { + "smithy.api#documentation": "

A key/value map to store attributes without affecting tagging or recommendations. For\n example, when synchronizing data between an external system and Amazon Q, you can store an\n external version identifier as metadata to utilize for determining drift.

" + } + }, + "uploadId": { + "target": "com.amazonaws.qconnect#UploadId", + "traits": { + "smithy.api#documentation": "

A pointer to the uploaded asset. This value is returned by StartContentUpload.\n

" + } + } + } + }, + "com.amazonaws.qconnect#UpdateContentResponse": { + "type": "structure", + "members": { + "content": { + "target": "com.amazonaws.qconnect#ContentData", + "traits": { + "smithy.api#documentation": "

The content.

" + } + } + } + }, + "com.amazonaws.qconnect#UpdateKnowledgeBaseTemplateUri": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#UpdateKnowledgeBaseTemplateUriRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#UpdateKnowledgeBaseTemplateUriResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the template URI of a knowledge base. This is only supported for knowledge bases\n of type EXTERNAL. Include a single variable in ${variable} format; this\n interpolated by Amazon Q using ingested content. For example, if you ingest a Salesforce\n article, it has an Id value, and you can set the template URI to\n https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.\n

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/templateUri", + "method": "POST" + } + } + }, + "com.amazonaws.qconnect#UpdateKnowledgeBaseTemplateUriRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "templateUri": { + "target": "com.amazonaws.qconnect#Uri", + "traits": { + "smithy.api#documentation": "

The template URI to update.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.qconnect#UpdateKnowledgeBaseTemplateUriResponse": { + "type": "structure", + "members": { + "knowledgeBase": { + "target": "com.amazonaws.qconnect#KnowledgeBaseData", + "traits": { + "smithy.api#documentation": "

The knowledge base to update.

" + } + } + } + }, + "com.amazonaws.qconnect#UpdateQuickResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#UpdateQuickResponseRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#UpdateQuickResponseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#PreconditionFailedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing Amazon Q quick response.

", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}", + "method": "POST" + } + } + }, + "com.amazonaws.qconnect#UpdateQuickResponseRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "quickResponseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the quick response.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#QuickResponseName", + "traits": { + "smithy.api#documentation": "

The name of the quick response.

" + } + }, + "content": { + "target": "com.amazonaws.qconnect#QuickResponseDataProvider", + "traits": { + "smithy.api#documentation": "

The updated content of the quick response.

" + } + }, + "contentType": { + "target": "com.amazonaws.qconnect#QuickResponseType", + "traits": { + "smithy.api#documentation": "

The media type of the quick response content.

\n " + } + }, + "groupingConfiguration": { + "target": "com.amazonaws.qconnect#GroupingConfiguration", + "traits": { + "smithy.api#documentation": "

The updated grouping configuration of the quick response.

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

Whether to remove the grouping configuration of the quick response.

" + } + }, + "description": { + "target": "com.amazonaws.qconnect#QuickResponseDescription", + "traits": { + "smithy.api#documentation": "

The updated description of the quick response.

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

Whether to remove the description from the quick response.

" + } + }, + "shortcutKey": { + "target": "com.amazonaws.qconnect#ShortCutKey", + "traits": { + "smithy.api#documentation": "

The shortcut key of the quick response. The value should be unique across the\n knowledge base.

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

Whether to remove the shortcut key of the quick response.

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

Whether the quick response is active.

" + } + }, + "channels": { + "target": "com.amazonaws.qconnect#Channels", + "traits": { + "smithy.api#documentation": "

The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.

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

The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES,\n fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR,\n zh_CN, zh_TW\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#UpdateQuickResponseResponse": { + "type": "structure", + "members": { + "quickResponse": { + "target": "com.amazonaws.qconnect#QuickResponseData", + "traits": { + "smithy.api#documentation": "

The quick response.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#UploadId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1200 + } + } + }, + "com.amazonaws.qconnect#Uri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.qconnect#Url": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.qconnect#Uuid": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.qconnect#UuidOrArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$" + } + }, + "com.amazonaws.qconnect#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

The input fails to satisfy the constraints specified by a service.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.qconnect#WaitTimeSeconds": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.qconnect#WisdomService": { + "type": "service", + "version": "2020-10-19", + "operations": [ + { + "target": "com.amazonaws.qconnect#ListTagsForResource" + }, + { + "target": "com.amazonaws.qconnect#TagResource" + }, + { + "target": "com.amazonaws.qconnect#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.qconnect#Assistant" + }, + { + "target": "com.amazonaws.qconnect#KnowledgeBase" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "QConnect", + "arnNamespace": "wisdom", + "cloudFormationName": "Wisdom" + }, + "aws.auth#sigv4": { + "name": "wisdom" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": {}, + "smithy.api#documentation": "

Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution\n of Amazon Connect Wisdom that delivers real-time recommendations to help contact center\n agents resolve customer issues quickly and accurately.

\n

Amazon Q automatically detects customer intent during calls and chats using\n conversational analytics and natural language understanding (NLU). It then provides agents\n with immediate, real-time generative responses and suggested actions, and links to relevant\n documents and articles. Agents can also query Amazon Q directly using natural language or\n keywords to answer customer requests.

\n

Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or\n manage content by uploading custom files.

\n

For more information, see Use Amazon Q in Connect for generative AI\n powered agent assistance in real-time in the Amazon Connect\n Administrator Guide.

", + "smithy.api#title": "Amazon Q Connect", + "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": [], + "rules": [ + { + "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" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wisdom-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wisdom-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wisdom.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wisdom.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wisdom-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wisdom-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wisdom.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wisdom.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wisdom-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://wisdom-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://wisdom.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wisdom.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wisdom-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wisdom-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wisdom.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wisdom.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wisdom-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wisdom.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wisdom-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wisdom.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/s3-control.json b/codegen/sdk-codegen/aws-models/s3-control.json index 590e6a3763c..306e0ea4997 100644 --- a/codegen/sdk-codegen/aws-models/s3-control.json +++ b/codegen/sdk-codegen/aws-models/s3-control.json @@ -7222,7 +7222,7 @@ "target": "com.amazonaws.s3control#CreateAccessPointResult" }, "traits": { - "smithy.api#documentation": "

Creates an access point and associates it with the specified bucket. For more information, see\n Managing\n Data Access with Amazon S3 Access Points in the\n Amazon S3 User Guide.

\n

\n \n

S3 on Outposts only supports VPC-style access points.

\n

For more information, see Accessing Amazon S3 on Outposts using\n virtual private cloud (VPC) only access points in the\n Amazon S3 User Guide.

\n \n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

\n

The following actions are related to CreateAccessPoint:

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

This operation is not supported by directory buckets.

\n \n

Creates an access point and associates it with the specified bucket. For more information, see\n Managing\n Data Access with Amazon S3 Access Points in the\n Amazon S3 User Guide.

\n

\n \n

S3 on Outposts only supports VPC-style access points.

\n

For more information, see Accessing Amazon S3 on Outposts using\n virtual private cloud (VPC) only access points in the\n Amazon S3 User Guide.

\n \n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

\n

The following actions are related to CreateAccessPoint:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -7247,7 +7247,7 @@ "target": "com.amazonaws.s3control#CreateAccessPointForObjectLambdaResult" }, "traits": { - "smithy.api#documentation": "

Creates an Object Lambda Access Point. For more information, see Transforming objects with\n Object Lambda Access Points in the Amazon S3 User Guide.

\n

The following actions are related to\n CreateAccessPointForObjectLambda:

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

This operation is not supported by directory buckets.

\n \n

Creates an Object Lambda Access Point. For more information, see Transforming objects with\n Object Lambda Access Points in the Amazon S3 User Guide.

\n

The following actions are related to\n CreateAccessPointForObjectLambda:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -7565,7 +7565,7 @@ } ], "traits": { - "smithy.api#documentation": "

You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects.\n Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more\n information, see S3 Batch Operations in the Amazon S3 User Guide.

\n

This action creates a S3 Batch Operations job.

\n

\n

Related actions include:

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

This operation creates an S3 Batch Operations job.

\n

You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects.\n Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more\n information, see S3 Batch Operations in the Amazon S3 User Guide.

\n
\n
Permissions
\n
\n

For information about permissions required to use the Batch Operations, see Granting permissions for S3 Batch Operations in the Amazon S3\n User Guide.

\n
\n
\n

\n

Related actions include:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -7692,7 +7692,7 @@ "target": "com.amazonaws.s3control#CreateMultiRegionAccessPointResult" }, "traits": { - "smithy.api#documentation": "

Creates a Multi-Region Access Point and associates it with the specified buckets. For more information\n about creating Multi-Region Access Points, see Creating\n Multi-Region Access Points in the Amazon S3 User Guide.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around managing Multi-Region Access Points, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.

\n

This request is asynchronous, meaning that you might receive a response before the\n command has completed. When this request provides a response, it provides a token that you\n can use to monitor the status of the request with\n DescribeMultiRegionAccessPointOperation.

\n

The following actions are related to CreateMultiRegionAccessPoint:

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

This operation is not supported by directory buckets.

\n \n

Creates a Multi-Region Access Point and associates it with the specified buckets. For more information\n about creating Multi-Region Access Points, see Creating\n Multi-Region Access Points in the Amazon S3 User Guide.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around managing Multi-Region Access Points, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.

\n

This request is asynchronous, meaning that you might receive a response before the\n command has completed. When this request provides a response, it provides a token that you\n can use to monitor the status of the request with\n DescribeMultiRegionAccessPointOperation.

\n

The following actions are related to CreateMultiRegionAccessPoint:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -8104,7 +8104,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Deletes the specified access point.

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to DeleteAccessPoint:

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

This operation is not supported by directory buckets.

\n \n

Deletes the specified access point.

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to DeleteAccessPoint:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -8129,7 +8129,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Deletes the specified Object Lambda Access Point.

\n

The following actions are related to\n DeleteAccessPointForObjectLambda:

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

This operation is not supported by directory buckets.

\n \n

Deletes the specified Object Lambda Access Point.

\n

The following actions are related to\n DeleteAccessPointForObjectLambda:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -8182,7 +8182,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Deletes the access point policy for the specified access point.

\n

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to DeleteAccessPointPolicy:

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

This operation is not supported by directory buckets.

\n \n

Deletes the access point policy for the specified access point.

\n

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to DeleteAccessPointPolicy:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -8207,7 +8207,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Removes the resource policy for an Object Lambda Access Point.

\n

The following actions are related to\n DeleteAccessPointPolicyForObjectLambda:

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

This operation is not supported by directory buckets.

\n \n

Removes the resource policy for an Object Lambda Access Point.

\n

The following actions are related to\n DeleteAccessPointPolicyForObjectLambda:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -8613,7 +8613,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the entire tag set from the specified S3 Batch Operations job. To use\n the\n DeleteJobTagging operation, you must have permission to\n perform the s3:DeleteJobTagging action. For more information, see Controlling\n access and labeling jobs using tags in the\n Amazon S3 User Guide.

\n

\n

Related actions include:

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

Removes the entire tag set from the specified S3 Batch Operations job.

\n
\n
Permissions
\n
\n

To use the\n DeleteJobTagging operation, you must have permission to\n perform the s3:DeleteJobTagging action. For more information, see Controlling\n access and labeling jobs using tags in the\n Amazon S3 User Guide.

\n
\n
\n

Related actions include:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -8705,7 +8705,7 @@ "target": "com.amazonaws.s3control#DeleteMultiRegionAccessPointResult" }, "traits": { - "smithy.api#documentation": "

Deletes a Multi-Region Access Point. This action does not delete the buckets associated with the Multi-Region Access Point,\n only the Multi-Region Access Point itself.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around managing Multi-Region Access Points, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.

\n

This request is asynchronous, meaning that you might receive a response before the\n command has completed. When this request provides a response, it provides a token that you\n can use to monitor the status of the request with\n DescribeMultiRegionAccessPointOperation.

\n

The following actions are related to DeleteMultiRegionAccessPoint:

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

This operation is not supported by directory buckets.

\n \n

Deletes a Multi-Region Access Point. This action does not delete the buckets associated with the Multi-Region Access Point,\n only the Multi-Region Access Point itself.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around managing Multi-Region Access Points, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.

\n

This request is asynchronous, meaning that you might receive a response before the\n command has completed. When this request provides a response, it provides a token that you\n can use to monitor the status of the request with\n DescribeMultiRegionAccessPointOperation.

\n

The following actions are related to DeleteMultiRegionAccessPoint:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -8795,7 +8795,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Removes the PublicAccessBlock configuration for an Amazon Web Services account. For more\n information, see Using Amazon S3 block\n public access.

\n

Related actions include:

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

This operation is not supported by directory buckets.

\n \n

Removes the PublicAccessBlock configuration for an Amazon Web Services account. For more\n information, see Using Amazon S3 block\n public access.

\n

Related actions include:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -8840,7 +8840,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage\n activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:DeleteStorageLensConfiguration action. For more information, see\n Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.

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

This operation is not supported by directory buckets.

\n \n

Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage\n activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:DeleteStorageLensConfiguration action. For more information, see\n Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -8893,7 +8893,7 @@ "target": "com.amazonaws.s3control#DeleteStorageLensConfigurationTaggingResult" }, "traits": { - "smithy.api#documentation": "

Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see\n Assessing your\n storage activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:DeleteStorageLensConfigurationTagging action. For more information,\n see Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.

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

This operation is not supported by directory buckets.

\n \n

Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see\n Assessing your\n storage activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:DeleteStorageLensConfigurationTagging action. For more information,\n see Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -9020,7 +9020,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the configuration parameters and status for a Batch Operations job. For more\n information, see S3 Batch Operations in the Amazon S3 User Guide.

\n

\n

Related actions include:

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

Retrieves the configuration parameters and status for a Batch Operations job. For more\n information, see S3 Batch Operations in the Amazon S3 User Guide.

\n
\n
Permissions
\n
\n

To use the DescribeJob operation, you must have permission to perform the s3:DescribeJob action.

\n
\n
\n

Related actions include:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -9087,7 +9087,7 @@ "target": "com.amazonaws.s3control#DescribeMultiRegionAccessPointOperationResult" }, "traits": { - "smithy.api#documentation": "

Retrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information\n about managing Multi-Region Access Points and how asynchronous requests work, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.

\n

The following actions are related to GetMultiRegionAccessPoint:

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

This operation is not supported by directory buckets.

\n \n

Retrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information\n about managing Multi-Region Access Points and how asynchronous requests work, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.

\n

The following actions are related to GetMultiRegionAccessPoint:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -9189,7 +9189,7 @@ "StorageClass": { "target": "com.amazonaws.s3control#ReplicationStorageClass", "traits": { - "smithy.api#documentation": "

The storage class to use when replicating objects. All objects stored on S3 on Outposts\n are stored in the OUTPOSTS storage class. S3 on Outposts uses the\n OUTPOSTS storage class to create the object replicas.

\n \n

Values other than OUTPOSTS are not supported by Amazon S3 on Outposts.\n

\n " + "smithy.api#documentation": "

The storage class to use when replicating objects. All objects stored on S3 on Outposts\n are stored in the OUTPOSTS storage class. S3 on Outposts uses the\n OUTPOSTS storage class to create the object replicas.

\n \n

Values other than OUTPOSTS aren't supported by Amazon S3 on Outposts.

\n " } } }, @@ -9892,7 +9892,7 @@ "target": "com.amazonaws.s3control#GetAccessPointResult" }, "traits": { - "smithy.api#documentation": "

Returns configuration information about the specified access point.

\n

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to GetAccessPoint:

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

This operation is not supported by directory buckets.

\n \n

Returns configuration information about the specified access point.

\n

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to GetAccessPoint:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -9917,7 +9917,7 @@ "target": "com.amazonaws.s3control#GetAccessPointConfigurationForObjectLambdaResult" }, "traits": { - "smithy.api#documentation": "

Returns configuration for an Object Lambda Access Point.

\n

The following actions are related to\n GetAccessPointConfigurationForObjectLambda:

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

This operation is not supported by directory buckets.

\n \n

Returns configuration for an Object Lambda Access Point.

\n

The following actions are related to\n GetAccessPointConfigurationForObjectLambda:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -9984,7 +9984,7 @@ "target": "com.amazonaws.s3control#GetAccessPointForObjectLambdaResult" }, "traits": { - "smithy.api#documentation": "

Returns configuration information about the specified Object Lambda Access Point

\n

The following actions are related to GetAccessPointForObjectLambda:

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

This operation is not supported by directory buckets.

\n \n

Returns configuration information about the specified Object Lambda Access Point

\n

The following actions are related to GetAccessPointForObjectLambda:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -10069,7 +10069,7 @@ "target": "com.amazonaws.s3control#GetAccessPointPolicyResult" }, "traits": { - "smithy.api#documentation": "

Returns the access point policy associated with the specified access point.

\n

The following actions are related to GetAccessPointPolicy:

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

This operation is not supported by directory buckets.

\n \n

Returns the access point policy associated with the specified access point.

\n

The following actions are related to GetAccessPointPolicy:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -10094,7 +10094,7 @@ "target": "com.amazonaws.s3control#GetAccessPointPolicyForObjectLambdaResult" }, "traits": { - "smithy.api#documentation": "

Returns the resource policy for an Object Lambda Access Point.

\n

The following actions are related to\n GetAccessPointPolicyForObjectLambda:

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

This operation is not supported by directory buckets.

\n \n

Returns the resource policy for an Object Lambda Access Point.

\n

The following actions are related to\n GetAccessPointPolicyForObjectLambda:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -10206,7 +10206,7 @@ "target": "com.amazonaws.s3control#GetAccessPointPolicyStatusResult" }, "traits": { - "smithy.api#documentation": "

Indicates whether the specified access point currently has a policy that allows public access.\n For more information about public access through access points, see Managing Data Access with Amazon S3\n access points in the Amazon S3 User Guide.

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

This operation is not supported by directory buckets.

\n \n

Indicates whether the specified access point currently has a policy that allows public access.\n For more information about public access through access points, see Managing Data Access with Amazon S3\n access points in the Amazon S3 User Guide.

", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -10231,7 +10231,7 @@ "target": "com.amazonaws.s3control#GetAccessPointPolicyStatusForObjectLambdaResult" }, "traits": { - "smithy.api#documentation": "

Returns the status of the resource policy associated with an Object Lambda Access Point.

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

This operation is not supported by directory buckets.

\n \n

Returns the status of the resource policy associated with an Object Lambda Access Point.

", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -10436,7 +10436,7 @@ "target": "com.amazonaws.s3control#GetBucketResult" }, "traits": { - "smithy.api#documentation": "

Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the\n Amazon S3 User Guide.

\n

If you are using an identity other than the root user of the Amazon Web Services account that owns the\n Outposts bucket, the calling identity must have the s3-outposts:GetBucket\n permissions on the specified Outposts bucket and belong to the Outposts bucket owner's\n account in order to use this action. Only users from Outposts bucket owner account with\n the right permissions can perform actions on an Outposts bucket.

\n

If you don't have s3-outposts:GetBucket permissions or you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access\n Denied error.

\n

The following actions are related to GetBucket for Amazon S3 on Outposts:

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

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

Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the\n Amazon S3 User Guide.

\n \n

If you are using an identity other than the root user of the Amazon Web Services account that owns the\n Outposts bucket, the calling identity must have the s3-outposts:GetBucket\n permissions on the specified Outposts bucket and belong to the Outposts bucket owner's\n account in order to use this action. Only users from Outposts bucket owner account with\n the right permissions can perform actions on an Outposts bucket.

\n

If you don't have s3-outposts:GetBucket permissions or you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access\n Denied error.

\n

The following actions are related to GetBucket for Amazon S3 on Outposts:

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -10991,7 +10991,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the tags on an S3 Batch Operations job. To use\n the\n GetJobTagging operation, you must have permission to\n perform the s3:GetJobTagging action. For more information, see Controlling\n access and labeling jobs using tags in the\n Amazon S3 User Guide.

\n

\n

Related actions include:

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

Returns the tags on an S3 Batch Operations job.

\n
\n
Permissions
\n
\n

To use the\n GetJobTagging operation, you must have permission to\n perform the s3:GetJobTagging action. For more information, see Controlling\n access and labeling jobs using tags in the\n Amazon S3 User Guide.

\n
\n
\n

Related actions include:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -11058,7 +11058,7 @@ "target": "com.amazonaws.s3control#GetMultiRegionAccessPointResult" }, "traits": { - "smithy.api#documentation": "

Returns configuration information about the specified Multi-Region Access Point.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around managing Multi-Region Access Points, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.

\n

The following actions are related to GetMultiRegionAccessPoint:

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

This operation is not supported by directory buckets.

\n \n

Returns configuration information about the specified Multi-Region Access Point.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around managing Multi-Region Access Points, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.

\n

The following actions are related to GetMultiRegionAccessPoint:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -11084,7 +11084,7 @@ "target": "com.amazonaws.s3control#GetMultiRegionAccessPointPolicyResult" }, "traits": { - "smithy.api#documentation": "

Returns the access control policy of the specified Multi-Region Access Point.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around managing Multi-Region Access Points, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.

\n

The following actions are related to\n GetMultiRegionAccessPointPolicy:

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

This operation is not supported by directory buckets.

\n \n

Returns the access control policy of the specified Multi-Region Access Point.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around managing Multi-Region Access Points, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.

\n

The following actions are related to\n GetMultiRegionAccessPointPolicy:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -11152,7 +11152,7 @@ "target": "com.amazonaws.s3control#GetMultiRegionAccessPointPolicyStatusResult" }, "traits": { - "smithy.api#documentation": "

Indicates whether the specified Multi-Region Access Point has an access control policy that allows public\n access.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around managing Multi-Region Access Points, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.

\n

The following actions are related to\n GetMultiRegionAccessPointPolicyStatus:

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

This operation is not supported by directory buckets.

\n \n

Indicates whether the specified Multi-Region Access Point has an access control policy that allows public\n access.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around managing Multi-Region Access Points, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.

\n

The following actions are related to\n GetMultiRegionAccessPointPolicyStatus:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -11259,7 +11259,7 @@ "target": "com.amazonaws.s3control#GetMultiRegionAccessPointRoutesResult" }, "traits": { - "smithy.api#documentation": "

Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or\n passive.

\n

To obtain routing control changes and failover requests, use the Amazon S3 failover control\n infrastructure endpoints in these five Amazon Web Services Regions:

\n \n \n

Your Amazon S3 bucket does not need to be in these five Regions.

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

This operation is not supported by directory buckets.

\n \n

Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or\n passive.

\n

To obtain routing control changes and failover requests, use the Amazon S3 failover control\n infrastructure endpoints in these five Amazon Web Services Regions:

\n \n \n

Your Amazon S3 bucket does not need to be in these five Regions.

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -11338,7 +11338,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the PublicAccessBlock configuration for an Amazon Web Services account. For\n more information, see Using Amazon S3 block\n public access.

\n

Related actions include:

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

This operation is not supported by directory buckets.

\n \n

Retrieves the PublicAccessBlock configuration for an Amazon Web Services account. For\n more information, see Using Amazon S3 block\n public access.

\n

Related actions include:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -11398,7 +11398,7 @@ "target": "com.amazonaws.s3control#GetStorageLensConfigurationResult" }, "traits": { - "smithy.api#documentation": "

Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage\n activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:GetStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

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

This operation is not supported by directory buckets.

\n \n

Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage\n activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:GetStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -11466,7 +11466,7 @@ "target": "com.amazonaws.s3control#GetStorageLensConfigurationTaggingResult" }, "traits": { - "smithy.api#documentation": "

Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see\n Assessing your\n storage activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:GetStorageLensConfigurationTagging action. For more information, see\n Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.

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

This operation is not supported by directory buckets.

\n \n

Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see\n Assessing your\n storage activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:GetStorageLensConfigurationTagging action. For more information, see\n Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -12033,7 +12033,7 @@ "Location": { "target": "com.amazonaws.s3control#JobManifestLocation", "traits": { - "smithy.api#documentation": "

Contains the information required to locate the specified job's manifest.

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

Contains the information required to locate the specified job's manifest. Manifests\n can't be imported from directory buckets. For more information, see Directory buckets.

", "smithy.api#required": {} } } @@ -12192,7 +12192,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the information required to locate a manifest object.

" + "smithy.api#documentation": "

Contains the information required to locate a manifest object. Manifests can't be\n imported from directory buckets. For more information, see Directory\n buckets.

" } }, "com.amazonaws.s3control#JobManifestSpec": { @@ -12252,25 +12252,25 @@ "S3PutObjectAcl": { "target": "com.amazonaws.s3control#S3SetObjectAclOperation", "traits": { - "smithy.api#documentation": "

Directs the specified job to run a PutObjectAcl call on every object in the\n manifest.

" + "smithy.api#documentation": "

Directs the specified job to run a PutObjectAcl call on every object in the\n manifest.

\n \n

This functionality is not supported by directory buckets.

\n " } }, "S3PutObjectTagging": { "target": "com.amazonaws.s3control#S3SetObjectTaggingOperation", "traits": { - "smithy.api#documentation": "

Directs the specified job to run a PUT Object tagging call on every object in the\n manifest.

" + "smithy.api#documentation": "

Directs the specified job to run a PUT Object tagging call on every object in the\n manifest.

\n \n

This functionality is not supported by directory buckets.

\n " } }, "S3DeleteObjectTagging": { "target": "com.amazonaws.s3control#S3DeleteObjectTaggingOperation", "traits": { - "smithy.api#documentation": "

Directs the specified job to execute a DELETE Object tagging call on every object in the\n manifest.

" + "smithy.api#documentation": "

Directs the specified job to execute a DELETE Object tagging call on every object in the\n manifest.

\n \n

This functionality is not supported by directory buckets.

\n " } }, "S3InitiateRestoreObject": { "target": "com.amazonaws.s3control#S3InitiateRestoreObjectOperation", "traits": { - "smithy.api#documentation": "

Directs the specified job to initiate restore requests for every archived object in the\n manifest.

" + "smithy.api#documentation": "

Directs the specified job to initiate restore requests for every archived object in the\n manifest.

\n \n

This functionality is not supported by directory buckets.

\n " } }, "S3PutObjectLegalHold": { @@ -12282,7 +12282,7 @@ "S3ReplicateObject": { "target": "com.amazonaws.s3control#S3ReplicateObjectOperation", "traits": { - "smithy.api#documentation": "

Directs the specified job to invoke ReplicateObject on every object in the\n job's manifest.

" + "smithy.api#documentation": "

Directs the specified job to invoke ReplicateObject on every object in the\n job's manifest.

\n \n

This functionality is not supported by directory buckets.

\n " } } }, @@ -12341,7 +12341,7 @@ "Bucket": { "target": "com.amazonaws.s3control#S3BucketArnString", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the bucket where specified job-completion report will\n be stored.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the bucket where specified job-completion report will\n be stored.

\n \n

\n Directory buckets - Directory buckets aren't supported \n as a location for Batch Operations to store job completion reports.

\n " } }, "Format": { @@ -12592,6 +12592,18 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the Lambda function that the specified job will\n invoke on every object in the manifest.

" } + }, + "InvocationSchemaVersion": { + "target": "com.amazonaws.s3control#NonEmptyMaxLength64String", + "traits": { + "smithy.api#documentation": "

Specifies the schema version for the payload that Batch Operations sends when invoking\n an Lambda function. Version 1.0 is the default. Version\n 2.0 is required when you use Batch Operations to invoke Lambda functions that act on directory buckets, or if you need to specify\n UserArguments. For more information, see Using Lambda with Amazon S3 Batch Operations and Amazon S3 Express One Zone in the Amazon Web Services Storage\n Blog.

\n \n

Ensure that your Lambda function code expects\n InvocationSchemaVersion\n 2.0 and uses bucket name rather than bucket ARN. If the\n InvocationSchemaVersion does not match what your Lambda\n function expects, your function might not work as expected.

\n \n \n

\n Directory buckets - To initiate Amazon Web Services Lambda function to perform custom actions on objects in directory buckets, you must specify 2.0.

\n " + } + }, + "UserArguments": { + "target": "com.amazonaws.s3control#UserArguments", + "traits": { + "smithy.api#documentation": "

Key-value pairs that are passed in the payload that Batch Operations sends when invoking\n an Lambda function. You must specify InvocationSchemaVersion\n 2.0 for LambdaInvoke operations that include\n UserArguments. For more information, see Using Lambda with Amazon S3 Batch Operations and Amazon S3 Express One Zone in the Amazon Web Services Storage\n Blog.

" + } } }, "traits": { @@ -13218,7 +13230,7 @@ "target": "com.amazonaws.s3control#ListAccessPointsResult" }, "traits": { - "smithy.api#documentation": "

Returns a list of the access points\n that are\n owned by the current account\n that's\n associated with the specified bucket. You can retrieve up to 1000 access points\n per call. If the specified bucket has more than 1,000 access points (or the number specified in\n maxResults, whichever is less), the response will include a continuation\n token that you can use to list the additional access points.

\n

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to ListAccessPoints:

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

This operation is not supported by directory buckets.

\n \n

Returns a list of the access points\n that are\n owned by the current account\n that's\n associated with the specified bucket. You can retrieve up to 1000 access points\n per call. If the specified bucket has more than 1,000 access points (or the number specified in\n maxResults, whichever is less), the response will include a continuation\n token that you can use to list the additional access points.

\n

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to ListAccessPoints:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -13248,7 +13260,7 @@ "target": "com.amazonaws.s3control#ListAccessPointsForObjectLambdaResult" }, "traits": { - "smithy.api#documentation": "

Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call. If there\n are more access points than what can be returned in one call, the response will include a\n continuation token that you can use to list the additional access points.

\n

The following actions are related to\n ListAccessPointsForObjectLambda:

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

This operation is not supported by directory buckets.

\n \n

Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call. If there\n are more access points than what can be returned in one call, the response will include a\n continuation token that you can use to list the additional access points.

\n

The following actions are related to\n ListAccessPointsForObjectLambda:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -13410,7 +13422,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for\n the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the\n Amazon S3 User Guide.

\n

Related actions include:

\n

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

Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 30 days for\n the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the\n Amazon S3 User Guide.

\n
\n
Permissions
\n
\n

To use the\n ListJobs operation, you must have permission to\n perform the s3:ListJobs action.

\n
\n
\n

Related actions include:

\n

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -13502,7 +13514,7 @@ "target": "com.amazonaws.s3control#ListMultiRegionAccessPointsResult" }, "traits": { - "smithy.api#documentation": "

Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account.\n Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be\n associated with a single account.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around managing Multi-Region Access Points, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.

\n

The following actions are related to ListMultiRegionAccessPoint:

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

This operation is not supported by directory buckets.

\n \n

Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account.\n Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be\n associated with a single account.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around managing Multi-Region Access Points, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.

\n

The following actions are related to ListMultiRegionAccessPoint:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -13588,7 +13600,7 @@ "target": "com.amazonaws.s3control#ListRegionalBucketsResult" }, "traits": { - "smithy.api#documentation": "

Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated\n sender of the request. For more information, see Using Amazon S3 on Outposts in the\n Amazon S3 User Guide.

\n

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts\n endpoint hostname prefix and x-amz-outpost-id in your request, see the Examples section.

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

This operation is not supported by directory buckets.

\n \n

Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated\n sender of the request. For more information, see Using Amazon S3 on Outposts in the\n Amazon S3 User Guide.

\n

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts\n endpoint hostname prefix and x-amz-outpost-id in your request, see the Examples section.

", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -13719,7 +13731,7 @@ "target": "com.amazonaws.s3control#ListStorageLensConfigurationsResult" }, "traits": { - "smithy.api#documentation": "

Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see\n Assessing your\n storage activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:ListStorageLensConfigurations action. For more information, see\n Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.

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

This operation is not supported by directory buckets.

\n \n

Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see\n Assessing your\n storage activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:ListStorageLensConfigurations action. For more information, see\n Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -15184,7 +15196,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Replaces configuration for an Object Lambda Access Point.

\n

The following actions are related to\n PutAccessPointConfigurationForObjectLambda:

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

This operation is not supported by directory buckets.

\n \n

Replaces configuration for an Object Lambda Access Point.

\n

The following actions are related to\n PutAccessPointConfigurationForObjectLambda:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -15244,7 +15256,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Associates an access policy with the specified access point. Each access point can have only one policy,\n so a request made to this API replaces any existing policy associated with the specified\n access point.

\n

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to PutAccessPointPolicy:

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

This operation is not supported by directory buckets.

\n \n

Associates an access policy with the specified access point. Each access point can have only one policy,\n so a request made to this API replaces any existing policy associated with the specified\n access point.

\n

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to PutAccessPointPolicy:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -15269,7 +15281,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see Creating Object Lambda Access Points in the Amazon S3 User Guide.

\n

The following actions are related to\n PutAccessPointPolicyForObjectLambda:

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

This operation is not supported by directory buckets.

\n \n

Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see Creating Object Lambda Access Points in the Amazon S3 User Guide.

\n

The following actions are related to\n PutAccessPointPolicyForObjectLambda:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -15723,7 +15735,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the supplied tag-set on an S3 Batch Operations job.

\n

A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending\n a PUT request against the tagging subresource that is associated with the job. To modify\n the existing tag set, you can either replace the existing tag set entirely, or make changes\n within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this action to replace the tag set\n with the one you modified. For more information, see Controlling\n access and labeling jobs using tags in the Amazon S3 User Guide.

\n

\n \n \n \n

\n

To use the\n PutJobTagging\n operation,\n you must have permission to perform the s3:PutJobTagging action.

\n

Related actions include:

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

Sets the supplied tag-set on an S3 Batch Operations job.

\n

A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending\n a PUT request against the tagging subresource that is associated with the job. To modify\n the existing tag set, you can either replace the existing tag set entirely, or make changes\n within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this operation to replace the tag set\n with the one you modified. For more information, see Controlling\n access and labeling jobs using tags in the Amazon S3 User Guide.

\n \n \n \n
\n
Permissions
\n
\n

To use the\n PutJobTagging operation, you must have permission to\n perform the s3:PutJobTagging action.

\n
\n
\n

Related actions include:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -15790,7 +15802,7 @@ "target": "com.amazonaws.s3control#PutMultiRegionAccessPointPolicyResult" }, "traits": { - "smithy.api#documentation": "

Associates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only\n one policy, so a request made to this action replaces any existing policy that is\n associated with the specified Multi-Region Access Point.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around managing Multi-Region Access Points, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.

\n

The following actions are related to\n PutMultiRegionAccessPointPolicy:

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

This operation is not supported by directory buckets.

\n \n

Associates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only\n one policy, so a request made to this action replaces any existing policy that is\n associated with the specified Multi-Region Access Point.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around managing Multi-Region Access Points, see Managing\n Multi-Region Access Points in the Amazon S3 User Guide.

\n

The following actions are related to\n PutMultiRegionAccessPointPolicy:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -15887,7 +15899,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Creates or modifies the PublicAccessBlock configuration for an\n Amazon Web Services account. For this operation, users must have the\n s3:PutAccountPublicAccessBlock permission. For more information, see \n Using Amazon S3 block public access.

\n

Related actions include:

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

This operation is not supported by directory buckets.

\n \n

Creates or modifies the PublicAccessBlock configuration for an\n Amazon Web Services account. For this operation, users must have the\n s3:PutAccountPublicAccessBlock permission. For more information, see \n Using Amazon S3 block public access.

\n

Related actions include:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -15941,7 +15953,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with\n Amazon S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:PutStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

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

This operation is not supported by directory buckets.

\n \n

Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with\n Amazon S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:PutStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -16007,7 +16019,7 @@ "target": "com.amazonaws.s3control#PutStorageLensConfigurationTaggingResult" }, "traits": { - "smithy.api#documentation": "

Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information\n about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:PutStorageLensConfigurationTagging action. For more information, see\n Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.

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

This operation is not supported by directory buckets.

\n \n

Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information\n about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:PutStorageLensConfigurationTagging action. For more information, see\n Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -16793,21 +16805,21 @@ "type": "structure", "members": { "TargetResource": { - "target": "com.amazonaws.s3control#S3BucketArnString", + "target": "com.amazonaws.s3control#S3RegionalOrS3ExpressBucketArnString", "traits": { - "smithy.api#documentation": "

Specifies the destination bucket\n Amazon Resource Name\n (ARN)\n for the batch copy operation. For example, to copy objects to a bucket named\n destinationBucket, set the TargetResource property to\n arn:aws:s3:::destinationBucket.

" + "smithy.api#documentation": "

Specifies the destination bucket\n Amazon Resource Name\n (ARN)\n for the batch copy operation.

\n " } }, "CannedAccessControlList": { "target": "com.amazonaws.s3control#S3CannedAccessControlList", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

\n \n

This functionality is not supported by directory buckets.

\n " } }, "AccessControlGrants": { "target": "com.amazonaws.s3control#S3GrantList", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

\n \n

This functionality is not supported by directory buckets.

\n " } }, "MetadataDirective": { @@ -16831,26 +16843,26 @@ "NewObjectTagging": { "target": "com.amazonaws.s3control#S3TagSet", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Specifies a list of tags to add to the destination objects after they are copied. \n If NewObjectTagging is not specified, the tags of the source objects are copied to destination objects by default.

\n \n

\n Directory buckets - Tags aren't supported by directory buckets. \n If your source objects have tags and your destination bucket is a directory bucket, specify an empty tag set in the NewObjectTagging field \n to prevent copying the source object tags to the directory bucket.

\n " } }, "RedirectLocation": { "target": "com.amazonaws.s3control#NonEmptyMaxLength2048String", "traits": { - "smithy.api#documentation": "

Specifies an optional metadata property for website redirects,\n x-amz-website-redirect-location. Allows webpage redirects if the object is\n accessed through a website endpoint.

" + "smithy.api#documentation": "

If the destination bucket is configured as a website, specifies an optional metadata property for website redirects,\n x-amz-website-redirect-location. Allows webpage redirects if the object copy is\n accessed through a website endpoint.

\n \n

This functionality is not supported by directory buckets.

\n " } }, "RequesterPays": { "target": "com.amazonaws.s3control#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

" + "smithy.api#documentation": "

\n \n

This functionality is not supported by directory buckets.

\n " } }, "StorageClass": { "target": "com.amazonaws.s3control#S3StorageClass", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Specify the storage class for the destination objects in a Copy operation.

\n \n

\n Directory buckets - This functionality is not supported by directory buckets.

\n " } }, "UnModifiedSinceConstraint": { @@ -16862,7 +16874,7 @@ "SSEAwsKmsKeyId": { "target": "com.amazonaws.s3control#KmsKeyArnString", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

\n \n

This functionality is not supported by directory buckets.

\n " } }, "TargetKeyPrefix": { @@ -16874,26 +16886,26 @@ "ObjectLockLegalHoldStatus": { "target": "com.amazonaws.s3control#S3ObjectLockLegalHoldStatus", "traits": { - "smithy.api#documentation": "

The legal hold status to be applied to all objects in the Batch Operations job.

" + "smithy.api#documentation": "

The legal hold status to be applied to all objects in the Batch Operations job.

\n \n

This functionality is not supported by directory buckets.

\n " } }, "ObjectLockMode": { "target": "com.amazonaws.s3control#S3ObjectLockMode", "traits": { - "smithy.api#documentation": "

The retention mode to be applied to all objects in the Batch Operations job.

" + "smithy.api#documentation": "

The retention mode to be applied to all objects in the Batch Operations job.

\n \n

This functionality is not supported by directory buckets.

\n " } }, "ObjectLockRetainUntilDate": { "target": "com.amazonaws.s3control#TimeStamp", "traits": { - "smithy.api#documentation": "

The date when the applied object retention configuration expires on all objects in the\n Batch Operations job.

" + "smithy.api#documentation": "

The date when the applied object retention configuration expires on all objects in the\n Batch Operations job.

\n \n

This functionality is not supported by directory buckets.

\n " } }, "BucketKeyEnabled": { "target": "com.amazonaws.s3control#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with\n server-side encryption using Amazon Web Services KMS (SSE-KMS). Setting this header to true\n causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

\n

Specifying this header with an object action doesn’t affect\n bucket-level settings for S3 Bucket Key.

" + "smithy.api#documentation": "

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with\n server-side encryption using Amazon Web Services KMS (SSE-KMS). Setting this header to true\n causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

\n

Specifying this header with an object action doesn’t affect\n bucket-level settings for S3 Bucket Key.

\n \n

This functionality is not supported by directory buckets.

\n " } }, "ChecksumAlgorithm": { @@ -17065,20 +17077,20 @@ "SourceBucket": { "target": "com.amazonaws.s3control#S3BucketArnString", "traits": { - "smithy.api#documentation": "

The source bucket used by the ManifestGenerator.

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

The source bucket used by the ManifestGenerator.

\n \n

\n Directory buckets - Directory buckets aren't supported \n as the source buckets used by S3JobManifestGenerator to generate the job manifest.

\n ", "smithy.api#required": {} } }, "ManifestOutputLocation": { "target": "com.amazonaws.s3control#S3ManifestOutputLocation", "traits": { - "smithy.api#documentation": "

Specifies the location the generated manifest will be written to.

" + "smithy.api#documentation": "

Specifies the location the generated manifest will be written to. Manifests can't be\n written to directory buckets. For more information, see Directory\n buckets.

" } }, "Filter": { "target": "com.amazonaws.s3control#JobManifestGeneratorFilter", "traits": { - "smithy.api#documentation": "

Specifies rules the S3JobManifestGenerator should use to use to decide whether an object\n in the source bucket should or should not be included in the generated job manifest.

" + "smithy.api#documentation": "

Specifies rules the S3JobManifestGenerator should use to decide whether an object\n in the source bucket should or should not be included in the generated job manifest.

" } }, "EnableManifestOutput": { @@ -17116,7 +17128,7 @@ "Bucket": { "target": "com.amazonaws.s3control#S3BucketArnString", "traits": { - "smithy.api#documentation": "

The bucket ARN the generated manifest should be written to.

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

The bucket ARN the generated manifest should be written to.

\n \n

\n Directory buckets - Directory buckets aren't supported \n as the buckets to store the generated manifest.

\n ", "smithy.api#required": {} } }, @@ -17264,13 +17276,13 @@ "target": "com.amazonaws.s3control#S3ContentLength", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

" + "smithy.api#documentation": "

\n This member has been deprecated.\n

\n

" } }, "ContentMD5": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

\n This member has been deprecated.\n

\n

" } }, "ContentType": { @@ -17289,13 +17301,13 @@ "target": "com.amazonaws.s3control#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

" + "smithy.api#documentation": "

\n This member has been deprecated.\n

\n

" } }, "SSEAlgorithm": { "target": "com.amazonaws.s3control#S3SSEAlgorithm", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

\n \n

For directory buckets, only the server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.

\n " } } }, @@ -17397,6 +17409,16 @@ } } }, + "com.amazonaws.s3control#S3RegionalOrS3ExpressBucketArnString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^arn:[^:]+:(s3|s3express):" + } + }, "com.amazonaws.s3control#S3ReplicateObjectOperation": { "type": "structure", "members": {}, @@ -17477,7 +17499,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the configuration for an S3 Object Lock legal hold operation that an\n S3 Batch Operations job passes\n to\n every object to the underlying\n PutObjectLegalHold\n API\n operation. For more information, see Using S3 Object Lock legal hold\n with S3 Batch Operations in the Amazon S3 User Guide.

" + "smithy.api#documentation": "

Contains the configuration for an S3 Object Lock legal hold operation that an\n S3 Batch Operations job passes\n to\n every object to the underlying\n PutObjectLegalHold\n API\n operation. For more information, see Using S3 Object Lock legal hold\n with S3 Batch Operations in the Amazon S3 User Guide.

\n \n

This functionality is not supported by directory buckets.

\n " } }, "com.amazonaws.s3control#S3SetObjectRetentionOperation": { @@ -17499,7 +17521,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the configuration parameters for the Object Lock retention action for an\n S3 Batch Operations job. Batch Operations passes every object to the underlying\n PutObjectRetention\n API\n operation. For more information, see Using S3 Object Lock retention\n with S3 Batch Operations in the Amazon S3 User Guide.

" + "smithy.api#documentation": "

Contains the configuration parameters for the Object Lock retention action for an\n S3 Batch Operations job. Batch Operations passes every object to the underlying\n PutObjectRetention\n API\n operation. For more information, see Using S3 Object Lock retention\n with S3 Batch Operations in the Amazon S3 User Guide.

\n \n

This functionality is not supported by directory buckets.

\n " } }, "com.amazonaws.s3control#S3SetObjectTaggingOperation": { @@ -17901,21 +17923,21 @@ "Name": { "target": "com.amazonaws.s3control#StorageLensGroupName", "traits": { - "smithy.api#documentation": "

\nContains the name of the Storage Lens group.\n

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

Contains the name of the Storage Lens group.

", "smithy.api#required": {} } }, "Filter": { "target": "com.amazonaws.s3control#StorageLensGroupFilter", "traits": { - "smithy.api#documentation": "

Sets the criteria for the Storage Lens group data that is displayed. For multiple filter conditions, the AND or OR\n logical operator is used.

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

Sets the criteria for the Storage Lens group data that is displayed. For multiple filter\n conditions, the AND or OR logical operator is used.

", "smithy.api#required": {} } }, "StorageLensGroupArn": { "target": "com.amazonaws.s3control#StorageLensGroupArn", "traits": { - "smithy.api#documentation": "

\nContains the Amazon Resource Name (ARN) of the Storage Lens group. This property is read-only.\n

" + "smithy.api#documentation": "

Contains the Amazon Resource Name (ARN) of the Storage Lens group. This property is\n read-only.

" } } }, @@ -17929,36 +17951,36 @@ "MatchAnyPrefix": { "target": "com.amazonaws.s3control#MatchAnyPrefix", "traits": { - "smithy.api#documentation": "

\n Contains a list of prefixes. At least one prefix must be specified. Up to 10 prefixes are allowed.\n

" + "smithy.api#documentation": "

Contains a list of prefixes. At least one prefix must be specified. Up to 10 prefixes\n are allowed.

" } }, "MatchAnySuffix": { "target": "com.amazonaws.s3control#MatchAnySuffix", "traits": { - "smithy.api#documentation": "

\n Contains a list of suffixes. At least one suffix must be specified. Up to 10 suffixes are allowed.\n

" + "smithy.api#documentation": "

Contains a list of suffixes. At least one suffix must be specified. Up to 10 suffixes\n are allowed.

" } }, "MatchAnyTag": { "target": "com.amazonaws.s3control#MatchAnyTag", "traits": { - "smithy.api#documentation": "

\n Contains the list of object tags. At least one object tag must be specified. Up to 10 object tags are allowed.\n

" + "smithy.api#documentation": "

Contains the list of object tags. At least one object tag must be specified. Up to 10\n object tags are allowed.

" } }, "MatchObjectAge": { "target": "com.amazonaws.s3control#MatchObjectAge", "traits": { - "smithy.api#documentation": "

\n Contains DaysGreaterThan and DaysLessThan to define the object age range (minimum and maximum number of days).\n

" + "smithy.api#documentation": "

Contains DaysGreaterThan and DaysLessThan to define the\n object age range (minimum and maximum number of days).

" } }, "MatchObjectSize": { "target": "com.amazonaws.s3control#MatchObjectSize", "traits": { - "smithy.api#documentation": "

\n Contains BytesGreaterThan and BytesLessThan to define the object size range (minimum and maximum number of Bytes).\n

" + "smithy.api#documentation": "

Contains BytesGreaterThan and BytesLessThan to define the\n object size range (minimum and maximum number of Bytes).

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

\nA logical operator that allows multiple filter conditions to be joined for more complex comparisons of Storage Lens group data.\n

" + "smithy.api#documentation": "

A logical operator that allows multiple filter conditions to be joined for more complex\n comparisons of Storage Lens group data.

" } }, "com.amazonaws.s3control#StorageLensGroupArn": { @@ -17977,48 +17999,48 @@ "MatchAnyPrefix": { "target": "com.amazonaws.s3control#MatchAnyPrefix", "traits": { - "smithy.api#documentation": "

\n Contains a list of prefixes. At least one prefix must be specified. Up to 10 prefixes are allowed.\n

" + "smithy.api#documentation": "

Contains a list of prefixes. At least one prefix must be specified. Up to 10 prefixes\n are allowed.

" } }, "MatchAnySuffix": { "target": "com.amazonaws.s3control#MatchAnySuffix", "traits": { - "smithy.api#documentation": "

\n Contains a list of suffixes. At least one suffix must be specified. Up to 10 suffixes are allowed.\n

" + "smithy.api#documentation": "

Contains a list of suffixes. At least one suffix must be specified. Up to 10 suffixes\n are allowed.

" } }, "MatchAnyTag": { "target": "com.amazonaws.s3control#MatchAnyTag", "traits": { - "smithy.api#documentation": "

\n Contains the list of S3 object tags. At least one object tag must be specified. Up to 10 object tags are allowed.\n

" + "smithy.api#documentation": "

Contains the list of S3 object tags. At least one object tag must be specified. Up to\n 10 object tags are allowed.

" } }, "MatchObjectAge": { "target": "com.amazonaws.s3control#MatchObjectAge", "traits": { - "smithy.api#documentation": "

\n Contains DaysGreaterThan and DaysLessThan to define the object age range (minimum and maximum number of days).\n

" + "smithy.api#documentation": "

Contains DaysGreaterThan and DaysLessThan to define the\n object age range (minimum and maximum number of days).

" } }, "MatchObjectSize": { "target": "com.amazonaws.s3control#MatchObjectSize", "traits": { - "smithy.api#documentation": "

\n Contains BytesGreaterThan and BytesLessThan to define the object size range (minimum and maximum number of Bytes).\n

" + "smithy.api#documentation": "

Contains BytesGreaterThan and BytesLessThan to define the\n object size range (minimum and maximum number of Bytes).

" } }, "And": { "target": "com.amazonaws.s3control#StorageLensGroupAndOperator", "traits": { - "smithy.api#documentation": "

A logical operator that allows multiple filter conditions to be joined for more complex\n comparisons of Storage Lens group data. Objects must match all of the listed filter\n conditions that are joined by the And logical operator. Only one of each filter condition\n is allowed.

" + "smithy.api#documentation": "

A logical operator that allows multiple filter conditions to be joined for more complex\n comparisons of Storage Lens group data. Objects must match all of the listed filter\n conditions that are joined by the And logical operator. Only one of each\n filter condition is allowed.

" } }, "Or": { "target": "com.amazonaws.s3control#StorageLensGroupOrOperator", "traits": { - "smithy.api#documentation": "

A single logical operator that allows multiple filter conditions to be joined. Objects\n can match any of the listed filter conditions, which are joined by the Or logical operator.\n Only one of each filter condition is allowed.

" + "smithy.api#documentation": "

A single logical operator that allows multiple filter conditions to be joined. Objects\n can match any of the listed filter conditions, which are joined by the Or\n logical operator. Only one of each filter condition is allowed.

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

The filter element sets the criteria for the Storage Lens group data that is displayed. For multiple filter conditions, the AND or OR\n logical operator is used.

" + "smithy.api#documentation": "

The filter element sets the criteria for the Storage Lens group data that is displayed.\n For multiple filter conditions, the AND or OR logical operator is\n used.

" } }, "com.amazonaws.s3control#StorageLensGroupLevel": { @@ -18027,12 +18049,12 @@ "SelectionCriteria": { "target": "com.amazonaws.s3control#StorageLensGroupLevelSelectionCriteria", "traits": { - "smithy.api#documentation": "

\n Indicates which Storage Lens group ARNs to include or exclude in the Storage Lens group aggregation. If this value is left null, then all Storage Lens groups are selected.\n

" + "smithy.api#documentation": "

Indicates which Storage Lens group ARNs to include or exclude in the Storage Lens group\n aggregation. If this value is left null, then all Storage Lens groups are selected.

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

\nSpecifies the Storage Lens groups to include in the Storage Lens group aggregation.\n

" + "smithy.api#documentation": "

Specifies the Storage Lens groups to include in the Storage Lens group aggregation.\n

" } }, "com.amazonaws.s3control#StorageLensGroupLevelExclude": { @@ -18059,7 +18081,7 @@ "Include": { "target": "com.amazonaws.s3control#StorageLensGroupLevelInclude", "traits": { - "smithy.api#documentation": "

\nIndicates which Storage Lens group ARNs to include in the Storage Lens group aggregation.\n

" + "smithy.api#documentation": "

Indicates which Storage Lens group ARNs to include in the Storage Lens group\n aggregation.

" } }, "Exclude": { @@ -18127,7 +18149,7 @@ } }, "traits": { - "smithy.api#documentation": "

A container element for specifying Or rule conditions. The rule conditions\n determine the subset of objects to which the Or rule applies. Objects can\n match any of the listed filter conditions, which are joined by the Or logical operator.\n Only one of each filter condition is allowed.

" + "smithy.api#documentation": "

A container element for specifying Or rule conditions. The rule conditions\n determine the subset of objects to which the Or rule applies. Objects can\n match any of the listed filter conditions, which are joined by the Or logical\n operator. Only one of each filter condition is allowed.

" } }, "com.amazonaws.s3control#StorageLensPrefixLevelDelimiter": { @@ -18198,7 +18220,7 @@ "target": "com.amazonaws.s3control#SubmitMultiRegionAccessPointRoutesResult" }, "traits": { - "smithy.api#documentation": "

Submits an updated route configuration for a Multi-Region Access Point. This API operation updates the\n routing status for the specified Regions from active to passive, or from passive to active.\n A value of 0 indicates a passive status, which means that traffic won't be\n routed to the specified Region. A value of 100 indicates an active status,\n which means that traffic will be routed to the specified Region. At least one Region must\n be active at all times.

\n

When the routing configuration is changed, any in-progress operations (uploads, copies,\n deletes, and so on) to formerly active Regions will continue to run to their final\n completion state (success or failure). The routing configurations of any Regions that\n aren’t specified remain unchanged.

\n \n

Updated routing configurations might not be immediately applied. It can take up to 2\n minutes for your changes to take effect.

\n \n

To submit routing control changes and failover requests, use the Amazon S3 failover control\n infrastructure endpoints in these five Amazon Web Services Regions:

\n \n \n

Your Amazon S3 bucket does not need to be in these five Regions.

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

This operation is not supported by directory buckets.

\n \n

Submits an updated route configuration for a Multi-Region Access Point. This API operation updates the\n routing status for the specified Regions from active to passive, or from passive to active.\n A value of 0 indicates a passive status, which means that traffic won't be\n routed to the specified Region. A value of 100 indicates an active status,\n which means that traffic will be routed to the specified Region. At least one Region must\n be active at all times.

\n

When the routing configuration is changed, any in-progress operations (uploads, copies,\n deletes, and so on) to formerly active Regions will continue to run to their final\n completion state (success or failure). The routing configurations of any Regions that\n aren’t specified remain unchanged.

\n \n

Updated routing configurations might not be immediately applied. It can take up to 2\n minutes for your changes to take effect.

\n \n

To submit routing control changes and failover requests, use the Amazon S3 failover control\n infrastructure endpoints in these five Amazon Web Services Regions:

\n \n \n

Your Amazon S3 bucket does not need to be in these five Regions.

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -18720,7 +18742,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

\n

\n

Related actions include:

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

Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

\n
\n
Permissions
\n
\n

To use the\n UpdateJobPriority operation, you must have permission to\n perform the s3:UpdateJobPriority action.

\n
\n
\n

Related actions include:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -18822,7 +18844,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the status for the specified job. Use this action to confirm that you want to\n run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

\n

\n

Related actions include:

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

Updates the status for the specified job. Use this operation to confirm that you want to\n run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

\n
\n
Permissions
\n
\n

To use the\n UpdateJobStatus operation, you must have permission to\n perform the s3:UpdateJobStatus action.

\n
\n
\n

Related actions include:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -18967,6 +18989,21 @@ "smithy.api#input": {} } }, + "com.amazonaws.s3control#UserArguments": { + "type": "map", + "key": { + "target": "com.amazonaws.s3control#NonEmptyMaxLength64String" + }, + "value": { + "target": "com.amazonaws.s3control#MaxLength1024String" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.s3control#VersioningConfiguration": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/s3.json b/codegen/sdk-codegen/aws-models/s3.json index c168e72a14a..38ccaaaeb02 100644 --- a/codegen/sdk-codegen/aws-models/s3.json +++ b/codegen/sdk-codegen/aws-models/s3.json @@ -672,7 +672,7 @@ }, "DisableS3ExpressSessionAuth": { "required": false, - "documentation": "Internal parameter to indicate whether S3Express session auth should be disabled", + "documentation": "Parameter to indicate whether S3Express session auth should be disabled", "type": "Boolean" } }, @@ -20650,14 +20650,15 @@ "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n \n

Removes the entire tag set from the specified object. For more information about\n managing object tags, see Object Tagging.

\n

To use this operation, you must have permission to perform the\n s3:DeleteObjectTagging action.

\n

To delete tags of a specific object version, add the versionId query\n parameter in the request. You will need permission for the\n s3:DeleteObjectVersionTagging action.

\n

The following operations are related to DeleteObjectTagging:

\n ", "smithy.api#examples": [ { - "title": "To remove tag set from an object", - "documentation": "The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the operation removes tag set from the latest object version.", + "title": "To remove tag set from an object version", + "documentation": "The following example removes tag set associated with the specified object version. The request specifies both the object key and object version.", "input": { "Bucket": "examplebucket", - "Key": "HappyFace.jpg" + "Key": "HappyFace.jpg", + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" }, "output": { - "VersionId": "null" + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" } } ], @@ -20738,6 +20739,40 @@ "requestChecksumRequired": true }, "smithy.api#documentation": "

This operation enables you to delete multiple objects from a bucket using a single HTTP\n request. If you know the object keys that you want to delete, then this operation provides a\n suitable alternative to sending individual delete requests, reducing per-request\n overhead.

\n

The request can contain a list of up to 1000 keys that you want to delete. In the XML, you\n provide the object key names, and optionally, version IDs if you want to delete a specific\n version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a\n delete operation and returns the result of that delete, success or failure, in the response.\n Note that if the object specified in the request is not found, Amazon S3 returns the result as\n deleted.

\n \n \n \n

The operation supports two modes for the response: verbose and quiet. By default, the\n operation uses verbose mode in which the response includes the result of deletion of each key\n in your request. In quiet mode the response includes only keys where the delete operation \n encountered an error. For a successful deletion in a quiet mode, the operation does not return any information\n about the delete in the response body.

\n

When performing this action on an MFA Delete enabled bucket, that attempts to delete any\n versioned objects, you must include an MFA token. If you do not provide one, the entire\n request will fail, even if there are non-versioned objects you are trying to delete. If you\n provide an invalid token, whether there are versioned keys in the request or not, the\n entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA\n Delete in the Amazon S3\n User Guide.

\n \n

\n Directory buckets - MFA delete is not supported by directory buckets.

\n \n
\n
Permissions
\n
\n \n
\n
Content-MD5 request header
\n
\n \n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com.

\n
\n
\n

The following operations are related to DeleteObjects:

\n ", + "smithy.api#examples": [ + { + "title": "To delete multiple object versions from a versioned bucket", + "documentation": "The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object versions and returns the key and versions of deleted objects in the response.", + "input": { + "Bucket": "examplebucket", + "Delete": { + "Objects": [ + { + "Key": "HappyFace.jpg", + "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b" + }, + { + "Key": "HappyFace.jpg", + "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd" + } + ], + "Quiet": false + } + }, + "output": { + "Deleted": [ + { + "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd", + "Key": "HappyFace.jpg" + }, + { + "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b", + "Key": "HappyFace.jpg" + } + ] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/{Bucket}?delete&x-id=DeleteObjects", @@ -24003,19 +24038,22 @@ "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n \n

Returns the tag-set of an object. You send the GET request against the tagging\n subresource associated with the object.

\n

To use this operation, you must have permission to perform the\n s3:GetObjectTagging action. By default, the GET action returns information\n about current version of an object. For a versioned bucket, you can have multiple versions\n of an object in your bucket. To retrieve tags of any other version, use the versionId query\n parameter. You also need permission for the s3:GetObjectVersionTagging\n action.

\n

By default, the bucket owner has this permission and can grant this permission to\n others.

\n

For information about the Amazon S3 object tagging feature, see Object Tagging.

\n

The following actions are related to GetObjectTagging:

\n ", "smithy.api#examples": [ { - "title": "To retrieve tag set of a specific object version", - "documentation": "The following example retrieves tag set of an object. The request specifies object version.", + "title": "To retrieve tag set of an object", + "documentation": "The following example retrieves tag set of an object.", "input": { "Bucket": "examplebucket", - "Key": "exampleobject", - "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + "Key": "HappyFace.jpg" }, "output": { - "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI", + "VersionId": "null", "TagSet": [ { - "Value": "Value1", - "Key": "Key1" + "Value": "Value4", + "Key": "Key4" + }, + { + "Value": "Value3", + "Key": "Key3" } ] } @@ -26234,47 +26272,6 @@ }, "traits": { "smithy.api#documentation": "

This operation lists in-progress multipart uploads in a bucket. An in-progress multipart upload is a\n multipart upload that has been initiated by the CreateMultipartUpload request, but\n has not yet been completed or aborted.

\n \n

\n Directory buckets - \n If multipart uploads in a directory bucket are in progress, you can't delete the bucket until all the in-progress multipart uploads are aborted or completed.\n

\n \n

The ListMultipartUploads operation returns a maximum of 1,000 multipart uploads in the response. The limit of 1,000 multipart\n uploads is also the default\n value. You can further limit the number of uploads in a response by specifying the\n max-uploads request parameter. If there are more than 1,000 multipart uploads that \n satisfy your ListMultipartUploads request, the response returns an IsTruncated element\n with the value of true, a NextKeyMarker element, and a NextUploadIdMarker element. \n To list the remaining multipart uploads, you need to make subsequent ListMultipartUploads requests. \n In these requests, include two query parameters: key-marker and upload-id-marker. \n Set the value of key-marker to the NextKeyMarker value from the previous response. \n Similarly, set the value of upload-id-marker to the NextUploadIdMarker value from the previous response.

\n \n

\n Directory buckets - The upload-id-marker element and \n the NextUploadIdMarker element aren't supported by directory buckets. \n To list the additional multipart uploads, you only need to set the value of key-marker to the NextKeyMarker value from the previous response.

\n \n

For more information about multipart uploads, see Uploading Objects Using Multipart\n Upload in the Amazon S3\n User Guide.

\n \n

\n Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name\n . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.

\n \n
\n
Permissions
\n
\n \n
\n
Sorting of multipart uploads in response
\n
\n \n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com.

\n
\n
\n

The following operations are related to ListMultipartUploads:

\n ", - "smithy.api#examples": [ - { - "title": "To list in-progress multipart uploads on a bucket", - "documentation": "The following example lists in-progress multipart uploads on a specific bucket.", - "input": { - "Bucket": "examplebucket" - }, - "output": { - "Uploads": [ - { - "Initiator": { - "DisplayName": "display-name", - "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" - }, - "Initiated": "2014-05-01T05:40:58.000Z", - "UploadId": "examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--", - "StorageClass": "STANDARD", - "Key": "JavaFile", - "Owner": { - "DisplayName": "display-name", - "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" - } - }, - { - "Initiator": { - "DisplayName": "display-name", - "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" - }, - "Initiated": "2014-05-01T05:41:27.000Z", - "UploadId": "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--", - "StorageClass": "STANDARD", - "Key": "JavaFile", - "Owner": { - "DisplayName": "display-name", - "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" - } - } - ] - } - } - ], "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?uploads", @@ -30381,16 +30378,15 @@ "smithy.api#documentation": "

Adds an object to a bucket.

\n \n \n \n

Amazon S3 is a distributed system. If it receives multiple write requests for the same object\n simultaneously, it overwrites all but the last object written. However, Amazon S3 provides features that can modify this behavior:

\n \n
\n
Permissions
\n
\n \n
\n
Data integrity with Content-MD5
\n
\n \n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com.

\n
\n
\n

For more information about related Amazon S3 APIs, see the following:

\n ", "smithy.api#examples": [ { - "title": "To upload an object and specify optional tags", - "documentation": "The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.", + "title": "To create an object.", + "documentation": "The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.", "input": { - "Body": "c:\\HappyFace.jpg", + "Body": "filetoupload", "Bucket": "examplebucket", - "Key": "HappyFace.jpg", - "Tagging": "key1=value1&key2=value2" + "Key": "objectkey" }, "output": { - "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a", + "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ", "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"" } }