AssociateAgentCollaborator

$result = $client->associateAgentCollaborator([/* ... */]);
$promise = $client->associateAgentCollaboratorAsync([/* ... */]);

Makes an agent a collaborator for another agent.

Parameter Syntax

$result = $client->associateAgentCollaborator([
    'agentDescriptor' => [ // REQUIRED
        'aliasArn' => '<string>',
    ],
    'agentId' => '<string>', // REQUIRED
    'agentVersion' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'collaborationInstruction' => '<string>', // REQUIRED
    'collaboratorName' => '<string>', // REQUIRED
    'relayConversationHistory' => 'TO_COLLABORATOR|DISABLED',
]);

Parameter Details

Result Syntax

[
    'agentCollaborator' => [
        'agentDescriptor' => [
            'aliasArn' => '<string>',
        ],
        'agentId' => '<string>',
        'agentVersion' => '<string>',
        'clientToken' => '<string>',
        'collaborationInstruction' => '<string>',
        'collaboratorId' => '<string>',
        'collaboratorName' => '<string>',
        'createdAt' => <DateTime>,
        'lastUpdatedAt' => <DateTime>,
        'relayConversationHistory' => 'TO_COLLABORATOR|DISABLED',
    ],
]

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.

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 enable your agent to retain conversational context across multiple sessions, include a memoryConfiguration object. For more information, see Configure memory.

• To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts.

• If your agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.

• The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.

Parameter Syntax

$result = $client->createAgent([
    'agentCollaboration' => 'SUPERVISOR|SUPERVISOR_ROUTER|DISABLED',
    'agentName' => '<string>', // REQUIRED
    'agentResourceRoleArn' => '<string>',
    'clientToken' => '<string>',
    'customOrchestration' => [
        'executor' => [
            'lambda' => '<string>',
        ],
    ],
    'customerEncryptionKeyArn' => '<string>',
    'description' => '<string>',
    'foundationModel' => '<string>',
    'guardrailConfiguration' => [
        'guardrailIdentifier' => '<string>',
        'guardrailVersion' => '<string>',
    ],
    'idleSessionTTLInSeconds' => <integer>,
    'instruction' => '<string>',
    'memoryConfiguration' => [
        'enabledMemoryTypes' => ['<string>', ...], // REQUIRED
        'storageDays' => <integer>,
    ],
    'orchestrationType' => 'DEFAULT|CUSTOM_ORCHESTRATION',
    'promptOverrideConfiguration' => [
        'overrideLambda' => '<string>',
        'promptConfigurations' => [ // REQUIRED
            [
                'basePromptTemplate' => '<string>',
                'foundationModel' => '<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>',
        'agentCollaboration' => 'SUPERVISOR|SUPERVISOR_ROUTER|DISABLED',
        'agentId' => '<string>',
        'agentName' => '<string>',
        'agentResourceRoleArn' => '<string>',
        'agentStatus' => 'CREATING|PREPARING|PREPARED|NOT_PREPARED|DELETING|FAILED|VERSIONING|UPDATING',
        'agentVersion' => '<string>',
        'clientToken' => '<string>',
        'createdAt' => <DateTime>,
        'customOrchestration' => [
            'executor' => [
                'lambda' => '<string>',
            ],
        ],
        'customerEncryptionKeyArn' => '<string>',
        'description' => '<string>',
        'failureReasons' => ['<string>', ...],
        'foundationModel' => '<string>',
        'guardrailConfiguration' => [
            'guardrailIdentifier' => '<string>',
            'guardrailVersion' => '<string>',
        ],
        'idleSessionTTLInSeconds' => <integer>,
        'instruction' => '<string>',
        'memoryConfiguration' => [
            'enabledMemoryTypes' => ['<string>', ...],
            'storageDays' => <integer>,
        ],
        'orchestrationType' => 'DEFAULT|CUSTOM_ORCHESTRATION',
        'preparedAt' => <DateTime>,
        'promptOverrideConfiguration' => [
            'overrideLambda' => '<string>',
            'promptConfigurations' => [
                [
                    'basePromptTemplate' => '<string>',
                    'foundationModel' => '<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.

To allow your agent to generate, run, and troubleshoot code when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.CodeInterpreter.

You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

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
                    ],
                    // ...
                ],
                'requireConfirmation' => 'ENABLED|DISABLED',
            ],
            // ...
        ],
    ],
    'parentActionGroupSignature' => 'AMAZON.UserInput|AMAZON.CodeInterpreter',
]);

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',
                        ],
                        // ...
                    ],
                    'requireConfirmation' => 'ENABLED|DISABLED',
                ],
                // ...
            ],
        ],
        'parentActionSignature' => 'AMAZON.UserInput|AMAZON.CodeInterpreter',
        '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([/* ... */]);

Connects a knowledge base to a data source. You specify the configuration for the specific data source service in the dataSourceConfiguration field.

Parameter Syntax

