API to export operation result as an archive
" }, "GenerateAssistantResponse":{ "name":"GenerateAssistantResponse", @@ -43,7 +44,8 @@ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} - ] + ], + "documentation":"API to generate assistant response.
" }, "GenerateTaskAssistPlan":{ "name":"GenerateTaskAssistPlan", @@ -55,8 +57,28 @@ "output":{"shape":"GenerateTaskAssistPlanResponse"}, "errors":[ {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"API to generate task assist plan.
" + }, + "SendMessage":{ + "name":"SendMessage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendMessageRequest"}, + "output":{"shape":"SendMessageResponse"}, + "errors":[ + {"shape":"DryRunOperationException"}, + {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, @@ -69,10 +91,157 @@ "type":"structure", "required":["message"], "members":{ - "message":{"shape":"String"} + "message":{"shape":"String"}, + "reason":{"shape":"AccessDeniedExceptionReason"} }, + "documentation":"This exception is thrown when the user does not have sufficient access to perform this action.
", "exception":true }, + "AccessDeniedExceptionReason":{ + "type":"string", + "documentation":"Reason for AccessDeniedException
", + "enum":["UNAUTHORIZED_CUSTOMIZATION_RESOURCE_ACCESS"] + }, + "Action":{ + "type":"structure", + "members":{ + "webLink":{"shape":"WebLink"}, + "moduleLink":{"shape":"ModuleLink"} + } + }, + "AdditionalContentEntry":{ + "type":"structure", + "required":[ + "name", + "description" + ], + "members":{ + "name":{ + "shape":"AdditionalContentEntryNameString", + "documentation":"The name/identifier for this context entry
" + }, + "description":{ + "shape":"AdditionalContentEntryDescriptionString", + "documentation":"A description of what this context entry represents
" + }, + "innerContext":{ + "shape":"AdditionalContentEntryInnerContextString", + "documentation":"The actual contextual content
" + } + }, + "documentation":"Structure representing a single entry of additional contextual content
" + }, + "AdditionalContentEntryDescriptionString":{ + "type":"string", + "max":1024, + "min":1, + "sensitive":true + }, + "AdditionalContentEntryInnerContextString":{ + "type":"string", + "max":8192, + "min":1, + "sensitive":true + }, + "AdditionalContentEntryNameString":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"[a-z]+(?:-[a-z0-9]+)*", + "sensitive":true + }, + "AdditionalContentList":{ + "type":"list", + "member":{"shape":"AdditionalContentEntry"}, + "documentation":"A list of additional content entries, limited to 20 items
", + "max":20, + "min":0 + }, + "Alert":{ + "type":"structure", + "required":[ + "type", + "content" + ], + "members":{ + "type":{"shape":"AlertType"}, + "content":{ + "shape":"AlertComponentList", + "documentation":"Contains the content of the alert, which may include sensitive information.
" + } + }, + "documentation":"Structure representing an alert with a type and content.
" + }, + "AlertComponent":{ + "type":"structure", + "members":{ + "text":{"shape":"Text"} + } + }, + "AlertComponentList":{ + "type":"list", + "member":{"shape":"AlertComponent"} + }, + "AlertType":{ + "type":"string", + "documentation":"Enum defining types of alerts that can be issued.
", + "enum":[ + "INFO", + "ERROR", + "WARNING" + ] + }, + "AppStudioState":{ + "type":"structure", + "required":[ + "namespace", + "propertyName", + "propertyContext" + ], + "members":{ + "namespace":{ + "shape":"AppStudioStateNamespaceString", + "documentation":"The namespace of the context. Examples: 'ui.Button', 'ui.Table.DataSource', 'ui.Table.RowActions.Button', 'logic.invokeAWS', 'logic.JavaScript'
" + }, + "propertyName":{ + "shape":"AppStudioStatePropertyNameString", + "documentation":"The name of the property. Examples: 'visibility', 'disability', 'value', 'code'
" + }, + "propertyValue":{ + "shape":"AppStudioStatePropertyValueString", + "documentation":"The value of the property.
" + }, + "propertyContext":{ + "shape":"AppStudioStatePropertyContextString", + "documentation":"Context about how the property is used
" + } + }, + "documentation":"Description of a user's context when they are calling Q Chat from AppStudio
" + }, + "AppStudioStateNamespaceString":{ + "type":"string", + "max":1024, + "min":1, + "sensitive":true + }, + "AppStudioStatePropertyContextString":{ + "type":"string", + "max":1024, + "min":1, + "sensitive":true + }, + "AppStudioStatePropertyNameString":{ + "type":"string", + "max":1024, + "min":1, + "sensitive":true + }, + "AppStudioStatePropertyValueString":{ + "type":"string", + "max":10240, + "min":0, + "sensitive":true + }, "ArtifactId":{ "type":"string", "max":126, @@ -83,8 +252,12 @@ "type":"structure", "required":["content"], "members":{ - "content":{"shape":"AssistantResponseEventContentString"} + "content":{ + "shape":"AssistantResponseEventContentString", + "documentation":"The content of the text message in markdown format.
" + } }, + "documentation":"Streaming Response Event for Assistant Markdown text message.
", "event":true }, "AssistantResponseEventContentString":{ @@ -97,32 +270,57 @@ "type":"structure", "required":["content"], "members":{ - "messageId":{"shape":"AssistantResponseMessageMessageIdString"}, - "content":{"shape":"AssistantResponseMessageContentString"}, - "supplementaryWebLinks":{"shape":"SupplementaryWebLinks"}, - "references":{"shape":"References"}, - "followupPrompt":{"shape":"FollowupPrompt"} - } + "messageId":{"shape":"MessageId"}, + "content":{ + "shape":"AssistantResponseMessageContentString", + "documentation":"The content of the text message in markdown format.
" + }, + "supplementaryWebLinks":{ + "shape":"SupplementaryWebLinks", + "documentation":"Web References
" + }, + "references":{ + "shape":"References", + "documentation":"Code References
" + }, + "followupPrompt":{ + "shape":"FollowupPrompt", + "documentation":"Followup Prompt
" + }, + "toolUses":{ + "shape":"ToolUses", + "documentation":"ToolUse Request
" + } + }, + "documentation":"Markdown text message.
" }, "AssistantResponseMessageContentString":{ "type":"string", - "max":4096, + "max":100000, "min":0, "sensitive":true }, - "AssistantResponseMessageMessageIdString":{ - "type":"string", - "max":128, - "min":0 - }, "BinaryMetadataEvent":{ "type":"structure", "members":{ - "size":{"shape":"Long"}, - "mimeType":{"shape":"String"}, - "contentChecksum":{"shape":"ContentChecksum"}, - "contentChecksumType":{"shape":"ContentChecksumType"} + "size":{ + "shape":"Long", + "documentation":"Content length of the binary payload
" + }, + "mimeType":{ + "shape":"String", + "documentation":"Content type of the response
" + }, + "contentChecksum":{ + "shape":"ContentChecksum", + "documentation":"Content checksum of the binary payload
" + }, + "contentChecksumType":{ + "shape":"ContentChecksumType", + "documentation":"Content checksum type of the binary payload
" + } }, + "documentation":"Payload Part
", "event":true, "sensitive":true }, @@ -131,6 +329,7 @@ "members":{ "bytes":{"shape":"PartBody"} }, + "documentation":"Payload Part
", "event":true, "sensitive":true }, @@ -141,7 +340,8 @@ "ChatHistory":{ "type":"list", "member":{"shape":"ChatMessage"}, - "max":10, + "documentation":"Indicates Participant in Chat conversation
", + "max":250, "min":0 }, "ChatMessage":{ @@ -155,39 +355,230 @@ "ChatResponseStream":{ "type":"structure", "members":{ - "messageMetadataEvent":{"shape":"MessageMetadataEvent"}, - "assistantResponseEvent":{"shape":"AssistantResponseEvent"}, - "codeReferenceEvent":{"shape":"CodeReferenceEvent"}, - "supplementaryWebLinksEvent":{"shape":"SupplementaryWebLinksEvent"}, - "followupPromptEvent":{"shape":"FollowupPromptEvent"}, - "invalidStateEvent": {"shape": "InvalidStateEvent"}, - "error":{"shape":"InternalServerException"} + "messageMetadataEvent":{ + "shape":"MessageMetadataEvent", + "documentation":"Message Metadata event
" + }, + "assistantResponseEvent":{ + "shape":"AssistantResponseEvent", + "documentation":"Assistant response event - Text / Code snippet
" + }, + "dryRunSucceedEvent":{ + "shape":"DryRunSucceedEvent", + "documentation":"DryRun Succeed Event
" + }, + "codeReferenceEvent":{ + "shape":"CodeReferenceEvent", + "documentation":"Code References event
" + }, + "supplementaryWebLinksEvent":{ + "shape":"SupplementaryWebLinksEvent", + "documentation":"Web Reference links event
" + }, + "followupPromptEvent":{ + "shape":"FollowupPromptEvent", + "documentation":"Followup prompt event
" + }, + "codeEvent":{ + "shape":"CodeEvent", + "documentation":"Code Generated event
" + }, + "intentsEvent":{ + "shape":"IntentsEvent", + "documentation":"Intents event
" + }, + "interactionComponentsEvent":{ + "shape":"InteractionComponentsEvent", + "documentation":"Interactions components event
" + }, + "toolUseEvent":{ + "shape":"ToolUseEvent", + "documentation":"ToolUse event
" + }, + "toolResultEvent":{ + "shape":"ToolResultEvent", + "documentation":"Tool use result
" + }, + "citationEvent":{ + "shape":"CitationEvent", + "documentation":"Citation event
" + }, + "invalidStateEvent":{ + "shape":"InvalidStateEvent", + "documentation":"Invalid State event
" + }, + "error":{ + "shape":"InternalServerException", + "documentation":"Internal Server Exception
" + } }, + "documentation":"Streaming events from UniDirectional Streaming Conversational APIs.
", "eventstream":true }, "ChatTriggerType":{ "type":"string", + "documentation":"Trigger Reason for Chat
", "enum":[ "MANUAL", "DIAGNOSTIC", "INLINE_CHAT" ] }, + "CitationEvent":{ + "type":"structure", + "required":[ + "target", + "citationLink" + ], + "members":{ + "target":{ + "shape":"CitationTarget", + "documentation":"The position or the range of the response text to be cited
" + }, + "citationText":{ + "shape":"SensitiveString", + "documentation":"The text inside the citation '1' in [1]
" + }, + "citationLink":{ + "shape":"SensitiveString", + "documentation":"The link to the document being cited
" + } + }, + "documentation":"Streaming response event for citations
", + "event":true + }, + "CitationTarget":{ + "type":"structure", + "members":{ + "location":{ + "shape":"Offset", + "documentation":"Represents a position in the response text where a citation should be added
" + }, + "range":{ + "shape":"Span", + "documentation":"Represents the range in the response text to be targetted by a citation
" + } + }, + "documentation":"Represents the target of a citation event
", + "union":true + }, + "CloudWatchTroubleshootingLink":{ + "type":"structure", + "required":[ + "label", + "investigationPayload" + ], + "members":{ + "label":{ + "shape":"CloudWatchTroubleshootingLinkLabelString", + "documentation":"A label for the link.
" + }, + "investigationPayload":{ + "shape":"CloudWatchTroubleshootingLinkInvestigationPayloadString", + "documentation":"Stringified JSON payload. See spec here https://code.amazon.com/packages/CloudWatchOdysseyModel/blobs/50c0832f0e393e4ab68827eb4f04d832366821c1/--/model/events.smithy#L28 .
" + }, + "defaultText":{ + "shape":"CloudWatchTroubleshootingLinkDefaultTextString", + "documentation":"Fallback string, if target channel does not support the CloudWatchTroubleshootingLink.
" + } + }, + "documentation":"For CloudWatch Troubleshooting Link Module
" + }, + "CloudWatchTroubleshootingLinkDefaultTextString":{ + "type":"string", + "max":1024, + "min":0, + "sensitive":true + }, + "CloudWatchTroubleshootingLinkInvestigationPayloadString":{ + "type":"string", + "max":16384, + "min":0, + "sensitive":true + }, + "CloudWatchTroubleshootingLinkLabelString":{ + "type":"string", + "max":1024, + "min":0, + "sensitive":true + }, + "CodeDescription":{ + "type":"structure", + "required":["href"], + "members":{ + "href":{ + "shape":"CodeDescriptionHrefString", + "documentation":"An URI to open with more information about the diagnostic error.
" + } + }, + "documentation":"Structure to capture a description for an error code.
" + }, + "CodeDescriptionHrefString":{ + "type":"string", + "max":1024, + "min":1, + "sensitive":true + }, + "CodeEvent":{ + "type":"structure", + "required":["content"], + "members":{ + "content":{ + "shape":"CodeEventContentString", + "documentation":"Generated code snippet.
" + } + }, + "documentation":"Streaming response event for generated code text.
", + "event":true + }, + "CodeEventContentString":{ + "type":"string", + "max":10240, + "min":0, + "sensitive":true + }, "CodeReferenceEvent":{ "type":"structure", "members":{ - "references":{"shape":"References"} + "references":{ + "shape":"References", + "documentation":"Code References for Assistant Response Message
" + } }, + "documentation":"Streaming Response Event for CodeReferences
", "event":true }, "ConflictException":{ "type":"structure", "required":["message"], "members":{ - "message":{"shape":"String"} + "message":{"shape":"String"}, + "reason":{"shape":"ConflictExceptionReason"} }, + "documentation":"This exception is thrown when the action to perform could not be completed because the resource is in a conflicting state.
", "exception":true }, + "ConflictExceptionReason":{ + "type":"string", + "documentation":"Reason for ConflictException
", + "enum":[ + "CUSTOMER_KMS_KEY_INVALID_KEY_POLICY", + "CUSTOMER_KMS_KEY_DISABLED", + "MISMATCHED_KMS_KEY" + ] + }, + "ConsoleState":{ + "type":"structure", + "members":{ + "region":{"shape":"String"}, + "consoleUrl":{"shape":"SensitiveString"}, + "serviceId":{"shape":"String"}, + "serviceConsolePage":{"shape":"String"}, + "serviceSubconsolePage":{"shape":"String"}, + "taskName":{"shape":"SensitiveString"} + }, + "documentation":"Information about the state of the AWS management console page from which the user is calling
" + }, "ContentChecksum":{ "type":"string", "max":512, @@ -199,6 +590,7 @@ }, "ContextTruncationScheme":{ "type":"string", + "documentation":"Workspace context truncation schemes based on usecase
", "enum":[ "ANALYSIS", "GUMBY" @@ -206,6 +598,7 @@ }, "ConversationId":{ "type":"string", + "documentation":"ID which represents a multi-turn conversation
", "max":128, "min":1 }, @@ -216,31 +609,108 @@ "chatTriggerType" ], "members":{ - "conversationId":{"shape":"ConversationId"}, - "history":{"shape":"ChatHistory"}, - "currentMessage":{"shape":"ChatMessage"}, - "chatTriggerType":{"shape":"ChatTriggerType"}, - "customizationArn":{"shape": "ResourceArn"} - } + "conversationId":{ + "shape":"ConversationId", + "documentation":"Unique identifier for the chat conversation stream
" + }, + "history":{ + "shape":"ChatHistory", + "documentation":"Holds the history of chat messages.
" + }, + "currentMessage":{ + "shape":"ChatMessage", + "documentation":"Holds the current message being processed or displayed.
" + }, + "chatTriggerType":{ + "shape":"ChatTriggerType", + "documentation":"Trigger Reason for Chat
" + }, + "customizationArn":{"shape":"ResourceArn"} + }, + "documentation":"Structure to represent the current state of a chat conversation.
" }, "CursorState":{ "type":"structure", "members":{ - "position":{"shape":"Position"}, - "range":{"shape":"Range"} + "position":{ + "shape":"Position", + "documentation":"Represents a cursor position in a Text Document
" + }, + "range":{ + "shape":"Range", + "documentation":"Represents a text selection in a Text Document
" + } }, + "documentation":"Represents the state of the Cursor in an Editor
", "union":true }, "Diagnostic":{ "type":"structure", "members":{ - "textDocumentDiagnostic":{"shape":"TextDocumentDiagnostic"}, - "runtimeDiagnostic":{"shape":"RuntimeDiagnostic"} + "textDocumentDiagnostic":{ + "shape":"TextDocumentDiagnostic", + "documentation":"Diagnostics originating from a TextDocument
" + }, + "runtimeDiagnostic":{ + "shape":"RuntimeDiagnostic", + "documentation":"Diagnostics originating from a Runtime
" + } }, + "documentation":"Represents a Diagnostic message
", "union":true }, + "DiagnosticLocation":{ + "type":"structure", + "required":[ + "uri", + "range" + ], + "members":{ + "uri":{"shape":"DiagnosticLocationUriString"}, + "range":{"shape":"Range"} + }, + "documentation":"Represents a location inside a resource, such as a line inside a text file.
" + }, + "DiagnosticLocationUriString":{ + "type":"string", + "max":1024, + "min":1, + "sensitive":true + }, + "DiagnosticRelatedInformation":{ + "type":"structure", + "required":[ + "location", + "message" + ], + "members":{ + "location":{ + "shape":"DiagnosticLocation", + "documentation":"The location of this related diagnostic information.
" + }, + "message":{ + "shape":"DiagnosticRelatedInformationMessageString", + "documentation":"The message of this related diagnostic information.
" + } + }, + "documentation":"Represents a related message and source code location for a diagnostic.
" + }, + "DiagnosticRelatedInformationList":{ + "type":"list", + "member":{"shape":"DiagnosticRelatedInformation"}, + "documentation":"List of DiagnosticRelatedInformation
", + "max":1024, + "min":0 + }, + "DiagnosticRelatedInformationMessageString":{ + "type":"string", + "max":1024, + "min":0, + "sensitive":true + }, "DiagnosticSeverity":{ "type":"string", + "documentation":"Diagnostic Error types
", "enum":[ "ERROR", "WARNING", @@ -248,6 +718,21 @@ "HINT" ] }, + "DiagnosticTag":{ + "type":"string", + "documentation":"The diagnostic tags.
", + "enum":[ + "UNNECESSARY", + "DEPRECATED" + ] + }, + "DiagnosticTagList":{ + "type":"list", + "member":{"shape":"DiagnosticTag"}, + "documentation":"List of DiagnosticTag
", + "max":1024, + "min":0 + }, "DocumentSymbol":{ "type":"structure", "required":[ @@ -255,9 +740,18 @@ "type" ], "members":{ - "name":{"shape":"DocumentSymbolNameString"}, - "type":{"shape":"SymbolType"}, - "source":{"shape":"DocumentSymbolSourceString"} + "name":{ + "shape":"DocumentSymbolNameString", + "documentation":"Name of the Document Symbol
" + }, + "type":{ + "shape":"SymbolType", + "documentation":"Symbol type - DECLARATION / USAGE
" + }, + "source":{ + "shape":"DocumentSymbolSourceString", + "documentation":"Symbol package / source for FullyQualified names
" + } } }, "DocumentSymbolNameString":{ @@ -276,14 +770,120 @@ "max":1000, "min":0 }, + "DryRunOperationException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"}, + "responseCode":{"shape":"Integer"} + }, + "documentation":"This exception is translated to a 204 as it succeeded the IAM Auth.
", + "exception":true + }, + "DryRunSucceedEvent":{ + "type":"structure", + "members":{ + }, + "documentation":"Streaming Response Event when DryRun is succeessful
", + "event":true + }, "EditorState":{ "type":"structure", "members":{ - "document":{"shape":"TextDocument"}, - "cursorState":{"shape":"CursorState"}, - "relevantDocuments": {"shape": "RelevantDocumentList"}, - "useRelevantDocuments": {"shape": "Boolean"} - } + "document":{ + "shape":"TextDocument", + "documentation":"Represents currently edited file
" + }, + "cursorState":{ + "shape":"CursorState", + "documentation":"Position of the cursor
" + }, + "relevantDocuments":{ + "shape":"RelevantDocumentList", + "documentation":"Represents IDE provided relevant files
" + }, + "useRelevantDocuments":{ + "shape":"Boolean", + "documentation":"Whether service should use relevant document in prompt
" + }, + "workspaceFolders":{ + "shape":"WorkspaceFolderList", + "documentation":"Represents IDE provided list of workspace folders
" + } + }, + "documentation":"Represents the state of an Editor
" + }, + "EnvState":{ + "type":"structure", + "members":{ + "operatingSystem":{ + "shape":"EnvStateOperatingSystemString", + "documentation":"The name of the operating system in use
" + }, + "currentWorkingDirectory":{ + "shape":"EnvStateCurrentWorkingDirectoryString", + "documentation":"The current working directory of the environment
" + }, + "environmentVariables":{ + "shape":"EnvironmentVariables", + "documentation":"The environment variables set in the current environment
" + }, + "timezoneOffset":{ + "shape":"EnvStateTimezoneOffsetInteger", + "documentation":"Local timezone offset of the client. For more information, see documentation https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/getTimezoneOffset
" + } + }, + "documentation":"State related to the user's environment
" + }, + "EnvStateCurrentWorkingDirectoryString":{ + "type":"string", + "max":256, + "min":1, + "sensitive":true + }, + "EnvStateOperatingSystemString":{ + "type":"string", + "max":32, + "min":1, + "pattern":"(macos|linux|windows)" + }, + "EnvStateTimezoneOffsetInteger":{ + "type":"integer", + "box":true, + "max":1440, + "min":-1440 + }, + "EnvironmentVariable":{ + "type":"structure", + "members":{ + "key":{ + "shape":"EnvironmentVariableKeyString", + "documentation":"The key of an environment variable
" + }, + "value":{ + "shape":"EnvironmentVariableValueString", + "documentation":"The value of an environment variable
" + } + }, + "documentation":"An environment variable
" + }, + "EnvironmentVariableKeyString":{ + "type":"string", + "max":256, + "min":1, + "sensitive":true + }, + "EnvironmentVariableValueString":{ + "type":"string", + "max":1024, + "min":1, + "sensitive":true + }, + "EnvironmentVariables":{ + "type":"list", + "member":{"shape":"EnvironmentVariable"}, + "documentation":"A list of environment variables
", + "max":100, + "min":0 }, "ExportContext":{ "type":"structure", @@ -291,10 +891,12 @@ "transformationExportContext":{"shape":"TransformationExportContext"}, "unitTestGenerationExportContext":{"shape":"UnitTestGenerationExportContext"} }, + "documentation":"Export Context
", "union":true }, "ExportIntent":{ "type":"string", + "documentation":"Export Intent
", "enum":[ "TRANSFORMATION", "TASK_ASSIST", @@ -308,25 +910,40 @@ "exportIntent" ], "members":{ - "exportId":{"shape":"String"}, + "exportId":{"shape":"ExportResultArchiveRequestExportIdString"}, "exportIntent":{"shape":"ExportIntent"}, - "exportContext":{"shape":"ExportContext"} - } + "exportContext":{"shape":"ExportContext"}, + "profileArn":{"shape":"ProfileArn"} + }, + "documentation":"Structure to represent a new ExportResultArchive request.
" + }, + "ExportResultArchiveRequestExportIdString":{ + "type":"string", + "max":1024, + "min":0 }, "ExportResultArchiveResponse":{ "type":"structure", "required":["body"], "members":{ "body":{"shape":"ResultArchiveStream"} - } + }, + "documentation":"Structure to represent ExportResultArchive response.
" }, "FollowupPrompt":{ "type":"structure", "required":["content"], "members":{ - "content":{"shape":"FollowupPromptContentString"}, - "userIntent":{"shape":"UserIntent"} - } + "content":{ + "shape":"FollowupPromptContentString", + "documentation":"The content of the text message in markdown format.
" + }, + "userIntent":{ + "shape":"UserIntent", + "documentation":"User Intent
" + } + }, + "documentation":"Followup Prompt for the Assistant Response
" }, "FollowupPromptContentString":{ "type":"string", @@ -339,14 +956,17 @@ "members":{ "followupPrompt":{"shape":"FollowupPrompt"} }, + "documentation":"Streaming Response Event for Followup Prompt.
", "event":true }, "GenerateAssistantResponseRequest":{ "type":"structure", "required":["conversationState"], "members":{ - "conversationState":{"shape":"ConversationState"} - } + "conversationState":{"shape":"ConversationState"}, + "profileArn":{"shape":"ProfileArn"} + }, + "documentation":"Structure to represent a new generate assistant response request.
" }, "GenerateAssistantResponseResponse":{ "type":"structure", @@ -357,7 +977,8 @@ "members":{ "conversationId":{"shape":"ConversationId"}, "generateAssistantResponseResponse":{"shape":"ChatResponseStream"} - } + }, + "documentation":"Structure to represent generate assistant response response.
" }, "GenerateTaskAssistPlanRequest":{ "type":"structure", @@ -367,50 +988,270 @@ ], "members":{ "conversationState":{"shape":"ConversationState"}, - "workspaceState":{"shape":"WorkspaceState"} - } + "workspaceState":{"shape":"WorkspaceState"}, + "profileArn":{"shape":"ProfileArn"} + }, + "documentation":"Structure to represent execute planning interaction request.
" }, "GenerateTaskAssistPlanResponse":{ "type":"structure", "members":{ "planningResponseStream":{"shape":"ChatResponseStream"} - } + }, + "documentation":"Structure to represent execute planning interaction response.
" + }, + "GitState":{ + "type":"structure", + "members":{ + "status":{ + "shape":"GitStateStatusString", + "documentation":"The output of the command git status --porcelain=v1 -b
State related to the Git VSC
" + }, + "GitStateStatusString":{ + "type":"string", + "max":4096, + "min":0, + "sensitive":true + }, + "ImageBlock":{ + "type":"structure", + "required":[ + "format", + "source" + ], + "members":{ + "format":{"shape":"ImageFormat"}, + "source":{"shape":"ImageSource"} + }, + "documentation":"Represents the image source itself and the format of the image.
" + }, + "ImageBlocks":{ + "type":"list", + "member":{"shape":"ImageBlock"}, + "max":10, + "min":0 + }, + "ImageFormat":{ + "type":"string", + "enum":[ + "png", + "jpeg", + "gif", + "webp" + ] + }, + "ImageSource":{ + "type":"structure", + "members":{ + "bytes":{"shape":"ImageSourceBytesBlob"} + }, + "documentation":"Image bytes limited to ~10MB considering overhead of base64 encoding
", + "sensitive":true, + "union":true + }, + "ImageSourceBytesBlob":{ + "type":"blob", + "max":1500000, + "min":1 + }, + "InfrastructureUpdate":{ + "type":"structure", + "members":{ + "transition":{"shape":"InfrastructureUpdateTransition"} + }, + "documentation":"Structure representing different types of infrastructure updates.
" + }, + "InfrastructureUpdateTransition":{ + "type":"structure", + "required":[ + "currentState", + "nextState" + ], + "members":{ + "currentState":{ + "shape":"InfrastructureUpdateTransitionCurrentStateString", + "documentation":"The current state of the infrastructure before the update.
" + }, + "nextState":{ + "shape":"InfrastructureUpdateTransitionNextStateString", + "documentation":"The next state of the infrastructure following the update.
" + } + }, + "documentation":"Structure describing a transition between two states in an infrastructure update.
" + }, + "InfrastructureUpdateTransitionCurrentStateString":{ + "type":"string", + "max":10240, + "min":0, + "sensitive":true + }, + "InfrastructureUpdateTransitionNextStateString":{ + "type":"string", + "max":10240, + "min":0, + "sensitive":true }, "Integer":{ "type":"integer", "box":true }, + "IntentData":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"IntentDataType"}, + "max":100, + "min":0, + "sensitive":true + }, + "IntentDataType":{ + "type":"structure", + "members":{ + "string":{"shape":"String"} + }, + "union":true + }, + "IntentMap":{ + "type":"map", + "key":{"shape":"IntentType"}, + "value":{"shape":"IntentData"}, + "max":5, + "min":0 + }, + "IntentType":{ + "type":"string", + "enum":[ + "SUPPORT", + "GLUE_SENSEI", + "RESOURCE_DATA" + ] + }, + "IntentsEvent":{ + "type":"structure", + "members":{ + "intents":{ + "shape":"IntentMap", + "documentation":"A map of Intent objects
" + } + }, + "documentation":"Streaming Response Event for Intents
", + "event":true + }, + "InteractionComponent":{ + "type":"structure", + "members":{ + "text":{"shape":"Text"}, + "alert":{"shape":"Alert"}, + "infrastructureUpdate":{"shape":"InfrastructureUpdate"}, + "progress":{"shape":"Progress"}, + "step":{"shape":"Step"}, + "taskDetails":{"shape":"TaskDetails"}, + "taskReference":{"shape":"TaskReference"}, + "suggestions":{"shape":"Suggestions"}, + "section":{"shape":"Section"}, + "resource":{"shape":"Resource"}, + "resourceList":{"shape":"ResourceList"}, + "action":{"shape":"Action"} + }, + "documentation":"Structure representing different types of interaction components.
" + }, + "InteractionComponentEntry":{ + "type":"structure", + "required":["interactionComponent"], + "members":{ + "interactionComponentId":{ + "shape":"InteractionComponentId", + "documentation":"Identifier that can uniquely identify the interaction component within stream response. This field is optional.
" + }, + "interactionComponent":{ + "shape":"InteractionComponent", + "documentation":"Interaction component
" + } + }, + "documentation":"Interaction component with an identifier
" + }, + "InteractionComponentEntryList":{ + "type":"list", + "member":{"shape":"InteractionComponentEntry"}, + "documentation":"List of identifiable interaction components
" + }, + "InteractionComponentId":{ + "type":"string", + "documentation":"Unique identifier for interaction component
", + "max":128, + "min":0 + }, + "InteractionComponentsEvent":{ + "type":"structure", + "required":["interactionComponentEntries"], + "members":{ + "interactionComponentEntries":{ + "shape":"InteractionComponentEntryList", + "documentation":"List of identifiable interaction components
" + } + }, + "documentation":"Streaming Event for interaction components list
", + "event":true + }, "InternalServerException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, + "documentation":"This exception is thrown when an unexpected error occurred during the processing of a request.
", "exception":true, "fault":true, "retryable":{"throttling":false} }, "InvalidStateEvent":{ "type":"structure", + "required":[ + "reason", + "message" + ], "members":{ "reason":{"shape":"InvalidStateReason"}, - "message":{"shape": "String"} + "message":{"shape":"InvalidStateEventMessageString"} }, + "documentation":"Streaming Response Event when an Invalid State is reached
", "event":true }, + "InvalidStateEventMessageString":{ + "type":"string", + "max":10240, + "min":0 + }, "InvalidStateReason":{ "type":"string", + "documentation":"Reasons for Invalid State Event
", "enum":["INVALID_TASK_ASSIST_PLAN"] }, "Long":{ "type":"long", "box":true }, + "MessageId":{ + "type":"string", + "documentation":"Unique identifier for the chat message
", + "max":128, + "min":0 + }, "MessageMetadataEvent":{ "type":"structure", "members":{ - "conversationId":{"shape":"MessageMetadataEventConversationIdString"} + "conversationId":{ + "shape":"MessageMetadataEventConversationIdString", + "documentation":"Unique identifier for the conversation
" + }, + "utteranceId":{ + "shape":"MessageMetadataEventUtteranceIdString", + "documentation":"Unique identifier for the utterance
" + } }, + "documentation":"Streaming Response Event for AssistantResponse Metadata
", "event":true }, "MessageMetadataEventConversationIdString":{ @@ -418,8 +1259,47 @@ "max":128, "min":0 }, + "MessageMetadataEventUtteranceIdString":{ + "type":"string", + "max":128, + "min":0 + }, + "ModuleLink":{ + "type":"structure", + "members":{ + "cloudWatchTroubleshootingLink":{"shape":"CloudWatchTroubleshootingLink"} + } + }, + "Offset":{ + "type":"integer", + "documentation":"Offset in the response text
", + "box":true, + "min":0 + }, + "Origin":{ + "type":"string", + "documentation":"Enum to represent the origin application conversing with Sidekick.
", + "enum":[ + "CHATBOT", + "CONSOLE", + "DOCUMENTATION", + "MARKETING", + "MOBILE", + "SERVICE_INTERNAL", + "UNIFIED_SEARCH", + "UNKNOWN", + "MD", + "IDE", + "SAGE_MAKER", + "CLI", + "AI_EDITOR", + "OPENSEARCH_DASHBOARD", + "GITLAB" + ] + }, "PartBody":{ "type":"blob", + "documentation":"Payload Part's body
", "max":1000000, "min":0, "sensitive":true @@ -431,22 +1311,57 @@ "character" ], "members":{ - "line":{"shape":"Integer"}, - "character":{"shape":"Integer"} - } + "line":{ + "shape":"Integer", + "documentation":"Line position in a document.
" + }, + "character":{ + "shape":"Integer", + "documentation":"Character offset on a line in a document (zero-based)
" + } + }, + "documentation":"Indicates Cursor postion in a Text Document
" + }, + "ProfileArn":{ + "type":"string", + "max":950, + "min":0, + "pattern":"arn:aws:codewhisperer:[-.a-z0-9]{1,63}:\\d{12}:profile/([a-zA-Z0-9]){12}" }, "ProgrammingLanguage":{ "type":"structure", "required":["languageName"], "members":{ "languageName":{"shape":"ProgrammingLanguageLanguageNameString"} - } + }, + "documentation":"Programming Languages supported by CodeWhisperer
" }, "ProgrammingLanguageLanguageNameString":{ "type":"string", "max":128, "min":1, - "pattern":"(python|javascript|java|csharp|typescript|c|cpp|go|kotlin|php|ruby|rust|scala|shell|sql|json|yaml|vue|tf)" + "pattern":"(python|javascript|java|csharp|typescript|c|cpp|go|kotlin|php|ruby|rust|scala|shell|sql|json|yaml|vue|tf|tsx|jsx|plaintext|systemverilog|dart|lua|swift|powershell|r)" + }, + "Progress":{ + "type":"structure", + "required":["content"], + "members":{ + "content":{ + "shape":"ProgressComponentList", + "documentation":"A collection of steps that make up a process. Each step is detailed using the Step structure.
" + } + }, + "documentation":"Structure representing a collection of steps in a process.
" + }, + "ProgressComponent":{ + "type":"structure", + "members":{ + "step":{"shape":"Step"} + } + }, + "ProgressComponentList":{ + "type":"list", + "member":{"shape":"ProgressComponent"} }, "Range":{ "type":"structure", @@ -455,18 +1370,38 @@ "end" ], "members":{ - "start":{"shape":"Position"}, - "end":{"shape":"Position"} - } + "start":{ + "shape":"Position", + "documentation":"The range's start position.
" + }, + "end":{ + "shape":"Position", + "documentation":"The range's end position.
" + } + }, + "documentation":"Indicates Range / Span in a Text Document
" }, "Reference":{ "type":"structure", "members":{ - "licenseName":{"shape":"ReferenceLicenseNameString"}, - "repository":{"shape":"ReferenceRepositoryString"}, - "url":{"shape":"ReferenceUrlString"}, - "recommendationContentSpan":{"shape":"Span"} - } + "licenseName":{ + "shape":"ReferenceLicenseNameString", + "documentation":"License name
" + }, + "repository":{ + "shape":"ReferenceRepositoryString", + "documentation":"Code Repsitory for the associated reference
" + }, + "url":{ + "shape":"ReferenceUrlString", + "documentation":"Respository URL
" + }, + "recommendationContentSpan":{ + "shape":"Span", + "documentation":"Span / Range for the Reference
" + } + }, + "documentation":"Code Reference / Repository details
" }, "ReferenceLicenseNameString":{ "type":"string", @@ -489,23 +1424,90 @@ "max":10, "min":0 }, - "RelevantTextDocument": { - "type": "structure", - "required": [ - "relativeFilePath" + "RelevantDocumentList":{ + "type":"list", + "member":{"shape":"RelevantTextDocument"}, + "max":30, + "min":0 + }, + "RelevantTextDocument":{ + "type":"structure", + "required":["relativeFilePath"], + "members":{ + "relativeFilePath":{ + "shape":"RelevantTextDocumentRelativeFilePathString", + "documentation":"Filepath relative to the root of the workspace
" + }, + "programmingLanguage":{ + "shape":"ProgrammingLanguage", + "documentation":"The text document's language identifier.
" + }, + "text":{ + "shape":"RelevantTextDocumentTextString", + "documentation":"Content of the text document
" + }, + "documentSymbols":{ + "shape":"DocumentSymbols", + "documentation":"DocumentSymbols parsed from a text document
" + } + }, + "documentation":"Represents an IDE retrieved relevant Text Document / File
" + }, + "RelevantTextDocumentRelativeFilePathString":{ + "type":"string", + "max":4096, + "min":1, + "sensitive":true + }, + "RelevantTextDocumentTextString":{ + "type":"string", + "max":40960, + "min":0, + "sensitive":true + }, + "Resource":{ + "type":"structure", + "required":[ + "title", + "link", + "description", + "type", + "ARN", + "resourceJsonString" ], - "members": { - "relativeFilePath": {"shape": "SensitiveString"}, - "programmingLanguage": {"shape": "ProgrammingLanguage"}, - "text": {"shape": "SensitiveString"}, - "documentSymbols": {"shape": "DocumentSymbols"} - } + "members":{ + "title":{ + "shape":"ResourceTitleString", + "documentation":"Card title.
" + }, + "link":{ + "shape":"ResourceLinkString", + "documentation":"Link for the resource item
" + }, + "description":{ + "shape":"ResourceDescriptionString", + "documentation":"Short text about that resource for example Region: us-east-1
" + }, + "type":{ + "shape":"ResourceTypeString", + "documentation":"Resource type e.g AWS EC2
" + }, + "ARN":{ + "shape":"ResourceARNString", + "documentation":"Amazon resource number e.g arn:aws:aec:.....
" + }, + "resourceJsonString":{ + "shape":"ResourceResourceJsonStringString", + "documentation":"A stringified object
" + } + }, + "documentation":"Structure representing a resource item
" }, - "RelevantDocumentList": { - "type": "list", - "member": {"shape": "RelevantTextDocument"}, - "max": 5, - "min": 0 + "ResourceARNString":{ + "type":"string", + "max":1024, + "min":0, + "sensitive":true }, "ResourceArn":{ "type":"string", @@ -513,14 +1515,67 @@ "min":0, "pattern":"arn:([-.a-z0-9]{1,63}:){2}([-.a-z0-9]{0,63}:){2}([a-zA-Z0-9-_:/]){1,1023}" }, + "ResourceDescriptionString":{ + "type":"string", + "max":1024, + "min":0, + "sensitive":true + }, + "ResourceLinkString":{ + "type":"string", + "max":1024, + "min":0, + "sensitive":true + }, + "ResourceList":{ + "type":"structure", + "required":["items"], + "members":{ + "action":{ + "shape":"Action", + "documentation":"Action associated with the list
" + }, + "items":{ + "shape":"ResourceListItemsList", + "documentation":"List of resources
" + } + }, + "documentation":"Structure representing a list of Items
" + }, + "ResourceListItemsList":{ + "type":"list", + "member":{"shape":"Resource"}, + "documentation":"List for resources
", + "max":10, + "min":0 + }, "ResourceNotFoundException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, + "documentation":"This exception is thrown when describing a resource that does not exist.
", "exception":true }, + "ResourceResourceJsonStringString":{ + "type":"string", + "max":8192, + "min":0, + "sensitive":true + }, + "ResourceTitleString":{ + "type":"string", + "max":1024, + "min":0, + "sensitive":true + }, + "ResourceTypeString":{ + "type":"string", + "max":1024, + "min":0, + "sensitive":true + }, "ResultArchiveStream":{ "type":"structure", "members":{ @@ -528,6 +1583,7 @@ "binaryPayloadEvent":{"shape":"BinaryPayloadEvent"}, "internalServerException":{"shape":"InternalServerException"} }, + "documentation":"Response Stream
", "eventstream":true }, "RuntimeDiagnostic":{ @@ -538,10 +1594,20 @@ "message" ], "members":{ - "source":{"shape":"RuntimeDiagnosticSourceString"}, - "severity":{"shape":"DiagnosticSeverity"}, - "message":{"shape":"RuntimeDiagnosticMessageString"} - } + "source":{ + "shape":"RuntimeDiagnosticSourceString", + "documentation":"A human-readable string describing the source of the diagnostic
" + }, + "severity":{ + "shape":"DiagnosticSeverity", + "documentation":"Diagnostic Error type
" + }, + "message":{ + "shape":"RuntimeDiagnosticMessageString", + "documentation":"The diagnostic's message.
" + } + }, + "documentation":"Structure to represent metadata about a Runtime Diagnostics
" }, "RuntimeDiagnosticMessageString":{ "type":"string", @@ -555,47 +1621,303 @@ "min":0, "sensitive":true }, - "SensitiveString":{ - "type":"string", - "sensitive":true + "Section":{ + "type":"structure", + "required":[ + "title", + "content" + ], + "members":{ + "title":{ + "shape":"SectionTitleString", + "documentation":"Contains text content that may include sensitive information and can support Markdown formatting.
" + }, + "content":{ + "shape":"SectionContentList", + "documentation":"Contains a list of interaction components e.g Text, Alert, List, etc.
" + }, + "action":{ + "shape":"Action", + "documentation":"Action associated with the Section
" + } + }, + "documentation":"Structure representing a collapsable section
" }, - "Span":{ + "SectionComponent":{ "type":"structure", "members":{ - "start":{"shape":"SpanStartInteger"}, - "end":{"shape":"SpanEndInteger"} + "text":{"shape":"Text"}, + "alert":{"shape":"Alert"}, + "resource":{"shape":"Resource"}, + "resourceList":{"shape":"ResourceList"} } }, - "SpanEndInteger":{ - "type":"integer", - "box":true, + "SectionContentList":{ + "type":"list", + "member":{"shape":"SectionComponent"}, + "max":5, "min":0 }, - "SpanStartInteger":{ - "type":"integer", - "box":true, - "min":0 + "SectionTitleString":{ + "type":"string", + "max":1024, + "min":0, + "sensitive":true }, - "String":{"type":"string"}, - "SupplementaryWebLink":{ + "SendMessageRequest":{ "type":"structure", - "required":[ - "url", - "title" - ], + "required":["conversationState"], "members":{ - "url":{"shape":"SupplementaryWebLinkUrlString"}, - "title":{"shape":"SupplementaryWebLinkTitleString"}, - "snippet":{"shape":"SupplementaryWebLinkSnippetString"} - } + "conversationState":{"shape":"ConversationState"}, + "profileArn":{"shape":"ProfileArn"}, + "source":{ + "shape":"Origin", + "documentation":"The origin of the caller
" + }, + "dryRun":{"shape":"Boolean"} + }, + "documentation":"Structure to represent a SendMessage request.
" }, - "SupplementaryWebLinkSnippetString":{ - "type":"string", - "max":1024, - "min":1, + "SendMessageResponse":{ + "type":"structure", + "required":["sendMessageResponse"], + "members":{ + "sendMessageResponse":{"shape":"ChatResponseStream"} + }, + "documentation":"Structure to represent a SendMessage response.
" + }, + "SensitiveDocument":{ + "type":"structure", + "members":{ + }, + "document":true, "sensitive":true }, - "SupplementaryWebLinkTitleString":{ + "SensitiveString":{ + "type":"string", + "sensitive":true + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"This exception is thrown when request was denied due to caller exceeding their usage limits
", + "exception":true + }, + "ShellHistory":{ + "type":"list", + "member":{"shape":"ShellHistoryEntry"}, + "documentation":"A list of shell history entries
", + "max":20, + "min":0 + }, + "ShellHistoryEntry":{ + "type":"structure", + "required":["command"], + "members":{ + "command":{ + "shape":"ShellHistoryEntryCommandString", + "documentation":"The shell command that was run
" + }, + "directory":{ + "shape":"ShellHistoryEntryDirectoryString", + "documentation":"The directory the command was ran in
" + }, + "exitCode":{ + "shape":"Integer", + "documentation":"The exit code of the command after it finished
" + }, + "stdout":{ + "shape":"ShellHistoryEntryStdoutString", + "documentation":"The stdout from the command
" + }, + "stderr":{ + "shape":"ShellHistoryEntryStderrString", + "documentation":"The stderr from the command
" + } + }, + "documentation":"An single entry in the shell history
" + }, + "ShellHistoryEntryCommandString":{ + "type":"string", + "max":1024, + "min":1, + "sensitive":true + }, + "ShellHistoryEntryDirectoryString":{ + "type":"string", + "max":256, + "min":1, + "sensitive":true + }, + "ShellHistoryEntryStderrString":{ + "type":"string", + "max":4096, + "min":0, + "sensitive":true + }, + "ShellHistoryEntryStdoutString":{ + "type":"string", + "max":4096, + "min":0, + "sensitive":true + }, + "ShellState":{ + "type":"structure", + "required":["shellName"], + "members":{ + "shellName":{ + "shape":"ShellStateShellNameString", + "documentation":"The name of the current shell
" + }, + "shellHistory":{ + "shape":"ShellHistory", + "documentation":"The history previous shell commands for the current shell
" + } + }, + "documentation":"Represents the state of a shell
" + }, + "ShellStateShellNameString":{ + "type":"string", + "max":32, + "min":1, + "pattern":"(zsh|bash|fish|pwsh|nu)" + }, + "Span":{ + "type":"structure", + "members":{ + "start":{"shape":"SpanStartInteger"}, + "end":{"shape":"SpanEndInteger"} + }, + "documentation":"Represents span in a text.
" + }, + "SpanEndInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "SpanStartInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "Step":{ + "type":"structure", + "required":[ + "id", + "state", + "label" + ], + "members":{ + "id":{ + "shape":"StepIdInteger", + "documentation":"A unique identifier for the step. It must be a non-negative integer to ensure each step is distinct.
" + }, + "state":{"shape":"StepState"}, + "label":{ + "shape":"StepLabelString", + "documentation":"A label for the step, providing a concise description.
" + }, + "content":{ + "shape":"StepComponentList", + "documentation":"Optional content providing additional details about the step.
" + } + }, + "documentation":"Structure representing an individual step in a process.
" + }, + "StepComponent":{ + "type":"structure", + "members":{ + "text":{"shape":"Text"} + } + }, + "StepComponentList":{ + "type":"list", + "member":{"shape":"StepComponent"} + }, + "StepIdInteger":{ + "type":"integer", + "box":true, + "max":128, + "min":0 + }, + "StepLabelString":{ + "type":"string", + "max":1024, + "min":0, + "sensitive":true + }, + "StepState":{ + "type":"string", + "documentation":"Enum representing all possible step states, combining terminal and non-terminal states.
", + "enum":[ + "FAILED", + "SUCCEEDED", + "STOPPED", + "PENDING", + "IN_PROGRESS", + "LOADING", + "PAUSED" + ] + }, + "String":{"type":"string"}, + "Suggestion":{ + "type":"structure", + "required":["value"], + "members":{ + "value":{"shape":"SuggestionValueString"} + }, + "documentation":"Structure representing a suggestion for follow-ups.
" + }, + "SuggestionList":{ + "type":"list", + "member":{"shape":"Suggestion"} + }, + "SuggestionValueString":{ + "type":"string", + "max":1000, + "min":1, + "sensitive":true + }, + "Suggestions":{ + "type":"structure", + "required":["items"], + "members":{ + "items":{"shape":"SuggestionList"} + }, + "documentation":"Structure containing a list of suggestions.
" + }, + "SupplementaryWebLink":{ + "type":"structure", + "required":[ + "url", + "title" + ], + "members":{ + "url":{ + "shape":"SupplementaryWebLinkUrlString", + "documentation":"URL of the web reference link.
" + }, + "title":{ + "shape":"SupplementaryWebLinkTitleString", + "documentation":"Title of the web reference link.
" + }, + "snippet":{ + "shape":"SupplementaryWebLinkSnippetString", + "documentation":"Relevant text snippet from the link.
" + } + }, + "documentation":"Represents an additional reference link retured with the Chat message
" + }, + "SupplementaryWebLinkSnippetString":{ + "type":"string", + "max":1024, + "min":1, + "sensitive":true + }, + "SupplementaryWebLinkTitleString":{ "type":"string", "max":1024, "min":1, @@ -616,8 +1938,12 @@ "SupplementaryWebLinksEvent":{ "type":"structure", "members":{ - "supplementaryWebLinks":{"shape":"SupplementaryWebLinks"} + "supplementaryWebLinks":{ + "shape":"SupplementaryWebLinks", + "documentation":"Web References for Assistant Response Message
" + } }, + "documentation":"Streaming Response Event for SupplementaryWebLinks
", "event":true }, "SymbolType":{ @@ -627,21 +1953,233 @@ "USAGE" ] }, + "TaskAction":{ + "type":"structure", + "required":[ + "label", + "payload" + ], + "members":{ + "label":{ + "shape":"TaskActionLabelString", + "documentation":"A label for the action.
" + }, + "note":{"shape":"TaskActionNote"}, + "primary":{ + "shape":"Boolean", + "documentation":"Indicates whether the action is primary or not.
" + }, + "disabled":{ + "shape":"Boolean", + "documentation":"Indicates whether the action is disabled or not.
" + }, + "payload":{"shape":"TaskActionPayload"}, + "confirmation":{"shape":"TaskActionConfirmation"} + }, + "documentation":"Structure representing an action associated with a task.
" + }, + "TaskActionConfirmation":{ + "type":"structure", + "members":{ + "content":{ + "shape":"TaskActionConfirmationContentString", + "documentation":"Confirmation message related to the action note, which may include sensitive information.
" + } + }, + "documentation":"Structure representing a confirmation message related to a task action.
" + }, + "TaskActionConfirmationContentString":{ + "type":"string", + "max":10240, + "min":0, + "sensitive":true + }, + "TaskActionLabelString":{ + "type":"string", + "max":1024, + "min":0, + "sensitive":true + }, + "TaskActionList":{ + "type":"list", + "member":{"shape":"TaskAction"} + }, + "TaskActionNote":{ + "type":"structure", + "required":["content"], + "members":{ + "content":{ + "shape":"TaskActionNoteContentString", + "documentation":"Content of the note, which may include sensitive information.
" + }, + "type":{"shape":"TaskActionNoteType"} + }, + "documentation":"Structure representing a note associated with a task action.
" + }, + "TaskActionNoteContentString":{ + "type":"string", + "max":10240, + "min":0, + "sensitive":true + }, + "TaskActionNoteType":{ + "type":"string", + "documentation":"Enum defining the types of notes that can be associated with a task action.
", + "enum":[ + "INFO", + "WARNING" + ] + }, + "TaskActionPayload":{ + "type":"map", + "key":{ + "shape":"TaskActionPayloadKeyString", + "documentation":"The key for the payload entry.
" + }, + "value":{ + "shape":"TaskActionPayloadValueString", + "documentation":"The sensitive value associated with the key.
" + }, + "documentation":"Map representing key-value pairs for the payload of a task action.
", + "max":32, + "min":0 + }, + "TaskActionPayloadKeyString":{ + "type":"string", + "max":1024, + "min":1 + }, + "TaskActionPayloadValueString":{ + "type":"string", + "max":1024, + "min":1, + "sensitive":true + }, + "TaskComponent":{ + "type":"structure", + "members":{ + "text":{"shape":"Text"}, + "infrastructureUpdate":{"shape":"InfrastructureUpdate"}, + "alert":{"shape":"Alert"}, + "progress":{"shape":"Progress"} + }, + "documentation":"Structure representing different types of components that can be part of a task.
" + }, + "TaskComponentList":{ + "type":"list", + "member":{"shape":"TaskComponent"} + }, + "TaskDetails":{ + "type":"structure", + "required":[ + "overview", + "content" + ], + "members":{ + "overview":{"shape":"TaskOverview"}, + "content":{ + "shape":"TaskComponentList", + "documentation":"Lists the components that can be used to form the task's content.
" + }, + "actions":{ + "shape":"TaskActionList", + "documentation":"Optional list of actions associated with the task.
" + } + }, + "documentation":"Structure containing details about a task.
" + }, + "TaskOverview":{ + "type":"structure", + "required":[ + "label", + "description" + ], + "members":{ + "label":{ + "shape":"TaskOverviewLabelString", + "documentation":"A label for the task overview.
" + }, + "description":{ + "shape":"TaskOverviewDescriptionString", + "documentation":"Text description providing details about the task. This field may include sensitive information and supports Markdown formatting.
" + } + }, + "documentation":"Structure representing an overview of a task, including a label and description.
" + }, + "TaskOverviewDescriptionString":{ + "type":"string", + "max":10240, + "min":0, + "sensitive":true + }, + "TaskOverviewLabelString":{ + "type":"string", + "max":1024, + "min":0, + "sensitive":true + }, + "TaskReference":{ + "type":"structure", + "required":["taskId"], + "members":{ + "taskId":{ + "shape":"TaskReferenceTaskIdString", + "documentation":"Unique identifier for the task.
" + } + }, + "documentation":"Structure representing a reference to a task.
" + }, + "TaskReferenceTaskIdString":{ + "type":"string", + "max":128, + "min":1 + }, "TestGenerationJobGroupName":{ "type":"string", + "documentation":"Test generation job group name
", "max":128, "min":1, "pattern":"[a-zA-Z0-9-_]+" }, + "Text":{ + "type":"structure", + "required":["content"], + "members":{ + "content":{ + "shape":"TextContentString", + "documentation":"Contains text content that may include sensitive information and can support Markdown formatting.
" + } + }, + "documentation":"Structure representing a simple text component with sensitive content, which can include Markdown formatting.
" + }, + "TextContentString":{ + "type":"string", + "max":10240, + "min":0, + "sensitive":true + }, "TextDocument":{ "type":"structure", "required":["relativeFilePath"], "members":{ - "relativeFilePath":{"shape":"TextDocumentRelativeFilePathString"}, - "programmingLanguage":{"shape":"ProgrammingLanguage"}, - "text":{"shape":"TextDocumentTextString"}, - "documentSymbols":{"shape":"DocumentSymbols"} - } + "relativeFilePath":{ + "shape":"TextDocumentRelativeFilePathString", + "documentation":"Filepath relative to the root of the workspace
" + }, + "programmingLanguage":{ + "shape":"ProgrammingLanguage", + "documentation":"The text document's language identifier.
" + }, + "text":{ + "shape":"TextDocumentTextString", + "documentation":"Content of the text document
" + }, + "documentSymbols":{ + "shape":"DocumentSymbols", + "documentation":"DocumentSymbols parsed from a text document
" + } + }, + "documentation":"Represents a Text Document / File
" }, "TextDocumentDiagnostic":{ "type":"structure", @@ -653,12 +2191,54 @@ "message" ], "members":{ - "document":{"shape":"TextDocument"}, - "range":{"shape":"Range"}, - "source":{"shape":"SensitiveString"}, - "severity":{"shape":"DiagnosticSeverity"}, - "message":{"shape":"TextDocumentDiagnosticMessageString"} - } + "document":{ + "shape":"TextDocument", + "documentation":"Represents a Text Document associated with Diagnostic
" + }, + "range":{ + "shape":"Range", + "documentation":"The range at which the message applies.
" + }, + "source":{ + "shape":"SensitiveString", + "documentation":"A human-readable string describing the source of the diagnostic
" + }, + "severity":{ + "shape":"DiagnosticSeverity", + "documentation":"Diagnostic Error type
" + }, + "message":{ + "shape":"TextDocumentDiagnosticMessageString", + "documentation":"The diagnostic's message.
" + }, + "code":{ + "shape":"Integer", + "documentation":"The diagnostic's code, which might appear in the user interface.
" + }, + "codeDescription":{ + "shape":"CodeDescription", + "documentation":"An optional property to describe the error code.
" + }, + "tags":{ + "shape":"DiagnosticTagList", + "documentation":"Additional metadata about the diagnostic.
" + }, + "relatedInformation":{ + "shape":"DiagnosticRelatedInformationList", + "documentation":"an array of related diagnostic information, e.g. when symbol-names within a scope collide all definitions can be marked via this property.
" + }, + "data":{ + "shape":"TextDocumentDiagnosticDataString", + "documentation":"A data entry field that is preserved between a textDocument/publishDiagnostics notification and textDocument/codeAction request.
Structure to represent metadata about a TextDocument Diagnostic
" + }, + "TextDocumentDiagnosticDataString":{ + "type":"string", + "max":4096, + "min":0, + "sensitive":true }, "TextDocumentDiagnosticMessageString":{ "type":"string", @@ -674,7 +2254,7 @@ }, "TextDocumentTextString":{ "type":"string", - "max":10240, + "max":40000, "min":0, "sensitive":true }, @@ -682,25 +2262,189 @@ "type":"structure", "required":["message"], "members":{ - "message":{"shape":"String"} + "message":{"shape":"String"}, + "reason":{"shape":"ThrottlingExceptionReason"} }, + "documentation":"This exception is thrown when request was denied due to request throttling.
", "exception":true, "retryable":{"throttling":true} }, - "ServiceQuotaExceededException":{ + "ThrottlingExceptionReason":{ + "type":"string", + "documentation":"Reason for ThrottlingException
", + "enum":["MONTHLY_REQUEST_COUNT"] + }, + "Tool":{ "type":"structure", - "required":["message"], "members":{ - "message":{"shape":"String"} + "toolSpecification":{"shape":"ToolSpecification"} }, - "exception":true, - "retryable":{"throttling":true} + "documentation":"Information about a tool that can be used.
", + "union":true + }, + "ToolDescription":{ + "type":"string", + "documentation":"The description for the tool.
", + "max":10240, + "min":1, + "sensitive":true + }, + "ToolInputSchema":{ + "type":"structure", + "members":{ + "json":{"shape":"SensitiveDocument"} + }, + "documentation":"The input schema for the tool in JSON format.
" + }, + "ToolName":{ + "type":"string", + "documentation":"The name for the tool.
", + "max":64, + "min":0, + "pattern":"[a-zA-Z][a-zA-Z0-9_]*", + "sensitive":true + }, + "ToolResult":{ + "type":"structure", + "required":[ + "toolUseId", + "content" + ], + "members":{ + "toolUseId":{"shape":"ToolUseId"}, + "content":{ + "shape":"ToolResultContent", + "documentation":"Content of the tool result.
" + }, + "status":{"shape":"ToolResultStatus"} + }, + "documentation":"A tool result that contains the results for a tool request that was previously made.
" + }, + "ToolResultContent":{ + "type":"list", + "member":{"shape":"ToolResultContentBlock"} + }, + "ToolResultContentBlock":{ + "type":"structure", + "members":{ + "text":{ + "shape":"ToolResultContentBlockTextString", + "documentation":"A tool result that is text.
" + }, + "json":{ + "shape":"SensitiveDocument", + "documentation":"A tool result that is JSON format data.
" + } + }, + "union":true + }, + "ToolResultContentBlockTextString":{ + "type":"string", + "max":800000, + "min":0, + "sensitive":true + }, + "ToolResultEvent":{ + "type":"structure", + "members":{ + "toolResult":{"shape":"ToolResult"} + }, + "event":true + }, + "ToolResultStatus":{ + "type":"string", + "documentation":"Status of the tools result.
", + "enum":[ + "success", + "error" + ] + }, + "ToolResults":{ + "type":"list", + "member":{"shape":"ToolResult"}, + "max":10, + "min":0 + }, + "ToolSpecification":{ + "type":"structure", + "required":[ + "inputSchema", + "name" + ], + "members":{ + "inputSchema":{"shape":"ToolInputSchema"}, + "name":{"shape":"ToolName"}, + "description":{"shape":"ToolDescription"} + }, + "documentation":"The specification for the tool.
" + }, + "ToolUse":{ + "type":"structure", + "required":[ + "toolUseId", + "name", + "input" + ], + "members":{ + "toolUseId":{"shape":"ToolUseId"}, + "name":{"shape":"ToolName"}, + "input":{ + "shape":"SensitiveDocument", + "documentation":"The input to pass to the tool.
" + } + }, + "documentation":"Contains information about a tool that the model is requesting be run. The model uses the result from the tool to generate a response.
" + }, + "ToolUseEvent":{ + "type":"structure", + "required":[ + "toolUseId", + "name" + ], + "members":{ + "toolUseId":{"shape":"ToolUseId"}, + "name":{"shape":"ToolName"}, + "input":{ + "shape":"ToolUseEventInputString", + "documentation":"Represents the serialized json input for the ToolUse request. This field should be concatenated until 'stop' is true.
" + }, + "stop":{ + "shape":"Boolean", + "documentation":"This field is true when all of the serialized input for this ToolUse request has been sent.
" + } + }, + "documentation":"Event for a ToolUse request. Multiple ToolUse requests can be returned from a single request, so each ToolUse has a unique 'toolUseId'.
", + "event":true + }, + "ToolUseEventInputString":{ + "type":"string", + "max":30720, + "min":0, + "sensitive":true + }, + "ToolUseId":{ + "type":"string", + "documentation":"The ID for the tool request.
", + "max":64, + "min":0, + "pattern":"[a-zA-Z0-9_-]+" + }, + "ToolUses":{ + "type":"list", + "member":{"shape":"ToolUse"}, + "max":10, + "min":0 + }, + "Tools":{ + "type":"list", + "member":{"shape":"Tool"} }, "TransformationDownloadArtifactType":{ "type":"string", "enum":[ "ClientInstructions", - "Logs" + "Logs", + "GeneratedCode" ] }, "TransformationExportContext":{ @@ -712,7 +2456,8 @@ "members":{ "downloadArtifactId":{"shape":"ArtifactId"}, "downloadArtifactType":{"shape":"TransformationDownloadArtifactType"} - } + }, + "documentation":"Transformation export context
" }, "UUID":{ "type":"string", @@ -725,10 +2470,12 @@ "members":{ "testGenerationJobGroupName":{"shape":"TestGenerationJobGroupName"}, "testGenerationJobId":{"shape":"UUID"} - } + }, + "documentation":"Unit test generation export context
" }, "UploadId":{ "type":"string", + "documentation":"Upload ID returned by CreateUploadUrl API
", "max":128, "min":1 }, @@ -736,26 +2483,88 @@ "type":"structure", "required":["content"], "members":{ - "content":{"shape":"UserInputMessageContentString"}, - "userInputMessageContext":{"shape":"UserInputMessageContext"}, - "userIntent":{"shape":"UserIntent"} - } + "content":{ + "shape":"UserInputMessageContentString", + "documentation":"The content of the chat message.
" + }, + "userInputMessageContext":{ + "shape":"UserInputMessageContext", + "documentation":"Chat message context associated with the Chat Message.
" + }, + "userIntent":{ + "shape":"UserIntent", + "documentation":"User Intent.
" + }, + "origin":{ + "shape":"Origin", + "documentation":"User Input Origin.
" + }, + "images":{ + "shape":"ImageBlocks", + "documentation":"Images associated with the Chat Message.
" + } + }, + "documentation":"Structure to represent a chat input message from User.
" }, "UserInputMessageContentString":{ "type":"string", - "max":4096, + "max":600000, "min":0, "sensitive":true }, "UserInputMessageContext":{ "type":"structure", "members":{ - "editorState":{"shape":"EditorState"}, - "diagnostic":{"shape":"Diagnostic"} - } + "editorState":{ + "shape":"EditorState", + "documentation":"Editor state chat message context.
" + }, + "shellState":{ + "shape":"ShellState", + "documentation":"Shell state chat message context.
" + }, + "gitState":{ + "shape":"GitState", + "documentation":"Git state chat message context.
" + }, + "envState":{ + "shape":"EnvState", + "documentation":"Environment state chat message context.
" + }, + "appStudioContext":{ + "shape":"AppStudioState", + "documentation":"The state of a user's AppStudio UI when sending a message.
" + }, + "diagnostic":{ + "shape":"Diagnostic", + "documentation":"Diagnostic chat message context.
" + }, + "consoleState":{ + "shape":"ConsoleState", + "documentation":"Contextual information about the environment from which the user is calling.
" + }, + "userSettings":{ + "shape":"UserSettings", + "documentation":"Settings information, e.g., whether the user has enabled cross-region API calls.
" + }, + "additionalContext":{ + "shape":"AdditionalContentList", + "documentation":"List of additional contextual content entries that can be included with the message.
" + }, + "toolResults":{ + "shape":"ToolResults", + "documentation":"ToolResults for the requested ToolUses.
" + }, + "tools":{ + "shape":"Tools", + "documentation":"Tools that can be used.
" + } + }, + "documentation":"Additional Chat message context associated with the Chat Message
" }, "UserIntent":{ "type":"string", + "documentation":"User Intent
", "enum":[ "SUGGEST_ALTERNATE_IMPLEMENTATION", "APPLY_COMMON_BEST_PRACTICES", @@ -764,9 +2573,18 @@ "CITE_SOURCES", "EXPLAIN_LINE_BY_LINE", "EXPLAIN_CODE_SELECTION", - "GENERATE_UNIT_TESTS" + "GENERATE_CLOUDFORMATION_TEMPLATE", + "GENERATE_UNIT_TESTS", + "CODE_GENERATION" ] }, + "UserSettings":{ + "type":"structure", + "members":{ + "hasConsentedToCrossRegionCalls":{"shape":"Boolean"} + }, + "documentation":"Settings information passed by the Q widget
" + }, "ValidationException":{ "type":"structure", "required":["message"], @@ -774,11 +2592,58 @@ "message":{"shape":"String"}, "reason":{"shape":"ValidationExceptionReason"} }, + "documentation":"This exception is thrown when the input fails to satisfy the constraints specified by the service.
", "exception":true }, "ValidationExceptionReason":{ "type":"string", - "enum":["INVALID_CONVERSATION_ID"] + "documentation":"Reason for ValidationException
", + "enum":[ + "INVALID_CONVERSATION_ID", + "CONTENT_LENGTH_EXCEEDS_THRESHOLD", + "INVALID_KMS_GRANT" + ] + }, + "WebLink":{ + "type":"structure", + "required":[ + "label", + "url" + ], + "members":{ + "label":{ + "shape":"WebLinkLabelString", + "documentation":"A label for the link
" + }, + "url":{ + "shape":"WebLinkUrlString", + "documentation":"URL of the Weblink
" + } + } + }, + "WebLinkLabelString":{ + "type":"string", + "max":1024, + "min":0, + "sensitive":true + }, + "WebLinkUrlString":{ + "type":"string", + "max":1024, + "min":1, + "sensitive":true + }, + "WorkspaceFolderList":{ + "type":"list", + "member":{"shape":"WorkspaceFolderListMemberString"}, + "max":100, + "min":0 + }, + "WorkspaceFolderListMemberString":{ + "type":"string", + "max":4096, + "min":1, + "sensitive":true }, "WorkspaceState":{ "type":"structure", @@ -787,10 +2652,20 @@ "programmingLanguage" ], "members":{ - "uploadId":{"shape":"UploadId"}, - "programmingLanguage":{"shape":"ProgrammingLanguage"}, - "contextTruncationScheme":{"shape":"ContextTruncationScheme"} - } + "uploadId":{ + "shape":"UploadId", + "documentation":"Upload ID representing an Upload using a PreSigned URL
" + }, + "programmingLanguage":{ + "shape":"ProgrammingLanguage", + "documentation":"Primary programming language of the Workspace
" + }, + "contextTruncationScheme":{ + "shape":"ContextTruncationScheme", + "documentation":"Workspace context truncation schemes based on usecase
" + } + }, + "documentation":"Represents a Workspace state uploaded to S3 for Async Code Actions
" } } }