AssociateAgentKnowledgeBase

$result = $client->associateAgentKnowledgeBase([/* ... */]);
$promise = $client->associateAgentKnowledgeBaseAsync([/* ... */]);

Associates a knowledge base with an agent. If a knowledge base is associated and its indexState is set to Enabled, the agent queries the knowledge base for information to augment its response to the user.

Parameter Syntax

$result = $client->associateAgentKnowledgeBase([
    'agentId' => '<string>', // REQUIRED
    'agentVersion' => '<string>', // REQUIRED
    'description' => '<string>', // REQUIRED
    'knowledgeBaseId' => '<string>', // REQUIRED
    'knowledgeBaseState' => 'ENABLED|DISABLED',
]);

Parameter Details

Result Syntax

[
    'agentKnowledgeBase' => [
        'agentId' => '<string>',
        'agentVersion' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'knowledgeBaseId' => '<string>',
        'knowledgeBaseState' => 'ENABLED|DISABLED',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ConflictException:

There was a conflict performing an operation.

ServiceQuotaExceededException:

The number of requests exceeds the service quota. Resubmit your request later.

CreateAgent

$result = $client->createAgent([/* ... */]);
$promise = $client->createAgentAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createAgent([
    'agentName' => '<string>', // REQUIRED
    'agentResourceRoleArn' => '<string>',
    'clientToken' => '<string>',
    'customerEncryptionKeyArn' => '<string>',
    'description' => '<string>',
    'foundationModel' => '<string>',
    'guardrailConfiguration' => [
        'guardrailIdentifier' => '<string>',
        'guardrailVersion' => '<string>',
    ],
    'idleSessionTTLInSeconds' => <integer>,
    'instruction' => '<string>',
    'promptOverrideConfiguration' => [
        'overrideLambda' => '<string>',
        'promptConfigurations' => [ // REQUIRED
            [
                'basePromptTemplate' => '<string>',
                'inferenceConfiguration' => [
                    'maximumLength' => <integer>,
                    'stopSequences' => ['<string>', ...],
                    'temperature' => <float>,
                    'topK' => <integer>,
                    'topP' => <float>,
                ],
                'parserMode' => 'DEFAULT|OVERRIDDEN',
                'promptCreationMode' => 'DEFAULT|OVERRIDDEN',
                'promptState' => 'ENABLED|DISABLED',
                'promptType' => 'PRE_PROCESSING|ORCHESTRATION|POST_PROCESSING|KNOWLEDGE_BASE_RESPONSE_GENERATION',
            ],
            // ...
        ],
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'agent' => [
        'agentArn' => '<string>',
        'agentId' => '<string>',
        'agentName' => '<string>',
        'agentResourceRoleArn' => '<string>',
        'agentStatus' => 'CREATING|PREPARING|PREPARED|NOT_PREPARED|DELETING|FAILED|VERSIONING|UPDATING',
        'agentVersion' => '<string>',
        'clientToken' => '<string>',
        'createdAt' => <DateTime>,
        'customerEncryptionKeyArn' => '<string>',
        'description' => '<string>',
        'failureReasons' => ['<string>', ...],
        'foundationModel' => '<string>',
        'guardrailConfiguration' => [
            'guardrailIdentifier' => '<string>',
            'guardrailVersion' => '<string>',
        ],
        'idleSessionTTLInSeconds' => <integer>,
        'instruction' => '<string>',
        'preparedAt' => <DateTime>,
        'promptOverrideConfiguration' => [
            'overrideLambda' => '<string>',
            'promptConfigurations' => [
                [
                    'basePromptTemplate' => '<string>',
                    'inferenceConfiguration' => [
                        'maximumLength' => <integer>,
                        'stopSequences' => ['<string>', ...],
                        'temperature' => <float>,
                        'topK' => <integer>,
                        'topP' => <float>,
                    ],
                    'parserMode' => 'DEFAULT|OVERRIDDEN',
                    'promptCreationMode' => 'DEFAULT|OVERRIDDEN',
                    'promptState' => 'ENABLED|DISABLED',
                    'promptType' => 'PRE_PROCESSING|ORCHESTRATION|POST_PROCESSING|KNOWLEDGE_BASE_RESPONSE_GENERATION',
                ],
                // ...
            ],
        ],
        'recommendedActions' => ['<string>', ...],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ConflictException:

There was a conflict performing an operation.

ServiceQuotaExceededException:

The number of requests exceeds the service quota. Resubmit your request later.

CreateAgentActionGroup

$result = $client->createAgentActionGroup([/* ... */]);
$promise = $client->createAgentActionGroupAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createAgentActionGroup([
    'actionGroupExecutor' => [
        'customControl' => 'RETURN_CONTROL',
        'lambda' => '<string>',
    ],
    'actionGroupName' => '<string>', // REQUIRED
    'actionGroupState' => 'ENABLED|DISABLED',
    'agentId' => '<string>', // REQUIRED
    'agentVersion' => '<string>', // REQUIRED
    'apiSchema' => [
        'payload' => '<string>',
        's3' => [
            's3BucketName' => '<string>',
            's3ObjectKey' => '<string>',
        ],
    ],
    'clientToken' => '<string>',
    'description' => '<string>',
    'functionSchema' => [
        'functions' => [
            [
                'description' => '<string>',
                'name' => '<string>', // REQUIRED
                'parameters' => [
                    '<Name>' => [
                        'description' => '<string>',
                        'required' => true || false,
                        'type' => 'string|number|integer|boolean|array', // REQUIRED
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'parentActionGroupSignature' => 'AMAZON.UserInput',
]);

Parameter Details

Result Syntax

[
    'agentActionGroup' => [
        'actionGroupExecutor' => [
            'customControl' => 'RETURN_CONTROL',
            'lambda' => '<string>',
        ],
        'actionGroupId' => '<string>',
        'actionGroupName' => '<string>',
        'actionGroupState' => 'ENABLED|DISABLED',
        'agentId' => '<string>',
        'agentVersion' => '<string>',
        'apiSchema' => [
            'payload' => '<string>',
            's3' => [
                's3BucketName' => '<string>',
                's3ObjectKey' => '<string>',
            ],
        ],
        'clientToken' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'functionSchema' => [
            'functions' => [
                [
                    'description' => '<string>',
                    'name' => '<string>',
                    'parameters' => [
                        '<Name>' => [
                            'description' => '<string>',
                            'required' => true || false,
                            'type' => 'string|number|integer|boolean|array',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        'parentActionSignature' => 'AMAZON.UserInput',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ConflictException:

There was a conflict performing an operation.

ServiceQuotaExceededException:

The number of requests exceeds the service quota. Resubmit your request later.

CreateAgentAlias

$result = $client->createAgentAlias([/* ... */]);
$promise = $client->createAgentAliasAsync([/* ... */]);

Creates an alias of an agent that can be used to deploy the agent.

Parameter Syntax

$result = $client->createAgentAlias([
    'agentAliasName' => '<string>', // REQUIRED
    'agentId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'description' => '<string>',
    'routingConfiguration' => [
        [
            'agentVersion' => '<string>',
            'provisionedThroughput' => '<string>',
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'agentAlias' => [
        'agentAliasArn' => '<string>',
        'agentAliasHistoryEvents' => [
            [
                'endDate' => <DateTime>,
                'routingConfiguration' => [
                    [
                        'agentVersion' => '<string>',
                        'provisionedThroughput' => '<string>',
                    ],
                    // ...
                ],
                'startDate' => <DateTime>,
            ],
            // ...
        ],
        'agentAliasId' => '<string>',
        'agentAliasName' => '<string>',
        'agentAliasStatus' => 'CREATING|PREPARED|FAILED|UPDATING|DELETING',
        'agentId' => '<string>',
        'clientToken' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'failureReasons' => ['<string>', ...],
        'routingConfiguration' => [
            [
                'agentVersion' => '<string>',
                'provisionedThroughput' => '<string>',
            ],
            // ...
        ],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ConflictException:

There was a conflict performing an operation.

ServiceQuotaExceededException:

The number of requests exceeds the service quota. Resubmit your request later.

CreateDataSource

$result = $client->createDataSource([/* ... */]);
$promise = $client->createDataSourceAsync([/* ... */]);

Sets up a data source to be added to a knowledge base.

Parameter Syntax

$result = $client->createDataSource([
    'clientToken' => '<string>',
    'dataDeletionPolicy' => 'RETAIN|DELETE',
    'dataSourceConfiguration' => [ // REQUIRED
        's3Configuration' => [
            'bucketArn' => '<string>', // REQUIRED
            'bucketOwnerAccountId' => '<string>',
            'inclusionPrefixes' => ['<string>', ...],
        ],
        'type' => 'S3', // REQUIRED
    ],
    'description' => '<string>',
    'knowledgeBaseId' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'serverSideEncryptionConfiguration' => [
        'kmsKeyArn' => '<string>',
    ],
    'vectorIngestionConfiguration' => [
        'chunkingConfiguration' => [
            'chunkingStrategy' => 'FIXED_SIZE|NONE', // REQUIRED
            'fixedSizeChunkingConfiguration' => [
                'maxTokens' => <integer>, // REQUIRED
                'overlapPercentage' => <integer>, // REQUIRED
            ],
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'dataSource' => [
        'createdAt' => <DateTime>,
        'dataDeletionPolicy' => 'RETAIN|DELETE',
        'dataSourceConfiguration' => [
            's3Configuration' => [
                'bucketArn' => '<string>',
                'bucketOwnerAccountId' => '<string>',
                'inclusionPrefixes' => ['<string>', ...],
            ],
            'type' => 'S3',
        ],
        'dataSourceId' => '<string>',
        'description' => '<string>',
        'failureReasons' => ['<string>', ...],
        'knowledgeBaseId' => '<string>',
        'name' => '<string>',
        'serverSideEncryptionConfiguration' => [
            'kmsKeyArn' => '<string>',
        ],
        'status' => 'AVAILABLE|DELETING|DELETE_UNSUCCESSFUL',
        'updatedAt' => <DateTime>,
        'vectorIngestionConfiguration' => [
            'chunkingConfiguration' => [
                'chunkingStrategy' => 'FIXED_SIZE|NONE',
                'fixedSizeChunkingConfiguration' => [
                    'maxTokens' => <integer>,
                    'overlapPercentage' => <integer>,
                ],
            ],
        ],
    ],
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ConflictException:

There was a conflict performing an operation.

ServiceQuotaExceededException:

The number of requests exceeds the service quota. Resubmit your request later.

CreateKnowledgeBase

$result = $client->createKnowledgeBase([/* ... */]);
$promise = $client->createKnowledgeBaseAsync([/* ... */]);

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.

• 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.

Parameter Syntax

$result = $client->createKnowledgeBase([
    'clientToken' => '<string>',
    'description' => '<string>',
    'knowledgeBaseConfiguration' => [ // REQUIRED
        'type' => 'VECTOR', // REQUIRED
        'vectorKnowledgeBaseConfiguration' => [
            'embeddingModelArn' => '<string>', // REQUIRED
            'embeddingModelConfiguration' => [
                'bedrockEmbeddingModelConfiguration' => [
                    'dimensions' => <integer>,
                ],
            ],
        ],
    ],
    'name' => '<string>', // REQUIRED
    'roleArn' => '<string>', // REQUIRED
    'storageConfiguration' => [ // REQUIRED
        'mongoDbAtlasConfiguration' => [
            'collectionName' => '<string>', // REQUIRED
            'credentialsSecretArn' => '<string>', // REQUIRED
            'databaseName' => '<string>', // REQUIRED
            'endpoint' => '<string>', // REQUIRED
            'endpointServiceName' => '<string>',
            'fieldMapping' => [ // REQUIRED
                'metadataField' => '<string>', // REQUIRED
                'textField' => '<string>', // REQUIRED
                'vectorField' => '<string>', // REQUIRED
            ],
            'vectorIndexName' => '<string>', // REQUIRED
        ],
        'opensearchServerlessConfiguration' => [
            'collectionArn' => '<string>', // REQUIRED
            'fieldMapping' => [ // REQUIRED
                'metadataField' => '<string>', // REQUIRED
                'textField' => '<string>', // REQUIRED
                'vectorField' => '<string>', // REQUIRED
            ],
            'vectorIndexName' => '<string>', // REQUIRED
        ],
        'pineconeConfiguration' => [
            'connectionString' => '<string>', // REQUIRED
            'credentialsSecretArn' => '<string>', // REQUIRED
            'fieldMapping' => [ // REQUIRED
                'metadataField' => '<string>', // REQUIRED
                'textField' => '<string>', // REQUIRED
            ],
            'namespace' => '<string>',
        ],
        'rdsConfiguration' => [
            'credentialsSecretArn' => '<string>', // REQUIRED
            'databaseName' => '<string>', // REQUIRED
            'fieldMapping' => [ // REQUIRED
                'metadataField' => '<string>', // REQUIRED
                'primaryKeyField' => '<string>', // REQUIRED
                'textField' => '<string>', // REQUIRED
                'vectorField' => '<string>', // REQUIRED
            ],
            'resourceArn' => '<string>', // REQUIRED
            'tableName' => '<string>', // REQUIRED
        ],
        'redisEnterpriseCloudConfiguration' => [
            'credentialsSecretArn' => '<string>', // REQUIRED
            'endpoint' => '<string>', // REQUIRED
            'fieldMapping' => [ // REQUIRED
                'metadataField' => '<string>', // REQUIRED
                'textField' => '<string>', // REQUIRED
                'vectorField' => '<string>', // REQUIRED
            ],
            'vectorIndexName' => '<string>', // REQUIRED
        ],
        'type' => 'OPENSEARCH_SERVERLESS|PINECONE|REDIS_ENTERPRISE_CLOUD|RDS|MONGO_DB_ATLAS', // REQUIRED
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'knowledgeBase' => [
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'failureReasons' => ['<string>', ...],
        'knowledgeBaseArn' => '<string>',
        'knowledgeBaseConfiguration' => [
            'type' => 'VECTOR',
            'vectorKnowledgeBaseConfiguration' => [
                'embeddingModelArn' => '<string>',
                'embeddingModelConfiguration' => [
                    'bedrockEmbeddingModelConfiguration' => [
                        'dimensions' => <integer>,
                    ],
                ],
            ],
        ],
        'knowledgeBaseId' => '<string>',
        'name' => '<string>',
        'roleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|DELETING|UPDATING|FAILED|DELETE_UNSUCCESSFUL',
        'storageConfiguration' => [
            'mongoDbAtlasConfiguration' => [
                'collectionName' => '<string>',
                'credentialsSecretArn' => '<string>',
                'databaseName' => '<string>',
                'endpoint' => '<string>',
                'endpointServiceName' => '<string>',
                'fieldMapping' => [
                    'metadataField' => '<string>',
                    'textField' => '<string>',
                    'vectorField' => '<string>',
                ],
                'vectorIndexName' => '<string>',
            ],
            'opensearchServerlessConfiguration' => [
                'collectionArn' => '<string>',
                'fieldMapping' => [
                    'metadataField' => '<string>',
                    'textField' => '<string>',
                    'vectorField' => '<string>',
                ],
                'vectorIndexName' => '<string>',
            ],
            'pineconeConfiguration' => [
                'connectionString' => '<string>',
                'credentialsSecretArn' => '<string>',
                'fieldMapping' => [
                    'metadataField' => '<string>',
                    'textField' => '<string>',
                ],
                'namespace' => '<string>',
            ],
            'rdsConfiguration' => [
                'credentialsSecretArn' => '<string>',
                'databaseName' => '<string>',
                'fieldMapping' => [
                    'metadataField' => '<string>',
                    'primaryKeyField' => '<string>',
                    'textField' => '<string>',
                    'vectorField' => '<string>',
                ],
                'resourceArn' => '<string>',
                'tableName' => '<string>',
            ],
            'redisEnterpriseCloudConfiguration' => [
                'credentialsSecretArn' => '<string>',
                'endpoint' => '<string>',
                'fieldMapping' => [
                    'metadataField' => '<string>',
                    'textField' => '<string>',
                    'vectorField' => '<string>',
                ],
                'vectorIndexName' => '<string>',
            ],
            'type' => 'OPENSEARCH_SERVERLESS|PINECONE|REDIS_ENTERPRISE_CLOUD|RDS|MONGO_DB_ATLAS',
        ],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ConflictException:

There was a conflict performing an operation.

ServiceQuotaExceededException:

The number of requests exceeds the service quota. Resubmit your request later.

DeleteAgent

$result = $client->deleteAgent([/* ... */]);
$promise = $client->deleteAgentAsync([/* ... */]);

Deletes an agent.

Parameter Syntax

$result = $client->deleteAgent([
    'agentId' => '<string>', // REQUIRED
    'skipResourceInUseCheck' => true || false,
]);

Parameter Details

Result Syntax

[
    'agentId' => '<string>',
    'agentStatus' => 'CREATING|PREPARING|PREPARED|NOT_PREPARED|DELETING|FAILED|VERSIONING|UPDATING',
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ConflictException:

There was a conflict performing an operation.

DeleteAgentActionGroup

$result = $client->deleteAgentActionGroup([/* ... */]);
$promise = $client->deleteAgentActionGroupAsync([/* ... */]);

Deletes an action group in an agent.

Parameter Syntax

$result = $client->deleteAgentActionGroup([
    'actionGroupId' => '<string>', // REQUIRED
    'agentId' => '<string>', // REQUIRED
    'agentVersion' => '<string>', // REQUIRED
    'skipResourceInUseCheck' => true || false,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ConflictException:

There was a conflict performing an operation.

DeleteAgentAlias

$result = $client->deleteAgentAlias([/* ... */]);
$promise = $client->deleteAgentAliasAsync([/* ... */]);

Deletes an alias of an agent.

Parameter Syntax

$result = $client->deleteAgentAlias([
    'agentAliasId' => '<string>', // REQUIRED
    'agentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'agentAliasId' => '<string>',
    'agentAliasStatus' => 'CREATING|PREPARED|FAILED|UPDATING|DELETING',
    'agentId' => '<string>',
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

DeleteAgentVersion

$result = $client->deleteAgentVersion([/* ... */]);
$promise = $client->deleteAgentVersionAsync([/* ... */]);

Deletes a version of an agent.

Parameter Syntax

$result = $client->deleteAgentVersion([
    'agentId' => '<string>', // REQUIRED
    'agentVersion' => '<string>', // REQUIRED
    'skipResourceInUseCheck' => true || false,
]);

Parameter Details

Result Syntax

[
    'agentId' => '<string>',
    'agentStatus' => 'CREATING|PREPARING|PREPARED|NOT_PREPARED|DELETING|FAILED|VERSIONING|UPDATING',
    'agentVersion' => '<string>',
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ConflictException:

There was a conflict performing an operation.

DeleteDataSource

$result = $client->deleteDataSource([/* ... */]);
$promise = $client->deleteDataSourceAsync([/* ... */]);

Deletes a data source from a knowledge base.

Parameter Syntax

$result = $client->deleteDataSource([
    'dataSourceId' => '<string>', // REQUIRED
    'knowledgeBaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'dataSourceId' => '<string>',
    'knowledgeBaseId' => '<string>',
    'status' => 'AVAILABLE|DELETING|DELETE_UNSUCCESSFUL',
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ConflictException:

There was a conflict performing an operation.

DeleteKnowledgeBase

$result = $client->deleteKnowledgeBase([/* ... */]);
$promise = $client->deleteKnowledgeBaseAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteKnowledgeBase([
    'knowledgeBaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'knowledgeBaseId' => '<string>',
    'status' => 'CREATING|ACTIVE|DELETING|UPDATING|FAILED|DELETE_UNSUCCESSFUL',
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ConflictException:

There was a conflict performing an operation.

DisassociateAgentKnowledgeBase

$result = $client->disassociateAgentKnowledgeBase([/* ... */]);
$promise = $client->disassociateAgentKnowledgeBaseAsync([/* ... */]);

Disassociates a knowledge base from an agent.

Parameter Syntax

$result = $client->disassociateAgentKnowledgeBase([
    'agentId' => '<string>', // REQUIRED
    'agentVersion' => '<string>', // REQUIRED
    'knowledgeBaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ConflictException:

There was a conflict performing an operation.

GetAgent

$result = $client->getAgent([/* ... */]);
$promise = $client->getAgentAsync([/* ... */]);

Gets information about an agent.

Parameter Syntax

$result = $client->getAgent([
    'agentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'agent' => [
        'agentArn' => '<string>',
        'agentId' => '<string>',
        'agentName' => '<string>',
        'agentResourceRoleArn' => '<string>',
        'agentStatus' => 'CREATING|PREPARING|PREPARED|NOT_PREPARED|DELETING|FAILED|VERSIONING|UPDATING',
        'agentVersion' => '<string>',
        'clientToken' => '<string>',
        'createdAt' => <DateTime>,
        'customerEncryptionKeyArn' => '<string>',
        'description' => '<string>',
        'failureReasons' => ['<string>', ...],
        'foundationModel' => '<string>',
        'guardrailConfiguration' => [
            'guardrailIdentifier' => '<string>',
            'guardrailVersion' => '<string>',
        ],
        'idleSessionTTLInSeconds' => <integer>,
        'instruction' => '<string>',
        'preparedAt' => <DateTime>,
        'promptOverrideConfiguration' => [
            'overrideLambda' => '<string>',
            'promptConfigurations' => [
                [
                    'basePromptTemplate' => '<string>',
                    'inferenceConfiguration' => [
                        'maximumLength' => <integer>,
                        'stopSequences' => ['<string>', ...],
                        'temperature' => <float>,
                        'topK' => <integer>,
                        'topP' => <float>,
                    ],
                    'parserMode' => 'DEFAULT|OVERRIDDEN',
                    'promptCreationMode' => 'DEFAULT|OVERRIDDEN',
                    'promptState' => 'ENABLED|DISABLED',
                    'promptType' => 'PRE_PROCESSING|ORCHESTRATION|POST_PROCESSING|KNOWLEDGE_BASE_RESPONSE_GENERATION',
                ],
                // ...
            ],
        ],
        'recommendedActions' => ['<string>', ...],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

GetAgentActionGroup

$result = $client->getAgentActionGroup([/* ... */]);
$promise = $client->getAgentActionGroupAsync([/* ... */]);

Gets information about an action group for an agent.

Parameter Syntax

$result = $client->getAgentActionGroup([
    'actionGroupId' => '<string>', // REQUIRED
    'agentId' => '<string>', // REQUIRED
    'agentVersion' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'agentActionGroup' => [
        'actionGroupExecutor' => [
            'customControl' => 'RETURN_CONTROL',
            'lambda' => '<string>',
        ],
        'actionGroupId' => '<string>',
        'actionGroupName' => '<string>',
        'actionGroupState' => 'ENABLED|DISABLED',
        'agentId' => '<string>',
        'agentVersion' => '<string>',
        'apiSchema' => [
            'payload' => '<string>',
            's3' => [
                's3BucketName' => '<string>',
                's3ObjectKey' => '<string>',
            ],
        ],
        'clientToken' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'functionSchema' => [
            'functions' => [
                [
                    'description' => '<string>',
                    'name' => '<string>',
                    'parameters' => [
                        '<Name>' => [
                            'description' => '<string>',
                            'required' => true || false,
                            'type' => 'string|number|integer|boolean|array',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        'parentActionSignature' => 'AMAZON.UserInput',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

GetAgentAlias

$result = $client->getAgentAlias([/* ... */]);
$promise = $client->getAgentAliasAsync([/* ... */]);

Gets information about an alias of an agent.

Parameter Syntax

$result = $client->getAgentAlias([
    'agentAliasId' => '<string>', // REQUIRED
    'agentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'agentAlias' => [
        'agentAliasArn' => '<string>',
        'agentAliasHistoryEvents' => [
            [
                'endDate' => <DateTime>,
                'routingConfiguration' => [
                    [
                        'agentVersion' => '<string>',
                        'provisionedThroughput' => '<string>',
                    ],
                    // ...
                ],
                'startDate' => <DateTime>,
            ],
            // ...
        ],
        'agentAliasId' => '<string>',
        'agentAliasName' => '<string>',
        'agentAliasStatus' => 'CREATING|PREPARED|FAILED|UPDATING|DELETING',
        'agentId' => '<string>',
        'clientToken' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'failureReasons' => ['<string>', ...],
        'routingConfiguration' => [
            [
                'agentVersion' => '<string>',
                'provisionedThroughput' => '<string>',
            ],
            // ...
        ],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

GetAgentKnowledgeBase

$result = $client->getAgentKnowledgeBase([/* ... */]);
$promise = $client->getAgentKnowledgeBaseAsync([/* ... */]);

Gets information about a knowledge base associated with an agent.

Parameter Syntax

$result = $client->getAgentKnowledgeBase([
    'agentId' => '<string>', // REQUIRED
    'agentVersion' => '<string>', // REQUIRED
    'knowledgeBaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'agentKnowledgeBase' => [
        'agentId' => '<string>',
        'agentVersion' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'knowledgeBaseId' => '<string>',
        'knowledgeBaseState' => 'ENABLED|DISABLED',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

GetAgentVersion

$result = $client->getAgentVersion([/* ... */]);
$promise = $client->getAgentVersionAsync([/* ... */]);

Gets details about a version of an agent.

Parameter Syntax

$result = $client->getAgentVersion([
    'agentId' => '<string>', // REQUIRED
    'agentVersion' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'agentVersion' => [
        'agentArn' => '<string>',
        'agentId' => '<string>',
        'agentName' => '<string>',
        'agentResourceRoleArn' => '<string>',
        'agentStatus' => 'CREATING|PREPARING|PREPARED|NOT_PREPARED|DELETING|FAILED|VERSIONING|UPDATING',
        'createdAt' => <DateTime>,
        'customerEncryptionKeyArn' => '<string>',
        'description' => '<string>',
        'failureReasons' => ['<string>', ...],
        'foundationModel' => '<string>',
        'guardrailConfiguration' => [
            'guardrailIdentifier' => '<string>',
            'guardrailVersion' => '<string>',
        ],
        'idleSessionTTLInSeconds' => <integer>,
        'instruction' => '<string>',
        'promptOverrideConfiguration' => [
            'overrideLambda' => '<string>',
            'promptConfigurations' => [
                [
                    'basePromptTemplate' => '<string>',
                    'inferenceConfiguration' => [
                        'maximumLength' => <integer>,
                        'stopSequences' => ['<string>', ...],
                        'temperature' => <float>,
                        'topK' => <integer>,
                        'topP' => <float>,
                    ],
                    'parserMode' => 'DEFAULT|OVERRIDDEN',
                    'promptCreationMode' => 'DEFAULT|OVERRIDDEN',
                    'promptState' => 'ENABLED|DISABLED',
                    'promptType' => 'PRE_PROCESSING|ORCHESTRATION|POST_PROCESSING|KNOWLEDGE_BASE_RESPONSE_GENERATION',
                ],
                // ...
            ],
        ],
        'recommendedActions' => ['<string>', ...],
        'updatedAt' => <DateTime>,
        'version' => '<string>',
    ],
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

GetDataSource

$result = $client->getDataSource([/* ... */]);
$promise = $client->getDataSourceAsync([/* ... */]);

Gets information about a data source.

Parameter Syntax

$result = $client->getDataSource([
    'dataSourceId' => '<string>', // REQUIRED
    'knowledgeBaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'dataSource' => [
        'createdAt' => <DateTime>,
        'dataDeletionPolicy' => 'RETAIN|DELETE',
        'dataSourceConfiguration' => [
            's3Configuration' => [
                'bucketArn' => '<string>',
                'bucketOwnerAccountId' => '<string>',
                'inclusionPrefixes' => ['<string>', ...],
            ],
            'type' => 'S3',
        ],
        'dataSourceId' => '<string>',
        'description' => '<string>',
        'failureReasons' => ['<string>', ...],
        'knowledgeBaseId' => '<string>',
        'name' => '<string>',
        'serverSideEncryptionConfiguration' => [
            'kmsKeyArn' => '<string>',
        ],
        'status' => 'AVAILABLE|DELETING|DELETE_UNSUCCESSFUL',
        'updatedAt' => <DateTime>,
        'vectorIngestionConfiguration' => [
            'chunkingConfiguration' => [
                'chunkingStrategy' => 'FIXED_SIZE|NONE',
                'fixedSizeChunkingConfiguration' => [
                    'maxTokens' => <integer>,
                    'overlapPercentage' => <integer>,
                ],
            ],
        ],
    ],
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

GetIngestionJob

$result = $client->getIngestionJob([/* ... */]);
$promise = $client->getIngestionJobAsync([/* ... */]);

Gets information about a ingestion job, in which a data source is added to a knowledge base.

Parameter Syntax

$result = $client->getIngestionJob([
    'dataSourceId' => '<string>', // REQUIRED
    'ingestionJobId' => '<string>', // REQUIRED
    'knowledgeBaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ingestionJob' => [
        'dataSourceId' => '<string>',
        'description' => '<string>',
        'failureReasons' => ['<string>', ...],
        'ingestionJobId' => '<string>',
        'knowledgeBaseId' => '<string>',
        'startedAt' => <DateTime>,
        'statistics' => [
            'numberOfDocumentsDeleted' => <integer>,
            'numberOfDocumentsFailed' => <integer>,
            'numberOfDocumentsScanned' => <integer>,
            'numberOfMetadataDocumentsModified' => <integer>,
            'numberOfMetadataDocumentsScanned' => <integer>,
            'numberOfModifiedDocumentsIndexed' => <integer>,
            'numberOfNewDocumentsIndexed' => <integer>,
        ],
        'status' => 'STARTING|IN_PROGRESS|COMPLETE|FAILED',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

GetKnowledgeBase

$result = $client->getKnowledgeBase([/* ... */]);
$promise = $client->getKnowledgeBaseAsync([/* ... */]);

Gets information about a knoweldge base.

Parameter Syntax

$result = $client->getKnowledgeBase([
    'knowledgeBaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'knowledgeBase' => [
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'failureReasons' => ['<string>', ...],
        'knowledgeBaseArn' => '<string>',
        'knowledgeBaseConfiguration' => [
            'type' => 'VECTOR',
            'vectorKnowledgeBaseConfiguration' => [
                'embeddingModelArn' => '<string>',
                'embeddingModelConfiguration' => [
                    'bedrockEmbeddingModelConfiguration' => [
                        'dimensions' => <integer>,
                    ],
                ],
            ],
        ],
        'knowledgeBaseId' => '<string>',
        'name' => '<string>',
        'roleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|DELETING|UPDATING|FAILED|DELETE_UNSUCCESSFUL',
        'storageConfiguration' => [
            'mongoDbAtlasConfiguration' => [
                'collectionName' => '<string>',
                'credentialsSecretArn' => '<string>',
                'databaseName' => '<string>',
                'endpoint' => '<string>',
                'endpointServiceName' => '<string>',
                'fieldMapping' => [
                    'metadataField' => '<string>',
                    'textField' => '<string>',
                    'vectorField' => '<string>',
                ],
                'vectorIndexName' => '<string>',
            ],
            'opensearchServerlessConfiguration' => [
                'collectionArn' => '<string>',
                'fieldMapping' => [
                    'metadataField' => '<string>',
                    'textField' => '<string>',
                    'vectorField' => '<string>',
                ],
                'vectorIndexName' => '<string>',
            ],
            'pineconeConfiguration' => [
                'connectionString' => '<string>',
                'credentialsSecretArn' => '<string>',
                'fieldMapping' => [
                    'metadataField' => '<string>',
                    'textField' => '<string>',
                ],
                'namespace' => '<string>',
            ],
            'rdsConfiguration' => [
                'credentialsSecretArn' => '<string>',
                'databaseName' => '<string>',
                'fieldMapping' => [
                    'metadataField' => '<string>',
                    'primaryKeyField' => '<string>',
                    'textField' => '<string>',
                    'vectorField' => '<string>',
                ],
                'resourceArn' => '<string>',
                'tableName' => '<string>',
            ],
            'redisEnterpriseCloudConfiguration' => [
                'credentialsSecretArn' => '<string>',
                'endpoint' => '<string>',
                'fieldMapping' => [
                    'metadataField' => '<string>',
                    'textField' => '<string>',
                    'vectorField' => '<string>',
                ],
                'vectorIndexName' => '<string>',
            ],
            'type' => 'OPENSEARCH_SERVERLESS|PINECONE|REDIS_ENTERPRISE_CLOUD|RDS|MONGO_DB_ATLAS',
        ],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ListAgentActionGroups

$result = $client->listAgentActionGroups([/* ... */]);
$promise = $client->listAgentActionGroupsAsync([/* ... */]);

Lists the action groups for an agent and information about each one.

Parameter Syntax

$result = $client->listAgentActionGroups([
    'agentId' => '<string>', // REQUIRED
    'agentVersion' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'actionGroupSummaries' => [
        [
            'actionGroupId' => '<string>',
            'actionGroupName' => '<string>',
            'actionGroupState' => 'ENABLED|DISABLED',
            'description' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ListAgentAliases

$result = $client->listAgentAliases([/* ... */]);
$promise = $client->listAgentAliasesAsync([/* ... */]);

Lists the aliases of an agent and information about each one.

Parameter Syntax

$result = $client->listAgentAliases([
    'agentId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'agentAliasSummaries' => [
        [
            'agentAliasId' => '<string>',
            'agentAliasName' => '<string>',
            'agentAliasStatus' => 'CREATING|PREPARED|FAILED|UPDATING|DELETING',
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'routingConfiguration' => [
                [
                    'agentVersion' => '<string>',
                    'provisionedThroughput' => '<string>',
                ],
                // ...
            ],
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ListAgentKnowledgeBases

$result = $client->listAgentKnowledgeBases([/* ... */]);
$promise = $client->listAgentKnowledgeBasesAsync([/* ... */]);

Lists knowledge bases associated with an agent and information about each one.

Parameter Syntax

$result = $client->listAgentKnowledgeBases([
    'agentId' => '<string>', // REQUIRED
    'agentVersion' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'agentKnowledgeBaseSummaries' => [
        [
            'description' => '<string>',
            'knowledgeBaseId' => '<string>',
            'knowledgeBaseState' => 'ENABLED|DISABLED',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ListAgentVersions

$result = $client->listAgentVersions([/* ... */]);
$promise = $client->listAgentVersionsAsync([/* ... */]);

Lists the versions of an agent and information about each version.

Parameter Syntax

$result = $client->listAgentVersions([
    'agentId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'agentVersionSummaries' => [
        [
            'agentName' => '<string>',
            'agentStatus' => 'CREATING|PREPARING|PREPARED|NOT_PREPARED|DELETING|FAILED|VERSIONING|UPDATING',
            'agentVersion' => '<string>',
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'guardrailConfiguration' => [
                'guardrailIdentifier' => '<string>',
                'guardrailVersion' => '<string>',
            ],
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ListAgents

$result = $client->listAgents([/* ... */]);
$promise = $client->listAgentsAsync([/* ... */]);

Lists the agents belonging to an account and information about each agent.

Parameter Syntax

$result = $client->listAgents([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'agentSummaries' => [
        [
            'agentId' => '<string>',
            'agentName' => '<string>',
            'agentStatus' => 'CREATING|PREPARING|PREPARED|NOT_PREPARED|DELETING|FAILED|VERSIONING|UPDATING',
            'description' => '<string>',
            'guardrailConfiguration' => [
                'guardrailIdentifier' => '<string>',
                'guardrailVersion' => '<string>',
            ],
            'latestAgentVersion' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ListDataSources

$result = $client->listDataSources([/* ... */]);
$promise = $client->listDataSourcesAsync([/* ... */]);

Lists the data sources in a knowledge base and information about each one.

Parameter Syntax

$result = $client->listDataSources([
    'knowledgeBaseId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'dataSourceSummaries' => [
        [
            'dataSourceId' => '<string>',
            'description' => '<string>',
            'knowledgeBaseId' => '<string>',
            'name' => '<string>',
            'status' => 'AVAILABLE|DELETING|DELETE_UNSUCCESSFUL',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ListIngestionJobs

$result = $client->listIngestionJobs([/* ... */]);
$promise = $client->listIngestionJobsAsync([/* ... */]);

Lists the ingestion jobs for a data source and information about each of them.

Parameter Syntax

$result = $client->listIngestionJobs([
    'dataSourceId' => '<string>', // REQUIRED
    'filters' => [
        [
            'attribute' => 'STATUS', // REQUIRED
            'operator' => 'EQ', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'knowledgeBaseId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortBy' => [
        'attribute' => 'STATUS|STARTED_AT', // REQUIRED
        'order' => 'ASCENDING|DESCENDING', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'ingestionJobSummaries' => [
        [
            'dataSourceId' => '<string>',
            'description' => '<string>',
            'ingestionJobId' => '<string>',
            'knowledgeBaseId' => '<string>',
            'startedAt' => <DateTime>,
            'statistics' => [
                'numberOfDocumentsDeleted' => <integer>,
                'numberOfDocumentsFailed' => <integer>,
                'numberOfDocumentsScanned' => <integer>,
                'numberOfMetadataDocumentsModified' => <integer>,
                'numberOfMetadataDocumentsScanned' => <integer>,
                'numberOfModifiedDocumentsIndexed' => <integer>,
                'numberOfNewDocumentsIndexed' => <integer>,
            ],
            'status' => 'STARTING|IN_PROGRESS|COMPLETE|FAILED',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ListKnowledgeBases

$result = $client->listKnowledgeBases([/* ... */]);
$promise = $client->listKnowledgeBasesAsync([/* ... */]);

Lists the knowledge bases in an account and information about each of them.

Parameter Syntax

$result = $client->listKnowledgeBases([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'knowledgeBaseSummaries' => [
        [
            'description' => '<string>',
            'knowledgeBaseId' => '<string>',
            'name' => '<string>',
            'status' => 'CREATING|ACTIVE|DELETING|UPDATING|FAILED|DELETE_UNSUCCESSFUL',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

List all the tags for the resource you specify.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

PrepareAgent

$result = $client->prepareAgent([/* ... */]);
$promise = $client->prepareAgentAsync([/* ... */]);

Creates a DRAFT version of the agent that can be used for internal testing.

Parameter Syntax

$result = $client->prepareAgent([
    'agentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'agentId' => '<string>',
    'agentStatus' => 'CREATING|PREPARING|PREPARED|NOT_PREPARED|DELETING|FAILED|VERSIONING|UPDATING',
    'agentVersion' => '<string>',
    'preparedAt' => <DateTime>,
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ConflictException:

There was a conflict performing an operation.

ServiceQuotaExceededException:

The number of requests exceeds the service quota. Resubmit your request later.

StartIngestionJob

$result = $client->startIngestionJob([/* ... */]);
$promise = $client->startIngestionJobAsync([/* ... */]);

Begins an ingestion job, in which a data source is added to a knowledge base.

Parameter Syntax

$result = $client->startIngestionJob([
    'clientToken' => '<string>',
    'dataSourceId' => '<string>', // REQUIRED
    'description' => '<string>',
    'knowledgeBaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ingestionJob' => [
        'dataSourceId' => '<string>',
        'description' => '<string>',
        'failureReasons' => ['<string>', ...],
        'ingestionJobId' => '<string>',
        'knowledgeBaseId' => '<string>',
        'startedAt' => <DateTime>,
        'statistics' => [
            'numberOfDocumentsDeleted' => <integer>,
            'numberOfDocumentsFailed' => <integer>,
            'numberOfDocumentsScanned' => <integer>,
            'numberOfMetadataDocumentsModified' => <integer>,
            'numberOfMetadataDocumentsScanned' => <integer>,
            'numberOfModifiedDocumentsIndexed' => <integer>,
            'numberOfNewDocumentsIndexed' => <integer>,
        ],
        'status' => 'STARTING|IN_PROGRESS|COMPLETE|FAILED',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ConflictException:

There was a conflict performing an operation.

ServiceQuotaExceededException:

The number of requests exceeds the service quota. Resubmit your request later.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ServiceQuotaExceededException:

The number of requests exceeds the service quota. Resubmit your request later.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Remove tags from a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

UpdateAgent

$result = $client->updateAgent([/* ... */]);
$promise = $client->updateAgentAsync([/* ... */]);

Updates the configuration of an agent.

Parameter Syntax

$result = $client->updateAgent([
    'agentId' => '<string>', // REQUIRED
    'agentName' => '<string>', // REQUIRED
    'agentResourceRoleArn' => '<string>', // REQUIRED
    'customerEncryptionKeyArn' => '<string>',
    'description' => '<string>',
    'foundationModel' => '<string>', // REQUIRED
    'guardrailConfiguration' => [
        'guardrailIdentifier' => '<string>',
        'guardrailVersion' => '<string>',
    ],
    'idleSessionTTLInSeconds' => <integer>,
    'instruction' => '<string>',
    'promptOverrideConfiguration' => [
        'overrideLambda' => '<string>',
        'promptConfigurations' => [ // REQUIRED
            [
                'basePromptTemplate' => '<string>',
                'inferenceConfiguration' => [
                    'maximumLength' => <integer>,
                    'stopSequences' => ['<string>', ...],
                    'temperature' => <float>,
                    'topK' => <integer>,
                    'topP' => <float>,
                ],
                'parserMode' => 'DEFAULT|OVERRIDDEN',
                'promptCreationMode' => 'DEFAULT|OVERRIDDEN',
                'promptState' => 'ENABLED|DISABLED',
                'promptType' => 'PRE_PROCESSING|ORCHESTRATION|POST_PROCESSING|KNOWLEDGE_BASE_RESPONSE_GENERATION',
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'agent' => [
        'agentArn' => '<string>',
        'agentId' => '<string>',
        'agentName' => '<string>',
        'agentResourceRoleArn' => '<string>',
        'agentStatus' => 'CREATING|PREPARING|PREPARED|NOT_PREPARED|DELETING|FAILED|VERSIONING|UPDATING',
        'agentVersion' => '<string>',
        'clientToken' => '<string>',
        'createdAt' => <DateTime>,
        'customerEncryptionKeyArn' => '<string>',
        'description' => '<string>',
        'failureReasons' => ['<string>', ...],
        'foundationModel' => '<string>',
        'guardrailConfiguration' => [
            'guardrailIdentifier' => '<string>',
            'guardrailVersion' => '<string>',
        ],
        'idleSessionTTLInSeconds' => <integer>,
        'instruction' => '<string>',
        'preparedAt' => <DateTime>,
        'promptOverrideConfiguration' => [
            'overrideLambda' => '<string>',
            'promptConfigurations' => [
                [
                    'basePromptTemplate' => '<string>',
                    'inferenceConfiguration' => [
                        'maximumLength' => <integer>,
                        'stopSequences' => ['<string>', ...],
                        'temperature' => <float>,
                        'topK' => <integer>,
                        'topP' => <float>,
                    ],
                    'parserMode' => 'DEFAULT|OVERRIDDEN',
                    'promptCreationMode' => 'DEFAULT|OVERRIDDEN',
                    'promptState' => 'ENABLED|DISABLED',
                    'promptType' => 'PRE_PROCESSING|ORCHESTRATION|POST_PROCESSING|KNOWLEDGE_BASE_RESPONSE_GENERATION',
                ],
                // ...
            ],
        ],
        'recommendedActions' => ['<string>', ...],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ConflictException:

There was a conflict performing an operation.

ServiceQuotaExceededException:

The number of requests exceeds the service quota. Resubmit your request later.

UpdateAgentActionGroup

$result = $client->updateAgentActionGroup([/* ... */]);
$promise = $client->updateAgentActionGroupAsync([/* ... */]);

Updates the configuration for an action group for an agent.

Parameter Syntax

$result = $client->updateAgentActionGroup([
    'actionGroupExecutor' => [
        'customControl' => 'RETURN_CONTROL',
        'lambda' => '<string>',
    ],
    'actionGroupId' => '<string>', // REQUIRED
    'actionGroupName' => '<string>', // REQUIRED
    'actionGroupState' => 'ENABLED|DISABLED',
    'agentId' => '<string>', // REQUIRED
    'agentVersion' => '<string>', // REQUIRED
    'apiSchema' => [
        'payload' => '<string>',
        's3' => [
            's3BucketName' => '<string>',
            's3ObjectKey' => '<string>',
        ],
    ],
    'description' => '<string>',
    'functionSchema' => [
        'functions' => [
            [
                'description' => '<string>',
                'name' => '<string>', // REQUIRED
                'parameters' => [
                    '<Name>' => [
                        'description' => '<string>',
                        'required' => true || false,
                        'type' => 'string|number|integer|boolean|array', // REQUIRED
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'parentActionGroupSignature' => 'AMAZON.UserInput',
]);

Parameter Details

Result Syntax

[
    'agentActionGroup' => [
        'actionGroupExecutor' => [
            'customControl' => 'RETURN_CONTROL',
            'lambda' => '<string>',
        ],
        'actionGroupId' => '<string>',
        'actionGroupName' => '<string>',
        'actionGroupState' => 'ENABLED|DISABLED',
        'agentId' => '<string>',
        'agentVersion' => '<string>',
        'apiSchema' => [
            'payload' => '<string>',
            's3' => [
                's3BucketName' => '<string>',
                's3ObjectKey' => '<string>',
            ],
        ],
        'clientToken' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'functionSchema' => [
            'functions' => [
                [
                    'description' => '<string>',
                    'name' => '<string>',
                    'parameters' => [
                        '<Name>' => [
                            'description' => '<string>',
                            'required' => true || false,
                            'type' => 'string|number|integer|boolean|array',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        'parentActionSignature' => 'AMAZON.UserInput',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ConflictException:

There was a conflict performing an operation.

ServiceQuotaExceededException:

The number of requests exceeds the service quota. Resubmit your request later.

UpdateAgentAlias

$result = $client->updateAgentAlias([/* ... */]);
$promise = $client->updateAgentAliasAsync([/* ... */]);

Updates configurations for an alias of an agent.

Parameter Syntax

$result = $client->updateAgentAlias([
    'agentAliasId' => '<string>', // REQUIRED
    'agentAliasName' => '<string>', // REQUIRED
    'agentId' => '<string>', // REQUIRED
    'description' => '<string>',
    'routingConfiguration' => [
        [
            'agentVersion' => '<string>',
            'provisionedThroughput' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'agentAlias' => [
        'agentAliasArn' => '<string>',
        'agentAliasHistoryEvents' => [
            [
                'endDate' => <DateTime>,
                'routingConfiguration' => [
                    [
                        'agentVersion' => '<string>',
                        'provisionedThroughput' => '<string>',
                    ],
                    // ...
                ],
                'startDate' => <DateTime>,
            ],
            // ...
        ],
        'agentAliasId' => '<string>',
        'agentAliasName' => '<string>',
        'agentAliasStatus' => 'CREATING|PREPARED|FAILED|UPDATING|DELETING',
        'agentId' => '<string>',
        'clientToken' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'failureReasons' => ['<string>', ...],
        'routingConfiguration' => [
            [
                'agentVersion' => '<string>',
                'provisionedThroughput' => '<string>',
            ],
            // ...
        ],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ConflictException:

There was a conflict performing an operation.

ServiceQuotaExceededException:

The number of requests exceeds the service quota. Resubmit your request later.

UpdateAgentKnowledgeBase

$result = $client->updateAgentKnowledgeBase([/* ... */]);
$promise = $client->updateAgentKnowledgeBaseAsync([/* ... */]);

Updates the configuration for a knowledge base that has been associated with an agent.

Parameter Syntax

$result = $client->updateAgentKnowledgeBase([
    'agentId' => '<string>', // REQUIRED
    'agentVersion' => '<string>', // REQUIRED
    'description' => '<string>',
    'knowledgeBaseId' => '<string>', // REQUIRED
    'knowledgeBaseState' => 'ENABLED|DISABLED',
]);

Parameter Details

Result Syntax

[
    'agentKnowledgeBase' => [
        'agentId' => '<string>',
        'agentVersion' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'knowledgeBaseId' => '<string>',
        'knowledgeBaseState' => 'ENABLED|DISABLED',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ConflictException:

There was a conflict performing an operation.

UpdateDataSource

$result = $client->updateDataSource([/* ... */]);
$promise = $client->updateDataSourceAsync([/* ... */]);

Updates configurations for a data source.

Parameter Syntax

$result = $client->updateDataSource([
    'dataDeletionPolicy' => 'RETAIN|DELETE',
    'dataSourceConfiguration' => [ // REQUIRED
        's3Configuration' => [
            'bucketArn' => '<string>', // REQUIRED
            'bucketOwnerAccountId' => '<string>',
            'inclusionPrefixes' => ['<string>', ...],
        ],
        'type' => 'S3', // REQUIRED
    ],
    'dataSourceId' => '<string>', // REQUIRED
    'description' => '<string>',
    'knowledgeBaseId' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'serverSideEncryptionConfiguration' => [
        'kmsKeyArn' => '<string>',
    ],
    'vectorIngestionConfiguration' => [
        'chunkingConfiguration' => [
            'chunkingStrategy' => 'FIXED_SIZE|NONE', // REQUIRED
            'fixedSizeChunkingConfiguration' => [
                'maxTokens' => <integer>, // REQUIRED
                'overlapPercentage' => <integer>, // REQUIRED
            ],
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'dataSource' => [
        'createdAt' => <DateTime>,
        'dataDeletionPolicy' => 'RETAIN|DELETE',
        'dataSourceConfiguration' => [
            's3Configuration' => [
                'bucketArn' => '<string>',
                'bucketOwnerAccountId' => '<string>',
                'inclusionPrefixes' => ['<string>', ...],
            ],
            'type' => 'S3',
        ],
        'dataSourceId' => '<string>',
        'description' => '<string>',
        'failureReasons' => ['<string>', ...],
        'knowledgeBaseId' => '<string>',
        'name' => '<string>',
        'serverSideEncryptionConfiguration' => [
            'kmsKeyArn' => '<string>',
        ],
        'status' => 'AVAILABLE|DELETING|DELETE_UNSUCCESSFUL',
        'updatedAt' => <DateTime>,
        'vectorIngestionConfiguration' => [
            'chunkingConfiguration' => [
                'chunkingStrategy' => 'FIXED_SIZE|NONE',
                'fixedSizeChunkingConfiguration' => [
                    'maxTokens' => <integer>,
                    'overlapPercentage' => <integer>,
                ],
            ],
        ],
    ],
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ConflictException:

There was a conflict performing an operation.

UpdateKnowledgeBase

$result = $client->updateKnowledgeBase([/* ... */]);
$promise = $client->updateKnowledgeBaseAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateKnowledgeBase([
    'description' => '<string>',
    'knowledgeBaseConfiguration' => [ // REQUIRED
        'type' => 'VECTOR', // REQUIRED
        'vectorKnowledgeBaseConfiguration' => [
            'embeddingModelArn' => '<string>', // REQUIRED
            'embeddingModelConfiguration' => [
                'bedrockEmbeddingModelConfiguration' => [
                    'dimensions' => <integer>,
                ],
            ],
        ],
    ],
    'knowledgeBaseId' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'roleArn' => '<string>', // REQUIRED
    'storageConfiguration' => [ // REQUIRED
        'mongoDbAtlasConfiguration' => [
            'collectionName' => '<string>', // REQUIRED
            'credentialsSecretArn' => '<string>', // REQUIRED
            'databaseName' => '<string>', // REQUIRED
            'endpoint' => '<string>', // REQUIRED
            'endpointServiceName' => '<string>',
            'fieldMapping' => [ // REQUIRED
                'metadataField' => '<string>', // REQUIRED
                'textField' => '<string>', // REQUIRED
                'vectorField' => '<string>', // REQUIRED
            ],
            'vectorIndexName' => '<string>', // REQUIRED
        ],
        'opensearchServerlessConfiguration' => [
            'collectionArn' => '<string>', // REQUIRED
            'fieldMapping' => [ // REQUIRED
                'metadataField' => '<string>', // REQUIRED
                'textField' => '<string>', // REQUIRED
                'vectorField' => '<string>', // REQUIRED
            ],
            'vectorIndexName' => '<string>', // REQUIRED
        ],
        'pineconeConfiguration' => [
            'connectionString' => '<string>', // REQUIRED
            'credentialsSecretArn' => '<string>', // REQUIRED
            'fieldMapping' => [ // REQUIRED
                'metadataField' => '<string>', // REQUIRED
                'textField' => '<string>', // REQUIRED
            ],
            'namespace' => '<string>',
        ],
        'rdsConfiguration' => [
            'credentialsSecretArn' => '<string>', // REQUIRED
            'databaseName' => '<string>', // REQUIRED
            'fieldMapping' => [ // REQUIRED
                'metadataField' => '<string>', // REQUIRED
                'primaryKeyField' => '<string>', // REQUIRED
                'textField' => '<string>', // REQUIRED
                'vectorField' => '<string>', // REQUIRED
            ],
            'resourceArn' => '<string>', // REQUIRED
            'tableName' => '<string>', // REQUIRED
        ],
        'redisEnterpriseCloudConfiguration' => [
            'credentialsSecretArn' => '<string>', // REQUIRED
            'endpoint' => '<string>', // REQUIRED
            'fieldMapping' => [ // REQUIRED
                'metadataField' => '<string>', // REQUIRED
                'textField' => '<string>', // REQUIRED
                'vectorField' => '<string>', // REQUIRED
            ],
            'vectorIndexName' => '<string>', // REQUIRED
        ],
        'type' => 'OPENSEARCH_SERVERLESS|PINECONE|REDIS_ENTERPRISE_CLOUD|RDS|MONGO_DB_ATLAS', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'knowledgeBase' => [
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'failureReasons' => ['<string>', ...],
        'knowledgeBaseArn' => '<string>',
        'knowledgeBaseConfiguration' => [
            'type' => 'VECTOR',
            'vectorKnowledgeBaseConfiguration' => [
                'embeddingModelArn' => '<string>',
                'embeddingModelConfiguration' => [
                    'bedrockEmbeddingModelConfiguration' => [
                        'dimensions' => <integer>,
                    ],
                ],
            ],
        ],
        'knowledgeBaseId' => '<string>',
        'name' => '<string>',
        'roleArn' => '<string>',
        'status' => 'CREATING|ACTIVE|DELETING|UPDATING|FAILED|DELETE_UNSUCCESSFUL',
        'storageConfiguration' => [
            'mongoDbAtlasConfiguration' => [
                'collectionName' => '<string>',
                'credentialsSecretArn' => '<string>',
                'databaseName' => '<string>',
                'endpoint' => '<string>',
                'endpointServiceName' => '<string>',
                'fieldMapping' => [
                    'metadataField' => '<string>',
                    'textField' => '<string>',
                    'vectorField' => '<string>',
                ],
                'vectorIndexName' => '<string>',
            ],
            'opensearchServerlessConfiguration' => [
                'collectionArn' => '<string>',
                'fieldMapping' => [
                    'metadataField' => '<string>',
                    'textField' => '<string>',
                    'vectorField' => '<string>',
                ],
                'vectorIndexName' => '<string>',
            ],
            'pineconeConfiguration' => [
                'connectionString' => '<string>',
                'credentialsSecretArn' => '<string>',
                'fieldMapping' => [
                    'metadataField' => '<string>',
                    'textField' => '<string>',
                ],
                'namespace' => '<string>',
            ],
            'rdsConfiguration' => [
                'credentialsSecretArn' => '<string>',
                'databaseName' => '<string>',
                'fieldMapping' => [
                    'metadataField' => '<string>',
                    'primaryKeyField' => '<string>',
                    'textField' => '<string>',
                    'vectorField' => '<string>',
                ],
                'resourceArn' => '<string>',
                'tableName' => '<string>',
            ],
            'redisEnterpriseCloudConfiguration' => [
                'credentialsSecretArn' => '<string>',
                'endpoint' => '<string>',
                'fieldMapping' => [
                    'metadataField' => '<string>',
                    'textField' => '<string>',
                    'vectorField' => '<string>',
                ],
                'vectorIndexName' => '<string>',
            ],
            'type' => 'OPENSEARCH_SERVERLESS|PINECONE|REDIS_ENTERPRISE_CLOUD|RDS|MONGO_DB_ATLAS',
        ],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ConflictException:

There was a conflict performing an operation.