BatchDeleteEvaluationJob

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

Creates a batch deletion job. A model 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.

CreateEvaluationJob

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

API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers. To learn more about the requirements for creating a model evaluation job see, Model evaluation.

Parameter Syntax

$result = $client->createEvaluationJob([
    'clientRequestToken' => '<string>',
    'customerEncryptionKeyId' => '<string>',
    'evaluationConfig' => [ // REQUIRED
        'automated' => [
            'datasetMetricConfigs' => [ // REQUIRED
                [
                    'dataset' => [ // REQUIRED
                        'datasetLocation' => [
                            's3Uri' => '<string>',
                        ],
                        'name' => '<string>', // REQUIRED
                    ],
                    'metricNames' => ['<string>', ...], // REQUIRED
                    'taskType' => 'Summarization|Classification|QuestionAndAnswer|Generation|Custom', // 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>', // REQUIRED
                    'modelIdentifier' => '<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.

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 Guardrails for Amazon Bedrock in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->createGuardrail([
    'blockedInputMessaging' => '<string>', // REQUIRED
    'blockedOutputsMessaging' => '<string>', // REQUIRED
    'clientRequestToken' => '<string>',
    'contentPolicyConfig' => [
        'filtersConfig' => [ // REQUIRED
            [
                'inputStrength' => 'NONE|LOW|MEDIUM|HIGH', // REQUIRED
                'outputStrength' => 'NONE|LOW|MEDIUM|HIGH', // REQUIRED
                'type' => 'SEXUAL|VIOLENCE|HATE|INSULTS|MISCONDUCT|PROMPT_ATTACK', // REQUIRED
            ],
            // ...
        ],
    ],
    'contextualGroundingPolicyConfig' => [
        'filtersConfig' => [ // REQUIRED
            [
                'threshold' => <float>, // REQUIRED
                'type' => 'GROUNDING|RELEVANCE', // REQUIRED
            ],
            // ...
        ],
    ],
    'description' => '<string>',
    'kmsKeyId' => '<string>',
    'name' => '<string>', // REQUIRED
    'sensitiveInformationPolicyConfig' => [
        'piiEntitiesConfig' => [
            [
                'action' => 'BLOCK|ANONYMIZE', // REQUIRED
                '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', // REQUIRED
                'description' => '<string>',
                'name' => '<string>', // REQUIRED
                'pattern' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'topicPolicyConfig' => [
        'topicsConfig' => [ // REQUIRED
            [
                'definition' => '<string>', // REQUIRED
                'examples' => ['<string>', ...],
                'name' => '<string>', // REQUIRED
                'type' => 'DENY', // REQUIRED
            ],
            // ...
        ],
    ],
    'wordPolicyConfig' => [
        'managedWordListsConfig' => [
            [
                'type' => 'PROFANITY', // REQUIRED
            ],
            // ...
        ],
        'wordsConfig' => [
            [
                '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.

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
        ],
        // ...
    ],
    'customizationType' => 'FINE_TUNING|CONTINUED_PRE_TRAINING',
    'hyperParameters' => ['<string>', ...], // REQUIRED
    'jobName' => '<string>', // REQUIRED
    'jobTags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'outputDataConfig' => [ // REQUIRED
        's3Uri' => '<string>', // REQUIRED
    ],
    'roleArn' => '<string>', // REQUIRED
    'trainingDataConfig' => [ // REQUIRED
        's3Uri' => '<string>', // REQUIRED
    ],
    '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
    '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.

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.

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.

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.

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.

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.

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.

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>,
    'customizationType' => 'FINE_TUNING|CONTINUED_PRE_TRAINING',
    'hyperParameters' => ['<string>', ...],
    'jobArn' => '<string>',
    'jobName' => '<string>',
    'modelArn' => '<string>',
    'modelKmsKeyArn' => '<string>',
    'modelName' => '<string>',
    'outputDataConfig' => [
        's3Uri' => '<string>',
    ],
    'trainingDataConfig' => [
        '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.

GetEvaluationJob

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

Retrieves the properties associated with a model evaluation job, including the status of the job. For more information, see Model evaluation.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'creationTime' => <DateTime>,
    'customerEncryptionKeyId' => '<string>',
    'evaluationConfig' => [
        'automated' => [
            'datasetMetricConfigs' => [
                [
                    'dataset' => [
                        'datasetLocation' => [
                            's3Uri' => '<string>',
                        ],
                        'name' => '<string>',
                    ],
                    'metricNames' => ['<string>', ...],
                    'taskType' => 'Summarization|Classification|QuestionAndAnswer|Generation|Custom',
                ],
                // ...
            ],
        ],
        '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>',
                ],
            ],
            // ...
        ],
    ],
    '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' => [
            '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.

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

[
    'blockedInputMessaging' => '<string>',
    'blockedOutputsMessaging' => '<string>',
    'contentPolicy' => [
        'filters' => [
            [
                'inputStrength' => 'NONE|LOW|MEDIUM|HIGH',
                'outputStrength' => 'NONE|LOW|MEDIUM|HIGH',
                'type' => 'SEXUAL|VIOLENCE|HATE|INSULTS|MISCONDUCT|PROMPT_ATTACK',
            ],
            // ...
        ],
    ],
    'contextualGroundingPolicy' => [
        'filters' => [
            [
                'threshold' => <float>,
                'type' => 'GROUNDING|RELEVANCE',
            ],
            // ...
        ],
    ],
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'failureRecommendations' => ['<string>', ...],
    'guardrailArn' => '<string>',
    'guardrailId' => '<string>',
    'kmsKeyArn' => '<string>',
    'name' => '<string>',
    'sensitiveInformationPolicy' => [
        'piiEntities' => [
            [
                'action' => 'BLOCK|ANONYMIZE',
                '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',
                'description' => '<string>',
                'name' => '<string>',
                'pattern' => '<string>',
            ],
            // ...
        ],
    ],
    'status' => 'CREATING|UPDATING|VERSIONING|READY|FAILED|DELETING',
    'statusReasons' => ['<string>', ...],
    'topicPolicy' => [
        'topics' => [
            [
                'definition' => '<string>',
                'examples' => ['<string>', ...],
                'name' => '<string>',
                'type' => 'DENY',
            ],
            // ...
        ],
    ],
    'updatedAt' => <DateTime>,
    'version' => '<string>',
    'wordPolicy' => [
        'managedWordLists' => [
            [
                'type' => 'PROFANITY',
            ],
            // ...
        ],
        'words' => [
            [
                'text' => '<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.

GetImportedModel

$result = $client->getImportedModel([/* ... */]);
$promise = $client->getImportedModelAsync([/* ... */]);

Gets properties associated with a customized model you imported.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'creationTime' => <DateTime>,
    'instructSupported' => true || false,
    'jobArn' => '<string>',
    'jobName' => '<string>',
    'modelArchitecture' => '<string>',
    'modelArn' => '<string>',
    'modelDataSource' => [
        's3DataSource' => [
            's3Uri' => '<string>',
        ],
    ],
    'modelKmsKeyArn' => '<string>',
    'modelName' => '<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.

GetInferenceProfile

$result = $client->getInferenceProfile([/* ... */]);
$promise = $client->getInferenceProfileAsync([/* ... */]);

Gets information about an 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->getInferenceProfile([
    'inferenceProfileIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'inferenceProfileArn' => '<string>',
    'inferenceProfileId' => '<string>',
    'inferenceProfileName' => '<string>',
    'models' => [
        [
            'modelArn' => '<string>',
        ],
        // ...
    ],
    'status' => 'ACTIVE',
    'type' => 'SYSTEM_DEFINED|APPLICATION',
    '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.

GetModelCopyJob

$result = $client->getModelCopyJob([/* ... */]);
$promise = $client->getModelCopyJobAsync([/* ... */]);

Retrieves information about a model copy job. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'creationTime' => <DateTime>,
    'failureMessage' => '<string>',
    'jobArn' => '<string>',
    'sourceAccountId' => '<string>',
    'sourceModelArn' => '<string>',
    'sourceModelName' => '<string>',
    'status' => 'InProgress|Completed|Failed',
    'targetModelArn' => '<string>',
    'targetModelKmsKeyArn' => '<string>',
    'targetModelName' => '<string>',
    'targetModelTags' => [
        [
            'key' => '<string>',
            'value' => '<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.

GetModelCustomizationJob

$result = $client->getModelCustomizationJob([/* ... */]);
$promise = $client->getModelCustomizationJobAsync([/* ... */]);

Retrieves the properties associated with a model-customization job, including the status of the job. For more information, see Custom models in the Amazon Bedrock User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'baseModelArn' => '<string>',
    'clientRequestToken' => '<string>',
    'creationTime' => <DateTime>,
    'customizationType' => 'FINE_TUNING|CONTINUED_PRE_TRAINING',
    'endTime' => <DateTime>,
    'failureMessage' => '<string>',
    'hyperParameters' => ['<string>', ...],
    'jobArn' => '<string>',
    'jobName' => '<string>',
    'lastModifiedTime' => <DateTime>,
    'outputDataConfig' => [
        's3Uri' => '<string>',
    ],
    'outputModelArn' => '<string>',
    'outputModelKmsKeyArn' => '<string>',
    'outputModelName' => '<string>',
    'roleArn' => '<string>',
    'status' => 'InProgress|Completed|Failed|Stopping|Stopped',
    'trainingDataConfig' => [
        's3Uri' => '<string>',
    ],
    'trainingMetrics' => [
        'trainingLoss' => <float>,
    ],
    'validationDataConfig' => [
        'validators' => [
            [
                's3Uri' => '<string>',
            ],
            // ...
        ],
    ],
    'validationMetrics' => [
        [
            'validationLoss' => <float>,
        ],
        // ...
    ],
    'vpcConfig' => [
        'securityGroupIds' => ['<string>', ...],
        'subnetIds' => ['<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.

GetModelImportJob

$result = $client->getModelImportJob([/* ... */]);
$promise = $client->getModelImportJobAsync([/* ... */]);

Retrieves the properties associated with import model job, including the status of the job. For more information, see Import a customized model in the Amazon Bedrock User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'creationTime' => <DateTime>,
    'endTime' => <DateTime>,
    'failureMessage' => '<string>',
    'importedModelArn' => '<string>',
    'importedModelKmsKeyArn' => '<string>',
    'importedModelName' => '<string>',
    'jobArn' => '<string>',
    'jobName' => '<string>',
    'lastModifiedTime' => <DateTime>,
    'modelDataSource' => [
        's3DataSource' => [
            's3Uri' => '<string>',
        ],
    ],
    'roleArn' => '<string>',
    'status' => 'InProgress|Completed|Failed',
    'vpcConfig' => [
        'securityGroupIds' => ['<string>', ...],
        'subnetIds' => ['<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.

GetModelInvocationJob

$result = $client->getModelInvocationJob([/* ... */]);
$promise = $client->getModelInvocationJobAsync([/* ... */]);

Gets details about a batch inference job. For more information, see View details about a batch inference job

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'clientRequestToken' => '<string>',
    'endTime' => <DateTime>,
    'inputDataConfig' => [
        's3InputDataConfig' => [
            's3BucketOwner' => '<string>',
            's3InputFormat' => 'JSONL',
            's3Uri' => '<string>',
        ],
    ],
    'jobArn' => '<string>',
    'jobExpirationTime' => <DateTime>,
    'jobName' => '<string>',
    'lastModifiedTime' => <DateTime>,
    'message' => '<string>',
    'modelId' => '<string>',
    'outputDataConfig' => [
        's3OutputDataConfig' => [
            's3BucketOwner' => '<string>',
            's3EncryptionKeyId' => '<string>',
            's3Uri' => '<string>',
        ],
    ],
    'roleArn' => '<string>',
    'status' => 'Submitted|InProgress|Completed|Failed|Stopping|Stopped|PartiallyCompleted|Expired|Validating|Scheduled',
    'submitTime' => <DateTime>,
    'timeoutDurationInHours' => <integer>,
    'vpcConfig' => [
        'securityGroupIds' => ['<string>', ...],
        'subnetIds' => ['<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.

GetModelInvocationLoggingConfiguration

$result = $client->getModelInvocationLoggingConfiguration([/* ... */]);
$promise = $client->getModelInvocationLoggingConfigurationAsync([/* ... */]);

Get the current configuration values for model invocation logging.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'loggingConfig' => [
        'cloudWatchConfig' => [
            'largeDataDeliveryS3Config' => [
                'bucketName' => '<string>',
                'keyPrefix' => '<string>',
            ],
            'logGroupName' => '<string>',
            'roleArn' => '<string>',
        ],
        'embeddingDataDeliveryEnabled' => true || false,
        'imageDataDeliveryEnabled' => true || false,
        's3Config' => [
            'bucketName' => '<string>',
            'keyPrefix' => '<string>',
        ],
        'textDataDeliveryEnabled' => true || false,
    ],
]

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.

GetProvisionedModelThroughput

$result = $client->getProvisionedModelThroughput([/* ... */]);
$promise = $client->getProvisionedModelThroughputAsync([/* ... */]);

Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'commitmentDuration' => 'OneMonth|SixMonths',
    'commitmentExpirationTime' => <DateTime>,
    'creationTime' => <DateTime>,
    'desiredModelArn' => '<string>',
    'desiredModelUnits' => <integer>,
    'failureMessage' => '<string>',
    'foundationModelArn' => '<string>',
    'lastModifiedTime' => <DateTime>,
    'modelArn' => '<string>',
    'modelUnits' => <integer>,
    'provisionedModelArn' => '<string>',
    'provisionedModelName' => '<string>',
    'status' => 'Creating|InService|Updating|Failed',
]

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.

ListCustomModels

$result = $client->listCustomModels([/* ... */]);
$promise = $client->listCustomModelsAsync([/* ... */]);

Returns a list of the custom models that you have created with the CreateModelCustomizationJob operation.

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

Parameter Syntax

$result = $client->listCustomModels([
    'baseModelArnEquals' => '<string>',
    'creationTimeAfter' => <integer || string || DateTime>,
    'creationTimeBefore' => <integer || string || DateTime>,
    'foundationModelArnEquals' => '<string>',
    'isOwned' => true || false,
    'maxResults' => <integer>,
    'nameContains' => '<string>',
    'nextToken' => '<string>',
    'sortBy' => 'CreationTime',
    'sortOrder' => 'Ascending|Descending',
]);

Parameter Details

Result Syntax

[
    'modelSummaries' => [
        [
            'baseModelArn' => '<string>',
            'baseModelName' => '<string>',
            'creationTime' => <DateTime>,
            'customizationType' => 'FINE_TUNING|CONTINUED_PRE_TRAINING',
            'modelArn' => '<string>',
            'modelName' => '<string>',
            'ownerAccountId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<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.

ListEvaluationJobs

$result = $client->listEvaluationJobs([/* ... */]);
$promise = $client->listEvaluationJobsAsync([/* ... */]);

Lists model evaluation jobs.

Parameter Syntax

$result = $client->listEvaluationJobs([
    'creationTimeAfter' => <integer || string || DateTime>,
    'creationTimeBefore' => <integer || string || DateTime>,
    'maxResults' => <integer>,
    'nameContains' => '<string>',
    'nextToken' => '<string>',
    'sortBy' => 'CreationTime',
    'sortOrder' => 'Ascending|Descending',
    'statusEquals' => 'InProgress|Completed|Failed|Stopping|Stopped|Deleting',
]);

Parameter Details

Result Syntax

[
    'jobSummaries' => [
        [
            'creationTime' => <DateTime>,
            'evaluationTaskTypes' => ['<string>', ...],
            'jobArn' => '<string>',
            'jobName' => '<string>',
            'jobType' => 'Human|Automated',
            'modelIdentifiers' => ['<string>', ...],
            'status' => 'InProgress|Completed|Failed|Stopping|Stopped|Deleting',
        ],
        // ...
    ],
    'nextToken' => '<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.

ListFoundationModels

$result = $client->listFoundationModels([/* ... */]);
$promise = $client->listFoundationModelsAsync([/* ... */]);

Lists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters. For more information, see Foundation models in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->listFoundationModels([
    'byCustomizationType' => 'FINE_TUNING|CONTINUED_PRE_TRAINING',
    'byInferenceType' => 'ON_DEMAND|PROVISIONED',
    'byOutputModality' => 'TEXT|IMAGE|EMBEDDING',
    'byProvider' => '<string>',
]);

Parameter Details

Result Syntax

[
    'modelSummaries' => [
        [
            'customizationsSupported' => ['<string>', ...],
            'inferenceTypesSupported' => ['<string>', ...],
            'inputModalities' => ['<string>', ...],
            'modelArn' => '<string>',
            'modelId' => '<string>',
            'modelLifecycle' => [
                'status' => 'ACTIVE|LEGACY',
            ],
            'modelName' => '<string>',
            'outputModalities' => ['<string>', ...],
            'providerName' => '<string>',
            'responseStreamingSupported' => true || false,
        ],
        // ...
    ],
]

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.

ListGuardrails

$result = $client->listGuardrails([/* ... */]);
$promise = $client->listGuardrailsAsync([/* ... */]);

Lists details about all the guardrails in an account. To list the DRAFT version of all your guardrails, don't specify the guardrailIdentifier field. To list all versions of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier field.

You can set the maximum number of results to return in a response in the maxResults field. If there are more results than the number you set, the response returns a nextToken that you can send in another ListGuardrails request to see the next batch of results.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'guardrails' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'status' => 'CREATING|UPDATING|VERSIONING|READY|FAILED|DELETING',
            'updatedAt' => <DateTime>,
            'version' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<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.

ListImportedModels

$result = $client->listImportedModels([/* ... */]);
$promise = $client->listImportedModelsAsync([/* ... */]);

Returns a list of models you've imported. You can filter the results to return based on one or more criteria. For more information, see Import a customized model in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->listImportedModels([
    'creationTimeAfter' => <integer || string || DateTime>,
    'creationTimeBefore' => <integer || string || DateTime>,
    'maxResults' => <integer>,
    'nameContains' => '<string>',
    'nextToken' => '<string>',
    'sortBy' => 'CreationTime',
    'sortOrder' => 'Ascending|Descending',
]);

Parameter Details

Result Syntax

[
    'modelSummaries' => [
        [
            'creationTime' => <DateTime>,
            'instructSupported' => true || false,
            'modelArchitecture' => '<string>',
            'modelArn' => '<string>',
            'modelName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<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.

ListInferenceProfiles

$result = $client->listInferenceProfiles([/* ... */]);
$promise = $client->listInferenceProfilesAsync([/* ... */]);

Returns a list of inference profiles that you can use. 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->listInferenceProfiles([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'typeEquals' => 'SYSTEM_DEFINED|APPLICATION',
]);

Parameter Details

Result Syntax

[
    'inferenceProfileSummaries' => [
        [
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'inferenceProfileArn' => '<string>',
            'inferenceProfileId' => '<string>',
            'inferenceProfileName' => '<string>',
            'models' => [
                [
                    'modelArn' => '<string>',
                ],
                // ...
            ],
            'status' => 'ACTIVE',
            'type' => 'SYSTEM_DEFINED|APPLICATION',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<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.

ListModelCopyJobs

$result = $client->listModelCopyJobs([/* ... */]);
$promise = $client->listModelCopyJobsAsync([/* ... */]);

Returns a list of model copy jobs that you have submitted. You can filter the jobs to return based on one or more criteria. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->listModelCopyJobs([
    'creationTimeAfter' => <integer || string || DateTime>,
    'creationTimeBefore' => <integer || string || DateTime>,
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortBy' => 'CreationTime',
    'sortOrder' => 'Ascending|Descending',
    'sourceAccountEquals' => '<string>',
    'sourceModelArnEquals' => '<string>',
    'statusEquals' => 'InProgress|Completed|Failed',
    'targetModelNameContains' => '<string>',
]);

Parameter Details

Result Syntax

[
    'modelCopyJobSummaries' => [
        [
            'creationTime' => <DateTime>,
            'failureMessage' => '<string>',
            'jobArn' => '<string>',
            'sourceAccountId' => '<string>',
            'sourceModelArn' => '<string>',
            'sourceModelName' => '<string>',
            'status' => 'InProgress|Completed|Failed',
            'targetModelArn' => '<string>',
            'targetModelKmsKeyArn' => '<string>',
            'targetModelName' => '<string>',
            'targetModelTags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'nextToken' => '<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.

ListModelCustomizationJobs

$result = $client->listModelCustomizationJobs([/* ... */]);
$promise = $client->listModelCustomizationJobsAsync([/* ... */]);

Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on one or more criteria.

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

Parameter Syntax

$result = $client->listModelCustomizationJobs([
    'creationTimeAfter' => <integer || string || DateTime>,
    'creationTimeBefore' => <integer || string || DateTime>,
    'maxResults' => <integer>,
    'nameContains' => '<string>',
    'nextToken' => '<string>',
    'sortBy' => 'CreationTime',
    'sortOrder' => 'Ascending|Descending',
    'statusEquals' => 'InProgress|Completed|Failed|Stopping|Stopped',
]);

Parameter Details

Result Syntax

[
    'modelCustomizationJobSummaries' => [
        [
            'baseModelArn' => '<string>',
            'creationTime' => <DateTime>,
            'customModelArn' => '<string>',
            'customModelName' => '<string>',
            'customizationType' => 'FINE_TUNING|CONTINUED_PRE_TRAINING',
            'endTime' => <DateTime>,
            'jobArn' => '<string>',
            'jobName' => '<string>',
            'lastModifiedTime' => <DateTime>,
            'status' => 'InProgress|Completed|Failed|Stopping|Stopped',
        ],
        // ...
    ],
    'nextToken' => '<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.

ListModelImportJobs

$result = $client->listModelImportJobs([/* ... */]);
$promise = $client->listModelImportJobsAsync([/* ... */]);

Returns a list of import jobs you've submitted. You can filter the results to return based on one or more criteria. For more information, see Import a customized model in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->listModelImportJobs([
    'creationTimeAfter' => <integer || string || DateTime>,
    'creationTimeBefore' => <integer || string || DateTime>,
    'maxResults' => <integer>,
    'nameContains' => '<string>',
    'nextToken' => '<string>',
    'sortBy' => 'CreationTime',
    'sortOrder' => 'Ascending|Descending',
    'statusEquals' => 'InProgress|Completed|Failed',
]);

Parameter Details

Result Syntax

[
    'modelImportJobSummaries' => [
        [
            'creationTime' => <DateTime>,
            'endTime' => <DateTime>,
            'importedModelArn' => '<string>',
            'importedModelName' => '<string>',
            'jobArn' => '<string>',
            'jobName' => '<string>',
            'lastModifiedTime' => <DateTime>,
            'status' => 'InProgress|Completed|Failed',
        ],
        // ...
    ],
    'nextToken' => '<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.

ListModelInvocationJobs

$result = $client->listModelInvocationJobs([/* ... */]);
$promise = $client->listModelInvocationJobsAsync([/* ... */]);

Lists all batch inference jobs in the account. For more information, see View details about a batch inference job.

Parameter Syntax

$result = $client->listModelInvocationJobs([
    'maxResults' => <integer>,
    'nameContains' => '<string>',
    'nextToken' => '<string>',
    'sortBy' => 'CreationTime',
    'sortOrder' => 'Ascending|Descending',
    'statusEquals' => 'Submitted|InProgress|Completed|Failed|Stopping|Stopped|PartiallyCompleted|Expired|Validating|Scheduled',
    'submitTimeAfter' => <integer || string || DateTime>,
    'submitTimeBefore' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'invocationJobSummaries' => [
        [
            'clientRequestToken' => '<string>',
            'endTime' => <DateTime>,
            'inputDataConfig' => [
                's3InputDataConfig' => [
                    's3BucketOwner' => '<string>',
                    's3InputFormat' => 'JSONL',
                    's3Uri' => '<string>',
                ],
            ],
            'jobArn' => '<string>',
            'jobExpirationTime' => <DateTime>,
            'jobName' => '<string>',
            'lastModifiedTime' => <DateTime>,
            'message' => '<string>',
            'modelId' => '<string>',
            'outputDataConfig' => [
                's3OutputDataConfig' => [
                    's3BucketOwner' => '<string>',
                    's3EncryptionKeyId' => '<string>',
                    's3Uri' => '<string>',
                ],
            ],
            'roleArn' => '<string>',
            'status' => 'Submitted|InProgress|Completed|Failed|Stopping|Stopped|PartiallyCompleted|Expired|Validating|Scheduled',
            'submitTime' => <DateTime>,
            'timeoutDurationInHours' => <integer>,
            'vpcConfig' => [
                'securityGroupIds' => ['<string>', ...],
                'subnetIds' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'nextToken' => '<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.

ListProvisionedModelThroughputs

$result = $client->listProvisionedModelThroughputs([/* ... */]);
$promise = $client->listProvisionedModelThroughputsAsync([/* ... */]);

Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->listProvisionedModelThroughputs([
    'creationTimeAfter' => <integer || string || DateTime>,
    'creationTimeBefore' => <integer || string || DateTime>,
    'maxResults' => <integer>,
    'modelArnEquals' => '<string>',
    'nameContains' => '<string>',
    'nextToken' => '<string>',
    'sortBy' => 'CreationTime',
    'sortOrder' => 'Ascending|Descending',
    'statusEquals' => 'Creating|InService|Updating|Failed',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'provisionedModelSummaries' => [
        [
            'commitmentDuration' => 'OneMonth|SixMonths',
            'commitmentExpirationTime' => <DateTime>,
            'creationTime' => <DateTime>,
            'desiredModelArn' => '<string>',
            'desiredModelUnits' => <integer>,
            'foundationModelArn' => '<string>',
            'lastModifiedTime' => <DateTime>,
            'modelArn' => '<string>',
            'modelUnits' => <integer>,
            'provisionedModelArn' => '<string>',
            'provisionedModelName' => '<string>',
            'status' => 'Creating|InService|Updating|Failed',
        ],
        // ...
    ],
]

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.

ListTagsForResource

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

List the tags associated with the specified resource.

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<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.

PutModelInvocationLoggingConfiguration

$result = $client->putModelInvocationLoggingConfiguration([/* ... */]);
$promise = $client->putModelInvocationLoggingConfigurationAsync([/* ... */]);

Set the configuration values for model invocation logging.

Parameter Syntax

$result = $client->putModelInvocationLoggingConfiguration([
    'loggingConfig' => [ // REQUIRED
        'cloudWatchConfig' => [
            'largeDataDeliveryS3Config' => [
                'bucketName' => '<string>', // REQUIRED
                'keyPrefix' => '<string>',
            ],
            'logGroupName' => '<string>', // REQUIRED
            'roleArn' => '<string>', // REQUIRED
        ],
        'embeddingDataDeliveryEnabled' => true || false,
        'imageDataDeliveryEnabled' => true || false,
        's3Config' => [
            'bucketName' => '<string>', // REQUIRED
            'keyPrefix' => '<string>',
        ],
        'textDataDeliveryEnabled' => true || false,
    ],
]);

Parameter Details

Result Syntax

[]

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.

StopEvaluationJob

$result = $client->stopEvaluationJob([/* ... */]);
$promise = $client->stopEvaluationJobAsync([/* ... */]);

Stops an in progress model evaluation job.

Parameter Syntax

$result = $client->stopEvaluationJob([
    'jobIdentifier' => '<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.

StopModelCustomizationJob

$result = $client->stopModelCustomizationJob([/* ... */]);
$promise = $client->stopModelCustomizationJobAsync([/* ... */]);

Stops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->stopModelCustomizationJob([
    'jobIdentifier' => '<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.

StopModelInvocationJob

$result = $client->stopModelInvocationJob([/* ... */]);
$promise = $client->stopModelInvocationJobAsync([/* ... */]);

Stops a batch inference job. You're only charged for tokens that were already processed. For more information, see Stop a batch inference job.

Parameter Syntax

$result = $client->stopModelInvocationJob([
    'jobIdentifier' => '<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.

TagResource

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

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

Parameter Syntax

$result = $client->tagResource([
    'resourceARN' => '<string>', // REQUIRED
    'tags' => [ // REQUIRED
        [
            'key' => '<string>', // REQUIRED
            'value' => '<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.

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.

ThrottlingException:

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

UntagResource

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

Remove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->untagResource([
    'resourceARN' => '<string>', // REQUIRED
    'tagKeys' => ['<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.

UpdateGuardrail

$result = $client->updateGuardrail([/* ... */]);
$promise = $client->updateGuardrailAsync([/* ... */]);

Updates a guardrail with the values you specify.

• Specify a name and optional description.

• Specify messages for when the guardrail successfully blocks a prompt or a model response in the blockedInputMessaging and blockedOutputsMessaging fields.

• Specify topics for the guardrail to deny in the topicPolicyConfig object. Each GuardrailTopicConfig object in the topicsConfig list pertains to one topic.

  • Give a name and description so that the guardrail can properly identify the topic.

  • Specify DENY in the type field.

  • (Optional) Provide up to five prompts that you would categorize as belonging to the topic in the examples list.

• Specify filter strengths for the harmful categories defined in Amazon Bedrock in the contentPolicyConfig object. Each GuardrailContentFilterConfig object in the filtersConfig list pertains to a harmful category. For more information, see Content filters. For more information about the fields in a content filter, see GuardrailContentFilterConfig.

  • Specify the category in the type field.

  • Specify the strength of the filter for prompts in the inputStrength field and for model responses in the strength field of the GuardrailContentFilterConfig.

• (Optional) For security, include the ARN of a KMS key in the kmsKeyId field.

Parameter Syntax

$result = $client->updateGuardrail([
    'blockedInputMessaging' => '<string>', // REQUIRED
    'blockedOutputsMessaging' => '<string>', // REQUIRED
    'contentPolicyConfig' => [
        'filtersConfig' => [ // REQUIRED
            [
                'inputStrength' => 'NONE|LOW|MEDIUM|HIGH', // REQUIRED
                'outputStrength' => 'NONE|LOW|MEDIUM|HIGH', // REQUIRED
                'type' => 'SEXUAL|VIOLENCE|HATE|INSULTS|MISCONDUCT|PROMPT_ATTACK', // REQUIRED
            ],
            // ...
        ],
    ],
    'contextualGroundingPolicyConfig' => [
        'filtersConfig' => [ // REQUIRED
            [
                'threshold' => <float>, // REQUIRED
                'type' => 'GROUNDING|RELEVANCE', // REQUIRED
            ],
            // ...
        ],
    ],
    'description' => '<string>',
    'guardrailIdentifier' => '<string>', // REQUIRED
    'kmsKeyId' => '<string>',
    'name' => '<string>', // REQUIRED
    'sensitiveInformationPolicyConfig' => [
        'piiEntitiesConfig' => [
            [
                'action' => 'BLOCK|ANONYMIZE', // REQUIRED
                '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', // REQUIRED
                'description' => '<string>',
                'name' => '<string>', // REQUIRED
                'pattern' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'topicPolicyConfig' => [
        'topicsConfig' => [ // REQUIRED
            [
                'definition' => '<string>', // REQUIRED
                'examples' => ['<string>', ...],
                'name' => '<string>', // REQUIRED
                'type' => 'DENY', // REQUIRED
            ],
            // ...
        ],
    ],
    'wordPolicyConfig' => [
        'managedWordListsConfig' => [
            [
                'type' => 'PROFANITY', // REQUIRED
            ],
            // ...
        ],
        'wordsConfig' => [
            [
                'text' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

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

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.

UpdateProvisionedModelThroughput

$result = $client->updateProvisionedModelThroughput([/* ... */]);
$promise = $client->updateProvisionedModelThroughputAsync([/* ... */]);

Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->updateProvisionedModelThroughput([
    'desiredModelId' => '<string>',
    'desiredProvisionedModelName' => '<string>',
    '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.

InternalServerException:

An internal server error occurred. Retry your request.

ThrottlingException:

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