BatchDeleteAdvancedPromptOptimizationJob

$result = $client->batchDeleteAdvancedPromptOptimizationJob([/* ... */]);
$promise = $client->batchDeleteAdvancedPromptOptimizationJobAsync([/* ... */]);

Deletes one or more advanced prompt optimization jobs.

Parameter Syntax

$result = $client->batchDeleteAdvancedPromptOptimizationJob([
    'jobIdentifiers' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'advancedPromptOptimizationJobs' => [
        [
            'jobIdentifier' => '<string>',
            'jobStatus' => 'InProgress|Completed|Failed|PartiallyCompleted|Stopping|Stopped|Deleting',
        ],
        // ...
    ],
    'errors' => [
        [
            'code' => '<string>',
            'jobIdentifier' => '<string>',
            'message' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

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.

ThrottlingException:

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

BatchDeleteEvaluationJob

$result = $client->batchDeleteEvaluationJob([/* ... */]);
$promise = $client->batchDeleteEvaluationJobAsync([/* ... */]);

Deletes a batch of evaluation jobs. An evaluation job can only be deleted if it has following status FAILED, COMPLETED, and STOPPED. You can request up to 25 model evaluation jobs be deleted in a single request.

Parameter Syntax

$result = $client->batchDeleteEvaluationJob([
    'jobIdentifiers' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'code' => '<string>',
            'jobIdentifier' => '<string>',
            'message' => '<string>',
        ],
        // ...
    ],
    'evaluationJobs' => [
        [
            'jobIdentifier' => '<string>',
            'jobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped|Deleting',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

ThrottlingException:

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

Examples

Example 1: Delete evaluation jobs

The following example shows a request to delete two model evaluation jobs, where one of the jobs is not found.

$result = $client->batchDeleteEvaluationJob([
    'jobIdentifiers' => [
        'arn:aws:bedrock:us-east-2:123456789012:evaluation-job/12rnxmplqv0v',
        'arn:aws:bedrock:us-east-2:123456789012:evaluation-job/rispxmpl12rn',
    ],
]);

Result syntax:

[
    'errors' => [
        [
            'code' => '404',
            'jobIdentifier' => 'arn:aws:bedrock:us-east-2:123456789012:evaluation-job/rispxmpl12rn',
            'message' => 'Unable to locate this job to delete.',
        ],
    ],
    'evaluationJobs' => [
        [
            'jobIdentifier' => 'arn:aws:bedrock:us-east-2:123456789012:evaluation-job/12rnxmplqv0v',
            'jobStatus' => 'Deleting',
        ],
    ],
]

CancelAutomatedReasoningPolicyBuildWorkflow

$result = $client->cancelAutomatedReasoningPolicyBuildWorkflow([/* ... */]);
$promise = $client->cancelAutomatedReasoningPolicyBuildWorkflowAsync([/* ... */]);

Cancels a running Automated Reasoning policy build workflow. This stops the policy generation process and prevents further processing of the source documents.

Parameter Syntax

$result = $client->cancelAutomatedReasoningPolicyBuildWorkflow([
    'buildWorkflowId' => '<string>', // REQUIRED
    'policyArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

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.

ThrottlingException:

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

CreateAdvancedPromptOptimizationJob

$result = $client->createAdvancedPromptOptimizationJob([/* ... */]);
$promise = $client->createAdvancedPromptOptimizationJobAsync([/* ... */]);

Creates an advanced prompt optimization job. The job optimizes your prompt templates for specific models using your evaluation dataset and criteria.

Parameter Syntax

$result = $client->createAdvancedPromptOptimizationJob([
    'clientToken' => '<string>',
    'encryptionKeyArn' => '<string>',
    'inputConfig' => [ // REQUIRED
        's3Uri' => '<string>', // REQUIRED
    ],
    'jobDescription' => '<string>',
    'jobName' => '<string>', // REQUIRED
    'modelConfigurations' => [ // REQUIRED
        [
            'additionalModelRequestFields' => [
                '<AdditionalModelRequestFieldsKey>' => [
                ],
                // ...
            ],
            'inferenceConfig' => [
                'maxTokens' => <integer>,
                'stopSequences' => ['<string>', ...],
                'temperature' => <float>,
                'topP' => <float>,
            ],
            'modelId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'outputConfig' => [ // REQUIRED
        's3Uri' => '<string>', // REQUIRED
    ],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

TooManyTagsException:

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

ServiceQuotaExceededException:

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

ThrottlingException:

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

CreateAutomatedReasoningPolicy

$result = $client->createAutomatedReasoningPolicy([/* ... */]);
$promise = $client->createAutomatedReasoningPolicyAsync([/* ... */]);

Creates an Automated Reasoning policy for Amazon Bedrock Guardrails. Automated Reasoning policies use mathematical techniques to detect hallucinations, suggest corrections, and highlight unstated assumptions in the responses of your GenAI application.

To create a policy, you upload a source document that describes the rules that you're encoding. Automated Reasoning extracts important concepts from the source document that will become variables in the policy and infers policy rules.

Parameter Syntax

$result = $client->createAutomatedReasoningPolicy([
    'clientRequestToken' => '<string>',
    'description' => '<string>',
    'kmsKeyId' => '<string>',
    'name' => '<string>', // REQUIRED
    'policyDefinition' => [
        'rules' => [
            [
                'alternateExpression' => '<string>',
                'expression' => '<string>', // REQUIRED
                'id' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'types' => [
            [
                'description' => '<string>',
                'name' => '<string>', // REQUIRED
                'values' => [ // REQUIRED
                    [
                        'description' => '<string>',
                        'value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'variables' => [
            [
                'description' => '<string>', // REQUIRED
                'name' => '<string>', // REQUIRED
                'type' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'version' => '<string>',
    ],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'definitionHash' => '<string>',
    'description' => '<string>',
    'name' => '<string>',
    'policyArn' => '<string>',
    'updatedAt' => <DateTime>,
    'version' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

TooManyTagsException:

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

ServiceQuotaExceededException:

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

ThrottlingException:

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

CreateAutomatedReasoningPolicyTestCase

$result = $client->createAutomatedReasoningPolicyTestCase([/* ... */]);
$promise = $client->createAutomatedReasoningPolicyTestCaseAsync([/* ... */]);

Creates a test for an Automated Reasoning policy. Tests validate that your policy works as expected by providing sample inputs and expected outcomes. Use tests to verify policy behavior before deploying to production.

Parameter Syntax

$result = $client->createAutomatedReasoningPolicyTestCase([
    'clientRequestToken' => '<string>',
    'confidenceThreshold' => <float>,
    'expectedAggregatedFindingsResult' => 'VALID|INVALID|SATISFIABLE|IMPOSSIBLE|TRANSLATION_AMBIGUOUS|TOO_COMPLEX|NO_TRANSLATION', // REQUIRED
    'guardContent' => '<string>', // REQUIRED
    'policyArn' => '<string>', // REQUIRED
    'queryContent' => '<string>',
]);

Parameter Details

Result Syntax

[
    'policyArn' => '<string>',
    'testCaseId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

ServiceQuotaExceededException:

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

ThrottlingException:

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

CreateAutomatedReasoningPolicyVersion

$result = $client->createAutomatedReasoningPolicyVersion([/* ... */]);
$promise = $client->createAutomatedReasoningPolicyVersionAsync([/* ... */]);

Creates a new version of an existing Automated Reasoning policy. This allows you to iterate on your policy rules while maintaining previous versions for rollback or comparison purposes.

Parameter Syntax

$result = $client->createAutomatedReasoningPolicyVersion([
    'clientRequestToken' => '<string>',
    'lastUpdatedDefinitionHash' => '<string>', // REQUIRED
    'policyArn' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'definitionHash' => '<string>',
    'description' => '<string>',
    'name' => '<string>',
    'policyArn' => '<string>',
    'version' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

TooManyTagsException:

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

ServiceQuotaExceededException:

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

ThrottlingException:

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

CreateCustomModel

$result = $client->createCustomModel([/* ... */]);
$promise = $client->createCustomModelAsync([/* ... */]);

Creates a new custom model in Amazon Bedrock. After the model is active, you can use it for inference.

You can provide the model data source in one of the following ways:

• customModelDataSource — Specify a SageMaker AI model package ARN. Amazon Bedrock resolves the model package to retrieve the model artifacts. This is the preferred method for new SageMaker AI training outputs.

• modelSourceConfig — Specify an Amazon S3 URI pointing to the Amazon-managed Amazon S3 bucket containing your model artifacts.

To use the model for inference, you must purchase Provisioned Throughput for it. You can't use On-demand inference with these custom models. For more information about Provisioned Throughput, see Provisioned Throughput.

The model appears in ListCustomModels with a customizationType of imported. To track the status of the new model, you use the GetCustomModel API operation. The model can be in the following states:

• Creating - Initial state during validation and registration

• Active - Model is ready for use in inference

• Failed - Creation process encountered an error

Related APIs

• GetCustomModel

• ListCustomModels

• DeleteCustomModel

Parameter Syntax

$result = $client->createCustomModel([
    'clientRequestToken' => '<string>',
    'customModelDataSource' => [
        'modelPackageArnDataSource' => [
            'modelPackageArn' => '<string>', // REQUIRED
        ],
    ],
    'modelKmsKeyArn' => '<string>',
    'modelName' => '<string>', // REQUIRED
    'modelSourceConfig' => [
        's3DataSource' => [
            's3Uri' => '<string>', // REQUIRED
        ],
    ],
    'modelTags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'roleArn' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

TooManyTagsException:

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

ServiceQuotaExceededException:

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

ThrottlingException:

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

Examples

Example 1: Successful CreateCustomModel API call

$result = $client->createCustomModel([
    'clientRequestToken' => 'foo',
    'modelKmsKeyArn' => 'arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab',
    'modelName' => 'SampleModel',
    'modelSourceConfig' => [
        's3DataSource' => [
            's3Uri' => 's3://my-bucket/folder',
        ],
    ],
    'modelTags' => [
        [
            'key' => 'foo',
            'value' => 'foo',
        ],
        [
            'key' => 'foo',
            'value' => 'foo',
        ],
    ],
    'roleArn' => 'arn:aws:iam::123456789012:role/SampleRole',
]);

Result syntax:

[
    'modelArn' => 'arn:aws:bedrock:us-east-1:123456789012:custom-model/imported/abcdef123456',
]

CreateCustomModelDeployment

$result = $client->createCustomModelDeployment([/* ... */]);
$promise = $client->createCustomModelDeploymentAsync([/* ... */]);

Deploys a custom model for on-demand inference in Amazon Bedrock. After you deploy your custom model, you use the deployment's Amazon Resource Name (ARN) as the modelId parameter when you submit prompts and generate responses with model inference.

For more information about setting up on-demand inference for custom models, see Set up inference for a custom model.

The following actions are related to the CreateCustomModelDeployment operation:

• GetCustomModelDeployment

• ListCustomModelDeployments

• DeleteCustomModelDeployment

Parameter Syntax

$result = $client->createCustomModelDeployment([
    'clientRequestToken' => '<string>',
    'description' => '<string>',
    'modelArn' => '<string>', // REQUIRED
    'modelDeploymentName' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

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.

TooManyTagsException:

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

ServiceQuotaExceededException:

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

ThrottlingException:

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

CreateEvaluationJob

$result = $client->createEvaluationJob([/* ... */]);
$promise = $client->createEvaluationJobAsync([/* ... */]);

Creates an evaluation job.

Parameter Syntax

$result = $client->createEvaluationJob([
    'applicationType' => 'ModelEvaluation|RagEvaluation',
    'clientRequestToken' => '<string>',
    'customerEncryptionKeyId' => '<string>',
    'evaluationConfig' => [ // REQUIRED
        'automated' => [
            'customMetricConfig' => [
                'customMetrics' => [ // REQUIRED
                    [
                        'customMetricDefinition' => [
                            'instructions' => '<string>', // REQUIRED
                            'name' => '<string>', // REQUIRED
                            'ratingScale' => [
                                [
                                    'definition' => '<string>', // REQUIRED
                                    'value' => [ // REQUIRED
                                        'floatValue' => <float>,
                                        'stringValue' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                        ],
                    ],
                    // ...
                ],
                'evaluatorModelConfig' => [ // REQUIRED
                    'bedrockEvaluatorModels' => [ // REQUIRED
                        [
                            'modelIdentifier' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                ],
            ],
            'datasetMetricConfigs' => [ // REQUIRED
                [
                    'dataset' => [ // REQUIRED
                        'datasetLocation' => [
                            's3Uri' => '<string>',
                        ],
                        'name' => '<string>', // REQUIRED
                    ],
                    'metricNames' => ['<string>', ...], // REQUIRED
                    'taskType' => 'Summarization|Classification|QuestionAndAnswer|Generation|Custom', // REQUIRED
                ],
                // ...
            ],
            'evaluatorModelConfig' => [
                'bedrockEvaluatorModels' => [
                    [
                        'modelIdentifier' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
        ],
        'human' => [
            'customMetrics' => [
                [
                    'description' => '<string>',
                    'name' => '<string>', // REQUIRED
                    'ratingMethod' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'datasetMetricConfigs' => [ // REQUIRED
                [
                    'dataset' => [ // REQUIRED
                        'datasetLocation' => [
                            's3Uri' => '<string>',
                        ],
                        'name' => '<string>', // REQUIRED
                    ],
                    'metricNames' => ['<string>', ...], // REQUIRED
                    'taskType' => 'Summarization|Classification|QuestionAndAnswer|Generation|Custom', // REQUIRED
                ],
                // ...
            ],
            'humanWorkflowConfig' => [
                'flowDefinitionArn' => '<string>', // REQUIRED
                'instructions' => '<string>',
            ],
        ],
    ],
    'inferenceConfig' => [ // REQUIRED
        'models' => [
            [
                'bedrockModel' => [
                    'inferenceParams' => '<string>',
                    'modelIdentifier' => '<string>', // REQUIRED
                    'performanceConfig' => [
                        'latency' => 'standard|optimized',
                    ],
                ],
                'precomputedInferenceSource' => [
                    'inferenceSourceIdentifier' => '<string>', // REQUIRED
                ],
            ],
            // ...
        ],
        'ragConfigs' => [
            [
                'knowledgeBaseConfig' => [
                    'retrieveAndGenerateConfig' => [
                        'externalSourcesConfiguration' => [
                            'generationConfiguration' => [
                                'additionalModelRequestFields' => [
                                    '<AdditionalModelRequestFieldsKey>' => [
                                    ],
                                    // ...
                                ],
                                'guardrailConfiguration' => [
                                    'guardrailId' => '<string>', // REQUIRED
                                    'guardrailVersion' => '<string>', // REQUIRED
                                ],
                                'kbInferenceConfig' => [
                                    'textInferenceConfig' => [
                                        'maxTokens' => <integer>,
                                        'stopSequences' => ['<string>', ...],
                                        'temperature' => <float>,
                                        'topP' => <float>,
                                    ],
                                ],
                                'promptTemplate' => [
                                    'textPromptTemplate' => '<string>',
                                ],
                            ],
                            'modelArn' => '<string>', // REQUIRED
                            'sources' => [ // REQUIRED
                                [
                                    'byteContent' => [
                                        'contentType' => '<string>', // REQUIRED
                                        'data' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
                                        'identifier' => '<string>', // REQUIRED
                                    ],
                                    's3Location' => [
                                        'uri' => '<string>', // REQUIRED
                                    ],
                                    'sourceType' => 'S3|BYTE_CONTENT', // REQUIRED
                                ],
                                // ...
                            ],
                        ],
                        'knowledgeBaseConfiguration' => [
                            'generationConfiguration' => [
                                'additionalModelRequestFields' => [
                                    '<AdditionalModelRequestFieldsKey>' => [
                                    ],
                                    // ...
                                ],
                                'guardrailConfiguration' => [
                                    'guardrailId' => '<string>', // REQUIRED
                                    'guardrailVersion' => '<string>', // REQUIRED
                                ],
                                'kbInferenceConfig' => [
                                    'textInferenceConfig' => [
                                        'maxTokens' => <integer>,
                                        'stopSequences' => ['<string>', ...],
                                        'temperature' => <float>,
                                        'topP' => <float>,
                                    ],
                                ],
                                'promptTemplate' => [
                                    'textPromptTemplate' => '<string>',
                                ],
                            ],
                            'knowledgeBaseId' => '<string>', // REQUIRED
                            'modelArn' => '<string>', // REQUIRED
                            'orchestrationConfiguration' => [
                                'queryTransformationConfiguration' => [ // REQUIRED
                                    'type' => 'QUERY_DECOMPOSITION', // REQUIRED
                                ],
                            ],
                            'retrievalConfiguration' => [
                                'vectorSearchConfiguration' => [ // REQUIRED
                                    'filter' => [
                                        'andAll' => [
                                            [...], // RECURSIVE
                                            // ...
                                        ],
                                        'equals' => [
                                            'key' => '<string>', // REQUIRED
                                            'value' => [ // REQUIRED
                                            ],
                                        ],
                                        'greaterThan' => [
                                            'key' => '<string>', // REQUIRED
                                            'value' => [ // REQUIRED
                                            ],
                                        ],
                                        'greaterThanOrEquals' => [
                                            'key' => '<string>', // REQUIRED
                                            'value' => [ // REQUIRED
                                            ],
                                        ],
                                        'in' => [
                                            'key' => '<string>', // REQUIRED
                                            'value' => [ // REQUIRED
                                            ],
                                        ],
                                        'lessThan' => [
                                            'key' => '<string>', // REQUIRED
                                            'value' => [ // REQUIRED
                                            ],
                                        ],
                                        'lessThanOrEquals' => [
                                            'key' => '<string>', // REQUIRED
                                            'value' => [ // REQUIRED
                                            ],
                                        ],
                                        'listContains' => [
                                            'key' => '<string>', // REQUIRED
                                            'value' => [ // REQUIRED
                                            ],
                                        ],
                                        'notEquals' => [
                                            'key' => '<string>', // REQUIRED
                                            'value' => [ // REQUIRED
                                            ],
                                        ],
                                        'notIn' => [
                                            'key' => '<string>', // REQUIRED
                                            'value' => [ // REQUIRED
                                            ],
                                        ],
                                        'orAll' => [
                                            [...], // RECURSIVE
                                            // ...
                                        ],
                                        'startsWith' => [
                                            'key' => '<string>', // REQUIRED
                                            'value' => [ // REQUIRED
                                            ],
                                        ],
                                        'stringContains' => [
                                            'key' => '<string>', // REQUIRED
                                            'value' => [ // REQUIRED
                                            ],
                                        ],
                                    ],
                                    'implicitFilterConfiguration' => [
                                        'metadataAttributes' => [ // REQUIRED
                                            [
                                                'description' => '<string>', // REQUIRED
                                                'key' => '<string>', // REQUIRED
                                                'type' => 'STRING|NUMBER|BOOLEAN|STRING_LIST', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                        'modelArn' => '<string>', // REQUIRED
                                    ],
                                    'numberOfResults' => <integer>,
                                    'overrideSearchType' => 'HYBRID|SEMANTIC',
                                    'rerankingConfiguration' => [
                                        'bedrockRerankingConfiguration' => [
                                            'metadataConfiguration' => [
                                                'selectionMode' => 'SELECTIVE|ALL', // REQUIRED
                                                'selectiveModeConfiguration' => [
                                                    'fieldsToExclude' => [
                                                        [
                                                            'fieldName' => '<string>', // REQUIRED
                                                        ],
                                                        // ...
                                                    ],
                                                    'fieldsToInclude' => [
                                                        [
                                                            'fieldName' => '<string>', // REQUIRED
                                                        ],
                                                        // ...
                                                    ],
                                                ],
                                            ],
                                            'modelConfiguration' => [ // REQUIRED
                                                'additionalModelRequestFields' => [
                                                    '<AdditionalModelRequestFieldsKey>' => [
                                                    ],
                                                    // ...
                                                ],
                                                'modelArn' => '<string>', // REQUIRED
                                            ],
                                            'numberOfRerankedResults' => <integer>,
                                        ],
                                        'type' => 'BEDROCK_RERANKING_MODEL', // REQUIRED
                                    ],
                                ],
                            ],
                        ],
                        'type' => 'KNOWLEDGE_BASE|EXTERNAL_SOURCES', // REQUIRED
                    ],
                    'retrieveConfig' => [
                        'knowledgeBaseId' => '<string>', // REQUIRED
                        'knowledgeBaseRetrievalConfiguration' => [ // REQUIRED
                            'vectorSearchConfiguration' => [ // REQUIRED
                                'filter' => [
                                    'andAll' => [
                                        [...], // RECURSIVE
                                        // ...
                                    ],
                                    'equals' => [
                                        'key' => '<string>', // REQUIRED
                                        'value' => [ // REQUIRED
                                        ],
                                    ],
                                    'greaterThan' => [
                                        'key' => '<string>', // REQUIRED
                                        'value' => [ // REQUIRED
                                        ],
                                    ],
                                    'greaterThanOrEquals' => [
                                        'key' => '<string>', // REQUIRED
                                        'value' => [ // REQUIRED
                                        ],
                                    ],
                                    'in' => [
                                        'key' => '<string>', // REQUIRED
                                        'value' => [ // REQUIRED
                                        ],
                                    ],
                                    'lessThan' => [
                                        'key' => '<string>', // REQUIRED
                                        'value' => [ // REQUIRED
                                        ],
                                    ],
                                    'lessThanOrEquals' => [
                                        'key' => '<string>', // REQUIRED
                                        'value' => [ // REQUIRED
                                        ],
                                    ],
                                    'listContains' => [
                                        'key' => '<string>', // REQUIRED
                                        'value' => [ // REQUIRED
                                        ],
                                    ],
                                    'notEquals' => [
                                        'key' => '<string>', // REQUIRED
                                        'value' => [ // REQUIRED
                                        ],
                                    ],
                                    'notIn' => [
                                        'key' => '<string>', // REQUIRED
                                        'value' => [ // REQUIRED
                                        ],
                                    ],
                                    'orAll' => [
                                        [...], // RECURSIVE
                                        // ...
                                    ],
                                    'startsWith' => [
                                        'key' => '<string>', // REQUIRED
                                        'value' => [ // REQUIRED
                                        ],
                                    ],
                                    'stringContains' => [
                                        'key' => '<string>', // REQUIRED
                                        'value' => [ // REQUIRED
                                        ],
                                    ],
                                ],
                                'implicitFilterConfiguration' => [
                                    'metadataAttributes' => [ // REQUIRED
                                        [
                                            'description' => '<string>', // REQUIRED
                                            'key' => '<string>', // REQUIRED
                                            'type' => 'STRING|NUMBER|BOOLEAN|STRING_LIST', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'modelArn' => '<string>', // REQUIRED
                                ],
                                'numberOfResults' => <integer>,
                                'overrideSearchType' => 'HYBRID|SEMANTIC',
                                'rerankingConfiguration' => [
                                    'bedrockRerankingConfiguration' => [
                                        'metadataConfiguration' => [
                                            'selectionMode' => 'SELECTIVE|ALL', // REQUIRED
                                            'selectiveModeConfiguration' => [
                                                'fieldsToExclude' => [
                                                    [
                                                        'fieldName' => '<string>', // REQUIRED
                                                    ],
                                                    // ...
                                                ],
                                                'fieldsToInclude' => [
                                                    [
                                                        'fieldName' => '<string>', // REQUIRED
                                                    ],
                                                    // ...
                                                ],
                                            ],
                                        ],
                                        'modelConfiguration' => [ // REQUIRED
                                            'additionalModelRequestFields' => [
                                                '<AdditionalModelRequestFieldsKey>' => [
                                                ],
                                                // ...
                                            ],
                                            'modelArn' => '<string>', // REQUIRED
                                        ],
                                        'numberOfRerankedResults' => <integer>,
                                    ],
                                    'type' => 'BEDROCK_RERANKING_MODEL', // REQUIRED
                                ],
                            ],
                        ],
                    ],
                ],
                'precomputedRagSourceConfig' => [
                    'retrieveAndGenerateSourceConfig' => [
                        'ragSourceIdentifier' => '<string>', // REQUIRED
                    ],
                    'retrieveSourceConfig' => [
                        'ragSourceIdentifier' => '<string>', // REQUIRED
                    ],
                ],
            ],
            // ...
        ],
    ],
    'jobDescription' => '<string>',
    'jobName' => '<string>', // REQUIRED
    'jobTags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'outputDataConfig' => [ // REQUIRED
        's3Uri' => '<string>', // REQUIRED
    ],
    'roleArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

ServiceQuotaExceededException:

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

ThrottlingException:

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

CreateFoundationModelAgreement

$result = $client->createFoundationModelAgreement([/* ... */]);
$promise = $client->createFoundationModelAgreementAsync([/* ... */]);

Request a model access agreement for the specified model.

Parameter Syntax

$result = $client->createFoundationModelAgreement([
    'modelId' => '<string>', // REQUIRED
    'offerToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

ThrottlingException:

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

CreateGuardrail

$result = $client->createGuardrail([/* ... */]);
$promise = $client->createGuardrailAsync([/* ... */]);

Creates a guardrail to block topics and to implement safeguards for your generative AI applications.

You can configure the following policies in a guardrail to avoid undesirable and harmful content, filter out denied topics and words, and remove sensitive information for privacy protection.

• Content filters - Adjust filter strengths to block input prompts or model responses containing harmful content.

• Denied topics - Define a set of topics that are undesirable in the context of your application. These topics will be blocked if detected in user queries or model responses.

• Word filters - Configure filters to block undesirable words, phrases, and profanity. Such words can include offensive terms, competitor names etc.

• Sensitive information filters - Block or mask sensitive information such as personally identifiable information (PII) or custom regex in user inputs and model responses.

In addition to the above policies, you can also configure the messages to be returned to the user if a user input or model response is in violation of the policies defined in the guardrail.

For more information, see Amazon Bedrock Guardrails in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->createGuardrail([
    'automatedReasoningPolicyConfig' => [
        'confidenceThreshold' => <float>,
        'policies' => ['<string>', ...], // REQUIRED
    ],
    'blockedInputMessaging' => '<string>', // REQUIRED
    'blockedOutputsMessaging' => '<string>', // REQUIRED
    'clientRequestToken' => '<string>',
    'contentPolicyConfig' => [
        'filtersConfig' => [ // REQUIRED
            [
                'inputAction' => 'BLOCK|NONE',
                'inputEnabled' => true || false,
                'inputModalities' => ['<string>', ...],
                'inputStrength' => 'NONE|LOW|MEDIUM|HIGH', // REQUIRED
                'outputAction' => 'BLOCK|NONE',
                'outputEnabled' => true || false,
                'outputModalities' => ['<string>', ...],
                'outputStrength' => 'NONE|LOW|MEDIUM|HIGH', // REQUIRED
                'type' => 'SEXUAL|VIOLENCE|HATE|INSULTS|MISCONDUCT|PROMPT_ATTACK', // REQUIRED
            ],
            // ...
        ],
        'tierConfig' => [
            'tierName' => 'CLASSIC|STANDARD', // REQUIRED
        ],
    ],
    'contextualGroundingPolicyConfig' => [
        'filtersConfig' => [ // REQUIRED
            [
                'action' => 'BLOCK|NONE',
                'enabled' => true || false,
                'threshold' => <float>, // REQUIRED
                'type' => 'GROUNDING|RELEVANCE', // REQUIRED
            ],
            // ...
        ],
    ],
    'crossRegionConfig' => [
        'guardrailProfileIdentifier' => '<string>', // REQUIRED
    ],
    'description' => '<string>',
    'kmsKeyId' => '<string>',
    'name' => '<string>', // REQUIRED
    'sensitiveInformationPolicyConfig' => [
        'piiEntitiesConfig' => [
            [
                'action' => 'BLOCK|ANONYMIZE|NONE', // REQUIRED
                'inputAction' => 'BLOCK|ANONYMIZE|NONE',
                'inputEnabled' => true || false,
                'outputAction' => 'BLOCK|ANONYMIZE|NONE',
                'outputEnabled' => true || false,
                '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', // REQUIRED
            ],
            // ...
        ],
        'regexesConfig' => [
            [
                'action' => 'BLOCK|ANONYMIZE|NONE', // REQUIRED
                'description' => '<string>',
                'inputAction' => 'BLOCK|ANONYMIZE|NONE',
                'inputEnabled' => true || false,
                'name' => '<string>', // REQUIRED
                'outputAction' => 'BLOCK|ANONYMIZE|NONE',
                'outputEnabled' => true || false,
                'pattern' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'topicPolicyConfig' => [
        'tierConfig' => [
            'tierName' => 'CLASSIC|STANDARD', // REQUIRED
        ],
        'topicsConfig' => [ // REQUIRED
            [
                'definition' => '<string>', // REQUIRED
                'examples' => ['<string>', ...],
                'inputAction' => 'BLOCK|NONE',
                'inputEnabled' => true || false,
                'name' => '<string>', // REQUIRED
                'outputAction' => 'BLOCK|NONE',
                'outputEnabled' => true || false,
                'type' => 'DENY', // REQUIRED
            ],
            // ...
        ],
    ],
    'wordPolicyConfig' => [
        'managedWordListsConfig' => [
            [
                'inputAction' => 'BLOCK|NONE',
                'inputEnabled' => true || false,
                'outputAction' => 'BLOCK|NONE',
                'outputEnabled' => true || false,
                'type' => 'PROFANITY', // REQUIRED
            ],
            // ...
        ],
        'wordsConfig' => [
            [
                'inputAction' => 'BLOCK|NONE',
                'inputEnabled' => true || false,
                'outputAction' => 'BLOCK|NONE',
                'outputEnabled' => true || false,
                'text' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'guardrailArn' => '<string>',
    'guardrailId' => '<string>',
    'version' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

TooManyTagsException:

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

ServiceQuotaExceededException:

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

ThrottlingException:

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

CreateGuardrailVersion

$result = $client->createGuardrailVersion([/* ... */]);
$promise = $client->createGuardrailVersionAsync([/* ... */]);

Creates a version of the guardrail. Use this API to create a snapshot of the guardrail when you are satisfied with a configuration, or to compare the configuration with another version.

Parameter Syntax

$result = $client->createGuardrailVersion([
    'clientRequestToken' => '<string>',
    'description' => '<string>',
    'guardrailIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'guardrailId' => '<string>',
    'version' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

ServiceQuotaExceededException:

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

ThrottlingException:

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

CreateInferenceProfile

$result = $client->createInferenceProfile([/* ... */]);
$promise = $client->createInferenceProfileAsync([/* ... */]);

Creates an application inference profile to track metrics and costs when invoking a model. To create an application inference profile for a foundation model in one region, specify the ARN of the model in that region. To create an application inference profile for a foundation model across multiple regions, specify the ARN of the system-defined inference profile that contains the regions that you want to route requests to. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->createInferenceProfile([
    'clientRequestToken' => '<string>',
    'description' => '<string>',
    'inferenceProfileName' => '<string>', // REQUIRED
    'modelSource' => [ // REQUIRED
        'copyFrom' => '<string>',
    ],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'inferenceProfileArn' => '<string>',
    'status' => 'ACTIVE',
]

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

TooManyTagsException:

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

ServiceQuotaExceededException:

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

ThrottlingException:

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

CreateMarketplaceModelEndpoint

$result = $client->createMarketplaceModelEndpoint([/* ... */]);
$promise = $client->createMarketplaceModelEndpointAsync([/* ... */]);

Creates an endpoint for a model from Amazon Bedrock Marketplace. The endpoint is hosted by Amazon SageMaker.

Parameter Syntax

$result = $client->createMarketplaceModelEndpoint([
    'acceptEula' => true || false,
    'clientRequestToken' => '<string>',
    'endpointConfig' => [ // REQUIRED
        'sageMaker' => [
            'executionRole' => '<string>', // REQUIRED
            'initialInstanceCount' => <integer>, // REQUIRED
            'instanceType' => '<string>', // REQUIRED
            'kmsEncryptionKey' => '<string>',
            'vpc' => [
                'securityGroupIds' => ['<string>', ...], // REQUIRED
                'subnetIds' => ['<string>', ...], // REQUIRED
            ],
        ],
    ],
    'endpointName' => '<string>', // REQUIRED
    'modelSourceIdentifier' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'marketplaceModelEndpoint' => [
        'createdAt' => <DateTime>,
        'endpointArn' => '<string>',
        'endpointConfig' => [
            'sageMaker' => [
                'executionRole' => '<string>',
                'initialInstanceCount' => <integer>,
                'instanceType' => '<string>',
                'kmsEncryptionKey' => '<string>',
                'vpc' => [
                    'securityGroupIds' => ['<string>', ...],
                    'subnetIds' => ['<string>', ...],
                ],
            ],
        ],
        'endpointStatus' => '<string>',
        'endpointStatusMessage' => '<string>',
        'modelSourceIdentifier' => '<string>',
        'status' => 'REGISTERED|INCOMPATIBLE_ENDPOINT',
        'statusMessage' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

ServiceQuotaExceededException:

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

ThrottlingException:

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

CreateModelCopyJob

$result = $client->createModelCopyJob([/* ... */]);
$promise = $client->createModelCopyJobAsync([/* ... */]);

Copies a model to another region so that it can be used there. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->createModelCopyJob([
    'clientRequestToken' => '<string>',
    'modelKmsKeyId' => '<string>',
    'sourceModelArn' => '<string>', // REQUIRED
    'targetModelName' => '<string>', // REQUIRED
    'targetModelTags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

InternalServerException:

An internal server error occurred. Retry your request.

TooManyTagsException:

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

CreateModelCustomizationJob

$result = $client->createModelCustomizationJob([/* ... */]);
$promise = $client->createModelCustomizationJobAsync([/* ... */]);

Creates a fine-tuning job to customize a base model.

You specify the base foundation model and the location of the training data. After the model-customization job completes successfully, your custom model resource will be ready to use. Amazon Bedrock returns validation loss metrics and output generations after the job completes.

For information on the format of training and validation data, see Prepare the datasets.

Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size. To monitor a job, use the GetModelCustomizationJob operation to retrieve the job status.

For more information, see Custom models in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->createModelCustomizationJob([
    'baseModelIdentifier' => '<string>', // REQUIRED
    'clientRequestToken' => '<string>',
    'customModelKmsKeyId' => '<string>',
    'customModelName' => '<string>', // REQUIRED
    'customModelTags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'customizationConfig' => [
        'distillationConfig' => [
            'teacherModelConfig' => [ // REQUIRED
                'maxResponseLengthForInference' => <integer>,
                'teacherModelIdentifier' => '<string>', // REQUIRED
            ],
        ],
        'rftConfig' => [
            'graderConfig' => [
                'lambdaGrader' => [
                    'lambdaArn' => '<string>', // REQUIRED
                ],
            ],
            'hyperParameters' => [
                'batchSize' => <integer>,
                'epochCount' => <integer>,
                'evalInterval' => <integer>,
                'inferenceMaxTokens' => <integer>,
                'learningRate' => <float>,
                'maxPromptLength' => <integer>,
                'reasoningEffort' => 'low|medium|high',
                'trainingSamplePerPrompt' => <integer>,
            ],
        ],
    ],
    'customizationType' => 'FINE_TUNING|CONTINUED_PRE_TRAINING|DISTILLATION|REINFORCEMENT_FINE_TUNING|IMPORTED',
    'hyperParameters' => ['<string>', ...],
    'jobName' => '<string>', // REQUIRED
    'jobTags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'outputDataConfig' => [ // REQUIRED
        's3Uri' => '<string>', // REQUIRED
    ],
    'roleArn' => '<string>', // REQUIRED
    'trainingDataConfig' => [ // REQUIRED
        'invocationLogsConfig' => [
            'invocationLogSource' => [ // REQUIRED
                's3Uri' => '<string>',
            ],
            'requestMetadataFilters' => [
                'andAll' => [
                    [
                        'equals' => ['<string>', ...],
                        'notEquals' => ['<string>', ...],
                    ],
                    // ...
                ],
                'equals' => ['<string>', ...],
                'notEquals' => ['<string>', ...],
                'orAll' => [
                    [
                        'equals' => ['<string>', ...],
                        'notEquals' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'usePromptResponse' => true || false,
        ],
        's3Uri' => '<string>',
    ],
    'validationDataConfig' => [
        'validators' => [ // REQUIRED
            [
                's3Uri' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'vpcConfig' => [
        'securityGroupIds' => ['<string>', ...], // REQUIRED
        'subnetIds' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

TooManyTagsException:

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

ServiceQuotaExceededException:

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

ThrottlingException:

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

CreateModelImportJob

$result = $client->createModelImportJob([/* ... */]);
$promise = $client->createModelImportJobAsync([/* ... */]);

Creates a model import job to import model that you have customized in other environments, such as Amazon SageMaker. For more information, see Import a customized model

Parameter Syntax

$result = $client->createModelImportJob([
    'clientRequestToken' => '<string>',
    'importedModelKmsKeyId' => '<string>',
    'importedModelName' => '<string>', // REQUIRED
    'importedModelTags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'jobName' => '<string>', // REQUIRED
    'jobTags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'modelDataSource' => [ // REQUIRED
        's3DataSource' => [
            's3Uri' => '<string>', // REQUIRED
        ],
    ],
    'roleArn' => '<string>', // REQUIRED
    'vpcConfig' => [
        'securityGroupIds' => ['<string>', ...], // REQUIRED
        'subnetIds' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

TooManyTagsException:

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

ServiceQuotaExceededException:

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

ThrottlingException:

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

CreateModelInvocationJob

$result = $client->createModelInvocationJob([/* ... */]);
$promise = $client->createModelInvocationJobAsync([/* ... */]);

Creates a batch inference job to invoke a model on multiple prompts. Format your data according to Format your inference data and upload it to an Amazon S3 bucket. For more information, see Process multiple prompts with batch inference.

The response returns a jobArn that you can use to stop or get details about the job.

Parameter Syntax

$result = $client->createModelInvocationJob([
    'clientRequestToken' => '<string>',
    'inputDataConfig' => [ // REQUIRED
        's3InputDataConfig' => [
            's3BucketOwner' => '<string>',
            's3InputFormat' => 'JSONL',
            's3Uri' => '<string>', // REQUIRED
        ],
    ],
    'jobName' => '<string>', // REQUIRED
    'modelId' => '<string>', // REQUIRED
    'modelInvocationType' => 'InvokeModel|Converse',
    'outputDataConfig' => [ // REQUIRED
        's3OutputDataConfig' => [
            's3BucketOwner' => '<string>',
            's3EncryptionKeyId' => '<string>',
            's3Uri' => '<string>', // REQUIRED
        ],
    ],
    'roleArn' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'timeoutDurationInHours' => <integer>,
    'vpcConfig' => [
        'securityGroupIds' => ['<string>', ...], // REQUIRED
        'subnetIds' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

ServiceQuotaExceededException:

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

ThrottlingException:

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

CreatePromptRouter

$result = $client->createPromptRouter([/* ... */]);
$promise = $client->createPromptRouterAsync([/* ... */]);

Creates a prompt router that manages the routing of requests between multiple foundation models based on the routing criteria.

Parameter Syntax

$result = $client->createPromptRouter([
    'clientRequestToken' => '<string>',
    'description' => '<string>',
    'fallbackModel' => [ // REQUIRED
        'modelArn' => '<string>', // REQUIRED
    ],
    'models' => [ // REQUIRED
        [
            'modelArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'promptRouterName' => '<string>', // REQUIRED
    'routingCriteria' => [ // REQUIRED
        'responseQualityDifference' => <float>, // REQUIRED
    ],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

TooManyTagsException:

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

ServiceQuotaExceededException:

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

ThrottlingException:

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

CreateProvisionedModelThroughput

$result = $client->createProvisionedModelThroughput([/* ... */]);
$promise = $client->createProvisionedModelThroughputAsync([/* ... */]);

Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify. For pricing details, see Amazon Bedrock Pricing. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->createProvisionedModelThroughput([
    'clientRequestToken' => '<string>',
    'commitmentDuration' => 'OneMonth|SixMonths',
    'modelId' => '<string>', // REQUIRED
    'modelUnits' => <integer>, // REQUIRED
    'provisionedModelName' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

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.

TooManyTagsException:

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

ServiceQuotaExceededException:

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

ThrottlingException:

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

DeleteAutomatedReasoningPolicy

$result = $client->deleteAutomatedReasoningPolicy([/* ... */]);
$promise = $client->deleteAutomatedReasoningPolicyAsync([/* ... */]);

Deletes an Automated Reasoning policy or policy version. This operation is idempotent. If you delete a policy more than once, each call succeeds. Deleting a policy removes it permanently and cannot be undone.

Parameter Syntax

$result = $client->deleteAutomatedReasoningPolicy([
    'force' => true || false,
    'policyArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceInUseException:

Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail.

ThrottlingException:

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

DeleteAutomatedReasoningPolicyBuildWorkflow

$result = $client->deleteAutomatedReasoningPolicyBuildWorkflow([/* ... */]);
$promise = $client->deleteAutomatedReasoningPolicyBuildWorkflowAsync([/* ... */]);

Deletes an Automated Reasoning policy build workflow and its associated artifacts. This permanently removes the workflow history and any generated assets.

Parameter Syntax

$result = $client->deleteAutomatedReasoningPolicyBuildWorkflow([
    'buildWorkflowId' => '<string>', // REQUIRED
    'lastUpdatedAt' => <integer || string || DateTime>, // REQUIRED
    'policyArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceInUseException:

Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail.

ThrottlingException:

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

DeleteAutomatedReasoningPolicyTestCase

$result = $client->deleteAutomatedReasoningPolicyTestCase([/* ... */]);
$promise = $client->deleteAutomatedReasoningPolicyTestCaseAsync([/* ... */]);

Deletes an Automated Reasoning policy test. This operation is idempotent; if you delete a test more than once, each call succeeds.

Parameter Syntax

$result = $client->deleteAutomatedReasoningPolicyTestCase([
    'lastUpdatedAt' => <integer || string || DateTime>, // REQUIRED
    'policyArn' => '<string>', // REQUIRED
    'testCaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceInUseException:

Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail.

ThrottlingException:

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

DeleteCustomModel

$result = $client->deleteCustomModel([/* ... */]);
$promise = $client->deleteCustomModelAsync([/* ... */]);

Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

ThrottlingException:

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

DeleteCustomModelDeployment

$result = $client->deleteCustomModelDeployment([/* ... */]);
$promise = $client->deleteCustomModelDeploymentAsync([/* ... */]);

Deletes a custom model deployment. This operation stops the deployment and removes it from your account. After deletion, the deployment ARN can no longer be used for inference requests.

The following actions are related to the DeleteCustomModelDeployment operation:

• CreateCustomModelDeployment

• GetCustomModelDeployment

• ListCustomModelDeployments

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

ThrottlingException:

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

DeleteEnforcedGuardrailConfiguration

$result = $client->deleteEnforcedGuardrailConfiguration([/* ... */]);
$promise = $client->deleteEnforcedGuardrailConfigurationAsync([/* ... */]);

Deletes the account-level enforced guardrail configuration.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

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.

ThrottlingException:

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

DeleteFoundationModelAgreement

$result = $client->deleteFoundationModelAgreement([/* ... */]);
$promise = $client->deleteFoundationModelAgreementAsync([/* ... */]);

Delete the model access agreement for the specified model.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

ThrottlingException:

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

DeleteGuardrail

$result = $client->deleteGuardrail([/* ... */]);
$promise = $client->deleteGuardrailAsync([/* ... */]);

Deletes a guardrail.

• To delete a guardrail, only specify the ARN of the guardrail in the guardrailIdentifier field. If you delete a guardrail, all of its versions will be deleted.

• To delete a version of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier field and the version in the guardrailVersion field.

Parameter Syntax

$result = $client->deleteGuardrail([
    'guardrailIdentifier' => '<string>', // REQUIRED
    'guardrailVersion' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceInUseException:

Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail.

ThrottlingException:

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

DeleteImportedModel

$result = $client->deleteImportedModel([/* ... */]);
$promise = $client->deleteImportedModelAsync([/* ... */]);

Deletes a custom model that you imported earlier. For more information, see Import a customized model in the Amazon Bedrock User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

ThrottlingException:

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

DeleteInferenceProfile

$result = $client->deleteInferenceProfile([/* ... */]);
$promise = $client->deleteInferenceProfileAsync([/* ... */]);

Deletes an application inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

ThrottlingException:

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

DeleteMarketplaceModelEndpoint

$result = $client->deleteMarketplaceModelEndpoint([/* ... */]);
$promise = $client->deleteMarketplaceModelEndpointAsync([/* ... */]);

Deletes an endpoint for a model from Amazon Bedrock Marketplace.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

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.

ThrottlingException:

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

DeleteModelInvocationLoggingConfiguration

$result = $client->deleteModelInvocationLoggingConfiguration([/* ... */]);
$promise = $client->deleteModelInvocationLoggingConfigurationAsync([/* ... */]);

Delete the invocation logging.

Parameter Syntax

$result = $client->deleteModelInvocationLoggingConfiguration([
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

The request is denied because of missing access permissions.

InternalServerException:

An internal server error occurred. Retry your request.

ThrottlingException:

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

DeletePromptRouter

$result = $client->deletePromptRouter([/* ... */]);
$promise = $client->deletePromptRouterAsync([/* ... */]);

Deletes a specified prompt router. This action cannot be undone.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

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.

ThrottlingException:

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

DeleteProvisionedModelThroughput

$result = $client->deleteProvisionedModelThroughput([/* ... */]);
$promise = $client->deleteProvisionedModelThroughputAsync([/* ... */]);

Deletes a Provisioned Throughput. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

AccessDeniedException:

The request is denied because of missing access permissions.

ValidationException:

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

ConflictException:

Error occurred because of a conflict while performing an operation.

InternalServerException:

An internal server error occurred. Retry your request.

ThrottlingException:

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

DeleteResourcePolicy

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

Deletes a previously created Bedrock resource policy.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

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.

ThrottlingException:

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

DeregisterMarketplaceModelEndpoint

$result = $client->deregisterMarketplaceModelEndpoint([/* ... */]);
$promise = $client->deregisterMarketplaceModelEndpointAsync([/* ... */]);

Deregisters an endpoint for a model from Amazon Bedrock Marketplace. This operation removes the endpoint's association with Amazon Bedrock but does not delete the underlying Amazon SageMaker endpoint.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

ServiceUnavailableException:

Returned if the service cannot complete the request.

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.

ThrottlingException:

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

ExportAutomatedReasoningPolicyVersion

$result = $client->exportAutomatedReasoningPolicyVersion([/* ... */]);
$promise = $client->exportAutomatedReasoningPolicyVersionAsync([/* ... */]);

Exports the policy definition for an Automated Reasoning policy version. Returns the complete policy definition including rules, variables, and custom variable types in a structured format.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'policyDefinition' => [
        'rules' => [
            [
                'alternateExpression' => '<string>',
                'expression' => '<string>',
                'id' => '<string>',
            ],
            // ...
        ],
        'types' => [
            [
                'description' => '<string>',
                'name' => '<string>',
                'values' => [
                    [
                        'description' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'variables' => [
            [
                'description' => '<string>',
                'name' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
        'version' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

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

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.

ThrottlingException:

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

GetAccountDataRetention

$result = $client->getAccountDataRetention([/* ... */]);
$promise = $client->getAccountDataRetentionAsync([/* ... */]);

Returns the account-wide data retention mode for Amazon Bedrock.

Parameter Syntax

$result = $client->getAccountDataRetention([
]);

Parameter Details

Result Syntax

[
    'mode' => 'default|none|aws_review|provider_data_share|inherit',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

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.

ThrottlingException:

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

GetAdvancedPromptOptimizationJob

$result = $client->getAdvancedPromptOptimizationJob([/* ... */]);
$promise = $client->getAdvancedPromptOptimizationJobAsync([/* ... */]);

Gets information about an advanced prompt optimization job.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'creationTime' => <DateTime>,
    'encryptionKeyArn' => '<string>',
    'failureMessage' => '<string>',
    'inputConfig' => [
        's3Uri' => '<string>',
    ],
    'jobArn' => '<string>',
    'jobDescription' => '<string>',
    'jobName' => '<string>',
    'jobStatus' => 'InProgress|Completed|Failed|PartiallyCompleted|Stopping|Stopped|Deleting',
    'lastModifiedTime' => <DateTime>,
    'modelConfigurations' => [
        [
            'additionalModelRequestFields' => [
                '<AdditionalModelRequestFieldsKey>' => [
                ],
                // ...
            ],
            'inferenceConfig' => [
                'maxTokens' => <integer>,
                'stopSequences' => ['<string>', ...],
                'temperature' => <float>,
                'topP' => <float>,
            ],
            'modelId' => '<string>',
        ],
        // ...
    ],
    'outputConfig' => [
        's3Uri' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

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

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.

ThrottlingException:

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

GetAutomatedReasoningPolicy

$result = $client->getAutomatedReasoningPolicy([/* ... */]);
$promise = $client->getAutomatedReasoningPolicyAsync([/* ... */]);

Retrieves details about an Automated Reasoning policy or policy version. Returns information including the policy definition, metadata, and timestamps.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'definitionHash' => '<string>',
    'description' => '<string>',
    'kmsKeyArn' => '<string>',
    'name' => '<string>',
    'policyArn' => '<string>',
    'policyId' => '<string>',
    'updatedAt' => <DateTime>,
    'version' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

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

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.

ThrottlingException:

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

GetAutomatedReasoningPolicyAnnotations

$result = $client->getAutomatedReasoningPolicyAnnotations([/* ... */]);
$promise = $client->getAutomatedReasoningPolicyAnnotationsAsync([/* ... */]);

Retrieves the current annotations for an Automated Reasoning policy build workflow. Annotations contain corrections to the rules, variables and types to be applied to the policy.

Parameter Syntax

$result = $client->getAutomatedReasoningPolicyAnnotations([
    'buildWorkflowId' => '<string>', // REQUIRED
    'policyArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'annotationSetHash' => '<string>',
    'annotations' => [
        [
            'addRule' => [
                'expression' => '<string>',
            ],
            'addRuleFromNaturalLanguage' => [
                'naturalLanguage' => '<string>',
            ],
            'addType' => [
                'description' => '<string>',
                'name' => '<string>',
                'values' => [
                    [
                        'description' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'addVariable' => [
                'description' => '<string>',
                'name' => '<string>',
                'type' => '<string>',
            ],
            'deleteRule' => [
                'ruleId' => '<string>',
            ],
            'deleteType' => [
                'name' => '<string>',
            ],
            'deleteVariable' => [
                'name' => '<string>',
            ],
            'ingestContent' => [
                'content' => '<string>',
            ],
            'updateFromRulesFeedback' => [
                'feedback' => '<string>',
                'ruleIds' => ['<string>', ...],
            ],
            'updateFromScenarioFeedback' => [
                'feedback' => '<string>',
                'ruleIds' => ['<string>', ...],
                'scenarioExpression' => '<string>',
            ],
            'updateRule' => [
                'expression' => '<string>',
                'ruleId' => '<string>',
            ],
            'updateType' => [
                'description' => '<string>',
                'name' => '<string>',
                'newName' => '<string>',
                'values' => [
                    [
                        'addTypeValue' => [
                            'description' => '<string>',
                            'value' => '<string>',
                        ],
                        'deleteTypeValue' => [
                            'value' => '<string>',
                        ],
                        'updateTypeValue' => [
                            'description' => '<string>',
                            'newValue' => '<string>',
                            'value' => '<string>',
                        ],
                    ],
                    // ...
                ],
            ],
            'updateVariable' => [
                'description' => '<string>',
                'name' => '<string>',
                'newName' => '<string>',
            ],
        ],
        // ...
    ],
    'buildWorkflowId' => '<string>',
    'name' => '<string>',
    'policyArn' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

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

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.

ThrottlingException:

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

GetAutomatedReasoningPolicyBuildWorkflow

$result = $client->getAutomatedReasoningPolicyBuildWorkflow([/* ... */]);
$promise = $client->getAutomatedReasoningPolicyBuildWorkflowAsync([/* ... */]);

Retrieves detailed information about an Automated Reasoning policy build workflow, including its status, configuration, and metadata.

Parameter Syntax

$result = $client->getAutomatedReasoningPolicyBuildWorkflow([
    'buildWorkflowId' => '<string>', // REQUIRED
    'policyArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'buildWorkflowId' => '<string>',
    'buildWorkflowType' => 'INGEST_CONTENT|REFINE_POLICY|IMPORT_POLICY|GENERATE_FIDELITY_REPORT|GENERATE_POLICY_SCENARIOS|RESOLVE_POLICY_AMBIGUITIES|ITERATIVELY_REFINE_POLICY',
    'createdAt' => <DateTime>,
    'documentContentType' => 'pdf|txt',
    'documentDescription' => '<string>',
    'documentName' => '<string>',
    'policyArn' => '<string>',
    'status' => 'SCHEDULED|CANCEL_REQUESTED|PREPROCESSING|BUILDING|TESTING|COMPLETED|FAILED|CANCELLED',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

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

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.

ThrottlingException:

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

GetAutomatedReasoningPolicyBuildWorkflowResultAssets

$result = $client->getAutomatedReasoningPolicyBuildWorkflowResultAssets([/* ... */]);
$promise = $client->getAutomatedReasoningPolicyBuildWorkflowResultAssetsAsync([/* ... */]);

Retrieves the resulting assets from a completed Automated Reasoning policy build workflow, including build logs, quality reports, and generated policy artifacts.

Parameter Syntax

$result = $client->getAutomatedReasoningPolicyBuildWorkflowResultAssets([
    'assetId' => '<string>',
    'assetType' => 'BUILD_LOG|QUALITY_REPORT|POLICY_DEFINITION|GENERATED_TEST_CASES|POLICY_SCENARIOS|FIDELITY_REPORT|ASSET_MANIFEST|SOURCE_DOCUMENT', // REQUIRED
    'buildWorkflowId' => '<string>', // REQUIRED
    'policyArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'buildWorkflowAssets' => [
        'assetManifest' => [
            'entries' => [
                [
                    'assetId' => '<string>',
                    'assetName' => '<string>',
                    'assetType' => 'BUILD_LOG|QUALITY_REPORT|POLICY_DEFINITION|GENERATED_TEST_CASES|POLICY_SCENARIOS|FIDELITY_REPORT|ASSET_MANIFEST|SOURCE_DOCUMENT',
                ],
                // ...
            ],
        ],
        'buildLog' => [
            'entries' => [
                [
                    'annotation' => [
                        'addRule' => [
                            'expression' => '<string>',
                        ],
                        'addRuleFromNaturalLanguage' => [
                            'naturalLanguage' => '<string>',
                        ],
                        'addType' => [
                            'description' => '<string>',
                            'name' => '<string>',
                            'values' => [
                                [
                                    'description' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'addVariable' => [
                            'description' => '<string>',
                            'name' => '<string>',
                            'type' => '<string>',
                        ],
                        'deleteRule' => [
                            'ruleId' => '<string>',
                        ],
                        'deleteType' => [
                            'name' => '<string>',
                        ],
                        'deleteVariable' => [
                            'name' => '<string>',
                        ],
                        'ingestContent' => [
                            'content' => '<string>',
                        ],
                        'updateFromRulesFeedback' => [
                            'feedback' => '<string>',
                            'ruleIds' => ['<string>', ...],
                        ],
                        'updateFromScenarioFeedback' => [
                            'feedback' => '<string>',
                            'ruleIds' => ['<string>', ...],
                            'scenarioExpression' => '<string>',
                        ],
                        'updateRule' => [
                            'expression' => '<string>',
                            'ruleId' => '<string>',
                        ],
                        'updateType' => [
                            'description' => '<string>',
                            'name' => '<string>',
                            'newName' => '<string>',
                            'values' => [
                                [
                                    'addTypeValue' => [
                                        'description' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    'deleteTypeValue' => [
                                        'value' => '<string>',
                                    ],
                                    'updateTypeValue' => [
                                        'description' => '<string>',
                                        'newValue' => '<string>',
                                        'value' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                        ],
                        'updateVariable' => [
                            'description' => '<string>',
                            'name' => '<string>',
                            'newName' => '<string>',
                        ],
                    ],
                    'buildSteps' => [
                        [
                            'context' => [
                                'mutation' => [
                                    'addRule' => [
                                        'rule' => [
                                            'alternateExpression' => '<string>',
                                            'expression' => '<string>',
                                            'id' => '<string>',
                                        ],
                                    ],
                                    'addType' => [
                                        'type' => [
                                            'description' => '<string>',
                                            'name' => '<string>',
                                            'values' => [
                                                [
                                                    'description' => '<string>',
                                                    'value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'addVariable' => [
                                        'variable' => [
                                            'description' => '<string>',
                                            'name' => '<string>',
                                            'type' => '<string>',
                                        ],
                                    ],
                                    'deleteRule' => [
                                        'id' => '<string>',
                                    ],
                                    'deleteType' => [
                                        'name' => '<string>',
                                    ],
                                    'deleteVariable' => [
                                        'name' => '<string>',
                                    ],
                                    'updateRule' => [
                                        'rule' => [
                                            'alternateExpression' => '<string>',
                                            'expression' => '<string>',
                                            'id' => '<string>',
                                        ],
                                    ],
                                    'updateType' => [
                                        'type' => [
                                            'description' => '<string>',
                                            'name' => '<string>',
                                            'values' => [
                                                [
                                                    'description' => '<string>',
                                                    'value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'updateVariable' => [
                                        'variable' => [
                                            'description' => '<string>',
                                            'name' => '<string>',
                                            'type' => '<string>',
                                        ],
                                    ],
                                ],
                                'planning' => [
                                ],
                            ],
                            'messages' => [
                                [
                                    'message' => '<string>',
                                    'messageType' => 'INFO|WARNING|ERROR',
                                ],
                                // ...
                            ],
                            'priorElement' => [
                                'policyDefinitionRule' => [
                                    'alternateExpression' => '<string>',
                                    'expression' => '<string>',
                                    'id' => '<string>',
                                ],
                                'policyDefinitionType' => [
                                    'description' => '<string>',
                                    'name' => '<string>',
                                    'values' => [
                                        [
                                            'description' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                ],
                                'policyDefinitionVariable' => [
                                    'description' => '<string>',
                                    'name' => '<string>',
                                    'type' => '<string>',
                                ],
                            ],
                        ],
                        // ...
                    ],
                    'status' => 'APPLIED|FAILED',
                ],
                // ...
            ],
        ],
        'document' => [
            'document' => <string || resource || Psr\Http\Message\StreamInterface>,
            'documentContentType' => 'pdf|txt',
            'documentDescription' => '<string>',
            'documentHash' => '<string>',
            'documentName' => '<string>',
        ],
        'fidelityReport' => [
            'accuracyScore' => <float>,
            'coverageScore' => <float>,
            'documentSources' => [
                [
                    'atomicStatements' => [
                        [
                            'id' => '<string>',
                            'location' => [
                                'lines' => [<integer>, ...],
                            ],
                            'text' => '<string>',
                        ],
                        // ...
                    ],
                    'documentContent' => [
                        [
                            'content' => [
                                [
                                    'line' => [
                                        'lineNumber' => <integer>,
                                        'lineText' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                            'pageNumber' => <integer>,
                        ],
                        // ...
                    ],
                    'documentHash' => '<string>',
                    'documentId' => '<string>',
                    'documentName' => '<string>',
                ],
                // ...
            ],
            'ruleReports' => [
                '<AutomatedReasoningPolicyDefinitionRuleId>' => [
                    'accuracyJustification' => '<string>',
                    'accuracyScore' => <float>,
                    'groundingJustifications' => ['<string>', ...],
                    'groundingStatements' => [
                        [
                            'documentId' => '<string>',
                            'statementId' => '<string>',
                        ],
                        // ...
                    ],
                    'rule' => '<string>',
                ],
                // ...
            ],
            'variableReports' => [
                '<AutomatedReasoningPolicyDefinitionVariableName>' => [
                    'accuracyJustification' => '<string>',
                    'accuracyScore' => <float>,
                    'groundingJustifications' => ['<string>', ...],
                    'groundingStatements' => [
                        [
                            'documentId' => '<string>',
                            'statementId' => '<string>',
                        ],
                        // ...
                    ],
                    'policyVariable' => '<string>',
                ],
                // ...
            ],
        ],
        'generatedTestCases' => [
            'generatedTestCases' => [
                [
                    'expectedAggregatedFindingsResult' => 'VALID|INVALID|SATISFIABLE|IMPOSSIBLE|TRANSLATION_AMBIGUOUS|TOO_COMPLEX|NO_TRANSLATION',
                    'guardContent' => '<string>',
                    'queryContent' => '<string>',
                ],
                // ...
            ],
        ],
        'policyDefinition' => [
            'rules' => [
                [
                    'alternateExpression' => '<string>',
                    'expression' => '<string>',
                    'id' => '<string>',
                ],
                // ...
            ],
            'types' => [
                [
                    'description' => '<string>',
                    'name' => '<string>',
                    'values' => [
                        [
                            'description' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'variables' => [
                [
                    'description' => '<string>',
                    'name' => '<string>',
                    'type' => '<string>',
                ],
                // ...
            ],
            'version' => '<string>',
        ],
        'policyScenarios' => [
            'policyScenarios' => [
                [
                    'alternateExpression' => '<string>',
                    'expectedResult' => 'VALID|INVALID|SATISFIABLE|IMPOSSIBLE|TRANSLATION_AMBIGUOUS|TOO_COMPLEX|NO_TRANSLATION',
                    'expression' => '<string>',
                    'ruleIds' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'qualityReport' => [
            'conflictingRules' => ['<string>', ...],
            'disjointRuleSets' => [
                [
                    'rules' => ['<string>', ...],
                    'variables' => ['<string>', ...],
                ],
                // ...
            ],
            'ruleCount' => <integer>,
            'typeCount' => <integer>,
            'unusedTypeValues' => [
                [
                    'typeName' => '<string>',
                    'valueName' => '<string>',
                ],
                // ...
            ],
            'unusedTypes' => ['<string>', ...],
            'unusedVariables' => ['<string>', ...],
            'variableCount' => <integer>,
        ],
    ],
    'buildWorkflowId' => '<string>',
    'policyArn' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

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

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.

ThrottlingException:

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

GetAutomatedReasoningPolicyNextScenario

$result = $client->getAutomatedReasoningPolicyNextScenario([/* ... */]);
$promise = $client->getAutomatedReasoningPolicyNextScenarioAsync([/* ... */]);

Retrieves the next test scenario for validating an Automated Reasoning policy. This is used during the interactive policy refinement process to test policy behavior.

Parameter Syntax

$result = $client->getAutomatedReasoningPolicyNextScenario([
    'buildWorkflowId' => '<string>', // REQUIRED
    'policyArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'policyArn' => '<string>',
    'scenario' => [
        'alternateExpression' => '<string>',
        'expectedResult' => 'VALID|INVALID|SATISFIABLE|IMPOSSIBLE|TRANSLATION_AMBIGUOUS|TOO_COMPLEX|NO_TRANSLATION',
        'expression' => '<string>',
        'ruleIds' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

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

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.

ThrottlingException:

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

GetAutomatedReasoningPolicyTestCase

$result = $client->getAutomatedReasoningPolicyTestCase([/* ... */]);
$promise = $client->getAutomatedReasoningPolicyTestCaseAsync([/* ... */]);

Retrieves details about a specific Automated Reasoning policy test.

Parameter Syntax

$result = $client->getAutomatedReasoningPolicyTestCase([
    'policyArn' => '<string>', // REQUIRED
    'testCaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'policyArn' => '<string>',
    'testCase' => [
        'confidenceThreshold' => <float>,
        'createdAt' => <DateTime>,
        'expectedAggregatedFindingsResult' => 'VALID|INVALID|SATISFIABLE|IMPOSSIBLE|TRANSLATION_AMBIGUOUS|TOO_COMPLEX|NO_TRANSLATION',
        'guardContent' => '<string>',
        'queryContent' => '<string>',
        'testCaseId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

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

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.

ThrottlingException:

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

GetAutomatedReasoningPolicyTestResult

$result = $client->getAutomatedReasoningPolicyTestResult([/* ... */]);
$promise = $client->getAutomatedReasoningPolicyTestResultAsync([/* ... */]);

Retrieves the test result for a specific Automated Reasoning policy test. Returns detailed validation findings and execution status.

Parameter Syntax

$result = $client->getAutomatedReasoningPolicyTestResult([
    'buildWorkflowId' => '<string>', // REQUIRED
    'policyArn' => '<string>', // REQUIRED
    'testCaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'testResult' => [
        'aggregatedTestFindingsResult' => 'VALID|INVALID|SATISFIABLE|IMPOSSIBLE|TRANSLATION_AMBIGUOUS|TOO_COMPLEX|NO_TRANSLATION',
        'policyArn' => '<string>',
        'testCase' => [
            'confidenceThreshold' => <float>,
            'createdAt' => <DateTime>,
            'expectedAggregatedFindingsResult' => 'VALID|INVALID|SATISFIABLE|IMPOSSIBLE|TRANSLATION_AMBIGUOUS|TOO_COMPLEX|NO_TRANSLATION',
            'guardContent' => '<string>',
            'queryContent' => '<string>',
            'testCaseId' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        'testFindings' => [
            [
                'impossible' => [
                    'contradictingRules' => [
                        [
                            'id' => '<string>',
                            'policyVersionArn' => '<string>',
                        ],
                        // ...
                    ],
                    'logicWarning' => [
                        'claims' => [
                            [
                                'logic' => '<string>',
                                'naturalLanguage' => '<string>',
                            ],
                            // ...
                        ],
                        'premises' => [
                            [
                                'logic' => '<string>',
                                'naturalLanguage' => '<string>',
                            ],
                            // ...
                        ],
                        'type' => 'ALWAYS_TRUE|ALWAYS_FALSE',
                    ],
                    'translation' => [
                        'claims' => [
                            [
                                'logic' => '<string>',
                                'naturalLanguage' => '<string>',
                            ],
                            // ...
                        ],
                        'confidence' => <float>,
                        'premises' => [
                            [
                                'logic' => '<string>',
                                'naturalLanguage' => '<string>',
                            ],
                            // ...
                        ],
                        'untranslatedClaims' => [
                            [
                                'text' => '<string>',
                            ],
                            // ...
                        ],
                        'untranslatedPremises' => [
                            [
                                'text' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                'invalid' => [
                    'contradictingRules' => [
                        [
                            'id' => '<string>',
                            'policyVersionArn' => '<string>',
                        ],
                        // ...
                    ],
                    'logicWarning' => [
                        'claims' => [
                            [
                                'logic' => '<string>',
                                'naturalLanguage' => '<string>',
                            ],
                            // ...
                        ],
                        'premises' => [
                            [
                                'logic' => '<string>',
                                'naturalLanguage' => '<string>',
                            ],
                            // ...
                        ],
                        'type' => 'ALWAYS_TRUE|ALWAYS_FALSE',
                    ],
                    'translation' => [
                        'claims' => [
                            [
                                'logic' => '<string>',
                                'naturalLanguage' => '<string>',
                            ],
                            // ...
                        ],
                        'confidence' => <float>,
                        'premises' => [
                            [
                                'logic' => '<string>',
                                'naturalLanguage' => '<string>',
                            ],
                            // ...
                        ],
                        'untranslatedClaims' => [
                            [
                                'text' => '<string>',
                            ],
                            // ...
                        ],
                        'untranslatedPremises' => [
                            [
                                'text' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                'noTranslations' => [
                ],
                'satisfiable' => [
                    'claimsFalseScenario' => [
                        'statements' => [
                            [
                                'logic' => '<string>',
                                'naturalLanguage' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'claimsTrueScenario' => [
                        'statements' => [
                            [
                                'logic' => '<string>',
                                'naturalLanguage' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'logicWarning' => [
                        'claims' => [
                            [
                                'logic' => '<string>',
                                'naturalLanguage' => '<string>',
                            ],
                            // ...
                        ],
                        'premises' => [
                            [
                                'logic' => '<string>',
                                'naturalLanguage' => '<string>',
                            ],
                            // ...
                        ],
                        'type' => 'ALWAYS_TRUE|ALWAYS_FALSE',
                    ],
                    'translation' => [
                        'claims' => [
                            [
                                'logic' => '<string>',
                                'naturalLanguage' => '<string>',
                            ],
                            // ...
                        ],
                        'confidence' => <float>,
                        'premises' => [
                            [
                                'logic' => '<string>',
                                'naturalLanguage' => '<string>',
                            ],
                            // ...
                        ],
                        'untranslatedClaims' => [
                            [
                                'text' => '<string>',
                            ],
                            // ...
                        ],
                        'untranslatedPremises' => [
                            [
                                'text' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                'tooComplex' => [
                ],
                'translationAmbiguous' => [
                    'differenceScenarios' => [
                        [
                            'statements' => [
                                [
                                    'logic' => '<string>',
                                    'naturalLanguage' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'options' => [
                        [
                            'translations' => [
                                [
                                    'claims' => [
                                        [
                                            'logic' => '<string>',
                                            'naturalLanguage' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'confidence' => <float>,
                                    'premises' => [
                                        [
                                            'logic' => '<string>',
                                            'naturalLanguage' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'untranslatedClaims' => [
                                        [
                                            'text' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'untranslatedPremises' => [
                                        [
                                            'text' => '<string>',
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                ],
                'valid' => [
                    'claimsTrueScenario' => [
                        'statements' => [
                            [
                                'logic' => '<string>',
                                'naturalLanguage' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'logicWarning' => [
                        'claims' => [
                            [
                                'logic' => '<string>',
                                'naturalLanguage' => '<string>',
                            ],
                            // ...
                        ],
                        'premises' => [
                            [
                                'logic' => '<string>',
                                'naturalLanguage' => '<string>',
                            ],
                            // ...
                        ],
                        'type' => 'ALWAYS_TRUE|ALWAYS_FALSE',
                    ],
                    'supportingRules' => [
                        [
                            'id' => '<string>',
                            'policyVersionArn' => '<string>',
                        ],
                        // ...
                    ],
                    'translation' => [
                        'claims' => [
                            [
                                'logic' => '<string>',
                                'naturalLanguage' => '<string>',
                            ],
                            // ...
                        ],
                        'confidence' => <float>,
                        'premises' => [
                            [
                                'logic' => '<string>',
                                'naturalLanguage' => '<string>',
                            ],
                            // ...
                        ],
                        'untranslatedClaims' => [
                            [
                                'text' => '<string>',
                            ],
                            // ...
                        ],
                        'untranslatedPremises' => [
                            [
                                'text' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
            ],
            // ...
        ],
        'testRunResult' => 'PASSED|FAILED',
        'testRunStatus' => 'NOT_STARTED|SCHEDULED|IN_PROGRESS|COMPLETED|FAILED',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

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

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.

ThrottlingException:

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

GetCustomModel

$result = $client->getCustomModel([/* ... */]);
$promise = $client->getCustomModelAsync([/* ... */]);

Get the properties associated with a Amazon Bedrock custom model that you have created. For more information, see Custom models in the Amazon Bedrock User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'baseModelArn' => '<string>',
    'creationTime' => <DateTime>,
    'customizationConfig' => [
        'distillationConfig' => [
            'teacherModelConfig' => [
                'maxResponseLengthForInference' => <integer>,
                'teacherModelIdentifier' => '<string>',
            ],
        ],
        'rftConfig' => [
            'graderConfig' => [
                'lambdaGrader' => [
                    'lambdaArn' => '<string>',
                ],
            ],
            'hyperParameters' => [
                'batchSize' => <integer>,
                'epochCount' => <integer>,
                'evalInterval' => <integer>,
                'inferenceMaxTokens' => <integer>,
                'learningRate' => <float>,
                'maxPromptLength' => <integer>,
                'reasoningEffort' => 'low|medium|high',
                'trainingSamplePerPrompt' => <integer>,
            ],
        ],
    ],
    'customizationType' => 'FINE_TUNING|CONTINUED_PRE_TRAINING|DISTILLATION|REINFORCEMENT_FINE_TUNING|IMPORTED',
    'failureMessage' => '<string>',
    'hyperParameters' => ['<string>', ...],
    'jobArn' => '<string>',
    'jobName' => '<string>',
    'modelArn' => '<string>',
    'modelKmsKeyArn' => '<string>',
    'modelName' => '<string>',
    'modelStatus' => 'Active|Creating|Failed',
    'outputDataConfig' => [
        's3Uri' => '<string>',
    ],
    'trainingDataConfig' => [
        'invocationLogsConfig' => [
            'invocationLogSource' => [
                's3Uri' => '<string>',
            ],
            'requestMetadataFilters' => [
                'andAll' => [
                    [
                        'equals' => ['<string>', ...],
                        'notEquals' => ['<string>', ...],
                    ],
                    // ...
                ],
                'equals' => ['<string>', ...],
                'notEquals' => ['<string>', ...],
                'orAll' => [
                    [
                        'equals' => ['<string>', ...],
                        'notEquals' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'usePromptResponse' => true || false,
        ],
        's3Uri' => '<string>',
    ],
    'trainingMetrics' => [
        'trainingLoss' => <float>,
    ],
    'validationDataConfig' => [
        'validators' => [
            [
                's3Uri' => '<string>',
            ],
            // ...
        ],
    ],
    'validationMetrics' => [
        [
            'validationLoss' => <float>,
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

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

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.

ThrottlingException:

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

GetCustomModelDeployment

$result = $client->getCustomModelDeployment([/* ... */]);
$promise = $client->getCustomModelDeploymentAsync([/* ... */]);

Retrieves information about a custom model deployment, including its status, configuration, and metadata. Use this operation to monitor the deployment status and retrieve details needed for inference requests.

The following actions are related to the GetCustomModelDeployment operation:

• CreateCustomModelDeployment

• ListCustomModelDeployments

• DeleteCustomModelDeployment

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'customModelDeploymentArn' => '<string>',
    'description' => '<string>',
    'failureMessage' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'modelArn' => '<string>',
    'modelDeploymentName' => '<string>',
    'status' => 'Creating|Active|Failed',
    'updateDetails' => [
        'modelArn' => '<string>',
        'updateStatus' => 'Updating|UpdateCompleted|UpdateFailed',
    ],
]

Result Details

Errors

ResourceNotFoundException:

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

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.

ThrottlingException:

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

GetEvaluationJob

$result = $client->getEvaluationJob([/* ... */]);
$promise = $client->getEvaluationJobAsync([/* ... */]);

Gets information about an evaluation job, such as the status of the job.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'applicationType' => 'ModelEvaluation|RagEvaluation',
    'creationTime' => <DateTime>,
    'customerEncryptionKeyId' => '<string>',
    'evaluationConfig' => [
        'automated' => [
            'customMetricConfig' => [
                'customMetrics' => [
                    [
                        'customMetricDefinition' => [
                            'instructions' => '<string>',
                            'name' => '<string>',
                            'ratingScale' => [
                                [
                                    'definition' => '<string>',
                                    'value' => [
                                        'floatValue' => <float>,
                                        'stringValue' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                        ],
                    ],
                    // ...
                ],
                'evaluatorModelConfig' => [
                    'bedrockEvaluatorModels' => [
                        [
                            'modelIdentifier' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
            'datasetMetricConfigs' => [
                [
                    'dataset' => [
                        'datasetLocation' => [
                            's3Uri' => '<string>',
                        ],
                        'name' => '<string>',
                    ],
                    'metricNames' => ['<string>', ...],
                    'taskType' => 'Summarization|Classification|QuestionAndAnswer|Generation|Custom',
                ],
                // ...
            ],
            'evaluatorModelConfig' => [
                'bedrockEvaluatorModels' => [
                    [
                        'modelIdentifier' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
        'human' => [
            'customMetrics' => [
                [
                    'description' => '<string>',
                    'name' => '<string>',
                    'ratingMethod' => '<string>',
                ],
                // ...
            ],
            'datasetMetricConfigs' => [
                [
                    'dataset' => [
                        'datasetLocation' => [
                            's3Uri' => '<string>',
                        ],
                        'name' => '<string>',
                    ],
                    'metricNames' => ['<string>', ...],
                    'taskType' => 'Summarization|Classification|QuestionAndAnswer|Generation|Custom',
                ],
                // ...
            ],
            'humanWorkflowConfig' => [
                'flowDefinitionArn' => '<string>',
                'instructions' => '<string>',
            ],
        ],
    ],
    'failureMessages' => ['<string>', ...],
    'inferenceConfig' => [
        'models' => [
            [
                'bedrockModel' => [
                    'inferenceParams' => '<string>',
                    'modelIdentifier' => '<string>',
                    'performanceConfig' => [
                        'latency' => 'standard|optimized',
                    ],
                ],
                'precomputedInferenceSource' => [
                    'inferenceSourceIdentifier' => '<string>',
                ],
            ],
            // ...
        ],
        'ragConfigs' => [
            [
                'knowledgeBaseConfig' => [
                    'retrieveAndGenerateConfig' => [
                        'externalSourcesConfiguration' => [
                            'generationConfiguration' => [
                                'additionalModelRequestFields' => [
                                    '<AdditionalModelRequestFieldsKey>' => [
                                    ],
                                    // ...
                                ],
                                'guardrailConfiguration' => [
                                    'guardrailId' => '<string>',
                                    'guardrailVersion' => '<string>',
                                ],
                                'kbInferenceConfig' => [
                                    'textInferenceConfig' => [
                                        'maxTokens' => <integer>,
                                        'stopSequences' => ['<string>', ...],
                                        'temperature' => <float>,
                                        'topP' => <float>,
                                    ],
                                ],
                                'promptTemplate' => [
                                    'textPromptTemplate' => '<string>',
                                ],
                            ],
                            'modelArn' => '<string>',
                            'sources' => [
                                [
                                    'byteContent' => [
                                        'contentType' => '<string>',
                                        'data' => <string || resource || Psr\Http\Message\StreamInterface>,
                                        'identifier' => '<string>',
                                    ],
                                    's3Location' => [
                                        'uri' => '<string>',
                                    ],
                                    'sourceType' => 'S3|BYTE_CONTENT',
                                ],
                                // ...
                            ],
                        ],
                        'knowledgeBaseConfiguration' => [
                            'generationConfiguration' => [
                                'additionalModelRequestFields' => [
                                    '<AdditionalModelRequestFieldsKey>' => [
                                    ],
                                    // ...
                                ],
                                'guardrailConfiguration' => [
                                    'guardrailId' => '<string>',
                                    'guardrailVersion' => '<string>',
                                ],
                                'kbInferenceConfig' => [
                                    'textInferenceConfig' => [
                                        'maxTokens' => <integer>,
                                        'stopSequences' => ['<string>', ...],
                                        'temperature' => <float>,
                                        'topP' => <float>,
                                    ],
                                ],
                                'promptTemplate' => [
                                    'textPromptTemplate' => '<string>',
                                ],
                            ],
                            'knowledgeBaseId' => '<string>',
                            'modelArn' => '<string>',
                            'orchestrationConfiguration' => [
                                'queryTransformationConfiguration' => [
                                    'type' => 'QUERY_DECOMPOSITION',
                                ],
                            ],
                            'retrievalConfiguration' => [
                                'vectorSearchConfiguration' => [
                                    'filter' => [
                                        'andAll' => [
                                            [...], // RECURSIVE
                                            // ...
                                        ],
                                        'equals' => [
                                            'key' => '<string>',
                                            'value' => [
                                            ],
                                        ],
                                        'greaterThan' => [
                                            'key' => '<string>',
                                            'value' => [
                                            ],
                                        ],
                                        'greaterThanOrEquals' => [
                                            'key' => '<string>',
                                            'value' => [
                                            ],
                                        ],
                                        'in' => [
                                            'key' => '<string>',
                                            'value' => [
                                            ],
                                        ],
                                        'lessThan' => [
                                            'key' => '<string>',
                                            'value' => [
                                            ],
                                        ],
                                        'lessThanOrEquals' => [
                                            'key' => '<string>',
                                            'value' => [
                                            ],
                                        ],
                                        'listContains' => [
                                            'key' => '<string>',
                                            'value' => [
                                            ],
                                        ],
                                        'notEquals' => [
                                            'key' => '<string>',
                                            'value' => [
                                            ],
                                        ],
                                        'notIn' => [
                                            'key' => '<string>',
                                            'value' => [
                                            ],
                                        ],
                                        'orAll' => [
                                            [...], // RECURSIVE
                                            // ...
                                        ],
                                        'startsWith' => [
                                            'key' => '<string>',
                                            'value' => [
                                            ],
                                        ],
                                        'stringContains' => [
                                            'key' => '<string>',
                                            'value' => [
                                            ],
                                        ],
                                    ],
                                    'implicitFilterConfiguration' => [
                                        'metadataAttributes' => [
                                            [
                                                'description' => '<string>',
                                                'key' => '<string>',
                                                'type' => 'STRING|NUMBER|BOOLEAN|STRING_LIST',
                                            ],
                                            // ...
                                        ],
                                        'modelArn' => '<string>',
                                    ],
                                    'numberOfResults' => <integer>,
                                    'overrideSearchType' => 'HYBRID|SEMANTIC',
                                    'rerankingConfiguration' => [
                                        'bedrockRerankingConfiguration' => [
                                            'metadataConfiguration' => [
                                                'selectionMode' => 'SELECTIVE|ALL',
                                                'selectiveModeConfiguration' => [
                                                    'fieldsToExclude' => [
                                                        [
                                                            'fieldName' => '<string>',
                                                        ],
                                                        // ...
                                                    ],
                                                    'fieldsToInclude' => [
                                                        [
                                                            'fieldName' => '<string>',
                                                        ],
                                                        // ...
                                                    ],
                                                ],
                                            ],
                                            'modelConfiguration' => [
                                                'additionalModelRequestFields' => [
                                                    '<AdditionalModelRequestFieldsKey>' => [
                                                    ],
                                                    // ...
                                                ],
                                                'modelArn' => '<string>',
                                            ],
                                            'numberOfRerankedResults' => <integer>,
                                        ],
                                        'type' => 'BEDROCK_RERANKING_MODEL',
                                    ],
                                ],
                            ],
                        ],
                        'type' => 'KNOWLEDGE_BASE|EXTERNAL_SOURCES',
                    ],
                    'retrieveConfig' => [
                        'knowledgeBaseId' => '<string>',
                        'knowledgeBaseRetrievalConfiguration' => [
                            'vectorSearchConfiguration' => [
                                'filter' => [
                                    'andAll' => [
                                        [...], // RECURSIVE
                                        // ...
                                    ],
                                    'equals' => [
                                        'key' => '<string>',
                                        'value' => [
                                        ],
                                    ],
                                    'greaterThan' => [
                                        'key' => '<string>',
                                        'value' => [
                                        ],
                                    ],
                                    'greaterThanOrEquals' => [
                                        'key' => '<string>',
                                        'value' => [
                                        ],
                                    ],
                                    'in' => [
                                        'key' => '<string>',
                                        'value' => [
                                        ],
                                    ],
                                    'lessThan' => [
                                        'key' => '<string>',
                                        'value' => [
                                        ],
                                    ],
                                    'lessThanOrEquals' => [
                                        'key' => '<string>',
                                        'value' => [
                                        ],
                                    ],
                                    'listContains' => [
                                        'key' => '<string>',
                                        'value' => [
                                        ],
                                    ],
                                    'notEquals' => [
                                        'key' => '<string>',
                                        'value' => [
                                        ],
                                    ],
                                    'notIn' => [
                                        'key' => '<string>',
                                        'value' => [
                                        ],
                                    ],
                                    'orAll' => [
                                        [...], // RECURSIVE
                                        // ...
                                    ],
                                    'startsWith' => [
                                        'key' => '<string>',
                                        'value' => [
                                        ],
                                    ],
                                    'stringContains' => [
                                        'key' => '<string>',
                                        'value' => [
                                        ],
                                    ],
                                ],
                                'implicitFilterConfiguration' => [
                                    'metadataAttributes' => [
                                        [
                                            'description' => '<string>',
                                            'key' => '<string>',
                                            'type' => 'STRING|NUMBER|BOOLEAN|STRING_LIST',
                                        ],
                                        // ...
                                    ],
                                    'modelArn' => '<string>',
                                ],
                                'numberOfResults' => <integer>,
                                'overrideSearchType' => 'HYBRID|SEMANTIC',
                                'rerankingConfiguration' => [
                                    'bedrockRerankingConfiguration' => [
                                        'metadataConfiguration' => [
                                            'selectionMode' => 'SELECTIVE|ALL',
                                            'selectiveModeConfiguration' => [
                                                'fieldsToExclude' => [
                                                    [
                                                        'fieldName' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                                'fieldsToInclude' => [
                                                    [
                                                        'fieldName' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                            ],
                                        ],
                                        'modelConfiguration' => [
                                            'additionalModelRequestFields' => [
                                                '<AdditionalModelRequestFieldsKey>' => [
                                                ],
                                                // ...
                                            ],
                                            'modelArn' => '<string>',
                                        ],
                                        'numberOfRerankedResults' => <integer>,
                                    ],
                                    'type' => 'BEDROCK_RERANKING_MODEL',
                                ],
                            ],
                        ],
                    ],
                ],
                'precomputedRagSourceConfig' => [
                    'retrieveAndGenerateSourceConfig' => [
                        'ragSourceIdentifier' => '<string>',
                    ],
                    'retrieveSourceConfig' => [
                        'ragSourceIdentifier' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
    ],
    'jobArn' => '<string>',
    'jobDescription' => '<string>',
    'jobName' => '<string>',
    'jobType' => 'Human|Automated',
    'lastModifiedTime' => <DateTime>,
    'outputDataConfig' => [
        's3Uri' => '<string>',
    ],
    'roleArn' => '<string>',
    'status' => 'InProgress|Completed|Failed|Stopping|Stopped|Deleting',
]

Result Details

Errors

ResourceNotFoundException:

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

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.

ThrottlingException:

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

GetFoundationModel

$result = $client->getFoundationModel([/* ... */]);
$promise = $client->getFoundationModelAsync([/* ... */]);

Get details about a Amazon Bedrock foundation model.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'modelDetails' => [
        'customizationsSupported' => ['<string>', ...],
        'inferenceTypesSupported' => ['<string>', ...],
        'inputModalities' => ['<string>', ...],
        'modelArn' => '<string>',
        'modelId' => '<string>',
        'modelLifecycle' => [
            'endOfLifeTime' => <DateTime>,
            'legacyTime' => <DateTime>,
            'publicExtendedAccessTime' => <DateTime>,
            'startOfLifeTime' => <DateTime>,
            'status' => 'ACTIVE|LEGACY',
        ],
        'modelName' => '<string>',
        'outputModalities' => ['<string>', ...],
        'providerName' => '<string>',
        'responseStreamingSupported' => true || false,
    ],
]

Result Details

Errors

ResourceNotFoundException:

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

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.

ThrottlingException:

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

GetFoundationModelAvailability

$result = $client->getFoundationModelAvailability([/* ... */]);
$promise = $client->getFoundationModelAvailabilityAsync([/* ... */]);

Get information about the Foundation model availability.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'agreementAvailability' => [
        'errorMessage' => '<string>',
        'status' => 'AVAILABLE|PENDING|NOT_AVAILABLE|ERROR',
    ],
    'authorizationStatus' => 'AUTHORIZED|NOT_AUTHORIZED',
    'entitlementAvailability' => 'AVAILABLE|NOT_AVAILABLE',
    'modelId' => '<string>',
    'regionAvailability' => 'AVAILABLE|NOT_AVAILABLE',
]

Result Details

Errors

ResourceNotFoundException:

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

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.

ThrottlingException:

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

GetGuardrail

$result = $client->getGuardrail([/* ... */]);
$promise = $client->getGuardrailAsync([/* ... */]);

Gets details about a guardrail. If you don't specify a version, the response returns details for the DRAFT version.

Parameter Syntax

$result = $client->getGuardrail([
    'guardrailIdentifier' => '<string>', // REQUIRED
    'guardrailVersion' => '<string>',
]);

Parameter Details

Result Syntax

[
    'automatedReasoningPolicy' => [
        'confidenceThreshold' => <float>,
        'policies' => ['<string>', ...],
    ],
    'blockedInputMessaging' => '<string>',
    'blockedOutputsMessaging' => '<string>',
    'contentPolicy' => [
        'filters' => [
            [
                'inputAction' => 'BLOCK|NONE',
                'inputEnabled' => true || false,
                'inputModalities' => ['<string>', ...],
                'inputStrength' => 'NONE|LOW|MEDIUM|HIGH',
                'outputAction' => 'BLOCK|NONE',
                'outputEnabled' => true || false,
                'outputModalities' => ['<string>', ...],
                'outputStrength' => 'NONE|LOW|MEDIUM|HIGH',
                'type' => 'SEXUAL|VIOLENCE|HATE|INSULTS|MISCONDUCT|PROMPT_ATTACK',
            ],
            // ...
        ],
        'tier' => [
            'tierName' => 'CLASSIC|STANDARD',
        ],
    ],
    'contextualGroundingPolicy' => [
        'filters' => [
            [
                'action' => 'BLOCK|NONE',
                'enabled' => true || false,
                'threshold' => <float>,
                'type' => 'GROUNDING|RELEVANCE',
            ],
            // ...
        ],
    ],
    'createdAt' => <DateTime>,
    'crossRegionDetails' => [
        'guardrailProfileArn' => '<string>',
        'guardrailProfileId' => '<string>',
    ],
    'description' => '<string>',
    'failureRecommendations' => ['<string>', ...],
    'guardrailArn' => '<string>',
    'guardrailId' => '<string>',
    'kmsKeyArn' => '<string>',
    'name' => '<string>',
    'sensitiveInformationPolicy' => [
        'piiEntities' => [
            [
                'action' => 'BLOCK|ANONYMIZE|NONE',
                'inputAction' => 'BLOCK|ANONYMIZE|NONE',
                'inputEnabled' => true || false,
                'outputAction' => 'BLOCK|ANONYMIZE|NONE',
                'outputEnabled' => true || false,
                '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' => 'BLOCK|ANONYMIZE|NONE',
                'description' => '<string>',
                'inputAction' => 'BLOCK|ANONYMIZE|NONE',
                'inputEnabled' => true || false,
                'name' => '<string>',
                'outputAction' => 'BLOCK|ANONYMIZE|NONE',
                'outputEnabled' => true || false,
                'pattern' => '<string>',
            ],
            // ...
        ],
    ],
    'status' => 'CREATING|UPDATING|VERSIONING|READY|FAILED|DELETING',
    'statusReasons' => ['<string>', ...],
    'topicPolicy' => [
        'tier' => [
            'tierName' => 'CLASSIC|STANDARD',
        ],
        'topics' => [
            [
                'definition' => '<string>',
                'examples' => ['<string>', ...],
                'inputAction' => 'BLOCK|NONE',
                'inputEnabled' => true || false,
                'name' => '<string>',
                'outputAction' => 'BLOCK|NONE',
                'outputEnabled' => true || false,
                'type' => 'DENY',
            ],
            // ...
        ],
    ],
    'updatedAt' => <DateTime>,
    'version' => '<string>',
    'wordPolicy' => [
        'managedWordLists' => [
            [
                'inputAction' => 'BLOCK|NONE',
                'inputEnabled' => true || false,
                'outputAction' => 'BLOCK|NONE',
                'outputEnabled' => true || false,
                'type' => 'PROFANITY',
            ],
            // ...
        ],
        'words' => [
            [
                'inputAction' => 'BLOCK|NONE',
                'inputEnabled' => true || false,
                'outputAction' => 'BLOCK|NONE',
                'outputEnabled' => true || false,
                'text' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details