$result = $client->createDataSource([
    'clientToken' => '<string>',
    'dataDeletionPolicy' => 'RETAIN|DELETE',
    'dataSourceConfiguration' => [ // REQUIRED
        'confluenceConfiguration' => [
            'crawlerConfiguration' => [
                'filterConfiguration' => [
                    'patternObjectFilter' => [
                        'filters' => [ // REQUIRED
                            [
                                'exclusionFilters' => ['<string>', ...],
                                'inclusionFilters' => ['<string>', ...],
                                'objectType' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                    'type' => 'PATTERN', // REQUIRED
                ],
            ],
            'sourceConfiguration' => [ // REQUIRED
                'authType' => 'BASIC|OAUTH2_CLIENT_CREDENTIALS', // REQUIRED
                'credentialsSecretArn' => '<string>', // REQUIRED
                'hostType' => 'SAAS', // REQUIRED
                'hostUrl' => '<string>', // REQUIRED
            ],
        ],
        's3Configuration' => [
            'bucketArn' => '<string>', // REQUIRED
            'bucketOwnerAccountId' => '<string>',
            'inclusionPrefixes' => ['<string>', ...],
        ],
        'salesforceConfiguration' => [
            'crawlerConfiguration' => [
                'filterConfiguration' => [
                    'patternObjectFilter' => [
                        'filters' => [ // REQUIRED
                            [
                                'exclusionFilters' => ['<string>', ...],
                                'inclusionFilters' => ['<string>', ...],
                                'objectType' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                    'type' => 'PATTERN', // REQUIRED
                ],
            ],
            'sourceConfiguration' => [ // REQUIRED
                'authType' => 'OAUTH2_CLIENT_CREDENTIALS', // REQUIRED
                'credentialsSecretArn' => '<string>', // REQUIRED
                'hostUrl' => '<string>', // REQUIRED
            ],
        ],
        'sharePointConfiguration' => [
            'crawlerConfiguration' => [
                'filterConfiguration' => [
                    'patternObjectFilter' => [
                        'filters' => [ // REQUIRED
                            [
                                'exclusionFilters' => ['<string>', ...],
                                'inclusionFilters' => ['<string>', ...],
                                'objectType' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                    'type' => 'PATTERN', // REQUIRED
                ],
            ],
            'sourceConfiguration' => [ // REQUIRED
                'authType' => 'OAUTH2_CLIENT_CREDENTIALS', // REQUIRED
                'credentialsSecretArn' => '<string>', // REQUIRED
                'domain' => '<string>', // REQUIRED
                'hostType' => 'ONLINE', // REQUIRED
                'siteUrls' => ['<string>', ...], // REQUIRED
                'tenantId' => '<string>',
            ],
        ],
        'type' => 'S3|WEB|CONFLUENCE|SALESFORCE|SHAREPOINT|CUSTOM|REDSHIFT_METADATA', // REQUIRED
        'webConfiguration' => [
            'crawlerConfiguration' => [
                'crawlerLimits' => [
                    'rateLimit' => <integer>,
                ],
                'exclusionFilters' => ['<string>', ...],
                'inclusionFilters' => ['<string>', ...],
                'scope' => 'HOST_ONLY|SUBDOMAINS',
            ],
            'sourceConfiguration' => [ // REQUIRED
                'urlConfiguration' => [ // REQUIRED
                    'seedUrls' => [
                        [
                            'url' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
        ],
    ],
    'description' => '<string>',
    'knowledgeBaseId' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'serverSideEncryptionConfiguration' => [
        'kmsKeyArn' => '<string>',
    ],
    'vectorIngestionConfiguration' => [
        'chunkingConfiguration' => [
            'chunkingStrategy' => 'FIXED_SIZE|NONE|HIERARCHICAL|SEMANTIC', // REQUIRED
            'fixedSizeChunkingConfiguration' => [
                'maxTokens' => <integer>, // REQUIRED
                'overlapPercentage' => <integer>, // REQUIRED
            ],
            'hierarchicalChunkingConfiguration' => [
                'levelConfigurations' => [ // REQUIRED
                    [
                        'maxTokens' => <integer>, // REQUIRED
                    ],
                    // ...
                ],
                'overlapTokens' => <integer>, // REQUIRED
            ],
            'semanticChunkingConfiguration' => [
                'breakpointPercentileThreshold' => <integer>, // REQUIRED
                'bufferSize' => <integer>, // REQUIRED
                'maxTokens' => <integer>, // REQUIRED
            ],
        ],
        'customTransformationConfiguration' => [
            'intermediateStorage' => [ // REQUIRED
                's3Location' => [ // REQUIRED
                    'uri' => '<string>', // REQUIRED
                ],
            ],
            'transformations' => [ // REQUIRED
                [
                    'stepToApply' => 'POST_CHUNKING', // REQUIRED
                    'transformationFunction' => [ // REQUIRED
                        'transformationLambdaConfiguration' => [ // REQUIRED
                            'lambdaArn' => '<string>', // REQUIRED
                        ],
                    ],
                ],
                // ...
            ],
        ],
        'parsingConfiguration' => [
            'bedrockDataAutomationConfiguration' => [
                'parsingModality' => 'MULTIMODAL',
            ],
            'bedrockFoundationModelConfiguration' => [
                'modelArn' => '<string>', // REQUIRED
                'parsingModality' => 'MULTIMODAL',
                'parsingPrompt' => [
                    'parsingPromptText' => '<string>', // REQUIRED
                ],
            ],
            'parsingStrategy' => 'BEDROCK_FOUNDATION_MODEL|BEDROCK_DATA_AUTOMATION', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'dataSource' => [
        'createdAt' => <DateTime>,
        'dataDeletionPolicy' => 'RETAIN|DELETE',
        'dataSourceConfiguration' => [
            'confluenceConfiguration' => [
                'crawlerConfiguration' => [
                    'filterConfiguration' => [
                        'patternObjectFilter' => [
                            'filters' => [
                                [
                                    'exclusionFilters' => ['<string>', ...],
                                    'inclusionFilters' => ['<string>', ...],
                                    'objectType' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'type' => 'PATTERN',
                    ],
                ],
                'sourceConfiguration' => [
                    'authType' => 'BASIC|OAUTH2_CLIENT_CREDENTIALS',
                    'credentialsSecretArn' => '<string>',
                    'hostType' => 'SAAS',
                    'hostUrl' => '<string>',
                ],
            ],
            's3Configuration' => [
                'bucketArn' => '<string>',
                'bucketOwnerAccountId' => '<string>',
                'inclusionPrefixes' => ['<string>', ...],
            ],
            'salesforceConfiguration' => [
                'crawlerConfiguration' => [
                    'filterConfiguration' => [
                        'patternObjectFilter' => [
                            'filters' => [
                                [
                                    'exclusionFilters' => ['<string>', ...],
                                    'inclusionFilters' => ['<string>', ...],
                                    'objectType' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'type' => 'PATTERN',
                    ],
                ],
                'sourceConfiguration' => [
                    'authType' => 'OAUTH2_CLIENT_CREDENTIALS',
                    'credentialsSecretArn' => '<string>',
                    'hostUrl' => '<string>',
                ],
            ],
            'sharePointConfiguration' => [
                'crawlerConfiguration' => [
                    'filterConfiguration' => [
                        'patternObjectFilter' => [
                            'filters' => [
                                [
                                    'exclusionFilters' => ['<string>', ...],
                                    'inclusionFilters' => ['<string>', ...],
                                    'objectType' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'type' => 'PATTERN',
                    ],
                ],
                'sourceConfiguration' => [
                    'authType' => 'OAUTH2_CLIENT_CREDENTIALS',
                    'credentialsSecretArn' => '<string>',
                    'domain' => '<string>',
                    'hostType' => 'ONLINE',
                    'siteUrls' => ['<string>', ...],
                    'tenantId' => '<string>',
                ],
            ],
            'type' => 'S3|WEB|CONFLUENCE|SALESFORCE|SHAREPOINT|CUSTOM|REDSHIFT_METADATA',
            'webConfiguration' => [
                'crawlerConfiguration' => [
                    'crawlerLimits' => [
                        'rateLimit' => <integer>,
                    ],
                    'exclusionFilters' => ['<string>', ...],
                    'inclusionFilters' => ['<string>', ...],
                    'scope' => 'HOST_ONLY|SUBDOMAINS',
                ],
                'sourceConfiguration' => [
                    'urlConfiguration' => [
                        'seedUrls' => [
                            [
                                'url' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
            ],
        ],
        '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|HIERARCHICAL|SEMANTIC',
                'fixedSizeChunkingConfiguration' => [
                    'maxTokens' => <integer>,
                    'overlapPercentage' => <integer>,
                ],
                'hierarchicalChunkingConfiguration' => [
                    'levelConfigurations' => [
                        [
                            'maxTokens' => <integer>,
                        ],
                        // ...
                    ],
                    'overlapTokens' => <integer>,
                ],
                'semanticChunkingConfiguration' => [
                    'breakpointPercentileThreshold' => <integer>,
                    'bufferSize' => <integer>,
                    'maxTokens' => <integer>,
                ],
            ],
            'customTransformationConfiguration' => [
                'intermediateStorage' => [
                    's3Location' => [
                        'uri' => '<string>',
                    ],
                ],
                'transformations' => [
                    [
                        'stepToApply' => 'POST_CHUNKING',
                        'transformationFunction' => [
                            'transformationLambdaConfiguration' => [
                                'lambdaArn' => '<string>',
                            ],
                        ],
                    ],
                    // ...
                ],
            ],
            'parsingConfiguration' => [
                'bedrockDataAutomationConfiguration' => [
                    'parsingModality' => 'MULTIMODAL',
                ],
                'bedrockFoundationModelConfiguration' => [
                    'modelArn' => '<string>',
                    'parsingModality' => 'MULTIMODAL',
                    'parsingPrompt' => [
                        'parsingPromptText' => '<string>',
                    ],
                ],
                'parsingStrategy' => 'BEDROCK_FOUNDATION_MODEL|BEDROCK_DATA_AUTOMATION',
            ],
        ],
    ],
]

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.

CreateFlow

$result = $client->createFlow([/* ... */]);
$promise = $client->createFlowAsync([/* ... */]);

Creates a prompt flow that you can use to send an input through various steps to yield an output. Configure nodes, each of which corresponds to a step of the flow, and create connections between the nodes to create paths to different outputs. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->createFlow([
    'clientToken' => '<string>',
    'customerEncryptionKeyArn' => '<string>',
    'definition' => [
        'connections' => [
            [
                'configuration' => [
                    'conditional' => [
                        'condition' => '<string>', // REQUIRED
                    ],
                    'data' => [
                        'sourceOutput' => '<string>', // REQUIRED
                        'targetInput' => '<string>', // REQUIRED
                    ],
                ],
                'name' => '<string>', // REQUIRED
                'source' => '<string>', // REQUIRED
                'target' => '<string>', // REQUIRED
                'type' => 'Data|Conditional', // REQUIRED
            ],
            // ...
        ],
        'nodes' => [
            [
                'configuration' => [
                    'agent' => [
                        'agentAliasArn' => '<string>', // REQUIRED
                    ],
                    'collector' => [
                    ],
                    'condition' => [
                        'conditions' => [ // REQUIRED
                            [
                                'expression' => '<string>',
                                'name' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                    'input' => [
                    ],
                    'iterator' => [
                    ],
                    'knowledgeBase' => [
                        'guardrailConfiguration' => [
                            'guardrailIdentifier' => '<string>',
                            'guardrailVersion' => '<string>',
                        ],
                        'knowledgeBaseId' => '<string>', // REQUIRED
                        'modelId' => '<string>',
                    ],
                    'lambdaFunction' => [
                        'lambdaArn' => '<string>', // REQUIRED
                    ],
                    'lex' => [
                        'botAliasArn' => '<string>', // REQUIRED
                        'localeId' => '<string>', // REQUIRED
                    ],
                    'output' => [
                    ],
                    'prompt' => [
                        'guardrailConfiguration' => [
                            'guardrailIdentifier' => '<string>',
                            'guardrailVersion' => '<string>',
                        ],
                        'sourceConfiguration' => [ // REQUIRED
                            'inline' => [
                                'additionalModelRequestFields' => [
                                ],
                                'inferenceConfiguration' => [
                                    'text' => [
                                        'maxTokens' => <integer>,
                                        'stopSequences' => ['<string>', ...],
                                        'temperature' => <float>,
                                        'topP' => <float>,
                                    ],
                                ],
                                'modelId' => '<string>', // REQUIRED
                                'templateConfiguration' => [ // REQUIRED
                                    'chat' => [
                                        'inputVariables' => [
                                            [
                                                'name' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'messages' => [ // REQUIRED
                                            [
                                                'content' => [ // REQUIRED
                                                    [
                                                        'text' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                                'role' => 'user|assistant', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                        'system' => [
                                            [
                                                'text' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'toolConfiguration' => [
                                            'toolChoice' => [
                                                'any' => [
                                                ],
                                                'auto' => [
                                                ],
                                                'tool' => [
                                                    'name' => '<string>', // REQUIRED
                                                ],
                                            ],
                                            'tools' => [ // REQUIRED
                                                [
                                                    'toolSpec' => [
                                                        'description' => '<string>',
                                                        'inputSchema' => [ // REQUIRED
                                                            'json' => [
                                                            ],
                                                        ],
                                                        'name' => '<string>', // REQUIRED
                                                    ],
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'text' => [
                                        'inputVariables' => [
                                            [
                                                'name' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'text' => '<string>', // REQUIRED
                                    ],
                                ],
                                'templateType' => 'TEXT|CHAT', // REQUIRED
                            ],
                            'resource' => [
                                'promptArn' => '<string>', // REQUIRED
                            ],
                        ],
                    ],
                    'retrieval' => [
                        'serviceConfiguration' => [ // REQUIRED
                            's3' => [
                                'bucketName' => '<string>', // REQUIRED
                            ],
                        ],
                    ],
                    'storage' => [
                        'serviceConfiguration' => [ // REQUIRED
                            's3' => [
                                'bucketName' => '<string>', // REQUIRED
                            ],
                        ],
                    ],
                ],
                'inputs' => [
                    [
                        'expression' => '<string>', // REQUIRED
                        'name' => '<string>', // REQUIRED
                        'type' => 'String|Number|Boolean|Object|Array', // REQUIRED
                    ],
                    // ...
                ],
                'name' => '<string>', // REQUIRED
                'outputs' => [
                    [
                        'name' => '<string>', // REQUIRED
                        'type' => 'String|Number|Boolean|Object|Array', // REQUIRED
                    ],
                    // ...
                ],
                'type' => 'Input|Output|KnowledgeBase|Condition|Lex|Prompt|LambdaFunction|Storage|Agent|Retrieval|Iterator|Collector', // REQUIRED
            ],
            // ...
        ],
    ],
    'description' => '<string>',
    'executionRoleArn' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'customerEncryptionKeyArn' => '<string>',
    'definition' => [
        'connections' => [
            [
                'configuration' => [
                    'conditional' => [
                        'condition' => '<string>',
                    ],
                    'data' => [
                        'sourceOutput' => '<string>',
                        'targetInput' => '<string>',
                    ],
                ],
                'name' => '<string>',
                'source' => '<string>',
                'target' => '<string>',
                'type' => 'Data|Conditional',
            ],
            // ...
        ],
        'nodes' => [
            [
                'configuration' => [
                    'agent' => [
                        'agentAliasArn' => '<string>',
                    ],
                    'collector' => [
                    ],
                    'condition' => [
                        'conditions' => [
                            [
                                'expression' => '<string>',
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'input' => [
                    ],
                    'iterator' => [
                    ],
                    'knowledgeBase' => [
                        'guardrailConfiguration' => [
                            'guardrailIdentifier' => '<string>',
                            'guardrailVersion' => '<string>',
                        ],
                        'knowledgeBaseId' => '<string>',
                        'modelId' => '<string>',
                    ],
                    'lambdaFunction' => [
                        'lambdaArn' => '<string>',
                    ],
                    'lex' => [
                        'botAliasArn' => '<string>',
                        'localeId' => '<string>',
                    ],
                    'output' => [
                    ],
                    'prompt' => [
                        'guardrailConfiguration' => [
                            'guardrailIdentifier' => '<string>',
                            'guardrailVersion' => '<string>',
                        ],
                        'sourceConfiguration' => [
                            'inline' => [
                                'additionalModelRequestFields' => [
                                ],
                                'inferenceConfiguration' => [
                                    'text' => [
                                        'maxTokens' => <integer>,
                                        'stopSequences' => ['<string>', ...],
                                        'temperature' => <float>,
                                        'topP' => <float>,
                                    ],
                                ],
                                'modelId' => '<string>',
                                'templateConfiguration' => [
                                    'chat' => [
                                        'inputVariables' => [
                                            [
                                                'name' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'messages' => [
                                            [
                                                'content' => [
                                                    [
                                                        'text' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                                'role' => 'user|assistant',
                                            ],
                                            // ...
                                        ],
                                        'system' => [
                                            [
                                                'text' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'toolConfiguration' => [
                                            'toolChoice' => [
                                                'any' => [
                                                ],
                                                'auto' => [
                                                ],
                                                'tool' => [
                                                    'name' => '<string>',
                                                ],
                                            ],
                                            'tools' => [
                                                [
                                                    'toolSpec' => [
                                                        'description' => '<string>',
                                                        'inputSchema' => [
                                                            'json' => [
                                                            ],
                                                        ],
                                                        'name' => '<string>',
                                                    ],
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'text' => [
                                        'inputVariables' => [
                                            [
                                                'name' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'text' => '<string>',
                                    ],
                                ],
                                'templateType' => 'TEXT|CHAT',
                            ],
                            'resource' => [
                                'promptArn' => '<string>',
                            ],
                        ],
                    ],
                    'retrieval' => [
                        'serviceConfiguration' => [
                            's3' => [
                                'bucketName' => '<string>',
                            ],
                        ],
                    ],
                    'storage' => [
                        'serviceConfiguration' => [
                            's3' => [
                                'bucketName' => '<string>',
                            ],
                        ],
                    ],
                ],
                'inputs' => [
                    [
                        'expression' => '<string>',
                        'name' => '<string>',
                        'type' => 'String|Number|Boolean|Object|Array',
                    ],
                    // ...
                ],
                'name' => '<string>',
                'outputs' => [
                    [
                        'name' => '<string>',
                        'type' => 'String|Number|Boolean|Object|Array',
                    ],
                    // ...
                ],
                'type' => 'Input|Output|KnowledgeBase|Condition|Lex|Prompt|LambdaFunction|Storage|Agent|Retrieval|Iterator|Collector',
            ],
            // ...
        ],
    ],
    'description' => '<string>',
    'executionRoleArn' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'status' => 'Failed|Prepared|Preparing|NotPrepared',
    '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.

ConflictException:

There was a conflict performing an operation.

ServiceQuotaExceededException:

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

CreateFlowAlias

$result = $client->createFlowAlias([/* ... */]);
$promise = $client->createFlowAliasAsync([/* ... */]);

Creates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->createFlowAlias([
    'clientToken' => '<string>',
    'description' => '<string>',
    'flowIdentifier' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'routingConfiguration' => [ // REQUIRED
        [
            'flowVersion' => '<string>',
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'flowId' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'routingConfiguration' => [
        [
            'flowVersion' => '<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.

CreateFlowVersion

$result = $client->createFlowVersion([/* ... */]);
$promise = $client->createFlowVersionAsync([/* ... */]);

Creates a version of the flow that you can deploy. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->createFlowVersion([
    'clientToken' => '<string>',
    'description' => '<string>',
    'flowIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'customerEncryptionKeyArn' => '<string>',
    'definition' => [
        'connections' => [
            [
                'configuration' => [
                    'conditional' => [
                        'condition' => '<string>',
                    ],
                    'data' => [
                        'sourceOutput' => '<string>',
                        'targetInput' => '<string>',
                    ],
                ],
                'name' => '<string>',
                'source' => '<string>',
                'target' => '<string>',
                'type' => 'Data|Conditional',
            ],
            // ...
        ],
        'nodes' => [
            [
                'configuration' => [
                    'agent' => [
                        'agentAliasArn' => '<string>',
                    ],
                    'collector' => [
                    ],
                    'condition' => [
                        'conditions' => [
                            [
                                'expression' => '<string>',
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'input' => [
                    ],
                    'iterator' => [
                    ],
                    'knowledgeBase' => [
                        'guardrailConfiguration' => [
                            'guardrailIdentifier' => '<string>',
                            'guardrailVersion' => '<string>',
                        ],
                        'knowledgeBaseId' => '<string>',
                        'modelId' => '<string>',
                    ],
                    'lambdaFunction' => [
                        'lambdaArn' => '<string>',
                    ],
                    'lex' => [
                        'botAliasArn' => '<string>',
                        'localeId' => '<string>',
                    ],
                    'output' => [
                    ],
                    'prompt' => [
                        'guardrailConfiguration' => [
                            'guardrailIdentifier' => '<string>',
                            'guardrailVersion' => '<string>',
                        ],
                        'sourceConfiguration' => [
                            'inline' => [
                                'additionalModelRequestFields' => [
                                ],
                                'inferenceConfiguration' => [
                                    'text' => [
                                        'maxTokens' => <integer>,
                                        'stopSequences' => ['<string>', ...],
                                        'temperature' => <float>,
                                        'topP' => <float>,
                                    ],
                                ],
                                'modelId' => '<string>',
                                'templateConfiguration' => [
                                    'chat' => [
                                        'inputVariables' => [
                                            [
                                                'name' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'messages' => [
                                            [
                                                'content' => [
                                                    [
                                                        'text' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                                'role' => 'user|assistant',
                                            ],
                                            // ...
                                        ],
                                        'system' => [
                                            [
                                                'text' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'toolConfiguration' => [
                                            'toolChoice' => [
                                                'any' => [
                                                ],
                                                'auto' => [
                                                ],
                                                'tool' => [
                                                    'name' => '<string>',
                                                ],
                                            ],
                                            'tools' => [
                                                [
                                                    'toolSpec' => [
                                                        'description' => '<string>',
                                                        'inputSchema' => [
                                                            'json' => [
                                                            ],
                                                        ],
                                                        'name' => '<string>',
                                                    ],
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'text' => [
                                        'inputVariables' => [
                                            [
                                                'name' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'text' => '<string>',
                                    ],
                                ],
                                'templateType' => 'TEXT|CHAT',
                            ],
                            'resource' => [
                                'promptArn' => '<string>',
                            ],
                        ],
                    ],
                    'retrieval' => [
                        'serviceConfiguration' => [
                            's3' => [
                                'bucketName' => '<string>',
                            ],
                        ],
                    ],
                    'storage' => [
                        'serviceConfiguration' => [
                            's3' => [
                                'bucketName' => '<string>',
                            ],
                        ],
                    ],
                ],
                'inputs' => [
                    [
                        'expression' => '<string>',
                        'name' => '<string>',
                        'type' => 'String|Number|Boolean|Object|Array',
                    ],
                    // ...
                ],
                'name' => '<string>',
                'outputs' => [
                    [
                        'name' => '<string>',
                        'type' => 'String|Number|Boolean|Object|Array',
                    ],
                    // ...
                ],
                'type' => 'Input|Output|KnowledgeBase|Condition|Lex|Prompt|LambdaFunction|Storage|Agent|Retrieval|Iterator|Collector',
            ],
            // ...
        ],
    ],
    'description' => '<string>',
    'executionRoleArn' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'status' => 'Failed|Prepared|Preparing|NotPrepared',
    '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.

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. A knowledge base contains your data sources so that Large Language Models (LLMs) can use your data. 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 a knowledge base.

• Provide the name and an optional description.

• Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn field.

• Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object.

• Provide the configuration for your vector store in the storageConfiguration object.

  • For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration object. For more information, see Create a vector store in Amazon OpenSearch Service.

  • For an Amazon Aurora database, use the RdsConfiguration object. For more information, see Create a vector store in Amazon Aurora.

  • For a Pinecone database, use the pineconeConfiguration object. For more information, see Create a vector store in Pinecone.

  • For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration object. For more information, see Create a vector store in Redis Enterprise Cloud.

Parameter Syntax

$result = $client->createKnowledgeBase([
    'clientToken' => '<string>',
    'description' => '<string>',
    'knowledgeBaseConfiguration' => [ // REQUIRED
        'kendraKnowledgeBaseConfiguration' => [
            'kendraIndexArn' => '<string>', // REQUIRED
        ],
        'sqlKnowledgeBaseConfiguration' => [
            'redshiftConfiguration' => [
                'queryEngineConfiguration' => [ // REQUIRED
                    'provisionedConfiguration' => [
                        'authConfiguration' => [ // REQUIRED
                            'databaseUser' => '<string>',
                            'type' => 'IAM|USERNAME_PASSWORD|USERNAME', // REQUIRED
                            'usernamePasswordSecretArn' => '<string>',
                        ],
                        'clusterIdentifier' => '<string>', // REQUIRED
                    ],
                    'serverlessConfiguration' => [
                        'authConfiguration' => [ // REQUIRED
                            'type' => 'IAM|USERNAME_PASSWORD', // REQUIRED
                            'usernamePasswordSecretArn' => '<string>',
                        ],
                        'workgroupArn' => '<string>', // REQUIRED
                    ],
                    'type' => 'SERVERLESS|PROVISIONED', // REQUIRED
                ],
                'queryGenerationConfiguration' => [
                    'executionTimeoutSeconds' => <integer>,
                    'generationContext' => [
                        'curatedQueries' => [
                            [
                                'naturalLanguage' => '<string>', // REQUIRED
                                'sql' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'tables' => [
                            [
                                'columns' => [
                                    [
                                        'description' => '<string>',
                                        'inclusion' => 'INCLUDE|EXCLUDE',
                                        'name' => '<string>',
                                    ],
                                    // ...
                                ],
                                'description' => '<string>',
                                'inclusion' => 'INCLUDE|EXCLUDE',
                                'name' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
                'storageConfigurations' => [ // REQUIRED
                    [
                        'awsDataCatalogConfiguration' => [
                            'tableNames' => ['<string>', ...], // REQUIRED
                        ],
                        'redshiftConfiguration' => [
                            'databaseName' => '<string>', // REQUIRED
                        ],
                        'type' => 'REDSHIFT|AWS_DATA_CATALOG', // REQUIRED
                    ],
                    // ...
                ],
            ],
            'type' => 'REDSHIFT', // REQUIRED
        ],
        'type' => 'VECTOR|KENDRA|SQL', // REQUIRED
        'vectorKnowledgeBaseConfiguration' => [
            'embeddingModelArn' => '<string>', // REQUIRED
            'embeddingModelConfiguration' => [
                'bedrockEmbeddingModelConfiguration' => [
                    'dimensions' => <integer>,
                    'embeddingDataType' => 'FLOAT32|BINARY',
                ],
            ],
            'supplementalDataStorageConfiguration' => [
                'storageLocations' => [ // REQUIRED
                    [
                        's3Location' => [
                            'uri' => '<string>', // REQUIRED
                        ],
                        'type' => 'S3', // REQUIRED
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'name' => '<string>', // REQUIRED
    'roleArn' => '<string>', // REQUIRED
    'storageConfiguration' => [
        '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' => [
            'kendraKnowledgeBaseConfiguration' => [
                'kendraIndexArn' => '<string>',
            ],
            'sqlKnowledgeBaseConfiguration' => [
                'redshiftConfiguration' => [
                    'queryEngineConfiguration' => [
                        'provisionedConfiguration' => [
                            'authConfiguration' => [
                                'databaseUser' => '<string>',
                                'type' => 'IAM|USERNAME_PASSWORD|USERNAME',
                                'usernamePasswordSecretArn' => '<string>',
                            ],
                            'clusterIdentifier' => '<string>',
                        ],
                        'serverlessConfiguration' => [
                            'authConfiguration' => [
                                'type' => 'IAM|USERNAME_PASSWORD',
                                'usernamePasswordSecretArn' => '<string>',
                            ],
                            'workgroupArn' => '<string>',
                        ],
                        'type' => 'SERVERLESS|PROVISIONED',
                    ],
                    'queryGenerationConfiguration' => [
                        'executionTimeoutSeconds' => <integer>,
                        'generationContext' => [
                            'curatedQueries' => [
                                [
                                    'naturalLanguage' => '<string>',
                                    'sql' => '<string>',
                                ],
                                // ...
                            ],
                            'tables' => [
                                [
                                    'columns' => [
                                        [
                                            'description' => '<string>',
                                            'inclusion' => 'INCLUDE|EXCLUDE',
                                            'name' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'description' => '<string>',
                                    'inclusion' => 'INCLUDE|EXCLUDE',
                                    'name' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'storageConfigurations' => [
                        [
                            'awsDataCatalogConfiguration' => [
                                'tableNames' => ['<string>', ...],
                            ],
                            'redshiftConfiguration' => [
                                'databaseName' => '<string>',
                            ],
                            'type' => 'REDSHIFT|AWS_DATA_CATALOG',
                        ],
                        // ...
                    ],
                ],
                'type' => 'REDSHIFT',
            ],
            'type' => 'VECTOR|KENDRA|SQL',
            'vectorKnowledgeBaseConfiguration' => [
                'embeddingModelArn' => '<string>',
                'embeddingModelConfiguration' => [
                    'bedrockEmbeddingModelConfiguration' => [
                        'dimensions' => <integer>,
                        'embeddingDataType' => 'FLOAT32|BINARY',
                    ],
                ],
                'supplementalDataStorageConfiguration' => [
                    'storageLocations' => [
                        [
                            's3Location' => [
                                'uri' => '<string>',
                            ],
                            'type' => 'S3',
                        ],
                        // ...
                    ],
                ],
            ],
        ],
        '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.

CreatePrompt

$result = $client->createPrompt([/* ... */]);
$promise = $client->createPromptAsync([/* ... */]);

Creates a prompt in your prompt library that you can add to a flow. For more information, see Prompt management in Amazon Bedrock, Create a prompt using Prompt management and Prompt flows in Amazon Bedrock in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->createPrompt([
    'clientToken' => '<string>',
    'customerEncryptionKeyArn' => '<string>',
    'defaultVariant' => '<string>',
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'variants' => [
        [
            'additionalModelRequestFields' => [
            ],
            'genAiResource' => [
                'agent' => [
                    'agentIdentifier' => '<string>', // REQUIRED
                ],
            ],
            'inferenceConfiguration' => [
                'text' => [
                    'maxTokens' => <integer>,
                    'stopSequences' => ['<string>', ...],
                    'temperature' => <float>,
                    'topP' => <float>,
                ],
            ],
            'metadata' => [
                [
                    'key' => '<string>', // REQUIRED
                    'value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'modelId' => '<string>',
            'name' => '<string>', // REQUIRED
            'templateConfiguration' => [ // REQUIRED
                'chat' => [
                    'inputVariables' => [
                        [
                            'name' => '<string>',
                        ],
                        // ...
                    ],
                    'messages' => [ // REQUIRED
                        [
                            'content' => [ // REQUIRED
                                [
                                    'text' => '<string>',
                                ],
                                // ...
                            ],
                            'role' => 'user|assistant', // REQUIRED
                        ],
                        // ...
                    ],
                    'system' => [
                        [
                            'text' => '<string>',
                        ],
                        // ...
                    ],
                    'toolConfiguration' => [
                        'toolChoice' => [
                            'any' => [
                            ],
                            'auto' => [
                            ],
                            'tool' => [
                                'name' => '<string>', // REQUIRED
                            ],
                        ],
                        'tools' => [ // REQUIRED
                            [
                                'toolSpec' => [
                                    'description' => '<string>',
                                    'inputSchema' => [ // REQUIRED
                                        'json' => [
                                        ],
                                    ],
                                    'name' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                ],
                'text' => [
                    'inputVariables' => [
                        [
                            'name' => '<string>',
                        ],
                        // ...
                    ],
                    'text' => '<string>', // REQUIRED
                ],
            ],
            'templateType' => 'TEXT|CHAT', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'customerEncryptionKeyArn' => '<string>',
    'defaultVariant' => '<string>',
    'description' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'updatedAt' => <DateTime>,
    'variants' => [
        [
            'additionalModelRequestFields' => [
            ],
            'genAiResource' => [
                'agent' => [
                    'agentIdentifier' => '<string>',
                ],
            ],
            'inferenceConfiguration' => [
                'text' => [
                    'maxTokens' => <integer>,
                    'stopSequences' => ['<string>', ...],
                    'temperature' => <float>,
                    'topP' => <float>,
                ],
            ],
            'metadata' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'modelId' => '<string>',
            'name' => '<string>',
            'templateConfiguration' => [
                'chat' => [
                    'inputVariables' => [
                        [
                            'name' => '<string>',
                        ],
                        // ...
                    ],
                    'messages' => [
                        [
                            'content' => [
                                [
                                    'text' => '<string>',
                                ],
                                // ...
                            ],
                            'role' => 'user|assistant',
                        ],
                        // ...
                    ],
                    'system' => [
                        [
                            'text' => '<string>',
                        ],
                        // ...
                    ],
                    'toolConfiguration' => [
                        'toolChoice' => [
                            'any' => [
                            ],
                            'auto' => [
                            ],
                            'tool' => [
                                'name' => '<string>',
                            ],
                        ],
                        'tools' => [
                            [
                                'toolSpec' => [
                                    'description' => '<string>',
                                    'inputSchema' => [
                                        'json' => [
                                        ],
                                    ],
                                    'name' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                ],
                'text' => [
                    'inputVariables' => [
                        [
                            'name' => '<string>',
                        ],
                        // ...
                    ],
                    'text' => '<string>',
                ],
            ],
            'templateType' => 'TEXT|CHAT',
        ],
        // ...
    ],
    '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.

ConflictException:

There was a conflict performing an operation.

ServiceQuotaExceededException:

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

CreatePromptVersion

$result = $client->createPromptVersion([/* ... */]);
$promise = $client->createPromptVersionAsync([/* ... */]);

Creates a static snapshot of your prompt that can be deployed to production. For more information, see Deploy prompts using Prompt management by creating versions in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->createPromptVersion([
    'clientToken' => '<string>',
    'description' => '<string>',
    'promptIdentifier' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'customerEncryptionKeyArn' => '<string>',
    'defaultVariant' => '<string>',
    'description' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'updatedAt' => <DateTime>,
    'variants' => [
        [
            'additionalModelRequestFields' => [
            ],
            'genAiResource' => [
                'agent' => [
                    'agentIdentifier' => '<string>',
                ],
            ],
            'inferenceConfiguration' => [
                'text' => [
                    'maxTokens' => <integer>,
                    'stopSequences' => ['<string>', ...],
                    'temperature' => <float>,
                    'topP' => <float>,
                ],
            ],
            'metadata' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'modelId' => '<string>',
            'name' => '<string>',
            'templateConfiguration' => [
                'chat' => [
                    'inputVariables' => [
                        [
                            'name' => '<string>',
                        ],
                        // ...
                    ],
                    'messages' => [
                        [
                            'content' => [
                                [
                                    'text' => '<string>',
                                ],
                                // ...
                            ],
                            'role' => 'user|assistant',
                        ],
                        // ...
                    ],
                    'system' => [
                        [
                            'text' => '<string>',
                        ],
                        // ...
                    ],
                    'toolConfiguration' => [
                        'toolChoice' => [
                            'any' => [
                            ],
                            'auto' => [
                            ],
                            'tool' => [
                                'name' => '<string>',
                            ],
                        ],
                        'tools' => [
                            [
                                'toolSpec' => [
                                    'description' => '<string>',
                                    'inputSchema' => [
                                        'json' => [
                                        ],
                                    ],
                                    'name' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                ],
                'text' => [
                    'inputVariables' => [
                        [
                            'name' => '<string>',
                        ],
                        // ...
                    ],
                    'text' => '<string>',
                ],
            ],
            'templateType' => 'TEXT|CHAT',
        ],
        // ...
    ],
    '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.

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.

DeleteFlow

$result = $client->deleteFlow([/* ... */]);
$promise = $client->deleteFlowAsync([/* ... */]);

Deletes a flow.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'id' => '<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.

DeleteFlowAlias

$result = $client->deleteFlowAlias([/* ... */]);
$promise = $client->deleteFlowAliasAsync([/* ... */]);

Deletes an alias of a flow.

Parameter Syntax

$result = $client->deleteFlowAlias([
    'aliasIdentifier' => '<string>', // REQUIRED
    'flowIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'flowId' => '<string>',
    'id' => '<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.

DeleteFlowVersion

$result = $client->deleteFlowVersion([/* ... */]);
$promise = $client->deleteFlowVersionAsync([/* ... */]);

Deletes a version of a flow.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'id' => '<string>',
    '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.

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.

DeleteKnowledgeBaseDocuments

$result = $client->deleteKnowledgeBaseDocuments([/* ... */]);
$promise = $client->deleteKnowledgeBaseDocumentsAsync([/* ... */]);

Deletes documents from a data source and syncs the changes to the knowledge base that is connected to it. For more information, see Ingest documents into a knowledge base in real-time in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->deleteKnowledgeBaseDocuments([
    'clientToken' => '<string>',
    'dataSourceId' => '<string>', // REQUIRED
    'documentIdentifiers' => [ // REQUIRED
        [
            'custom' => [
                'id' => '<string>', // REQUIRED
            ],
            'dataSourceType' => 'CUSTOM|S3', // REQUIRED
            's3' => [
                'uri' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'knowledgeBaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'documentDetails' => [
        [
            'dataSourceId' => '<string>',
            'identifier' => [
                'custom' => [
                    'id' => '<string>',
                ],
                'dataSourceType' => 'CUSTOM|S3',
                's3' => [
                    'uri' => '<string>',
                ],
            ],
            'knowledgeBaseId' => '<string>',
            'status' => 'INDEXED|PARTIALLY_INDEXED|PENDING|FAILED|METADATA_PARTIALLY_INDEXED|METADATA_UPDATE_FAILED|IGNORED|NOT_FOUND|STARTING|IN_PROGRESS|DELETING|DELETE_IN_PROGRESS',
            'statusReason' => '<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.

ServiceQuotaExceededException:

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

DeletePrompt

$result = $client->deletePrompt([/* ... */]);
$promise = $client->deletePromptAsync([/* ... */]);

Deletes a prompt or a version of it, depending on whether you include the promptVersion field or not. For more information, see Delete prompts from the Prompt management tool and Delete a version of a prompt from the Prompt management tool in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->deletePrompt([
    'promptIdentifier' => '<string>', // REQUIRED
    'promptVersion' => '<string>',
]);

Parameter Details

Result Syntax

[
    'id' => '<string>',
    '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.

ConflictException:

There was a conflict performing an operation.

DisassociateAgentCollaborator

$result = $client->disassociateAgentCollaborator([/* ... */]);
$promise = $client->disassociateAgentCollaboratorAsync([/* ... */]);

Disassociates an agent collaborator.

Parameter Syntax

$result = $client->disassociateAgentCollaborator([
    'agentId' => '<string>', // REQUIRED
    'agentVersion' => '<string>', // REQUIRED
    'collaboratorId' => '<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.

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>',
        'agentCollaboration' => 'SUPERVISOR|SUPERVISOR_ROUTER|DISABLED',
        'agentId' => '<string>',
        'agentName' => '<string>',
        'agentResourceRoleArn' => '<string>',
        'agentStatus' => 'CREATING|PREPARING|PREPARED|NOT_PREPARED|DELETING|FAILED|VERSIONING|UPDATING',
        'agentVersion' => '<string>',
        'clientToken' => '<string>',
        'createdAt' => <DateTime>,
        'customOrchestration' => [
            'executor' => [
                'lambda' => '<string>',
            ],
        ],
        'customerEncryptionKeyArn' => '<string>',
        'description' => '<string>',
        'failureReasons' => ['<string>', ...],
        'foundationModel' => '<string>',
        'guardrailConfiguration' => [
            'guardrailIdentifier' => '<string>',
            'guardrailVersion' => '<string>',
        ],
        'idleSessionTTLInSeconds' => <integer>,
        'instruction' => '<string>',
        'memoryConfiguration' => [
            'enabledMemoryTypes' => ['<string>', ...],
            'storageDays' => <integer>,
        ],
        'orchestrationType' => 'DEFAULT|CUSTOM_ORCHESTRATION',
        'preparedAt' => <DateTime>,
        'promptOverrideConfiguration' => [
            'overrideLambda' => '<string>',
            'promptConfigurations' => [
                [
                    'basePromptTemplate' => '<string>',
                    'foundationModel' => '<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',
                        ],
                        // ...
                    ],
                    'requireConfirmation' => 'ENABLED|DISABLED',
                ],
                // ...
            ],
        ],
        'parentActionSignature' => 'AMAZON.UserInput|AMAZON.CodeInterpreter',
        '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.

GetAgentCollaborator

$result = $client->getAgentCollaborator([/* ... */]);
$promise = $client->getAgentCollaboratorAsync([/* ... */]);

Retrieves information about an agent's collaborator.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'agentCollaborator' => [
        'agentDescriptor' => [
            'aliasArn' => '<string>',
        ],
        'agentId' => '<string>',
        'agentVersion' => '<string>',
        'clientToken' => '<string>',
        'collaborationInstruction' => '<string>',
        'collaboratorId' => '<string>',
        'collaboratorName' => '<string>',
        'createdAt' => <DateTime>,
        'lastUpdatedAt' => <DateTime>,
        'relayConversationHistory' => 'TO_COLLABORATOR|DISABLED',
    ],
]

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>',
        'agentCollaboration' => 'SUPERVISOR|SUPERVISOR_ROUTER|DISABLED',
        '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>',
        'memoryConfiguration' => [
            'enabledMemoryTypes' => ['<string>', ...],
            'storageDays' => <integer>,
        ],
        'promptOverrideConfiguration' => [
            'overrideLambda' => '<string>',
            'promptConfigurations' => [
                [
                    'basePromptTemplate' => '<string>',
                    'foundationModel' => '<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' => [
            'confluenceConfiguration' => [
                'crawlerConfiguration' => [
                    'filterConfiguration' => [
                        'patternObjectFilter' => [
                            'filters' => [
                                [
                                    'exclusionFilters' => ['<string>', ...],
                                    'inclusionFilters' => ['<string>', ...],
                                    'objectType' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'type' => 'PATTERN',
                    ],
                ],
                'sourceConfiguration' => [
                    'authType' => 'BASIC|OAUTH2_CLIENT_CREDENTIALS',
                    'credentialsSecretArn' => '<string>',
                    'hostType' => 'SAAS',
                    'hostUrl' => '<string>',
                ],
            ],
            's3Configuration' => [
                'bucketArn' => '<string>',
                'bucketOwnerAccountId' => '<string>',
                'inclusionPrefixes' => ['<string>', ...],
            ],
            'salesforceConfiguration' => [
                'crawlerConfiguration' => [
                    'filterConfiguration' => [
                        'patternObjectFilter' => [
                            'filters' => [
                                [
                                    'exclusionFilters' => ['<string>', ...],
                                    'inclusionFilters' => ['<string>', ...],
                                    'objectType' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'type' => 'PATTERN',
                    ],
                ],
                'sourceConfiguration' => [
                    'authType' => 'OAUTH2_CLIENT_CREDENTIALS',
                    'credentialsSecretArn' => '<string>',
                    'hostUrl' => '<string>',
                ],
            ],
            'sharePointConfiguration' => [
                'crawlerConfiguration' => [
                    'filterConfiguration' => [
                        'patternObjectFilter' => [
                            'filters' => [
                                [
                                    'exclusionFilters' => ['<string>', ...],
                                    'inclusionFilters' => ['<string>', ...],
                                    'objectType' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'type' => 'PATTERN',
                    ],
                ],
                'sourceConfiguration' => [
                    'authType' => 'OAUTH2_CLIENT_CREDENTIALS',
                    'credentialsSecretArn' => '<string>',
                    'domain' => '<string>',
                    'hostType' => 'ONLINE',
                    'siteUrls' => ['<string>', ...],
                    'tenantId' => '<string>',
                ],
            ],
            'type' => 'S3|WEB|CONFLUENCE|SALESFORCE|SHAREPOINT|CUSTOM|REDSHIFT_METADATA',
            'webConfiguration' => [
                'crawlerConfiguration' => [
                    'crawlerLimits' => [
                        'rateLimit' => <integer>,
                    ],
                    'exclusionFilters' => ['<string>', ...],
                    'inclusionFilters' => ['<string>', ...],
                    'scope' => 'HOST_ONLY|SUBDOMAINS',
                ],
                'sourceConfiguration' => [
                    'urlConfiguration' => [
                        'seedUrls' => [
                            [
                                'url' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
            ],
        ],
        '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|HIERARCHICAL|SEMANTIC',
                'fixedSizeChunkingConfiguration' => [
                    'maxTokens' => <integer>,
                    'overlapPercentage' => <integer>,
                ],
                'hierarchicalChunkingConfiguration' => [
                    'levelConfigurations' => [
                        [
                            'maxTokens' => <integer>,
                        ],
                        // ...
                    ],
                    'overlapTokens' => <integer>,
                ],
                'semanticChunkingConfiguration' => [
                    'breakpointPercentileThreshold' => <integer>,
                    'bufferSize' => <integer>,
                    'maxTokens' => <integer>,
                ],
            ],
            'customTransformationConfiguration' => [
                'intermediateStorage' => [
                    's3Location' => [
                        'uri' => '<string>',
                    ],
                ],
                'transformations' => [
                    [
                        'stepToApply' => 'POST_CHUNKING',
                        'transformationFunction' => [
                            'transformationLambdaConfiguration' => [
                                'lambdaArn' => '<string>',
                            ],
                        ],
                    ],
                    // ...
                ],
            ],
            'parsingConfiguration' => [
                'bedrockDataAutomationConfiguration' => [
                    'parsingModality' => 'MULTIMODAL',
                ],
                'bedrockFoundationModelConfiguration' => [
                    'modelArn' => '<string>',
                    'parsingModality' => 'MULTIMODAL',
                    'parsingPrompt' => [
                        'parsingPromptText' => '<string>',
                    ],
                ],
                'parsingStrategy' => 'BEDROCK_FOUNDATION_MODEL|BEDROCK_DATA_AUTOMATION',
            ],
        ],
    ],
]

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.

GetFlow

$result = $client->getFlow([/* ... */]);
$promise = $client->getFlowAsync([/* ... */]);

Retrieves information about a flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'customerEncryptionKeyArn' => '<string>',
    'definition' => [
        'connections' => [
            [
                'configuration' => [
                    'conditional' => [
                        'condition' => '<string>',
                    ],
                    'data' => [
                        'sourceOutput' => '<string>',
                        'targetInput' => '<string>',
                    ],
                ],
                'name' => '<string>',
                'source' => '<string>',
                'target' => '<string>',
                'type' => 'Data|Conditional',
            ],
            // ...
        ],
        'nodes' => [
            [
                'configuration' => [
                    'agent' => [
                        'agentAliasArn' => '<string>',
                    ],
                    'collector' => [
                    ],
                    'condition' => [
                        'conditions' => [
                            [
                                'expression' => '<string>',
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'input' => [
                    ],
                    'iterator' => [
                    ],
                    'knowledgeBase' => [
                        'guardrailConfiguration' => [
                            'guardrailIdentifier' => '<string>',
                            'guardrailVersion' => '<string>',
                        ],
                        'knowledgeBaseId' => '<string>',
                        'modelId' => '<string>',
                    ],
                    'lambdaFunction' => [
                        'lambdaArn' => '<string>',
                    ],
                    'lex' => [
                        'botAliasArn' => '<string>',
                        'localeId' => '<string>',
                    ],
                    'output' => [
                    ],
                    'prompt' => [
                        'guardrailConfiguration' => [
                            'guardrailIdentifier' => '<string>',
                            'guardrailVersion' => '<string>',
                        ],
                        'sourceConfiguration' => [
                            'inline' => [
                                'additionalModelRequestFields' => [
                                ],
                                'inferenceConfiguration' => [
                                    'text' => [
                                        'maxTokens' => <integer>,
                                        'stopSequences' => ['<string>', ...],
                                        'temperature' => <float>,
                                        'topP' => <float>,
                                    ],
                                ],
                                'modelId' => '<string>',
                                'templateConfiguration' => [
                                    'chat' => [
                                        'inputVariables' => [
                                            [
                                                'name' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'messages' => [
                                            [
                                                'content' => [
                                                    [
                                                        'text' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                                'role' => 'user|assistant',
                                            ],
                                            // ...
                                        ],
                                        'system' => [
                                            [
                                                'text' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'toolConfiguration' => [
                                            'toolChoice' => [
                                                'any' => [
                                                ],
                                                'auto' => [
                                                ],
                                                'tool' => [
                                                    'name' => '<string>',
                                                ],
                                            ],
                                            'tools' => [
                                                [
                                                    'toolSpec' => [
                                                        'description' => '<string>',
                                                        'inputSchema' => [
                                                            'json' => [
                                                            ],
                                                        ],
                                                        'name' => '<string>',
                                                    ],
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'text' => [
                                        'inputVariables' => [
                                            [
                                                'name' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'text' => '<string>',
                                    ],
                                ],
                                'templateType' => 'TEXT|CHAT',
                            ],
                            'resource' => [
                                'promptArn' => '<string>',
                            ],
                        ],
                    ],
                    'retrieval' => [
                        'serviceConfiguration' => [
                            's3' => [
                                'bucketName' => '<string>',
                            ],
                        ],
                    ],
                    'storage' => [
                        'serviceConfiguration' => [
                            's3' => [
                                'bucketName' => '<string>',
                            ],
                        ],
                    ],
                ],
                'inputs' => [
                    [
                        'expression' => '<string>',
                        'name' => '<string>',
                        'type' => 'String|Number|Boolean|Object|Array',
                    ],
                    // ...
                ],
                'name' => '<string>',
                'outputs' => [
                    [
                        'name' => '<string>',
                        'type' => 'String|Number|Boolean|Object|Array',
                    ],
                    // ...
                ],
                'type' => 'Input|Output|KnowledgeBase|Condition|Lex|Prompt|LambdaFunction|Storage|Agent|Retrieval|Iterator|Collector',
            ],
            // ...
        ],
    ],
    'description' => '<string>',
    'executionRoleArn' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'status' => 'Failed|Prepared|Preparing|NotPrepared',
    'updatedAt' => <DateTime>,
    'validations' => [
        [
            'details' => [
                'cyclicConnection' => [
                    'connection' => '<string>',
                ],
                'duplicateConditionExpression' => [
                    'expression' => '<string>',
                    'node' => '<string>',
                ],
                'duplicateConnections' => [
                    'source' => '<string>',
                    'target' => '<string>',
                ],
                'incompatibleConnectionDataType' => [
                    'connection' => '<string>',
                ],
                'malformedConditionExpression' => [
                    'cause' => '<string>',
                    'condition' => '<string>',
                    'node' => '<string>',
                ],
                'malformedNodeInputExpression' => [
                    'cause' => '<string>',
                    'input' => '<string>',
                    'node' => '<string>',
                ],
                'mismatchedNodeInputType' => [
                    'expectedType' => 'String|Number|Boolean|Object|Array',
                    'input' => '<string>',
                    'node' => '<string>',
                ],
                'mismatchedNodeOutputType' => [
                    'expectedType' => 'String|Number|Boolean|Object|Array',
                    'node' => '<string>',
                    'output' => '<string>',
                ],
                'missingConnectionConfiguration' => [
                    'connection' => '<string>',
                ],
                'missingDefaultCondition' => [
                    'node' => '<string>',
                ],
                'missingEndingNodes' => [
                ],
                'missingNodeConfiguration' => [
                    'node' => '<string>',
                ],
                'missingNodeInput' => [
                    'input' => '<string>',
                    'node' => '<string>',
                ],
                'missingNodeOutput' => [
                    'node' => '<string>',
                    'output' => '<string>',
                ],
                'missingStartingNodes' => [
                ],
                'multipleNodeInputConnections' => [
                    'input' => '<string>',
                    'node' => '<string>',
                ],
                'unfulfilledNodeInput' => [
                    'input' => '<string>',
                    'node' => '<string>',
                ],
                'unknownConnectionCondition' => [
                    'connection' => '<string>',
                ],
                'unknownConnectionSource' => [
                    'connection' => '<string>',
                ],
                'unknownConnectionSourceOutput' => [
                    'connection' => '<string>',
                ],
                'unknownConnectionTarget' => [
                    'connection' => '<string>',
                ],
                'unknownConnectionTargetInput' => [
                    'connection' => '<string>',
                ],
                'unreachableNode' => [
                    'node' => '<string>',
                ],
                'unsatisfiedConnectionConditions' => [
                    'connection' => '<string>',
                ],
                'unspecified' => [
                ],
            ],
            'message' => '<string>',
            'severity' => 'Warning|Error',
            'type' => 'CyclicConnection|DuplicateConnections|DuplicateConditionExpression|UnreachableNode|UnknownConnectionSource|UnknownConnectionSourceOutput|UnknownConnectionTarget|UnknownConnectionTargetInput|UnknownConnectionCondition|MalformedConditionExpression|MalformedNodeInputExpression|MismatchedNodeInputType|MismatchedNodeOutputType|IncompatibleConnectionDataType|MissingConnectionConfiguration|MissingDefaultCondition|MissingEndingNodes|MissingNodeConfiguration|MissingNodeInput|MissingNodeOutput|MissingStartingNodes|MultipleNodeInputConnections|UnfulfilledNodeInput|UnsatisfiedConnectionConditions|Unspecified',
        ],
        // ...
    ],
    '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.

GetFlowAlias

$result = $client->getFlowAlias([/* ... */]);
$promise = $client->getFlowAliasAsync([/* ... */]);

Retrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->getFlowAlias([
    'aliasIdentifier' => '<string>', // REQUIRED
    'flowIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'flowId' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'routingConfiguration' => [
        [
            'flowVersion' => '<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.

GetFlowVersion

$result = $client->getFlowVersion([/* ... */]);
$promise = $client->getFlowVersionAsync([/* ... */]);

Retrieves information about a version of a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->getFlowVersion([
    'flowIdentifier' => '<string>', // REQUIRED
    'flowVersion' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'customerEncryptionKeyArn' => '<string>',
    'definition' => [
        'connections' => [
            [
                'configuration' => [
                    'conditional' => [
                        'condition' => '<string>',
                    ],
                    'data' => [
                        'sourceOutput' => '<string>',
                        'targetInput' => '<string>',
                    ],
                ],
                'name' => '<string>',
                'source' => '<string>',
                'target' => '<string>',
                'type' => 'Data|Conditional',
            ],
            // ...
        ],
        'nodes' => [
            [
                'configuration' => [
                    'agent' => [
                        'agentAliasArn' => '<string>',
                    ],
                    'collector' => [
                    ],
                    'condition' => [
                        'conditions' => [
                            [
                                'expression' => '<string>',
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'input' => [
                    ],
                    'iterator' => [
                    ],
                    'knowledgeBase' => [
                        'guardrailConfiguration' => [
                            'guardrailIdentifier' => '<string>',
                            'guardrailVersion' => '<string>',
                        ],
                        'knowledgeBaseId' => '<string>',
                        'modelId' => '<string>',
                    ],
                    'lambdaFunction' => [
                        'lambdaArn' => '<string>',
                    ],
                    'lex' => [
                        'botAliasArn' => '<string>',
                        'localeId' => '<string>',
                    ],
                    'output' => [
                    ],
                    'prompt' => [
                        'guardrailConfiguration' => [
                            'guardrailIdentifier' => '<string>',
                            'guardrailVersion' => '<string>',
                        ],
                        'sourceConfiguration' => [
                            'inline' => [
                                'additionalModelRequestFields' => [
                                ],
                                'inferenceConfiguration' => [
                                    'text' => [
                                        'maxTokens' => <integer>,
                                        'stopSequences' => ['<string>', ...],
                                        'temperature' => <float>,
                                        'topP' => <float>,
                                    ],
                                ],
                                'modelId' => '<string>',
                                'templateConfiguration' => [
                                    'chat' => [
                                        'inputVariables' => [
                                            [
                                                'name' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'messages' => [
                                            [
                                                'content' => [
                                                    [
                                                        'text' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                                'role' => 'user|assistant',
                                            ],
                                            // ...
                                        ],
                                        'system' => [
                                            [
                                                'text' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'toolConfiguration' => [
                                            'toolChoice' => [
                                                'any' => [
                                                ],
                                                'auto' => [
                                                ],
                                                'tool' => [
                                                    'name' => '<string>',
                                                ],
                                            ],
                                            'tools' => [
                                                [
                                                    'toolSpec' => [
                                                        'description' => '<string>',
                                                        'inputSchema' => [
                                                            'json' => [
                                                            ],
                                                        ],
                                                        'name' => '<string>',
                                                    ],
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'text' => [
                                        'inputVariables' => [
                                            [
                                                'name' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'text' => '<string>',
                                    ],
                                ],
                                'templateType' => 'TEXT|CHAT',
                            ],
                            'resource' => [
                                'promptArn' => '<string>',
                            ],
                        ],
                    ],
                    'retrieval' => [
                        'serviceConfiguration' => [
                            's3' => [
                                'bucketName' => '<string>',
                            ],
                        ],
                    ],
                    'storage' => [
                        'serviceConfiguration' => [
                            's3' => [
                                'bucketName' => '<string>',
                            ],
                        ],
                    ],
                ],
                'inputs' => [
                    [
                        'expression' => '<string>',
                        'name' => '<string>',
                        'type' => 'String|Number|Boolean|Object|Array',
                    ],
                    // ...
                ],
                'name' => '<string>',
                'outputs' => [
                    [
                        'name' => '<string>',
                        'type' => 'String|Number|Boolean|Object|Array',
                    ],
                    // ...
                ],
                'type' => 'Input|Output|KnowledgeBase|Condition|Lex|Prompt|LambdaFunction|Storage|Agent|Retrieval|Iterator|Collector',
            ],
            // ...
        ],
    ],
    'description' => '<string>',
    'executionRoleArn' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'status' => 'Failed|Prepared|Preparing|NotPrepared',
    '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.

GetIngestionJob

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

Gets information about a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.

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|STOPPING|STOPPED',
        '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' => [
            'kendraKnowledgeBaseConfiguration' => [
                'kendraIndexArn' => '<string>',
            ],
            'sqlKnowledgeBaseConfiguration' => [
                'redshiftConfiguration' => [
                    'queryEngineConfiguration' => [
                        'provisionedConfiguration' => [
                            'authConfiguration' => [
                                'databaseUser' => '<string>',
                                'type' => 'IAM|USERNAME_PASSWORD|USERNAME',
                                'usernamePasswordSecretArn' => '<string>',
                            ],
                            'clusterIdentifier' => '<string>',
                        ],
                        'serverlessConfiguration' => [
                            'authConfiguration' => [
                                'type' => 'IAM|USERNAME_PASSWORD',
                                'usernamePasswordSecretArn' => '<string>',
                            ],
                            'workgroupArn' => '<string>',
                        ],
                        'type' => 'SERVERLESS|PROVISIONED',
                    ],
                    'queryGenerationConfiguration' => [
                        'executionTimeoutSeconds' => <integer>,
                        'generationContext' => [
                            'curatedQueries' => [
                                [
                                    'naturalLanguage' => '<string>',
                                    'sql' => '<string>',
                                ],
                                // ...
                            ],
                            'tables' => [
                                [
                                    'columns' => [
                                        [
                                            'description' => '<string>',
                                            'inclusion' => 'INCLUDE|EXCLUDE',
                                            'name' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'description' => '<string>',
                                    'inclusion' => 'INCLUDE|EXCLUDE',
                                    'name' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'storageConfigurations' => [
                        [
                            'awsDataCatalogConfiguration' => [
                                'tableNames' => ['<string>', ...],
                            ],
                            'redshiftConfiguration' => [
                                'databaseName' => '<string>',
                            ],
                            'type' => 'REDSHIFT|AWS_DATA_CATALOG',
                        ],
                        // ...
                    ],
                ],
                'type' => 'REDSHIFT',
            ],
            'type' => 'VECTOR|KENDRA|SQL',
            'vectorKnowledgeBaseConfiguration' => [
                'embeddingModelArn' => '<string>',
                'embeddingModelConfiguration' => [
                    'bedrockEmbeddingModelConfiguration' => [
                        'dimensions' => <integer>,
                        'embeddingDataType' => 'FLOAT32|BINARY',
                    ],
                ],
                'supplementalDataStorageConfiguration' => [
                    'storageLocations' => [
                        [
                            's3Location' => [
                                'uri' => '<string>',
                            ],
                            'type' => 'S3',
                        ],
                        // ...
                    ],
                ],
            ],
        ],
        '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.

GetKnowledgeBaseDocuments

$result = $client->getKnowledgeBaseDocuments([/* ... */]);
$promise = $client->getKnowledgeBaseDocumentsAsync([/* ... */]);

Retrieves specific documents from a data source that is connected to a knowledge base. For more information, see Ingest documents into a knowledge base in real-time in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->getKnowledgeBaseDocuments([
    'dataSourceId' => '<string>', // REQUIRED
    'documentIdentifiers' => [ // REQUIRED
        [
            'custom' => [
                'id' => '<string>', // REQUIRED
            ],
            'dataSourceType' => 'CUSTOM|S3', // REQUIRED
            's3' => [
                'uri' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'knowledgeBaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'documentDetails' => [
        [
            'dataSourceId' => '<string>',
            'identifier' => [
                'custom' => [
                    'id' => '<string>',
                ],
                'dataSourceType' => 'CUSTOM|S3',
                's3' => [
                    'uri' => '<string>',
                ],
            ],
            'knowledgeBaseId' => '<string>',
            'status' => 'INDEXED|PARTIALLY_INDEXED|PENDING|FAILED|METADATA_PARTIALLY_INDEXED|METADATA_UPDATE_FAILED|IGNORED|NOT_FOUND|STARTING|IN_PROGRESS|DELETING|DELETE_IN_PROGRESS',
            'statusReason' => '<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.

ServiceQuotaExceededException:

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

GetPrompt

$result = $client->getPrompt([/* ... */]);
$promise = $client->getPromptAsync([/* ... */]);

Retrieves information about the working draft (DRAFT version) of a prompt or a version of it, depending on whether you include the promptVersion field or not. For more information, see View information about prompts using Prompt management and View information about a version of your prompt in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->getPrompt([
    'promptIdentifier' => '<string>', // REQUIRED
    'promptVersion' => '<string>',
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'customerEncryptionKeyArn' => '<string>',
    'defaultVariant' => '<string>',
    'description' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'updatedAt' => <DateTime>,
    'variants' => [
        [
            'additionalModelRequestFields' => [
            ],
            'genAiResource' => [
                'agent' => [
                    'agentIdentifier' => '<string>',
                ],
            ],
            'inferenceConfiguration' => [
                'text' => [
                    'maxTokens' => <integer>,
                    'stopSequences' => ['<string>', ...],
                    'temperature' => <float>,
                    'topP' => <float>,
                ],
            ],
            'metadata' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'modelId' => '<string>',
            'name' => '<string>',
            'templateConfiguration' => [
                'chat' => [
                    'inputVariables' => [
                        [
                            'name' => '<string>',
                        ],
                        // ...
                    ],
                    'messages' => [
                        [
                            'content' => [
                                [
                                    'text' => '<string>',
                                ],
                                // ...
                            ],
                            'role' => 'user|assistant',
                        ],
                        // ...
                    ],
                    'system' => [
                        [
                            'text' => '<string>',
                        ],
                        // ...
                    ],
                    'toolConfiguration' => [
                        'toolChoice' => [
                            'any' => [
                            ],
                            'auto' => [
                            ],
                            'tool' => [
                                'name' => '<string>',
                            ],
                        ],
                        'tools' => [
                            [
                                'toolSpec' => [
                                    'description' => '<string>',
                                    'inputSchema' => [
                                        'json' => [
                                        ],
                                    ],
                                    'name' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                ],
                'text' => [
                    'inputVariables' => [
                        [
                            'name' => '<string>',
                        ],
                        // ...
                    ],
                    'text' => '<string>',
                ],
            ],
            'templateType' => 'TEXT|CHAT',
        ],
        // ...
    ],
    '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.

IngestKnowledgeBaseDocuments

$result = $client->ingestKnowledgeBaseDocuments([/* ... */]);
$promise = $client->ingestKnowledgeBaseDocumentsAsync([/* ... */]);

Ingests documents directly into the knowledge base that is connected to the data source. The dataSourceType specified in the content for each document must match the type of the data source that you specify in the header. For more information, see Ingest documents into a knowledge base in real-time in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->ingestKnowledgeBaseDocuments([
    'clientToken' => '<string>',
    'dataSourceId' => '<string>', // REQUIRED
    'documents' => [ // REQUIRED
        [
            'content' => [ // REQUIRED
                'custom' => [
                    'customDocumentIdentifier' => [ // REQUIRED
                        'id' => '<string>', // REQUIRED
                    ],
                    'inlineContent' => [
                        'byteContent' => [
                            'data' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
                            'mimeType' => '<string>', // REQUIRED
                        ],
                        'textContent' => [
                            'data' => '<string>', // REQUIRED
                        ],
                        'type' => 'BYTE|TEXT', // REQUIRED
                    ],
                    's3Location' => [
                        'bucketOwnerAccountId' => '<string>',
                        'uri' => '<string>', // REQUIRED
                    ],
                    'sourceType' => 'IN_LINE|S3_LOCATION', // REQUIRED
                ],
                'dataSourceType' => 'CUSTOM|S3', // REQUIRED
                's3' => [
                    's3Location' => [ // REQUIRED
                        'uri' => '<string>', // REQUIRED
                    ],
                ],
            ],
            'metadata' => [
                'inlineAttributes' => [
                    [
                        'key' => '<string>', // REQUIRED
                        'value' => [ // REQUIRED
                            'booleanValue' => true || false,
                            'numberValue' => <float>,
                            'stringListValue' => ['<string>', ...],
                            'stringValue' => '<string>',
                            'type' => 'BOOLEAN|NUMBER|STRING|STRING_LIST', // REQUIRED
                        ],
                    ],
                    // ...
                ],
                's3Location' => [
                    'bucketOwnerAccountId' => '<string>',
                    'uri' => '<string>', // REQUIRED
                ],
                'type' => 'IN_LINE_ATTRIBUTE|S3_LOCATION', // REQUIRED
            ],
        ],
        // ...
    ],
    'knowledgeBaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'documentDetails' => [
        [
            'dataSourceId' => '<string>',
            'identifier' => [
                'custom' => [
                    'id' => '<string>',
                ],
                'dataSourceType' => 'CUSTOM|S3',
                's3' => [
                    'uri' => '<string>',
                ],
            ],
            'knowledgeBaseId' => '<string>',
            'status' => 'INDEXED|PARTIALLY_INDEXED|PENDING|FAILED|METADATA_PARTIALLY_INDEXED|METADATA_UPDATE_FAILED|IGNORED|NOT_FOUND|STARTING|IN_PROGRESS|DELETING|DELETE_IN_PROGRESS',
            'statusReason' => '<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.

ServiceQuotaExceededException:

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

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.

ListAgentCollaborators

$result = $client->listAgentCollaborators([/* ... */]);
$promise = $client->listAgentCollaboratorsAsync([/* ... */]);

Retrieve a list of an agent's collaborators.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'agentCollaboratorSummaries' => [
        [
            'agentDescriptor' => [
                'aliasArn' => '<string>',
            ],
            'agentId' => '<string>',
            'agentVersion' => '<string>',
            'collaborationInstruction' => '<string>',
            'collaboratorId' => '<string>',
            'collaboratorName' => '<string>',
            'createdAt' => <DateTime>,
            'lastUpdatedAt' => <DateTime>,
            'relayConversationHistory' => 'TO_COLLABORATOR|DISABLED',
        ],
        // ...
    ],
    '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.

ListFlowAliases

$result = $client->listFlowAliases([/* ... */]);
$promise = $client->listFlowAliasesAsync([/* ... */]);

Returns a list of aliases for a flow.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'flowAliasSummaries' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'flowId' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'routingConfiguration' => [
                [
                    'flowVersion' => '<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.

ListFlowVersions

$result = $client->listFlowVersions([/* ... */]);
$promise = $client->listFlowVersionsAsync([/* ... */]);

Returns a list of information about each flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'flowVersionSummaries' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'status' => 'Failed|Prepared|Preparing|NotPrepared',
            'version' => '<string>',
        ],
        // ...
    ],
    '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.

ListFlows

$result = $client->listFlows([/* ... */]);
$promise = $client->listFlowsAsync([/* ... */]);

Returns a list of flows and information about each flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'flowSummaries' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'status' => 'Failed|Prepared|Preparing|NotPrepared',
            'updatedAt' => <DateTime>,
            'version' => '<string>',
        ],
        // ...
    ],
    '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.

ListIngestionJobs

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

Lists the data ingestion jobs for a data source. The list also includes information about each job.

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|STOPPING|STOPPED',
            '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.

ListKnowledgeBaseDocuments

$result = $client->listKnowledgeBaseDocuments([/* ... */]);
$promise = $client->listKnowledgeBaseDocumentsAsync([/* ... */]);

Retrieves all the documents contained in a data source that is connected to a knowledge base. For more information, see Ingest documents into a knowledge base in real-time in the Amazon Bedrock User Guide.

Parameter Syntax

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

Parameter Details