aws-sdk
Version:
AWS SDK for JavaScript
2,117 lines • 105 kB
JSON
{
"version": "2.0",
"metadata": {
"apiVersion": "2023-06-05",
"endpointPrefix": "bedrock-agent",
"jsonVersion": "1.1",
"protocol": "rest-json",
"serviceFullName": "Agents for Amazon Bedrock",
"serviceId": "Bedrock Agent",
"signatureVersion": "v4",
"signingName": "bedrock",
"uid": "bedrock-agent-2023-06-05"
},
"operations": {
"AssociateAgentKnowledgeBase": {
"http": {
"method": "PUT",
"requestUri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"agentId",
"agentVersion",
"description",
"knowledgeBaseId"
],
"members": {
"agentId": {
"location": "uri",
"locationName": "agentId"
},
"agentVersion": {
"location": "uri",
"locationName": "agentVersion"
},
"description": {},
"knowledgeBaseId": {},
"knowledgeBaseState": {}
}
},
"output": {
"type": "structure",
"required": [
"agentKnowledgeBase"
],
"members": {
"agentKnowledgeBase": {
"shape": "S7"
}
}
},
"idempotent": true
},
"CreateAgent": {
"http": {
"method": "PUT",
"requestUri": "/agents/",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"agentName"
],
"members": {
"agentName": {},
"agentResourceRoleArn": {},
"clientToken": {
"idempotencyToken": true
},
"customerEncryptionKeyArn": {},
"description": {},
"foundationModel": {},
"guardrailConfiguration": {
"shape": "Sg"
},
"idleSessionTTLInSeconds": {
"type": "integer"
},
"instruction": {
"shape": "Sk"
},
"memoryConfiguration": {
"shape": "Sl"
},
"promptOverrideConfiguration": {
"shape": "Sp"
},
"tags": {
"shape": "S14"
}
}
},
"output": {
"type": "structure",
"required": [
"agent"
],
"members": {
"agent": {
"shape": "S18"
}
}
},
"idempotent": true
},
"CreateAgentActionGroup": {
"http": {
"method": "PUT",
"requestUri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"actionGroupName",
"agentId",
"agentVersion"
],
"members": {
"actionGroupExecutor": {
"shape": "S1g"
},
"actionGroupName": {},
"actionGroupState": {},
"agentId": {
"location": "uri",
"locationName": "agentId"
},
"agentVersion": {
"location": "uri",
"locationName": "agentVersion"
},
"apiSchema": {
"shape": "S1j"
},
"clientToken": {
"idempotencyToken": true
},
"description": {},
"functionSchema": {
"shape": "S1o"
},
"parentActionGroupSignature": {}
}
},
"output": {
"type": "structure",
"required": [
"agentActionGroup"
],
"members": {
"agentActionGroup": {
"shape": "S20"
}
}
},
"idempotent": true
},
"CreateAgentAlias": {
"http": {
"method": "PUT",
"requestUri": "/agents/{agentId}/agentaliases/",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"agentAliasName",
"agentId"
],
"members": {
"agentAliasName": {},
"agentId": {
"location": "uri",
"locationName": "agentId"
},
"clientToken": {
"idempotencyToken": true
},
"description": {},
"routingConfiguration": {
"shape": "S22"
},
"tags": {
"shape": "S14"
}
}
},
"output": {
"type": "structure",
"required": [
"agentAlias"
],
"members": {
"agentAlias": {
"shape": "S26"
}
}
},
"idempotent": true
},
"CreateDataSource": {
"http": {
"method": "PUT",
"requestUri": "/knowledgebases/{knowledgeBaseId}/datasources/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"dataSourceConfiguration",
"knowledgeBaseId",
"name"
],
"members": {
"clientToken": {
"idempotencyToken": true
},
"dataDeletionPolicy": {},
"dataSourceConfiguration": {
"shape": "S2e"
},
"description": {},
"knowledgeBaseId": {
"location": "uri",
"locationName": "knowledgeBaseId"
},
"name": {},
"serverSideEncryptionConfiguration": {
"shape": "S3m"
},
"vectorIngestionConfiguration": {
"shape": "S3n"
}
}
},
"output": {
"type": "structure",
"required": [
"dataSource"
],
"members": {
"dataSource": {
"shape": "S4i"
}
}
},
"idempotent": true
},
"CreateFlow": {
"http": {
"requestUri": "/flows/",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"executionRoleArn",
"name"
],
"members": {
"clientToken": {
"idempotencyToken": true
},
"customerEncryptionKeyArn": {},
"definition": {
"shape": "S4l"
},
"description": {},
"executionRoleArn": {},
"name": {},
"tags": {
"shape": "S14"
}
}
},
"output": {
"type": "structure",
"required": [
"arn",
"createdAt",
"executionRoleArn",
"id",
"name",
"status",
"updatedAt",
"version"
],
"members": {
"arn": {},
"createdAt": {
"shape": "S9"
},
"customerEncryptionKeyArn": {},
"definition": {
"shape": "S4l"
},
"description": {},
"executionRoleArn": {},
"id": {},
"name": {},
"status": {},
"updatedAt": {
"shape": "S9"
},
"version": {}
}
},
"idempotent": true
},
"CreateFlowAlias": {
"http": {
"requestUri": "/flows/{flowIdentifier}/aliases",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"flowIdentifier",
"name",
"routingConfiguration"
],
"members": {
"clientToken": {
"idempotencyToken": true
},
"description": {},
"flowIdentifier": {
"location": "uri",
"locationName": "flowIdentifier"
},
"name": {},
"routingConfiguration": {
"shape": "S6g"
},
"tags": {
"shape": "S14"
}
}
},
"output": {
"type": "structure",
"required": [
"arn",
"createdAt",
"flowId",
"id",
"name",
"routingConfiguration",
"updatedAt"
],
"members": {
"arn": {},
"createdAt": {
"shape": "S9"
},
"description": {},
"flowId": {},
"id": {},
"name": {},
"routingConfiguration": {
"shape": "S6g"
},
"updatedAt": {
"shape": "S9"
}
}
},
"idempotent": true
},
"CreateFlowVersion": {
"http": {
"requestUri": "/flows/{flowIdentifier}/versions",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"flowIdentifier"
],
"members": {
"clientToken": {
"idempotencyToken": true
},
"description": {},
"flowIdentifier": {
"location": "uri",
"locationName": "flowIdentifier"
}
}
},
"output": {
"type": "structure",
"required": [
"arn",
"createdAt",
"executionRoleArn",
"id",
"name",
"status",
"version"
],
"members": {
"arn": {},
"createdAt": {
"shape": "S9"
},
"customerEncryptionKeyArn": {},
"definition": {
"shape": "S4l"
},
"description": {},
"executionRoleArn": {},
"id": {},
"name": {},
"status": {},
"version": {}
}
},
"idempotent": true
},
"CreateKnowledgeBase": {
"http": {
"method": "PUT",
"requestUri": "/knowledgebases/",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"knowledgeBaseConfiguration",
"name",
"roleArn",
"storageConfiguration"
],
"members": {
"clientToken": {
"idempotencyToken": true
},
"description": {},
"knowledgeBaseConfiguration": {
"shape": "S6p"
},
"name": {},
"roleArn": {},
"storageConfiguration": {
"shape": "S6x"
},
"tags": {
"shape": "S14"
}
}
},
"output": {
"type": "structure",
"required": [
"knowledgeBase"
],
"members": {
"knowledgeBase": {
"shape": "S7q"
}
}
},
"idempotent": true
},
"CreatePrompt": {
"http": {
"requestUri": "/prompts/",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"name"
],
"members": {
"clientToken": {
"idempotencyToken": true
},
"customerEncryptionKeyArn": {},
"defaultVariant": {},
"description": {},
"name": {},
"tags": {
"shape": "S14"
},
"variants": {
"shape": "S7x"
}
}
},
"output": {
"type": "structure",
"required": [
"arn",
"createdAt",
"id",
"name",
"updatedAt",
"version"
],
"members": {
"arn": {},
"createdAt": {
"shape": "S9"
},
"customerEncryptionKeyArn": {},
"defaultVariant": {},
"description": {},
"id": {},
"name": {},
"updatedAt": {
"shape": "S9"
},
"variants": {
"shape": "S7x"
},
"version": {}
}
},
"idempotent": true
},
"CreatePromptVersion": {
"http": {
"requestUri": "/prompts/{promptIdentifier}/versions",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"promptIdentifier"
],
"members": {
"clientToken": {
"idempotencyToken": true
},
"description": {},
"promptIdentifier": {
"location": "uri",
"locationName": "promptIdentifier"
},
"tags": {
"shape": "S14"
}
}
},
"output": {
"type": "structure",
"required": [
"arn",
"createdAt",
"id",
"name",
"updatedAt",
"version"
],
"members": {
"arn": {},
"createdAt": {
"shape": "S9"
},
"customerEncryptionKeyArn": {},
"defaultVariant": {},
"description": {},
"id": {},
"name": {},
"updatedAt": {
"shape": "S9"
},
"variants": {
"shape": "S7x"
},
"version": {}
}
},
"idempotent": true
},
"DeleteAgent": {
"http": {
"method": "DELETE",
"requestUri": "/agents/{agentId}/",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"agentId"
],
"members": {
"agentId": {
"location": "uri",
"locationName": "agentId"
},
"skipResourceInUseCheck": {
"location": "querystring",
"locationName": "skipResourceInUseCheck",
"type": "boolean"
}
}
},
"output": {
"type": "structure",
"required": [
"agentId",
"agentStatus"
],
"members": {
"agentId": {},
"agentStatus": {}
}
},
"idempotent": true
},
"DeleteAgentActionGroup": {
"http": {
"method": "DELETE",
"requestUri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"actionGroupId",
"agentId",
"agentVersion"
],
"members": {
"actionGroupId": {
"location": "uri",
"locationName": "actionGroupId"
},
"agentId": {
"location": "uri",
"locationName": "agentId"
},
"agentVersion": {
"location": "uri",
"locationName": "agentVersion"
},
"skipResourceInUseCheck": {
"location": "querystring",
"locationName": "skipResourceInUseCheck",
"type": "boolean"
}
}
},
"output": {
"type": "structure",
"members": {}
},
"idempotent": true
},
"DeleteAgentAlias": {
"http": {
"method": "DELETE",
"requestUri": "/agents/{agentId}/agentaliases/{agentAliasId}/",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"agentAliasId",
"agentId"
],
"members": {
"agentAliasId": {
"location": "uri",
"locationName": "agentAliasId"
},
"agentId": {
"location": "uri",
"locationName": "agentId"
}
}
},
"output": {
"type": "structure",
"required": [
"agentAliasId",
"agentAliasStatus",
"agentId"
],
"members": {
"agentAliasId": {},
"agentAliasStatus": {},
"agentId": {}
}
},
"idempotent": true
},
"DeleteAgentVersion": {
"http": {
"method": "DELETE",
"requestUri": "/agents/{agentId}/agentversions/{agentVersion}/",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"agentId",
"agentVersion"
],
"members": {
"agentId": {
"location": "uri",
"locationName": "agentId"
},
"agentVersion": {
"location": "uri",
"locationName": "agentVersion"
},
"skipResourceInUseCheck": {
"location": "querystring",
"locationName": "skipResourceInUseCheck",
"type": "boolean"
}
}
},
"output": {
"type": "structure",
"required": [
"agentId",
"agentStatus",
"agentVersion"
],
"members": {
"agentId": {},
"agentStatus": {},
"agentVersion": {}
}
},
"idempotent": true
},
"DeleteDataSource": {
"http": {
"method": "DELETE",
"requestUri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"dataSourceId",
"knowledgeBaseId"
],
"members": {
"dataSourceId": {
"location": "uri",
"locationName": "dataSourceId"
},
"knowledgeBaseId": {
"location": "uri",
"locationName": "knowledgeBaseId"
}
}
},
"output": {
"type": "structure",
"required": [
"dataSourceId",
"knowledgeBaseId",
"status"
],
"members": {
"dataSourceId": {},
"knowledgeBaseId": {},
"status": {}
}
},
"idempotent": true
},
"DeleteFlow": {
"http": {
"method": "DELETE",
"requestUri": "/flows/{flowIdentifier}/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"flowIdentifier"
],
"members": {
"flowIdentifier": {
"location": "uri",
"locationName": "flowIdentifier"
},
"skipResourceInUseCheck": {
"location": "querystring",
"locationName": "skipResourceInUseCheck",
"type": "boolean"
}
}
},
"output": {
"type": "structure",
"required": [
"id"
],
"members": {
"id": {}
}
},
"idempotent": true
},
"DeleteFlowAlias": {
"http": {
"method": "DELETE",
"requestUri": "/flows/{flowIdentifier}/aliases/{aliasIdentifier}",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"aliasIdentifier",
"flowIdentifier"
],
"members": {
"aliasIdentifier": {
"location": "uri",
"locationName": "aliasIdentifier"
},
"flowIdentifier": {
"location": "uri",
"locationName": "flowIdentifier"
}
}
},
"output": {
"type": "structure",
"required": [
"flowId",
"id"
],
"members": {
"flowId": {},
"id": {}
}
},
"idempotent": true
},
"DeleteFlowVersion": {
"http": {
"method": "DELETE",
"requestUri": "/flows/{flowIdentifier}/versions/{flowVersion}/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"flowIdentifier",
"flowVersion"
],
"members": {
"flowIdentifier": {
"location": "uri",
"locationName": "flowIdentifier"
},
"flowVersion": {
"location": "uri",
"locationName": "flowVersion"
},
"skipResourceInUseCheck": {
"location": "querystring",
"locationName": "skipResourceInUseCheck",
"type": "boolean"
}
}
},
"output": {
"type": "structure",
"required": [
"id",
"version"
],
"members": {
"id": {},
"version": {}
}
},
"idempotent": true
},
"DeleteKnowledgeBase": {
"http": {
"method": "DELETE",
"requestUri": "/knowledgebases/{knowledgeBaseId}",
"responseCode": 202
},
"input": {
"type": "structure",
"required": [
"knowledgeBaseId"
],
"members": {
"knowledgeBaseId": {
"location": "uri",
"locationName": "knowledgeBaseId"
}
}
},
"output": {
"type": "structure",
"required": [
"knowledgeBaseId",
"status"
],
"members": {
"knowledgeBaseId": {},
"status": {}
}
},
"idempotent": true
},
"DeletePrompt": {
"http": {
"method": "DELETE",
"requestUri": "/prompts/{promptIdentifier}/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"promptIdentifier"
],
"members": {
"promptIdentifier": {
"location": "uri",
"locationName": "promptIdentifier"
},
"promptVersion": {
"location": "querystring",
"locationName": "promptVersion"
}
}
},
"output": {
"type": "structure",
"required": [
"id"
],
"members": {
"id": {},
"version": {}
}
},
"idempotent": true
},
"DisassociateAgentKnowledgeBase": {
"http": {
"method": "DELETE",
"requestUri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"agentId",
"agentVersion",
"knowledgeBaseId"
],
"members": {
"agentId": {
"location": "uri",
"locationName": "agentId"
},
"agentVersion": {
"location": "uri",
"locationName": "agentVersion"
},
"knowledgeBaseId": {
"location": "uri",
"locationName": "knowledgeBaseId"
}
}
},
"output": {
"type": "structure",
"members": {}
},
"idempotent": true
},
"GetAgent": {
"http": {
"method": "GET",
"requestUri": "/agents/{agentId}/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"agentId"
],
"members": {
"agentId": {
"location": "uri",
"locationName": "agentId"
}
}
},
"output": {
"type": "structure",
"required": [
"agent"
],
"members": {
"agent": {
"shape": "S18"
}
}
}
},
"GetAgentActionGroup": {
"http": {
"method": "GET",
"requestUri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"actionGroupId",
"agentId",
"agentVersion"
],
"members": {
"actionGroupId": {
"location": "uri",
"locationName": "actionGroupId"
},
"agentId": {
"location": "uri",
"locationName": "agentId"
},
"agentVersion": {
"location": "uri",
"locationName": "agentVersion"
}
}
},
"output": {
"type": "structure",
"required": [
"agentActionGroup"
],
"members": {
"agentActionGroup": {
"shape": "S20"
}
}
}
},
"GetAgentAlias": {
"http": {
"method": "GET",
"requestUri": "/agents/{agentId}/agentaliases/{agentAliasId}/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"agentAliasId",
"agentId"
],
"members": {
"agentAliasId": {
"location": "uri",
"locationName": "agentAliasId"
},
"agentId": {
"location": "uri",
"locationName": "agentId"
}
}
},
"output": {
"type": "structure",
"required": [
"agentAlias"
],
"members": {
"agentAlias": {
"shape": "S26"
}
}
}
},
"GetAgentKnowledgeBase": {
"http": {
"method": "GET",
"requestUri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"agentId",
"agentVersion",
"knowledgeBaseId"
],
"members": {
"agentId": {
"location": "uri",
"locationName": "agentId"
},
"agentVersion": {
"location": "uri",
"locationName": "agentVersion"
},
"knowledgeBaseId": {
"location": "uri",
"locationName": "knowledgeBaseId"
}
}
},
"output": {
"type": "structure",
"required": [
"agentKnowledgeBase"
],
"members": {
"agentKnowledgeBase": {
"shape": "S7"
}
}
}
},
"GetAgentVersion": {
"http": {
"method": "GET",
"requestUri": "/agents/{agentId}/agentversions/{agentVersion}/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"agentId",
"agentVersion"
],
"members": {
"agentId": {
"location": "uri",
"locationName": "agentId"
},
"agentVersion": {
"location": "uri",
"locationName": "agentVersion"
}
}
},
"output": {
"type": "structure",
"required": [
"agentVersion"
],
"members": {
"agentVersion": {
"type": "structure",
"required": [
"agentArn",
"agentId",
"agentName",
"agentResourceRoleArn",
"agentStatus",
"createdAt",
"idleSessionTTLInSeconds",
"updatedAt",
"version"
],
"members": {
"agentArn": {},
"agentId": {},
"agentName": {},
"agentResourceRoleArn": {},
"agentStatus": {},
"createdAt": {
"shape": "S9"
},
"customerEncryptionKeyArn": {},
"description": {},
"failureReasons": {
"shape": "S1b"
},
"foundationModel": {},
"guardrailConfiguration": {
"shape": "Sg"
},
"idleSessionTTLInSeconds": {
"type": "integer"
},
"instruction": {
"shape": "Sk"
},
"memoryConfiguration": {
"shape": "Sl"
},
"promptOverrideConfiguration": {
"shape": "Sp"
},
"recommendedActions": {
"shape": "S1d"
},
"updatedAt": {
"shape": "S9"
},
"version": {}
}
}
}
}
},
"GetDataSource": {
"http": {
"method": "GET",
"requestUri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"dataSourceId",
"knowledgeBaseId"
],
"members": {
"dataSourceId": {
"location": "uri",
"locationName": "dataSourceId"
},
"knowledgeBaseId": {
"location": "uri",
"locationName": "knowledgeBaseId"
}
}
},
"output": {
"type": "structure",
"required": [
"dataSource"
],
"members": {
"dataSource": {
"shape": "S4i"
}
}
}
},
"GetFlow": {
"http": {
"method": "GET",
"requestUri": "/flows/{flowIdentifier}/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"flowIdentifier"
],
"members": {
"flowIdentifier": {
"location": "uri",
"locationName": "flowIdentifier"
}
}
},
"output": {
"type": "structure",
"required": [
"arn",
"createdAt",
"executionRoleArn",
"id",
"name",
"status",
"updatedAt",
"version"
],
"members": {
"arn": {},
"createdAt": {
"shape": "S9"
},
"customerEncryptionKeyArn": {},
"definition": {
"shape": "S4l"
},
"description": {},
"executionRoleArn": {},
"id": {},
"name": {},
"status": {},
"updatedAt": {
"shape": "S9"
},
"validations": {
"type": "list",
"member": {
"type": "structure",
"required": [
"message",
"severity"
],
"members": {
"message": {},
"severity": {}
}
}
},
"version": {}
}
}
},
"GetFlowAlias": {
"http": {
"method": "GET",
"requestUri": "/flows/{flowIdentifier}/aliases/{aliasIdentifier}",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"aliasIdentifier",
"flowIdentifier"
],
"members": {
"aliasIdentifier": {
"location": "uri",
"locationName": "aliasIdentifier"
},
"flowIdentifier": {
"location": "uri",
"locationName": "flowIdentifier"
}
}
},
"output": {
"type": "structure",
"required": [
"arn",
"createdAt",
"flowId",
"id",
"name",
"routingConfiguration",
"updatedAt"
],
"members": {
"arn": {},
"createdAt": {
"shape": "S9"
},
"description": {},
"flowId": {},
"id": {},
"name": {},
"routingConfiguration": {
"shape": "S6g"
},
"updatedAt": {
"shape": "S9"
}
}
}
},
"GetFlowVersion": {
"http": {
"method": "GET",
"requestUri": "/flows/{flowIdentifier}/versions/{flowVersion}/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"flowIdentifier",
"flowVersion"
],
"members": {
"flowIdentifier": {
"location": "uri",
"locationName": "flowIdentifier"
},
"flowVersion": {
"location": "uri",
"locationName": "flowVersion"
}
}
},
"output": {
"type": "structure",
"required": [
"arn",
"createdAt",
"executionRoleArn",
"id",
"name",
"status",
"version"
],
"members": {
"arn": {},
"createdAt": {
"shape": "S9"
},
"customerEncryptionKeyArn": {},
"definition": {
"shape": "S4l"
},
"description": {},
"executionRoleArn": {},
"id": {},
"name": {},
"status": {},
"version": {}
}
}
},
"GetIngestionJob": {
"http": {
"method": "GET",
"requestUri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/{ingestionJobId}",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"dataSourceId",
"ingestionJobId",
"knowledgeBaseId"
],
"members": {
"dataSourceId": {
"location": "uri",
"locationName": "dataSourceId"
},
"ingestionJobId": {
"location": "uri",
"locationName": "ingestionJobId"
},
"knowledgeBaseId": {
"location": "uri",
"locationName": "knowledgeBaseId"
}
}
},
"output": {
"type": "structure",
"required": [
"ingestionJob"
],
"members": {
"ingestionJob": {
"shape": "S9k"
}
}
}
},
"GetKnowledgeBase": {
"http": {
"method": "GET",
"requestUri": "/knowledgebases/{knowledgeBaseId}",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"knowledgeBaseId"
],
"members": {
"knowledgeBaseId": {
"location": "uri",
"locationName": "knowledgeBaseId"
}
}
},
"output": {
"type": "structure",
"required": [
"knowledgeBase"
],
"members": {
"knowledgeBase": {
"shape": "S7q"
}
}
}
},
"GetPrompt": {
"http": {
"method": "GET",
"requestUri": "/prompts/{promptIdentifier}/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"promptIdentifier"
],
"members": {
"promptIdentifier": {
"location": "uri",
"locationName": "promptIdentifier"
},
"promptVersion": {
"location": "querystring",
"locationName": "promptVersion"
}
}
},
"output": {
"type": "structure",
"required": [
"arn",
"createdAt",
"id",
"name",
"updatedAt",
"version"
],
"members": {
"arn": {},
"createdAt": {
"shape": "S9"
},
"customerEncryptionKeyArn": {},
"defaultVariant": {},
"description": {},
"id": {},
"name": {},
"updatedAt": {
"shape": "S9"
},
"variants": {
"shape": "S7x"
},
"version": {}
}
}
},
"ListAgentActionGroups": {
"http": {
"requestUri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"agentId",
"agentVersion"
],
"members": {
"agentId": {
"location": "uri",
"locationName": "agentId"
},
"agentVersion": {
"location": "uri",
"locationName": "agentVersion"
},
"maxResults": {
"type": "integer"
},
"nextToken": {}
}
},
"output": {
"type": "structure",
"required": [
"actionGroupSummaries"
],
"members": {
"actionGroupSummaries": {
"type": "list",
"member": {
"type": "structure",
"required": [
"actionGroupId",
"actionGroupName",
"actionGroupState",
"updatedAt"
],
"members": {
"actionGroupId": {},
"actionGroupName": {},
"actionGroupState": {},
"description": {},
"updatedAt": {
"shape": "S9"
}
}
}
},
"nextToken": {}
}
}
},
"ListAgentAliases": {
"http": {
"requestUri": "/agents/{agentId}/agentaliases/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"agentId"
],
"members": {
"agentId": {
"location": "uri",
"locationName": "agentId"
},
"maxResults": {
"type": "integer"
},
"nextToken": {}
}
},
"output": {
"type": "structure",
"required": [
"agentAliasSummaries"
],
"members": {
"agentAliasSummaries": {
"type": "list",
"member": {
"type": "structure",
"required": [
"agentAliasId",
"agentAliasName",
"agentAliasStatus",
"createdAt",
"updatedAt"
],
"members": {
"agentAliasId": {},
"agentAliasName": {},
"agentAliasStatus": {},
"createdAt": {
"shape": "S9"
},
"description": {},
"routingConfiguration": {
"shape": "S22"
},
"updatedAt": {
"shape": "S9"
}
}
}
},
"nextToken": {}
}
}
},
"ListAgentKnowledgeBases": {
"http": {
"requestUri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"agentId",
"agentVersion"
],
"members": {
"agentId": {
"location": "uri",
"locationName": "agentId"
},
"agentVersion": {
"location": "uri",
"locationName": "agentVersion"
},
"maxResults": {
"type": "integer"
},
"nextToken": {}
}
},
"output": {
"type": "structure",
"required": [
"agentKnowledgeBaseSummaries"
],
"members": {
"agentKnowledgeBaseSummaries": {
"type": "list",
"member": {
"type": "structure",
"required": [
"knowledgeBaseId",
"knowledgeBaseState",
"updatedAt"
],
"members": {
"description": {},
"knowledgeBaseId": {},
"knowledgeBaseState": {},
"updatedAt": {
"shape": "S9"
}
}
}
},
"nextToken": {}
}
}
},
"ListAgentVersions": {
"http": {
"requestUri": "/agents/{agentId}/agentversions/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"agentId"
],
"members": {
"agentId": {
"location": "uri",
"locationName": "agentId"
},
"maxResults": {
"type": "integer"
},
"nextToken": {}
}
},
"output": {
"type": "structure",
"required": [
"agentVersionSummaries"
],
"members": {
"agentVersionSummaries": {
"type": "list",
"member": {
"type": "structure",
"required": [
"agentName",
"agentStatus",
"agentVersion",
"createdAt",
"updatedAt"
],
"members": {
"agentName": {},
"agentStatus": {},
"agentVersion": {},
"createdAt": {
"shape": "S9"
},
"description": {},
"guardrailConfiguration": {
"shape": "Sg"
},
"updatedAt": {
"shape": "S9"
}
}
}
},
"nextToken": {}
}
}
},
"ListAgents": {
"http": {
"requestUri": "/agents/",
"responseCode": 200
},
"input": {
"type": "structure",
"members": {
"maxResults": {
"type": "integer"
},
"nextToken": {}
}
},
"output": {
"type": "structure",
"required": [
"agentSummaries"
],
"members": {
"agentSummaries": {
"type": "list",
"member": {
"type": "structure",
"required": [
"agentId",
"agentName",
"agentStatus",
"updatedAt"
],
"members": {
"agentId": {},
"agentName": {},
"agentStatus": {},
"description": {},
"guardrailConfiguration": {
"shape": "Sg"
},
"latestAgentVersion": {},
"updatedAt": {
"shape": "S9"
}
}
}
},
"nextToken": {}
}
}
},
"ListDataSources": {
"http": {
"requestUri": "/knowledgebases/{knowledgeBaseId}/datasources/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"knowledgeBaseId"
],
"members": {
"knowledgeBaseId": {
"location": "uri",
"locationName": "knowledgeBaseId"
},
"maxResults": {
"type": "integer"
},
"nextToken": {}
}
},
"output": {
"type": "structure",
"required": [
"dataSourceSummaries"
],
"members": {
"dataSourceSummaries": {
"type": "list",
"member": {
"type": "structure",
"required": [
"dataSourceId",
"knowledgeBaseId",
"name",
"status",
"updatedAt"
],
"members": {
"dataSourceId": {},
"description": {},
"knowledgeBaseId": {},
"name": {},
"status": {},
"updatedAt": {
"shape": "S9"
}
}
}
},
"nextToken": {}
}
}
},
"ListFlowAliases": {
"http": {
"method": "GET",
"requestUri": "/flows/{flowIdentifier}/aliases",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"flowIdentifier"
],
"members": {
"flowIdentifier": {
"location": "uri",
"locationName": "flowIdentifier"
},
"maxResults": {
"location": "querystring",
"locationName": "maxResults",
"type": "integer"
},
"nextToken": {
"location": "querystring",
"locationName": "nextToken"
}
}
},
"output": {
"type": "structure",
"required": [
"flowAliasSummaries"
],
"members": {
"flowAliasSummaries": {
"type": "list",
"member": {
"type": "structure",
"required": [
"arn",
"createdAt",
"flowId",
"id",
"name",
"routingConfiguration",
"updatedAt"
],
"members": {
"arn": {},
"createdAt": {
"shape": "S9"
},
"description": {},
"flowId": {},
"id": {},
"name": {},
"routingConfiguration": {
"shape": "S6g"
},
"updatedAt": {
"shape": "S9"
}
}
}
},
"nextToken": {}
}
}
},
"ListFlowVersions": {
"http": {
"method": "GET",
"requestUri": "/flows/{flowIdentifier}/versions",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"flowIdentifier"
],
"members": {
"flowIdentifier": {
"location": "uri",
"locationName": "flowIdentifier"
},
"maxResults": {
"location": "querystring",
"locationName": "maxResults",
"type": "integer"
},
"nextToken": {
"location": "querystring",
"locationName": "nextToken"
}
}
},
"output": {
"type": "structure",
"required": [
"flowVersionSummaries"
],
"members": {
"flowVersionSummaries": {
"type": "list",
"member": {
"type": "structure",
"required": [
"arn",
"createdAt",
"id",
"status",
"version"
],
"members": {
"arn": {},
"createdAt": {
"shape": "S9"
},
"id": {},
"status": {},
"version": {}
}
}
},
"nextToken": {}
}
}
},
"ListFlows": {
"http": {
"method": "GET",
"requestUri": "/flows/",
"responseCode": 200
},
"input": {
"type": "structure",
"members": {
"maxResults": {
"location": "querystring",
"locationName": "maxResults",
"type": "integer"
},
"nextToken": {
"location": "querystring",
"locationName": "nextToken"
}
}
},
"output": {
"type": "structure",
"required": [
"flowSummaries"
],
"members": {
"flowSummaries": {
"type": "list",
"member": {
"type": "structure",
"required": [
"arn",
"createdAt",
"id",
"name",
"status",
"updatedAt",
"version"
],
"members": {
"arn": {},
"createdAt": {
"shape": "S9"
},
"description": {},
"id": {},
"name": {},
"status": {},
"updatedAt": {
"shape": "S9"
},
"version": {}
}
}
},
"nextToken": {}
}
}
},
"ListIngestionJobs": {
"http": {
"requestUri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"dataSourceId",
"knowledgeBaseId"
],
"members": {
"dataSourceId": {
"location": "uri",
"locationName": "dataSourceId"
},
"filters": {
"type": "list",
"member": {
"type": "structure",
"required": [
"attribute",
"operator",
"values"
],
"members": {
"attribute": {},
"operator": {},
"values": {
"type": "list",
"member": {}
}
}
}
},
"knowledgeBaseId": {
"location": "uri",
"locationName": "knowledgeBaseId"
},
"maxResults": {
"type": "integer"
},
"nextToken": {},
"sortBy": {
"type": "structure",
"required": [
"attribute",
"order"
],
"members": {
"attribute": {},
"order": {}
}
}
}
},
"output": {
"type": "structu