The details for the init containers.
" }, + "eksClusterArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the Amazon EKS cluster.
" + }, "podName":{ "shape":"String", "documentation":"The name of the pod for this job attempt.
" @@ -3261,6 +3265,10 @@ "instanceTypes":{ "shape":"StringList", "documentation":"An object that contains the instance types that you want to replace for the existing resources of a job.
" + }, + "eksPropertiesOverride":{ + "shape":"EksPropertiesOverride", + "documentation":"An object that contains the properties that you want to replace for the existing Amazon EKS resources of a job.
" } }, "documentation":"The object that represents any node overrides to a job definition that's used in a SubmitJob API operation.
" @@ -3292,6 +3300,10 @@ "ecsProperties":{ "shape":"EcsProperties", "documentation":"This is an object that represents the properties of the node range for a multi-node parallel job.
" + }, + "eksProperties":{ + "shape":"EksProperties", + "documentation":"This is an object that represents the properties of the node range for a multi-node parallel job.
" } }, "documentation":"This is an object that represents the properties of the node range for a multi-node parallel job.
" diff --git a/botocore/data/bedrock-agent-runtime/2023-07-26/paginators-1.json b/botocore/data/bedrock-agent-runtime/2023-07-26/paginators-1.json index bd57dfbc67..6d64542de3 100644 --- a/botocore/data/bedrock-agent-runtime/2023-07-26/paginators-1.json +++ b/botocore/data/bedrock-agent-runtime/2023-07-26/paginators-1.json @@ -4,6 +4,12 @@ "input_token": "nextToken", "output_token": "nextToken", "result_key": "retrievalResults" + }, + "GetAgentMemory": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxItems", + "result_key": "memoryContents" } } } diff --git a/botocore/data/bedrock-agent-runtime/2023-07-26/service-2.json b/botocore/data/bedrock-agent-runtime/2023-07-26/service-2.json index a0dc239a32..87a76e0df1 100644 --- a/botocore/data/bedrock-agent-runtime/2023-07-26/service-2.json +++ b/botocore/data/bedrock-agent-runtime/2023-07-26/service-2.json @@ -12,6 +12,51 @@ "uid":"bedrock-agent-runtime-2023-07-26" }, "operations":{ + "DeleteAgentMemory":{ + "name":"DeleteAgentMemory", + "http":{ + "method":"DELETE", + "requestUri":"/agents/{agentId}/agentAliases/{agentAliasId}/memories", + "responseCode":202 + }, + "input":{"shape":"DeleteAgentMemoryRequest"}, + "output":{"shape":"DeleteAgentMemoryResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"DependencyFailedException"}, + {"shape":"BadGatewayException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Deletes memory from the specified memory identifier.
", + "idempotent":true + }, + "GetAgentMemory":{ + "name":"GetAgentMemory", + "http":{ + "method":"GET", + "requestUri":"/agents/{agentId}/agentAliases/{agentAliasId}/memories", + "responseCode":200 + }, + "input":{"shape":"GetAgentMemoryRequest"}, + "output":{"shape":"GetAgentMemoryResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"DependencyFailedException"}, + {"shape":"BadGatewayException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Gets the sessions stored in the memory of the agent.
" + }, "InvokeAgent":{ "name":"InvokeAgent", "http":{ @@ -32,7 +77,29 @@ {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"The CLI doesn't support InvokeAgent.
Sends a prompt for the agent to process and respond to. Note the following fields for the request:
To continue the same conversation with an agent, use the same sessionId value in the request.
To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement.
End a conversation by setting endSession to true.
In the sessionState object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.
The response is returned in the bytes field of the chunk object.
The attribution object contains citations for parts of the response.
If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response.
If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the returnControl field.
Errors are also surfaced in the response.
The CLI doesn't support streaming operations in Amazon Bedrock, including InvokeAgent.
Sends a prompt for the agent to process and respond to. Note the following fields for the request:
To continue the same conversation with an agent, use the same sessionId value in the request.
To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement.
End a conversation by setting endSession to true.
In the sessionState object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.
The response is returned in the bytes field of the chunk object.
The attribution object contains citations for parts of the response.
If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response.
If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the returnControl field.
Errors are also surfaced in the response.
Invokes an alias of a flow to run the inputs that you specify and return the output of each node as a stream. If there's an error, the error is returned. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
" }, "Retrieve":{ "name":"Retrieve", @@ -103,10 +170,18 @@ "shape":"ApiPath", "documentation":"The path to the API to call, based off the action group.
" }, + "executionType":{ + "shape":"ExecutionType", + "documentation":"How fulfillment of the action is handled. For more information, see Handling fulfillment of the action.
" + }, "function":{ "shape":"Function", "documentation":"The function in the action group to call.
" }, + "invocationId":{ + "shape":"String", + "documentation":"The unique identifier of the invocation. Only returned if the executionType is RETURN_CONTROL.
The parameters in the Lambda input event.
" @@ -336,6 +411,24 @@ }, "documentation":"This property contains the document to chat with, along with its attributes.
" }, + "ByteContentFile":{ + "type":"structure", + "required":[ + "data", + "mediaType" + ], + "members":{ + "data":{ + "shape":"ByteContentBlob", + "documentation":"The byte value of the file to attach, encoded as Base-64 string. The maximum size of all files that is attached is 10MB. You can attach a maximum of 5 files.
" + }, + "mediaType":{ + "shape":"MimeType", + "documentation":"The MIME type of data contained in the file used for chat.
" + } + }, + "documentation":"The property contains the file to chat with, along with its attributes.
" + }, "Citation":{ "type":"structure", "members":{ @@ -354,6 +447,42 @@ "type":"list", "member":{"shape":"Citation"} }, + "CodeInterpreterInvocationInput":{ + "type":"structure", + "members":{ + "code":{ + "shape":"String", + "documentation":"The code for the code interpreter to use.
" + }, + "files":{ + "shape":"Files", + "documentation":"Files that are uploaded for code interpreter to use.
" + } + }, + "documentation":"Contains information about the code interpreter being invoked.
" + }, + "CodeInterpreterInvocationOutput":{ + "type":"structure", + "members":{ + "executionError":{ + "shape":"String", + "documentation":"Contains the error returned from code execution.
" + }, + "executionOutput":{ + "shape":"String", + "documentation":"Contains the successful output returned from code execution
" + }, + "executionTimeout":{ + "shape":"Boolean", + "documentation":"Indicates if the execution of the code timed out.
" + }, + "files":{ + "shape":"Files", + "documentation":"Contains output files, if generated by code execution.
" + } + }, + "documentation":"Contains the JSON-formatted string returned by the API invoked by the code interpreter.
" + }, "ConflictException":{ "type":"structure", "members":{ @@ -392,6 +521,43 @@ "OVERRIDDEN" ] }, + "DateTimestamp":{ + "type":"timestamp", + "documentation":"Time Stamp.
", + "timestampFormat":"iso8601" + }, + "DeleteAgentMemoryRequest":{ + "type":"structure", + "required":[ + "agentAliasId", + "agentId" + ], + "members":{ + "agentAliasId":{ + "shape":"AgentAliasId", + "documentation":"The unique identifier of an alias of an agent.
", + "location":"uri", + "locationName":"agentAliasId" + }, + "agentId":{ + "shape":"AgentId", + "documentation":"The unique identifier of the agent to which the alias belongs.
", + "location":"uri", + "locationName":"agentId" + }, + "memoryId":{ + "shape":"MemoryId", + "documentation":"The unique identifier of the memory.
", + "location":"querystring", + "locationName":"memoryId" + } + } + }, + "DeleteAgentMemoryResponse":{ + "type":"structure", + "members":{ + } + }, "DependencyFailedException":{ "type":"structure", "members":{ @@ -408,10 +574,23 @@ }, "exception":true }, + "Document":{ + "type":"structure", + "members":{ + }, + "document":true + }, "Double":{ "type":"double", "box":true }, + "ExecutionType":{ + "type":"string", + "enum":[ + "LAMBDA", + "RETURN_CONTROL" + ] + }, "ExternalSource":{ "type":"structure", "required":["sourceType"], @@ -507,6 +686,60 @@ "documentation":"Contains information about the failure of the interaction.
", "sensitive":true }, + "FileBody":{ + "type":"blob", + "max":1000000, + "min":0, + "sensitive":true + }, + "FilePart":{ + "type":"structure", + "members":{ + "files":{ + "shape":"OutputFiles", + "documentation":"Files containing intermediate response for the user.
" + } + }, + "documentation":"Contains intermediate response for code interpreter if any files have been generated.
", + "event":true + }, + "FileSource":{ + "type":"structure", + "required":["sourceType"], + "members":{ + "byteContent":{ + "shape":"ByteContentFile", + "documentation":"The data and the text of the attached files.
" + }, + "s3Location":{ + "shape":"S3ObjectFile", + "documentation":"The s3 location of the files to attach.
" + }, + "sourceType":{ + "shape":"FileSourceType", + "documentation":"The source type of the files to attach.
" + } + }, + "documentation":"The source file of the content contained in the wrapper object.
" + }, + "FileSourceType":{ + "type":"string", + "enum":[ + "S3", + "BYTE_CONTENT" + ] + }, + "FileUseCase":{ + "type":"string", + "enum":[ + "CODE_INTERPRETER", + "CHAT" + ] + }, + "Files":{ + "type":"list", + "member":{"shape":"String"} + }, "FilterAttribute":{ "type":"structure", "required":[ @@ -550,6 +783,163 @@ "type":"string", "sensitive":true }, + "FlowAliasIdentifier":{ + "type":"string", + "max":2048, + "min":0, + "pattern":"^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(\\bTSTALIASID\\b|[0-9a-zA-Z]+)$" + }, + "FlowCompletionEvent":{ + "type":"structure", + "required":["completionReason"], + "members":{ + "completionReason":{ + "shape":"FlowCompletionReason", + "documentation":"The reason that the flow completed.
" + } + }, + "documentation":"Contains information about why a flow completed.
This data type is used in the following API operations:
", + "event":true, + "sensitive":true + }, + "FlowCompletionReason":{ + "type":"string", + "enum":["SUCCESS"] + }, + "FlowIdentifier":{ + "type":"string", + "max":2048, + "min":0, + "pattern":"^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})$" + }, + "FlowInput":{ + "type":"structure", + "required":[ + "content", + "nodeName", + "nodeOutputName" + ], + "members":{ + "content":{ + "shape":"FlowInputContent", + "documentation":"Contains information about an input into the flow.
" + }, + "nodeName":{ + "shape":"NodeName", + "documentation":"A name for the input of the flow input node.
" + }, + "nodeOutputName":{ + "shape":"NodeOutputName", + "documentation":"A name for the output of the flow input node.
" + } + }, + "documentation":"Contains information about an input into the flow and what to do with it.
This data type is used in the following API operations:
" + }, + "FlowInputContent":{ + "type":"structure", + "members":{ + "document":{ + "shape":"Document", + "documentation":"The input for the flow input node.
" + } + }, + "documentation":"Contains information about an input into the flow.
This data type is used in the following API operations:
", + "sensitive":true, + "union":true + }, + "FlowInputs":{ + "type":"list", + "member":{"shape":"FlowInput"}, + "max":1, + "min":1 + }, + "FlowOutputContent":{ + "type":"structure", + "members":{ + "document":{ + "shape":"Document", + "documentation":"A name for the output of the flow.
" + } + }, + "documentation":"Contains information about the output node.
This data type is used in the following API operations:
", + "union":true + }, + "FlowOutputEvent":{ + "type":"structure", + "required":[ + "content", + "nodeName", + "nodeType" + ], + "members":{ + "content":{ + "shape":"FlowOutputContent", + "documentation":"The output of the node.
" + }, + "nodeName":{ + "shape":"NodeName", + "documentation":"The name of the node to which input was provided.
" + }, + "nodeType":{ + "shape":"NodeType", + "documentation":"The type of node to which input was provided.
" + } + }, + "documentation":"Contains information about an output from flow invoction.
This data type is used in the following API operations:
", + "event":true, + "sensitive":true + }, + "FlowResponseStream":{ + "type":"structure", + "members":{ + "accessDeniedException":{ + "shape":"AccessDeniedException", + "documentation":"The request is denied because of missing access permissions. Check your permissions and retry your request.
" + }, + "badGatewayException":{ + "shape":"BadGatewayException", + "documentation":"There was an issue with a dependency due to a server issue. Retry your request.
" + }, + "conflictException":{ + "shape":"ConflictException", + "documentation":"There was a conflict performing an operation. Resolve the conflict and retry your request.
" + }, + "dependencyFailedException":{ + "shape":"DependencyFailedException", + "documentation":"There was an issue with a dependency. Check the resource configurations and retry the request.
" + }, + "flowCompletionEvent":{ + "shape":"FlowCompletionEvent", + "documentation":"Contains information about why the flow completed.
" + }, + "flowOutputEvent":{ + "shape":"FlowOutputEvent", + "documentation":"Contains information about an output from flow invocation.
" + }, + "internalServerException":{ + "shape":"InternalServerException", + "documentation":"An internal server error occurred. Retry your request.
" + }, + "resourceNotFoundException":{ + "shape":"ResourceNotFoundException", + "documentation":"The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
" + }, + "serviceQuotaExceededException":{ + "shape":"ServiceQuotaExceededException", + "documentation":"The number of requests exceeds the service quota. Resubmit your request later.
" + }, + "throttlingException":{ + "shape":"ThrottlingException", + "documentation":"The number of requests exceeds the limit. Resubmit your request later.
" + }, + "validationException":{ + "shape":"ValidationException", + "documentation":"Input validation failed. Check your request parameters and retry the request.
" + } + }, + "documentation":"The output of the flow.
This data type is used in the following API operations:
", + "eventstream":true + }, "Function":{ "type":"string", "sensitive":true @@ -650,6 +1040,66 @@ }, "documentation":"Contains configurations for response generation based on the knowledge base query results.
This data type is used in the following API operations:
" }, + "GetAgentMemoryRequest":{ + "type":"structure", + "required":[ + "agentAliasId", + "agentId", + "memoryId", + "memoryType" + ], + "members":{ + "agentAliasId":{ + "shape":"AgentAliasId", + "documentation":"The unique identifier of an alias of an agent.
", + "location":"uri", + "locationName":"agentAliasId" + }, + "agentId":{ + "shape":"AgentId", + "documentation":"The unique identifier of the agent to which the alias belongs.
", + "location":"uri", + "locationName":"agentId" + }, + "maxItems":{ + "shape":"MaxResults", + "documentation":"The maximum number of items to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The unique identifier of the memory.
", + "location":"querystring", + "locationName":"memoryId" + }, + "memoryType":{ + "shape":"MemoryType", + "documentation":"The type of memory.
", + "location":"querystring", + "locationName":"memoryType" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the total number of results is greater than the maxItems value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
Contains details of the sessions stored in the memory
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the total number of results is greater than the maxItems value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.
" }, + "InputFile":{ + "type":"structure", + "required":[ + "name", + "source", + "useCase" + ], + "members":{ + "name":{ + "shape":"String", + "documentation":"The name of the source file.
" + }, + "source":{ + "shape":"FileSource", + "documentation":"Specifies where the files are located.
" + }, + "useCase":{ + "shape":"FileUseCase", + "documentation":"Specifies how the source files will be used by the code interpreter.
" + } + }, + "documentation":"Contains details of the source files.
" + }, + "InputFiles":{ + "type":"list", + "member":{"shape":"InputFile"} + }, "InputText":{ "type":"string", "max":25000000, @@ -1092,6 +1569,10 @@ "shape":"ActionGroupInvocationInput", "documentation":"Contains information about the action group to be invoked.
" }, + "codeInterpreterInvocationInput":{ + "shape":"CodeInterpreterInvocationInput", + "documentation":"Contains information about the code interpreter to be invoked.
" + }, "invocationType":{ "shape":"InvocationType", "documentation":"Specifies whether the agent is invoking an action group or a knowledge base.
" @@ -1149,7 +1630,8 @@ "enum":[ "ACTION_GROUP", "KNOWLEDGE_BASE", - "FINISH" + "FINISH", + "ACTION_GROUP_CODE_INTERPRETER" ] }, "InvokeAgentRequest":{ @@ -1184,6 +1666,10 @@ "shape":"InputText", "documentation":"The prompt text to send the agent.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
The unique identifier of the agent memory.
" + }, "sessionId":{ "shape":"SessionId", "documentation":"The unique identifier of the session. Use the same value across requests to continue the same conversation.
", @@ -1214,6 +1700,12 @@ "location":"header", "locationName":"x-amzn-bedrock-agent-content-type" }, + "memoryId":{ + "shape":"MemoryId", + "documentation":"The unique identifier of the agent memory.
", + "location":"header", + "locationName":"x-amz-bedrock-agent-memory-id" + }, "sessionId":{ "shape":"SessionId", "documentation":"The unique identifier of the session with the agent.
", @@ -1223,12 +1715,72 @@ }, "payload":"completion" }, + "InvokeFlowRequest":{ + "type":"structure", + "required":[ + "flowAliasIdentifier", + "flowIdentifier", + "inputs" + ], + "members":{ + "flowAliasIdentifier":{ + "shape":"FlowAliasIdentifier", + "documentation":"The unique identifier of the flow alias.
", + "location":"uri", + "locationName":"flowAliasIdentifier" + }, + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow.
", + "location":"uri", + "locationName":"flowIdentifier" + }, + "inputs":{ + "shape":"FlowInputs", + "documentation":"A list of objects, each containing information about an input into the flow.
" + } + } + }, + "InvokeFlowResponse":{ + "type":"structure", + "required":["responseStream"], + "members":{ + "responseStream":{ + "shape":"FlowResponseStream", + "documentation":"The output of the flow, returned as a stream. If there's an error, the error is returned.
" + } + }, + "payload":"responseStream" + }, "KmsKeyArn":{ "type":"string", "max":2048, "min":1, "pattern":"^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" }, + "KnowledgeBaseConfiguration":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "retrievalConfiguration" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"KnowledgeBaseId", + "documentation":"The unique identifier for a knowledge base attached to the agent.
" + }, + "retrievalConfiguration":{ + "shape":"KnowledgeBaseRetrievalConfiguration", + "documentation":"The configurations to apply to the knowledge base during query. For more information, see Query configurations.
" + } + }, + "documentation":"Configurations to apply to a knowledge base attached to the agent during query. For more information, see Knowledge base retrieval configurations.
" + }, + "KnowledgeBaseConfigurations":{ + "type":"list", + "member":{"shape":"KnowledgeBaseConfiguration"}, + "min":1 + }, "KnowledgeBaseId":{ "type":"string", "max":10, @@ -1289,7 +1841,7 @@ "documentation":"Contains details about how the results from the vector search should be returned. For more information, see Query configurations.
" } }, - "documentation":"Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
This data type is used in the following API operations:
Retrieve request – in the retrievalConfiguration field
RetrieveAndGenerate request – in the retrievalConfiguration field
Contains configurations for knowledge base query. For more information, see Query configurations.
This data type is used in the following API operations:
Retrieve request – in the retrievalConfiguration field
RetrieveAndGenerate request – in the retrievalConfiguration field
Contains configurations for response generation based on the knowwledge base query results.
" + "documentation":"Contains configurations for response generation based on the knowledge base query results.
" }, "knowledgeBaseId":{ "shape":"KnowledgeBaseId", @@ -1338,6 +1890,10 @@ "shape":"BedrockModelArn", "documentation":"The ARN of the foundation model used to generate a response.
" }, + "orchestrationConfiguration":{ + "shape":"OrchestrationConfiguration", + "documentation":"Settings for how the model processes the prompt prior to retrieval and generation.
" + }, "retrievalConfiguration":{ "shape":"KnowledgeBaseRetrievalConfiguration", "documentation":"Contains configurations for how to retrieve and return the knowledge base query.
" @@ -1371,6 +1927,13 @@ "min":1 }, "LambdaArn":{"type":"string"}, + "MaxResults":{ + "type":"integer", + "documentation":"Max Results.
", + "box":true, + "max":1000, + "min":1 + }, "MaxTokens":{ "type":"integer", "box":true, @@ -1383,6 +1946,57 @@ "max":4096, "min":0 }, + "Memories":{ + "type":"list", + "member":{"shape":"Memory"} + }, + "Memory":{ + "type":"structure", + "members":{ + "sessionSummary":{ + "shape":"MemorySessionSummary", + "documentation":"Contains summary of a session.
" + } + }, + "documentation":"Contains sessions summaries.
", + "union":true + }, + "MemoryId":{ + "type":"string", + "max":100, + "min":2, + "pattern":"^[0-9a-zA-Z._:-]+$" + }, + "MemorySessionSummary":{ + "type":"structure", + "members":{ + "memoryId":{ + "shape":"MemoryId", + "documentation":"The unique identifier of the memory where the session summary is stored.
" + }, + "sessionExpiryTime":{ + "shape":"DateTimestamp", + "documentation":"The time when the memory duration for the session is set to end.
" + }, + "sessionId":{ + "shape":"SessionId", + "documentation":"The identifier for this session.
" + }, + "sessionStartTime":{ + "shape":"DateTimestamp", + "documentation":"The start time for this session.
" + }, + "summaryText":{ + "shape":"SummaryText", + "documentation":"The summarized text for this session.
" + } + }, + "documentation":"Contains details of a session summary.
" + }, + "MemoryType":{ + "type":"string", + "enum":["SESSION_SUMMARY"] + }, "MimeType":{"type":"string"}, "ModelInvocationInput":{ "type":"structure", @@ -1425,6 +2039,26 @@ "min":1, "pattern":"^\\S*$" }, + "NodeName":{ + "type":"string", + "pattern":"^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$" + }, + "NodeOutputName":{ + "type":"string", + "pattern":"^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$" + }, + "NodeType":{ + "type":"string", + "enum":[ + "FlowInputNode", + "FlowOutputNode", + "LambdaFunctionNode", + "KnowledgeBaseNode", + "PromptNode", + "ConditionNode", + "LexNode" + ] + }, "NonBlankString":{ "type":"string", "pattern":"^[\\s\\S]*$" @@ -1436,6 +2070,10 @@ "shape":"ActionGroupInvocationOutput", "documentation":"Contains the JSON-formatted string returned by the API invoked by the action group.
" }, + "codeInterpreterInvocationOutput":{ + "shape":"CodeInterpreterInvocationOutput", + "documentation":"Contains the JSON-formatted string returned by the API invoked by the code interpreter.
" + }, "finalResponse":{ "shape":"FinalResponse", "documentation":"Contains details about the response to the user.
" @@ -1460,6 +2098,17 @@ "documentation":"Contains the result or output of an action group or knowledge base, or the response to the user.
", "sensitive":true }, + "OrchestrationConfiguration":{ + "type":"structure", + "required":["queryTransformationConfiguration"], + "members":{ + "queryTransformationConfiguration":{ + "shape":"QueryTransformationConfiguration", + "documentation":"To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.
Settings for how the model processes the prompt prior to retrieval and generation.
" + }, "OrchestrationTrace":{ "type":"structure", "members":{ @@ -1484,6 +2133,31 @@ "sensitive":true, "union":true }, + "OutputFile":{ + "type":"structure", + "members":{ + "bytes":{ + "shape":"FileBody", + "documentation":"The byte count of files that contains response from code interpreter.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the file containing response from code interpreter.
" + }, + "type":{ + "shape":"MimeType", + "documentation":"The type of file that contains response from the code interpreter.
" + } + }, + "documentation":"Contains details of the response from code interpreter.
", + "sensitive":true + }, + "OutputFiles":{ + "type":"list", + "member":{"shape":"OutputFile"}, + "max":5, + "min":0 + }, "OutputString":{ "type":"string", "sensitive":true @@ -1662,6 +2336,21 @@ }, "documentation":"Contains the parameters in the request body.
" }, + "QueryTransformationConfiguration":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{ + "shape":"QueryTransformationType", + "documentation":"The type of transformation to apply to the prompt.
" + } + }, + "documentation":"To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.
There was an issue with a dependency. Check the resource configurations and retry the request.
" }, + "files":{ + "shape":"FilePart", + "documentation":"Contains intermediate response for code interpreter if any files have been generated.
" + }, "internalServerException":{ "shape":"InternalServerException", "documentation":"An internal server error occurred. Retry your request.
" @@ -1862,6 +2555,16 @@ "max":5, "min":2 }, + "RetrievalResultConfluenceLocation":{ + "type":"structure", + "members":{ + "url":{ + "shape":"String", + "documentation":"The Confluence host URL for the data source location.
" + } + }, + "documentation":"The Confluence data source location.
" + }, "RetrievalResultContent":{ "type":"structure", "required":["text"], @@ -1878,21 +2581,43 @@ "type":"structure", "required":["type"], "members":{ + "confluenceLocation":{ + "shape":"RetrievalResultConfluenceLocation", + "documentation":"The Confluence data source location.
" + }, "s3Location":{ "shape":"RetrievalResultS3Location", - "documentation":"Contains the S3 location of the data source.
" + "documentation":"The S3 data source location.
" + }, + "salesforceLocation":{ + "shape":"RetrievalResultSalesforceLocation", + "documentation":"The Salesforce data source location.
" + }, + "sharePointLocation":{ + "shape":"RetrievalResultSharePointLocation", + "documentation":"The SharePoint data source location.
" }, "type":{ "shape":"RetrievalResultLocationType", - "documentation":"The type of the location of the data source.
" + "documentation":"The type of data source location.
" + }, + "webLocation":{ + "shape":"RetrievalResultWebLocation", + "documentation":"The web URL/URLs data source location.
" } }, - "documentation":"Contains information about the location of the data source.
This data type is used in the following API operations:
Retrieve response – in the location field
RetrieveAndGenerate response – in the location field
InvokeAgent response – in the locatino field
Contains information about the data source location.
This data type is used in the following API operations:
Retrieve response – in the location field
RetrieveAndGenerate response – in the location field
InvokeAgent response – in the locatino field
The S3 URI of the data source.
" + "documentation":"The S3 URI for the data source location.
" } }, - "documentation":"Contains the S3 location of the data source.
This data type is used in the following API operations:
Retrieve response – in the s3Location field
RetrieveAndGenerate response – in the s3Location field
InvokeAgent response – in the s3Location field
The S3 data source location.
This data type is used in the following API operations:
Retrieve response – in the s3Location field
RetrieveAndGenerate response – in the s3Location field
InvokeAgent response – in the s3Location field
The Salesforce host URL for the data source location.
" + } + }, + "documentation":"The Salesforce data source location.
" + }, + "RetrievalResultSharePointLocation":{ + "type":"structure", + "members":{ + "url":{ + "shape":"String", + "documentation":"The SharePoint site URL for the data source location.
" + } + }, + "documentation":"The SharePoint data source location.
" + }, + "RetrievalResultWebLocation":{ + "type":"structure", + "members":{ + "url":{ + "shape":"String", + "documentation":"The web URL/URLs for the data source location.
" + } + }, + "documentation":"The web URL/URLs data source location.
" }, "RetrieveAndGenerateConfiguration":{ "type":"structure", @@ -1988,7 +2743,7 @@ }, "sessionId":{ "shape":"SessionId", - "documentation":"The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.
" + "documentation":"The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.
The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.
" + "documentation":"The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.
The unique wrapper object of the document from the S3 location.
" }, + "S3ObjectFile":{ + "type":"structure", + "required":["uri"], + "members":{ + "uri":{ + "shape":"S3Uri", + "documentation":"The uri of the s3 object.
" + } + }, + "documentation":"Contains details of the s3 object where the source file is located.
" + }, "S3Uri":{ "type":"string", "max":1024, @@ -2170,10 +2936,18 @@ "SessionState":{ "type":"structure", "members":{ + "files":{ + "shape":"InputFiles", + "documentation":"Contains information about the files used by code interpreter.
" + }, "invocationId":{ "shape":"String", "documentation":"The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer and Control session context.
An array of configurations, each of which applies to a knowledge base attached to the agent.
" + }, "promptSessionAttributes":{ "shape":"PromptSessionAttributesMap", "documentation":"Contains attributes that persist across a prompt and the values of those attributes. These attributes replace the $prompt_session_attributes$ placeholder variable in the orchestration prompt template. For more information, see Prompt template placeholder variables.
" @@ -2229,6 +3003,11 @@ "min":0 }, "String":{"type":"string"}, + "SummaryText":{ + "type":"string", + "max":25000000, + "min":0 + }, "Temperature":{ "type":"float", "box":true, diff --git a/botocore/data/bedrock-agent/2023-06-05/paginators-1.json b/botocore/data/bedrock-agent/2023-06-05/paginators-1.json index 8e00fb72a9..8485d731a1 100644 --- a/botocore/data/bedrock-agent/2023-06-05/paginators-1.json +++ b/botocore/data/bedrock-agent/2023-06-05/paginators-1.json @@ -47,6 +47,30 @@ "output_token": "nextToken", "limit_key": "maxResults", "result_key": "knowledgeBaseSummaries" + }, + "ListFlowAliases": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "flowAliasSummaries" + }, + "ListFlowVersions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "flowVersionSummaries" + }, + "ListFlows": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "flowSummaries" + }, + "ListPrompts": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "promptSummaries" } } } diff --git a/botocore/data/bedrock-agent/2023-06-05/service-2.json b/botocore/data/bedrock-agent/2023-06-05/service-2.json index b76b1841ce..438e3339c9 100644 --- a/botocore/data/bedrock-agent/2023-06-05/service-2.json +++ b/botocore/data/bedrock-agent/2023-06-05/service-2.json @@ -50,7 +50,7 @@ {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.
Specify the following fields for security purposes.
agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent.
(Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.
(Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session.
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts.
If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.
Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.
Specify the following fields for security purposes.
agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent.
(Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.
(Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session.
To enable your agent to retain conversational context across multiple sessions, include a memoryConfiguration object. For more information, see Configure memory.
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts.
If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.
Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them.
To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them.
To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.CodeInterpreter.
You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
Sets up a data source to be added to a knowledge base.
You can't change the chunkingConfiguration after you create the data source.
Creates a data source connector for a knowledge base.
You can't change the chunkingConfiguration after you create the data source connector.
Creates a prompt flow that you can use to send an input through various steps to yield an output. Configure nodes, each of which corresponds to a step of the flow, and create connections between the nodes to create paths to different outputs. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "idempotent":true + }, + "CreateFlowAlias":{ + "name":"CreateFlowAlias", + "http":{ + "method":"POST", + "requestUri":"/flows/{flowIdentifier}/aliases", + "responseCode":201 + }, + "input":{"shape":"CreateFlowAliasRequest"}, + "output":{"shape":"CreateFlowAliasResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Creates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "idempotent":true + }, + "CreateFlowVersion":{ + "name":"CreateFlowVersion", + "http":{ + "method":"POST", + "requestUri":"/flows/{flowIdentifier}/versions", + "responseCode":201 + }, + "input":{"shape":"CreateFlowVersionRequest"}, + "output":{"shape":"CreateFlowVersionResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Creates a version of the flow that you can deploy. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", "idempotent":true }, "CreateKnowledgeBase":{ @@ -136,6 +198,47 @@ "documentation":"Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion.
If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base.
Provide the name and an optional description.
Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn field.
Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object.
Provide the configuration for your vector store in the storageConfiguration object.
For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration object. For more information, see Create a vector store in Amazon OpenSearch Service.
For an Amazon Aurora database, use the RdsConfiguration object. For more information, see Create a vector store in Amazon Aurora.
For a Pinecone database, use the pineconeConfiguration object. For more information, see Create a vector store in Pinecone.
For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration object. For more information, see Create a vector store in Redis Enterprise Cloud.
Creates a prompt in your prompt library that you can add to a flow. For more information, see Prompt management in Amazon Bedrock, Create a prompt using Prompt management and Prompt flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "idempotent":true + }, + "CreatePromptVersion":{ + "name":"CreatePromptVersion", + "http":{ + "method":"POST", + "requestUri":"/prompts/{promptIdentifier}/versions", + "responseCode":201 + }, + "input":{"shape":"CreatePromptVersionRequest"}, + "output":{"shape":"CreatePromptVersionResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Creates a static snapshot of your prompt that can be deployed to production. For more information, see Deploy prompts using Prompt management by creating versions in the Amazon Bedrock User Guide.
", + "idempotent":true + }, "DeleteAgent":{ "name":"DeleteAgent", "http":{ @@ -235,6 +338,66 @@ "documentation":"Deletes a data source from a knowledge base.
", "idempotent":true }, + "DeleteFlow":{ + "name":"DeleteFlow", + "http":{ + "method":"DELETE", + "requestUri":"/flows/{flowIdentifier}/", + "responseCode":200 + }, + "input":{"shape":"DeleteFlowRequest"}, + "output":{"shape":"DeleteFlowResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"Deletes a flow.
", + "idempotent":true + }, + "DeleteFlowAlias":{ + "name":"DeleteFlowAlias", + "http":{ + "method":"DELETE", + "requestUri":"/flows/{flowIdentifier}/aliases/{aliasIdentifier}", + "responseCode":200 + }, + "input":{"shape":"DeleteFlowAliasRequest"}, + "output":{"shape":"DeleteFlowAliasResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"Deletes an alias of a flow.
", + "idempotent":true + }, + "DeleteFlowVersion":{ + "name":"DeleteFlowVersion", + "http":{ + "method":"DELETE", + "requestUri":"/flows/{flowIdentifier}/versions/{flowVersion}/", + "responseCode":200 + }, + "input":{"shape":"DeleteFlowVersionRequest"}, + "output":{"shape":"DeleteFlowVersionResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"Deletes a version of a flow.
", + "idempotent":true + }, "DeleteKnowledgeBase":{ "name":"DeleteKnowledgeBase", "http":{ @@ -255,6 +418,26 @@ "documentation":"Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.
", "idempotent":true }, + "DeletePrompt":{ + "name":"DeletePrompt", + "http":{ + "method":"DELETE", + "requestUri":"/prompts/{promptIdentifier}/", + "responseCode":200 + }, + "input":{"shape":"DeletePromptRequest"}, + "output":{"shape":"DeletePromptResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"Deletes a prompt or a prompt version from the Prompt management tool. For more information, see Delete prompts from the Prompt management tool and Delete a version of a prompt from the Prompt management tool in the Amazon Bedrock User Guide.
", + "idempotent":true + }, "DisassociateAgentKnowledgeBase":{ "name":"DisassociateAgentKnowledgeBase", "http":{ @@ -383,6 +566,60 @@ ], "documentation":"Gets information about a data source.
" }, + "GetFlow":{ + "name":"GetFlow", + "http":{ + "method":"GET", + "requestUri":"/flows/{flowIdentifier}/", + "responseCode":200 + }, + "input":{"shape":"GetFlowRequest"}, + "output":{"shape":"GetFlowResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves information about a flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
" + }, + "GetFlowAlias":{ + "name":"GetFlowAlias", + "http":{ + "method":"GET", + "requestUri":"/flows/{flowIdentifier}/aliases/{aliasIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetFlowAliasRequest"}, + "output":{"shape":"GetFlowAliasResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
" + }, + "GetFlowVersion":{ + "name":"GetFlowVersion", + "http":{ + "method":"GET", + "requestUri":"/flows/{flowIdentifier}/versions/{flowVersion}/", + "responseCode":200 + }, + "input":{"shape":"GetFlowVersionRequest"}, + "output":{"shape":"GetFlowVersionResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves information about a version of a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
" + }, "GetIngestionJob":{ "name":"GetIngestionJob", "http":{ @@ -419,6 +656,24 @@ ], "documentation":"Gets information about a knoweldge base.
" }, + "GetPrompt":{ + "name":"GetPrompt", + "http":{ + "method":"GET", + "requestUri":"/prompts/{promptIdentifier}/", + "responseCode":200 + }, + "input":{"shape":"GetPromptRequest"}, + "output":{"shape":"GetPromptResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves information about a prompt or a version of it. For more information, see View information about prompts using Prompt management and View information about a version of your prompt in the Amazon Bedrock User Guide.
" + }, "ListAgentActionGroups":{ "name":"ListAgentActionGroups", "http":{ @@ -526,6 +781,59 @@ ], "documentation":"Lists the data sources in a knowledge base and information about each one.
" }, + "ListFlowAliases":{ + "name":"ListFlowAliases", + "http":{ + "method":"GET", + "requestUri":"/flows/{flowIdentifier}/aliases", + "responseCode":200 + }, + "input":{"shape":"ListFlowAliasesRequest"}, + "output":{"shape":"ListFlowAliasesResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Returns a list of aliases for a flow.
" + }, + "ListFlowVersions":{ + "name":"ListFlowVersions", + "http":{ + "method":"GET", + "requestUri":"/flows/{flowIdentifier}/versions", + "responseCode":200 + }, + "input":{"shape":"ListFlowVersionsRequest"}, + "output":{"shape":"ListFlowVersionsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Returns a list of information about each flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
" + }, + "ListFlows":{ + "name":"ListFlows", + "http":{ + "method":"GET", + "requestUri":"/flows/", + "responseCode":200 + }, + "input":{"shape":"ListFlowsRequest"}, + "output":{"shape":"ListFlowsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Returns a list of flows and information about each flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
" + }, "ListIngestionJobs":{ "name":"ListIngestionJobs", "http":{ @@ -561,6 +869,24 @@ ], "documentation":"Lists the knowledge bases in an account and information about each of them.
" }, + "ListPrompts":{ + "name":"ListPrompts", + "http":{ + "method":"GET", + "requestUri":"/prompts/", + "responseCode":200 + }, + "input":{"shape":"ListPromptsRequest"}, + "output":{"shape":"ListPromptsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Returns a list of prompts from the Prompt management tool and information about each prompt. For more information, see View information about prompts using Prompt management in the Amazon Bedrock User Guide.
" + }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ @@ -599,6 +925,26 @@ ], "documentation":"Creates a DRAFT version of the agent that can be used for internal testing.
Prepares the DRAFT version of a flow so that it can be invoked. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
Updates configurations for a data source.
You can't change the chunkingConfiguration after you create the data source. Specify the existing chunkingConfiguration.
Updates the configurations for a data source connector.
You can't change the chunkingConfiguration after you create the data source connector. Specify the existing chunkingConfiguration.
Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same.
You can change the following fields:
name
description
roleArn
You can't change the knowledgeBaseConfiguration or storageConfiguration fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.
Modifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", "idempotent":true - } - }, - "shapes":{ - "APISchema":{ - "type":"structure", - "members":{ - "payload":{ - "shape":"Payload", - "documentation":"The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
" - }, - "s3":{ - "shape":"S3Identifier", + }, + "UpdateFlowAlias":{ + "name":"UpdateFlowAlias", + "http":{ + "method":"PUT", + "requestUri":"/flows/{flowIdentifier}/aliases/{aliasIdentifier}", + "responseCode":200 + }, + "input":{"shape":"UpdateFlowAliasRequest"}, + "output":{"shape":"UpdateFlowAliasResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Modifies the alias of a flow. Include both fields that you want to keep and ones that you want to change. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "idempotent":true + }, + "UpdateKnowledgeBase":{ + "name":"UpdateKnowledgeBase", + "http":{ + "method":"PUT", + "requestUri":"/knowledgebases/{knowledgeBaseId}", + "responseCode":202 + }, + "input":{"shape":"UpdateKnowledgeBaseRequest"}, + "output":{"shape":"UpdateKnowledgeBaseResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same.
You can change the following fields:
name
description
roleArn
You can't change the knowledgeBaseConfiguration or storageConfiguration fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.
Modifies a prompt in your prompt library. Include both fields that you want to keep and fields that you want to replace. For more information, see Prompt management in Amazon Bedrock and Edit prompts in your prompt library in the Amazon Bedrock User Guide.
", + "idempotent":true + } + }, + "shapes":{ + "APISchema":{ + "type":"structure", + "members":{ + "payload":{ + "shape":"Payload", + "documentation":"The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
" + }, + "s3":{ + "shape":"S3Identifier", "documentation":"Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
" } }, @@ -827,7 +1236,10 @@ }, "ActionGroupSignature":{ "type":"string", - "enum":["AMAZON.UserInput"] + "enum":[ + "AMAZON.UserInput", + "AMAZON.CodeInterpreter" + ] }, "ActionGroupState":{ "type":"string", @@ -938,7 +1350,7 @@ }, "guardrailConfiguration":{ "shape":"GuardrailConfiguration", - "documentation":"The guardrails configuration assigned to the agent.
" + "documentation":"Details about the guardrail associated with the agent.
" }, "idleSessionTTLInSeconds":{ "shape":"SessionTTL", @@ -948,6 +1360,10 @@ "shape":"Instruction", "documentation":"Instructions that tell the agent what it should do and how it should interact with users.
" }, + "memoryConfiguration":{ + "shape":"MemoryConfiguration", + "documentation":"Contains memory configuration for the agent.
" + }, "preparedAt":{ "shape":"DateTimestamp", "documentation":"The time at which the agent was last prepared.
" @@ -1217,6 +1633,17 @@ "min":0, "pattern":"^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$" }, + "AgentFlowNodeConfiguration":{ + "type":"structure", + "required":["agentAliasArn"], + "members":{ + "agentAliasArn":{ + "shape":"AgentAliasArn", + "documentation":"The Amazon Resource Name (ARN) of the alias of the agent to invoke.
" + } + }, + "documentation":"Defines an agent node in your flow. You specify the agent to invoke at this point in the flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + }, "AgentKnowledgeBase":{ "type":"structure", "required":[ @@ -1345,7 +1772,7 @@ }, "guardrailConfiguration":{ "shape":"GuardrailConfiguration", - "documentation":"The details of the guardrails configuration in the agent summary.
" + "documentation":"Details about the guardrail associated with the agent.
" }, "latestAgentVersion":{ "shape":"Version", @@ -1414,7 +1841,7 @@ }, "guardrailConfiguration":{ "shape":"GuardrailConfiguration", - "documentation":"The guardrails configuration assigned to the agent version.
" + "documentation":"Details about the guardrail associated with the agent.
" }, "idleSessionTTLInSeconds":{ "shape":"SessionTTL", @@ -1424,6 +1851,10 @@ "shape":"Instruction", "documentation":"The instructions provided to the agent.
" }, + "memoryConfiguration":{ + "shape":"MemoryConfiguration", + "documentation":"Contains details of the memory configuration on the version of the agent.
" + }, "promptOverrideConfiguration":{ "shape":"PromptOverrideConfiguration", "documentation":"Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
" @@ -1481,7 +1912,7 @@ }, "guardrailConfiguration":{ "shape":"GuardrailConfiguration", - "documentation":"The details of the guardrails configuration in the agent version summary.
" + "documentation":"Details about the guardrail associated with the agent.
" }, "updatedAt":{ "shape":"DateTimestamp", @@ -1538,7 +1969,8 @@ "BasePromptTemplate":{ "type":"string", "max":100000, - "min":1 + "min":1, + "sensitive":true }, "BedrockEmbeddingModelArn":{ "type":"string", @@ -1556,6 +1988,27 @@ }, "documentation":"The vector configuration details for the Bedrock embeddings model.
" }, + "BedrockFoundationModelConfiguration":{ + "type":"structure", + "required":["modelArn"], + "members":{ + "modelArn":{ + "shape":"BedrockModelArn", + "documentation":"The model's ARN.
" + }, + "parsingPrompt":{ + "shape":"ParsingPrompt", + "documentation":"Instructions for interpreting the contents of a document.
" + } + }, + "documentation":"Settings for a foundation model used to parse documents for a data source.
" + }, + "BedrockModelArn":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})$" + }, "Boolean":{ "type":"boolean", "box":true @@ -1572,11 +2025,19 @@ "members":{ "chunkingStrategy":{ "shape":"ChunkingStrategy", - "documentation":"Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.
FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.
NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.
Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.
FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.
HIERARCHICAL – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
SEMANTIC – Split documents into chunks based on groups of similar content derived with natural language processing.
NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.
Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
" + }, + "semanticChunkingConfiguration":{ + "shape":"SemanticChunkingConfiguration", + "documentation":"Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing.
" } }, "documentation":"Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
" @@ -1585,14 +2046,22 @@ "type":"string", "enum":[ "FIXED_SIZE", - "NONE" + "NONE", + "HIERARCHICAL", + "SEMANTIC" ] }, "ClientToken":{ "type":"string", "max":256, "min":33, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}$" + }, + "CollectorFlowNodeConfiguration":{ + "type":"structure", + "members":{ + }, + "documentation":"Defines a collector node in your flow. This node takes an iteration of inputs and consolidates them into an array in the output. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" }, "ColumnName":{ "type":"string", @@ -1600,6 +2069,17 @@ "min":0, "pattern":"^[a-zA-Z0-9_\\-]+$" }, + "ConditionFlowNodeConfiguration":{ + "type":"structure", + "required":["conditions"], + "members":{ + "conditions":{ + "shape":"FlowConditions", + "documentation":"An array of conditions. Each member contains the name of a condition and an expression that defines the condition.
" + } + }, + "documentation":"Defines a condition node in your flow. You can specify conditions that determine which node comes next in the flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + }, "ConflictException":{ "type":"structure", "members":{ @@ -1612,6 +2092,89 @@ }, "exception":true }, + "ConfluenceAuthType":{ + "type":"string", + "enum":[ + "BASIC", + "OAUTH2_CLIENT_CREDENTIALS" + ] + }, + "ConfluenceCrawlerConfiguration":{ + "type":"structure", + "members":{ + "filterConfiguration":{ + "shape":"CrawlFilterConfiguration", + "documentation":"The configuration of filtering the Confluence content. For example, configuring regular expression patterns to include or exclude certain content.
" + } + }, + "documentation":"The configuration of the Confluence content. For example, configuring specific types of Confluence content.
" + }, + "ConfluenceDataSourceConfiguration":{ + "type":"structure", + "required":["sourceConfiguration"], + "members":{ + "crawlerConfiguration":{ + "shape":"ConfluenceCrawlerConfiguration", + "documentation":"The configuration of the Confluence content. For example, configuring specific types of Confluence content.
" + }, + "sourceConfiguration":{ + "shape":"ConfluenceSourceConfiguration", + "documentation":"The endpoint information to connect to your Confluence data source.
" + } + }, + "documentation":"The configuration information to connect to Confluence as your data source.
" + }, + "ConfluenceHostType":{ + "type":"string", + "enum":["SAAS"] + }, + "ConfluenceSourceConfiguration":{ + "type":"structure", + "required":[ + "authType", + "credentialsSecretArn", + "hostType", + "hostUrl" + ], + "members":{ + "authType":{ + "shape":"ConfluenceAuthType", + "documentation":"The supported authentication type to authenticate and connect to your Confluence instance.
" + }, + "credentialsSecretArn":{ + "shape":"SecretArn", + "documentation":"The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see Confluence connection configuration.
" + }, + "hostType":{ + "shape":"ConfluenceHostType", + "documentation":"The supported host type, whether online/cloud or server/on-premises.
" + }, + "hostUrl":{ + "shape":"HttpsUrl", + "documentation":"The Confluence host URL or instance URL.
" + } + }, + "documentation":"The endpoint information to connect to your Confluence data source.
" + }, + "CrawlFilterConfiguration":{ + "type":"structure", + "required":["type"], + "members":{ + "patternObjectFilter":{ + "shape":"PatternObjectFilterConfiguration", + "documentation":"The configuration of filtering certain objects or content types of the data source.
" + }, + "type":{ + "shape":"CrawlFilterConfigurationType", + "documentation":"The type of filtering that you want to apply to certain objects or content of the data source. For example, the PATTERN type is regular expression patterns you can apply to filter your content.
The configuration of filtering the data source content. For example, configuring regular expression patterns to include or exclude certain content.
" + }, + "CrawlFilterConfigurationType":{ + "type":"string", + "enum":["PATTERN"] + }, "CreateAgentActionGroupRequest":{ "type":"structure", "required":[ @@ -1663,7 +2226,7 @@ }, "parentActionGroupSignature":{ "shape":"ActionGroupSignature", - "documentation":"To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.
During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
" + "documentation":"To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.
During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
" } } }, @@ -1764,6 +2327,10 @@ "shape":"Instruction", "documentation":"Instructions that tell the agent what it should do and how it should interact with users.
" }, + "memoryConfiguration":{ + "shape":"MemoryConfiguration", + "documentation":"Contains the details of the memory configured for the agent.
" + }, "promptOverrideConfiguration":{ "shape":"PromptOverrideConfiguration", "documentation":"Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
" @@ -1799,11 +2366,11 @@ }, "dataDeletionPolicy":{ "shape":"DataDeletionPolicy", - "documentation":"The data deletion policy assigned to the data source.
" + "documentation":"The data deletion policy for the data source.
You can set the data deletion policy to:
DELETE: Deletes all underlying data belonging to the data source from the vector store upon deletion of a knowledge base or data source resource. Note that the vector store itself is not deleted, only the underlying data. This flag is ignored if an Amazon Web Services account is deleted.
RETAIN: Retains all underlying data in your vector store upon deletion of a knowledge base or data source resource.
Contains metadata about where the data source is stored.
" + "documentation":"The connection configuration for the data source.
" }, "description":{ "shape":"Description", @@ -1839,13 +2406,12 @@ } } }, - "CreateKnowledgeBaseRequest":{ + "CreateFlowAliasRequest":{ "type":"structure", "required":[ - "knowledgeBaseConfiguration", + "flowIdentifier", "name", - "roleArn", - "storageConfiguration" + "routingConfiguration" ], "members":{ "clientToken":{ @@ -1855,536 +2421,1735 @@ }, "description":{ "shape":"Description", - "documentation":"A description of the knowledge base.
" + "documentation":"A description for the alias.
" }, - "knowledgeBaseConfiguration":{ - "shape":"KnowledgeBaseConfiguration", - "documentation":"Contains details about the embeddings model used for the knowledge base.
" + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow for which to create an alias.
", + "location":"uri", + "locationName":"flowIdentifier" }, "name":{ "shape":"Name", - "documentation":"A name for the knowledge base.
" - }, - "roleArn":{ - "shape":"KnowledgeBaseRoleArn", - "documentation":"The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
" + "documentation":"A name for the alias.
" }, - "storageConfiguration":{ - "shape":"StorageConfiguration", - "documentation":"Contains details about the configuration of the vector database used for the knowledge base.
" + "routingConfiguration":{ + "shape":"FlowAliasRoutingConfiguration", + "documentation":"Contains information about the version to which to map the alias.
" }, "tags":{ "shape":"TagsMap", - "documentation":"Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.
" - } - } - }, - "CreateKnowledgeBaseResponse":{ - "type":"structure", - "required":["knowledgeBase"], - "members":{ - "knowledgeBase":{ - "shape":"KnowledgeBase", - "documentation":"Contains details about the knowledge base.
" + "documentation":"Any tags that you want to attach to the alias of the flow. For more information, see Tagging resources in Amazon Bedrock.
" } } }, - "CreationMode":{ - "type":"string", - "enum":[ - "DEFAULT", - "OVERRIDDEN" - ] - }, - "CustomControlMethod":{ - "type":"string", - "enum":["RETURN_CONTROL"] - }, - "DataDeletionPolicy":{ - "type":"string", - "enum":[ - "RETAIN", - "DELETE" - ] - }, - "DataSource":{ + "CreateFlowAliasResponse":{ "type":"structure", "required":[ + "arn", "createdAt", - "dataSourceConfiguration", - "dataSourceId", - "knowledgeBaseId", + "flowId", + "id", "name", - "status", + "routingConfiguration", "updatedAt" ], "members":{ + "arn":{ + "shape":"FlowAliasArn", + "documentation":"The Amazon Resource Name (ARN) of the alias.
" + }, "createdAt":{ "shape":"DateTimestamp", - "documentation":"The time at which the data source was created.
" - }, - "dataDeletionPolicy":{ - "shape":"DataDeletionPolicy", - "documentation":"The data deletion policy for a data source.
" - }, - "dataSourceConfiguration":{ - "shape":"DataSourceConfiguration", - "documentation":"Contains details about how the data source is stored.
" - }, - "dataSourceId":{ - "shape":"Id", - "documentation":"The unique identifier of the data source.
" + "documentation":"The time at which the alias was created.
" }, "description":{ "shape":"Description", - "documentation":"The description of the data source.
" + "documentation":"The description of the alias.
" }, - "failureReasons":{ - "shape":"FailureReasons", - "documentation":"The detailed reasons on the failure to delete a data source.
" + "flowId":{ + "shape":"FlowId", + "documentation":"The unique identifier of the flow that the alias belongs to.
" }, - "knowledgeBaseId":{ - "shape":"Id", - "documentation":"The unique identifier of the knowledge base to which the data source belongs.
" + "id":{ + "shape":"FlowAliasId", + "documentation":"The unique identifier of the alias.
" }, "name":{ "shape":"Name", - "documentation":"The name of the data source.
" - }, - "serverSideEncryptionConfiguration":{ - "shape":"ServerSideEncryptionConfiguration", - "documentation":"Contains details about the configuration of the server-side encryption.
" + "documentation":"The name of the alias.
" }, - "status":{ - "shape":"DataSourceStatus", - "documentation":"The status of the data source. The following statuses are possible:
Available – The data source has been created and is ready for ingestion into the knowledge base.
Deleting – The data source is being deleted.
Contains information about the version that the alias is mapped to.
" }, "updatedAt":{ "shape":"DateTimestamp", - "documentation":"The time at which the data source was last updated.
" - }, - "vectorIngestionConfiguration":{ - "shape":"VectorIngestionConfiguration", - "documentation":"Contains details about how to ingest the documents in the data source.
" + "documentation":"The time at which the alias of the flow was last updated.
" } - }, - "documentation":"Contains details about a data source.
" + } }, - "DataSourceConfiguration":{ + "CreateFlowRequest":{ "type":"structure", - "required":["type"], + "required":[ + "executionRoleArn", + "name" + ], "members":{ - "s3Configuration":{ - "shape":"S3DataSourceConfiguration", - "documentation":"Contains details about the configuration of the S3 object containing the data source.
" + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "idempotencyToken":true }, - "type":{ - "shape":"DataSourceType", - "documentation":"The type of storage for the data source.
" + "customerEncryptionKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.
" + }, + "definition":{ + "shape":"FlowDefinition", + "documentation":"A definition of the nodes and connections between nodes in the flow.
" + }, + "description":{ + "shape":"FlowDescription", + "documentation":"A description for the flow.
" + }, + "executionRoleArn":{ + "shape":"FlowExecutionRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
" + }, + "name":{ + "shape":"FlowName", + "documentation":"A name for the flow.
" + }, + "tags":{ + "shape":"TagsMap", + "documentation":"Any tags that you want to attach to the flow. For more information, see Tagging resources in Amazon Bedrock.
" } - }, - "documentation":"Contains details about how a data source is stored.
" + } }, - "DataSourceStatus":{ - "type":"string", - "enum":[ - "AVAILABLE", - "DELETING", - "DELETE_UNSUCCESSFUL" - ] - }, - "DataSourceSummaries":{ - "type":"list", - "member":{"shape":"DataSourceSummary"} - }, - "DataSourceSummary":{ + "CreateFlowResponse":{ "type":"structure", "required":[ - "dataSourceId", - "knowledgeBaseId", + "arn", + "createdAt", + "executionRoleArn", + "id", "name", "status", - "updatedAt" + "updatedAt", + "version" ], "members":{ - "dataSourceId":{ - "shape":"Id", - "documentation":"The unique identifier of the data source.
" + "arn":{ + "shape":"FlowArn", + "documentation":"The Amazon Resource Name (ARN) of the flow.
" + }, + "createdAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the flow was created.
" + }, + "customerEncryptionKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the KMS key that you encrypted the flow with.
" + }, + "definition":{ + "shape":"FlowDefinition", + "documentation":"A definition of the nodes and connections between nodes in the flow.
" }, "description":{ - "shape":"Description", - "documentation":"The description of the data source.
" + "shape":"FlowDescription", + "documentation":"The description of the flow.
" }, - "knowledgeBaseId":{ - "shape":"Id", - "documentation":"The unique identifier of the knowledge base to which the data source belongs.
" + "executionRoleArn":{ + "shape":"FlowExecutionRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
" + }, + "id":{ + "shape":"FlowId", + "documentation":"The unique identifier of the flow.
" }, "name":{ - "shape":"Name", - "documentation":"The name of the data source.
" + "shape":"FlowName", + "documentation":"The name of the flow.
" }, "status":{ - "shape":"DataSourceStatus", - "documentation":"The status of the data source.
" + "shape":"FlowStatus", + "documentation":"The status of the flow. When you submit this request, the status will be NotPrepared. If creation fails, the status becomes Failed.
The time at which the data source was last updated.
" + "documentation":"The time at which the flow was last updated.
" + }, + "version":{ + "shape":"DraftVersion", + "documentation":"The version of the flow. When you create a flow, the version created is the DRAFT version.
Contains details about a data source.
" - }, - "DataSourceType":{ - "type":"string", - "enum":["S3"] - }, - "DateTimestamp":{ - "type":"timestamp", - "timestampFormat":"iso8601" + } }, - "DeleteAgentActionGroupRequest":{ + "CreateFlowVersionRequest":{ "type":"structure", - "required":[ - "actionGroupId", - "agentId", - "agentVersion" - ], + "required":["flowIdentifier"], "members":{ - "actionGroupId":{ - "shape":"Id", - "documentation":"The unique identifier of the action group to delete.
", - "location":"uri", - "locationName":"actionGroupId" + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "idempotencyToken":true }, - "agentId":{ - "shape":"Id", - "documentation":"The unique identifier of the agent that the action group belongs to.
", - "location":"uri", - "locationName":"agentId" + "description":{ + "shape":"FlowDescription", + "documentation":"A description of the version of the flow.
" }, - "agentVersion":{ - "shape":"DraftVersion", - "documentation":"The version of the agent that the action group belongs to.
", + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow that you want to create a version of.
", "location":"uri", - "locationName":"agentVersion" - }, - "skipResourceInUseCheck":{ - "shape":"Boolean", - "documentation":"By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
The unique identifier of the alias to delete.
", - "location":"uri", - "locationName":"agentAliasId" + "arn":{ + "shape":"FlowArn", + "documentation":"The Amazon Resource Name (ARN) of the flow.
" }, - "agentId":{ - "shape":"Id", - "documentation":"The unique identifier of the agent that the alias belongs to.
", - "location":"uri", - "locationName":"agentId" + "createdAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the flow was created.
" + }, + "customerEncryptionKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The KMS key that the flow is encrypted with.
" + }, + "definition":{ + "shape":"FlowDefinition", + "documentation":"A definition of the nodes and connections in the flow.
" + }, + "description":{ + "shape":"FlowDescription", + "documentation":"The description of the flow version.
" + }, + "executionRoleArn":{ + "shape":"FlowExecutionRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
" + }, + "id":{ + "shape":"FlowId", + "documentation":"The unique identifier of the flow.
" + }, + "name":{ + "shape":"FlowName", + "documentation":"The name of the flow version.
" + }, + "status":{ + "shape":"FlowStatus", + "documentation":"The status of the flow.
" + }, + "version":{ + "shape":"NumericalVersion", + "documentation":"The version of the flow that was created. Versions are numbered incrementally, starting from 1.
" } } }, - "DeleteAgentAliasResponse":{ + "CreateKnowledgeBaseRequest":{ "type":"structure", "required":[ - "agentAliasId", - "agentAliasStatus", - "agentId" + "knowledgeBaseConfiguration", + "name", + "roleArn", + "storageConfiguration" ], "members":{ - "agentAliasId":{ - "shape":"AgentAliasId", - "documentation":"The unique identifier of the alias that was deleted.
" + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "idempotencyToken":true }, - "agentAliasStatus":{ - "shape":"AgentAliasStatus", - "documentation":"The status of the alias.
" + "description":{ + "shape":"Description", + "documentation":"A description of the knowledge base.
" }, - "agentId":{ - "shape":"Id", - "documentation":"The unique identifier of the agent that the alias belongs to.
" + "knowledgeBaseConfiguration":{ + "shape":"KnowledgeBaseConfiguration", + "documentation":"Contains details about the embeddings model used for the knowledge base.
" + }, + "name":{ + "shape":"Name", + "documentation":"A name for the knowledge base.
" + }, + "roleArn":{ + "shape":"KnowledgeBaseRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
" + }, + "storageConfiguration":{ + "shape":"StorageConfiguration", + "documentation":"Contains details about the configuration of the vector database used for the knowledge base.
" + }, + "tags":{ + "shape":"TagsMap", + "documentation":"Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.
" } } }, - "DeleteAgentRequest":{ + "CreateKnowledgeBaseResponse":{ "type":"structure", - "required":["agentId"], + "required":["knowledgeBase"], "members":{ - "agentId":{ - "shape":"Id", - "documentation":"The unique identifier of the agent to delete.
", - "location":"uri", - "locationName":"agentId" - }, - "skipResourceInUseCheck":{ - "shape":"Boolean", - "documentation":"By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
Contains details about the knowledge base.
" } } }, - "DeleteAgentResponse":{ + "CreatePromptRequest":{ "type":"structure", - "required":[ - "agentId", - "agentStatus" - ], + "required":["name"], "members":{ - "agentId":{ - "shape":"Id", - "documentation":"The unique identifier of the agent that was deleted.
" + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "idempotencyToken":true }, - "agentStatus":{ - "shape":"AgentStatus", - "documentation":"The status of the agent.
" + "customerEncryptionKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
" + }, + "defaultVariant":{ + "shape":"PromptVariantName", + "documentation":"The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
A description for the prompt.
" + }, + "name":{ + "shape":"PromptName", + "documentation":"A name for the prompt.
" + }, + "tags":{ + "shape":"TagsMap", + "documentation":"Any tags that you want to attach to the prompt. For more information, see Tagging resources in Amazon Bedrock.
" + }, + "variants":{ + "shape":"PromptVariantList", + "documentation":"A list of objects, each containing details about a variant of the prompt.
" } } }, - "DeleteAgentVersionRequest":{ + "CreatePromptResponse":{ "type":"structure", "required":[ - "agentId", - "agentVersion" + "arn", + "createdAt", + "id", + "name", + "updatedAt", + "version" ], "members":{ - "agentId":{ - "shape":"Id", - "documentation":"The unique identifier of the agent that the version belongs to.
", - "location":"uri", - "locationName":"agentId" + "arn":{ + "shape":"PromptArn", + "documentation":"The Amazon Resource Name (ARN) of the prompt.
" }, - "agentVersion":{ - "shape":"NumericalVersion", - "documentation":"The version of the agent to delete.
", - "location":"uri", - "locationName":"agentVersion" + "createdAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the prompt was created.
" }, - "skipResourceInUseCheck":{ - "shape":"Boolean", - "documentation":"By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
The Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
" + }, + "defaultVariant":{ + "shape":"PromptVariantName", + "documentation":"The name of the default variant for your prompt.
" + }, + "description":{ + "shape":"PromptDescription", + "documentation":"The description of the prompt.
" + }, + "id":{ + "shape":"PromptId", + "documentation":"The unique identifier of the prompt.
" + }, + "name":{ + "shape":"PromptName", + "documentation":"The name of the prompt.
" + }, + "updatedAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the prompt was last updated.
" + }, + "variants":{ + "shape":"PromptVariantList", + "documentation":"A list of objects, each containing details about a variant of the prompt.
" + }, + "version":{ + "shape":"Version", + "documentation":"The version of the prompt. When you create a prompt, the version created is the DRAFT version.
The unique identifier of the agent that the version belongs to.
" + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "idempotencyToken":true }, - "agentStatus":{ - "shape":"AgentStatus", - "documentation":"The status of the agent version.
" + "description":{ + "shape":"PromptDescription", + "documentation":"A description for the version of the prompt.
" }, - "agentVersion":{ - "shape":"NumericalVersion", - "documentation":"The version that was deleted.
" + "promptIdentifier":{ + "shape":"PromptIdentifier", + "documentation":"The unique identifier of the prompt that you want to create a version of.
", + "location":"uri", + "locationName":"promptIdentifier" + }, + "tags":{ + "shape":"TagsMap", + "documentation":"Any tags that you want to attach to the version of the prompt. For more information, see Tagging resources in Amazon Bedrock.
" } } }, - "DeleteDataSourceRequest":{ + "CreatePromptVersionResponse":{ "type":"structure", "required":[ - "dataSourceId", - "knowledgeBaseId" + "arn", + "createdAt", + "id", + "name", + "updatedAt", + "version" ], "members":{ - "dataSourceId":{ - "shape":"Id", - "documentation":"The unique identifier of the data source to delete.
", - "location":"uri", - "locationName":"dataSourceId" + "arn":{ + "shape":"PromptArn", + "documentation":"The Amazon Resource Name (ARN) of the version of the prompt.
" }, - "knowledgeBaseId":{ - "shape":"Id", - "documentation":"The unique identifier of the knowledge base from which to delete the data source.
", - "location":"uri", - "locationName":"knowledgeBaseId" + "createdAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the prompt was created.
" + }, + "customerEncryptionKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the KMS key to encrypt the version of the prompt.
" + }, + "defaultVariant":{ + "shape":"PromptVariantName", + "documentation":"The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
A description for the prompt version.
" + }, + "id":{ + "shape":"PromptId", + "documentation":"The unique identifier of the prompt.
" + }, + "name":{ + "shape":"PromptName", + "documentation":"The name of the prompt version.
" + }, + "updatedAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the prompt was last updated.
" + }, + "variants":{ + "shape":"PromptVariantList", + "documentation":"A list of objects, each containing details about a variant of the prompt.
" + }, + "version":{ + "shape":"Version", + "documentation":"The version of the prompt that was created. Versions are numbered incrementally, starting from 1.
" } } }, - "DeleteDataSourceResponse":{ + "CreationMode":{ + "type":"string", + "enum":[ + "DEFAULT", + "OVERRIDDEN" + ] + }, + "CustomControlMethod":{ + "type":"string", + "enum":["RETURN_CONTROL"] + }, + "CustomTransformationConfiguration":{ + "type":"structure", + "required":[ + "intermediateStorage", + "transformations" + ], + "members":{ + "intermediateStorage":{ + "shape":"IntermediateStorage", + "documentation":"An S3 bucket path for input and output objects.
" + }, + "transformations":{ + "shape":"Transformations", + "documentation":"A Lambda function that processes documents.
" + } + }, + "documentation":"Settings for customizing steps in the data source content ingestion pipeline.
You can configure the data source to process documents with a Lambda function after they are parsed and converted into chunks. When you add a post-chunking transformation, the service stores chunked documents in an S3 bucket and invokes a Lambda function to process them.
To process chunked documents with a Lambda function, define an S3 bucket path for input and output objects, and a transformation that specifies the Lambda function to invoke. You can use the Lambda function to customize how chunks are split, and the metadata for each chunk.
" + }, + "DataDeletionPolicy":{ + "type":"string", + "enum":[ + "RETAIN", + "DELETE" + ] + }, + "DataSource":{ "type":"structure", "required":[ + "createdAt", + "dataSourceConfiguration", "dataSourceId", "knowledgeBaseId", - "status" + "name", + "status", + "updatedAt" ], "members":{ + "createdAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the data source was created.
" + }, + "dataDeletionPolicy":{ + "shape":"DataDeletionPolicy", + "documentation":"The data deletion policy for the data source.
" + }, + "dataSourceConfiguration":{ + "shape":"DataSourceConfiguration", + "documentation":"The connection configuration for the data source.
" + }, "dataSourceId":{ "shape":"Id", - "documentation":"The unique identifier of the data source that was deleted.
" + "documentation":"The unique identifier of the data source.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the data source.
" + }, + "failureReasons":{ + "shape":"FailureReasons", + "documentation":"The detailed reasons on the failure to delete a data source.
" }, "knowledgeBaseId":{ "shape":"Id", - "documentation":"The unique identifier of the knowledge base to which the data source that was deleted belonged.
" + "documentation":"The unique identifier of the knowledge base to which the data source belongs.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the data source.
" + }, + "serverSideEncryptionConfiguration":{ + "shape":"ServerSideEncryptionConfiguration", + "documentation":"Contains details about the configuration of the server-side encryption.
" }, "status":{ "shape":"DataSourceStatus", - "documentation":"The status of the data source.
" + "documentation":"The status of the data source. The following statuses are possible:
Available – The data source has been created and is ready for ingestion into the knowledge base.
Deleting – The data source is being deleted.
The time at which the data source was last updated.
" + }, + "vectorIngestionConfiguration":{ + "shape":"VectorIngestionConfiguration", + "documentation":"Contains details about how to ingest the documents in the data source.
" } - } + }, + "documentation":"Contains details about a data source.
" }, - "DeleteKnowledgeBaseRequest":{ + "DataSourceConfiguration":{ "type":"structure", - "required":["knowledgeBaseId"], + "required":["type"], "members":{ - "knowledgeBaseId":{ - "shape":"Id", - "documentation":"The unique identifier of the knowledge base to delete.
", - "location":"uri", - "locationName":"knowledgeBaseId" + "confluenceConfiguration":{ + "shape":"ConfluenceDataSourceConfiguration", + "documentation":"The configuration information to connect to Confluence as your data source.
Confluence data source connector is in preview release and is subject to change.
The configuration information to connect to Amazon S3 as your data source.
" + }, + "salesforceConfiguration":{ + "shape":"SalesforceDataSourceConfiguration", + "documentation":"The configuration information to connect to Salesforce as your data source.
Salesforce data source connector is in preview release and is subject to change.
The configuration information to connect to SharePoint as your data source.
SharePoint data source connector is in preview release and is subject to change.
The type of data source.
" + }, + "webConfiguration":{ + "shape":"WebDataSourceConfiguration", + "documentation":"The configuration of web URLs to crawl for your data source. You should be authorized to crawl the URLs.
Crawling web URLs as your data source is in preview release and is subject to change.
The connection configuration for the data source.
" }, - "DeleteKnowledgeBaseResponse":{ + "DataSourceStatus":{ + "type":"string", + "enum":[ + "AVAILABLE", + "DELETING", + "DELETE_UNSUCCESSFUL" + ] + }, + "DataSourceSummaries":{ + "type":"list", + "member":{"shape":"DataSourceSummary"} + }, + "DataSourceSummary":{ "type":"structure", "required":[ + "dataSourceId", "knowledgeBaseId", - "status" + "name", + "status", + "updatedAt" ], "members":{ + "dataSourceId":{ + "shape":"Id", + "documentation":"The unique identifier of the data source.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the data source.
" + }, "knowledgeBaseId":{ "shape":"Id", - "documentation":"The unique identifier of the knowledge base that was deleted.
" + "documentation":"The unique identifier of the knowledge base to which the data source belongs.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the data source.
" }, "status":{ - "shape":"KnowledgeBaseStatus", - "documentation":"The status of the knowledge base and whether it has been successfully deleted.
" + "shape":"DataSourceStatus", + "documentation":"The status of the data source.
" + }, + "updatedAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the data source was last updated.
" } - } + }, + "documentation":"Contains details about a data source.
" }, - "Description":{ + "DataSourceType":{ "type":"string", - "max":200, - "min":1 + "enum":[ + "S3", + "WEB", + "CONFLUENCE", + "SALESFORCE", + "SHAREPOINT" + ] }, - "Dimensions":{ - "type":"integer", - "box":true, - "max":4096, - "min":0 + "DateTimestamp":{ + "type":"timestamp", + "timestampFormat":"iso8601" }, - "DisassociateAgentKnowledgeBaseRequest":{ + "DeleteAgentActionGroupRequest":{ "type":"structure", "required":[ + "actionGroupId", "agentId", - "agentVersion", - "knowledgeBaseId" + "agentVersion" ], "members":{ + "actionGroupId":{ + "shape":"Id", + "documentation":"The unique identifier of the action group to delete.
", + "location":"uri", + "locationName":"actionGroupId" + }, "agentId":{ "shape":"Id", - "documentation":"The unique identifier of the agent from which to disassociate the knowledge base.
", + "documentation":"The unique identifier of the agent that the action group belongs to.
", "location":"uri", "locationName":"agentId" }, "agentVersion":{ "shape":"DraftVersion", - "documentation":"The version of the agent from which to disassociate the knowledge base.
", + "documentation":"The version of the agent that the action group belongs to.
", "location":"uri", "locationName":"agentVersion" }, - "knowledgeBaseId":{ - "shape":"Id", - "documentation":"The unique identifier of the knowledge base to disassociate.
", - "location":"uri", - "locationName":"knowledgeBaseId" + "skipResourceInUseCheck":{ + "shape":"Boolean", + "documentation":"By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
The vector configuration details on the Bedrock embeddings model.
" + "agentAliasId":{ + "shape":"AgentAliasId", + "documentation":"The unique identifier of the alias to delete.
", + "location":"uri", + "locationName":"agentAliasId" + }, + "agentId":{ + "shape":"Id", + "documentation":"The unique identifier of the agent that the alias belongs to.
", + "location":"uri", + "locationName":"agentId" + } + } + }, + "DeleteAgentAliasResponse":{ + "type":"structure", + "required":[ + "agentAliasId", + "agentAliasStatus", + "agentId" + ], + "members":{ + "agentAliasId":{ + "shape":"AgentAliasId", + "documentation":"The unique identifier of the alias that was deleted.
" + }, + "agentAliasStatus":{ + "shape":"AgentAliasStatus", + "documentation":"The status of the alias.
" + }, + "agentId":{ + "shape":"Id", + "documentation":"The unique identifier of the agent that the alias belongs to.
" + } + } + }, + "DeleteAgentRequest":{ + "type":"structure", + "required":["agentId"], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"The unique identifier of the agent to delete.
", + "location":"uri", + "locationName":"agentId" + }, + "skipResourceInUseCheck":{ + "shape":"Boolean", + "documentation":"By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
The unique identifier of the agent that was deleted.
" + }, + "agentStatus":{ + "shape":"AgentStatus", + "documentation":"The status of the agent.
" + } + } + }, + "DeleteAgentVersionRequest":{ + "type":"structure", + "required":[ + "agentId", + "agentVersion" + ], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"The unique identifier of the agent that the version belongs to.
", + "location":"uri", + "locationName":"agentId" + }, + "agentVersion":{ + "shape":"NumericalVersion", + "documentation":"The version of the agent to delete.
", + "location":"uri", + "locationName":"agentVersion" + }, + "skipResourceInUseCheck":{ + "shape":"Boolean", + "documentation":"By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
The unique identifier of the agent that the version belongs to.
" + }, + "agentStatus":{ + "shape":"AgentStatus", + "documentation":"The status of the agent version.
" + }, + "agentVersion":{ + "shape":"NumericalVersion", + "documentation":"The version that was deleted.
" + } + } + }, + "DeleteDataSourceRequest":{ + "type":"structure", + "required":[ + "dataSourceId", + "knowledgeBaseId" + ], + "members":{ + "dataSourceId":{ + "shape":"Id", + "documentation":"The unique identifier of the data source to delete.
", + "location":"uri", + "locationName":"dataSourceId" + }, + "knowledgeBaseId":{ + "shape":"Id", + "documentation":"The unique identifier of the knowledge base from which to delete the data source.
", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "DeleteDataSourceResponse":{ + "type":"structure", + "required":[ + "dataSourceId", + "knowledgeBaseId", + "status" + ], + "members":{ + "dataSourceId":{ + "shape":"Id", + "documentation":"The unique identifier of the data source that was deleted.
" + }, + "knowledgeBaseId":{ + "shape":"Id", + "documentation":"The unique identifier of the knowledge base to which the data source that was deleted belonged.
" + }, + "status":{ + "shape":"DataSourceStatus", + "documentation":"The status of the data source.
" + } + } + }, + "DeleteFlowAliasRequest":{ + "type":"structure", + "required":[ + "aliasIdentifier", + "flowIdentifier" + ], + "members":{ + "aliasIdentifier":{ + "shape":"FlowAliasIdentifier", + "documentation":"The unique identifier of the alias to be deleted.
", + "location":"uri", + "locationName":"aliasIdentifier" + }, + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow that the alias belongs to.
", + "location":"uri", + "locationName":"flowIdentifier" + } + } + }, + "DeleteFlowAliasResponse":{ + "type":"structure", + "required":[ + "flowId", + "id" + ], + "members":{ + "flowId":{ + "shape":"FlowId", + "documentation":"The unique identifier of the flow that the alias belongs to.
" + }, + "id":{ + "shape":"FlowAliasId", + "documentation":"The unique identifier of the flow.
" + } + } + }, + "DeleteFlowRequest":{ + "type":"structure", + "required":["flowIdentifier"], + "members":{ + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow.
", + "location":"uri", + "locationName":"flowIdentifier" + }, + "skipResourceInUseCheck":{ + "shape":"Boolean", + "documentation":"By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
The unique identifier of the flow.
" + } + } + }, + "DeleteFlowVersionRequest":{ + "type":"structure", + "required":[ + "flowIdentifier", + "flowVersion" + ], + "members":{ + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow whose version that you want to delete
", + "location":"uri", + "locationName":"flowIdentifier" + }, + "flowVersion":{ + "shape":"NumericalVersion", + "documentation":"The version of the flow that you want to delete.
", + "location":"uri", + "locationName":"flowVersion" + }, + "skipResourceInUseCheck":{ + "shape":"Boolean", + "documentation":"By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
The unique identifier of the flow.
" + }, + "version":{ + "shape":"NumericalVersion", + "documentation":"The version of the flow being deleted.
" + } + } + }, + "DeleteKnowledgeBaseRequest":{ + "type":"structure", + "required":["knowledgeBaseId"], + "members":{ + "knowledgeBaseId":{ + "shape":"Id", + "documentation":"The unique identifier of the knowledge base to delete.
", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "DeleteKnowledgeBaseResponse":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "status" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"Id", + "documentation":"The unique identifier of the knowledge base that was deleted.
" + }, + "status":{ + "shape":"KnowledgeBaseStatus", + "documentation":"The status of the knowledge base and whether it has been successfully deleted.
" + } + } + }, + "DeletePromptRequest":{ + "type":"structure", + "required":["promptIdentifier"], + "members":{ + "promptIdentifier":{ + "shape":"PromptIdentifier", + "documentation":"The unique identifier of the prompt.
", + "location":"uri", + "locationName":"promptIdentifier" + }, + "promptVersion":{ + "shape":"NumericalVersion", + "documentation":"The version of the prompt to delete.
", + "location":"querystring", + "locationName":"promptVersion" + } + } + }, + "DeletePromptResponse":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"PromptId", + "documentation":"The unique identifier of the prompt that was deleted.
" + }, + "version":{ + "shape":"NumericalVersion", + "documentation":"The version of the prompt that was deleted.
" + } + } + }, + "Description":{ + "type":"string", + "max":200, + "min":1 + }, + "Dimensions":{ + "type":"integer", + "box":true, + "max":4096, + "min":0 + }, + "DisassociateAgentKnowledgeBaseRequest":{ + "type":"structure", + "required":[ + "agentId", + "agentVersion", + "knowledgeBaseId" + ], + "members":{ + "agentId":{ + "shape":"Id", + "documentation":"The unique identifier of the agent from which to disassociate the knowledge base.
", + "location":"uri", + "locationName":"agentId" + }, + "agentVersion":{ + "shape":"DraftVersion", + "documentation":"The version of the agent from which to disassociate the knowledge base.
", + "location":"uri", + "locationName":"agentVersion" + }, + "knowledgeBaseId":{ + "shape":"Id", + "documentation":"The unique identifier of the knowledge base to disassociate.
", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "DisassociateAgentKnowledgeBaseResponse":{ + "type":"structure", + "members":{ + } + }, + "DraftVersion":{ + "type":"string", + "max":5, + "min":5, + "pattern":"^DRAFT$" + }, + "EmbeddingModelConfiguration":{ + "type":"structure", + "members":{ + "bedrockEmbeddingModelConfiguration":{ + "shape":"BedrockEmbeddingModelConfiguration", + "documentation":"The vector configuration details on the Bedrock embeddings model.
" + } + }, + "documentation":"The configuration details for the embeddings model.
" + }, + "EnabledMemoryTypes":{ + "type":"list", + "member":{"shape":"MemoryType"}, + "max":1, + "min":1 + }, + "FailureReason":{ + "type":"string", + "max":2048, + "min":0 + }, + "FailureReasons":{ + "type":"list", + "member":{"shape":"FailureReason"}, + "max":2048, + "min":0 + }, + "FieldName":{ + "type":"string", + "max":2048, + "min":0, + "pattern":"^.*$" + }, + "FilterList":{ + "type":"list", + "member":{"shape":"FilterPattern"}, + "max":25, + "min":1, + "sensitive":true + }, + "FilterPattern":{ + "type":"string", + "max":1000, + "min":1, + "sensitive":true + }, + "FilteredObjectType":{ + "type":"string", + "max":50, + "min":1, + "sensitive":true + }, + "FixedSizeChunkingConfiguration":{ + "type":"structure", + "required":[ + "maxTokens", + "overlapPercentage" + ], + "members":{ + "maxTokens":{ + "shape":"FixedSizeChunkingConfigurationMaxTokensInteger", + "documentation":"The maximum number of tokens to include in a chunk.
" + }, + "overlapPercentage":{ + "shape":"FixedSizeChunkingConfigurationOverlapPercentageInteger", + "documentation":"The percentage of overlap between adjacent chunks of a data source.
" + } + }, + "documentation":"Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
The version that the alias maps to.
" + } + }, + "documentation":"Contains information about a version that the alias maps to.
" + }, + "FlowAliasSummaries":{ + "type":"list", + "member":{"shape":"FlowAliasSummary"}, + "max":10, + "min":0 + }, + "FlowAliasSummary":{ + "type":"structure", + "required":[ + "arn", + "createdAt", + "flowId", + "id", + "name", + "routingConfiguration", + "updatedAt" + ], + "members":{ + "arn":{ + "shape":"FlowAliasArn", + "documentation":"The Amazon Resource Name (ARN) of the flow alias.
" + }, + "createdAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the alias was created.
" + }, + "description":{ + "shape":"Description", + "documentation":"A description of the alias.
" + }, + "flowId":{ + "shape":"FlowId", + "documentation":"The unique identifier of the flow.
" + }, + "id":{ + "shape":"FlowAliasId", + "documentation":"The unique identifier of the alias of the flow.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the alias.
" + }, + "routingConfiguration":{ + "shape":"FlowAliasRoutingConfiguration", + "documentation":"A list of configurations about the versions that the alias maps to. Currently, you can only specify one.
" + }, + "updatedAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the alias was last updated.
" + } + }, + "documentation":"Contains information about an alias of a flow.
This data type is used in the following API operations:
" + }, + "FlowArn":{ + "type":"string", + "pattern":"^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}$" + }, + "FlowCondition":{ + "type":"structure", + "required":["name"], + "members":{ + "expression":{ + "shape":"FlowConditionExpression", + "documentation":"Defines the condition. You must refer to at least one of the inputs in the condition. For more information, expand the Condition node section in Node types in prompt flows.
" + }, + "name":{ + "shape":"FlowConditionName", + "documentation":"A name for the condition that you can reference.
" + } + }, + "documentation":"Defines a condition in the condition node.
", + "sensitive":true + }, + "FlowConditionExpression":{ + "type":"string", + "max":64, + "min":1, + "sensitive":true + }, + "FlowConditionName":{ + "type":"string", + "pattern":"^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" + }, + "FlowConditionalConnectionConfiguration":{ + "type":"structure", + "required":["condition"], + "members":{ + "condition":{ + "shape":"FlowConditionName", + "documentation":"The condition that triggers this connection. For more information about how to write conditions, see the Condition node type in the Node types topic in the Amazon Bedrock User Guide.
" + } + }, + "documentation":"The configuration of a connection between a condition node and another node.
" + }, + "FlowConditions":{ + "type":"list", + "member":{"shape":"FlowCondition"}, + "max":5, + "min":1, + "sensitive":true + }, + "FlowConnection":{ + "type":"structure", + "required":[ + "name", + "source", + "target", + "type" + ], + "members":{ + "configuration":{ + "shape":"FlowConnectionConfiguration", + "documentation":"The configuration of the connection.
" + }, + "name":{ + "shape":"FlowConnectionName", + "documentation":"A name for the connection that you can reference.
" + }, + "source":{ + "shape":"FlowNodeName", + "documentation":"The node that the connection starts at.
" + }, + "target":{ + "shape":"FlowNodeName", + "documentation":"The node that the connection ends at.
" + }, + "type":{ + "shape":"FlowConnectionType", + "documentation":"Whether the source node that the connection begins from is a condition node (Conditional) or not (Data).
Contains information about a connection between two nodes in the flow.
" + }, + "FlowConnectionConfiguration":{ + "type":"structure", + "members":{ + "conditional":{ + "shape":"FlowConditionalConnectionConfiguration", + "documentation":"The configuration of a connection originating from a Condition node.
" + }, + "data":{ + "shape":"FlowDataConnectionConfiguration", + "documentation":"The configuration of a connection originating from a node that isn't a Condition node.
" + } + }, + "documentation":"The configuration of the connection.
", + "union":true + }, + "FlowConnectionName":{ + "type":"string", + "pattern":"^[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}$" + }, + "FlowConnectionType":{ + "type":"string", + "enum":[ + "Data", + "Conditional" + ] + }, + "FlowConnections":{ + "type":"list", + "member":{"shape":"FlowConnection"}, + "max":20, + "min":0 + }, + "FlowDataConnectionConfiguration":{ + "type":"structure", + "required":[ + "sourceOutput", + "targetInput" + ], + "members":{ + "sourceOutput":{ + "shape":"FlowNodeOutputName", + "documentation":"The name of the output in the source node that the connection begins from.
" + }, + "targetInput":{ + "shape":"FlowNodeInputName", + "documentation":"The name of the input in the target node that the connection ends at.
" + } + }, + "documentation":"The configuration of a connection originating from a node that isn't a Condition node.
" + }, + "FlowDefinition":{ + "type":"structure", + "members":{ + "connections":{ + "shape":"FlowConnections", + "documentation":"An array of connection definitions in the flow.
" + }, + "nodes":{ + "shape":"FlowNodes", + "documentation":"An array of node definitions in the flow.
" + } + }, + "documentation":"The definition of the nodes and connections between nodes in the flow.
" + }, + "FlowDescription":{ + "type":"string", + "max":200, + "min":1 + }, + "FlowExecutionRoleArn":{ + "type":"string", + "max":2048, + "min":0, + "pattern":"^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+$" + }, + "FlowId":{ + "type":"string", + "pattern":"^[0-9a-zA-Z]{10}$" + }, + "FlowIdentifier":{ + "type":"string", + "pattern":"^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})$" + }, + "FlowName":{ + "type":"string", + "pattern":"^([0-9a-zA-Z][_-]?){1,100}$" + }, + "FlowNode":{ + "type":"structure", + "required":[ + "name", + "type" + ], + "members":{ + "configuration":{ + "shape":"FlowNodeConfiguration", + "documentation":"Contains configurations for the node.
" + }, + "inputs":{ + "shape":"FlowNodeInputs", + "documentation":"An array of objects, each of which contains information about an input into the node.
" + }, + "name":{ + "shape":"FlowNodeName", + "documentation":"A name for the node.
" + }, + "outputs":{ + "shape":"FlowNodeOutputs", + "documentation":"A list of objects, each of which contains information about an output from the node.
" + }, + "type":{ + "shape":"FlowNodeType", + "documentation":"The type of node. This value must match the name of the key that you provide in the configuration you provide in the FlowNodeConfiguration field.
Contains configurations about a node in the flow.
" + }, + "FlowNodeConfiguration":{ + "type":"structure", + "members":{ + "agent":{ + "shape":"AgentFlowNodeConfiguration", + "documentation":"Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response.
" + }, + "collector":{ + "shape":"CollectorFlowNodeConfiguration", + "documentation":"Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.
" + }, + "condition":{ + "shape":"ConditionFlowNodeConfiguration", + "documentation":"Contains configurations for a Condition node in your flow. Defines conditions that lead to different branches of the flow.
" + }, + "input":{ + "shape":"InputFlowNodeConfiguration", + "documentation":"Contains configurations for an input flow node in your flow. The first node in the flow. inputs can't be specified for this node.
Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.
The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.
" + }, + "knowledgeBase":{ + "shape":"KnowledgeBaseFlowNodeConfiguration", + "documentation":"Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.
" + }, + "lambdaFunction":{ + "shape":"LambdaFunctionFlowNodeConfiguration", + "documentation":"Contains configurations for a Lambda function node in your flow. Invokes an Lambda function.
" + }, + "lex":{ + "shape":"LexFlowNodeConfiguration", + "documentation":"Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.
" + }, + "output":{ + "shape":"OutputFlowNodeConfiguration", + "documentation":"Contains configurations for an output flow node in your flow. The last node in the flow. outputs can't be specified for this node.
Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node.
" + }, + "retrieval":{ + "shape":"RetrievalFlowNodeConfiguration", + "documentation":"Contains configurations for a Retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.
" + }, + "storage":{ + "shape":"StorageFlowNodeConfiguration", + "documentation":"Contains configurations for a Storage node in your flow. Stores an input in an Amazon S3 location.
" + } + }, + "documentation":"Contains configurations for a node in your flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
", + "union":true + }, + "FlowNodeIODataType":{ + "type":"string", + "enum":[ + "String", + "Number", + "Boolean", + "Object", + "Array" + ] + }, + "FlowNodeInput":{ + "type":"structure", + "required":[ + "expression", + "name", + "type" + ], + "members":{ + "expression":{ + "shape":"FlowNodeInputExpression", + "documentation":"An expression that formats the input for the node. For an explanation of how to create expressions, see Expressions in Prompt flows in Amazon Bedrock.
" + }, + "name":{ + "shape":"FlowNodeInputName", + "documentation":"A name for the input that you can reference.
" + }, + "type":{ + "shape":"FlowNodeIODataType", + "documentation":"The data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.
" + } + }, + "documentation":"Contains configurations for an input to a node.
" + }, + "FlowNodeInputExpression":{ + "type":"string", + "max":64, + "min":1, + "sensitive":true + }, + "FlowNodeInputName":{ + "type":"string", + "pattern":"^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" + }, + "FlowNodeInputs":{ + "type":"list", + "member":{"shape":"FlowNodeInput"}, + "max":5, + "min":0 + }, + "FlowNodeName":{ + "type":"string", + "pattern":"^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" + }, + "FlowNodeOutput":{ + "type":"structure", + "required":[ + "name", + "type" + ], + "members":{ + "name":{ + "shape":"FlowNodeOutputName", + "documentation":"A name for the output that you can reference.
" + }, + "type":{ + "shape":"FlowNodeIODataType", + "documentation":"The data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown.
" + } + }, + "documentation":"Contains configurations for an output from a node.
" + }, + "FlowNodeOutputName":{ + "type":"string", + "pattern":"^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" + }, + "FlowNodeOutputs":{ + "type":"list", + "member":{"shape":"FlowNodeOutput"}, + "max":5, + "min":0 + }, + "FlowNodeType":{ + "type":"string", + "enum":[ + "Input", + "Output", + "KnowledgeBase", + "Condition", + "Lex", + "Prompt", + "LambdaFunction", + "Storage", + "Agent", + "Retrieval", + "Iterator", + "Collector" + ] + }, + "FlowNodes":{ + "type":"list", + "member":{"shape":"FlowNode"}, + "max":20, + "min":0, + "sensitive":true + }, + "FlowStatus":{ + "type":"string", + "enum":[ + "Failed", + "Prepared", + "Preparing", + "NotPrepared" + ] + }, + "FlowSummaries":{ + "type":"list", + "member":{"shape":"FlowSummary"}, + "max":10, + "min":0 + }, + "FlowSummary":{ + "type":"structure", + "required":[ + "arn", + "createdAt", + "id", + "name", + "status", + "updatedAt", + "version" + ], + "members":{ + "arn":{ + "shape":"FlowArn", + "documentation":"The Amazon Resource Name (ARN) of the flow.
" + }, + "createdAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the flow was created.
" + }, + "description":{ + "shape":"FlowDescription", + "documentation":"A description of the flow.
" + }, + "id":{ + "shape":"FlowId", + "documentation":"The unique identifier of the flow.
" + }, + "name":{ + "shape":"FlowName", + "documentation":"The name of the flow.
" + }, + "status":{ + "shape":"FlowStatus", + "documentation":"The status of the flow. The following statuses are possible:
NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.
Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.
Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.
Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.
The time at which the flow was last updated.
" + }, + "version":{ + "shape":"DraftVersion", + "documentation":"The latest version of the flow.
" + } + }, + "documentation":"Contains the definition of a flow.
" + }, + "FlowValidation":{ + "type":"structure", + "required":[ + "message", + "severity" + ], + "members":{ + "message":{ + "shape":"NonBlankString", + "documentation":"A message describing the validation error.
" + }, + "severity":{ + "shape":"FlowValidationSeverity", + "documentation":"The severity of the issue described in the message.
" } }, - "documentation":"The configuration details for the embeddings model.
" + "documentation":"Contains information about validation of the flow.
This data type is used in the following API operations:
" }, - "FailureReason":{ + "FlowValidationSeverity":{ "type":"string", - "max":2048, - "min":0 + "enum":[ + "Warning", + "Error" + ] }, - "FailureReasons":{ + "FlowValidations":{ "type":"list", - "member":{"shape":"FailureReason"}, - "max":2048, + "member":{"shape":"FlowValidation"}, + "max":100, "min":0 }, - "FieldName":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"^.*$" + "FlowVersionSummaries":{ + "type":"list", + "member":{"shape":"FlowVersionSummary"}, + "max":10, + "min":0 }, - "FixedSizeChunkingConfiguration":{ + "FlowVersionSummary":{ "type":"structure", "required":[ - "maxTokens", - "overlapPercentage" + "arn", + "createdAt", + "id", + "status", + "version" ], "members":{ - "maxTokens":{ - "shape":"FixedSizeChunkingConfigurationMaxTokensInteger", - "documentation":"The maximum number of tokens to include in a chunk.
" + "arn":{ + "shape":"FlowArn", + "documentation":"The Amazon Resource Name (ARN) of the flow that the version belongs to.
" }, - "overlapPercentage":{ - "shape":"FixedSizeChunkingConfigurationOverlapPercentageInteger", - "documentation":"The percentage of overlap between adjacent chunks of a data source.
" + "createdAt":{ + "shape":"DateTimestamp", + "documentation":"The time at the flow version was created.
" + }, + "id":{ + "shape":"FlowId", + "documentation":"The unique identifier of the flow.
" + }, + "status":{ + "shape":"FlowStatus", + "documentation":"The status of the flow.
" + }, + "version":{ + "shape":"NumericalVersion", + "documentation":"The version of the flow.
" } }, - "documentation":"Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
Contains information about the flow version.
This data type is used in the following API operations:
" }, "Function":{ "type":"structure", @@ -2616,6 +4381,223 @@ } } }, + "GetFlowAliasRequest":{ + "type":"structure", + "required":[ + "aliasIdentifier", + "flowIdentifier" + ], + "members":{ + "aliasIdentifier":{ + "shape":"FlowAliasIdentifier", + "documentation":"The unique identifier of the alias for which to retrieve information.
", + "location":"uri", + "locationName":"aliasIdentifier" + }, + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow that the alias belongs to.
", + "location":"uri", + "locationName":"flowIdentifier" + } + } + }, + "GetFlowAliasResponse":{ + "type":"structure", + "required":[ + "arn", + "createdAt", + "flowId", + "id", + "name", + "routingConfiguration", + "updatedAt" + ], + "members":{ + "arn":{ + "shape":"FlowAliasArn", + "documentation":"The Amazon Resource Name (ARN) of the flow.
" + }, + "createdAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the flow was created.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the flow.
" + }, + "flowId":{ + "shape":"FlowId", + "documentation":"The unique identifier of the flow that the alias belongs to.
" + }, + "id":{ + "shape":"FlowAliasId", + "documentation":"The unique identifier of the alias of the flow.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the flow alias.
" + }, + "routingConfiguration":{ + "shape":"FlowAliasRoutingConfiguration", + "documentation":"Contains information about the version that the alias is mapped to.
" + }, + "updatedAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the flow alias was last updated.
" + } + } + }, + "GetFlowRequest":{ + "type":"structure", + "required":["flowIdentifier"], + "members":{ + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow.
", + "location":"uri", + "locationName":"flowIdentifier" + } + } + }, + "GetFlowResponse":{ + "type":"structure", + "required":[ + "arn", + "createdAt", + "executionRoleArn", + "id", + "name", + "status", + "updatedAt", + "version" + ], + "members":{ + "arn":{ + "shape":"FlowArn", + "documentation":"The Amazon Resource Name (ARN) of the flow.
" + }, + "createdAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the flow was created.
" + }, + "customerEncryptionKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.
" + }, + "definition":{ + "shape":"FlowDefinition", + "documentation":"The definition of the nodes and connections between the nodes in the flow.
" + }, + "description":{ + "shape":"FlowDescription", + "documentation":"The description of the flow.
" + }, + "executionRoleArn":{ + "shape":"FlowExecutionRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service row for flows in the Amazon Bedrock User Guide.
" + }, + "id":{ + "shape":"FlowId", + "documentation":"The unique identifier of the flow.
" + }, + "name":{ + "shape":"FlowName", + "documentation":"The name of the flow.
" + }, + "status":{ + "shape":"FlowStatus", + "documentation":"The status of the flow. The following statuses are possible:
NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.
Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.
Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.
Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.
The time at which the flow was last updated.
" + }, + "validations":{ + "shape":"FlowValidations", + "documentation":"A list of validation error messages related to the last failed operation on the flow.
" + }, + "version":{ + "shape":"DraftVersion", + "documentation":"The version of the flow for which information was retrieved.
" + } + } + }, + "GetFlowVersionRequest":{ + "type":"structure", + "required":[ + "flowIdentifier", + "flowVersion" + ], + "members":{ + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow for which to get information.
", + "location":"uri", + "locationName":"flowIdentifier" + }, + "flowVersion":{ + "shape":"NumericalVersion", + "documentation":"The version of the flow for which to get information.
", + "location":"uri", + "locationName":"flowVersion" + } + } + }, + "GetFlowVersionResponse":{ + "type":"structure", + "required":[ + "arn", + "createdAt", + "executionRoleArn", + "id", + "name", + "status", + "version" + ], + "members":{ + "arn":{ + "shape":"FlowArn", + "documentation":"The Amazon Resource Name (ARN) of the flow.
" + }, + "createdAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the flow was created.
" + }, + "customerEncryptionKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the KMS key that the version of the flow is encrypted with.
" + }, + "definition":{ + "shape":"FlowDefinition", + "documentation":"The definition of the nodes and connections between nodes in the flow.
" + }, + "description":{ + "shape":"FlowDescription", + "documentation":"The description of the flow.
" + }, + "executionRoleArn":{ + "shape":"FlowExecutionRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
" + }, + "id":{ + "shape":"FlowId", + "documentation":"The unique identifier of the flow.
" + }, + "name":{ + "shape":"FlowName", + "documentation":"The name of the flow version.
" + }, + "status":{ + "shape":"FlowStatus", + "documentation":"The status of the flow.
" + }, + "version":{ + "shape":"NumericalVersion", + "documentation":"The version of the flow for which information was retrieved.
" + } + } + }, "GetIngestionJobRequest":{ "type":"structure", "required":[ @@ -2676,19 +4658,90 @@ } } }, + "GetPromptRequest":{ + "type":"structure", + "required":["promptIdentifier"], + "members":{ + "promptIdentifier":{ + "shape":"PromptIdentifier", + "documentation":"The unique identifier of the prompt.
", + "location":"uri", + "locationName":"promptIdentifier" + }, + "promptVersion":{ + "shape":"Version", + "documentation":"The version of the prompt about which you want to retrieve information.
", + "location":"querystring", + "locationName":"promptVersion" + } + } + }, + "GetPromptResponse":{ + "type":"structure", + "required":[ + "arn", + "createdAt", + "id", + "name", + "updatedAt", + "version" + ], + "members":{ + "arn":{ + "shape":"PromptArn", + "documentation":"The Amazon Resource Name (ARN) of the prompt.
" + }, + "createdAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the prompt was created.
" + }, + "customerEncryptionKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.
" + }, + "defaultVariant":{ + "shape":"PromptVariantName", + "documentation":"The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
The descriptino of the prompt.
" + }, + "id":{ + "shape":"PromptId", + "documentation":"The unique identifier of the prompt.
" + }, + "name":{ + "shape":"PromptName", + "documentation":"The name of the prompt.
" + }, + "updatedAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the prompt was last updated.
" + }, + "variants":{ + "shape":"PromptVariantList", + "documentation":"A list of objects, each containing details about a variant of the prompt.
" + }, + "version":{ + "shape":"Version", + "documentation":"The version of the prompt.
" + } + } + }, "GuardrailConfiguration":{ "type":"structure", "members":{ "guardrailIdentifier":{ "shape":"GuardrailIdentifier", - "documentation":"The guardrails identifier assigned to the guardrails configuration.
" + "documentation":"The unique identifier of the guardrail.
" }, "guardrailVersion":{ "shape":"GuardrailVersion", - "documentation":"The guardrails version assigned to the guardrails configuration.
" + "documentation":"The version of the guardrail.
" } }, - "documentation":"The details of the guardrails configuration.
" + "documentation":"Details about the guardrail associated with an agent.
" }, "GuardrailIdentifier":{ "type":"string", @@ -2700,6 +4753,56 @@ "type":"string", "pattern":"^(([0-9]{1,8})|(DRAFT))$" }, + "HierarchicalChunkingConfiguration":{ + "type":"structure", + "required":[ + "levelConfigurations", + "overlapTokens" + ], + "members":{ + "levelConfigurations":{ + "shape":"HierarchicalChunkingLevelConfigurations", + "documentation":"Token settings for each layer.
" + }, + "overlapTokens":{ + "shape":"HierarchicalChunkingConfigurationOverlapTokensInteger", + "documentation":"The number of tokens to repeat across chunks in the same layer.
" + } + }, + "documentation":"Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
You configure the number of tokens to overlap, or repeat across adjacent chunks. For example, if you set overlap tokens to 60, the last 60 tokens in the first chunk are also included at the beginning of the second chunk. For each layer, you must also configure the maximum number of tokens in a chunk.
" + }, + "HierarchicalChunkingConfigurationOverlapTokensInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "HierarchicalChunkingLevelConfiguration":{ + "type":"structure", + "required":["maxTokens"], + "members":{ + "maxTokens":{ + "shape":"HierarchicalChunkingLevelConfigurationMaxTokensInteger", + "documentation":"The maximum number of tokens that a chunk can contain in this layer.
" + } + }, + "documentation":"Token settings for a layer in a hierarchical chunking configuration.
" + }, + "HierarchicalChunkingLevelConfigurationMaxTokensInteger":{ + "type":"integer", + "box":true, + "max":8192, + "min":1 + }, + "HierarchicalChunkingLevelConfigurations":{ + "type":"list", + "member":{"shape":"HierarchicalChunkingLevelConfiguration"}, + "max":2, + "min":2 + }, + "HttpsUrl":{ + "type":"string", + "pattern":"^https://[A-Za-z0-9][^\\s]*$" + }, "Id":{ "type":"string", "pattern":"^[0-9a-zA-Z]{10}$" @@ -2947,12 +5050,29 @@ }, "documentation":"Contains details about an ingestion job.
" }, + "InputFlowNodeConfiguration":{ + "type":"structure", + "members":{ + }, + "documentation":"Contains configurations for the input flow node for a flow. This node takes the input from flow invocation and passes it to the next node in the data type that you specify.
" + }, "Instruction":{ "type":"string", "max":4000, "min":40, "sensitive":true }, + "IntermediateStorage":{ + "type":"structure", + "required":["s3Location"], + "members":{ + "s3Location":{ + "shape":"S3Location", + "documentation":"An S3 bucket path.
" + } + }, + "documentation":"A location for storing content from data sources temporarily as it is processed by custom components in the ingestion pipeline.
" + }, "InternalServerException":{ "type":"structure", "members":{ @@ -2963,6 +5083,12 @@ "exception":true, "fault":true }, + "IteratorFlowNodeConfiguration":{ + "type":"structure", + "members":{ + }, + "documentation":"Contains configurations for an iterator node in a flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.
The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.
" + }, "KmsKeyArn":{ "type":"string", "max":2048, @@ -3049,7 +5175,28 @@ "documentation":"Contains details about the embeddings model that'sused to convert the data source.
" } }, - "documentation":"Contains details about the embeddings configuration of the knowledge base.
" + "documentation":"Contains details about the embeddings configuration of the knowledge base.
" + }, + "KnowledgeBaseFlowNodeConfiguration":{ + "type":"structure", + "required":["knowledgeBaseId"], + "members":{ + "knowledgeBaseId":{ + "shape":"KnowledgeBaseId", + "documentation":"The unique identifier of the knowledge base to query.
" + }, + "modelId":{ + "shape":"ModelIdentifier", + "documentation":"The unique identifier of the model to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.
" + } + }, + "documentation":"Contains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + }, + "KnowledgeBaseId":{ + "type":"string", + "max":10, + "min":0, + "pattern":"^[0-9a-zA-Z]+$" }, "KnowledgeBaseRoleArn":{ "type":"string", @@ -3131,6 +5278,46 @@ "min":0, "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-_]+))?$" }, + "LambdaFunctionFlowNodeConfiguration":{ + "type":"structure", + "required":["lambdaArn"], + "members":{ + "lambdaArn":{ + "shape":"LambdaArn", + "documentation":"The Amazon Resource Name (ARN) of the Lambda function to invoke.
" + } + }, + "documentation":"Contains configurations for a Lambda function node in the flow. You specify the Lambda function to invoke and the inputs into the function. The output is the response that is defined in the Lambda function. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + }, + "LexBotAliasArn":{ + "type":"string", + "max":78, + "min":0, + "pattern":"^arn:aws(|-us-gov):lex:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:bot-alias/[0-9a-zA-Z]+/[0-9a-zA-Z]+$" + }, + "LexBotLocaleId":{ + "type":"string", + "max":10, + "min":1 + }, + "LexFlowNodeConfiguration":{ + "type":"structure", + "required":[ + "botAliasArn", + "localeId" + ], + "members":{ + "botAliasArn":{ + "shape":"LexBotAliasArn", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Lex bot alias to invoke.
" + }, + "localeId":{ + "shape":"LexBotLocaleId", + "documentation":"The Region to invoke the Amazon Lex bot in.
" + } + }, + "documentation":"Contains configurations for a Lex node in the flow. You specify a Amazon Lex bot to invoke. This node takes an utterance as the input and returns as the output the intent identified by the Amazon Lex bot. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + }, "ListAgentActionGroupsRequest":{ "type":"structure", "required":[ @@ -3346,6 +5533,113 @@ } } }, + "ListFlowAliasesRequest":{ + "type":"structure", + "required":["flowIdentifier"], + "members":{ + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow for which aliases are being returned.
", + "location":"uri", + "locationName":"flowIdentifier" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list, each member of which contains information about a flow alias.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
The unique identifier of the flow.
", + "location":"uri", + "locationName":"flowIdentifier" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list, each member of which contains information about a flow.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list, each member of which contains information about a flow.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The unique identifier of the prompt.
", + "location":"querystring", + "locationName":"promptIdentifier" + } + } + }, + "ListPromptsResponse":{ + "type":"structure", + "required":["promptSummaries"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
A list, each member of which contains information about a prompt using Prompt management.
" + } + } + }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], @@ -3457,6 +5788,31 @@ "max":4096, "min":0 }, + "MemoryConfiguration":{ + "type":"structure", + "required":["enabledMemoryTypes"], + "members":{ + "enabledMemoryTypes":{ + "shape":"EnabledMemoryTypes", + "documentation":"The type of memory that is stored.
" + }, + "storageDays":{ + "shape":"StorageDays", + "documentation":"The number of days the agent is configured to retain the conversational context.
" + } + }, + "documentation":"Details of the memory configuration.
" + }, + "MemoryType":{ + "type":"string", + "enum":["SESSION_SUMMARY"] + }, + "Microsoft365TenantId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + }, "ModelIdentifier":{ "type":"string", "max":2048, @@ -3634,6 +5990,12 @@ "min":0, "pattern":"^.*$" }, + "OutputFlowNodeConfiguration":{ + "type":"structure", + "members":{ + }, + "documentation":"Contains configurations for an output flow node in the flow. You specify the data type expected for the input into the node in the type field and how to return the final output in the expression field.
Settings for a foundation model used to parse documents for a data source.
" + }, + "parsingStrategy":{ + "shape":"ParsingStrategy", + "documentation":"The parsing strategy for the data source.
" + } + }, + "documentation":"Settings for parsing document contents. By default, the service converts the contents of each document into text before splitting it into chunks. To improve processing of PDF files with tables and images, you can configure the data source to convert the pages of text into images and use a model to describe the contents of each page.
To use a model to parse PDF documents, set the parsing strategy to BEDROCK_FOUNDATION_MODEL and specify the model to use by ARN. You can also override the default parsing prompt with instructions for how to interpret images and tables in your documents. The following models are supported.
Anthropic Claude 3 Sonnet - anthropic.claude-3-sonnet-20240229-v1:0
Anthropic Claude 3 Haiku - anthropic.claude-3-haiku-20240307-v1:0
You can get the ARN of a model with the action. Standard model usage charges apply for the foundation model parsing strategy.
" + }, + "ParsingPrompt":{ + "type":"structure", + "required":["parsingPromptText"], + "members":{ + "parsingPromptText":{ + "shape":"ParsingPromptText", + "documentation":"Instructions for interpreting the contents of a document.
" + } + }, + "documentation":"Instructions for interpreting the contents of a document.
" + }, + "ParsingPromptText":{ + "type":"string", + "max":10000, + "min":1 + }, + "ParsingStrategy":{ + "type":"string", + "enum":["BEDROCK_FOUNDATION_MODEL"] + }, + "PatternObjectFilter":{ + "type":"structure", + "required":["objectType"], + "members":{ + "exclusionFilters":{ + "shape":"FilterList", + "documentation":"A list of one or more exclusion regular expression patterns to exclude certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.
" + }, + "inclusionFilters":{ + "shape":"FilterList", + "documentation":"A list of one or more inclusion regular expression patterns to include certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.
" + }, + "objectType":{ + "shape":"FilteredObjectType", + "documentation":"The supported object type or content type of the data source.
" + } + }, + "documentation":"The specific filters applied to your data source content. You can filter out or include certain content.
" + }, + "PatternObjectFilterConfiguration":{ + "type":"structure", + "required":["filters"], + "members":{ + "filters":{ + "shape":"PatternObjectFilterList", + "documentation":"The configuration of specific filters applied to your data source content. You can filter out or include certain content.
" + } + }, + "documentation":"The configuration of filtering certain objects or content types of the data source.
" + }, + "PatternObjectFilterList":{ + "type":"list", + "member":{"shape":"PatternObjectFilter"}, + "max":25, + "min":1, + "sensitive":true + }, "Payload":{ "type":"string", "sensitive":true @@ -3761,44 +6195,222 @@ "shape":"DateTimestamp", "documentation":"The time at which the DRAFT version of the agent was last prepared.
The unique identifier of the flow.
", + "location":"uri", + "locationName":"flowIdentifier" + } + } + }, + "PrepareFlowResponse":{ + "type":"structure", + "required":[ + "id", + "status" + ], + "members":{ + "id":{ + "shape":"FlowId", + "documentation":"The unique identifier of the flow.
" + }, + "status":{ + "shape":"FlowStatus", + "documentation":"The status of the flow. When you submit this request, the status will be NotPrepared. If preparation succeeds, the status becomes Prepared. If it fails, the status becomes FAILED.
Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.
" + }, + "inferenceConfiguration":{ + "shape":"InferenceConfiguration", + "documentation":"Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.
Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
PRE_PROCESSING – ENABLED
ORCHESTRATION – ENABLED
KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
POST_PROCESSING – DISABLED
The step in the agent sequence that this prompt configuration applies to.
" + } + }, + "documentation":"Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
" + }, + "PromptConfigurations":{ + "type":"list", + "member":{"shape":"PromptConfiguration"}, + "max":10, + "min":0 + }, + "PromptDescription":{ + "type":"string", + "max":200, + "min":1 + }, + "PromptFlowNodeConfiguration":{ + "type":"structure", + "required":["sourceConfiguration"], + "members":{ + "sourceConfiguration":{ + "shape":"PromptFlowNodeSourceConfiguration", + "documentation":"Specifies whether the prompt is from Prompt management or defined inline.
" + } + }, + "documentation":"Contains configurations for a prompt node in the flow. You can use a prompt from Prompt management or you can define one in this node. If the prompt contains variables, the inputs into this node will fill in the variables. The output from this node is the response generated by the model. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + }, + "PromptFlowNodeInlineConfiguration":{ + "type":"structure", + "required":[ + "modelId", + "templateConfiguration", + "templateType" + ], + "members":{ + "inferenceConfiguration":{ + "shape":"PromptInferenceConfiguration", + "documentation":"Contains inference configurations for the prompt.
" + }, + "modelId":{ + "shape":"PromptModelIdentifier", + "documentation":"The unique identifier of the model to run inference with.
" + }, + "templateConfiguration":{ + "shape":"PromptTemplateConfiguration", + "documentation":"Contains a prompt and variables in the prompt that can be replaced with values at runtime.
" + }, + "templateType":{ + "shape":"PromptTemplateType", + "documentation":"The type of prompt template.
" + } + }, + "documentation":"Contains configurations for a prompt defined inline in the node.
" + }, + "PromptFlowNodeResourceConfiguration":{ + "type":"structure", + "required":["promptArn"], + "members":{ + "promptArn":{ + "shape":"PromptArn", + "documentation":"The Amazon Resource Name (ARN) of the prompt from Prompt management.
" + } + }, + "documentation":"Contains configurations for a prompt from Prompt management to use in a node.
" + }, + "PromptFlowNodeSourceConfiguration":{ + "type":"structure", + "members":{ + "inline":{ + "shape":"PromptFlowNodeInlineConfiguration", + "documentation":"Contains configurations for a prompt that is defined inline
" + }, + "resource":{ + "shape":"PromptFlowNodeResourceConfiguration", + "documentation":"Contains configurations for a prompt from Prompt management.
" + } + }, + "documentation":"Contains configurations for a prompt and whether it is from Prompt management or defined inline.
", + "union":true + }, + "PromptId":{ + "type":"string", + "pattern":"^[0-9a-zA-Z]{10}$" + }, + "PromptIdentifier":{ + "type":"string", + "pattern":"^([0-9a-zA-Z]{10})|(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})(?::[0-9]{1,5})?$" + }, + "PromptInferenceConfiguration":{ + "type":"structure", + "members":{ + "text":{ + "shape":"PromptModelInferenceConfiguration", + "documentation":"Contains inference configurations for a text prompt.
" + } + }, + "documentation":"Contains inference configurations for the prompt.
", + "union":true }, - "PrimitiveLong":{"type":"long"}, - "PromptConfiguration":{ + "PromptInputVariable":{ "type":"structure", "members":{ - "basePromptTemplate":{ - "shape":"BasePromptTemplate", - "documentation":"Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.
" - }, - "inferenceConfiguration":{ - "shape":"InferenceConfiguration", - "documentation":"Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
The name of the variable.
" + } + }, + "documentation":"Contains information about a variable in the prompt.
" + }, + "PromptInputVariableName":{ + "type":"string", + "pattern":"^([0-9a-zA-Z][_-]?){1,100}$" + }, + "PromptInputVariablesList":{ + "type":"list", + "member":{"shape":"PromptInputVariable"}, + "max":5, + "min":0, + "sensitive":true + }, + "PromptModelIdentifier":{ + "type":"string", + "max":2048, + "min":1, + "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][_-]?)+)$" + }, + "PromptModelInferenceConfiguration":{ + "type":"structure", + "members":{ + "maxTokens":{ + "shape":"MaximumLength", + "documentation":"The maximum number of tokens to return in the response.
" }, - "parserMode":{ - "shape":"CreationMode", - "documentation":"Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
A list of strings that define sequences after which the model will stop generating.
" }, - "promptCreationMode":{ - "shape":"CreationMode", - "documentation":"Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.
Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
" }, - "promptState":{ - "shape":"PromptState", - "documentation":"Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
PRE_PROCESSING – ENABLED
ORCHESTRATION – ENABLED
KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
POST_PROCESSING – DISABLED
The number of most-likely candidates that the model considers for the next token during generation.
" }, - "promptType":{ - "shape":"PromptType", - "documentation":"The step in the agent sequence that this prompt configuration applies to.
" + "topP":{ + "shape":"TopP", + "documentation":"The percentage of most-likely candidates that the model considers for the next token.
" } }, - "documentation":"Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
" + "documentation":"Contains inference configurations related to model inference for a prompt. For more information, see Inference parameters.
" }, - "PromptConfigurations":{ - "type":"list", - "member":{"shape":"PromptConfiguration"}, - "max":10, - "min":0 + "PromptName":{ + "type":"string", + "pattern":"^([0-9a-zA-Z][_-]?){1,100}$" }, "PromptOverrideConfiguration":{ "type":"structure", @@ -3823,6 +6435,69 @@ "DISABLED" ] }, + "PromptSummaries":{ + "type":"list", + "member":{"shape":"PromptSummary"}, + "max":10, + "min":0 + }, + "PromptSummary":{ + "type":"structure", + "required":[ + "arn", + "createdAt", + "id", + "name", + "updatedAt", + "version" + ], + "members":{ + "arn":{ + "shape":"PromptArn", + "documentation":"The Amazon Resource Name (ARN) of the prompt.
" + }, + "createdAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the prompt was created.
" + }, + "description":{ + "shape":"PromptDescription", + "documentation":"The description of the prompt.
" + }, + "id":{ + "shape":"PromptId", + "documentation":"The unique identifier of the prompt.
" + }, + "name":{ + "shape":"PromptName", + "documentation":"The name of the prompt.
" + }, + "updatedAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the prompt was last updated.
" + }, + "version":{ + "shape":"Version", + "documentation":"The version of the prompt that this summary applies to.
" + } + }, + "documentation":"Contains information about a prompt in your Prompt management tool.
This data type is used in the following API operations:
" + }, + "PromptTemplateConfiguration":{ + "type":"structure", + "members":{ + "text":{ + "shape":"TextPromptTemplateConfiguration", + "documentation":"Contains configurations for the text in a message for a prompt.
" + } + }, + "documentation":"Contains the message for a prompt. For more information, see Prompt management in Amazon Bedrock.
", + "union":true + }, + "PromptTemplateType":{ + "type":"string", + "enum":["TEXT"] + }, "PromptType":{ "type":"string", "enum":[ @@ -3832,6 +6507,48 @@ "KNOWLEDGE_BASE_RESPONSE_GENERATION" ] }, + "PromptVariant":{ + "type":"structure", + "required":[ + "name", + "templateType" + ], + "members":{ + "inferenceConfiguration":{ + "shape":"PromptInferenceConfiguration", + "documentation":"Contains inference configurations for the prompt variant.
" + }, + "modelId":{ + "shape":"PromptModelIdentifier", + "documentation":"The unique identifier of the model with which to run inference on the prompt.
" + }, + "name":{ + "shape":"PromptVariantName", + "documentation":"The name of the prompt variant.
" + }, + "templateConfiguration":{ + "shape":"PromptTemplateConfiguration", + "documentation":"Contains configurations for the prompt template.
" + }, + "templateType":{ + "shape":"PromptTemplateType", + "documentation":"The type of prompt template to use.
" + } + }, + "documentation":"Contains details about a variant of the prompt.
", + "sensitive":true + }, + "PromptVariantList":{ + "type":"list", + "member":{"shape":"PromptVariant"}, + "max":3, + "min":0, + "sensitive":true + }, + "PromptVariantName":{ + "type":"string", + "pattern":"^([0-9a-zA-Z][_-]?){1,100}$" + }, "ProvisionedModelIdentifier":{ "type":"string", "max":2048, @@ -4001,6 +6718,39 @@ }, "exception":true }, + "RetrievalFlowNodeConfiguration":{ + "type":"structure", + "required":["serviceConfiguration"], + "members":{ + "serviceConfiguration":{ + "shape":"RetrievalFlowNodeServiceConfiguration", + "documentation":"Contains configurations for the service to use for retrieving data to return as the output from the node.
" + } + }, + "documentation":"Contains configurations for a Retrieval node in a flow. This node retrieves data from the Amazon S3 location that you specify and returns it as the output.
" + }, + "RetrievalFlowNodeS3Configuration":{ + "type":"structure", + "required":["bucketName"], + "members":{ + "bucketName":{ + "shape":"S3BucketName", + "documentation":"The name of the Amazon S3 bucket from which to retrieve data.
" + } + }, + "documentation":"Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.
" + }, + "RetrievalFlowNodeServiceConfiguration":{ + "type":"structure", + "members":{ + "s3":{ + "shape":"RetrievalFlowNodeS3Configuration", + "documentation":"Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.
" + } + }, + "documentation":"Contains configurations for the service to use for retrieving data to return as the output from the node.
", + "union":true + }, "S3BucketArn":{ "type":"string", "max":2048, @@ -4013,24 +6763,30 @@ "min":3, "pattern":"^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" }, + "S3BucketUri":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^s3://.{1,128}$" + }, "S3DataSourceConfiguration":{ "type":"structure", "required":["bucketArn"], "members":{ "bucketArn":{ "shape":"S3BucketArn", - "documentation":"The Amazon Resource Name (ARN) of the bucket that contains the data source.
" + "documentation":"The Amazon Resource Name (ARN) of the S3 bucket that contains your data.
" }, "bucketOwnerAccountId":{ "shape":"BucketOwnerAccountId", - "documentation":"The bucket account owner ID for the S3 bucket.
" + "documentation":"The account ID for the owner of the S3 bucket.
" }, "inclusionPrefixes":{ "shape":"S3Prefixes", - "documentation":"A list of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes.
" + "documentation":"A list of S3 prefixes to include certain files or content. For more information, see Organizing objects using prefixes.
" } }, - "documentation":"Contains information about the S3 configuration of the data source.
" + "documentation":"The configuration information to connect to Amazon S3 as your data source.
" }, "S3Identifier":{ "type":"structure", @@ -4041,10 +6797,21 @@ }, "s3ObjectKey":{ "shape":"S3ObjectKey", - "documentation":"The S3 object key containing the resource.
" + "documentation":"The S3 object key for the S3 resource.
" + } + }, + "documentation":"The identifier information for an Amazon S3 bucket.
" + }, + "S3Location":{ + "type":"structure", + "required":["uri"], + "members":{ + "uri":{ + "shape":"S3BucketUri", + "documentation":"The location's URI. For example, s3://my-bucket/chunk-processor/.
Contains information about the S3 object containing the resource.
" + "documentation":"An Amazon S3 location.
" }, "S3ObjectKey":{ "type":"string", @@ -4055,7 +6822,8 @@ "S3Prefix":{ "type":"string", "max":300, - "min":1 + "min":1, + "sensitive":true }, "S3Prefixes":{ "type":"list", @@ -4063,10 +6831,118 @@ "max":1, "min":1 }, + "SalesforceAuthType":{ + "type":"string", + "enum":["OAUTH2_CLIENT_CREDENTIALS"] + }, + "SalesforceCrawlerConfiguration":{ + "type":"structure", + "members":{ + "filterConfiguration":{ + "shape":"CrawlFilterConfiguration", + "documentation":"The configuration of filtering the Salesforce content. For example, configuring regular expression patterns to include or exclude certain content.
" + } + }, + "documentation":"The configuration of the Salesforce content. For example, configuring specific types of Salesforce content.
" + }, + "SalesforceDataSourceConfiguration":{ + "type":"structure", + "required":["sourceConfiguration"], + "members":{ + "crawlerConfiguration":{ + "shape":"SalesforceCrawlerConfiguration", + "documentation":"The configuration of the Salesforce content. For example, configuring specific types of Salesforce content.
" + }, + "sourceConfiguration":{ + "shape":"SalesforceSourceConfiguration", + "documentation":"The endpoint information to connect to your Salesforce data source.
" + } + }, + "documentation":"The configuration information to connect to Salesforce as your data source.
" + }, + "SalesforceSourceConfiguration":{ + "type":"structure", + "required":[ + "authType", + "credentialsSecretArn", + "hostUrl" + ], + "members":{ + "authType":{ + "shape":"SalesforceAuthType", + "documentation":"The supported authentication type to authenticate and connect to your Salesforce instance.
" + }, + "credentialsSecretArn":{ + "shape":"SecretArn", + "documentation":"The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see Salesforce connection configuration.
" + }, + "hostUrl":{ + "shape":"HttpsUrl", + "documentation":"The Salesforce host URL or instance URL.
" + } + }, + "documentation":"The endpoint information to connect to your Salesforce data source.
" + }, "SecretArn":{ "type":"string", "pattern":"^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$" }, + "SeedUrl":{ + "type":"structure", + "members":{ + "url":{ + "shape":"Url", + "documentation":"A seed or starting point URL.
" + } + }, + "documentation":"The seed or starting point URL. You should be authorized to crawl the URL.
" + }, + "SeedUrls":{ + "type":"list", + "member":{"shape":"SeedUrl"}, + "max":100, + "min":1 + }, + "SemanticChunkingConfiguration":{ + "type":"structure", + "required":[ + "breakpointPercentileThreshold", + "bufferSize", + "maxTokens" + ], + "members":{ + "breakpointPercentileThreshold":{ + "shape":"SemanticChunkingConfigurationBreakpointPercentileThresholdInteger", + "documentation":"The dissimilarity threshold for splitting chunks.
" + }, + "bufferSize":{ + "shape":"SemanticChunkingConfigurationBufferSizeInteger", + "documentation":"The buffer size.
" + }, + "maxTokens":{ + "shape":"SemanticChunkingConfigurationMaxTokensInteger", + "documentation":"The maximum number of tokens that a chunk can contain.
" + } + }, + "documentation":"Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing.
With semantic chunking, each sentence is compared to the next to determine how similar they are. You specify a threshold in the form of a percentile, where adjacent sentences that are less similar than that percentage of sentence pairs are divided into separate chunks. For example, if you set the threshold to 90, then the 10 percent of sentence pairs that are least similar are split. So if you have 101 sentences, 100 sentence pairs are compared, and the 10 with the least similarity are split, creating 11 chunks. These chunks are further split if they exceed the max token size.
You must also specify a buffer size, which determines whether sentences are compared in isolation, or within a moving context window that includes the previous and following sentence. For example, if you set the buffer size to 1, the embedding for sentence 10 is derived from sentences 9, 10, and 11 combined.
The configuration of filtering the SharePoint content. For example, configuring regular expression patterns to include or exclude certain content.
" + } + }, + "documentation":"The configuration of the SharePoint content. For example, configuring specific types of SharePoint content.
" + }, + "SharePointDataSourceConfiguration":{ + "type":"structure", + "required":["sourceConfiguration"], + "members":{ + "crawlerConfiguration":{ + "shape":"SharePointCrawlerConfiguration", + "documentation":"The configuration of the SharePoint content. For example, configuring specific types of SharePoint content.
" + }, + "sourceConfiguration":{ + "shape":"SharePointSourceConfiguration", + "documentation":"The endpoint information to connect to your SharePoint data source.
" + } + }, + "documentation":"The configuration information to connect to SharePoint as your data source.
" + }, + "SharePointDomain":{ + "type":"string", + "max":50, + "min":1 + }, + "SharePointHostType":{ + "type":"string", + "enum":["ONLINE"] + }, + "SharePointSiteUrls":{ + "type":"list", + "member":{"shape":"HttpsUrl"}, + "max":100, + "min":1 + }, + "SharePointSourceConfiguration":{ + "type":"structure", + "required":[ + "authType", + "credentialsSecretArn", + "domain", + "hostType", + "siteUrls" + ], + "members":{ + "authType":{ + "shape":"SharePointAuthType", + "documentation":"The supported authentication type to authenticate and connect to your SharePoint site/sites.
" + }, + "credentialsSecretArn":{ + "shape":"SecretArn", + "documentation":"The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see SharePoint connection configuration.
" + }, + "domain":{ + "shape":"SharePointDomain", + "documentation":"The domain of your SharePoint instance or site URL/URLs.
" + }, + "hostType":{ + "shape":"SharePointHostType", + "documentation":"The supported host type, whether online/cloud or server/on-premises.
" + }, + "siteUrls":{ + "shape":"SharePointSiteUrls", + "documentation":"A list of one or more SharePoint site URLs.
" + }, + "tenantId":{ + "shape":"Microsoft365TenantId", + "documentation":"The identifier of your Microsoft 365 tenant.
" + } + }, + "documentation":"The endpoint information to connect to your SharePoint data source.
" }, "SortOrder":{ "type":"string", @@ -4142,6 +7099,10 @@ } } }, + "StepType":{ + "type":"string", + "enum":["POST_CHUNKING"] + }, "StopSequences":{ "type":"list", "member":{"shape":"String"}, @@ -4179,6 +7140,45 @@ }, "documentation":"Contains the storage configuration of the knowledge base.
" }, + "StorageDays":{ + "type":"integer", + "box":true, + "max":30, + "min":0 + }, + "StorageFlowNodeConfiguration":{ + "type":"structure", + "required":["serviceConfiguration"], + "members":{ + "serviceConfiguration":{ + "shape":"StorageFlowNodeServiceConfiguration", + "documentation":"Contains configurations for the service to use for storing the input into the node.
" + } + }, + "documentation":"Contains configurations for a Storage node in a flow. This node stores the input in an Amazon S3 location that you specify.
" + }, + "StorageFlowNodeS3Configuration":{ + "type":"structure", + "required":["bucketName"], + "members":{ + "bucketName":{ + "shape":"S3BucketName", + "documentation":"The name of the Amazon S3 bucket in which to store the input into the node.
" + } + }, + "documentation":"Contains configurations for the Amazon S3 location in which to store the input into the node.
" + }, + "StorageFlowNodeServiceConfiguration":{ + "type":"structure", + "members":{ + "s3":{ + "shape":"StorageFlowNodeS3Configuration", + "documentation":"Contains configurations for the Amazon S3 location in which to store the input into the node.
" + } + }, + "documentation":"Contains configurations for the service to use for storing the input into the node.
", + "union":true + }, "String":{"type":"string"}, "TagKey":{ "type":"string", @@ -4226,7 +7226,7 @@ "type":"string", "max":1011, "min":20, - "pattern":"(^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:(agent|agent-alias|knowledge-base)/[A-Z0-9]{10}(?:/[A-Z0-9]{10})?$)" + "pattern":"(^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:(agent|agent-alias|knowledge-base|flow|prompt)/[A-Z0-9]{10}(?:/[A-Z0-9]{10})?$|^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:flow/([A-Z0-9]{10})/alias/([A-Z0-9]{10})$|^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:prompt/([A-Z0-9]{10})?(?::/d+)?$)" }, "TagsMap":{ "type":"map", @@ -4239,6 +7239,28 @@ "max":1, "min":0 }, + "TextPrompt":{ + "type":"string", + "max":200000, + "min":1, + "sensitive":true + }, + "TextPromptTemplateConfiguration":{ + "type":"structure", + "required":["text"], + "members":{ + "inputVariables":{ + "shape":"PromptInputVariablesList", + "documentation":"An array of the variables in the prompt template.
" + }, + "text":{ + "shape":"TextPrompt", + "documentation":"The message for the prompt.
" + } + }, + "documentation":"Contains configurations for a text prompt template. To include a variable, enclose a word in double curly braces as in {{variable}}.
When the service applies the transformation.
" + }, + "transformationFunction":{ + "shape":"TransformationFunction", + "documentation":"A Lambda function that processes documents.
" + } + }, + "documentation":"A custom processing step for documents moving through a data source ingestion pipeline. To process documents after they have been converted into chunks, set the step to apply to POST_CHUNKING.
The Lambda function.
" + } + }, + "documentation":"A Lambda function that processes documents.
" + }, + "TransformationLambdaConfiguration":{ + "type":"structure", + "required":["lambdaArn"], + "members":{ + "lambdaArn":{ + "shape":"LambdaArn", + "documentation":"The function's ARN identifier.
" + } + }, + "documentation":"A Lambda function that processes documents.
" + }, + "Transformations":{ + "type":"list", + "member":{"shape":"Transformation"}, + "max":1, + "min":1 + }, "Type":{ "type":"string", "enum":[ @@ -4503,6 +7571,10 @@ "shape":"Instruction", "documentation":"Specifies new instructions that tell the agent what it should do and how it should interact with users.
" }, + "memoryConfiguration":{ + "shape":"MemoryConfiguration", + "documentation":"Specifies the new memory configuration for the agent.
" + }, "promptOverrideConfiguration":{ "shape":"PromptOverrideConfiguration", "documentation":"Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
" @@ -4530,11 +7602,11 @@ "members":{ "dataDeletionPolicy":{ "shape":"DataDeletionPolicy", - "documentation":"The data deletion policy of the updated data source.
" + "documentation":"The data deletion policy for the data source that you want to update.
" }, "dataSourceConfiguration":{ "shape":"DataSourceConfiguration", - "documentation":"Contains details about the storage configuration of the data source.
" + "documentation":"The connection configuration for the data source that you want to update.
" }, "dataSourceId":{ "shape":"Id", @@ -4548,7 +7620,7 @@ }, "knowledgeBaseId":{ "shape":"Id", - "documentation":"The unique identifier of the knowledge base to which the data source belongs.
", + "documentation":"The unique identifier of the knowledge base for the data source.
", "location":"uri", "locationName":"knowledgeBaseId" }, @@ -4576,6 +7648,182 @@ } } }, + "UpdateFlowAliasRequest":{ + "type":"structure", + "required":[ + "aliasIdentifier", + "flowIdentifier", + "name", + "routingConfiguration" + ], + "members":{ + "aliasIdentifier":{ + "shape":"FlowAliasIdentifier", + "documentation":"The unique identifier of the alias.
", + "location":"uri", + "locationName":"aliasIdentifier" + }, + "description":{ + "shape":"Description", + "documentation":"A description for the flow alias.
" + }, + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow.
", + "location":"uri", + "locationName":"flowIdentifier" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the flow alias.
" + }, + "routingConfiguration":{ + "shape":"FlowAliasRoutingConfiguration", + "documentation":"Contains information about the version to which to map the alias.
" + } + } + }, + "UpdateFlowAliasResponse":{ + "type":"structure", + "required":[ + "arn", + "createdAt", + "flowId", + "id", + "name", + "routingConfiguration", + "updatedAt" + ], + "members":{ + "arn":{ + "shape":"FlowAliasArn", + "documentation":"The Amazon Resource Name (ARN) of the flow.
" + }, + "createdAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the flow was created.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the flow.
" + }, + "flowId":{ + "shape":"FlowId", + "documentation":"The unique identifier of the flow.
" + }, + "id":{ + "shape":"FlowAliasId", + "documentation":"The unique identifier of the alias.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the flow alias.
" + }, + "routingConfiguration":{ + "shape":"FlowAliasRoutingConfiguration", + "documentation":"Contains information about the version that the alias is mapped to.
" + }, + "updatedAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the flow alias was last updated.
" + } + } + }, + "UpdateFlowRequest":{ + "type":"structure", + "required":[ + "executionRoleArn", + "flowIdentifier", + "name" + ], + "members":{ + "customerEncryptionKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.
" + }, + "definition":{ + "shape":"FlowDefinition", + "documentation":"A definition of the nodes and the connections between the nodes in the flow.
" + }, + "description":{ + "shape":"FlowDescription", + "documentation":"A description for the flow.
" + }, + "executionRoleArn":{ + "shape":"FlowExecutionRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
" + }, + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow.
", + "location":"uri", + "locationName":"flowIdentifier" + }, + "name":{ + "shape":"FlowName", + "documentation":"A name for the flow.
" + } + } + }, + "UpdateFlowResponse":{ + "type":"structure", + "required":[ + "arn", + "createdAt", + "executionRoleArn", + "id", + "name", + "status", + "updatedAt", + "version" + ], + "members":{ + "arn":{ + "shape":"FlowArn", + "documentation":"The Amazon Resource Name (ARN) of the flow.
" + }, + "createdAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the flow was created.
" + }, + "customerEncryptionKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the KMS key that the flow was encrypted with.
" + }, + "definition":{ + "shape":"FlowDefinition", + "documentation":"A definition of the nodes and the connections between nodes in the flow.
" + }, + "description":{ + "shape":"FlowDescription", + "documentation":"The description of the flow.
" + }, + "executionRoleArn":{ + "shape":"FlowExecutionRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
" + }, + "id":{ + "shape":"FlowId", + "documentation":"The unique identifier of the flow.
" + }, + "name":{ + "shape":"FlowName", + "documentation":"The name of the flow.
" + }, + "status":{ + "shape":"FlowStatus", + "documentation":"The status of the flow. When you submit this request, the status will be NotPrepared. If updating fails, the status becomes Failed.
The time at which the flow was last updated.
" + }, + "version":{ + "shape":"DraftVersion", + "documentation":"The version of the flow. When you update a flow, the version updated is the DRAFT version.
The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
" + }, + "defaultVariant":{ + "shape":"PromptVariantName", + "documentation":"The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
A description for the prompt.
" + }, + "name":{ + "shape":"PromptName", + "documentation":"A name for the prompt.
" + }, + "promptIdentifier":{ + "shape":"PromptIdentifier", + "documentation":"The unique identifier of the prompt.
", + "location":"uri", + "locationName":"promptIdentifier" + }, + "variants":{ + "shape":"PromptVariantList", + "documentation":"A list of objects, each containing details about a variant of the prompt.
" + } + } + }, + "UpdatePromptResponse":{ + "type":"structure", + "required":[ + "arn", + "createdAt", + "id", + "name", + "updatedAt", + "version" + ], + "members":{ + "arn":{ + "shape":"PromptArn", + "documentation":"The Amazon Resource Name (ARN) of the prompt.
" + }, + "createdAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the prompt was created.
" + }, + "customerEncryptionKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
" + }, + "defaultVariant":{ + "shape":"PromptVariantName", + "documentation":"The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
The description of the prompt.
" + }, + "id":{ + "shape":"PromptId", + "documentation":"The unique identifier of the prompt.
" + }, + "name":{ + "shape":"PromptName", + "documentation":"The name of the prompt.
" + }, + "updatedAt":{ + "shape":"DateTimestamp", + "documentation":"The time at which the prompt was last updated.
" + }, + "variants":{ + "shape":"PromptVariantList", + "documentation":"A list of objects, each containing details about a variant of the prompt.
" + }, + "version":{ + "shape":"Version", + "documentation":"The version of the prompt. When you update a prompt, the version updated is the DRAFT version.
One or more seed or starting point URLs.
" + } + }, + "documentation":"The configuration of web URLs that you want to crawl. You should be authorized to crawl the URLs.
" + }, "ValidationException":{ "type":"structure", "members":{ @@ -4668,6 +8018,14 @@ "chunkingConfiguration":{ "shape":"ChunkingConfiguration", "documentation":"Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
" + }, + "customTransformationConfiguration":{ + "shape":"CustomTransformationConfiguration", + "documentation":"A custom document transformer for parsed data source documents.
" + }, + "parsingConfiguration":{ + "shape":"ParsingConfiguration", + "documentation":"A custom parser for data source documents.
" } }, "documentation":"Contains details about how to ingest the documents in a data source.
" @@ -4692,6 +8050,77 @@ "max":5, "min":1, "pattern":"^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$" + }, + "WebCrawlerConfiguration":{ + "type":"structure", + "members":{ + "crawlerLimits":{ + "shape":"WebCrawlerLimits", + "documentation":"The configuration of crawl limits for the web URLs.
" + }, + "exclusionFilters":{ + "shape":"FilterList", + "documentation":"A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
" + }, + "inclusionFilters":{ + "shape":"FilterList", + "documentation":"A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
" + }, + "scope":{ + "shape":"WebScopeType", + "documentation":"The scope of what is crawled for your URLs.
You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL \"https://docs.aws.amazon.com/bedrock/latest/userguide/\" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain \"aws.amazon.com\" can also include sub domain \"docs.aws.amazon.com\".
" + } + }, + "documentation":"The configuration of web URLs that you want to crawl. You should be authorized to crawl the URLs.
" + }, + "WebCrawlerLimits":{ + "type":"structure", + "members":{ + "rateLimit":{ + "shape":"WebCrawlerLimitsRateLimitInteger", + "documentation":"The max rate at which pages are crawled, up to 300 per minute per host.
" + } + }, + "documentation":"The rate limits for the URLs that you want to crawl. You should be authorized to crawl the URLs.
" + }, + "WebCrawlerLimitsRateLimitInteger":{ + "type":"integer", + "box":true, + "max":300, + "min":1 + }, + "WebDataSourceConfiguration":{ + "type":"structure", + "required":["sourceConfiguration"], + "members":{ + "crawlerConfiguration":{ + "shape":"WebCrawlerConfiguration", + "documentation":"The Web Crawler configuration details for the web data source.
" + }, + "sourceConfiguration":{ + "shape":"WebSourceConfiguration", + "documentation":"The source configuration details for the web data source.
" + } + }, + "documentation":"The configuration details for the web data source.
" + }, + "WebScopeType":{ + "type":"string", + "enum":[ + "HOST_ONLY", + "SUBDOMAINS" + ] + }, + "WebSourceConfiguration":{ + "type":"structure", + "required":["urlConfiguration"], + "members":{ + "urlConfiguration":{ + "shape":"UrlConfiguration", + "documentation":"The configuration of the URL/URLs.
" + } + }, + "documentation":"The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.
" } }, "documentation":"Describes the API operations for creating and managing Amazon Bedrock agents.
" diff --git a/botocore/data/bedrock-runtime/2023-09-30/service-2.json b/botocore/data/bedrock-runtime/2023-09-30/service-2.json index 84dc4609ed..e3214f4fac 100644 --- a/botocore/data/bedrock-runtime/2023-09-30/service-2.json +++ b/botocore/data/bedrock-runtime/2023-09-30/service-2.json @@ -12,6 +12,25 @@ "uid":"bedrock-runtime-2023-09-30" }, "operations":{ + "ApplyGuardrail":{ + "name":"ApplyGuardrail", + "http":{ + "method":"POST", + "requestUri":"/guardrail/{guardrailIdentifier}/version/{guardrailVersion}/apply", + "responseCode":200 + }, + "input":{"shape":"ApplyGuardrailRequest"}, + "output":{"shape":"ApplyGuardrailResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"The action to apply a guardrail.
" + }, "Converse":{ "name":"Converse", "http":{ @@ -119,6 +138,64 @@ }, "documentation":"The model must request at least one tool (no text is generated). For example, {\"any\" : {}}.
The guardrail identifier used in the request to apply the guardrail.
", + "location":"uri", + "locationName":"guardrailIdentifier" + }, + "guardrailVersion":{ + "shape":"GuardrailVersion", + "documentation":"The guardrail version used in the request to apply the guardrail.
", + "location":"uri", + "locationName":"guardrailVersion" + }, + "source":{ + "shape":"GuardrailContentSource", + "documentation":"The source of data used in the request to apply the guardrail.
" + }, + "content":{ + "shape":"GuardrailContentBlockList", + "documentation":"The content details used in the request to apply the guardrail.
" + } + } + }, + "ApplyGuardrailResponse":{ + "type":"structure", + "required":[ + "usage", + "action", + "outputs", + "assessments" + ], + "members":{ + "usage":{ + "shape":"GuardrailUsage", + "documentation":"The usage details in the response from the guardrail.
" + }, + "action":{ + "shape":"GuardrailAction", + "documentation":"The action taken in the response from the guardrail.
" + }, + "outputs":{ + "shape":"GuardrailOutputContentList", + "documentation":"The output details in the response from the guardrail.
" + }, + "assessments":{ + "shape":"GuardrailAssessmentList", + "documentation":"The assessment details in the response from the guardrail.
" + } + } + }, "AutoToolChoice":{ "type":"structure", "members":{ @@ -148,7 +225,7 @@ }, "toolUse":{ "shape":"ToolUseBlock", - "documentation":"Information about a tool use request from a model.
" + "documentation":"Information about a tool use request from a model.
" }, "toolResult":{ "shape":"ToolResultBlock", @@ -159,7 +236,7 @@ "documentation":"Contains the content to assess with the guardrail. If you don't specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.
For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.
</p> A block of content for a message that you pass to, or receive from, a model with the Converse API (Converse and ConverseStream).
", + "documentation":"A block of content for a message that you pass to, or receive from, a model with the Converse or ConverseStream API operations.
", "union":true }, "ContentBlockDelta":{ @@ -383,7 +460,7 @@ }, "trace":{ "shape":"ConverseStreamTrace", - "documentation":"The trace object in the response from ConverseStream that contains information about the guardrail behavior.
" + "documentation":"The trace object in the response from ConverseStream that contains information about the guardrail behavior.
" } }, "documentation":"A conversation stream metadata event.
", @@ -519,7 +596,7 @@ "documentation":"The guardrail trace object.
" } }, - "documentation":"The trace object in a response from ConverseStream. Currently, you can only trace guardrails.
" + "documentation":"The trace object in a response from ConverseStream. Currently, you can only trace guardrails.
" }, "ConverseTrace":{ "type":"structure", @@ -529,7 +606,7 @@ "documentation":"The guardrail trace object.
" } }, - "documentation":"The trace object in a response from Converse. Currently, you can only trace guardrails.
" + "documentation":"The trace object in a response from Converse. Currently, you can only trace guardrails.
" }, "Document":{ "type":"structure", @@ -551,14 +628,14 @@ }, "name":{ "shape":"DocumentBlockNameString", - "documentation":"A name for the document.
" + "documentation":"A name for the document. The name can only contain the following characters:
Alphanumeric characters
Whitespace characters (no more than one in a row)
Hyphens
Parentheses
Square brackets
This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.
Contains the content of the document.
" } }, - "documentation":"A document to include in a message when sending a Converse or ConverseStream request. You can include up to 5 documents in a request. The maximum document size is 50 MB.
" + "documentation":"A document to include in a message.
" }, "DocumentBlockNameString":{ "type":"string", @@ -584,16 +661,23 @@ "members":{ "bytes":{ "shape":"DocumentSourceBytesBlob", - "documentation":"A base64-encoded string of a UTF-8 encoded file, that is the document to include in the message.
" + "documentation":"The raw bytes for the document. If you use an Amazon Web Services SDK, you don't need to encode the bytes in base64.
" } }, - "documentation":"Contains the content of the document included in a message when sending a Converse or ConverseStream request or in the response.
", + "documentation":"Contains the content of a document.
", "union":true }, "DocumentSourceBytesBlob":{ "type":"blob", "min":1 }, + "GuardrailAction":{ + "type":"string", + "enum":[ + "NONE", + "GUARDRAIL_INTERVENED" + ] + }, "GuardrailAssessment":{ "type":"structure", "members":{ @@ -612,6 +696,10 @@ "sensitiveInformationPolicy":{ "shape":"GuardrailSensitiveInformationPolicyAssessment", "documentation":"The sensitive information policy.
" + }, + "contextualGroundingPolicy":{ + "shape":"GuardrailContextualGroundingPolicyAssessment", + "documentation":"The contextual grounding policy used for the guardrail assessment.
" } }, "documentation":"A behavior assessment of the guardrail policies used in a call to the Converse API.
" @@ -650,7 +738,22 @@ "documentation":"The trace behavior for the guardrail.
" } }, - "documentation":"Configuration information for a guardrail that you use with the Converse action.
" + "documentation":"Configuration information for a guardrail that you use with the Converse operation.
" + }, + "GuardrailContentBlock":{ + "type":"structure", + "members":{ + "text":{ + "shape":"GuardrailTextBlock", + "documentation":"Text within content block to be evaluated by the guardrail.
" + } + }, + "documentation":"The content block to be evaluated by the guardrail.
", + "union":true + }, + "GuardrailContentBlockList":{ + "type":"list", + "member":{"shape":"GuardrailContentBlock"} }, "GuardrailContentFilter":{ "type":"structure", @@ -714,6 +817,101 @@ }, "documentation":"An assessment of a content policy for a guardrail.
" }, + "GuardrailContentPolicyUnitsProcessed":{ + "type":"integer", + "box":true + }, + "GuardrailContentQualifier":{ + "type":"string", + "enum":[ + "grounding_source", + "query", + "guard_content" + ] + }, + "GuardrailContentQualifierList":{ + "type":"list", + "member":{"shape":"GuardrailContentQualifier"} + }, + "GuardrailContentSource":{ + "type":"string", + "enum":[ + "INPUT", + "OUTPUT" + ] + }, + "GuardrailContextualGroundingFilter":{ + "type":"structure", + "required":[ + "type", + "threshold", + "score", + "action" + ], + "members":{ + "type":{ + "shape":"GuardrailContextualGroundingFilterType", + "documentation":"The contextual grounding filter type.
" + }, + "threshold":{ + "shape":"GuardrailContextualGroundingFilterThresholdDouble", + "documentation":"The threshold used by contextual grounding filter to determine whether the content is grounded or not.
" + }, + "score":{ + "shape":"GuardrailContextualGroundingFilterScoreDouble", + "documentation":"The score generated by contextual grounding filter.
" + }, + "action":{ + "shape":"GuardrailContextualGroundingPolicyAction", + "documentation":"The action performed by the guardrails contextual grounding filter.
" + } + }, + "documentation":"The details for the guardrails contextual grounding filter.
" + }, + "GuardrailContextualGroundingFilterScoreDouble":{ + "type":"double", + "box":true, + "max":1, + "min":0 + }, + "GuardrailContextualGroundingFilterThresholdDouble":{ + "type":"double", + "box":true, + "max":1, + "min":0 + }, + "GuardrailContextualGroundingFilterType":{ + "type":"string", + "enum":[ + "GROUNDING", + "RELEVANCE" + ] + }, + "GuardrailContextualGroundingFilters":{ + "type":"list", + "member":{"shape":"GuardrailContextualGroundingFilter"} + }, + "GuardrailContextualGroundingPolicyAction":{ + "type":"string", + "enum":[ + "BLOCKED", + "NONE" + ] + }, + "GuardrailContextualGroundingPolicyAssessment":{ + "type":"structure", + "members":{ + "filters":{ + "shape":"GuardrailContextualGroundingFilters", + "documentation":"The filter details for the guardrails contextual grounding filter.
" + } + }, + "documentation":"The policy assessment details for the guardrails contextual grounding filter.
" + }, + "GuardrailContextualGroundingPolicyUnitsProcessed":{ + "type":"integer", + "box":true + }, "GuardrailConverseContentBlock":{ "type":"structure", "members":{ @@ -722,9 +920,21 @@ "documentation":"The text to guard.
" } }, - "documentation":"A content block for selective guarding with the Converse API (Converse and ConverseStream).
", + "documentation":"A content block for selective guarding with the Converse or ConverseStream API operations.
", "union":true }, + "GuardrailConverseContentQualifier":{ + "type":"string", + "enum":[ + "grounding_source", + "query", + "guard_content" + ] + }, + "GuardrailConverseContentQualifierList":{ + "type":"list", + "member":{"shape":"GuardrailConverseContentQualifier"} + }, "GuardrailConverseTextBlock":{ "type":"structure", "required":["text"], @@ -732,6 +942,10 @@ "text":{ "shape":"String", "documentation":"The text that you want to guard.
" + }, + "qualifiers":{ + "shape":"GuardrailConverseContentQualifierList", + "documentation":"The qualifier details for the guardrails contextual grounding filter.
" } }, "documentation":"A text block that contains text that you want to assess with a guardrail. For more information, see GuardrailConverseContentBlock.
" @@ -795,6 +1009,20 @@ "type":"string", "enum":["PROFANITY"] }, + "GuardrailOutputContent":{ + "type":"structure", + "members":{ + "text":{ + "shape":"GuardrailOutputText", + "documentation":"The specific text for the output content produced by the guardrail.
" + } + }, + "documentation":"The output content produced by the guardrail.
" + }, + "GuardrailOutputContentList":{ + "type":"list", + "member":{"shape":"GuardrailOutputContent"} + }, "GuardrailOutputText":{"type":"string"}, "GuardrailPiiEntityFilter":{ "type":"structure", @@ -911,6 +1139,14 @@ }, "documentation":"The assessment for aPersonally Identifiable Information (PII) policy.
" }, + "GuardrailSensitiveInformationPolicyFreeUnitsProcessed":{ + "type":"integer", + "box":true + }, + "GuardrailSensitiveInformationPolicyUnitsProcessed":{ + "type":"integer", + "box":true + }, "GuardrailStreamConfiguration":{ "type":"structure", "required":[ @@ -944,6 +1180,21 @@ "async" ] }, + "GuardrailTextBlock":{ + "type":"structure", + "required":["text"], + "members":{ + "text":{ + "shape":"String", + "documentation":"The input text details to be evaluated by the guardrail.
" + }, + "qualifiers":{ + "shape":"GuardrailContentQualifierList", + "documentation":"The qualifiers describing the text block.
" + } + }, + "documentation":"The text block to be evaluated by the guardrail.
" + }, "GuardrailTopic":{ "type":"structure", "required":[ @@ -986,6 +1237,10 @@ }, "documentation":"A behavior assessment of a topic policy.
" }, + "GuardrailTopicPolicyUnitsProcessed":{ + "type":"integer", + "box":true + }, "GuardrailTopicType":{ "type":"string", "enum":["DENY"] @@ -1015,6 +1270,44 @@ }, "documentation":"A Top level guardrail trace object. For more information, see ConverseTrace.
" }, + "GuardrailUsage":{ + "type":"structure", + "required":[ + "topicPolicyUnits", + "contentPolicyUnits", + "wordPolicyUnits", + "sensitiveInformationPolicyUnits", + "sensitiveInformationPolicyFreeUnits", + "contextualGroundingPolicyUnits" + ], + "members":{ + "topicPolicyUnits":{ + "shape":"GuardrailTopicPolicyUnitsProcessed", + "documentation":"The topic policy units processed by the guardrail.
" + }, + "contentPolicyUnits":{ + "shape":"GuardrailContentPolicyUnitsProcessed", + "documentation":"The content policy units processed by the guardrail.
" + }, + "wordPolicyUnits":{ + "shape":"GuardrailWordPolicyUnitsProcessed", + "documentation":"The word policy units processed by the guardrail.
" + }, + "sensitiveInformationPolicyUnits":{ + "shape":"GuardrailSensitiveInformationPolicyUnitsProcessed", + "documentation":"The sensitive information policy units processed by the guardrail.
" + }, + "sensitiveInformationPolicyFreeUnits":{ + "shape":"GuardrailSensitiveInformationPolicyFreeUnitsProcessed", + "documentation":"The sensitive information policy free units processed by the guardrail.
" + }, + "contextualGroundingPolicyUnits":{ + "shape":"GuardrailContextualGroundingPolicyUnitsProcessed", + "documentation":"The contextual grounding policy units processed by the guardrail.
" + } + }, + "documentation":"The details on the use of the guardrail.
" + }, "GuardrailVersion":{ "type":"string", "pattern":"(([1-9][0-9]{0,7})|(DRAFT))" @@ -1041,6 +1334,10 @@ }, "documentation":"The word policy assessment.
" }, + "GuardrailWordPolicyUnitsProcessed":{ + "type":"integer", + "box":true + }, "ImageBlock":{ "type":"structure", "required":[ @@ -1073,7 +1370,7 @@ "members":{ "bytes":{ "shape":"ImageSourceBytesBlob", - "documentation":"The raw image bytes for the image. If you use an AWS SDK, you don't need to base64 encode the image bytes.
" + "documentation":"The raw image bytes for the image. If you use an AWS SDK, you don't need to encode the image bytes in base64.
" } }, "documentation":"The source for an image.
", @@ -1301,7 +1598,7 @@ }, "content":{ "shape":"ContentBlocks", - "documentation":"The message content.
" + "documentation":"The message content. Note the following restrictions:
You can include up to 20 images. Each image's size, height, and width must be no more than 3.75 MB, 8000 px, and 8000 px, respectively.
You can include up to five documents. Each document's size must be no more than 4.5 MB.
If you include a ContentBlock with a document field in the array, you must also include a ContentBlock with a text field.
You can only include images and documents if the role is user.
A message input, or returned from, a call to Converse or ConverseStream.
" @@ -1531,7 +1828,7 @@ }, "guardContent":{ "shape":"GuardrailConverseContentBlock", - "documentation":"A content block to assess with the guardrail. Use with the Converse API (Converse and ConverseStream).
For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.
" + "documentation":"A content block to assess with the guardrail. Use with the Converse or ConverseStream API operations.
For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.
" } }, "documentation":"A system content block.
", @@ -1599,7 +1896,7 @@ "documentation":"The specfication for the tool.
" } }, - "documentation":"Information about a tool that you can use with the Converse API.
", + "documentation":"Information about a tool that you can use with the Converse API. For more information, see Tool use (function calling) in the Amazon Bedrock User Guide.
", "union":true }, "ToolChoice":{ @@ -1634,7 +1931,7 @@ "documentation":"If supported by model, forces the model to request a tool.
" } }, - "documentation":"Configuration information for the tools that you pass to a model.
This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.
Configuration information for the tools that you pass to a model. For more information, see Tool use (function calling) in the Amazon Bedrock User Guide.
This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.
Creates a guardrail to block topics and to filter out harmful content.
Specify a name and optional description.
Specify messages for when the guardrail successfully blocks a prompt or a model response in the blockedInputMessaging and blockedOutputsMessaging fields.
Specify topics for the guardrail to deny in the topicPolicyConfig object. Each GuardrailTopicConfig object in the topicsConfig list pertains to one topic.
Give a name and description so that the guardrail can properly identify the topic.
Specify DENY in the type field.
(Optional) Provide up to five prompts that you would categorize as belonging to the topic in the examples list.
Specify filter strengths for the harmful categories defined in Amazon Bedrock in the contentPolicyConfig object. Each GuardrailContentFilterConfig object in the filtersConfig list pertains to a harmful category. For more information, see Content filters. For more information about the fields in a content filter, see GuardrailContentFilterConfig.
Specify the category in the type field.
Specify the strength of the filter for prompts in the inputStrength field and for model responses in the strength field of the GuardrailContentFilterConfig.
(Optional) For security, include the ARN of a KMS key in the kmsKeyId field.
(Optional) Attach any tags to the guardrail in the tags object. For more information, see Tag resources.
Creates a guardrail to block topics and to implement safeguards for your generative AI applications.
You can configure the following policies in a guardrail to avoid undesirable and harmful content, filter out denied topics and words, and remove sensitive information for privacy protection.
Content filters - Adjust filter strengths to block input prompts or model responses containing harmful content.
Denied topics - Define a set of topics that are undesirable in the context of your application. These topics will be blocked if detected in user queries or model responses.
Word filters - Configure filters to block undesirable words, phrases, and profanity. Such words can include offensive terms, competitor names etc.
Sensitive information filters - Block or mask sensitive information such as personally identifiable information (PII) or custom regex in user inputs and model responses.
In addition to the above policies, you can also configure the messages to be returned to the user if a user input or model response is in violation of the policies defined in the guardrail.
For more information, see Guardrails for Amazon Bedrock in the Amazon Bedrock User Guide.
" }, "CreateGuardrailVersion":{ "name":"CreateGuardrailVersion", @@ -551,7 +551,7 @@ {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], - "documentation":"Updates a guardrail with the values you specify.
Specify a name and optional description.
Specify messages for when the guardrail successfully blocks a prompt or a model response in the blockedInputMessaging and blockedOutputsMessaging fields.
Specify topics for the guardrail to deny in the topicPolicyConfig object. Each GuardrailTopicConfig object in the topicsConfig list pertains to one topic.
Give a name and description so that the guardrail can properly identify the topic.
Specify DENY in the type field.
(Optional) Provide up to five prompts that you would categorize as belonging to the topic in the examples list.
Specify filter strengths for the harmful categories defined in Amazon Bedrock in the contentPolicyConfig object. Each GuardrailContentFilterConfig object in the filtersConfig list pertains to a harmful category. For more information, see Content filters. For more information about the fields in a content filter, see GuardrailContentFilterConfig.
Specify the category in the type field.
Specify the strength of the filter for prompts in the inputStrength field and for model responses in the strength field of the GuardrailContentFilterConfig.
(Optional) For security, include the ARN of a KMS key in the kmsKeyId field.
(Optional) Attach any tags to the guardrail in the tags object. For more information, see Tag resources.
Updates a guardrail with the values you specify.
Specify a name and optional description.
Specify messages for when the guardrail successfully blocks a prompt or a model response in the blockedInputMessaging and blockedOutputsMessaging fields.
Specify topics for the guardrail to deny in the topicPolicyConfig object. Each GuardrailTopicConfig object in the topicsConfig list pertains to one topic.
Give a name and description so that the guardrail can properly identify the topic.
Specify DENY in the type field.
(Optional) Provide up to five prompts that you would categorize as belonging to the topic in the examples list.
Specify filter strengths for the harmful categories defined in Amazon Bedrock in the contentPolicyConfig object. Each GuardrailContentFilterConfig object in the filtersConfig list pertains to a harmful category. For more information, see Content filters. For more information about the fields in a content filter, see GuardrailContentFilterConfig.
Specify the category in the type field.
Specify the strength of the filter for prompts in the inputStrength field and for model responses in the strength field of the GuardrailContentFilterConfig.
(Optional) For security, include the ARN of a KMS key in the kmsKeyId field.
The sensitive information policy to configure for the guardrail.
" }, + "contextualGroundingPolicyConfig":{ + "shape":"GuardrailContextualGroundingPolicyConfig", + "documentation":"The contextual grounding policy configuration used to create a guardrail.
" + }, "blockedInputMessaging":{ "shape":"GuardrailBlockedMessaging", "documentation":"The message to return when the guardrail blocks a prompt.
" @@ -795,11 +799,11 @@ }, "guardrailArn":{ "shape":"GuardrailArn", - "documentation":"The ARN of the guardrail that was created.
" + "documentation":"The ARN of the guardrail.
" }, "version":{ "shape":"GuardrailDraftVersion", - "documentation":"The version of the guardrail that was created. This value should be 1.
" + "documentation":"The version of the guardrail that was created. This value will always be DRAFT.
The unique identifier of the guardrail.
", + "documentation":"The unique identifier of the guardrail. This can be an ID or the ARN.
", "location":"uri", "locationName":"guardrailIdentifier" }, @@ -1054,7 +1058,7 @@ "members":{ "guardrailIdentifier":{ "shape":"GuardrailIdentifier", - "documentation":"The unique identifier of the guardrail.
", + "documentation":"The unique identifier of the guardrail. This can be an ID or the ARN.
", "location":"uri", "locationName":"guardrailIdentifier" }, @@ -1723,7 +1727,7 @@ "members":{ "guardrailIdentifier":{ "shape":"GuardrailIdentifier", - "documentation":"The unique identifier of the guardrail for which to get details.
", + "documentation":"The unique identifier of the guardrail for which to get details. This can be an ID or the ARN.
", "location":"uri", "locationName":"guardrailIdentifier" }, @@ -1763,7 +1767,7 @@ }, "guardrailArn":{ "shape":"GuardrailArn", - "documentation":"The ARN of the guardrail that was created.
" + "documentation":"The ARN of the guardrail.
" }, "version":{ "shape":"GuardrailVersion", @@ -1789,6 +1793,10 @@ "shape":"GuardrailSensitiveInformationPolicy", "documentation":"The sensitive information policy that was configured for the guardrail.
" }, + "contextualGroundingPolicy":{ + "shape":"GuardrailContextualGroundingPolicy", + "documentation":"The contextual grounding policy used in the guardrail.
" + }, "createdAt":{ "shape":"Timestamp", "documentation":"The date and time at which the guardrail was created.
" @@ -2083,7 +2091,7 @@ "documentation":"The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
" } }, - "documentation":"Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.
Hate – Describes language or a statement that discriminates, criticizes, insults, denounces, or dehumanizes a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).
Insults – Describes language or a statement that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.
Sexual – Describes language or a statement that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.
Violence – Describes language or a statement that includes glorification of or threats to inflict physical pain, hurt, or injury toward a person, group or thing.
Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as Hate with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual with NONE confidence, and Violence with MEDIUM confidence.
For more information, see Guardrails content filters.
This data type is used in the following API operations:
" + "documentation":"Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.
Hate – Describes language or a statement that discriminates, criticizes, insults, denounces, or dehumanizes a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).
Insults – Describes language or a statement that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.
Sexual – Describes language or a statement that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.
Violence – Describes language or a statement that includes glorification of or threats to inflict physical pain, hurt, or injury toward a person, group or thing.
Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as Hate with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual with NONE confidence, and Violence with MEDIUM confidence.
For more information, see Guardrails content filters.
" }, "GuardrailContentFilterType":{ "type":"string", @@ -2127,7 +2135,92 @@ "documentation":"Contains the type of the content filter and how strongly it should apply to prompts and model responses.
" } }, - "documentation":"Contains details about how to handle harmful content.
This data type is used in the following API operations:
" + "documentation":"Contains details about how to handle harmful content.
" + }, + "GuardrailContextualGroundingFilter":{ + "type":"structure", + "required":[ + "type", + "threshold" + ], + "members":{ + "type":{ + "shape":"GuardrailContextualGroundingFilterType", + "documentation":"The filter type details for the guardrails contextual grounding filter.
" + }, + "threshold":{ + "shape":"GuardrailContextualGroundingFilterThresholdDouble", + "documentation":"The threshold details for the guardrails contextual grounding filter.
" + } + }, + "documentation":"The details for the guardrails contextual grounding filter.
" + }, + "GuardrailContextualGroundingFilterConfig":{ + "type":"structure", + "required":[ + "type", + "threshold" + ], + "members":{ + "type":{ + "shape":"GuardrailContextualGroundingFilterType", + "documentation":"The filter details for the guardrails contextual grounding filter.
" + }, + "threshold":{ + "shape":"GuardrailContextualGroundingFilterConfigThresholdDouble", + "documentation":"The threshold details for the guardrails contextual grounding filter.
" + } + }, + "documentation":"The filter configuration details for the guardrails contextual grounding filter.
" + }, + "GuardrailContextualGroundingFilterConfigThresholdDouble":{ + "type":"double", + "box":true, + "min":0 + }, + "GuardrailContextualGroundingFilterThresholdDouble":{ + "type":"double", + "box":true, + "min":0 + }, + "GuardrailContextualGroundingFilterType":{ + "type":"string", + "enum":[ + "GROUNDING", + "RELEVANCE" + ] + }, + "GuardrailContextualGroundingFilters":{ + "type":"list", + "member":{"shape":"GuardrailContextualGroundingFilter"}, + "min":1 + }, + "GuardrailContextualGroundingFiltersConfig":{ + "type":"list", + "member":{"shape":"GuardrailContextualGroundingFilterConfig"}, + "min":1 + }, + "GuardrailContextualGroundingPolicy":{ + "type":"structure", + "required":["filters"], + "members":{ + "filters":{ + "shape":"GuardrailContextualGroundingFilters", + "documentation":"The filter details for the guardrails contextual grounding policy.
" + } + }, + "documentation":"The details for the guardrails contextual grounding policy.
" + }, + "GuardrailContextualGroundingPolicyConfig":{ + "type":"structure", + "required":["filtersConfig"], + "members":{ + "filtersConfig":{ + "shape":"GuardrailContextualGroundingFiltersConfig", + "documentation":"The filter configuration details for the guardrails contextual grounding policy.
" + } + }, + "documentation":"The policy configuration details for the guardrails contextual grounding policy.
" }, "GuardrailDescription":{ "type":"string", @@ -2191,7 +2284,7 @@ "documentation":"ManagedWords$type The managed word type that was configured for the guardrail. (For now, we only offer profanity word list)
" } }, - "documentation":"The managed word list that was configured for the guardrail. (This is a list of words that are pre-defined and managed by Guardrails only.)
" + "documentation":"The managed word list that was configured for the guardrail. (This is a list of words that are pre-defined and managed by guardrails only.)
" }, "GuardrailManagedWordsConfig":{ "type":"structure", @@ -2256,7 +2349,7 @@ "members":{ "type":{ "shape":"GuardrailPiiEntityType", - "documentation":"Configure guardrail type when the PII entity is detected.
" + "documentation":"Configure guardrail type when the PII entity is detected.
The following PIIs are used to block or mask sensitive information:
General
ADDRESS
A physical address, such as \"100 Main Street, Anytown, USA\" or \"Suite #12, Building 123\". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood.
AGE
An individual's age, including the quantity and unit of time. For example, in the phrase \"I am 40 years old,\" Guarrails recognizes \"40 years\" as an age.
NAME
An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the \"John Doe Organization\" as an organization, and it recognizes \"Jane Doe Street\" as an address.
An email address, such as marymajor@email.com.
PHONE
A phone number. This entity type also includes fax and pager numbers.
USERNAME
A user name that identifies an account, such as a login name, screen name, nick name, or handle.
PASSWORD
An alphanumeric string that is used as a password, such as \"*very20special#pass*\".
DRIVER_ID
The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters.
LICENSE_PLATE
A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country.
VEHICLE_IDENTIFICATION_NUMBER
A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the ISO 3779 specification. Each country has specific codes and formats for VINs.
Finance
REDIT_DEBIT_CARD_CVV
A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code.
CREDIT_DEBIT_CARD_EXPIRY
The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as month/year or MM/YY. Guardrails recognizes expiration dates such as 01/21, 01/2021, and Jan 2021.
CREDIT_DEBIT_CARD_NUMBER
The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present.
PIN
A four-digit personal identification number (PIN) with which you can access your bank account.
INTERNATIONAL_BANK_ACCOUNT_NUMBER
An International Bank Account Number has specific formats in each country. For more information, see www.iban.com/structure.
SWIFT_CODE
A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.
SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.
IT
IP_ADDRESS
An IPv4 address, such as 198.51.100.0.
MAC_ADDRESS
A media access control (MAC) address is a unique identifier assigned to a network interface controller (NIC).
URL
A web address, such as www.example.com.
AWS_ACCESS_KEY
A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically.
AWS_SECRET_KEY
A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically.
USA specific
US_BANK_ACCOUNT_NUMBER
A US bank account number, which is typically 10 to 12 digits long.
US_BANK_ROUTING_NUMBER
A US bank account routing number. These are typically nine digits long,
US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER
A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a \"9\" and contain a \"7\" or \"8\" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits.
US_PASSPORT_NUMBER
A US passport number. Passport numbers range from six to nine alphanumeric characters.
US_SOCIAL_SECURITY_NUMBER
A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents.
Canada specific
CA_HEALTH_NUMBER
A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits.
CA_SOCIAL_INSURANCE_NUMBER
A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.
The SIN is formatted as three groups of three digits, such as 123-456-789. A SIN can be validated through a simple check-digit process called the Luhn algorithm.
UK Specific
UK_NATIONAL_HEALTH_SERVICE_NUMBER
A UK National Health Service Number is a 10-17 digit number, such as 485 777 3456. The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.
UK_NATIONAL_INSURANCE_NUMBER
A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.
The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.
UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.
Custom
Regex filter - You can use a regular expressions to define patterns for a guardrail to recognize and act upon such as serial number, booking ID etc..
Specifies to deny the topic.
" } }, - "documentation":"Details about topics for the guardrail to identify and deny.
This data type is used in the following API operations:
" + "documentation":"Details about topics for the guardrail to identify and deny.
" }, "GuardrailTopicDefinition":{ "type":"string", @@ -2604,7 +2697,7 @@ "documentation":"A list of policies related to topics that the guardrail should deny.
" } }, - "documentation":"Contains details about topics that the guardrail should identify and deny.
This data type is used in the following API operations:
" + "documentation":"Contains details about topics that the guardrail should identify and deny.
" }, "GuardrailTopicType":{ "type":"string", @@ -2998,7 +3091,7 @@ "members":{ "guardrailIdentifier":{ "shape":"GuardrailIdentifier", - "documentation":"The unique identifier of the guardrail.
", + "documentation":"The unique identifier of the guardrail. This can be an ID or the ARN.
", "location":"querystring", "locationName":"guardrailIdentifier" }, @@ -3782,7 +3875,7 @@ "members":{ "guardrailIdentifier":{ "shape":"GuardrailIdentifier", - "documentation":"The unique identifier of the guardrail
", + "documentation":"The unique identifier of the guardrail. This can be an ID or the ARN.
", "location":"uri", "locationName":"guardrailIdentifier" }, @@ -3810,6 +3903,10 @@ "shape":"GuardrailSensitiveInformationPolicyConfig", "documentation":"The sensitive information policy to configure for the guardrail.
" }, + "contextualGroundingPolicyConfig":{ + "shape":"GuardrailContextualGroundingPolicyConfig", + "documentation":"The contextual grounding policy configuration used to update a guardrail.
" + }, "blockedInputMessaging":{ "shape":"GuardrailBlockedMessaging", "documentation":"The message to return when the guardrail blocks a prompt.
" @@ -3839,7 +3936,7 @@ }, "guardrailArn":{ "shape":"GuardrailArn", - "documentation":"The ARN of the guardrail that was created.
" + "documentation":"The ARN of the guardrail.
" }, "version":{ "shape":"GuardrailDraftVersion", diff --git a/botocore/data/ec2/2016-11-15/service-2.json b/botocore/data/ec2/2016-11-15/service-2.json index 62feb5aa9c..25a037c10f 100644 --- a/botocore/data/ec2/2016-11-15/service-2.json +++ b/botocore/data/ec2/2016-11-15/service-2.json @@ -13230,7 +13230,7 @@ }, "Locale":{ "shape":"String", - "documentation":"In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.
Possible values: Any Amazon Web Services Region, such as us-east-1.
" + "documentation":"In IPAM, the locale is the Amazon Web Services Region or, for IPAM IPv4 pools in the public scope, the network border group for an Amazon Web Services Local Zone where you want to make an IPAM pool available for allocations (supported Local Zones). If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.
Possible values: Any Amazon Web Services Region, such as us-east-1.
" }, "SourceIpamPoolId":{ "shape":"IpamPoolId", @@ -14227,6 +14227,10 @@ "shape":"TagSpecificationList", "documentation":"The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see Local Zone availability in the Amazon EC2 User Guide.
" } } }, @@ -17673,6 +17677,10 @@ "PoolId":{ "shape":"Ipv4PoolEc2Id", "documentation":"The ID of the public IPv4 pool you want to delete.
" + }, + "NetworkBorderGroup":{ + "shape":"String", + "documentation":"The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see Local Zone availability in the Amazon EC2 User Guide.
" } } }, @@ -38005,7 +38013,7 @@ }, "NetworkBorderGroup":{ "shape":"String", - "documentation":"The network border group that the resource that the IP address is assigned to is in.
", + "documentation":"The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see Local Zone availability in the Amazon EC2 User Guide.
", "locationName":"networkBorderGroup" }, "SecurityGroups":{ @@ -38076,10 +38084,20 @@ "documentation":"The VPC ID.
", "locationName":"vpcId" }, + "NetworkInterfaceAttachmentStatus":{ + "shape":"IpamNetworkInterfaceAttachmentStatus", + "documentation":"For elastic IP addresses, this is the status of an attached network interface.
", + "locationName":"networkInterfaceAttachmentStatus" + }, "SampleTime":{ "shape":"MillisecondDateTime", "documentation":"The last successful resource discovery time.
", "locationName":"sampleTime" + }, + "AvailabilityZoneId":{ + "shape":"String", + "documentation":"The Availability Zone ID.
", + "locationName":"availabilityZoneId" } }, "documentation":"An IPAM discovered resource CIDR. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses. The discovered resource CIDR is the IP address range in CIDR notation that is associated with the resource.
" @@ -38134,6 +38152,13 @@ "max":128, "min":0 }, + "IpamNetworkInterfaceAttachmentStatus":{ + "type":"string", + "enum":[ + "available", + "in-use" + ] + }, "IpamOperatingRegion":{ "type":"structure", "members":{ @@ -38205,7 +38230,7 @@ }, "Locale":{ "shape":"String", - "documentation":"The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.
", + "documentation":"The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region or, for IPAM IPv4 pools in the public scope, the network border group for an Amazon Web Services Local Zone where you want to make an IPAM pool available for allocations (supported Local Zones). If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.
", "locationName":"locale" }, "PoolDepth":{ @@ -38687,6 +38712,11 @@ "shape":"String", "documentation":"The ID of a VPC.
", "locationName":"vpcId" + }, + "AvailabilityZoneId":{ + "shape":"String", + "documentation":"The Availability Zone ID.
", + "locationName":"availabilityZoneId" } }, "documentation":"The CIDR for an IPAM resource.
" @@ -48157,6 +48187,10 @@ "NetmaskLength":{ "shape":"Integer", "documentation":"The netmask length of the CIDR you would like to allocate to the public IPv4 pool.
" + }, + "NetworkBorderGroup":{ + "shape":"String", + "documentation":"The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see Local Zone availability in the Amazon EC2 User Guide.
" } } }, diff --git a/botocore/data/endpoints.json b/botocore/data/endpoints.json index 56460f6da0..6decd3e23e 100644 --- a/botocore/data/endpoints.json +++ b/botocore/data/endpoints.json @@ -3018,6 +3018,12 @@ "ca-central-1" : { "variants" : [ { "tags" : [ "dualstack" ] + }, { + "hostname" : "cloud9-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "cloud9-fips.ca-central-1.api.aws", + "tags" : [ "dualstack", "fips" ] } ] }, "eu-central-1" : { @@ -3050,6 +3056,41 @@ "tags" : [ "dualstack" ] } ] }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "cloud9-fips.ca-central-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "cloud9-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "cloud9-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "cloud9-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "cloud9-fips.us-west-2.amazonaws.com" + }, "il-central-1" : { "variants" : [ { "tags" : [ "dualstack" ] @@ -3068,58 +3109,189 @@ "us-east-1" : { "variants" : [ { "tags" : [ "dualstack" ] + }, { + "hostname" : "cloud9-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "cloud9-fips.us-east-1.api.aws", + "tags" : [ "dualstack", "fips" ] } ] }, "us-east-2" : { "variants" : [ { "tags" : [ "dualstack" ] + }, { + "hostname" : "cloud9-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "cloud9-fips.us-east-2.api.aws", + "tags" : [ "dualstack", "fips" ] } ] }, "us-west-1" : { "variants" : [ { "tags" : [ "dualstack" ] + }, { + "hostname" : "cloud9-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "cloud9-fips.us-west-1.api.aws", + "tags" : [ "dualstack", "fips" ] } ] }, "us-west-2" : { "variants" : [ { "tags" : [ "dualstack" ] + }, { + "hostname" : "cloud9-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "cloud9-fips.us-west-2.api.aws", + "tags" : [ "dualstack", "fips" ] } ] } } }, "cloudcontrolapi" : { "endpoints" : { - "af-south-1" : { }, - "ap-east-1" : { }, - "ap-northeast-1" : { }, - "ap-northeast-2" : { }, - "ap-northeast-3" : { }, - "ap-south-1" : { }, - "ap-south-2" : { }, - "ap-southeast-1" : { }, - "ap-southeast-2" : { }, - "ap-southeast-3" : { }, - "ap-southeast-4" : { }, + "af-south-1" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.af-south-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-east-1" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.ap-east-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-1" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.ap-northeast-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-2" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.ap-northeast-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-3" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.ap-northeast-3.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-south-1" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.ap-south-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-south-2" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.ap-south-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-1" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.ap-southeast-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-2" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.ap-southeast-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-3" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.ap-southeast-3.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-4" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.ap-southeast-4.api.aws", + "tags" : [ "dualstack" ] + } ] + }, "ca-central-1" : { "variants" : [ { "hostname" : "cloudcontrolapi-fips.ca-central-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "cloudcontrolapi-fips.ca-central-1.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "cloudcontrolapi.ca-central-1.api.aws", + "tags" : [ "dualstack" ] } ] }, "ca-west-1" : { "variants" : [ { "hostname" : "cloudcontrolapi-fips.ca-west-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "cloudcontrolapi-fips.ca-west-1.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "cloudcontrolapi.ca-west-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-central-1" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.eu-central-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-central-2" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.eu-central-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-north-1" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.eu-north-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-south-1" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.eu-south-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-south-2" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.eu-south-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-1" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.eu-west-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-2" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.eu-west-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-3" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.eu-west-3.api.aws", + "tags" : [ "dualstack" ] } ] }, - "eu-central-1" : { }, - "eu-central-2" : { }, - "eu-north-1" : { }, - "eu-south-1" : { }, - "eu-south-2" : { }, - "eu-west-1" : { }, - "eu-west-2" : { }, - "eu-west-3" : { }, "fips-ca-central-1" : { "credentialScope" : { "region" : "ca-central-1" @@ -3162,32 +3334,76 @@ "deprecated" : true, "hostname" : "cloudcontrolapi-fips.us-west-2.amazonaws.com" }, - "il-central-1" : { }, - "me-central-1" : { }, - "me-south-1" : { }, - "sa-east-1" : { }, + "il-central-1" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.il-central-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "me-central-1" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.me-central-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "me-south-1" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.me-south-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "sa-east-1" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.sa-east-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, "us-east-1" : { "variants" : [ { "hostname" : "cloudcontrolapi-fips.us-east-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "cloudcontrolapi-fips.us-east-1.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "cloudcontrolapi.us-east-1.api.aws", + "tags" : [ "dualstack" ] } ] }, "us-east-2" : { "variants" : [ { "hostname" : "cloudcontrolapi-fips.us-east-2.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "cloudcontrolapi-fips.us-east-2.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "cloudcontrolapi.us-east-2.api.aws", + "tags" : [ "dualstack" ] } ] }, "us-west-1" : { "variants" : [ { "hostname" : "cloudcontrolapi-fips.us-west-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "cloudcontrolapi-fips.us-west-1.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "cloudcontrolapi.us-west-1.api.aws", + "tags" : [ "dualstack" ] } ] }, "us-west-2" : { "variants" : [ { "hostname" : "cloudcontrolapi-fips.us-west-2.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "cloudcontrolapi-fips.us-west-2.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "cloudcontrolapi.us-west-2.api.aws", + "tags" : [ "dualstack" ] } ] } } @@ -19376,20 +19592,66 @@ }, "textract" : { "endpoints" : { - "ap-northeast-2" : { }, - "ap-south-1" : { }, - "ap-southeast-1" : { }, - "ap-southeast-2" : { }, + "ap-northeast-2" : { + "variants" : [ { + "hostname" : "textract.ap-northeast-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-south-1" : { + "variants" : [ { + "hostname" : "textract.ap-south-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-1" : { + "variants" : [ { + "hostname" : "textract.ap-southeast-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-2" : { + "variants" : [ { + "hostname" : "textract.ap-southeast-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, "ca-central-1" : { "variants" : [ { "hostname" : "textract-fips.ca-central-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "textract-fips.ca-central-1.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "textract.ca-central-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-central-1" : { + "variants" : [ { + "hostname" : "textract.eu-central-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-1" : { + "variants" : [ { + "hostname" : "textract.eu-west-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-2" : { + "variants" : [ { + "hostname" : "textract.eu-west-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-3" : { + "variants" : [ { + "hostname" : "textract.eu-west-3.api.aws", + "tags" : [ "dualstack" ] } ] }, - "eu-central-1" : { }, - "eu-west-1" : { }, - "eu-west-2" : { }, - "eu-west-3" : { }, "fips-ca-central-1" : { "credentialScope" : { "region" : "ca-central-1" @@ -19429,24 +19691,48 @@ "variants" : [ { "hostname" : "textract-fips.us-east-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "textract-fips.us-east-1.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "textract.us-east-1.api.aws", + "tags" : [ "dualstack" ] } ] }, "us-east-2" : { "variants" : [ { "hostname" : "textract-fips.us-east-2.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "textract-fips.us-east-2.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "textract.us-east-2.api.aws", + "tags" : [ "dualstack" ] } ] }, "us-west-1" : { "variants" : [ { "hostname" : "textract-fips.us-west-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "textract-fips.us-west-1.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "textract.us-west-1.api.aws", + "tags" : [ "dualstack" ] } ] }, "us-west-2" : { "variants" : [ { "hostname" : "textract-fips.us-west-2.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "textract-fips.us-west-2.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "textract.us-west-2.api.aws", + "tags" : [ "dualstack" ] } ] } } @@ -21556,8 +21842,18 @@ }, "cloudcontrolapi" : { "endpoints" : { - "cn-north-1" : { }, - "cn-northwest-1" : { } + "cn-north-1" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.cn-north-1.api.amazonwebservices.com.cn", + "tags" : [ "dualstack" ] + } ] + }, + "cn-northwest-1" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.cn-northwest-1.api.amazonwebservices.com.cn", + "tags" : [ "dualstack" ] + } ] + } } }, "cloudformation" : { @@ -23547,12 +23843,24 @@ "variants" : [ { "hostname" : "cloudcontrolapi-fips.us-gov-east-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "cloudcontrolapi-fips.us-gov-east-1.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "cloudcontrolapi.us-gov-east-1.api.aws", + "tags" : [ "dualstack" ] } ] }, "us-gov-west-1" : { "variants" : [ { "hostname" : "cloudcontrolapi-fips.us-gov-west-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "cloudcontrolapi-fips.us-gov-west-1.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "cloudcontrolapi.us-gov-west-1.api.aws", + "tags" : [ "dualstack" ] } ] } } @@ -27633,12 +27941,24 @@ "variants" : [ { "hostname" : "textract-fips.us-gov-east-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "textract-fips.us-gov-east-1.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "textract.us-gov-east-1.api.aws", + "tags" : [ "dualstack" ] } ] }, "us-gov-west-1" : { "variants" : [ { "hostname" : "textract-fips.us-gov-west-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "textract-fips.us-gov-west-1.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "textract.us-gov-west-1.api.aws", + "tags" : [ "dualstack" ] } ] } } diff --git a/botocore/data/glue/2017-03-31/service-2.json b/botocore/data/glue/2017-03-31/service-2.json index 60631635a8..5dcbb07199 100644 --- a/botocore/data/glue/2017-03-31/service-2.json +++ b/botocore/data/glue/2017-03-31/service-2.json @@ -6376,6 +6376,32 @@ "documentation":"A specified condition was not satisfied.
", "exception":true }, + "ConditionExpression":{ + "type":"structure", + "required":[ + "Condition", + "TargetColumn" + ], + "members":{ + "Condition":{ + "shape":"DatabrewCondition", + "documentation":"The condition of the condition expression.
" + }, + "Value":{ + "shape":"DatabrewConditionValue", + "documentation":"The value of the condition expression.
" + }, + "TargetColumn":{ + "shape":"TargetColumn", + "documentation":"The target column of the condition expressions.
" + } + }, + "documentation":"Condition expression defined in the Glue Studio data preparation recipe node.
" + }, + "ConditionExpressionList":{ + "type":"list", + "member":{"shape":"ConditionExpression"} + }, "ConditionList":{ "type":"list", "member":{"shape":"Condition"} @@ -9242,6 +9268,16 @@ "member":{"shape":"Database"} }, "DatabaseName":{"type":"string"}, + "DatabrewCondition":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[A-Z\\_]+$" + }, + "DatabrewConditionValue":{ + "type":"string", + "max":1024 + }, "Datatype":{ "type":"structure", "required":[ @@ -10479,11 +10515,11 @@ }, "EnclosedInStringProperty":{ "type":"string", - "pattern":"([\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF]|[^\\S\\r\\n\"'])*" + "pattern":"([\\u0009\\u000B\\u000C\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF])*" }, "EnclosedInStringPropertyWithQuote":{ "type":"string", - "pattern":"([\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF]|[^\\S\\r\\n])*" + "pattern":"([\\u0009\\u000B\\u000C\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF])*" }, "EncryptionAtRest":{ "type":"structure", @@ -16482,7 +16518,7 @@ }, "NodeName":{ "type":"string", - "pattern":"([\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF]|[^\\r\\n])*" + "pattern":"([^\\r\\n])*" }, "NodeType":{ "type":"string", @@ -16667,6 +16703,12 @@ }, "documentation":"A structure representing an open format table.
" }, + "Operation":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[A-Z\\_]+$" + }, "OperationNotSupportedException":{ "type":"structure", "members":{ @@ -16926,6 +16968,22 @@ "null" ] }, + "ParameterMap":{ + "type":"map", + "key":{"shape":"ParameterName"}, + "value":{"shape":"ParameterValue"} + }, + "ParameterName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[A-Za-z0-9]+$" + }, + "ParameterValue":{ + "type":"string", + "max":32768, + "min":1 + }, "ParametersMap":{ "type":"map", "key":{"shape":"KeyString"}, @@ -17602,8 +17660,7 @@ "type":"structure", "required":[ "Name", - "Inputs", - "RecipeReference" + "Inputs" ], "members":{ "Name":{ @@ -17617,10 +17674,29 @@ "RecipeReference":{ "shape":"RecipeReference", "documentation":"A reference to the DataBrew recipe used by the node.
" + }, + "RecipeSteps":{ + "shape":"RecipeSteps", + "documentation":"Transform steps used in the recipe node.
" } }, "documentation":"A Glue Studio node that uses a Glue DataBrew recipe in Glue jobs.
" }, + "RecipeAction":{ + "type":"structure", + "required":["Operation"], + "members":{ + "Operation":{ + "shape":"Operation", + "documentation":"The operation of the recipe action.
" + }, + "Parameters":{ + "shape":"ParameterMap", + "documentation":"The parameters of the recipe action.
" + } + }, + "documentation":"Actions defined in the Glue Studio data preparation recipe node.
" + }, "RecipeReference":{ "type":"structure", "required":[ @@ -17639,6 +17715,25 @@ }, "documentation":"A reference to a Glue DataBrew recipe.
" }, + "RecipeStep":{ + "type":"structure", + "required":["Action"], + "members":{ + "Action":{ + "shape":"RecipeAction", + "documentation":"The transformation action of the recipe step.
" + }, + "ConditionExpressions":{ + "shape":"ConditionExpressionList", + "documentation":"The condition expressions for the recipe step.
" + } + }, + "documentation":"A recipe step used in a Glue Studio data preparation recipe node.
" + }, + "RecipeSteps":{ + "type":"list", + "member":{"shape":"RecipeStep"} + }, "RecipeVersion":{ "type":"string", "max":16, @@ -21001,6 +21096,11 @@ "max":50, "min":0 }, + "TargetColumn":{ + "type":"string", + "max":1024, + "min":1 + }, "TargetFormat":{ "type":"string", "enum":[ diff --git a/botocore/data/groundstation/2019-05-23/service-2.json b/botocore/data/groundstation/2019-05-23/service-2.json index 409e09423d..9dc1c209f6 100644 --- a/botocore/data/groundstation/2019-05-23/service-2.json +++ b/botocore/data/groundstation/2019-05-23/service-2.json @@ -5,11 +5,13 @@ "endpointPrefix":"groundstation", "jsonVersion":"1.1", "protocol":"rest-json", + "protocols":["rest-json"], "serviceFullName":"AWS Ground Station", "serviceId":"GroundStation", "signatureVersion":"v4", "signingName":"groundstation", - "uid":"groundstation-2019-05-23" + "uid":"groundstation-2019-05-23", + "auth":["aws.auth#sigv4"] }, "operations":{ "CancelContact":{ @@ -2676,7 +2678,7 @@ "documentation":"Identifies the S3 object to be used as the ephemeris.
" } }, - "documentation":"Ephemeris data in Orbit Ephemeris Message (OEM) format.
" + "documentation":"Ephemeris data in Orbit Ephemeris Message (OEM) format.
Position, velocity, and acceleration units must be represented in km, km/s, and km/s**2, respectively, in ephemeris data lines. Covariance matrix line units must be represented in km**2 if computed from two positions, km**2/s if computed from one position and one velocity, and km**2/s**2 if computed from two velocities. Consult section 7.7.2 of The Consultative Committee for Space Data Systems (CCSDS) Recommended Standard for Orbit Data Messages for more information.
Remove a third-party subscription provider from the Bring Your Own License (BYOL) subscriptions registered to your account.
", + "idempotent":true + }, + "GetRegisteredSubscriptionProvider":{ + "name":"GetRegisteredSubscriptionProvider", + "http":{ + "method":"POST", + "requestUri":"/subscription/GetRegisteredSubscriptionProvider", + "responseCode":200 + }, + "input":{"shape":"GetRegisteredSubscriptionProviderRequest"}, + "output":{"shape":"GetRegisteredSubscriptionProviderResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Get details for a Bring Your Own License (BYOL) subscription that's registered to your account.
", + "idempotent":true + }, "GetServiceSettings":{ "name":"GetServiceSettings", "http":{ @@ -26,7 +64,7 @@ {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], - "documentation":"Lists the Linux subscriptions service settings.
", + "documentation":"Lists the Linux subscriptions service settings for your account.
", "idempotent":true }, "ListLinuxSubscriptionInstances":{ @@ -63,6 +101,89 @@ "documentation":"Lists the Linux subscriptions that have been discovered. If you have linked your organization, the returned results will include data aggregated across your accounts in Organizations.
", "idempotent":true }, + "ListRegisteredSubscriptionProviders":{ + "name":"ListRegisteredSubscriptionProviders", + "http":{ + "method":"POST", + "requestUri":"/subscription/ListRegisteredSubscriptionProviders", + "responseCode":200 + }, + "input":{"shape":"ListRegisteredSubscriptionProvidersRequest"}, + "output":{"shape":"ListRegisteredSubscriptionProvidersResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"List Bring Your Own License (BYOL) subscription registration resources for your account.
", + "idempotent":true + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"List the metadata tags that are assigned to the specified Amazon Web Services resource.
" + }, + "RegisterSubscriptionProvider":{ + "name":"RegisterSubscriptionProvider", + "http":{ + "method":"POST", + "requestUri":"/subscription/RegisterSubscriptionProvider", + "responseCode":200 + }, + "input":{"shape":"RegisterSubscriptionProviderRequest"}, + "output":{"shape":"RegisterSubscriptionProviderResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Register the supported third-party subscription provider for your Bring Your Own License (BYOL) subscription.
", + "idempotent":true + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"PUT", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Add metadata tags to the specified Amazon Web Services resource.
", + "idempotent":true + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Remove one or more metadata tag from the specified Amazon Web Services resource.
", + "idempotent":true + }, "UpdateServiceSettings":{ "name":"UpdateServiceSettings", "http":{ @@ -94,6 +215,21 @@ "type":"long", "box":true }, + "DeregisterSubscriptionProviderRequest":{ + "type":"structure", + "required":["SubscriptionProviderArn"], + "members":{ + "SubscriptionProviderArn":{ + "shape":"SubscriptionProviderArn", + "documentation":"The Amazon Resource Name (ARN) of the subscription provider resource to deregister.
" + } + } + }, + "DeregisterSubscriptionProviderResponse":{ + "type":"structure", + "members":{ + } + }, "Filter":{ "type":"structure", "members":{ @@ -116,6 +252,45 @@ "type":"list", "member":{"shape":"Filter"} }, + "GetRegisteredSubscriptionProviderRequest":{ + "type":"structure", + "required":["SubscriptionProviderArn"], + "members":{ + "SubscriptionProviderArn":{ + "shape":"SubscriptionProviderArn", + "documentation":"The Amazon Resource Name (ARN) of the BYOL registration resource to get details for.
" + } + } + }, + "GetRegisteredSubscriptionProviderResponse":{ + "type":"structure", + "members":{ + "LastSuccessfulDataRetrievalTime":{ + "shape":"String", + "documentation":"The timestamp from the last time License Manager retrieved subscription details from your registered third-party Linux subscription provider.
" + }, + "SecretArn":{ + "shape":"SecretArn", + "documentation":"The Amazon Resource Name (ARN) of the third-party access secret stored in Secrets Manager for the BYOL registration resource specified in the request.
" + }, + "SubscriptionProviderArn":{ + "shape":"SubscriptionProviderArn", + "documentation":"The Amazon Resource Name (ARN) for the BYOL registration resource specified in the request.
" + }, + "SubscriptionProviderSource":{ + "shape":"SubscriptionProviderSource", + "documentation":"The subscription provider for the BYOL registration resource specified in the request.
" + }, + "SubscriptionProviderStatus":{ + "shape":"SubscriptionProviderStatus", + "documentation":"The status of the Linux subscription provider access token from the last successful subscription data request.
" + }, + "SubscriptionProviderStatusMessage":{ + "shape":"String", + "documentation":"The detailed message from your subscription provider token status.
" + } + } + }, "GetServiceSettingsRequest":{ "type":"structure", "members":{ @@ -157,6 +332,10 @@ "shape":"String", "documentation":"The AMI ID used to launch the instance.
" }, + "DualSubscription":{ + "shape":"String", + "documentation":"Indicates that you have two different license subscriptions for the same software on your instance.
" + }, "InstanceID":{ "shape":"String", "documentation":"The instance ID of the resource.
" @@ -169,6 +348,10 @@ "shape":"String", "documentation":"The time in which the last discovery updated the instance details.
" }, + "OsVersion":{ + "shape":"String", + "documentation":"The operating system software version that runs on your instance.
" + }, "ProductCode":{ "shape":"ProductCodeList", "documentation":"The product code for the instance. For more information, see Usage operation values in the License Manager User Guide .
" @@ -177,13 +360,25 @@ "shape":"String", "documentation":"The Region the instance is running in.
" }, + "RegisteredWithSubscriptionProvider":{ + "shape":"String", + "documentation":"Indicates that your instance uses a BYOL license subscription from a third-party Linux subscription provider that you've registered with License Manager.
" + }, "Status":{ "shape":"String", "documentation":"The status of the instance.
" }, "SubscriptionName":{ "shape":"String", - "documentation":"The name of the subscription being used by the instance.
" + "documentation":"The name of the license subscription that the instance uses.
" + }, + "SubscriptionProviderCreateTime":{ + "shape":"String", + "documentation":"The timestamp when you registered the third-party Linux subscription provider for the subscription that the instance uses.
" + }, + "SubscriptionProviderUpdateTime":{ + "shape":"String", + "documentation":"The timestamp from the last time that the instance synced with the registered third-party Linux subscription provider.
" }, "UsageOperation":{ "shape":"String", @@ -235,15 +430,15 @@ "members":{ "Filters":{ "shape":"FilterList", - "documentation":"An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify. For example, you can filter by the name of AmiID with an optional operator to see subscriptions that match, partially match, or don't match a certain Amazon Machine Image (AMI) ID.
The valid names for this filter are:
AmiID
InstanceID
AccountID
Status
Region
UsageOperation
ProductCode
InstanceType
The valid Operators for this filter are:
contains
equals
Notequal
An array of structures that you can use to filter the results by your specified criteria. For example, you can specify Region in the Name, with the contains operator to list all subscriptions that match a partial string in the Value, such as us-west.
For each filter, you can specify one of the following values for the Name key to streamline results:
AccountID
AmiID
DualSubscription
InstanceID
InstanceType
ProductCode
Region
Status
UsageOperation
For each filter, you can use one of the following Operator values to define the behavior of the filter:
contains
equals
Notequal
Maximum number of results to return in a single call.
" + "documentation":"The maximum items to return in a request.
" }, "NextToken":{ "shape":"ListLinuxSubscriptionInstancesRequestNextTokenString", - "documentation":"Token for the next set of results.
" + "documentation":"A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" } }, "documentation":"NextToken length limit is half of ddb accepted limit. Increase this limit if parameters in request increases.
" @@ -262,7 +457,7 @@ }, "NextToken":{ "shape":"String", - "documentation":"Token for the next set of results.
" + "documentation":"The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -275,11 +470,11 @@ }, "MaxResults":{ "shape":"BoxInteger", - "documentation":"Maximum number of results to return in a single call.
" + "documentation":"The maximum items to return in a request.
" }, "NextToken":{ "shape":"ListLinuxSubscriptionsRequestNextTokenString", - "documentation":"Token for the next set of results.
" + "documentation":"A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" } }, "documentation":"NextToken length limit is half of ddb accepted limit. Increase this limit if parameters in request increases.
" @@ -294,7 +489,7 @@ "members":{ "NextToken":{ "shape":"String", - "documentation":"Token for the next set of results.
" + "documentation":"The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" }, "Subscriptions":{ "shape":"SubscriptionList", @@ -302,6 +497,63 @@ } } }, + "ListRegisteredSubscriptionProvidersRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"ListRegisteredSubscriptionProvidersRequestMaxResultsInteger", + "documentation":"The maximum items to return in a request.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" + }, + "SubscriptionProviderSources":{ + "shape":"SubscriptionProviderSourceList", + "documentation":"To filter your results, specify which subscription providers to return in the list.
" + } + } + }, + "ListRegisteredSubscriptionProvidersRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListRegisteredSubscriptionProvidersResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" + }, + "RegisteredSubscriptionProviders":{ + "shape":"RegisteredSubscriptionProviderList", + "documentation":"The list of BYOL registration resources that fit the criteria you specified in the request.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"SubscriptionProviderArn", + "documentation":"The Amazon Resource Name (ARN) of the resource for which to list metadata tags.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"Tags", + "documentation":"The metadata tags for the requested resource.
" + } + } + }, "Operator":{ "type":"string", "enum":[ @@ -323,6 +575,90 @@ "type":"list", "member":{"shape":"String"} }, + "RegisterSubscriptionProviderRequest":{ + "type":"structure", + "required":[ + "SecretArn", + "SubscriptionProviderSource" + ], + "members":{ + "SecretArn":{ + "shape":"SecretArn", + "documentation":"The Amazon Resource Name (ARN) of the secret where you've stored your subscription provider's access token. For RHEL subscriptions managed through the Red Hat Subscription Manager (RHSM), the secret contains your Red Hat Offline token.
" + }, + "SubscriptionProviderSource":{ + "shape":"SubscriptionProviderSource", + "documentation":"The supported Linux subscription provider to register.
" + }, + "Tags":{ + "shape":"Tags", + "documentation":"The metadata tags to assign to your registered Linux subscription provider resource.
" + } + } + }, + "RegisterSubscriptionProviderResponse":{ + "type":"structure", + "members":{ + "SubscriptionProviderArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the Linux subscription provider resource that you registered.
" + }, + "SubscriptionProviderSource":{ + "shape":"SubscriptionProviderSource", + "documentation":"The Linux subscription provider that you registered.
" + }, + "SubscriptionProviderStatus":{ + "shape":"SubscriptionProviderStatus", + "documentation":"Indicates the status of the registration action for the Linux subscription provider that you requested.
" + } + } + }, + "RegisteredSubscriptionProvider":{ + "type":"structure", + "members":{ + "LastSuccessfulDataRetrievalTime":{ + "shape":"String", + "documentation":"The timestamp from the last time that License Manager accessed third-party subscription data for your account from your registered Linux subscription provider.
" + }, + "SecretArn":{ + "shape":"SecretArn", + "documentation":"The Amazon Resource Name (ARN) of the Secrets Manager secret that stores your registered Linux subscription provider access token. For RHEL account subscriptions, this is the offline token.
" + }, + "SubscriptionProviderArn":{ + "shape":"SubscriptionProviderArn", + "documentation":"The Amazon Resource Name (ARN) of the Linux subscription provider resource that you registered.
" + }, + "SubscriptionProviderSource":{ + "shape":"SubscriptionProviderSource", + "documentation":"A supported third-party Linux subscription provider. License Manager currently supports Red Hat subscriptions.
" + }, + "SubscriptionProviderStatus":{ + "shape":"SubscriptionProviderStatus", + "documentation":"Indicates the status of your registered Linux subscription provider access token from the last time License Manager retrieved subscription data. For RHEL account subscriptions, this is the status of the offline token.
" + }, + "SubscriptionProviderStatusMessage":{ + "shape":"String", + "documentation":"A detailed message that's associated with your BYOL subscription provider token status.
" + } + }, + "documentation":"A third-party provider for operating system (OS) platform software and license subscriptions, such as Red Hat. When you register a third-party Linux subscription provider, License Manager can get subscription data from the registered provider.
" + }, + "RegisteredSubscriptionProviderList":{ + "type":"list", + "member":{"shape":"RegisteredSubscriptionProvider"} + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Unable to find the requested Amazon Web Services resource.
", + "exception":true + }, + "SecretArn":{ + "type":"string", + "pattern":"^arn:[a-z0-9-\\.]{1,63}:secretsmanager:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:secret:[^/]{1,1023}$" + }, "Status":{ "type":"string", "enum":[ @@ -371,6 +707,65 @@ "type":"list", "member":{"shape":"Subscription"} }, + "SubscriptionProviderArn":{ + "type":"string", + "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{1,510}/[a-z0-9-\\.]{1,510}$" + }, + "SubscriptionProviderSource":{ + "type":"string", + "enum":["RedHat"] + }, + "SubscriptionProviderSourceList":{ + "type":"list", + "member":{"shape":"SubscriptionProviderSource"} + }, + "SubscriptionProviderStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "INVALID", + "PENDING" + ] + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"String"}, + "max":50, + "min":0, + "sensitive":true + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"SubscriptionProviderArn", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Web Services resource to which to add the specified metadata tags.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"Tags", + "documentation":"The metadata tags to assign to the Amazon Web Services resource. Tags are formatted as key value pairs.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "Tags":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"}, + "max":50, + "min":0, + "sensitive":true + }, "ThrottlingException":{ "type":"structure", "members":{ @@ -379,6 +774,32 @@ "documentation":"The request was denied due to request throttling.
", "exception":true }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"SubscriptionProviderArn", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Web Services resource to remove the metadata tags from.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"A list of metadata tag keys to remove from the requested resource.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, "UpdateServiceSettingsRequest":{ "type":"structure", "required":[ diff --git a/botocore/data/mediaconnect/2018-11-14/service-2.json b/botocore/data/mediaconnect/2018-11-14/service-2.json index 3bf4acb776..73591931d8 100644 --- a/botocore/data/mediaconnect/2018-11-14/service-2.json +++ b/botocore/data/mediaconnect/2018-11-14/service-2.json @@ -8,7 +8,10 @@ "protocol": "rest-json", "jsonVersion": "1.1", "uid": "mediaconnect-2018-11-14", - "signatureVersion": "v4" + "signatureVersion": "v4", + "auth": [ + "aws.auth#sigv4" + ] }, "operations": { "AddBridgeOutputs": { @@ -2641,7 +2644,7 @@ "MinLatency": { "shape": "__integer", "locationName": "minLatency", - "documentation": "The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender\u2019s minimum latency and the receiver\u2019s minimum latency." + "documentation": "The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency." }, "Name": { "shape": "__string", @@ -2682,6 +2685,11 @@ "shape": "VpcInterfaceAttachment", "locationName": "vpcInterfaceAttachment", "documentation": "The name of the VPC interface attachment to use for this output." + }, + "OutputStatus": { + "shape": "OutputStatus", + "locationName": "outputStatus", + "documentation": "An indication of whether the new output should be enabled or disabled as soon as it is created. If you don't specify the outputStatus field in your request, MediaConnect sets it to ENABLED." } }, "documentation": "The output that you want to add to this flow.", @@ -3904,7 +3912,7 @@ "ScanMode": { "shape": "ScanMode", "locationName": "scanMode", - "documentation": "The type of compression that was used to smooth the video\u2019s appearance" + "documentation": "The type of compression that was used to smooth the video’s appearance" }, "Tcs": { "shape": "Tcs", @@ -3945,7 +3953,7 @@ "ScanMode": { "shape": "ScanMode", "locationName": "scanMode", - "documentation": "The type of compression that was used to smooth the video\u2019s appearance." + "documentation": "The type of compression that was used to smooth the video’s appearance." }, "Tcs": { "shape": "Tcs", @@ -4159,7 +4167,7 @@ "EntitlementStatus": { "shape": "EntitlementStatus", "locationName": "entitlementStatus", - "documentation": "An indication of whether the new entitlement should be enabled or disabled as soon as it is created. If you don\u2019t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED." + "documentation": "An indication of whether the new entitlement should be enabled or disabled as soon as it is created. If you don’t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED." }, "Name": { "shape": "__string", @@ -5237,6 +5245,11 @@ "shape": "__listOf__integer", "locationName": "bridgePorts", "documentation": "The bridge output ports currently in use." + }, + "OutputStatus": { + "shape": "OutputStatus", + "locationName": "outputStatus", + "documentation": "An indication of whether the output is transmitting data or not." } }, "documentation": "The settings for an output.", @@ -5245,6 +5258,13 @@ "Name" ] }, + "OutputStatus": { + "type": "string", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, "PriceUnits": { "type": "string", "enum": [ @@ -5801,7 +5821,7 @@ "MinLatency": { "shape": "__integer", "locationName": "minLatency", - "documentation": "The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender\u2019s minimum latency and the receiver\u2019s minimum latency." + "documentation": "The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency." }, "Name": { "shape": "__string", @@ -6117,7 +6137,7 @@ "MinLatency": { "shape": "__integer", "locationName": "minLatency", - "documentation": "The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender\u2019s minimum latency and the receiver\u2019s minimum latency." + "documentation": "The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency." }, "Protocol": { "shape": "Protocol", @@ -6629,7 +6649,7 @@ "EntitlementStatus": { "shape": "EntitlementStatus", "locationName": "entitlementStatus", - "documentation": "An indication of whether you want to enable the entitlement to allow access, or disable it to stop streaming content to the subscriber\u2019s flow temporarily. If you don\u2019t specify the entitlementStatus field in your request, MediaConnect leaves the value unchanged." + "documentation": "An indication of whether you want to enable the entitlement to allow access, or disable it to stop streaming content to the subscriber’s flow temporarily. If you don’t specify the entitlementStatus field in your request, MediaConnect leaves the value unchanged." }, "FlowArn": { "shape": "__string", @@ -6771,7 +6791,7 @@ "MinLatency": { "shape": "__integer", "locationName": "minLatency", - "documentation": "The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender\u2019s minimum latency and the receiver\u2019s minimum latency." + "documentation": "The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency." }, "OutputArn": { "shape": "__string", @@ -6819,6 +6839,11 @@ "shape": "VpcInterfaceAttachment", "locationName": "vpcInterfaceAttachment", "documentation": "The name of the VPC interface attachment to use for this output." + }, + "OutputStatus": { + "shape": "OutputStatus", + "locationName": "outputStatus", + "documentation": "An indication of whether the output should transmit data or not. If you don't specify the outputStatus field in your request, MediaConnect leaves the value unchanged." } }, "documentation": "The fields that you want to update in the output.", @@ -6929,7 +6954,7 @@ "MinLatency": { "shape": "__integer", "locationName": "minLatency", - "documentation": "The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender\u2019s minimum latency and the receiver\u2019s minimum latency." + "documentation": "The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency." }, "Protocol": { "shape": "Protocol", @@ -7430,4 +7455,4 @@ } }, "documentation": "API for AWS Elemental MediaConnect" -} +} \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 27543b5eee..70e6fa89d9 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -59,7 +59,7 @@ # The short X.Y version. version = '1.34.1' # The full version, including alpha/beta/rc tags. -release = '1.34.142' +release = '1.34.143' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.