ApplyGuardrail

$result = $client->applyGuardrail([/* ... */]);
$promise = $client->applyGuardrailAsync([/* ... */]);

The action to apply a guardrail.

For troubleshooting some of the common errors you might encounter when using the ApplyGuardrail API, see Troubleshooting Amazon Bedrock API Error Codes in the Amazon Bedrock User Guide

Parameter Syntax

$result = $client->applyGuardrail([
    'content' => [ // REQUIRED
        [
            'image' => [
                'format' => 'png|jpeg', // REQUIRED
                'source' => [ // REQUIRED
                    'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                ],
            ],
            'text' => [
                'qualifiers' => ['<string>', ...],
                'text' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'guardrailIdentifier' => '<string>', // REQUIRED
    'guardrailVersion' => '<string>', // REQUIRED
    'source' => 'INPUT|OUTPUT', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'action' => 'NONE|GUARDRAIL_INTERVENED',
    'assessments' => [
        [
            'contentPolicy' => [
                'filters' => [
                    [
                        'action' => 'BLOCKED',
                        'confidence' => 'NONE|LOW|MEDIUM|HIGH',
                        'filterStrength' => 'NONE|LOW|MEDIUM|HIGH',
                        'type' => 'INSULTS|HATE|SEXUAL|VIOLENCE|MISCONDUCT|PROMPT_ATTACK',
                    ],
                    // ...
                ],
            ],
            'contextualGroundingPolicy' => [
                'filters' => [
                    [
                        'action' => 'BLOCKED|NONE',
                        'score' => <float>,
                        'threshold' => <float>,
                        'type' => 'GROUNDING|RELEVANCE',
                    ],
                    // ...
                ],
            ],
            'invocationMetrics' => [
                'guardrailCoverage' => [
                    'images' => [
                        'guarded' => <integer>,
                        'total' => <integer>,
                    ],
                    'textCharacters' => [
                        'guarded' => <integer>,
                        'total' => <integer>,
                    ],
                ],
                'guardrailProcessingLatency' => <integer>,
                'usage' => [
                    'contentPolicyUnits' => <integer>,
                    'contextualGroundingPolicyUnits' => <integer>,
                    'sensitiveInformationPolicyFreeUnits' => <integer>,
                    'sensitiveInformationPolicyUnits' => <integer>,
                    'topicPolicyUnits' => <integer>,
                    'wordPolicyUnits' => <integer>,
                ],
            ],
            'sensitiveInformationPolicy' => [
                'piiEntities' => [
                    [
                        'action' => 'ANONYMIZED|BLOCKED',
                        'match' => '<string>',
                        'type' => 'ADDRESS|AGE|AWS_ACCESS_KEY|AWS_SECRET_KEY|CA_HEALTH_NUMBER|CA_SOCIAL_INSURANCE_NUMBER|CREDIT_DEBIT_CARD_CVV|CREDIT_DEBIT_CARD_EXPIRY|CREDIT_DEBIT_CARD_NUMBER|DRIVER_ID|EMAIL|INTERNATIONAL_BANK_ACCOUNT_NUMBER|IP_ADDRESS|LICENSE_PLATE|MAC_ADDRESS|NAME|PASSWORD|PHONE|PIN|SWIFT_CODE|UK_NATIONAL_HEALTH_SERVICE_NUMBER|UK_NATIONAL_INSURANCE_NUMBER|UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER|URL|USERNAME|US_BANK_ACCOUNT_NUMBER|US_BANK_ROUTING_NUMBER|US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER|US_PASSPORT_NUMBER|US_SOCIAL_SECURITY_NUMBER|VEHICLE_IDENTIFICATION_NUMBER',
                    ],
                    // ...
                ],
                'regexes' => [
                    [
                        'action' => 'ANONYMIZED|BLOCKED',
                        'match' => '<string>',
                        'name' => '<string>',
                        'regex' => '<string>',
                    ],
                    // ...
                ],
            ],
            'topicPolicy' => [
                'topics' => [
                    [
                        'action' => 'BLOCKED',
                        'name' => '<string>',
                        'type' => 'DENY',
                    ],
                    // ...
                ],
            ],
            'wordPolicy' => [
                'customWords' => [
                    [
                        'action' => 'BLOCKED',
                        'match' => '<string>',
                    ],
                    // ...
                ],
                'managedWordLists' => [
                    [
                        'action' => 'BLOCKED',
                        'match' => '<string>',
                        'type' => 'PROFANITY',
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
    'guardrailCoverage' => [
        'images' => [
            'guarded' => <integer>,
            'total' => <integer>,
        ],
        'textCharacters' => [
            'guarded' => <integer>,
            'total' => <integer>,
        ],
    ],
    'outputs' => [
        [
            'text' => '<string>',
        ],
        // ...
    ],
    'usage' => [
        'contentPolicyUnits' => <integer>,
        'contextualGroundingPolicyUnits' => <integer>,
        'sensitiveInformationPolicyFreeUnits' => <integer>,
        'sensitiveInformationPolicyUnits' => <integer>,
        'topicPolicyUnits' => <integer>,
        'wordPolicyUnits' => <integer>,
    ],
]

Result Details

Errors

AccessDeniedException:

The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see AccessDeniedException in the Amazon Bedrock User Guide

ResourceNotFoundException:

The specified resource ARN was not found. For troubleshooting this error, see ResourceNotFound in the Amazon Bedrock User Guide

ThrottlingException:

Your request was denied due to exceeding the account quotas for Amazon Bedrock. For troubleshooting this error, see ThrottlingException in the Amazon Bedrock User Guide

InternalServerException:

An internal server error occurred. For troubleshooting this error, see InternalFailure in the Amazon Bedrock User Guide

ValidationException:

The input fails to satisfy the constraints specified by Amazon Bedrock. For troubleshooting this error, see ValidationError in the Amazon Bedrock User Guide

ServiceQuotaExceededException:

Your request exceeds the service quota for your account. You can view your quotas at Viewing service quotas. You can resubmit your request later.

Converse

$result = $client->converse([/* ... */]);
$promise = $client->converseAsync([/* ... */]);

Sends messages to the specified Amazon Bedrock model. Converse provides a consistent interface that works with all models that support messages. This allows you to write code once and use it with different models. If a model has unique inference parameters, you can also pass those unique parameters to the model.

Amazon Bedrock doesn't store any text, images, or documents that you provide as content. The data is only used to generate the response.

You can submit a prompt by including it in the messages field, specifying the modelId of a foundation model or inference profile to run inference on it, and including any other fields that are relevant to your use case.

You can also submit a prompt from Prompt management by specifying the ARN of the prompt version and including a map of variables to values in the promptVariables field. You can append more messages to the prompt by using the messages field. If you use a prompt from Prompt management, you can't include the following fields in the request: additionalModelRequestFields, inferenceConfig, system, or toolConfig. Instead, these fields must be defined through Prompt management. For more information, see Use a prompt from Prompt management.

For information about the Converse API, see Use the Converse API in the Amazon Bedrock User Guide. To use a guardrail, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide. To use a tool with a model, see Tool use (Function calling) in the Amazon Bedrock User Guide

For example code, see Converse API examples in the Amazon Bedrock User Guide.

This operation requires permission for the bedrock:InvokeModel action.

For troubleshooting some of the common errors you might encounter when using the Converse API, see Troubleshooting Amazon Bedrock API Error Codes in the Amazon Bedrock User Guide

Parameter Syntax

$result = $client->converse([
    'additionalModelRequestFields' => [
    ],
    'additionalModelResponseFieldPaths' => ['<string>', ...],
    'guardrailConfig' => [
        'guardrailIdentifier' => '<string>', // REQUIRED
        'guardrailVersion' => '<string>', // REQUIRED
        'trace' => 'enabled|disabled',
    ],
    'inferenceConfig' => [
        'maxTokens' => <integer>,
        'stopSequences' => ['<string>', ...],
        'temperature' => <float>,
        'topP' => <float>,
    ],
    'messages' => [
        [
            'content' => [ // REQUIRED
                [
                    'document' => [
                        'format' => 'pdf|csv|doc|docx|xls|xlsx|html|txt|md', // REQUIRED
                        'name' => '<string>', // REQUIRED
                        'source' => [ // REQUIRED
                            'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                        ],
                    ],
                    'guardContent' => [
                        'image' => [
                            'format' => 'png|jpeg', // REQUIRED
                            'source' => [ // REQUIRED
                                'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                            ],
                        ],
                        'text' => [
                            'qualifiers' => ['<string>', ...],
                            'text' => '<string>', // REQUIRED
                        ],
                    ],
                    'image' => [
                        'format' => 'png|jpeg|gif|webp', // REQUIRED
                        'source' => [ // REQUIRED
                            'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                        ],
                    ],
                    'text' => '<string>',
                    'toolResult' => [
                        'content' => [ // REQUIRED
                            [
                                'document' => [
                                    'format' => 'pdf|csv|doc|docx|xls|xlsx|html|txt|md', // REQUIRED
                                    'name' => '<string>', // REQUIRED
                                    'source' => [ // REQUIRED
                                        'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                                    ],
                                ],
                                'image' => [
                                    'format' => 'png|jpeg|gif|webp', // REQUIRED
                                    'source' => [ // REQUIRED
                                        'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                                    ],
                                ],
                                'json' => [
                                ],
                                'text' => '<string>',
                                'video' => [
                                    'format' => 'mkv|mov|mp4|webm|flv|mpeg|mpg|wmv|three_gp', // REQUIRED
                                    'source' => [ // REQUIRED
                                        'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                                        's3Location' => [
                                            'bucketOwner' => '<string>',
                                            'uri' => '<string>', // REQUIRED
                                        ],
                                    ],
                                ],
                            ],
                            // ...
                        ],
                        'status' => 'success|error',
                        'toolUseId' => '<string>', // REQUIRED
                    ],
                    'toolUse' => [
                        'input' => [ // REQUIRED
                        ],
                        'name' => '<string>', // REQUIRED
                        'toolUseId' => '<string>', // REQUIRED
                    ],
                    'video' => [
                        'format' => 'mkv|mov|mp4|webm|flv|mpeg|mpg|wmv|three_gp', // REQUIRED
                        'source' => [ // REQUIRED
                            'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                            's3Location' => [
                                'bucketOwner' => '<string>',
                                'uri' => '<string>', // REQUIRED
                            ],
                        ],
                    ],
                ],
                // ...
            ],
            'role' => 'user|assistant', // REQUIRED
        ],
        // ...
    ],
    'modelId' => '<string>', // REQUIRED
    'performanceConfig' => [
        'latency' => 'standard|optimized',
    ],
    'promptVariables' => [
        '<String>' => [
            'text' => '<string>',
        ],
        // ...
    ],
    'requestMetadata' => ['<string>', ...],
    'system' => [
        [
            'guardContent' => [
                'image' => [
                    'format' => 'png|jpeg', // REQUIRED
                    'source' => [ // REQUIRED
                        'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                    ],
                ],
                'text' => [
                    'qualifiers' => ['<string>', ...],
                    'text' => '<string>', // REQUIRED
                ],
            ],
            'text' => '<string>',
        ],
        // ...
    ],
    'toolConfig' => [
        'toolChoice' => [
            'any' => [
            ],
            'auto' => [
            ],
            'tool' => [
                'name' => '<string>', // REQUIRED
            ],
        ],
        'tools' => [ // REQUIRED
            [
                'toolSpec' => [
                    'description' => '<string>',
                    'inputSchema' => [ // REQUIRED
                        'json' => [
                        ],
                    ],
                    'name' => '<string>', // REQUIRED
                ],
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'additionalModelResponseFields' => [
    ],
    'metrics' => [
        'latencyMs' => <integer>,
    ],
    'output' => [
        'message' => [
            'content' => [
                [
                    'document' => [
                        'format' => 'pdf|csv|doc|docx|xls|xlsx|html|txt|md',
                        'name' => '<string>',
                        'source' => [
                            'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                        ],
                    ],
                    'guardContent' => [
                        'image' => [
                            'format' => 'png|jpeg',
                            'source' => [
                                'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                            ],
                        ],
                        'text' => [
                            'qualifiers' => ['<string>', ...],
                            'text' => '<string>',
                        ],
                    ],
                    'image' => [
                        'format' => 'png|jpeg|gif|webp',
                        'source' => [
                            'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                        ],
                    ],
                    'text' => '<string>',
                    'toolResult' => [
                        'content' => [
                            [
                                'document' => [
                                    'format' => 'pdf|csv|doc|docx|xls|xlsx|html|txt|md',
                                    'name' => '<string>',
                                    'source' => [
                                        'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                                    ],
                                ],
                                'image' => [
                                    'format' => 'png|jpeg|gif|webp',
                                    'source' => [
                                        'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                                    ],
                                ],
                                'json' => [
                                ],
                                'text' => '<string>',
                                'video' => [
                                    'format' => 'mkv|mov|mp4|webm|flv|mpeg|mpg|wmv|three_gp',
                                    'source' => [
                                        'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                                        's3Location' => [
                                            'bucketOwner' => '<string>',
                                            'uri' => '<string>',
                                        ],
                                    ],
                                ],
                            ],
                            // ...
                        ],
                        'status' => 'success|error',
                        'toolUseId' => '<string>',
                    ],
                    'toolUse' => [
                        'input' => [
                        ],
                        'name' => '<string>',
                        'toolUseId' => '<string>',
                    ],
                    'video' => [
                        'format' => 'mkv|mov|mp4|webm|flv|mpeg|mpg|wmv|three_gp',
                        'source' => [
                            'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                            's3Location' => [
                                'bucketOwner' => '<string>',
                                'uri' => '<string>',
                            ],
                        ],
                    ],
                ],
                // ...
            ],
            'role' => 'user|assistant',
        ],
    ],
    'performanceConfig' => [
        'latency' => 'standard|optimized',
    ],
    'stopReason' => 'end_turn|tool_use|max_tokens|stop_sequence|guardrail_intervened|content_filtered',
    'trace' => [
        'guardrail' => [
            'inputAssessment' => [
                '<String>' => [
                    'contentPolicy' => [
                        'filters' => [
                            [
                                'action' => 'BLOCKED',
                                'confidence' => 'NONE|LOW|MEDIUM|HIGH',
                                'filterStrength' => 'NONE|LOW|MEDIUM|HIGH',
                                'type' => 'INSULTS|HATE|SEXUAL|VIOLENCE|MISCONDUCT|PROMPT_ATTACK',
                            ],
                            // ...
                        ],
                    ],
                    'contextualGroundingPolicy' => [
                        'filters' => [
                            [
                                'action' => 'BLOCKED|NONE',
                                'score' => <float>,
                                'threshold' => <float>,
                                'type' => 'GROUNDING|RELEVANCE',
                            ],
                            // ...
                        ],
                    ],
                    'invocationMetrics' => [
                        'guardrailCoverage' => [
                            'images' => [
                                'guarded' => <integer>,
                                'total' => <integer>,
                            ],
                            'textCharacters' => [
                                'guarded' => <integer>,
                                'total' => <integer>,
                            ],
                        ],
                        'guardrailProcessingLatency' => <integer>,
                        'usage' => [
                            'contentPolicyUnits' => <integer>,
                            'contextualGroundingPolicyUnits' => <integer>,
                            'sensitiveInformationPolicyFreeUnits' => <integer>,
                            'sensitiveInformationPolicyUnits' => <integer>,
                            'topicPolicyUnits' => <integer>,
                            'wordPolicyUnits' => <integer>,
                        ],
                    ],
                    'sensitiveInformationPolicy' => [
                        'piiEntities' => [
                            [
                                'action' => 'ANONYMIZED|BLOCKED',
                                'match' => '<string>',
                                'type' => 'ADDRESS|AGE|AWS_ACCESS_KEY|AWS_SECRET_KEY|CA_HEALTH_NUMBER|CA_SOCIAL_INSURANCE_NUMBER|CREDIT_DEBIT_CARD_CVV|CREDIT_DEBIT_CARD_EXPIRY|CREDIT_DEBIT_CARD_NUMBER|DRIVER_ID|EMAIL|INTERNATIONAL_BANK_ACCOUNT_NUMBER|IP_ADDRESS|LICENSE_PLATE|MAC_ADDRESS|NAME|PASSWORD|PHONE|PIN|SWIFT_CODE|UK_NATIONAL_HEALTH_SERVICE_NUMBER|UK_NATIONAL_INSURANCE_NUMBER|UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER|URL|USERNAME|US_BANK_ACCOUNT_NUMBER|US_BANK_ROUTING_NUMBER|US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER|US_PASSPORT_NUMBER|US_SOCIAL_SECURITY_NUMBER|VEHICLE_IDENTIFICATION_NUMBER',
                            ],
                            // ...
                        ],
                        'regexes' => [
                            [
                                'action' => 'ANONYMIZED|BLOCKED',
                                'match' => '<string>',
                                'name' => '<string>',
                                'regex' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'topicPolicy' => [
                        'topics' => [
                            [
                                'action' => 'BLOCKED',
                                'name' => '<string>',
                                'type' => 'DENY',
                            ],
                            // ...
                        ],
                    ],
                    'wordPolicy' => [
                        'customWords' => [
                            [
                                'action' => 'BLOCKED',
                                'match' => '<string>',
                            ],
                            // ...
                        ],
                        'managedWordLists' => [
                            [
                                'action' => 'BLOCKED',
                                'match' => '<string>',
                                'type' => 'PROFANITY',
                            ],
                            // ...
                        ],
                    ],
                ],
                // ...
            ],
            'modelOutput' => ['<string>', ...],
            'outputAssessments' => [
                '<String>' => [
                    [
                        'contentPolicy' => [
                            'filters' => [
                                [
                                    'action' => 'BLOCKED',
                                    'confidence' => 'NONE|LOW|MEDIUM|HIGH',
                                    'filterStrength' => 'NONE|LOW|MEDIUM|HIGH',
                                    'type' => 'INSULTS|HATE|SEXUAL|VIOLENCE|MISCONDUCT|PROMPT_ATTACK',
                                ],
                                // ...
                            ],
                        ],
                        'contextualGroundingPolicy' => [
                            'filters' => [
                                [
                                    'action' => 'BLOCKED|NONE',
                                    'score' => <float>,
                                    'threshold' => <float>,
                                    'type' => 'GROUNDING|RELEVANCE',
                                ],
                                // ...
                            ],
                        ],
                        'invocationMetrics' => [
                            'guardrailCoverage' => [
                                'images' => [
                                    'guarded' => <integer>,
                                    'total' => <integer>,
                                ],
                                'textCharacters' => [
                                    'guarded' => <integer>,
                                    'total' => <integer>,
                                ],
                            ],
                            'guardrailProcessingLatency' => <integer>,
                            'usage' => [
                                'contentPolicyUnits' => <integer>,
                                'contextualGroundingPolicyUnits' => <integer>,
                                'sensitiveInformationPolicyFreeUnits' => <integer>,
                                'sensitiveInformationPolicyUnits' => <integer>,
                                'topicPolicyUnits' => <integer>,
                                'wordPolicyUnits' => <integer>,
                            ],
                        ],
                        'sensitiveInformationPolicy' => [
                            'piiEntities' => [
                                [
                                    'action' => 'ANONYMIZED|BLOCKED',
                                    'match' => '<string>',
                                    'type' => 'ADDRESS|AGE|AWS_ACCESS_KEY|AWS_SECRET_KEY|CA_HEALTH_NUMBER|CA_SOCIAL_INSURANCE_NUMBER|CREDIT_DEBIT_CARD_CVV|CREDIT_DEBIT_CARD_EXPIRY|CREDIT_DEBIT_CARD_NUMBER|DRIVER_ID|EMAIL|INTERNATIONAL_BANK_ACCOUNT_NUMBER|IP_ADDRESS|LICENSE_PLATE|MAC_ADDRESS|NAME|PASSWORD|PHONE|PIN|SWIFT_CODE|UK_NATIONAL_HEALTH_SERVICE_NUMBER|UK_NATIONAL_INSURANCE_NUMBER|UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER|URL|USERNAME|US_BANK_ACCOUNT_NUMBER|US_BANK_ROUTING_NUMBER|US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER|US_PASSPORT_NUMBER|US_SOCIAL_SECURITY_NUMBER|VEHICLE_IDENTIFICATION_NUMBER',
                                ],
                                // ...
                            ],
                            'regexes' => [
                                [
                                    'action' => 'ANONYMIZED|BLOCKED',
                                    'match' => '<string>',
                                    'name' => '<string>',
                                    'regex' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'topicPolicy' => [
                            'topics' => [
                                [
                                    'action' => 'BLOCKED',
                                    'name' => '<string>',
                                    'type' => 'DENY',
                                ],
                                // ...
                            ],
                        ],
                        'wordPolicy' => [
                            'customWords' => [
                                [
                                    'action' => 'BLOCKED',
                                    'match' => '<string>',
                                ],
                                // ...
                            ],
                            'managedWordLists' => [
                                [
                                    'action' => 'BLOCKED',
                                    'match' => '<string>',
                                    'type' => 'PROFANITY',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    // ...
                ],
                // ...
            ],
        ],
        'promptRouter' => [
            'invokedModelId' => '<string>',
        ],
    ],
    'usage' => [
        'inputTokens' => <integer>,
        'outputTokens' => <integer>,
        'totalTokens' => <integer>,
    ],
]

Result Details

Errors

AccessDeniedException:

The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see AccessDeniedException in the Amazon Bedrock User Guide

ResourceNotFoundException:

The specified resource ARN was not found. For troubleshooting this error, see ResourceNotFound in the Amazon Bedrock User Guide

ThrottlingException:

Your request was denied due to exceeding the account quotas for Amazon Bedrock. For troubleshooting this error, see ThrottlingException in the Amazon Bedrock User Guide

ModelTimeoutException:

The request took too long to process. Processing time exceeded the model timeout length.

InternalServerException:

An internal server error occurred. For troubleshooting this error, see InternalFailure in the Amazon Bedrock User Guide

ServiceUnavailableException:

The service isn't currently available. For troubleshooting this error, see ServiceUnavailable in the Amazon Bedrock User Guide

ValidationException:

The input fails to satisfy the constraints specified by Amazon Bedrock. For troubleshooting this error, see ValidationError in the Amazon Bedrock User Guide

ModelNotReadyException:

The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see Retry behavior in the AWS SDKs and Tools reference guide.

ModelErrorException:

The request failed due to an error while processing the model.

ConverseStream

$result = $client->converseStream([/* ... */]);
$promise = $client->converseStreamAsync([/* ... */]);

Sends messages to the specified Amazon Bedrock model and returns the response in a stream. ConverseStream provides a consistent API that works with all Amazon Bedrock models that support messages. This allows you to write code once and use it with different models. Should a model have unique inference parameters, you can also pass those unique parameters to the model.

To find out if a model supports streaming, call GetFoundationModel and check the responseStreamingSupported field in the response.

Amazon Bedrock doesn't store any text, images, or documents that you provide as content. The data is only used to generate the response.

You can submit a prompt by including it in the messages field, specifying the modelId of a foundation model or inference profile to run inference on it, and including any other fields that are relevant to your use case.

You can also submit a prompt from Prompt management by specifying the ARN of the prompt version and including a map of variables to values in the promptVariables field. You can append more messages to the prompt by using the messages field. If you use a prompt from Prompt management, you can't include the following fields in the request: additionalModelRequestFields, inferenceConfig, system, or toolConfig. Instead, these fields must be defined through Prompt management. For more information, see Use a prompt from Prompt management.

For information about the Converse API, see Use the Converse API in the Amazon Bedrock User Guide. To use a guardrail, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide. To use a tool with a model, see Tool use (Function calling) in the Amazon Bedrock User Guide

For example code, see Conversation streaming example in the Amazon Bedrock User Guide.

This operation requires permission for the bedrock:InvokeModelWithResponseStream action.

For troubleshooting some of the common errors you might encounter when using the ConverseStream API, see Troubleshooting Amazon Bedrock API Error Codes in the Amazon Bedrock User Guide

Parameter Syntax

$result = $client->converseStream([
    'additionalModelRequestFields' => [
    ],
    'additionalModelResponseFieldPaths' => ['<string>', ...],
    'guardrailConfig' => [
        'guardrailIdentifier' => '<string>', // REQUIRED
        'guardrailVersion' => '<string>', // REQUIRED
        'streamProcessingMode' => 'sync|async',
        'trace' => 'enabled|disabled',
    ],
    'inferenceConfig' => [
        'maxTokens' => <integer>,
        'stopSequences' => ['<string>', ...],
        'temperature' => <float>,
        'topP' => <float>,
    ],
    'messages' => [
        [
            'content' => [ // REQUIRED
                [
                    'document' => [
                        'format' => 'pdf|csv|doc|docx|xls|xlsx|html|txt|md', // REQUIRED
                        'name' => '<string>', // REQUIRED
                        'source' => [ // REQUIRED
                            'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                        ],
                    ],
                    'guardContent' => [
                        'image' => [
                            'format' => 'png|jpeg', // REQUIRED
                            'source' => [ // REQUIRED
                                'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                            ],
                        ],
                        'text' => [
                            'qualifiers' => ['<string>', ...],
                            'text' => '<string>', // REQUIRED
                        ],
                    ],
                    'image' => [
                        'format' => 'png|jpeg|gif|webp', // REQUIRED
                        'source' => [ // REQUIRED
                            'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                        ],
                    ],
                    'text' => '<string>',
                    'toolResult' => [
                        'content' => [ // REQUIRED
                            [
                                'document' => [
                                    'format' => 'pdf|csv|doc|docx|xls|xlsx|html|txt|md', // REQUIRED
                                    'name' => '<string>', // REQUIRED
                                    'source' => [ // REQUIRED
                                        'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                                    ],
                                ],
                                'image' => [
                                    'format' => 'png|jpeg|gif|webp', // REQUIRED
                                    'source' => [ // REQUIRED
                                        'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                                    ],
                                ],
                                'json' => [
                                ],
                                'text' => '<string>',
                                'video' => [
                                    'format' => 'mkv|mov|mp4|webm|flv|mpeg|mpg|wmv|three_gp', // REQUIRED
                                    'source' => [ // REQUIRED
                                        'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                                        's3Location' => [
                                            'bucketOwner' => '<string>',
                                            'uri' => '<string>', // REQUIRED
                                        ],
                                    ],
                                ],
                            ],
                            // ...
                        ],
                        'status' => 'success|error',
                        'toolUseId' => '<string>', // REQUIRED
                    ],
                    'toolUse' => [
                        'input' => [ // REQUIRED
                        ],
                        'name' => '<string>', // REQUIRED
                        'toolUseId' => '<string>', // REQUIRED
                    ],
                    'video' => [
                        'format' => 'mkv|mov|mp4|webm|flv|mpeg|mpg|wmv|three_gp', // REQUIRED
                        'source' => [ // REQUIRED
                            'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                            's3Location' => [
                                'bucketOwner' => '<string>',
                                'uri' => '<string>', // REQUIRED
                            ],
                        ],
                    ],
                ],
                // ...
            ],
            'role' => 'user|assistant', // REQUIRED
        ],
        // ...
    ],
    'modelId' => '<string>', // REQUIRED
    'performanceConfig' => [
        'latency' => 'standard|optimized',
    ],
    'promptVariables' => [
        '<String>' => [
            'text' => '<string>',
        ],
        // ...
    ],
    'requestMetadata' => ['<string>', ...],
    'system' => [
        [
            'guardContent' => [
                'image' => [
                    'format' => 'png|jpeg', // REQUIRED
                    'source' => [ // REQUIRED
                        'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                    ],
                ],
                'text' => [
                    'qualifiers' => ['<string>', ...],
                    'text' => '<string>', // REQUIRED
                ],
            ],
            'text' => '<string>',
        ],
        // ...
    ],
    'toolConfig' => [
        'toolChoice' => [
            'any' => [
            ],
            'auto' => [
            ],
            'tool' => [
                'name' => '<string>', // REQUIRED
            ],
        ],
        'tools' => [ // REQUIRED
            [
                'toolSpec' => [
                    'description' => '<string>',
                    'inputSchema' => [ // REQUIRED
                        'json' => [
                        ],
                    ],
                    'name' => '<string>', // REQUIRED
                ],
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'stream' => [ // EventParsingIterator
        'contentBlockDelta' => [
            'contentBlockIndex' => <integer>,
            'delta' => [
                'text' => '<string>',
                'toolUse' => [
                    'input' => '<string>',
                ],
            ],
        ],
        'contentBlockStart' => [
            'contentBlockIndex' => <integer>,
            'start' => [
                'toolUse' => [
                    'name' => '<string>',
                    'toolUseId' => '<string>',
                ],
            ],
        ],
        'contentBlockStop' => [
            'contentBlockIndex' => <integer>,
        ],
        'internalServerException' => [
            'message' => '<string>',
        ],
        'messageStart' => [
            'role' => 'user|assistant',
        ],
        'messageStop' => [
            'additionalModelResponseFields' => [
            ],
            'stopReason' => 'end_turn|tool_use|max_tokens|stop_sequence|guardrail_intervened|content_filtered',
        ],
        'metadata' => [
            'metrics' => [
                'latencyMs' => <integer>,
            ],
            'performanceConfig' => [
                'latency' => 'standard|optimized',
            ],
            'trace' => [
                'guardrail' => [
                    'inputAssessment' => [
                        '<String>' => [
                            'contentPolicy' => [
                                'filters' => [
                                    [
                                        'action' => 'BLOCKED',
                                        'confidence' => 'NONE|LOW|MEDIUM|HIGH',
                                        'filterStrength' => 'NONE|LOW|MEDIUM|HIGH',
                                        'type' => 'INSULTS|HATE|SEXUAL|VIOLENCE|MISCONDUCT|PROMPT_ATTACK',
                                    ],
                                    // ...
                                ],
                            ],
                            'contextualGroundingPolicy' => [
                                'filters' => [
                                    [
                                        'action' => 'BLOCKED|NONE',
                                        'score' => <float>,
                                        'threshold' => <float>,
                                        'type' => 'GROUNDING|RELEVANCE',
                                    ],
                                    // ...
                                ],
                            ],
                            'invocationMetrics' => [
                                'guardrailCoverage' => [
                                    'images' => [
                                        'guarded' => <integer>,
                                        'total' => <integer>,
                                    ],
                                    'textCharacters' => [
                                        'guarded' => <integer>,
                                        'total' => <integer>,
                                    ],
                                ],
                                'guardrailProcessingLatency' => <integer>,
                                'usage' => [
                                    'contentPolicyUnits' => <integer>,
                                    'contextualGroundingPolicyUnits' => <integer>,
                                    'sensitiveInformationPolicyFreeUnits' => <integer>,
                                    'sensitiveInformationPolicyUnits' => <integer>,
                                    'topicPolicyUnits' => <integer>,
                                    'wordPolicyUnits' => <integer>,
                                ],
                            ],
                            'sensitiveInformationPolicy' => [
                                'piiEntities' => [
                                    [
                                        'action' => 'ANONYMIZED|BLOCKED',
                                        'match' => '<string>',
                                        'type' => 'ADDRESS|AGE|AWS_ACCESS_KEY|AWS_SECRET_KEY|CA_HEALTH_NUMBER|CA_SOCIAL_INSURANCE_NUMBER|CREDIT_DEBIT_CARD_CVV|CREDIT_DEBIT_CARD_EXPIRY|CREDIT_DEBIT_CARD_NUMBER|DRIVER_ID|EMAIL|INTERNATIONAL_BANK_ACCOUNT_NUMBER|IP_ADDRESS|LICENSE_PLATE|MAC_ADDRESS|NAME|PASSWORD|PHONE|PIN|SWIFT_CODE|UK_NATIONAL_HEALTH_SERVICE_NUMBER|UK_NATIONAL_INSURANCE_NUMBER|UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER|URL|USERNAME|US_BANK_ACCOUNT_NUMBER|US_BANK_ROUTING_NUMBER|US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER|US_PASSPORT_NUMBER|US_SOCIAL_SECURITY_NUMBER|VEHICLE_IDENTIFICATION_NUMBER',
                                    ],
                                    // ...
                                ],
                                'regexes' => [
                                    [
                                        'action' => 'ANONYMIZED|BLOCKED',
                                        'match' => '<string>',
                                        'name' => '<string>',
                                        'regex' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                            'topicPolicy' => [
                                'topics' => [
                                    [
                                        'action' => 'BLOCKED',
                                        'name' => '<string>',
                                        'type' => 'DENY',
                                    ],
                                    // ...
                                ],
                            ],
                            'wordPolicy' => [
                                'customWords' => [
                                    [
                                        'action' => 'BLOCKED',
                                        'match' => '<string>',
                                    ],
                                    // ...
                                ],
                                'managedWordLists' => [
                                    [
                                        'action' => 'BLOCKED',
                                        'match' => '<string>',
                                        'type' => 'PROFANITY',
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        // ...
                    ],
                    'modelOutput' => ['<string>', ...],
                    'outputAssessments' => [
                        '<String>' => [
                            [
                                'contentPolicy' => [
                                    'filters' => [
                                        [
                                            'action' => 'BLOCKED',
                                            'confidence' => 'NONE|LOW|MEDIUM|HIGH',
                                            'filterStrength' => 'NONE|LOW|MEDIUM|HIGH',
                                            'type' => 'INSULTS|HATE|SEXUAL|VIOLENCE|MISCONDUCT|PROMPT_ATTACK',
                                        ],
                                        // ...
                                    ],
                                ],
                                'contextualGroundingPolicy' => [
                                    'filters' => [
                                        [
                                            'action' => 'BLOCKED|NONE',
                                            'score' => <float>,
                                            'threshold' => <float>,
                                            'type' => 'GROUNDING|RELEVANCE',
                                        ],
                                        // ...
                                    ],
                                ],
                                'invocationMetrics' => [
                                    'guardrailCoverage' => [
                                        'images' => [
                                            'guarded' => <integer>,
                                            'total' => <integer>,
                                        ],
                                        'textCharacters' => [
                                            'guarded' => <integer>,
                                            'total' => <integer>,
                                        ],
                                    ],
                                    'guardrailProcessingLatency' => <integer>,
                                    'usage' => [
                                        'contentPolicyUnits' => <integer>,
                                        'contextualGroundingPolicyUnits' => <integer>,
                                        'sensitiveInformationPolicyFreeUnits' => <integer>,
                                        'sensitiveInformationPolicyUnits' => <integer>,
                                        'topicPolicyUnits' => <integer>,
                                        'wordPolicyUnits' => <integer>,
                                    ],
                                ],
                                'sensitiveInformationPolicy' => [
                                    'piiEntities' => [
                                        [
                                            'action' => 'ANONYMIZED|BLOCKED',
                                            'match' => '<string>',
                                            'type' => 'ADDRESS|AGE|AWS_ACCESS_KEY|AWS_SECRET_KEY|CA_HEALTH_NUMBER|CA_SOCIAL_INSURANCE_NUMBER|CREDIT_DEBIT_CARD_CVV|CREDIT_DEBIT_CARD_EXPIRY|CREDIT_DEBIT_CARD_NUMBER|DRIVER_ID|EMAIL|INTERNATIONAL_BANK_ACCOUNT_NUMBER|IP_ADDRESS|LICENSE_PLATE|MAC_ADDRESS|NAME|PASSWORD|PHONE|PIN|SWIFT_CODE|UK_NATIONAL_HEALTH_SERVICE_NUMBER|UK_NATIONAL_INSURANCE_NUMBER|UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER|URL|USERNAME|US_BANK_ACCOUNT_NUMBER|US_BANK_ROUTING_NUMBER|US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER|US_PASSPORT_NUMBER|US_SOCIAL_SECURITY_NUMBER|VEHICLE_IDENTIFICATION_NUMBER',
                                        ],
                                        // ...
                                    ],
                                    'regexes' => [
                                        [
                                            'action' => 'ANONYMIZED|BLOCKED',
                                            'match' => '<string>',
                                            'name' => '<string>',
                                            'regex' => '<string>',
                                        ],
                                        // ...
                                    ],
                                ],
                                'topicPolicy' => [
                                    'topics' => [
                                        [
                                            'action' => 'BLOCKED',
                                            'name' => '<string>',
                                            'type' => 'DENY',
                                        ],
                                        // ...
                                    ],
                                ],
                                'wordPolicy' => [
                                    'customWords' => [
                                        [
                                            'action' => 'BLOCKED',
                                            'match' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'managedWordLists' => [
                                        [
                                            'action' => 'BLOCKED',
                                            'match' => '<string>',
                                            'type' => 'PROFANITY',
                                        ],
                                        // ...
                                    ],
                                ],
                            ],
                            // ...
                        ],
                        // ...
                    ],
                ],
                'promptRouter' => [
                    'invokedModelId' => '<string>',
                ],
            ],
            'usage' => [
                'inputTokens' => <integer>,
                'outputTokens' => <integer>,
                'totalTokens' => <integer>,
            ],
        ],
        'modelStreamErrorException' => [
            'message' => '<string>',
            'originalMessage' => '<string>',
            'originalStatusCode' => <integer>,
        ],
        'serviceUnavailableException' => [
            'message' => '<string>',
        ],
        'throttlingException' => [
            'message' => '<string>',
        ],
        'validationException' => [
            'message' => '<string>',
        ],
    ],
]

Result Details

Using an EventParsingIterator

To use an EventParsingIterator, you will need to loop over the events it will generate and check the top-level field to determine which type of event it is.

foreach($result['stream'] as $event) {
    if (isset($event['contentBlockDelta'])) {
        // Handle the 'contentBlockDelta' event.
    } else if (isset($event['contentBlockStart'])) {
        // Handle the 'contentBlockStart' event.
    } else if (isset($event['contentBlockStop'])) {
        // Handle the 'contentBlockStop' event.
    } else if (isset($event['internalServerException'])) {
        // Handle the 'internalServerException' event.
    } else if (isset($event['messageStart'])) {
        // Handle the 'messageStart' event.
    } else if (isset($event['messageStop'])) {
        // Handle the 'messageStop' event.
    } else if (isset($event['metadata'])) {
        // Handle the 'metadata' event.
    } else if (isset($event['modelStreamErrorException'])) {
        // Handle the 'modelStreamErrorException' event.
    } else if (isset($event['serviceUnavailableException'])) {
        // Handle the 'serviceUnavailableException' event.
    } else if (isset($event['throttlingException'])) {
        // Handle the 'throttlingException' event.
    } else if (isset($event['validationException'])) {
        // Handle the 'validationException' event.
    }
}

Errors

AccessDeniedException:

The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see AccessDeniedException in the Amazon Bedrock User Guide

ResourceNotFoundException:

The specified resource ARN was not found. For troubleshooting this error, see ResourceNotFound in the Amazon Bedrock User Guide

ThrottlingException:

Your request was denied due to exceeding the account quotas for Amazon Bedrock. For troubleshooting this error, see ThrottlingException in the Amazon Bedrock User Guide

ModelTimeoutException:

The request took too long to process. Processing time exceeded the model timeout length.

InternalServerException:

An internal server error occurred. For troubleshooting this error, see InternalFailure in the Amazon Bedrock User Guide

ServiceUnavailableException:

The service isn't currently available. For troubleshooting this error, see ServiceUnavailable in the Amazon Bedrock User Guide

ValidationException:

The input fails to satisfy the constraints specified by Amazon Bedrock. For troubleshooting this error, see ValidationError in the Amazon Bedrock User Guide

ModelNotReadyException:

The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see Retry behavior in the AWS SDKs and Tools reference guide.

ModelErrorException:

The request failed due to an error while processing the model.

GetAsyncInvoke

$result = $client->getAsyncInvoke([/* ... */]);
$promise = $client->getAsyncInvokeAsync([/* ... */]);

Retrieve information about an asynchronous invocation.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'clientRequestToken' => '<string>',
    'endTime' => <DateTime>,
    'failureMessage' => '<string>',
    'invocationArn' => '<string>',
    'lastModifiedTime' => <DateTime>,
    'modelArn' => '<string>',
    'outputDataConfig' => [
        's3OutputDataConfig' => [
            'bucketOwner' => '<string>',
            'kmsKeyId' => '<string>',
            's3Uri' => '<string>',
        ],
    ],
    'status' => 'InProgress|Completed|Failed',
    'submitTime' => <DateTime>,
]

Result Details

Errors

AccessDeniedException:

The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see AccessDeniedException in the Amazon Bedrock User Guide

ThrottlingException:

Your request was denied due to exceeding the account quotas for Amazon Bedrock. For troubleshooting this error, see ThrottlingException in the Amazon Bedrock User Guide

InternalServerException:

An internal server error occurred. For troubleshooting this error, see InternalFailure in the Amazon Bedrock User Guide

ValidationException:

The input fails to satisfy the constraints specified by Amazon Bedrock. For troubleshooting this error, see ValidationError in the Amazon Bedrock User Guide

InvokeModel

$result = $client->invokeModel([/* ... */]);
$promise = $client->invokeModelAsync([/* ... */]);

Invokes the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. You use model inference to generate text, images, and embeddings.

For example code, see Invoke model code examples in the Amazon Bedrock User Guide.

This operation requires permission for the bedrock:InvokeModel action.

For troubleshooting some of the common errors you might encounter when using the InvokeModel API, see Troubleshooting Amazon Bedrock API Error Codes in the Amazon Bedrock User Guide

Parameter Syntax

$result = $client->invokeModel([
    'accept' => '<string>',
    'body' => <string || resource || Psr\Http\Message\StreamInterface>,
    'contentType' => '<string>',
    'guardrailIdentifier' => '<string>',
    'guardrailVersion' => '<string>',
    'modelId' => '<string>', // REQUIRED
    'performanceConfigLatency' => 'standard|optimized',
    'trace' => 'ENABLED|DISABLED',
]);

Parameter Details

Result Syntax

[
    'body' => <string || resource || Psr\Http\Message\StreamInterface>,
    'contentType' => '<string>',
    'performanceConfigLatency' => 'standard|optimized',
]

Result Details

Errors

AccessDeniedException:

The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see AccessDeniedException in the Amazon Bedrock User Guide

ResourceNotFoundException:

The specified resource ARN was not found. For troubleshooting this error, see ResourceNotFound in the Amazon Bedrock User Guide

ThrottlingException:

Your request was denied due to exceeding the account quotas for Amazon Bedrock. For troubleshooting this error, see ThrottlingException in the Amazon Bedrock User Guide

ModelTimeoutException:

The request took too long to process. Processing time exceeded the model timeout length.

InternalServerException:

An internal server error occurred. For troubleshooting this error, see InternalFailure in the Amazon Bedrock User Guide

ServiceUnavailableException:

The service isn't currently available. For troubleshooting this error, see ServiceUnavailable in the Amazon Bedrock User Guide

ValidationException:

The input fails to satisfy the constraints specified by Amazon Bedrock. For troubleshooting this error, see ValidationError in the Amazon Bedrock User Guide

ModelNotReadyException:

The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see Retry behavior in the AWS SDKs and Tools reference guide.

ServiceQuotaExceededException:

Your request exceeds the service quota for your account. You can view your quotas at Viewing service quotas. You can resubmit your request later.

ModelErrorException:

The request failed due to an error while processing the model.

InvokeModelWithResponseStream

$result = $client->invokeModelWithResponseStream([/* ... */]);
$promise = $client->invokeModelWithResponseStreamAsync([/* ... */]);

Invoke the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. The response is returned in a stream.

To see if a model supports streaming, call GetFoundationModel and check the responseStreamingSupported field in the response.

For example code, see Invoke model with streaming code example in the Amazon Bedrock User Guide.

This operation requires permissions to perform the bedrock:InvokeModelWithResponseStream action.

For troubleshooting some of the common errors you might encounter when using the InvokeModelWithResponseStream API, see Troubleshooting Amazon Bedrock API Error Codes in the Amazon Bedrock User Guide

Parameter Syntax

$result = $client->invokeModelWithResponseStream([
    'accept' => '<string>',
    'body' => <string || resource || Psr\Http\Message\StreamInterface>,
    'contentType' => '<string>',
    'guardrailIdentifier' => '<string>',
    'guardrailVersion' => '<string>',
    'modelId' => '<string>', // REQUIRED
    'performanceConfigLatency' => 'standard|optimized',
    'trace' => 'ENABLED|DISABLED',
]);

Parameter Details

Result Syntax

[
    'body' => [ // EventParsingIterator
        'chunk' => [
            'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
        ],
        'internalServerException' => [
            'message' => '<string>',
        ],
        'modelStreamErrorException' => [
            'message' => '<string>',
            'originalMessage' => '<string>',
            'originalStatusCode' => <integer>,
        ],
        'modelTimeoutException' => [
            'message' => '<string>',
        ],
        'serviceUnavailableException' => [
            'message' => '<string>',
        ],
        'throttlingException' => [
            'message' => '<string>',
        ],
        'validationException' => [
            'message' => '<string>',
        ],
    ],
    'contentType' => '<string>',
    'performanceConfigLatency' => 'standard|optimized',
]

Result Details

Using an EventParsingIterator

To use an EventParsingIterator, you will need to loop over the events it will generate and check the top-level field to determine which type of event it is.

foreach($result['body'] as $event) {
    if (isset($event['chunk'])) {
        // Handle the 'chunk' event.
    } else if (isset($event['internalServerException'])) {
        // Handle the 'internalServerException' event.
    } else if (isset($event['modelStreamErrorException'])) {
        // Handle the 'modelStreamErrorException' event.
    } else if (isset($event['modelTimeoutException'])) {
        // Handle the 'modelTimeoutException' event.
    } else if (isset($event['serviceUnavailableException'])) {
        // Handle the 'serviceUnavailableException' event.
    } else if (isset($event['throttlingException'])) {
        // Handle the 'throttlingException' event.
    } else if (isset($event['validationException'])) {
        // Handle the 'validationException' event.
    }
}

Errors

AccessDeniedException:

The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see AccessDeniedException in the Amazon Bedrock User Guide

ResourceNotFoundException:

The specified resource ARN was not found. For troubleshooting this error, see ResourceNotFound in the Amazon Bedrock User Guide

ThrottlingException:

Your request was denied due to exceeding the account quotas for Amazon Bedrock. For troubleshooting this error, see ThrottlingException in the Amazon Bedrock User Guide

ModelTimeoutException:

The request took too long to process. Processing time exceeded the model timeout length.

InternalServerException:

An internal server error occurred. For troubleshooting this error, see InternalFailure in the Amazon Bedrock User Guide

ServiceUnavailableException:

The service isn't currently available. For troubleshooting this error, see ServiceUnavailable in the Amazon Bedrock User Guide

ModelStreamErrorException:

An error occurred while streaming the response. Retry your request.

ValidationException:

The input fails to satisfy the constraints specified by Amazon Bedrock. For troubleshooting this error, see ValidationError in the Amazon Bedrock User Guide

ModelNotReadyException:

The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see Retry behavior in the AWS SDKs and Tools reference guide.

ServiceQuotaExceededException:

Your request exceeds the service quota for your account. You can view your quotas at Viewing service quotas. You can resubmit your request later.

ModelErrorException:

The request failed due to an error while processing the model.

ListAsyncInvokes

$result = $client->listAsyncInvokes([/* ... */]);
$promise = $client->listAsyncInvokesAsync([/* ... */]);

Lists asynchronous invocations.

Parameter Syntax

$result = $client->listAsyncInvokes([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortBy' => 'SubmissionTime',
    'sortOrder' => 'Ascending|Descending',
    'statusEquals' => 'InProgress|Completed|Failed',
    'submitTimeAfter' => <integer || string || DateTime>,
    'submitTimeBefore' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'asyncInvokeSummaries' => [
        [
            'clientRequestToken' => '<string>',
            'endTime' => <DateTime>,
            'failureMessage' => '<string>',
            'invocationArn' => '<string>',
            'lastModifiedTime' => <DateTime>,
            'modelArn' => '<string>',
            'outputDataConfig' => [
                's3OutputDataConfig' => [
                    'bucketOwner' => '<string>',
                    'kmsKeyId' => '<string>',
                    's3Uri' => '<string>',
                ],
            ],
            'status' => 'InProgress|Completed|Failed',
            'submitTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see AccessDeniedException in the Amazon Bedrock User Guide

ThrottlingException:

Your request was denied due to exceeding the account quotas for Amazon Bedrock. For troubleshooting this error, see ThrottlingException in the Amazon Bedrock User Guide

InternalServerException:

An internal server error occurred. For troubleshooting this error, see InternalFailure in the Amazon Bedrock User Guide

ValidationException:

The input fails to satisfy the constraints specified by Amazon Bedrock. For troubleshooting this error, see ValidationError in the Amazon Bedrock User Guide

StartAsyncInvoke

$result = $client->startAsyncInvoke([/* ... */]);
$promise = $client->startAsyncInvokeAsync([/* ... */]);

Starts an asynchronous invocation.

This operation requires permission for the bedrock:InvokeModel action.

Parameter Syntax

$result = $client->startAsyncInvoke([
    'clientRequestToken' => '<string>',
    'modelId' => '<string>', // REQUIRED
    'modelInput' => [ // REQUIRED
    ],
    'outputDataConfig' => [ // REQUIRED
        's3OutputDataConfig' => [
            'bucketOwner' => '<string>',
            'kmsKeyId' => '<string>',
            's3Uri' => '<string>', // REQUIRED
        ],
    ],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'invocationArn' => '<string>',
]

Result Details

Errors

AccessDeniedException:

The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see AccessDeniedException in the Amazon Bedrock User Guide

ResourceNotFoundException:

The specified resource ARN was not found. For troubleshooting this error, see ResourceNotFound in the Amazon Bedrock User Guide

ThrottlingException:

Your request was denied due to exceeding the account quotas for Amazon Bedrock. For troubleshooting this error, see ThrottlingException in the Amazon Bedrock User Guide

InternalServerException:

An internal server error occurred. For troubleshooting this error, see InternalFailure in the Amazon Bedrock User Guide

ServiceUnavailableException:

The service isn't currently available. For troubleshooting this error, see ServiceUnavailable in the Amazon Bedrock User Guide

ValidationException:

The input fails to satisfy the constraints specified by Amazon Bedrock. For troubleshooting this error, see ValidationError in the Amazon Bedrock User Guide

ServiceQuotaExceededException:

Your request exceeds the service quota for your account. You can view your quotas at Viewing service quotas. You can resubmit your request later.

ConflictException:

Error occurred because of a conflict while performing an operation.